Unit HIDKEYBOARD
Return to Unit Reference
Description
Ultibo HID Keyboard Consumer unit
This is a consumer for any generic HID keyboard device, it accepts HID application collections in the generic desktop page (HID_PAGE_GENERIC_DESKTOP) with the usage set to keyboard (HID_DESKTOP_KEYBOARD).
The consumer will bind to any keyboard collection that includes at a minimum an input report containing a field that provides keypress data from the keyboard / keypad page (HID_PAGE_KEYBOARD_KEYPAD) and a field providing modifier keys from the same page.
The consumer will also look for an output report containing a field from the LED page (HID_PAGE_LED) and will use this to set the keyboard LEDs if found.
Up to 16 keypresses per report can be accepted (see HID_KEYBOARD_MAX_KEYS) but most keyboards will commonly report up to 6 which is the size defined in the USB HID usage tables for boot mode keyboard reports.
Constants
HID_KEYBOARD_* HID_KEYBOARD_CONSUMER_NAME = 'HID Keyboard Consumer';
|
Name of HID Keyboard consumer |
HID_KEYBOARD_DESCRIPTION = 'HID Keyboard';
|
Description of HID Keyboard device |
HID_KEYBOARD_MAX_KEYS = 16;
|
Maximum number of keys allowed in any report |
Type definitions
To be documented
Public variables
None defined
Function declarations
To be documented
Return to Unit Reference
