USB Device Interface (UDI) for Human Interface Device Keyboard (HID keyboard) provides an interface for the configuration and management of USB HID keyboard device.
The outline of this documentation is as follows:
For more details for Atmel® Software Framework (ASF) USB Device Stack and USB Device HID keyboard, refer to following application notes:
Data Structures | |
struct | udi_hid_kbd_desc_t |
Interface descriptor structure for HID keyboard. More... | |
struct | udi_hid_kbd_report_desc_t |
Report descriptor for HID keyboard. More... | |
Interface with USB Device Core (UDC) | |
UDC_DESC_STORAGE udi_api_t | udi_api_hid_kbd |
Global structure which contains standard UDI API for UDC. More... | |
USB Interface Descriptors | |
The following structures provide predefined USB interface descriptors. It must be used to define the final USB descriptors. | |
#define | UDI_HID_KBD_STRING_ID 0 |
By default no string associated to this interface. More... | |
#define | UDI_HID_KBD_EP_SIZE 8 |
HID keyboard endpoints size. More... | |
#define | UDI_HID_KBD_DESC |
Content of HID keyboard interface descriptor for all speed. More... | |
USB Device Interface (UDI) for Human Interface Device (HID) Keyboard Class | |
Common APIs used by high level application to use this USB class. | |
bool | udi_hid_kbd_modifier_up (uint8_t modifier_id) |
Send events key modifier released. More... | |
bool | udi_hid_kbd_modifier_down (uint8_t modifier_id) |
Send events key modifier pressed. More... | |
bool | udi_hid_kbd_up (uint8_t key_id) |
Send events key released. More... | |
bool | udi_hid_kbd_down (uint8_t key_id) |
Send events key pressed. More... | |
#define UDI_HID_KBD_DESC |
Content of HID keyboard interface descriptor for all speed.
#define UDI_HID_KBD_EP_SIZE 8 |
HID keyboard endpoints size.
#define UDI_HID_KBD_STRING_ID 0 |
By default no string associated to this interface.
bool udi_hid_kbd_down | ( | uint8_t | key_id | ) |
Send events key pressed.
[in] | key_id | ID of key |
1
if function was successfully done, otherwise 0
. bool udi_hid_kbd_modifier_down | ( | uint8_t | modifier_id | ) |
Send events key modifier pressed.
[in] | modifier_id | ID of key modifier |
1
if function was successfully done, otherwise 0
. bool udi_hid_kbd_modifier_up | ( | uint8_t | modifier_id | ) |
Send events key modifier released.
[in] | modifier_id | ID of key modifier |
1
if function was successfully done, otherwise 0
. bool udi_hid_kbd_up | ( | uint8_t | key_id | ) |
Send events key released.
[in] | key_id | ID of key |
1
if function was successfully done, otherwise 0
. UDC_DESC_STORAGE udi_api_t udi_api_hid_kbd |
Global structure which contains standard UDI API for UDC.