hids_client_connect() function

Connect to HID Services of remote device. Event GATTSERVICE_SUBEVENT_HID_SERVICE_CONNECTED will be emitted after all remote HID services and characteristics are found, and notifications for all input reports are enabled. Status code can be ERROR_CODE_SUCCES if at least one HID service is found, otherwise either ATT errors or ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no service or report map or report are found. It also contains the number of individual HIDS Services.

Syntax

Show:

Summary

Declaration

Definition

from hids_client.h:236

uint8_t hids_client_connect(hci_con_handle_t con_handle, btstack_packet_handler_t packet_handler, hid_protocol_mode_t protocol_mode, uint16_t * hids_cid);

Implemented in hids_client.c:1390

Arguments

Argument

Description

con_handle

packet_handler

protocol_mode

see hid_protocol_mode_t in btstack_hid.h

hids_cid

(out) to use for other functions

Return value

status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_COMMAND_DISALLOWED if there is already a client associated with con_handle, or BTSTACK_MEMORY_ALLOC_FAILED.

Examples

References

from examples

hids_client_connect() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle