|
@@ -87,8 +87,13 @@ board is refused by name.
|
|
|
|
|
|
|
|
Never write an effect name into this repo that no source states. Either the
|
|
Never write an effect name into this repo that no source states. Either the
|
|
|
vendor's file names it, or the user has looked at the board and named what they
|
|
vendor's file names it, or the user has looked at the board and named what they
|
|
|
-see — in which case it is a tool name, it goes in the board's file in
|
|
|
|
|
-`internal/rgb`, and the comment says it was measured.
|
|
|
|
|
|
|
+see — in which case it is a tool name, it goes in that board's definition file
|
|
|
|
|
+in `definitions/`, and the comment says it was measured. No name belongs in Go
|
|
|
|
|
+code: there is no hand-written catalog anywhere in `internal/`, because a list
|
|
|
|
|
+beside the vendor's file is two places to update one name, and that is how the
|
|
|
|
|
+names here drifted from the ones Wobkey publishes. `definitions/README.md` says
|
|
|
|
|
+which files belong in that directory; a file added there takes effect after a
|
|
|
|
|
+rebuild.
|
|
|
|
|
|
|
|
## Zone behavior
|
|
## Zone behavior
|
|
|
|
|
|
|
@@ -133,8 +138,10 @@ user that the tool's own output did not confirm.
|
|
|
|
|
|
|
|
## Compatibility aliases
|
|
## Compatibility aliases
|
|
|
|
|
|
|
|
-- `off` → `none`, but on `logo` and `side` the firmware refuses effect ID 0 and
|
|
|
|
|
- leaves the running effect alone; `disable` is what turns a channel off
|
|
|
|
|
|
|
+- `off` → `none`, but on `logo` and `side` the firmware reads effect ID 0 as
|
|
|
|
|
+ "lighting off" and leaves the mode register where it was, so the running
|
|
|
|
|
+ effect keeps running; `disable` is what turns a channel off, because it also
|
|
|
|
|
+ writes brightness 0
|
|
|
- `breathe` → `breathing`
|
|
- `breathe` → `breathing`
|
|
|
- `rainbow` → varies by zone (resolves automatically)
|
|
- `rainbow` → varies by zone (resolves automatically)
|
|
|
- `solid` → varies by zone (resolves automatically)
|
|
- `solid` → varies by zone (resolves automatically)
|