![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This is the client for the Human Interface Device Service. More...
This is the client for the Human Interface Device Service.
Data Structures | |
struct | st_ble_hidc_evt_data_t |
Human Interface Device Service Client event data. More... | |
struct | st_ble_hidc_report_hdl_t |
Report characteristic attribute handles. More... | |
struct | st_ble_hidc_hdls_t |
Human Interface Device Service attribute handles. More... | |
struct | st_ble_hidc_init_param_t |
Human Interface Device Service initialization parameters. More... | |
struct | st_ble_hidc_connect_param_t |
Human Interface Device Service Client connection parameters. More... | |
struct | st_ble_hidc_disconnect_param_t |
Human Interface Device Service disconnection parameters. More... | |
struct | st_ble_hidc_report_value_t |
Report characteristic callback parameters. More... | |
struct | st_ble_hidc_report_report_reference_t |
Report Reference descriptor parameters. More... | |
struct | st_ble_hidc_report_map_t |
Report Map characteristic parameters. More... | |
struct | st_ble_hidc_hid_information_t |
HID Information characteristic parameters. More... | |
Macros | |
#define | BLE_HIDC_PROTOCOL_MODE_LEN (1) |
Protocol Mode characteristic value length. More... | |
#define | BLE_HIDC_REPORT_LEN (64) |
Report characteristic value length. More... | |
#define | BLE_HIDC_REPORT_MAP_LEN (512) |
Report Map characteristic value length. More... | |
#define | BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_LEN (8) |
Boot Keyboard Input Report characteristic value length. More... | |
#define | BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_LEN (8) |
Boot Keyboard Output Report characteristic value length. More... | |
#define | BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_LEN (8) |
Boot Mouse Input Report characteristic value length. More... | |
#define | BLE_HIDC_HID_INFORMATION_LEN (4) |
HID Information characteristic value length. More... | |
#define | BLE_HIDC_HID_CONTROL_POINT_LEN (1) |
HID Control Point characteristic value length. More... | |
Typedefs | |
typedef void(* | ble_hidc_app_cb_t) (uint16_t type, ble_status_t result, uint8_t idx, void *p_data) |
Human Interface Device Service Client event callback. More... | |
Functions | |
ble_status_t | R_BLE_HIDC_Init (const st_ble_hidc_init_param_t *p_param) |
Initialize Human Interface Device Service Client. More... | |
ble_status_t | R_BLE_HIDC_Connect (uint16_t conn_hdl, uint8_t idx, const st_ble_hidc_connect_param_t *p_param) |
Perform Human Interface Device Service Client connection settings. More... | |
ble_status_t | R_BLE_HIDC_Disconnect (uint16_t conn_hdl, uint8_t idx, st_ble_hidc_disconnect_param_t *p_param) |
Retrieve Human Interface Device Service Client connection specific settings before disconnection. More... | |
ble_status_t | R_BLE_HIDC_ReadProtocolMode (uint16_t conn_hdl, uint8_t idx) |
Read Protocol Mode characteristic value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_WriteWithoutRspProtocolMode (uint16_t conn_hdl, uint8_t idx, uint8_t app_value) |
Write Protocol Mode characteristic value without response to remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_ReadReport (uint16_t conn_hdl, uint8_t idx, uint8_t report_id) |
Read Report characteristic value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_WriteReport (uint16_t conn_hdl, uint8_t idx, uint8_t report_id, const st_ble_gatt_value_t *p_app_value) |
Write Report characteristic value to remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_SetReportCliCnfg (uint16_t conn_hdl, uint8_t idx, uint8_t report_id, uint16_t cli_cnfg) |
Set Report characteristic cli cnfg. More... | |
ble_status_t | R_BLE_HIDC_ReadReportCliCnfg (uint16_t conn_hdl, uint8_t idx, uint8_t report_id) |
Read Report characteristic cli cnfg. More... | |
ble_status_t | R_BLE_HIDC_ReadReportReportReference (uint16_t conn_hdl, uint8_t idx, uint8_t report_id) |
Read Report characteristic Report Reference descriptor value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_ReadReportMap (uint16_t conn_hdl, uint8_t idx) |
Read Report Map characteristic value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_ReadLongReportMap (uint16_t conn_hdl, uint8_t idx) |
Read Report Map characteristic long value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_ReadReportMapExternalReportReference (uint16_t conn_hdl, uint8_t idx) |
Read Report Map characteristic External Report Reference descriptor value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_ReadBootKeyboardInputReport (uint16_t conn_hdl, uint8_t idx) |
Read Boot Keyboard Input Report characteristic value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_WriteBootKeyboardInputReport (uint16_t conn_hdl, uint8_t idx, const st_ble_gatt_value_t *p_app_value) |
Write Boot Keyboard Input Report characteristic value to remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_SetBootKeyboardInputReportCliCnfg (uint16_t conn_hdl, uint8_t idx, uint16_t cli_cnfg) |
Set Boot Keyboard Input Report characteristic cli cnfg. More... | |
ble_status_t | R_BLE_HIDC_ReadBootKeyboardInputReportCliCnfg (uint16_t conn_hdl, uint8_t idx) |
Read Boot Keyboard Input Report characteristic cli cnfg. More... | |
ble_status_t | R_BLE_HIDC_ReadBootKeyboardOutputReport (uint16_t conn_hdl, uint8_t idx) |
Read Boot Keyboard Output Report characteristic value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_WriteBootKeyboardOutputReport (uint16_t conn_hdl, uint8_t idx, const st_ble_gatt_value_t *p_app_value) |
Write Boot Keyboard Output Report characteristic value to remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_WriteWithoutRspBootKeyboardOutputReport (uint16_t conn_hdl, uint8_t idx, const st_ble_gatt_value_t *p_app_value) |
Write Boot Keyboard Output Report characteristic value without response to remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_ReadBootMouseInputReport (uint16_t conn_hdl, uint8_t idx) |
Read Boot Mouse Input Report characteristic value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_WriteBootMouseInputReport (uint16_t conn_hdl, uint8_t idx, const st_ble_gatt_value_t *p_app_value) |
Write Boot Mouse Input Report characteristic value to remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_SetBootMouseInputReportCliCnfg (uint16_t conn_hdl, uint8_t idx, uint16_t cli_cnfg) |
Set Boot Mouse Input Report characteristic cli cnfg. More... | |
ble_status_t | R_BLE_HIDC_ReadBootMouseInputReportCliCnfg (uint16_t conn_hdl, uint8_t idx) |
Read Boot Mouse Input Report characteristic cli cnfg. More... | |
ble_status_t | R_BLE_HIDC_ReadHidInformation (uint16_t conn_hdl, uint8_t idx) |
Read HID Information characteristic value from remote GATT database. More... | |
ble_status_t | R_BLE_HIDC_WriteWithoutRspHidControlPoint (uint16_t conn_hdl, uint8_t idx, uint8_t app_value) |
Write HID Control Point characteristic value without response to remote GATT database. More... | |
void | R_BLE_HIDC_ServDiscCb (uint16_t conn_hdl, uint8_t idx, uint16_t type, void *p_param) |
uint32_t | R_BLE_HIDC_GetVersion (void) |
Return version of the HIDC service client. More... | |
#define BLE_HIDC_PROTOCOL_MODE_LEN (1) |
Protocol Mode characteristic value length.
#define BLE_HIDC_REPORT_LEN (64) |
Report characteristic value length.
#define BLE_HIDC_REPORT_MAP_LEN (512) |
Report Map characteristic value length.
#define BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_LEN (8) |
Boot Keyboard Input Report characteristic value length.
#define BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_LEN (8) |
Boot Keyboard Output Report characteristic value length.
#define BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_LEN (8) |
Boot Mouse Input Report characteristic value length.
#define BLE_HIDC_HID_INFORMATION_LEN (4) |
HID Information characteristic value length.
#define BLE_HIDC_HID_CONTROL_POINT_LEN (1) |
HID Control Point characteristic value length.
typedef void(* ble_hidc_app_cb_t) (uint16_t type, ble_status_t result, uint8_t idx, void *p_data) |
Human Interface Device Service Client event callback.
enum e_ble_hidc_event_t |
Human Interface Device Service Client event type.
ble_status_t R_BLE_HIDC_Init | ( | const st_ble_hidc_init_param_t * | p_param | ) |
Initialize Human Interface Device Service Client.
This function shall be called once at startup.
[in] | param | Human Interface Device Service Client initialization parameters. |
ble_status_t R_BLE_HIDC_Connect | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_hidc_connect_param_t * | p_param | ||
) |
Perform Human Interface Device Service Client connection settings.
This function shall be called on each connection establishment.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | param | Connection parameters. |
ble_status_t R_BLE_HIDC_Disconnect | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
st_ble_hidc_disconnect_param_t * | p_param | ||
) |
Retrieve Human Interface Device Service Client connection specific settings before disconnection.
This function shall be called on each disconnection.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | param | Disconnection parameters. |
ble_status_t R_BLE_HIDC_ReadProtocolMode | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Protocol Mode characteristic value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_WriteWithoutRspProtocolMode | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | app_value | ||
) |
Write Protocol Mode characteristic value without response to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | app_value | Protocol Mode characteristic value to write. |
ble_status_t R_BLE_HIDC_ReadReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | report_id | ||
) |
Read Report characteristic value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | report_id | Report index used to distinguish the multiple same UUID characteristic. |
ble_status_t R_BLE_HIDC_WriteReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | report_id, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Write Report characteristic value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | report_id | Report index used to distinguish the multiple same UUID characteristic. |
[in] | app_value | Report characteristic value to write. |
ble_status_t R_BLE_HIDC_SetReportCliCnfg | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | report_id, | ||
uint16_t | cli_cnfg | ||
) |
Set Report characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | report_id | Report index used to distinguish the multiple same UUID characteristic. |
[in] | cli_cnfg | Report characteristic cli cnfg to set. |
ble_status_t R_BLE_HIDC_ReadReportCliCnfg | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | report_id | ||
) |
Read Report characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | report_id | Report index used to distinguish the multiple same UUID characteristic. |
ble_status_t R_BLE_HIDC_ReadReportReportReference | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | report_id | ||
) |
Read Report characteristic Report Reference descriptor value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | report_id | Report index used to distinguish the multiple same UUID characterisitc. |
ble_status_t R_BLE_HIDC_ReadReportMap | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Report Map characteristic value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_ReadLongReportMap | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Report Map characteristic long value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_ReadReportMapExternalReportReference | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Report Map characteristic External Report Reference descriptor value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_ReadBootKeyboardInputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Boot Keyboard Input Report characteristic value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_WriteBootKeyboardInputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Write Boot Keyboard Input Report characteristic value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | app_value | Boot Keyboard Input Report characteristic value to write. |
ble_status_t R_BLE_HIDC_SetBootKeyboardInputReportCliCnfg | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint16_t | cli_cnfg | ||
) |
Set Boot Keyboard Input Report characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | cli_cnfg | Boot Keyboard Input Report characteristic cli cnfg to set. |
ble_status_t R_BLE_HIDC_ReadBootKeyboardInputReportCliCnfg | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Boot Keyboard Input Report characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_ReadBootKeyboardOutputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Boot Keyboard Output Report characteristic value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_WriteBootKeyboardOutputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Write Boot Keyboard Output Report characteristic value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | app_value | Boot Keyboard Output Report characteristic value to write. |
ble_status_t R_BLE_HIDC_WriteWithoutRspBootKeyboardOutputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Write Boot Keyboard Output Report characteristic value without response to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | app_value | Boot Keyboard Output Report characteristic value to write. |
ble_status_t R_BLE_HIDC_ReadBootMouseInputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Boot Mouse Input Report characteristic value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_WriteBootMouseInputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Write Boot Mouse Input Report characteristic value to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | app_value | Boot Mouse Input Report characteristic value to write. |
ble_status_t R_BLE_HIDC_SetBootMouseInputReportCliCnfg | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint16_t | cli_cnfg | ||
) |
Set Boot Mouse Input Report characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | cli_cnfg | Boot Mouse Input Report characteristic client configuration to set. |
ble_status_t R_BLE_HIDC_ReadBootMouseInputReportCliCnfg | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read Boot Mouse Input Report characteristic cli cnfg.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_ReadHidInformation | ( | uint16_t | conn_hdl, |
uint8_t | idx | ||
) |
Read HID Information characteristic value from remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
ble_status_t R_BLE_HIDC_WriteWithoutRspHidControlPoint | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | app_value | ||
) |
Write HID Control Point characteristic value without response to remote GATT database.
[in] | conn_hdl | Connection handle. |
[in] | idx | Service index used to distinguish the multiple same UUID service. |
[in] | app_value | HID Control Point characteristic value to write. |
uint32_t R_BLE_HIDC_GetVersion | ( | void | ) |
Return version of the HIDC service client.
const uint8_t BLE_HIDC_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Human Interface Device Service UUID.
const uint8_t BLE_HIDC_PROTOCOL_MODE_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Protocol Mode characteristic UUID.
const uint8_t BLE_HIDC_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Report characteristic UUID.
const uint8_t BLE_HIDC_REPORT_MAP_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Report Map characteristic UUID.
const uint8_t BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Boot Keyboard Input Report characteristic UUID.
const uint8_t BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Boot Keyboard Output Report characteristic UUID.
const uint8_t BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
Boot Mouse Input Report characteristic UUID.
const uint8_t BLE_HIDC_HID_INFORMATION_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
HID Information characteristic UUID.
const uint8_t BLE_HIDC_HID_CONTROL_POINT_UUID[BLE_GATT_16_BIT_UUID_SIZE] |
HID Control Point characteristic UUID.
const uint8_t BLE_HIDC_REPORT_UUID = { 0x4D, 0x2A } |
Report characteristic UUID.