Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
Human Interface Device Service Client

This is the client for the Human Interface Device Service. More...

Detailed Description

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...
 

Enumerations

enum  e_ble_hidc_event_t {
  BLE_HIDC_EVENT_PROTOCOL_MODE_READ_RSP,
  BLE_HIDC_EVENT_REPORT_HDL_VAL_NTF,
  BLE_HIDC_EVENT_REPORT_WRITE_RSP,
  BLE_HIDC_EVENT_REPORT_READ_RSP,
  BLE_HIDC_EVENT_REPORT_REPORT_REFERENCE_WRITE_RSP,
  BLE_HIDC_EVENT_REPORT_REPORT_REFERENCE_READ_RSP,
  BLE_HIDC_EVENT_REPORT_CLI_CNFG_READ_RSP,
  BLE_HIDC_EVENT_REPORT_MAP_READ_RSP,
  BLE_HIDC_EVENT_REPORT_MAP_READ_LONG_RSP,
  BLE_HIDC_EVENT_REPORT_MAP_EXTERNAL_REPORT_REFERENCE_READ_RSP,
  BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_HDL_VAL_NTF,
  BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_WRITE_RSP,
  BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_READ_RSP,
  BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_CLI_CNFG_READ_RSP,
  BLE_HIDC_EVENT_BOOT_KEYBOARD_OUTPUT_REPORT_WRITE_RSP,
  BLE_HIDC_EVENT_BOOT_KEYBOARD_OUTPUT_REPORT_READ_RSP,
  BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_HDL_VAL_NTF,
  BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_WRITE_RSP,
  BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_READ_RSP,
  BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_CLI_CNFG_READ_RSP,
  BLE_HIDC_EVENT_HID_INFORMATION_READ_RSP,
  BLE_HIDC_EVENT_CLI_CNFG_WRITE_RSP,
  BLE_HIDC_EVENT_ERROR_RSP
}
 Human Interface Device Service Client event type. More...
 
enum  e_ble_hidc_host_mode_t {
  BLE_HIDC_BOOT_HOST_MODE = 0,
  BLE_HIDC_REPORT_HOST_MODE = 1
}
 Human Interface Device Service Client Host mode. 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...
 

Variables

const uint8_t BLE_HIDC_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Human Interface Device Service UUID. More...
 
const uint8_t BLE_HIDC_PROTOCOL_MODE_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Protocol Mode characteristic UUID. More...
 
const uint8_t BLE_HIDC_REPORT_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Report characteristic UUID. More...
 
const uint8_t BLE_HIDC_REPORT_MAP_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Report Map characteristic UUID. More...
 
const uint8_t BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Boot Keyboard Input Report characteristic UUID. More...
 
const uint8_t BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Boot Keyboard Output Report characteristic UUID. More...
 
const uint8_t BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 Boot Mouse Input Report characteristic UUID. More...
 
const uint8_t BLE_HIDC_HID_INFORMATION_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 HID Information characteristic UUID. More...
 
const uint8_t BLE_HIDC_HID_CONTROL_POINT_UUID [BLE_GATT_16_BIT_UUID_SIZE]
 HID Control Point characteristic UUID. More...
 
const uint8_t BLE_HIDC_REPORT_UUID [BLE_GATT_16_BIT_UUID_SIZE] = { 0x4D, 0x2A }
 Report characteristic UUID. More...
 

Macro Definition Documentation

◆ BLE_HIDC_PROTOCOL_MODE_LEN

#define BLE_HIDC_PROTOCOL_MODE_LEN   (1)

Protocol Mode characteristic value length.

◆ BLE_HIDC_REPORT_LEN

#define BLE_HIDC_REPORT_LEN   (64)

Report characteristic value length.

◆ BLE_HIDC_REPORT_MAP_LEN

#define BLE_HIDC_REPORT_MAP_LEN   (512)

Report Map characteristic value length.

◆ BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_LEN

#define BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_LEN   (8)

Boot Keyboard Input Report characteristic value length.

◆ BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_LEN

#define BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_LEN   (8)

Boot Keyboard Output Report characteristic value length.

◆ BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_LEN

#define BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_LEN   (8)

Boot Mouse Input Report characteristic value length.

◆ BLE_HIDC_HID_INFORMATION_LEN

#define BLE_HIDC_HID_INFORMATION_LEN   (4)

HID Information characteristic value length.

◆ BLE_HIDC_HID_CONTROL_POINT_LEN

#define BLE_HIDC_HID_CONTROL_POINT_LEN   (1)

HID Control Point characteristic value length.

Typedef Documentation

