HID Device API

#include "src/classic/hid_device.h"

typedef struct {
    uint16_t        hid_device_subclass;
    uint8_t         hid_country_code;
    uint8_t         hid_virtual_cable;
    uint8_t         hid_remote_wake;
    uint8_t         hid_reconnect_initiate;
    bool            hid_normally_connectable;
    bool            hid_boot_device;
    uint16_t        hid_ssr_host_max_latency; 
    uint16_t        hid_ssr_host_min_timeout;
    uint16_t        hid_supervision_timeout;
    const uint8_t * hid_descriptor;
    uint16_t        hid_descriptor_size;
    // ServiceName, or NULL
    const char *    device_name;
} hid_sdp_record_t;

hid_create_sdp_record

void hid_create_sdp_record(uint8_t * service, uint32_t service_record_handle, const hid_sdp_record_t * params);

Create HID Device SDP service record.

Parameters

Source


hid_device_init

void hid_device_init(bool boot_protocol_mode_supported, uint16_t hid_descriptor_len, const uint8_t * hid_descriptor);

Set up HID Device

Parameters

Source


hid_device_register_packet_handler

void hid_device_register_packet_handler(btstack_packet_handler_t callback);

Register callback for the HID Device client.

Parameters

Source


hid_device_register_report_request_callback

void hid_device_register_report_request_callback(int (*callback)(uint16_t hid_cid, hid_report_type_t report_type, uint16_t report_id, int * out_report_size, uint8_t * out_report));

Register get report callback for the HID Device client.

Parameters

Source


hid_device_register_set_report_callback

void hid_device_register_set_report_callback(void (*callback)(uint16_t hid_cid, hid_report_type_t report_type, int report_size, uint8_t * report));

Register set report callback for the HID Device client.

Parameters

Source


hid_device_register_report_data_callback

void hid_device_register_report_data_callback(void (*callback)(uint16_t cid, hid_report_type_t report_type, uint16_t report_id, int report_size, uint8_t * report));

Register callback to receive report data for the HID Device client.

Parameters

Source


hid_device_connect

uint8_t hid_device_connect(bd_addr_t addr, uint16_t * hid_cid);

Register callback to receive report data for the HID Device client.

Create HID connection to HID Host

Parameters

Returns

Source


hid_device_disconnect

void hid_device_disconnect(uint16_t hid_cid);

Register callback to receive report data for the HID Device client.

Create HID connection to HID Host

Disconnect from HID Host

Parameters

Source


hid_device_request_can_send_now_event

void hid_device_request_can_send_now_event(uint16_t hid_cid);

Request can send now event to send HID Report Generates an HID_SUBEVENT_CAN_SEND_NOW subevent

Parameters

Source


hid_device_send_interrupt_message

void hid_device_send_interrupt_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len);

Send HID message on interrupt channel

Parameters

Source


hid_device_send_control_message

void hid_device_send_control_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len);

Send HID message on control channel

Parameters

Source


hid_device_in_boot_protocol_mode

int hid_device_in_boot_protocol_mode(uint16_t hid_cid);

Retutn 1 if boot protocol mode active

Parameters

Returns

Source


hid_device_accept_truncated_hid_reports

void hid_device_accept_truncated_hid_reports(bool accept_truncated);

Configure if HID reports shorter than descriptor-defined size are accepted

Note: The HID Test Specification requires to reject HID reports with incorrect size

Parameters

Source


hid_device_deinit

void hid_device_deinit(void);

De-Init HID Device

Source