opensteno_qmk/docs/feature_rawhid.md

Raw HID

Raw HID allows for bidirectional communication between QMK and the host computer over an HID interface. This has many potential use cases, such as switching keymaps on the fly or changing RGB LED colors and modes.

There are two main components to getting raw HID working with your keyboard.

Keyboard firmware

The implementation is fairly straightforward for the firmware. In your rules.mk add:

RAW_ENABLE = yes

In your keymap.c include "raw_hid.h" and implement the following:

void raw_hid_receive(uint8_t *data, uint8_t length) {
    // Your code goes here. data is the packet received from host.
}

The "raw_hid.h" header also declares void raw_hid_send(uint8_t *data, uint8_t length); which allows sending packets from keyboard to host. As an example, it can also be used for debugging when building your host application by returning all data back to the host.

void raw_hid_receive(uint8_t *data, uint8_t length) {
    raw_hid_send(data, length);
}

raw_hid_receive can receive variable size packets from host with maximum length RAW_EPSIZE. raw_hid_send on the other hand can send packets to host of exactly RAW_EPSIZE length, therefore it should be used with data of length RAW_EPSIZE.

Make sure to flash raw enabled firmware before proceeding with working on the host side.

Host (Windows/macOS/Linux)

This is the more complicated part as it will require some digging.

To connect your host computer to your keyboard with raw HID you need four pieces of information about your keyboard:

1. Vendor ID
2. Product ID
3. Usage Page
4. Usage

The first two can easily be found in your keyboard's config.h in the keyboard's main directory under VENDOR_ID and PRODUCT_ID.

The final two can be overridden in your keyboard's config.h in the keyboard's main directory by redefining the values: #define RAW_USAGE_PAGE 0xFF60 and #define RAW_USAGE_ID 0x61.

By default, Usage Page is 0xFF60 and Usage is 0x61.

Building your host

You can build your host using any language that has an available HID implementation library if you don't wish to make your own. The ones we know of for popular languages are:

• Node: node-hid.
• C: hidapi.
• Java: purejavahidapi and hid4java.
• Python: pyhidapi.

This is not an exhaustive cross-platform list but should get you started. There are no special requirements for using raw HID so any HID library should work.

Now that you have all four pieces of information required to open HID interface to your keyboard. All you need to do is use your library's available functions to open the device with its ID parameters.

Note that Vendor ID and Product ID are not actually required to open the device. They are used only to filter to a specific device out of the many HID devices you have plugged in. Many libraries will give you the option to open the device using Product Name or Manufacturer Name instead, node-hid being a prime example. This will create issues for devices with builtin USB Hub or any extra HID interfaces where you will have multiple interfaces with the same name or from the same manufacturer. The Vendor ID together with Product ID create a unique designation to a single interface and will not exhibit this problem. Therefore, even if your library doesn't require you to, it is best to use them to avoid issues. Unlike Vendor ID and Product ID though, Usage Page and Usage are necessary for successful communication.

It should go without saying that regardless of the library you're using, you should always make sure to close the interface when finished. Depending on the operating system and your particular environment there may be issues connecting to it again afterwards with another client or another instance of the same client if it's not explicitly closed.