hids_client.h File Reference

HID Service Client header file. More...

#include <string.h>
#include "ble_gattc.h"
#include "ble_client.h"

Go to the source code of this file.

Data Structures
struct	hids_client_hid_info_t
	HID Service Client info data. More...

Enumerations
enum	hids_client_protocol_mode_t { HIDS_CLIENT_PROTOCOL_MODE_BOOT = 0x00, HIDS_CLIENT_PROTOCOL_MODE_REPORT = 0x01 }
	HID Service Client protocol mode. More...
enum	hids_client_report_type_t { HIDS_CLIENT_REPORT_TYPE_INPUT = 0x01, HIDS_CLIENT_REPORT_TYPE_OUTPUT = 0x02, HIDS_CLIENT_REPORT_TYPE_FEATURE = 0x03 }
	HID Service Client report type. More...
enum	hids_client_boot_report_type { HIDS_CLIENT_BOOT_MOUSE_INPUT, HIDS_CLIENT_BOOT_KEYBOARD_INPUT, HIDS_CLIENT_BOOT_KEYBOARD_OUTPUT }
	HID Service Client boot report type. More...
enum	hids_client_cp_command_t { HIDS_CLIENT_CONTROL_POINT_SUSPEND = 0x00, HIDS_CLIENT_CONTROL_POINT_EXIT_SUSPEND = 0x01 }
	HID Service Client control point command. More...
enum	hids_client_cap_t {   HIDS_CLIENT_CAP_PROTOCOL_MODE = 0x01, HIDS_CLIENT_CAP_BOOT_MOUSE_INPUT = 0x02, HIDS_CLIENT_CAP_BOOT_KEYBOARD_INPUT = 0x04, HIDS_CLIENT_CAP_BOOT_KEYBOARD_OUTPUT = 0x08,   HIDS_CLIENT_CAP_HID_INFO = 0x10, HIDS_CLIENT_CAP_HID_CONTROL_POINT = 0x20, HIDS_CLIENT_CAP_REPORT_MAP = 0x40 }
	HIDS Client capabilities. More...

Functions
ble_client_t *	hids_client_init (const hids_client_config_t *config, const hids_client_callbacks_t *cb, const ble_evt_gattc_browse_svc_t *evt)
	Register HID Client instance. More...
ble_client_t *	hids_client_init_from_data (uint16_t conn_idx, const hids_client_config_t *config, const hids_client_callbacks_t *cb, const void *data, size_t length)
	Initialize and register HID Client instance from data buffer. More...
bool	hids_client_set_protocol_mode (ble_client_t *client)
	Set protocol mode. More...
bool	hids_client_boot_report_read (ble_client_t *client, hids_client_boot_report_type type)
	Read Boot Report. More...
bool	hids_client_boot_report_write (ble_client_t *client, hids_client_boot_report_type type, bool response, uint16_t length, const uint8_t *data)
	Write Boot Report. More...
bool	hids_client_report_write (ble_client_t *client, hids_client_report_type_t type, uint8_t report_id, bool response, uint16_t length, const uint8_t *data)
	Write Report. More...
bool	hids_client_report_read (ble_client_t *client, hids_client_report_type_t type, uint8_t report_id)
	Read Report. More...
bool	hids_client_cp_command (ble_client_t *client, hids_client_cp_command_t command)
	Write command to control point. More...
bool	hids_client_input_report_set_notif_state (ble_client_t *client, uint8_t report_id, bool enable)
	Enable/disable notifications for Input Report. More...
bool	hids_client_input_report_get_notif_state (ble_client_t *client, uint8_t report_id)
	Check if notifications are enabled for Input Report. More...
bool	hids_client_boot_report_set_notif_state (ble_client_t *client, hids_client_boot_report_type type, bool enable)
	Enable/disable notifications for Boot Input reports. More...
bool	hids_client_boot_report_get_notif_state (ble_client_t *client, hids_client_boot_report_type type)
	Check if notifications are enabled for Boot Input Report. More...
bool	hids_client_get_protocol_mode (ble_client_t *client)
	Get protocol mode. More...
bool	hids_client_read_hid_info (ble_client_t *client)
	Get HID Info characteristic. More...
bool	hids_client_read_report_map (ble_client_t *client)
	Read Report Map characteristic. More...
bool	hids_client_discover_external_reports (ble_client_t *client)
	Read External Reports descriptors. More...
bool	hids_client_discover_reports (ble_client_t *client)
	Read Report Reference descriptors. More...
hids_client_cap_t	hids_client_get_capabilities (ble_client_t *client)
	Get capabilities. More...
void	hids_client_dump_dervice_data (ble_client_t *client, hids_client_dump_service_data_cb_t cb)
	Dump HID Service data. More...

Detailed Description

HID Service Client header file.

Copyright (C) 2015-2018 Renesas Electronics Corporation and/or its affiliates. All rights reserved. Confidential Information.

This software ("Software") is supplied by Renesas Electronics Corporation and/or its affiliates ("Renesas"). Renesas grants you a personal, non-exclusive, non-transferable, revocable, non-sub-licensable right and license to use the Software, solely if used in or together with Renesas products. You may make copies of this Software, provided this copyright notice and disclaimer ("Notice") is included in all such copies. Renesas reserves the right to change or discontinue the Software at any time without notice.

THE SOFTWARE IS PROVIDED "AS IS". RENESAS DISCLAIMS ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. TO THE MAXIMUM EXTENT PERMITTED UNDER LAW, IN NO EVENT SHALL RENESAS BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE, EVEN IF RENESAS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. USE OF THIS SOFTWARE MAY BE SUBJECT TO TERMS AND CONDITIONS CONTAINED IN AN ADDITIONAL AGREEMENT BETWEEN YOU AND RENESAS. IN CASE OF CONFLICT BETWEEN THE TERMS OF THIS NOTICE AND ANY SUCH ADDITIONAL LICENSE AGREEMENT, THE TERMS OF THE AGREEMENT SHALL TAKE PRECEDENCE. BY CONTINUING TO USE THIS SOFTWARE, YOU AGREE TO THE TERMS OF THIS NOTICE.IF YOU DO NOT AGREE TO THESE TERMS, YOU ARE NOT PERMITTED TO USE THIS SOFTWARE.