hids.h File Reference

Bluetooth HID Service (HIDS) API. More...

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <sys/types.h>
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/gatt.h>
#include <zephyr/sys/util.h>

Go to the source code of this file.

Data Structures
struct	bt_hids_cb
	HID Service callbacks. More...
struct	bt_hids_register_param
	HID Service registration parameters. More...

Macros
#define	BT_HIDS_REPORT_MAP_MAX_LEN   512U
	Maximum Report Map length of one HID Service.

Enumerations
enum	bt_hids_report_type { BT_HIDS_REPORT_TYPE_INPUT = 0x01U , BT_HIDS_REPORT_TYPE_OUTPUT = 0x02U , BT_HIDS_REPORT_TYPE_FEATURE = 0x03U }
	HID Report Type values. More...
enum	bt_hids_info_flags { BT_HIDS_INFO_FLAG_REMOTE_WAKE = BIT(0) , BT_HIDS_INFO_FLAG_NORMALLY_CONNECTABLE = BIT(1) }
	HID Information flags. More...
enum	bt_hids_ctrl_point { BT_HIDS_CTRL_SUSPEND = 0x00U , BT_HIDS_CTRL_EXIT_SUSPEND = 0x01U }
	HID Control Point commands. More...

Functions
int	bt_hids_register (const struct bt_hids_register_param *param)
	Register the HID Service.
int	bt_hids_unregister (void)
	Unregister the HID Service.
int	bt_hids_report_set (enum bt_hids_report_type report_type, uint8_t report_id, const uint8_t *data, uint16_t len)
	Set the value a Host reads from a Report characteristic.
int	bt_hids_report_get (enum bt_hids_report_type report_type, uint8_t report_id, uint8_t *data, uint16_t *len)
	Read back the value of a Report characteristic.
int	bt_hids_send_report (struct bt_conn *conn, uint8_t report_id, const uint8_t *data, uint16_t len, bt_gatt_complete_func_t func, void *user_data)
	Send an Input Report to a Host.

Detailed Description

Bluetooth HID Service (HIDS) API.