Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 778ff9cf authored by Siarhei Vishniakou's avatar Siarhei Vishniakou Committed by Automerger Merge Worker
Browse files

Merge "Updated documentation for CTS uhid tests" into rvc-dev am: 01c36833 am: f489424a 

Change-Id: I301a981e6b1a3f03c3d94228c7d6a6d887fd55c4
parents 7d923a47 f489424a

cmds/hid/README.md

+7 −2
Original line number Diff line number Diff line
@@ -44,11 +44,15 @@ Register a new uhid device 
| name          | string        | Device name                |

| vid           | 16-bit integer| Vendor id                  |

| pid           | 16-bit integer| Product id                 |

| bus           | string        | Bus that device should use |

| descriptor    | byte array    | USB HID report descriptor  |



Device ID is used for matching the subsequent commands to a specific device

to avoid ambiguity when multiple devices are registered.



Device bus is used to determine how the uhid device is connected to the host.

The options are "usb" and "bluetooth".



USB HID report descriptor should be generated according the the USB HID spec

and can be checked by reverse parsing using a variety of tools, for example

[usbdescreqparser][5].
@@ -61,6 +65,7 @@ Example: 
  "name": "Odie (Test)",

  "vid": 0x18d1,

  "pid": 0x2c40,

  "bus": "usb",

  "descriptor": [0x05, 0x01, 0x09, 0x05, 0xa1, 0x01, 0x85, 0x01, 0x05, 0x09, 0x0a, 0x01, 0x00,

    0x0a, 0x02, 0x00, 0x0a, 0x04, 0x00, 0x0a, 0x05, 0x00, 0x0a, 0x07, 0x00, 0x0a, 0x08, 0x00,

    0x0a, 0x0e, 0x00, 0x0a, 0x0f, 0x00, 0x0a, 0x0d, 0x00, 0x05, 0x0c, 0x0a, 0x24, 0x02, 0x0a,