Universal Serial Bus (USB)
HID Usage Tables
1/21/2005
Version 1.12
Please send comments via electronic mail to:
hidcomments@usb.org
©1996-2005 USB Implementers’ Forum—All rights reserved.
Universal Serial Bus HID Usage Tables
ii
Contributors
Brian M. Bates – ELO Touchsystems
Robert Dezmelyk – LCS/Telegraphics
Robert Ingman – Microsoft Corporation
Rob Lieb – Symbol Technologies, Inc.
Steve McGowan – Intel (Editor)
Kenneth Ray – Microsoft Corporation
Steve Schumacher – LCS/Telegraphics
Nathan C. Sherman - Microsoft Corporation
Don Stern – TV Interactive
Mike Van Flandern – Microsoft Corporation
Remy Zimmerman – Logitech International
And many others.
Version 1.12
January 21, 2005
Universal Serial Bus HID Usage Tables
iii
Revision History
Issue Date
Revision
January 21, 2005
1.12
1.12rc1
October 28, 2004
1.11
1.11rc1
1.1
1.1rc3
1.1rc2
1.1rc1
1.0
June 27, 2001
August 7, 2000
April 8, 1999
February 16, 1999
January 21, 1999
October 13,1998
October 30, 1997
Comments
Version 1.12 release
Incorporate HUT Review Request 20, 21,
22, 23, 24, 25, 27, and 29.
Version 1.11 release
Incorporate HUT Review Request 1, 2, 3, 4,
5, 6, 7, 8, 9, 11, 13, 14, 15,16, 17, and 18.
Version 1.1 release
Correct barcode Usage Page ID.
Corrected page numbering.
Incorporate HID Review Request 51.
Incorporate Keyboard Usage Table from the
1.0 HID Specification and HID Review
Requests 16, 34, 38, 40, 41, 42, 43, 45, 46,
48 and 49.
Version 1
Version 1.12
January 21, 2005
Universal Serial Bus HID Usage Tables
iv
Copyright © 1996-2005, USB Implementers Forum
All rights reserved.
INTELLECTUAL PROPERTY DISCLAIMER
THIS SPECIFICATION IS PROVIDED “AS IS” WITH NO WARRANTIES WHATSOEVER INCLUDING ANY
WARRANTY OF MERCHANTABILITY, FITNESS FOR ANY PARTICULAR PURPOSE, OR ANY WARRANTY
OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION, OR SAMPLE.
A LICENSE IS HEREBY GRANTED TO REPRODUCE AND DISTRIBUTE THIS SPECIFICATION FOR INTERNAL USE
ONLY. NO OTHER LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY OTHER
INTELLECTUAL PROPERTY RIGHTS IS GRANTED OR INTENDED HEREBY.
AUTHORS OF THIS SPECIFICATION DISCLAIM ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT
OF PROPRIETARY RIGHTS, RELATING TO IMPLEMENTATION OF INFORMATION IN THIS SPECIFICATION.
AUTHORS OF THIS SPECIFICATION ALSO DO NOT WARRANT OR REPRESENT THAT SUCH
IMPLEMENTATION(S) WILL NOT INFRINGE SUCH RIGHTS.
All product names are trademarks, registered trademarks, or service marks of their respective owners.
Please send comments via electronic mail to hidcomments’at’usb.org, us the @ sign for ‘at’.
Version 1.12
January 21, 2005
Universal Serial Bus HID Usage Tables
v
Table of Contents
1
3.1
3.2
3.3
3.4
3.5
3.6
1.1
1.2
1.3
1.4
3.4.1
3.4.2
3.4.3
3.4.4
3.5.1
3.5.2
3.5.3
3.6.1
3.6.2
INTRODUCTION.................................................................................................................................11
SCOPE ..............................................................................................................................................11
PURPOSE ..........................................................................................................................................11
RELATED DOCUMENTS ....................................................................................................................12
TERMS AND ABBREVIATIONS...........................................................................................................12
2 MANAGEMENT OVERVIEW...........................................................................................................13
3 USAGE PAGES.....................................................................................................................................14
HID USAGE TABLE CONVENTIONS ..................................................................................................15
HANDLING UNKNOWN USAGES .......................................................................................................15
USAGES AND UNITS .........................................................................................................................16
USAGE TYPES ..................................................................................................................................16
Usage Types (Controls)...........................................................................................................17
Usage Types (Data).................................................................................................................18
Usage Types (Collection)........................................................................................................20
Alternate Types........................................................................................................................21
SYSTEM CONTROLS .........................................................................................................................22
Keyboard.................................................................................................................................22
Mice.........................................................................................................................................22
Joysticks ..................................................................................................................................22
HID LANGIDS................................................................................................................................22
Usage Data Descriptor (0x01)................................................................................................24
Vendor Defined HID LANGID (0x3C - 0x3F) ........................................................................24
4 GENERIC DESKTOP PAGE (0X01) .................................................................................................26
APPLICATION USAGES .....................................................................................................................28
4.1
AXIS USAGES...................................................................................................................................29
4.2
4.3 MISCELLANEOUS CONTROLS ...........................................................................................................29
Resolution Multiplier...............................................................................................................30
VECTOR USAGES .............................................................................................................................31
4.4
SYSTEM CONTROLS .........................................................................................................................32
4.5
Power Controls .......................................................................................................................32
BUFFERED BYTES ............................................................................................................................34
4.6
DIRECTION PADS .............................................................................................................................34
4.7
4.8
FEATURE NOTIFICATIONS ................................................................................................................34
4.9
SOFTWARE FLOW CONTROLS...........................................................................................................35
4.10 SYSTEM DISPLAY CONTROLS...........................................................................................................35
SIMULATION CONTROLS PAGE (0X02).......................................................................................37
SPORTS SIMULATION DEVICE ..........................................................................................................38
5.1
FLIGHT SIMULATION DEVICES.........................................................................................................38
5.2
5.3
AUTOMOBILE SIMULATION DEVICES ...............................................................................................41
TANK SIMULATION DEVICES ...........................................................................................................42
5.4
5.5 MARITIME SIMULATION DEVICES....................................................................................................42
5.6
TWO-WHEELED SIMULATION DEVICES ............................................................................................43
5.7 MISCELLANEOUS SIMULATION DEVICES..........................................................................................43
6 VR CONTROLS PAGE (0X03)...........................................................................................................44
4.3.1
4.5.1
5
Version 1.12
January 21, 2005
vi
7
7.1
7.2
15
Universal Serial Bus HID Usage Tables
8.4.1
8.1
8.2
8.3
8.4
12
13
14
SPORT CONTROLS PAGE (0X04)....................................................................................................46
STICK DEVICES ................................................................................................................................47
EXERCISE MACHINES .......................................................................................................................48
8 GAME CONTROLS PAGE (0X05).....................................................................................................49
3D GAME CONTROLLER...................................................................................................................50
PINBALL DEVICE..............................................................................................................................51
GUN DEVICE ....................................................................................................................................51
GAMEPADS.......................................................................................................................................52
Gamepad Button Collections...................................................................................................52
9 GENERIC DEVICE CONTROLS PAGE (0X06) ..............................................................................53
10
KEYBOARD/KEYPAD PAGE (0X07)............................................................................................54
LED PAGE (0X08) ............................................................................................................................62
11
11.1 KEYBOARD INDICATORS ..................................................................................................................64
11.2 TELEPHONY INDICATORS .................................................................................................................64
11.3 CONSUMER INDICATORS ..................................................................................................................65
11.4 MEDIA TRANSPORT INDICATORS......................................................................................................65
11.5 PRINTER INDICATORS.......................................................................................................................66
11.6 GENERAL DEVICE INDICATORS ........................................................................................................66
BUTTON PAGE (0X09)....................................................................................................................69
ORDINAL PAGE (0X0A).................................................................................................................70
TELEPHONY DEVICE PAGE (0X0B) ..........................................................................................71
14.1 TELEPHONY DEVICES.......................................................................................................................73
14.2 TELEPHONY KEY PAD USAGES ........................................................................................................73
14.3 CALL CONTROL................................................................................................................................74
14.4 SPEED DIAL CONTROLS....................................................................................................................75
14.5 VOICE MAIL CONTROLS...................................................................................................................75
14.6 LOCALLY GENERATED TONES..........................................................................................................75
CONSUMER PAGE (0X0C) ............................................................................................................77
15.1 GENERIC CONSUMER CONTROL DEVICE ..........................................................................................87
15.2 NUMERIC KEY PAD ..........................................................................................................................88
15.3 GENERAL CONTROLS .......................................................................................................................88
15.4 MENU CONTROLS.............................................................................................................................89
15.5 DISPLAY CONTROLS.........................................................................................................................89
15.6 SELECTION CONTROLS.....................................................................................................................89
15.7 TRANSPORT CONTROLS....................................................................................................................91
15.8 SEARCH CONTROLS..........................................................................................................................92
15.9 AUDIO CONTROLS............................................................................................................................92
15.9.1 Volume.....................................................................................................................................92
15.9.2 Balance....................................................................................................................................92
15.9.3 Bass .........................................................................................................................................93
15.9.4
Treble ......................................................................................................................................93
15.9.5 Other........................................................................................................................................93
15.10
SPEED CONTROLS.........................................................................................................................93
15.11 HOME AND SECURITY CONTROLS ................................................................................................94
Version 1.12
January 21, 2005
Universal Serial Bus HID Usage Tables
vii
16
17
18
15.12.1
SPEAKER CHANNELS....................................................................................................................95
15.12
Audio Channels ...................................................................................................................95
15.13
PC THEATRE................................................................................................................................97
15.14
PROGRAMMABLE BUTTONS .........................................................................................................97
15.15 APPLICATION LAUNCH BUTTONS.................................................................................................97
15.16 GENERIC GUI APPLICATION CONTROLS ....................................................................................101
DIGITIZERS (0X0D)......................................................................................................................106
16.1 DIGITIZER DEVICES .......................................................................................................................107
16.2 DIGITIZER TRANSDUCER COLLECTION USAGES.............................................................................108
16.3 DIGITIZER REPORT FIELD USAGES.................................................................................................108
16.3.1 Digitizer-Specific Fields........................................................................................................108
Tilt Orientation......................................................................................................................109
16.3.2
16.3.3 Azimuth-Altitude Orientation ................................................................................................109
16.4 DIGITIZER SWITCH USAGES ...........................................................................................................110
UNICODE PAGE (0X10) ...............................................................................................................111
ALPHANUMERIC DISPLAY PAGE (0X14) ..............................................................................112
18.1 ALPHANUMERIC DISPLAY..............................................................................................................114
18.1.1 Flags......................................................................................................................................114
18.1.2 Display Control.....................................................................................................................116
18.1.3
Scrolling................................................................................................................................117
18.1.4 Character Transfers..............................................................................................................117
18.1.5 Display Status........................................................................................................................118
18.1.6 Cursor Control......................................................................................................................119
18.1.7 Font Loading.........................................................................................................................121
18.1.8 Character Formats................................................................................................................122
18.2 BITMAPPED DISPLAY .....................................................................................................................124
18.2.1 Display Attributes Report......................................................................................................125
18.2.2 Orientation............................................................................................................................127
18.2.3 Palette Report........................................................................................................................128
18.2.4 Blit Report.............................................................................................................................129
18.2.5
Soft Button Report.................................................................................................................129
19 MEDICAL INSTRUMENT PAGE (0X40)...................................................................................130
19.1 ULTRASOUND DEVICES..................................................................................................................131
19.2 ACQUISITION CONTROLS ...............................................................................................................131
19.3 SIGNAL MODULATION ...................................................................................................................132
19.4 ACQUISITION AND DISPLAY MODE CONTROLS ..............................................................................132
APPENDIX A: USAGE EXAMPLES.......................................................................................................134
A.1 VOLUME CONTROL........................................................................................................................134
Up/Down Buttons..................................................................................................................134
Knob......................................................................................................................................134
TAPE JOG WHEEL ..........................................................................................................................134
A.2
A.3 RADIO BUTTONS............................................................................................................................135
A.3.1 Mechanically Linked Radio Buttons......................................................................................135
Radio Buttons with No Mechanical Linkage.........................................................................135
A.3.2
A.4 NAMED ARRAY FIELD....................................................................................................................135
A.5 MULTIPLE INSTANCES OF A CONTROL ...........................................................................................136
A.6 MULTIPLE INSTANCES OF A MULTI-MODE LED ............................................................................136
A.7 DESKTOP TABLET EXAMPLE..........................................................................................................138
A.1.1
A.1.2
Version 1.12
January 21, 2005
Universal Serial Bus HID Usage Tables
viii
A.11.1
A.8 A DEVICE WITH A DISPLAY............................................................................................................141
A.9 REMOTE CONTROL.........................................................................................................................145
TELEPHONE................................................................................................................................146
A.10
Multi-Line Snippet..............................................................................................................149
A.12
JOYSTICK....................................................................................................................................149
GAME PAD .................................................................................................................................151
A.13
A.14 GRAPHIC EQUALIZER ........................................................................................................................152
19.5 SAMPLE BITMAPPED DISPLAY DEVICE...........................................................................................154
19.5.1 Example Bitmapped Display Report Descriptor ...................................................................155
APPENDIX B: DELIMITER EXAMPLE ................................................................................................158
APPENDIX C: PHYSICAL DESCRIPTOR EXAMPLE........................................................................160
USAGE INDEX ...........................................................................................................................................164
Version 1.12
January 21, 2005