IOKit/hidsystem/IOHIDUsageTables.h Kernel.framework

Usage Pages

Undefined Usage for all usage pages

GenericDesktop Page (0x01)

Simulation Page (0x02) This section provides detailed descriptions of the usages employed by simulation devices.

VR Page (0x03) Virtual Reality controls depend on designators to identify the individual controls. Most of the following are usages are applied to the collections of entities that comprise the actual device.

Sport Page (0x04)

Game Page (0x05)

Generic Device Controls (0x0g)

KeyboardOrKeypad Page (0x07) This section is the Usage Page for key codes to be used in implementing a USB keyboard. A Boot Keyboard (84-, 101- or 104-key) should at a minimum support all associated usage codes as indicated in the �Boot� column below. The usage type of all key codes is Selectors (Sel), except for the modifier keys Keyboard Left Control (0x224) to Keyboard Right GUI (0x231) which are Dynamic Flags (DV). Note: A general note on Usages and languages: Due to the variation of keyboards from language to language, it is not feasible to specify exact key mappings for every language. Where this list is not specific for a key function in a language, the closest equivalent key position should be used, so that a keyboard may be modified for a different language by simply printing different keycaps. One example is the Y key on a North American keyboard. In Germany this is typically Z. Rather than changing the keyboard firmware to put the Z Usage into that place in the descriptor list, the vendor should use the Y Usage on both the North American and German keyboards. This continues to be the existing practice in the industry, in order to minimize the number of changes to the electronics to accommodate otherlanguages.

LEDs Page (0x08) An LED or indicator is implemented as an On/Off Control (OOF) using the �Single button toggle� mode, where a value of 1 will turn on the indicator, and a value of 0 will turn it off. The exceptions are described below.

Button Page (0x09) The Button page is the first place an application should look for user selection controls. System graphical user interfaces typically employ a pointer and a set of hierarchical selectors to select, move and otherwise manipulate their environment. For these purposes the following assignment of significance can be applied to the Button usages: � Button 1, Primary Button. Used for object selecting, dragging, and double click activation. On MacOS, this is the only button. Microsoft operating systems call this a logical left button, because it is not necessarily physically located on the left of the pointing device. � Button 2, Secondary Button. Used by newer graphical user interfaces to browse object properties. Exposed by systems to applications that typically assign application-specific functionality. � Button 3, Tertiary Button. Optional control. Exposed to applications, but seldom assigned functionality due to prevalence of two- and one-button devices. � Buttons 4 -55. As the button number increases, its significance as a selector decreases. In many ways the assignment of button numbers is similar to the assignment of Effort in Physical descriptors. Button 1 would be used to define the button a finger rests on when the hand is in the �at rest� position, that is, virtually no effort is required by the user to activate the button. Button values increment as the finger has to stretch to reach a control. See Section 6.2.3, �Physical Descriptors,� in the HID Specification for methods of further qualifying buttons.

Ordinal Page (0x0A) The Ordinal page allows multiple instances of a control or sets of controls to be declared without requiring individual enumeration in the native usage page. For example, it is not necessary to declare usages of Pointer 1, Pointer 2, and so forth on the Generic Desktop page. When parsed, the ordinal instance number is, in essence, concatenated to the usages attached to the encompassing collection to create Pointer 1, Pointer 2, and so forth. For an example, see Section A.5, �Multiple Instances of a Control,� in Appendix A, �Usage Examples.� By convention, an Ordinal collection is placed inside the collection for which it is declaring multiple instances. Instances do not have to be identical.

Telephony Page (0x0B) This usage page defines the keytop and control usages for telephony devices. Indicators on a phone are handled by wrapping them in LED: Usage In Use Indicator and LED: Usage Selected Indicator usages. For example, a message-indicator LED would be identified by a Telephony: Message usage declared as a Feature or Output in a LED: Usage In Use Indicator collection. See Section 14, �Consumer Page (0x0C),� for audio volume and tone controls.

Consumer Page (0x0C) All controls on the Consumer page are application-specific. That is, they affect a specific device, not the system as a whole.

Digitizer Page (0x0D) This section provides detailed descriptions of the usages employed by Digitizer Devices.

Haptics Feedback Controls Page (0x0E) This section provides detailed descriptions of the usages employed by Haptics Controllers.

Physical Interface Device Page (0x0F) This section provides detailed descriptions of the usages employed by Power Devices.

AlphanumericDisplay Page (0x14) The Alphanumeric Display page is intended for use by simple alphanumeric displays that are used on consumer devices.

Sensor Page (0x20) The Sensor page is intended for use by devices that capture biometric, electrical, environmental, light, location, mechanical, motion, orientation, scanner, etc events.

Braille Display Page (0x20) The Braille Display page is intended for use by devices that allow visually impaired computer users to read out text using raised pins. These devices also have support for controls that help navigate the computer screen. Typically, braille displays interface with software known as a screen reader in order to perform this navigation.

Power Device Page (0x84) This section provides detailed descriptions of the usages employed by Power Devices.