chroma-sdk/Colore

No guide for KEYBOARD_CUSTOM_KEY

JoniSykes opened this issue · 1 comments

I've read that the SDK added support for generic layouts.

Looking through the Colore docs I cannot see how the current grid implementation allows for generic layouts.

Could I get some help with this please?

As an example: the Blade and Ornata both have very different key layouts. If I reference a key using the grid, I will not get the same key on the Blade as I would on the Ornata.

The IKeyboard interface provides index-based indexers and key-based indexers for setting colors. Setting a color via a key (for example: keyboard[Key.A] = Color.Red will set the "A" key to the color red regardless of the user's current keyboard layout. This is supported as far as the SDK supports it, there have been issues in the past where it's not working properly due to bugs in the SDK/firmware.

Are you using v5.2 or v6.0 of Colore?

As for the documentation, we currently only have the "Getting Started" guide. But there's also the raw API documentation you can look at for v5.2 and v6.0.

For the keyboard specifically, check out the API docs for IKeyboard (or the v6.0 version).