HID Sensor Usage Tables - USB.org

More documents

Recommendations

Info

60 HID Sensor Usages 3.4 HID Reports HID communication transactions are accomplished by transferring Reports. On the USB bus, every HID Report begins with a SETUP packet on the Control Pipe, followed by a DATA packet on the Control Pipe, Input Pipe, or Output Pipe. Inside the SETUP packet are some fields that indicate: The HID-protocol request transfer type, such as GET_REPORT or SET_REPORT; The report type, such as Input, Output, or Feature; A numeric identifier for the report, called a Report ID, which is always the first byte of the of the DATA packet; The total length of the DATA packet (actual length sent, or expected length desired to receive). On other busses, this discriminating information may be transmitted in a slightly different manner. See Also For more information about SETUP packets; please refer to Section 9.3 of the Universal Serial Bus Specification (Reference Document [1]). For more information about HID Reports; please refer to Sections 5.2, 5.6, 7.2.1, and 7.2.2 of the Device Class Definition for Human Interface Devices specification (Reference Document [2]). The combination of the transfer type and report type determine the nature of the communication transaction, as summarized in the following table. Report Type Transfer for a GET_REPORT Transfer for a SET_REPORT Input Via: HID Interrupt In Pipe Data Direction: Device Host “HID GET INPUT REPORT” N/A Output N/A Via: HID Interrupt Out pipe Data Direction: Host Device “HID SET OUTPUT REPORT” Feature Via: Control pipe Via: Control pipe Data Direction: Device Host Data Direction: Host Device “HID GET FEATURE REPORT” “HID SET FEATURE REPORT” 3.5 HID Report IDs Table 6. HID Transfer and Report Types The first byte of each report (byte position 0) is always the Report ID, which is used to differentiate reports from one another. Report IDs are assigned by the device implementer. For a sensor physical device which represents more than one logical device, each of the logical devices must have a disjoint set of Report IDs. This can be done by judiciously assigning ranges of Report ID numbers for each logical device. The following table shows an example of only one of many possible Report ID allocation schemes that an implementer may choose. Logical sensor device Report ID range First 0x10 – 0x1f Second 0x20 – 0x2f
61 HID Sensor Usages Third 0x30 – 0x3f Table 7. A Report ID allocation scheme example Because the SETUP packet has fields describing the request type separate from the Report ID, it is OK to “re use” Report IDs for Input Reports, Output Reports, and Feature Reports. For example, a sensor can have an Input Report with Report ID 0x01, an Output Report with Report ID 0x01, and a Feature Report with Report ID 0x01. These are all separate Reports with different contents. If you find this too confusing, you may wish to assign different Report IDs, for example: an Input Report with Report ID 0x01, an Output Report with Report ID 0x02, and a Feature Report with Report ID 0x03. Either technique is allowed. If there is only one logical device, and that device only has a single Input Report, Output Report, and/or Feature Report, then the Report ID is not mandatory and must be filled with the special value zero. 3.6 HID Report Items Each report may incorporate one or more pieces of data, called Items. The Items always follow the Report ID byte, i.e., the Items start at byte position 1 and work upward. See Also For more information about HID Report Items; please refer to Sections 5.2 and 5.3 of the Device Class Definition for Human Interface Devices specification (Reference Document [2]). Input Reports are sent from the device to the host. Input Reports may be sent “asynchronously” by the device to the host (in actuality, the host bus controller periodically polls for these). The host may also “demand” an Input Report by invoking a HID GET INPUT REPORT request. Sensor Data Fields, i.e., real-time acquired sensor data samples, are equated to HID Input Report Items. Output Reports are sent from the host to the device. Output Reports are optional. In the context of Sensors, Output Reports may be used to send functional commands to the Sensor by invoking the HID SET OUTPUT REPORT request. In practice, configuration of sensors is more commonly done using the HID SET FEATURE REPORT request instead. See Also For more information about HID Output Reports that may optionally be supported by some sensor device implementations; please refer to the Device Class Definition for Physical Interface Devices (PID) specification (Reference Document [7]). In that document, it describes how various types of Output Reports could be used for advanced features such as downloading detailed Haptic feedback waveforms, waveform shape “envelopes”, and “condition” definitions that can be used as complex triggers. Please note that PID Usages appear on Usage Page 0x0F, not the Sensor Usage Page 0x20. Feature Reports can be used to transfer non-real-time Properties between the device and the host. They are optional, meaning that it is possible to define a sensor collection that communicates solely with Input Reports. Feature Reports are also bi-directional, and sub-divided into Get Feature Reports and Set Feature Reports, depending upon direction. Get Feature Reports are sent from the device to the host. They are used to get Properties from a sensor by invoking the HID GET FEATURE REPORT request. This might include identifying information such as the sensor’s manufacturer and model number, or reading back previously set configuration settings. Sensor Properties are equated to HID Feature Report Items.
Page 1 and 2:
1 HID Sensor Usages Request Submiss
Page 3 and 4:
3 HID Sensor Usages Table of Conten
Page 5 and 6:
5 HID Sensor Usages Table of Tables
Page 7 and 8:
7 HID Sensor Usages 1. Sensor Page
Page 9 and 10: 9 HID Sensor Usages 66 Mechanical:
Page 11 and 12: 11 HID Sensor Usages 0806 Sensor St
Page 13 and 14: 13 HID Sensor Usages 08A4 GPS Selec
Page 15 and 16: 15 HID Sensor Usages 047C Data Fiel
Page 17 and 18: 17 HID Sensor Usages 08C4 Day of We
Page 19 and 20: 19 HID Sensor Usages 092D VT_F32ED:
Page 21 and 22: 21 HID Sensor Usages Electrical: Po
Page 23 and 24: 23 HID Sensor Usages Motion: Gyrome
Page 25 and 26: 25 HID Sensor Usages Modifier: Mini
Page 27 and 28: 27 HID Sensor Usages 081B Low Thres
Page 29 and 30: 29 HID Sensor Usages change sensiti
Page 31 and 32: 31 HID Sensor Usages can be overrid
Page 33 and 34: 33 HID Sensor Usages Unit Exponent.
Page 35 and 36: 35 HID Sensor Usages Country or Reg
Page 37 and 38: 37 HID Sensor Usages specifying min
Page 39 and 40: 39 HID Sensor Usages host-based mid
Page 41 and 42: 41 HID Sensor Usages Generic GUID S
Page 43 and 44: 43 HID Sensor Usages Sel - Degrees
Page 45 and 46: 45 HID Sensor Usages 2. Sensor Back
Page 47 and 48: 47 HID Sensor Usages Separation or
Page 49 and 50: 49 HID Sensor Usages Z=Down) coordi
Page 51 and 52: 51 HID Sensor Usages Figure 1. Sens
Page 53 and 54: 53 HID Sensor Usages
Page 55 and 56: 55 HID Sensor Usages
Page 57 and 58: 57 HID Sensor Usages 3. Sensor Inte
Page 59: 59 HID Sensor Usages Strategy 1: ne
Page 63 and 64: 63 HID Sensor Usages 3 4 Data Field
Page 65 and 66: 65 HID Sensor Usages DF Dynamic Dat
Page 67 and 68: 67 HID Sensor Usages The HID Specif
Page 69 and 70: 69 HID Sensor Usages Definition for
Page 71 and 72: 71 HID Sensor Usages 4. Illustrativ
Page 73 and 74: 73 HID Sensor Usages #define HID_US
Page 79 and 80: 79 HID Sensor Usages A value is ide
Page 81 and 82: 81 HID Sensor Usages HID_USAGE_SENS
Page 83 and 84: 83 HID Sensor Usages It is up to th
Page 87 and 88: 87 HID Sensor Usages 4.2.5 Sensor C
Page 93 and 94: 93 HID Sensor Usages }; HID_REPORT_
Page 95 and 96: 95 HID Sensor Usages }; HID_REPORT_
Page 97 and 98: 97 HID Sensor Usages }; HID_INPUT(C
Page 99 and 100: 99 HID Sensor Usages unsigned long
Page 101 and 102: 101 HID Sensor Usages enum GorPK_KI
Page 103 and 104: 103 HID Sensor Usages Because these
Page 105 and 106: 105 HID Sensor Usages }; //feature
Page 107 and 108: 107 HID Sensor Usages }; HID_LOGICA
Page 109 and 110: 109 HID Sensor Usages HID_REPORT_SI
Page 111 and 112:
111 HID Sensor Usages }; HID_USAGE_
Page 113 and 114:
113 HID Sensor Usages HID_USAGE_SEN
Page 115 and 116:
Page 117 and 118:
Page 119 and 120:
Page 121 and 122:
121 HID Sensor Usages }; HID_LOGICA
Page 123 and 124:
Page 125 and 126:
125 HID Sensor Usages }; HID_REPORT
Page 127 and 128:
127 HID Sensor Usages }; HID_FEATUR
Page 129 and 130:
129 HID Sensor Usages }; HID_INPUT(
Page 131 and 132:
Page 133 and 134:
Page 135 and 136:
Page 137 and 138:
Page 139 and 140:
139 HID Sensor Usages HID_COLLECTIO
Page 141 and 142:
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Page 149 and 150:
Page 151:
show all

HID Sensor Usage Tables - USB.org

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?