Skip to content

Commit 263c8fe

Browse files
committed
Development/Configurations: Fixup 'Interface' definition
This apparently applies to both the device identifier, as well as the general attributes array
1 parent aff7589 commit 263c8fe

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

site/_wiki/Development/Configurations.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ pinpoint devices.
8181
| Output Initialization Report | `List<byte[]>` | A list of output reports to be sent to the device to perform the device's initialization sequence.
8282
| Device Strings | `Dictionary<byte, string>` | A list of regular expressions to be matched against specific indexes of strings contained within the device's firmware. They can be retrieved via the device string reader. This is optional, however it is commonly used to improve detection precision.
8383
| Initialization String Indexes | `byte[]` | A list of indexes to be retrieved from the device as part of the device's initialization sequence. This is optional, and very infrequently used.
84+
| `Interface` | non-negative integer | Specifies the USB device interface to use. For example: `0`. Should be used when the identifier might be ambiguous, or if the tablet has multiple interfaces matching the used identifiers, but only has one of them usable.
8485
{: .table .table-dark }
8586

8687
> Byte arrays (`byte[]`) are serialized as Base64 in JSON.NET, the library that serializes and deserializes configurations.
@@ -100,9 +101,9 @@ Some example attributes include:
100101
| Key Name | String Value | Description |
101102
| :------------------: | :------------------: | :---------- |
102103
| `libinputoverride` | `1` | *(Linux only)* Whether the generic tablet interface should be ignored by [libinput] or not. Used in [udev] rule generation, using the tablets VID and PID.
103-
| `Interface` | non-negative integer | Specifies the USB device interface to use. For example: `0`. Should be used when the identifiers might be ambiguous, or if the tablet has multiple interfaces matching the used identifiers, but only has one of them usable.
104104
| `WinUsage` | [00..99] | *(Windows only)* Specifies the HID usage collection to use. String must have exactly two digits (e.g. `"01"`)
105105
| `FeatureInitDelayMs` | milliseconds | For tablets with multiple feature initialization reports (e.g. polling rate change), wait this many milliseconds between reports. This can help if later feature initialization reports are sometimes randomly not picked up by the tablet.
106+
| `Interface` | non-negative integer | Specifies the USB device interface to use. For example: `0`. Should be used when the identifiers might be ambiguous, or if the tablet has multiple interfaces matching the used identifiers, but only has one of them usable. We suggest using the digitizer-specific `Interface` attribute instead, if possible.
106107
{: .table .table-dark }
107108

108109
[libinput]: https://www.freedesktop.org/wiki/Software/libinput/ "freedesktop.org's site on libinput"

0 commit comments

Comments
 (0)