◆ ble_hidc_app_cb_t

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.

Enumeration Type Documentation

◆ e_ble_hidc_event_t

Human Interface Device Service Client event type.

Enumerator
BLE_HIDC_EVENT_PROTOCOL_MODE_READ_RSP 

Protocol Mode characteristic read response event

BLE_HIDC_EVENT_REPORT_HDL_VAL_NTF 

Report characteristic handle value notification event

BLE_HIDC_EVENT_REPORT_WRITE_RSP 

Report characteristic write response event

BLE_HIDC_EVENT_REPORT_READ_RSP 

Report characteristic read response event

BLE_HIDC_EVENT_REPORT_REPORT_REFERENCE_WRITE_RSP 

Report characteristic Report Reference write response event

BLE_HIDC_EVENT_REPORT_REPORT_REFERENCE_READ_RSP 

Report characteristic Report Reference read response event

BLE_HIDC_EVENT_REPORT_CLI_CNFG_READ_RSP 

Report characteristic Client Configuration read response event

BLE_HIDC_EVENT_REPORT_MAP_READ_RSP 

Report Map characteristic read response event

BLE_HIDC_EVENT_REPORT_MAP_READ_LONG_RSP 

Report Map characteristic read long response event

BLE_HIDC_EVENT_REPORT_MAP_EXTERNAL_REPORT_REFERENCE_READ_RSP 

Report Map characteristic External Report Reference read response event

BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_HDL_VAL_NTF 

Boot Keyboard Input Report characteristic handle value notification event

BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_WRITE_RSP 

Boot Keyboard Input Report characteristic write response event

BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_READ_RSP 

Boot Keyboard Input Report characteristic read response event

BLE_HIDC_EVENT_BOOT_KEYBOARD_INPUT_REPORT_CLI_CNFG_READ_RSP 

Boot Keyboard Input Report characteristic Client Configuration read response event

BLE_HIDC_EVENT_BOOT_KEYBOARD_OUTPUT_REPORT_WRITE_RSP 

Boot Keyboard Output Report characteristic write response event

BLE_HIDC_EVENT_BOOT_KEYBOARD_OUTPUT_REPORT_READ_RSP 

Boot Keyboard Output Report characteristic read response event

BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_HDL_VAL_NTF 

Boot Mouse Input Report characteristic handle value notification event

BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_WRITE_RSP 

Boot Mouse Input Report characteristic write response event

BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_READ_RSP 

Boot Mouse Input Report characteristic read response event

BLE_HIDC_EVENT_BOOT_MOUSE_INPUT_REPORT_CLI_CNFG_READ_RSP 

Boot Mouse Input Report characteristic Client Configuration read response event

BLE_HIDC_EVENT_HID_INFORMATION_READ_RSP 

HID Information characteristic read response event

BLE_HIDC_EVENT_CLI_CNFG_WRITE_RSP 

Client Configuration write response

BLE_HIDC_EVENT_ERROR_RSP 

error response

◆ e_ble_hidc_host_mode_t

Human Interface Device Service Client Host mode.

Enumerator
BLE_HIDC_BOOT_HOST_MODE 

Protocol Mode characteristic value Report host

BLE_HIDC_REPORT_HOST_MODE 

Protocol Mode characteristic value Boot host

Function Documentation

◆ R_BLE_HIDC_Init()

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.

Parameters
[in]paramHuman Interface Device Service Client initialization parameters.
Returns
ble_status_t

◆ R_BLE_HIDC_Connect()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]paramConnection parameters.
Returns
ble_status_t

◆ R_BLE_HIDC_Disconnect()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]paramDisconnection parameters.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadProtocolMode()

ble_status_t R_BLE_HIDC_ReadProtocolMode ( uint16_t  conn_hdl,
uint8_t  idx 
)

Read Protocol Mode characteristic value from remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_WriteWithoutRspProtocolMode()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]app_valueProtocol Mode characteristic value to write.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]report_idReport index used to distinguish the multiple same UUID characteristic.
Returns
ble_status_t

◆ R_BLE_HIDC_WriteReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]report_idReport index used to distinguish the multiple same UUID characteristic.
[in]app_valueReport characteristic value to write.
Returns
ble_status_t

◆ R_BLE_HIDC_SetReportCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]report_idReport index used to distinguish the multiple same UUID characteristic.
[in]cli_cnfgReport characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadReportCliCnfg()

ble_status_t R_BLE_HIDC_ReadReportCliCnfg ( uint16_t  conn_hdl,
uint8_t  idx,
uint8_t  report_id 
)

