![]() |
Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
|
This service exposes the HID reports and other HID data intended for HID Hosts and HID Devices. More...
This service exposes the HID reports and other HID data intended for HID Hosts and HID Devices.
Data Structures | |
struct | st_ble_hids_evt_data_t |
Human Interface Device Service event data. More... | |
struct | st_ble_hids_connect_param_t |
Human Interface Device Service connection parameters. More... | |
struct | st_ble_hids_disconnect_param_t |
Human Interface Device Service disconnection parameters. More... | |
struct | st_ble_hids_init_param_t |
Human Interface Device Service initialization parameters. More... | |
struct | st_ble_hids_report_t |
Report characteristic parameters. More... | |
struct | st_ble_hids_report_report_reference_t |
Report Report Reference descriptor parameters. More... | |
struct | st_ble_hids_report_map_t |
Report Map characteristic parameters. More... | |
struct | st_ble_hids_boot_keyboard_input_report_t |
Boot Keyboard Input Report characteristic parameters. More... | |
struct | st_ble_hids_boot_keyboard_output_report_t |
Boot Keyboard Output Report characteristic parameters. More... | |
struct | st_ble_hids_boot_mouse_input_report_t |
Boot Mouse Input Report characteristic parameters. More... | |
struct | st_ble_hids_hid_information_t |
HID Information characteristic parameters. More... | |
Macros | |
#define | BLE_HIDS_HID_INFORMATION_FLAGS_REMOTEWAKE (1 << 0) |
RemoteWake bit. More... | |
#define | BLE_HIDS_HID_INFORMATION_FLAGS_NORMALLYCONNECTABLE (1 << 1) |
NormallyConnectable bit. More... | |
Typedefs | |
typedef void(* | ble_hids_app_cb_t) (uint16_t type, ble_status_t result, st_ble_hids_evt_data_t *data) |
Human Interface Device Service event callback. More... | |
Functions | |
ble_status_t | R_BLE_HIDS_Init (const st_ble_hids_init_param_t *p_param) |
Initialize Human Interface Device Service. More... | |
ble_status_t | R_BLE_HIDS_Connect (uint16_t conn_hdl, uint8_t idx, const st_ble_hids_connect_param_t *p_param) |
Perform Human Interface Device Service connection settings. More... | |
ble_status_t | R_BLE_HIDS_Disconnect (uint16_t conn_hdl, uint8_t idx, st_ble_hids_disconnect_param_t *p_param) |
Retrieve Human Interface Device Service connection specific settings before disconnection. More... | |
ble_status_t | R_BLE_HIDS_GetProtocolMode (uint8_t idx, uint8_t *p_app_value) |
Get Protocol Mode characteristic value from local GATT database. More... | |
ble_status_t | R_BLE_HIDS_SetProtocolMode (uint8_t idx, const uint8_t *p_app_value) |
Set Protocol Mode characteristic value to local GATT database. More... | |
ble_status_t | R_BLE_HIDS_SetReport (uint8_t idx, uint8_t report_id, st_ble_gatt_value_t *p_app_value) |
Set Report characteristic value to local GATT database. More... | |
ble_status_t | R_BLE_HIDS_NotifyReport (uint16_t conn_hdl, uint8_t idx, uint8_t report_id, const st_ble_gatt_value_t *p_app_value) |
Send Report notification. More... | |
ble_status_t | R_BLE_HIDS_GetReportReportReference (uint8_t idx, uint8_t report_id, st_ble_hids_report_report_reference_t *p_app_value) |
Get Report characteristic Report Reference descriptor value from local GATT database. More... | |
ble_status_t | R_BLE_HIDS_GetReportMap (uint8_t idx, st_ble_gatt_value_t *p_app_value) |
Get Report Map characteristic value from local GATT database. More... | |
ble_status_t | R_BLE_HIDS_GetReportMapExternalReportReference (uint8_t idx, uint16_t *p_app_value) |
Get Report Map characteristic External Report Reference descriptor value from local GATT database. More... | |
ble_status_t | R_BLE_HIDS_SetBootKeyboardInputReport (uint8_t idx, st_ble_gatt_value_t *p_app_value) |
Set Boot Keyboard Input Report characteristic value to local GATT database. More... | |
ble_status_t | R_BLE_HIDS_NotifyBootKeyboardInputReport (uint16_t conn_hdl, uint8_t idx, const st_ble_gatt_value_t *p_app_value) |
Send Boot Keyboard Input Report notification. More... | |
ble_status_t | R_BLE_HIDS_SetBootKeyboardOutputReport (uint8_t idx, st_ble_gatt_value_t *p_app_value) |
Set Boot Keyboard Output Report characteristic value to local GATT database. More... | |
ble_status_t | R_BLE_HIDS_SetBootMouseInputReport (uint8_t idx, st_ble_gatt_value_t *p_app_value) |
Set Boot Mouse Input Report characteristic value to local GATT database. More... | |
ble_status_t | R_BLE_HIDS_NotifyBootMouseInputReport (uint16_t conn_hdl, uint8_t idx, const st_ble_gatt_value_t *p_app_value) |
Send Boot Mouse Input Report notification. More... | |
ble_status_t | R_BLE_HIDS_GetHidInformation (uint8_t idx, st_ble_hids_hid_information_t *p_app_value) |
Get HID Information characteristic value from local GATT database. More... | |
uint32_t | R_BLE_HIDS_GetVersion (void) |
Return version of the HIDC service server. More... | |
#define BLE_HIDS_HID_INFORMATION_FLAGS_REMOTEWAKE (1 << 0) |
RemoteWake bit.
#define BLE_HIDS_HID_INFORMATION_FLAGS_NORMALLYCONNECTABLE (1 << 1) |
NormallyConnectable bit.
typedef void(* ble_hids_app_cb_t) (uint16_t type, ble_status_t result, st_ble_hids_evt_data_t *data) |
Human Interface Device Service event callback.
enum e_ble_hids_event_t |
Human Interface Device Service event type.
ble_status_t R_BLE_HIDS_Init | ( | const st_ble_hids_init_param_t * | p_param | ) |
Initialize Human Interface Device Service.
This function shall be called once at startup.
[in] | param | Human Interface Device Service initialization parameters. |
ble_status_t R_BLE_HIDS_Connect | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_hids_connect_param_t * | p_param | ||
) |
Perform Human Interface Device Service connection settings.
This function shall be called on each connection establishment.
[in] | conn_hdl | Connection handle. |
[in] | param | Connection parameters. |
The Protocol Mode characteristic value shall be reset to the default value following connection establishment.
ble_status_t R_BLE_HIDS_Disconnect | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
st_ble_hids_disconnect_param_t * | p_param | ||
) |
Retrieve Human Interface Device Service connection specific settings before disconnection.
This function shall be called on each disconnection.
[in] | conn_hdl | Connection handle. |
[in] | param | Disconnection parameters. |
ble_status_t R_BLE_HIDS_GetProtocolMode | ( | uint8_t | idx, |
uint8_t * | p_app_value | ||
) |
Get Protocol Mode characteristic value from local GATT database.
[out] | app_value | Retrieved Protocol Mode characteristic value. |
ble_status_t R_BLE_HIDS_SetProtocolMode | ( | uint8_t | idx, |
const uint8_t * | p_app_value | ||
) |
Set Protocol Mode characteristic value to local GATT database.
[in] | app_value | Protocol Mode characteristic value to set. |
ble_status_t R_BLE_HIDS_SetReport | ( | uint8_t | idx, |
uint8_t | report_id, | ||
st_ble_gatt_value_t * | p_app_value | ||
) |
Set Report characteristic value to local GATT database.
[in] | app_value | Report characteristic value to set. |
ble_status_t R_BLE_HIDS_NotifyReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
uint8_t | report_id, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Send Report notification.
[in] | conn_hdl | Connection handle. |
[in] | app_value | Report value to send. |
ble_status_t R_BLE_HIDS_GetReportReportReference | ( | uint8_t | idx, |
uint8_t | report_id, | ||
st_ble_hids_report_report_reference_t * | p_app_value | ||
) |
Get Report characteristic Report Reference descriptor value from local GATT database.
[out] | app_value | Retrieved Report characteristic Report Reference value. |
ble_status_t R_BLE_HIDS_GetReportMap | ( | uint8_t | idx, |
st_ble_gatt_value_t * | p_app_value | ||
) |
Get Report Map characteristic value from local GATT database.
[out] | app_value | Retrieved Report Map characteristic value. |
ble_status_t R_BLE_HIDS_GetReportMapExternalReportReference | ( | uint8_t | idx, |
uint16_t * | p_app_value | ||
) |
Get Report Map characteristic External Report Reference descriptor value from local GATT database.
[out] | p_app_value | Retrieved Report Map characteristic External Report Reference value. |
ble_status_t R_BLE_HIDS_SetBootKeyboardInputReport | ( | uint8_t | idx, |
st_ble_gatt_value_t * | p_app_value | ||
) |
Set Boot Keyboard Input Report characteristic value to local GATT database.
[in] | app_value | Boot Keyboard Input Report characteristic value to set. |
ble_status_t R_BLE_HIDS_NotifyBootKeyboardInputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Send Boot Keyboard Input Report notification.
[in] | conn_hdl | Connection handle. |
[in] | app_value | Boot Keyboard Input Report value to send. |
ble_status_t R_BLE_HIDS_SetBootKeyboardOutputReport | ( | uint8_t | idx, |
st_ble_gatt_value_t * | p_app_value | ||
) |
Set Boot Keyboard Output Report characteristic value to local GATT database.
[in] | app_value | Boot Keyboard Output Report characteristic value to set. |
ble_status_t R_BLE_HIDS_SetBootMouseInputReport | ( | uint8_t | idx, |
st_ble_gatt_value_t * | p_app_value | ||
) |
Set Boot Mouse Input Report characteristic value to local GATT database.
[in] | app_value | Boot Mouse Input Report characteristic value to set. |
ble_status_t R_BLE_HIDS_NotifyBootMouseInputReport | ( | uint16_t | conn_hdl, |
uint8_t | idx, | ||
const st_ble_gatt_value_t * | p_app_value | ||
) |
Send Boot Mouse Input Report notification.
[in] | conn_hdl | Connection handle. |
[in] | app_value | Boot Mouse Input Report value to send. |
ble_status_t R_BLE_HIDS_GetHidInformation | ( | uint8_t | idx, |
st_ble_hids_hid_information_t * | p_app_value | ||
) |
Get HID Information characteristic value from local GATT database.
[out] | app_value | Retrieved HID Information characteristic value. |
uint32_t R_BLE_HIDS_GetVersion | ( | void | ) |
Return version of the HIDC service server.