hc-magichome/README.md

43 lines
1.0 KiB
Markdown

## Configuration
All types:
- `type`
Either `"normal"`, `"addressable"` or `"subsection"`
Type "normal" and "addressable":
- `logall`
Sets `log_all_received` in the constructor.
- `connect_timeout`
Sets `connect_timeout` in the constructor. (Default: 10000)
- `command_timeout`
Sets `command_timeout` in the constructor. (Default: 5000)
Type "normal":
- `ack`
Bitmask to set `ack` in the constructor.
Type "addressable":
- `strip_length`
Number of segments on the strip. Required.
- `registry_key`
Name to register this controller in the global registry as. Only required when this device is supposed to have subsections.
Type "subsection":
- `parent`
Name of the parent device in the registry. Corresponds to a `registry_key`
- `section_id`
Identifier of this section for the parent.
- `section_start`
Which segment of the strip this subsection starts. May not be greater than `strip_length` of the parent.
- `section_end`
Which segment of the strip this subsection ends. May not be greater than `strip_length` of the parent.