nRF Connect SDK Bare Metal API 2.0.99
Loading...
Searching...
No Matches
Human Interface Device Service

Human Interface Device Service. More...

Data Structures

struct  ble_hids_input_report
 HID input report. More...
 
struct  ble_hids_boot_keyboard_input_report
 Bluetooth LE HID service boot keyboard input report. More...
 
struct  ble_hids_boot_mouse_input_report
 Bluetooth LE HID service boot mouse input report. More...
 
struct  ble_hids_client_context
 HID Host context structure. It keeps information relevant to a single host. More...
 
struct  ble_hids_link_ctx_storage
 
struct  ble_hids_char_id
 HID Service characteristic id. More...
 
struct  ble_hids_evt
 HID Service event. More...
 
struct  ble_hids_report_config
 HID Report configuration. More...
 
struct  ble_hids_rep_map_config
 HID Service Report Map characteristic init structure. This contains all options and data needed for initialization of the Report Map characteristic. More...
 
struct  ble_hids_rep_char
 HID Report characteristic structure. More...
 
struct  ble_hids_config
 HID service configuration. More...
 
struct  ble_hids
 HID Service structure. This contains various status information for the service. More...
 

Macros

#define BLE_HIDS_DEF(_name)
 Define a HID service instance.
 
#define BLE_HIDS_CONFIG_SEC_MODE_DEFAULT_MOUSE
 Default mouse security configuration.
 
#define BLE_HIDS_CONFIG_SEC_MODE_DEFAULT_KEYBOARD
 Default keyboard security configuration.
 
#define BLE_HIDS_BOOT_KB_INPUT_REPORT_MAX_SIZE   8
 HID boot keyboard input report maximum size, in bytes.
 
#define BLE_HIDS_BOOT_KB_OUTPUT_REPORT_MAX_SIZE   1
 HID boot keyboard output report maximum size, in bytes.
 
#define BLE_HIDS_BOOT_MOUSE_INPUT_REPORT_MAX_SIZE   8
 HID boot mouse input report maximum size, in bytes.
 
#define BLE_HIDS_LINK_CTX_SIZE
 
#define CTX_DATA_POOL_SIZE   ((CONFIG_BLE_HIDS_MAX_CLIENTS) * BYTES_TO_WORDS(BLE_HIDS_LINK_CTX_SIZE))
 Size of links context memory pool.
 

Typedefs

typedef void(* ble_hids_evt_handler_t) (struct ble_hids *hids, const struct ble_hids_evt *evt)
 HID service event handler type.
 

Enumerations

enum  ble_hids_report_type { BLE_HIDS_REPORT_TYPE_RESERVED = 0x00 , BLE_HIDS_REPORT_TYPE_INPUT = 0x01 , BLE_HIDS_REPORT_TYPE_OUTPUT = 0x02 , BLE_HIDS_REPORT_TYPE_FEATURE = 0x03 }
 HID report types as defined in the Report Reference Characteristic descriptor. More...
 
enum  ble_hids_evt_type {
  BLE_HIDS_EVT_HOST_SUSP , BLE_HIDS_EVT_HOST_EXIT_SUSP , BLE_HIDS_EVT_NOTIF_ENABLED , BLE_HIDS_EVT_NOTIF_DISABLED ,
  BLE_HIDS_EVT_REP_CHAR_WRITE , BLE_HIDS_EVT_BOOT_MODE_ENTERED , BLE_HIDS_EVT_REPORT_MODE_ENTERED , BLE_HIDS_EVT_REPORT_READ ,
  BLE_HIDS_EVT_ERROR
}
 HID Service event type. More...
 

Functions

void ble_hids_on_ble_evt (const ble_evt_t *ble_evt, void *ble_hids)
 Bluetooth LE event handler for the HID Service.
 
uint32_t ble_hids_init (struct ble_hids *hids, const struct ble_hids_config *hids_cfg)
 Function for initializing the HID Service.
 
uint32_t ble_hids_inp_rep_send (struct ble_hids *hids, uint16_t conn_handle, struct ble_hids_input_report *report)
 Function for sending Input Report.
 
uint32_t ble_hids_boot_kb_inp_rep_send (struct ble_hids *hids, uint16_t conn_handle, struct ble_hids_boot_keyboard_input_report *report)
 Function for sending Boot Keyboard Input Report.
 
uint32_t ble_hids_boot_mouse_inp_rep_send (struct ble_hids *hids, uint16_t conn_handle, struct ble_hids_boot_mouse_input_report *report)
 Function for sending Boot Mouse Input Report.
 
uint32_t ble_hids_outp_rep_get (struct ble_hids *hids, uint8_t report_index, uint16_t len, uint8_t offset, uint16_t conn_handle, uint8_t *outp_rep)
 Function for getting the current value of Output Report from the stack.
 

Detailed Description

Human Interface Device Service.