MT7697 API Reference  LinkIt SDK v4

This section introduces the UUID APIs including terms and acronyms, supported features, details on how to use this module, UUID function groups, structures and functions. More...

Overview

This section introduces the UUID APIs including terms and acronyms, supported features, details on how to use this module, UUID function groups, structures and functions.

Terms and Acronyms

Terms Details
UUID Universally Unique Identifier. For more information, please refer to Wikipedia.

How to use this module

Functions

void bt_uuid_copy (bt_uuid_t *dst, const bt_uuid_t *src)
 This function copies the UUID from another UUID. More...
 
bool bt_uuid_equal (const bt_uuid_t *uuid1, const bt_uuid_t *uuid2)
 This function checks if two UUIDs are identical. More...
 
bool bt_uuid_is_uuid32 (const bt_uuid_t *uuid)
 This function checks if it is a 32-bit UUID. More...
 
bool bt_uuid_is_uuid16 (const bt_uuid_t *uuid)
 This function checks if it is a 16-bit UUID. More...
 
void bt_uuid_load (bt_uuid_t *dst, const void *src, const uint8_t src_size)
 This function converts the UUID stored as a number in string format to bt_uuid_t structure. More...
 
void bt_uuid_from_uuid16 (bt_uuid_t *dst, const uint16_t uuid16)
 This function converts the UUID in 16-bit integer format to bt_uuid_t structure. More...
 
void bt_uuid_from_uuid32 (bt_uuid_t *dst, const uint32_t uuid32)
 This function converts the UUID in 32-bit integer format to bt_uuid_t structure. More...
 

Modules

 Define
 This section defines the Bluetooth SIG base UUID.
 
 Struct
 This section defines bt_uuid data structure.
 

Function Documentation

void bt_uuid_copy ( bt_uuid_t dst,
const bt_uuid_t src 
)

This function copies the UUID from another UUID.

Parameters
[in]dstis the destination UUID.
[in]srcis the source UUID.
Returns
None.
bool bt_uuid_equal ( const bt_uuid_t uuid1,
const bt_uuid_t uuid2 
)

This function checks if two UUIDs are identical.

Parameters
[in]uuid1is the first UUID.
[in]uuid2is the second UUID.
Returns
true, if two UUIDs are identical.
void bt_uuid_from_uuid16 ( bt_uuid_t dst,
const uint16_t  uuid16 
)

This function converts the UUID in 16-bit integer format to bt_uuid_t structure.

Parameters
[in]dstis the pointer to the converted UUID.
[in]uuid16is the UUID in 16-bit integer format.
Returns
None
void bt_uuid_from_uuid32 ( bt_uuid_t dst,
const uint32_t  uuid32 
)

This function converts the UUID in 32-bit integer format to bt_uuid_t structure.

Parameters
[in]dstis the pointer to the converted UUID.
[in]uuid32is the UUID in 32-bit integer format.
Returns
None.
bool bt_uuid_is_uuid16 ( const bt_uuid_t uuid)

This function checks if it is a 16-bit UUID.

Parameters
[in]uuidis the UUID to check.
Returns
true, if it is a 16-bit UUID.
bool bt_uuid_is_uuid32 ( const bt_uuid_t uuid)

This function checks if it is a 32-bit UUID.

Parameters
[in]uuidis the UUID to check.
Returns
true, if it is a 32-bit UUID.
void bt_uuid_load ( bt_uuid_t dst,
const void *  src,
const uint8_t  src_size 
)

This function converts the UUID stored as a number in string format to bt_uuid_t structure.

Parameters
[in]dstis the pointer to the converted UUID.
[in]srcis the pointer to the input integer in string format.
[in]src_sizeis the size of the input integer in string format.
Returns
None