Pages
API Documentation
On this page

Sonic VIA

Lighting control for QMK keyboards over the VIA protocol.

Sonic VIA implements the QMK VIA HID keyboard protocol for RGB lighting control.

  • ViaDiscovery lists VIA keyboards (HID usage page 0xff60) without opening them.
  • ViaDevice gives blocking access to one keyboard.
  • ViaProtocol sends the lighting commands, encoded for the device's protocol version (VIA V3, 11 and later, or legacy).
  • ViaCommand builds single VIA commands.

Without hidapi at build time, the library is a stub: discovery finds no keyboards and devices don't open.

Using the Module

Building with CMake

Use the find_package() command to locate the SonicVia package and link against its target:

find_package(SonicVia REQUIRED)
target_link_libraries(mytarget PRIVATE SonicVia::SonicVia)

API Reference

We use cookies to personalize content and to analyze our traffic. Please decide if you are willing to accept cookies from our website.