Bond Management Service Server

This Specification proposes that this service will enable users to manage their bonds on devices with a limited user interface. More...

Detailed Description

This Specification proposes that this service will enable users to manage their bonds on devices with a limited user interface.

Data Structures
struct	st_ble_bms_cp_t
	Bond Management Control Point value structure. More...
struct	st_ble_bms_feat_t
	Bond Management Features value structure. More...

Macros
#define	BLE_BMS_OP_CODE_NOT_SUPPORTED_ERROR   (BLE_ERR_GROUP_GATT | 0x80)
	Response if unsupported Op Code is received. More...
#define	BLE_BMS_OPERATION_FAILED_ERROR   (BLE_ERR_GROUP_GATT | 0x81)
	Response if unable to complete a procedure for any reason. More...

Enumerations
enum	e_ble_bms_cp_op_code_t {   BLE_BMS_CP_OP_CODE_DELETE_BOND_OF_REQUESTING_DEVICE_LE_TRANSPORT_ONLY = 3,   BLE_BMS_CP_OP_CODE_DELETE_ALL_BONDS_ON_SERVER_LE_TRANSPORT_ONLY = 6,   BLE_BMS_CP_OP_CODE_DELETE_ALL_BUT_THE_ACTIVE_BOND_ON_SERVER_LE_TRANSPORT_ONLY = 9 }
	Bond Management Control Point Op Code enumeration. More...
enum	e_ble_bms_char_idx_t {   BLE_BMS_CP_IDX,   BLE_BMS_FEAT_IDX }
	Bond Management Service characteristic Index. More...
enum	e_ble_bms_event_t {   BLE_BMS_EVENT_CP_WRITE_REQ = BLE_SERVS_ATTR_EVENT(BLE_BMS_CP_IDX, BLE_SERVS_WRITE_REQ),   BLE_BMS_EVENT_CP_WRITE_COMP = BLE_SERVS_ATTR_EVENT(BLE_BMS_CP_IDX, BLE_SERVS_WRITE_COMP),   BLE_BMS_EVENT_FEAT_READ_REQ = BLE_SERVS_ATTR_EVENT(BLE_BMS_FEAT_IDX, BLE_SERVS_READ_REQ) }
	Bond Management Service event type. More...

Functions
ble_status_t	R_BLE_BMS_SetFeat (const st_ble_bms_feat_t *p_value)
	Set Bond Management Features characteristic value to the local GATT database. More...
ble_status_t	R_BLE_BMS_GetFeat (st_ble_bms_feat_t *p_value)
	Get Bond Management Features characteristic value from the local GATT database. More...
ble_status_t	R_BLE_BMS_Init (ble_servs_app_cb_t cb)
	Initialize Bond Management Service service. More...

Macro Definition Documentation

BLE_BMS_OP_CODE_NOT_SUPPORTED_ERROR

#define BLE_BMS_OP_CODE_NOT_SUPPORTED_ERROR   (BLE_ERR_GROUP_GATT | 0x80)

Response if unsupported Op Code is received.

BLE_BMS_OPERATION_FAILED_ERROR

#define BLE_BMS_OPERATION_FAILED_ERROR   (BLE_ERR_GROUP_GATT | 0x81)

Response if unable to complete a procedure for any reason.

Enumeration Type Documentation

e_ble_bms_cp_op_code_t

enum e_ble_bms_cp_op_code_t

Bond Management Control Point Op Code enumeration.

Enumerator
BLE_BMS_CP_OP_CODE_DELETE_BOND_OF_REQUESTING_DEVICE_LE_TRANSPORT_ONLY	Delete bond of requesting device (LE transport only)
BLE_BMS_CP_OP_CODE_DELETE_ALL_BONDS_ON_SERVER_LE_TRANSPORT_ONLY	Delete all bonds on server (LE transport only)
BLE_BMS_CP_OP_CODE_DELETE_ALL_BUT_THE_ACTIVE_BOND_ON_SERVER_LE_TRANSPORT_ONLY	Delete all but the active bond on server (LE transport only)

e_ble_bms_char_idx_t

enum e_ble_bms_char_idx_t

Bond Management Service characteristic Index.

e_ble_bms_event_t

enum e_ble_bms_event_t

Bond Management Service event type.

Function Documentation

R_BLE_BMS_SetFeat()

ble_status_t R_BLE_BMS_SetFeat

(

const st_ble_bms_feat_t *

p_value

)

Set Bond Management Features characteristic value to the local GATT database.

Parameters

[in]

p_value

Characteristic value to set.

Returns

ble_status_t

R_BLE_BMS_GetFeat()

ble_status_t R_BLE_BMS_GetFeat

(

st_ble_bms_feat_t *

p_value

)

Get Bond Management Features characteristic value from the local GATT database.

Parameters

[in]

p_value

Output location for the acquired descriptor value.

Returns

ble_status_t

R_BLE_BMS_Init()

ble_status_t R_BLE_BMS_Init

(

ble_servs_app_cb_t

cb

)

Initialize Bond Management Service service.

Parameters

[in]

cb

Service callback.

Returns

ble_status_t