Skip to content

Add Host Lighting add-on documentation - #119

Open
djGLiTCH wants to merge 3 commits into
OpenStickCommunity:mainfrom
djGLiTCH:20260811-host-lighting-protocol
Open

djGLiTCH wants to merge 3 commits into
OpenStickCommunity:mainfrom
djGLiTCH:20260811-host-lighting-protocol

Conversation

@djGLiTCH

@djGLiTCH djGLiTCH commented Aug 11, 2026 •

Copy link
Copy Markdown

User documentation for the Host Lighting add-on, OpenStickCommunity/GP2040-CE#1691. Adds the add-on page in the existing format and its entry in the Add-Ons Configuration list.

The page covers the option being disabled by default, the three XInput lighting settings, the Allow hosts to change the keyboard mapping setting, the input modes that carry the lighting interface and the settings host software can change. It points developers to docs/host-lighting.md in the firmware repository.

@djGLiTCH

Copy link
Copy Markdown
Author

Rebuilt as one commit on main. The page's wording is revised, and it gains a paragraph on the settings host software can change under protocol 2.0.

A page for the Host Lighting add-on in the format of the other add-on
pages, and its entry in the Add-Ons Configuration list.
Miscellaneous Notes links gp2040ce-hostlighting, the reference host
library with the hlp app for Windows, macOS and Linux, and names its
hlp-conformance check.
@djGLiTCH
djGLiTCH force-pushed the 20260811-host-lighting-protocol branch from ca13902 to 28797df Compare October 29, 2026 04:08
@djGLiTCH

djGLiTCH commented Oct 29, 2026 •

Copy link
Copy Markdown
Author

Updated for HLP v2.0-rc10. The page adds the Keyboard codes and restart that host software can change, lists the modes in the Web Configurator's order, and links LED Configuration under Requirements. A second commit links gp2040ce-hostlighting, the reference host library, now public at v1.0.0rc. That link can be repointed or dropped.

Web Configurator Options lists "Allow hosts to change the keyboard
mapping", off by default. While it is on, host software can change the
codes the Keyboard input mode sends, in the active input profile only.
@djGLiTCH

Copy link
Copy Markdown
Author

Updated for HLP v2.0-rc12. Web Configurator Options lists the new Allow hosts to change the keyboard mapping setting (off by default), and the page now says host software can change the codes the Keyboard input mode sends only in the active input profile.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant