hid-types 0.1.1

Rust types for working with USB HID report descriptors
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! Well-known Usage ID values from the Digitizers Usage Page.

use num_enum::{IntoPrimitive, TryFromPrimitive};

use crate::Ident;

/// Well-known Usage ID values from the Digitizers Usage Page.
///
/// See [HID Usage Tables for Universal Serial Bus](https://www.usb.org/document-library/hid-usage-tables-17),
/// section 16.
#[expect(missing_docs)]
#[derive(Clone, Copy, Debug, Eq, PartialEq, TryFromPrimitive, IntoPrimitive)]
#[repr(u16)]
pub enum KnownUsage {
    Undefined = 0x00,
    Digitizer = 0x01,
    Pen = 0x02,
    LightPen = 0x03,
    TouchScreen = 0x04,
    TouchPad = 0x05,
    Whiteboard = 0x06,
    CoordinateMeasuringMachine = 0x07,
    ThreeDDigitizer = 0x08,
    StereoPlotter = 0x09,
    ArticulatedArm = 0x0A,
    Armature = 0x0B,
    MultiplePointDigitizer = 0x0C,
    FreeSpaceWand = 0x0D,
    DeviceConfiguration = 0x0E,
    CapacitiveHeatMapDigitizer = 0x0F,
    // 0x10-0x1F reserved
    Stylus = 0x20,
    Puck = 0x21,
    Finger = 0x22,
    DeviceSettings = 0x23,
    CharacterGesture = 0x24,
    // 0x25-0x2F reserved
    TipPressure = 0x30,
    BarrelPressure = 0x31,
    InRange = 0x32,
    Touch = 0x33,
    Untouch = 0x34,
    Tap = 0x35,
    Quality = 0x36,
    DataValid = 0x37,
    TransducerIndex = 0x38,
    TabletFunctionKeys = 0x39,
    ProgramChangeKeys = 0x3A,
    BatteryStrength = 0x3B,
    Invert = 0x3C,
    XTilt = 0x3D,
    YTilt = 0x3E,
    Azimuth = 0x3F,
    Altitude = 0x40,
    Twist = 0x41,
    TipSwitch = 0x42,
    SecondaryTipSwitch = 0x43,
    BarrelSwitch = 0x44,
    Eraser = 0x45,
    TabletPick = 0x46,
    TouchValid = 0x47,
    Width = 0x48,
    Height = 0x49,
    // 0x4A-0X50 reserved
    ContactIdentifier = 0x51,
    DeviceMode = 0x52,
    DeviceIdentifier = 0x53,
    ContactCount = 0x54,
    ContactCountMaximum = 0x55,
    ScanTime = 0x56,
    SurfaceSwitch = 0x57,
    ButtonSwitch = 0x58,
    PadType = 0x59,
    SecondaryBarrelSwitch = 0x5A,
    TransducerSerialNumber = 0x5B,
    PreferredColor = 0x5C,
    PreferredColorIsLocked = 0x5D,
    PreferredLineWidth = 0x5E,
    PreferredLineWidthIsLocked = 0x5F,
    LatencyMode = 0x60,
    GestureCharacterQuality = 0x61,
    CharacterGestureDataLength = 0x62,
    CharacterGestureData = 0x63,
    GestureCharacterEncoding = 0x64,
    Utf8CharacterGestureEncoding = 0x65,
    Utf16LittleEndianCharacterGestureEncoding = 0x66,
    Utf16BigEndianCharacterGestureEncoding = 0x67,
    Utf32LittleEndianCharacterGestureEncoding = 0x68,
    Utf32BigEndianCharacterGestureEncoding = 0x69,
    CapacitiveHeatMapProtocolVendorId = 0x6A,
    CapacitiveHeatMapProtocolVersion = 0x6B,
    CapacitiveHeatMapFrameData = 0x6C,
    GestureCharacterEnable = 0x6D,
    TransducerSerialNumberPart2 = 0x6E,
    NoPreferredColor = 0x6F,
    PreferredLineStyle = 0x70,
    PreferredLineStyleIsLocked = 0x71,
    Ink = 0x72,
    Pencil = 0x73,
    Highlighter = 0x74,
    ChiselMarker = 0x75,
    Brush = 0x76,
    NoPreference = 0x77,
    // 0x78-0x7F reserved
    DigitizerDiagnostic = 0x80,
    DigitizerError = 0x81,
    ErrNormalStatus = 0x82,
    ErrTransducersExceeded = 0x83,
    ErrFullTransFeaturesUnavailable = 0x84,
    ErrChargeLow = 0x85,
    // 0x86-0x8F reserved
    TransducerSoftwareInfo = 0x90,
    TransducerVendorId = 0x91,
    TransducerProductId = 0x92,
    DeviceSupportedProtocols = 0x93,
    TransducerSupportedProtocols = 0x94,
    NoProtocol = 0x95,
    WacomAesProtocol = 0x96,
    UsiProtocol = 0x97,
    MicrosoftPenProtocol = 0x98,
    // 0x99-0x9F reserved
    SupportedReportRates = 0xA0,
    ReportRate = 0xA1,
    TransducerConnected = 0xA2,
    SwitchDisabled = 0xA3,
    SwitchUnimplemented = 0xA4,
    TransducerSwitches = 0xA5,
    TransducerIndexSelector = 0xA6,
    // 0xA7-0xAF reserved
    ButtonPressThreshold = 0xB0,
    // 0xB1-0xFFFF reserved
}

/// A __Usage ID__ value.
pub type Usage = Ident<KnownUsage, u16>;