From d32b5da39e30fb3cede037f2c2d598dd0291e678 Mon Sep 17 00:00:00 2001 From: Jacob Simpson <28767380+djGLiTCH@users.noreply.github.com> Date: Tue, 11 Aug 2026 13:52:06 +1000 Subject: [PATCH 1/3] Add Host Lighting add-on documentation --- docs/add-ons/host-lighting.mdx | 61 +++++++++++++++++++ .../menu-pages/08-add-ons-configuration.mdx | 1 + 2 files changed, 62 insertions(+) create mode 100644 docs/add-ons/host-lighting.mdx diff --git a/docs/add-ons/host-lighting.mdx b/docs/add-ons/host-lighting.mdx new file mode 100644 index 0000000..05b4f89 --- /dev/null +++ b/docs/add-ons/host-lighting.mdx @@ -0,0 +1,61 @@ +--- +title: Host Lighting +# tags: +# - +pagination_next: null +pagination_prev: null +description: "Add-on that lets PC software drive the board's RGB LEDs live over USB" +--- + +# Host Lighting + +Purpose: This add-on lets host software on a PC drive the board's RGB LEDs in +real time over a dedicated USB interface, alongside the normal controller +interface. Lighting applications can colour individual buttons, the case +strip, and player LEDs - for example reacting to game state - while the +board's own animations return automatically whenever the host disconnects or +goes quiet. + +The board describes its own LED layout to the host (which buttons have LEDs, +where the case strip is, colour order, and so on), taken live from your +configuration - so host software needs no per-board setup and follows any +remapping you do in the Web Configurator. + +## Web Configurator Options + +- `Enabled` - Enables the Host Lighting interface. Disabled by default; while + disabled the board presents exactly its stock USB identity in every mode. +- `XInput Lighting` - How XInput mode carries the lighting interface: + - `Auto` (default) - The board boots with its stock, console-identical + identity. On a console nothing ever changes. On a PC, the board detects + the host after a few seconds and re-enumerates with the lighting + interface alongside the controller, which binds the operating system's + standard Xbox 360 driver. + - `Always on` - The lighting identity from boot. PC-only; do not use this + setting on a console. + - `Off` - Stock XInput behaviour; no lighting interface in XInput mode. + +The lighting interface is available in XInput, Generic (DInput) and Keyboard +input modes. Console modes (PS3/PS4/PS5, Switch, Xbox) never expose it. + +## Hardware + +### Requirements + +No additional hardware - the add-on uses the RGB LEDs already configured on +the [RGB LEDs](../rgb-leds.mdx) page. Host software that supports the +protocol is required on the PC side. + +### Installation + +None beyond enabling the option in the Web Configurator. + +## Miscellaneous Notes + +The full protocol reference for developers of host software - commands, +capability pages, and a typical host flow - is in the firmware repository +under `docs/host-lighting.md`. + +In `Auto` XInput lighting mode, the lighting interface appears a few seconds +after plugging into a PC (after a brief reconnect); host software is expected +to tolerate this delay. diff --git a/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx b/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx index bd3ec07..f59b5f6 100644 --- a/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx +++ b/docs/web-configurator/menu-pages/08-add-ons-configuration.mdx @@ -25,6 +25,7 @@ Some of these add-ons are experimental and not all add-ons are interoperable wit - [DRV8833 Rumble](../../add-ons/drv8833-rumble.mdx) - [Dual Directional Input](../../add-ons/dual-direction-input.mdx) - [Focus Mode Configuration](../../add-ons/focus-mode.mdx) +- [Host Lighting](../../add-ons/host-lighting.mdx) - [I2C Analog ADS1219](../../add-ons/i2c-analog-ads1219.mdx) - [I2C Analog ADS1256-SPI](../../add-ons/i2c-analog-ads1256-spi.mdx) - [Input Reverse](../../add-ons/input-reverse.mdx) From f3a2bb9a88217ee9335dd5484d37e46f084eb008 Mon Sep 17 00:00:00 2001 From: Jacob Simpson <28767380+djGLiTCH@users.noreply.github.com> Date: Mon, 21 Sep 2026 12:24:30 +1000 Subject: [PATCH 2/3] List SInput among the modes that carry the lighting interface --- docs/add-ons/host-lighting.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/add-ons/host-lighting.mdx b/docs/add-ons/host-lighting.mdx index 05b4f89..3dbf616 100644 --- a/docs/add-ons/host-lighting.mdx +++ b/docs/add-ons/host-lighting.mdx @@ -35,8 +35,8 @@ remapping you do in the Web Configurator. setting on a console. - `Off` - Stock XInput behaviour; no lighting interface in XInput mode. -The lighting interface is available in XInput, Generic (DInput) and Keyboard -input modes. Console modes (PS3/PS4/PS5, Switch, Xbox) never expose it. +The lighting interface is available in XInput, Generic (DInput), Keyboard and +SInput input modes. Console modes (PS3/PS4/PS5, Switch, Xbox) never expose it. ## Hardware From d9629c455587f96c9806acba43a3da3f1a6b5855 Mon Sep 17 00:00:00 2001 From: Jacob Simpson <28767380+djGLiTCH@users.noreply.github.com> Date: Thu, 24 Sep 2026 20:13:37 +1000 Subject: [PATCH 3/3] Renamed Generic HID and Always On for HLP Rename to Generic HID and Always On for HLP --- docs/add-ons/host-lighting.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/add-ons/host-lighting.mdx b/docs/add-ons/host-lighting.mdx index 3dbf616..6c49a0e 100644 --- a/docs/add-ons/host-lighting.mdx +++ b/docs/add-ons/host-lighting.mdx @@ -31,11 +31,11 @@ remapping you do in the Web Configurator. the host after a few seconds and re-enumerates with the lighting interface alongside the controller, which binds the operating system's standard Xbox 360 driver. - - `Always on` - The lighting identity from boot. PC-only; do not use this + - `Always On` - The lighting identity from boot. PC-only; do not use this setting on a console. - `Off` - Stock XInput behaviour; no lighting interface in XInput mode. -The lighting interface is available in XInput, Generic (DInput), Keyboard and +The lighting interface is available in XInput, Generic HID, Keyboard and SInput input modes. Console modes (PS3/PS4/PS5, Switch, Xbox) never expose it. ## Hardware