nRF Connect SDK Bare Metal API 2.0.99
Loading...
Searching...
No Matches
Bond Management Service

Bond Management Service (BMS) module. More...

Topics

 BMS feature bits
 

Data Structures

struct  ble_bms_features
 Supported features. More...
 
struct  ble_bms_auth_code
 Received authorization codes. More...
 
struct  ble_bms_evt
 BMS events. More...
 
struct  ble_bms_ctrlpt
 BMS control points. More...
 
struct  ble_bms_config
 BMS initialization structure with all information needed to initialize the service. More...
 
struct  ble_bms
 Status information for the service. More...
 

Macros

#define BLE_BMS_DEF(_name)
 Macro for defining a ble_bms instance.
 
#define BLE_BMS_CONFIG_SEC_MODE_DEFAULT
 Default security configuration.
 
#define BLE_BMS_CTRLPT_MAX_LEN   128
 
#define BLE_BMS_AUTH_CODE_MAX_LEN   BLE_BMS_CTRLPT_MAX_LEN - 1
 
#define BLE_BMS_OPCODE_NOT_SUPPORTED   0x80
 
#define BLE_BMS_OPERATION_FAILED   0x81
 

Typedefs

typedef void(* ble_bms_evt_handler_t) (struct ble_bms *bms, struct ble_bms_evt *evt)
 BMS event handler type.
 

Enumerations

enum  ble_bms_op {
  BLE_BMS_OP_DEL_BOND_REQ_DEVICE_BR_LE = 0x01 , BLE_BMS_OP_DEL_BOND_REQ_DEVICE_BR_ONLY = 0x02 , BLE_BMS_OP_DEL_BOND_REQ_DEVICE_LE_ONLY = 0x03 , BLE_BMS_OP_DEL_ALL_BONDS_ON_SERVER_BR_LE = 0x04 ,
  BLE_BMS_OP_DEL_ALL_BONDS_ON_SERVER_BR_ONLY = 0x05 , BLE_BMS_OP_DEL_ALL_BONDS_ON_SERVER_LE_ONLY = 0x06 , BLE_BMS_OP_DEL_ALL_BUT_ACTIVE_BOND_BR_LE = 0x07 , BLE_BMS_OP_DEL_ALL_BUT_ACTIVE_BOND_BR_ONLY = 0x08 ,
  BLE_BMS_OP_DEL_ALL_BUT_ACTIVE_BOND_LE_ONLY = 0x09 , BLE_BMS_OP_NONE = 0xFF
}
 BMS Control Point opcodes. More...
 
enum  ble_bms_auth_status { BLE_BMS_AUTH_STATUS_ALLOWED , BLE_BMS_AUTH_STATUS_DENIED , BLE_BMS_AUTH_STATUS_PENDING }
 Authorization status values. More...
 
enum  ble_bms_evt_type {
  BLE_BMS_EVT_ERROR , BLE_BMS_EVT_AUTH , BLE_BMS_EVT_BOND_DELETE_REQUESTING , BLE_BMS_EVT_BOND_DELETE_ALL ,
  BLE_BMS_EVT_BOND_DELETE_ALL_EXCEPT_REQUESTING
}
 BMS event types. More...
 

Functions

uint32_t ble_bms_auth_response (struct ble_bms *bms, bool authorize)
 Respond to an authorization request.
 
uint32_t ble_bms_init (struct ble_bms *bms, struct ble_bms_config *bms_config)
 Initialize the Bond Management Service.
 
void ble_bms_on_ble_evt (const ble_evt_t *ble_evt, void *ble_bms)
 Bluetooth LE event handler for the Bond Management Service.
 
uint16_t ble_bms_on_qwr_evt (struct ble_bms *bms, struct ble_qwr *qwr, const struct ble_qwr_evt *evt)
 Handle events from the nrf_ble_qwr.
 

Detailed Description

Bond Management Service (BMS) module.

This module implements the Bond Management Service (BMS). By writing to the Bond Management Control Point, the connected peer can request the deletion of bond information from the device. If authorization is configured, the application must supply an event handler for receiving Bond Management Service events. Using this handler, the service requests authorization when a procedure is requested by writing to the Bond Management Control Point.