Read Report characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]report_idReport index used to distinguish the multiple same UUID characteristic.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadReportReportReference()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]report_idReport index used to distinguish the multiple same UUID characterisitc.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadReportMap()

ble_status_t R_BLE_HIDC_ReadReportMap ( uint16_t  conn_hdl,
uint8_t  idx 
)

Read Report Map characteristic value from remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadLongReportMap()

ble_status_t R_BLE_HIDC_ReadLongReportMap ( uint16_t  conn_hdl,
uint8_t  idx 
)

Read Report Map characteristic long value from remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadReportMapExternalReportReference()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadBootKeyboardInputReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_WriteBootKeyboardInputReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]app_valueBoot Keyboard Input Report characteristic value to write.
Returns
ble_status_t

◆ R_BLE_HIDC_SetBootKeyboardInputReportCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]cli_cnfgBoot Keyboard Input Report characteristic cli cnfg to set.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadBootKeyboardInputReportCliCnfg()

ble_status_t R_BLE_HIDC_ReadBootKeyboardInputReportCliCnfg ( uint16_t  conn_hdl,
uint8_t  idx 
)

Read Boot Keyboard Input Report characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadBootKeyboardOutputReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_WriteBootKeyboardOutputReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]app_valueBoot Keyboard Output Report characteristic value to write.
Returns
ble_status_t

◆ R_BLE_HIDC_WriteWithoutRspBootKeyboardOutputReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]app_valueBoot Keyboard Output Report characteristic value to write.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadBootMouseInputReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_WriteBootMouseInputReport()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]app_valueBoot Mouse Input Report characteristic value to write.
Returns
ble_status_t

◆ R_BLE_HIDC_SetBootMouseInputReportCliCnfg()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]cli_cnfgBoot Mouse Input Report characteristic client configuration to set.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadBootMouseInputReportCliCnfg()

ble_status_t R_BLE_HIDC_ReadBootMouseInputReportCliCnfg ( uint16_t  conn_hdl,
uint8_t  idx 
)

Read Boot Mouse Input Report characteristic cli cnfg.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_ReadHidInformation()

ble_status_t R_BLE_HIDC_ReadHidInformation ( uint16_t  conn_hdl,
uint8_t  idx 
)

Read HID Information characteristic value from remote GATT database.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
Returns
ble_status_t

◆ R_BLE_HIDC_WriteWithoutRspHidControlPoint()

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.

Parameters
[in]conn_hdlConnection handle.
[in]idxService index used to distinguish the multiple same UUID service.
[in]app_valueHID Control Point characteristic value to write.
Returns
ble_status_t

◆ R_BLE_HIDC_GetVersion()

uint32_t R_BLE_HIDC_GetVersion ( void  )

Return version of the HIDC service client.

Returns
version

Variable Documentation

◆ BLE_HIDC_UUID

const uint8_t BLE_HIDC_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Human Interface Device Service UUID.

◆ BLE_HIDC_PROTOCOL_MODE_UUID

const uint8_t BLE_HIDC_PROTOCOL_MODE_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Protocol Mode characteristic UUID.

◆ BLE_HIDC_REPORT_UUID [1/2]

const uint8_t BLE_HIDC_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Report characteristic UUID.

◆ BLE_HIDC_REPORT_MAP_UUID

const uint8_t BLE_HIDC_REPORT_MAP_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Report Map characteristic UUID.

◆ BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_UUID

const uint8_t BLE_HIDC_BOOT_KEYBOARD_INPUT_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Boot Keyboard Input Report characteristic UUID.

◆ BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_UUID

const uint8_t BLE_HIDC_BOOT_KEYBOARD_OUTPUT_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Boot Keyboard Output Report characteristic UUID.

◆ BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_UUID

const uint8_t BLE_HIDC_BOOT_MOUSE_INPUT_REPORT_UUID[BLE_GATT_16_BIT_UUID_SIZE]

Boot Mouse Input Report characteristic UUID.

◆ BLE_HIDC_HID_INFORMATION_UUID

const uint8_t BLE_HIDC_HID_INFORMATION_UUID[BLE_GATT_16_BIT_UUID_SIZE]

HID Information characteristic UUID.

◆ BLE_HIDC_HID_CONTROL_POINT_UUID

const uint8_t BLE_HIDC_HID_CONTROL_POINT_UUID[BLE_GATT_16_BIT_UUID_SIZE]

HID Control Point characteristic UUID.

◆ BLE_HIDC_REPORT_UUID [2/2]

const uint8_t BLE_HIDC_REPORT_UUID = { 0x4D, 0x2A }

Report characteristic UUID.