intergatedcircuits / hid-usage-tables

Documenting the HID usage tables in a parsable format for code generation

HID usage tables database

This repository contains the HID usage tables in a machine-readable format (under pages), and accompanying Python3 scripts (under src) to parse them into a database, and generate code for different programming languages. The recent versions of the HID usage tables document contain a JSON attachment, which can also serve as the input of the code generator.

Supported formats

• C++ (to be used with hid-rp)

Additional languages can be easily added by taking src/hid/codegen/cpp.py as a template.

hid-usage-tables's Issues

Separate code generation from symbol building

The CodeGenerator class deserves a refactoring into two functionalities, one for building the symbol list, and another for creating the generated code.

Code generator ID to string conversion

The code generator is currently only prepared to generate the enums from the pages, to add support for ID to string conversion some refactoring will be necessary. No timeline for implementing this yet.

Use embedded HidUsageTables.json when available

Since version 1.3 (Issue Date January 1, 2022), HID Usage Tables for Universal Serial Bus includes embedded HidUsageTables.json file. It is preferred to use the JSON file as opposed to page text scanning.

Potential typo?

hid-usage-tables/pages/000f-physical-input-device.txt

Line 1 in 34c6340

000f "Physical Interput Device"

Did you mean to change "Input" to "Interput"?

Handle inline usage switches

The sensors page has many IUS entries at the bottom, which are usage ID masks that modify the original sensor usage (which is normally done by encapsulating the original usage with a collection). We need to consider what are the possible options for representing this combination of usage values, and choose the option that fits best for the end programmer.