Atmel Software Framework

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
USB Device Interface (UDI) for Human Interface Device (HID) Keyboard Class

Common APIs used by high level application to use this USB class.

See Quick start guide for USB device keyboard module (UDI keyboard).

Modules

 
 Quick Start Guide(s)
 In this section you can find a list of all Quick Start guides related to the USB Device Interface (UDI) for Human Interface Device (HID) Keyboard Class.
 
 Interface with USB Device Core (UDC)
 Structures and functions required by UDC.
 
 Implementation of UDI HID keyboard
 Class internal implementation.
 
 USB interface descriptors
 The following structures provide predefined USB interface descriptors.
 
 USB device descriptors for a single interface
 The following structures provide the USB device descriptors required for USB Device with a single interface HID keyboard.
 

Functions

bool udi_hid_kbd_down (uint8_t key_id)
 Send events key pressed. More...
 
bool udi_hid_kbd_modifier_down (uint8_t modifier_id)
 Send events key modifier pressed. More...
 
bool udi_hid_kbd_modifier_up (uint8_t modifier_id)
 Send events key modifier released. More...
 
bool udi_hid_kbd_up (uint8_t key_id)
 Send events key released. More...
 

bool udi_hid_kbd_down ( uint8_t  key_id)
bool udi_hid_kbd_modifier_down ( uint8_t  modifier_id)

Send events key modifier pressed.

Parameters
modifier_idID of key modifier
Returns
1 if function was successfully done, otherwise 0.

References cpu_irq_restore(), cpu_irq_save(), udi_hid_kbd_b_report_valid, udi_hid_kbd_report, and udi_hid_kbd_send_report().

bool udi_hid_kbd_modifier_up ( uint8_t  modifier_id)

Send events key modifier released.

Parameters
modifier_idID of key modifier
Returns
1 if function was successfully done, otherwise 0.

References cpu_irq_restore(), cpu_irq_save(), udi_hid_kbd_b_report_valid, udi_hid_kbd_report, and udi_hid_kbd_send_report().

bool udi_hid_kbd_up ( uint8_t  key_id)

Send events key released.

Parameters
key_idID of key
Returns
1 if function was successfully done, otherwise 0.

References cpu_irq_restore(), cpu_irq_save(), i, udi_hid_kbd_b_report_valid, udi_hid_kbd_report, UDI_HID_KBD_REPORT_SIZE, and udi_hid_kbd_send_report().