HID Service registration parameters. More...

#include <zephyr/bluetooth/services/hids.h>

Data Fields
uint16_t	bcd_hid
	Version of the USB HID Specification the Device implements.
uint8_t	country_code
	Country code of the localized hardware.
uint8_t	flags
	HID Information flags, see bt_hids_info_flags.
const uint8_t *	report_map
	HID Report Map descriptor data.
uint16_t	report_map_len
	Length of report_map in bytes.
uint8_t	input_report_ids [CONFIG_BT_HIDS_INPUT_REPORT_COUNT]
	Report IDs of the Input Report characteristics.
uint8_t	output_report_ids [CONFIG_BT_HIDS_OUTPUT_REPORT_COUNT]
	Report IDs of the Output Report characteristics.
uint8_t	feature_report_ids [CONFIG_BT_HIDS_FEATURE_REPORT_COUNT]
	Report IDs of the Feature Report characteristics.
const struct bt_hids_cb *	cb
	Application callbacks.

Detailed Description

HID Service registration parameters.

Field Documentation

◆ bcd_hid

uint16_t bt_hids_register_param::bcd_hid

Version of the USB HID Specification the Device implements.

The bcdHID field of the HID Information characteristic, in binary coded decimal: 0xJJMN is version JJ.M.N, so 0x0111 is version 1.11. Every nibble is a decimal digit, so a value such as 0x0abc makes bt_hids_register() fail.

◆ cb

const struct bt_hids_cb* bt_hids_register_param::cb

Application callbacks.

The callback structure is not copied and must remain valid until bt_hids_unregister() is called.

◆ country_code

uint8_t bt_hids_register_param::country_code

Country code of the localized hardware.

The bCountryCode field of the HID Information characteristic, defined by the USB HID Specification, section 6.2.1. 0 if the hardware is not localized.

◆ feature_report_ids

uint8_t bt_hids_register_param::feature_report_ids[CONFIG_BT_HIDS_FEATURE_REPORT_COUNT]

Report IDs of the Feature Report characteristics.

See CONFIG_BT_HIDS_FEATURE_REPORT_COUNT.

◆ flags

uint8_t bt_hids_register_param::flags

HID Information flags, see bt_hids_info_flags.

Setting BT_HIDS_INFO_FLAG_NORMALLY_CONNECTABLE tells the Host that the Device is connectable whenever it is bonded and not connected. The advertising state is owned by the application, so the application has to implement that behavior if it sets the flag.

Only the flags in bt_hids_info_flags may be set. Any other bit makes bt_hids_register() fail.

◆ input_report_ids

uint8_t bt_hids_register_param::input_report_ids[CONFIG_BT_HIDS_INPUT_REPORT_COUNT]

Report IDs of the Input Report characteristics.

One Report ID per Input Report characteristic, in the order the characteristics appear in the service. The number of Input Report characteristics is set with CONFIG_BT_HIDS_INPUT_REPORT_COUNT.

◆ output_report_ids

uint8_t bt_hids_register_param::output_report_ids[CONFIG_BT_HIDS_OUTPUT_REPORT_COUNT]

Report IDs of the Output Report characteristics.

See CONFIG_BT_HIDS_OUTPUT_REPORT_COUNT.

◆ report_map

const uint8_t* bt_hids_register_param::report_map

HID Report Map descriptor data.

At most BT_HIDS_REPORT_MAP_MAX_LEN octets.

The Report Map is not copied. It is read directly whenever a Host reads the Report Map characteristic, so it must remain valid until bt_hids_unregister() is called.

◆ report_map_len

uint16_t bt_hids_register_param::report_map_len

Length of report_map in bytes.

The documentation for this struct was generated from the following file:

zephyr/bluetooth/services/hids.h

Data Fields