Add motion sensor documentation
This commit is contained in:
parent
5d07dbb73d
commit
1477caeb83
19
Readme.md
19
Readme.md
|
@ -2,14 +2,21 @@ Homie Schild Firmware
|
|||
=====================
|
||||
## About
|
||||
## Features
|
||||
### LED Strip
|
||||
|Topic |Descriptions |settable |Values |
|
||||
|---------|--------------|:---------:|---------|
|
||||
|`device_id`/strip/pixel/|Range property from 0 - (number of pixels - 1)|ja|Color as uint32_t see [Color](#color)|
|
||||
|`device_id`/strip/color|Range property to set the effects colors 1 & 2 see: [effect colors](#effect-colors)|ja|Color as uint32_t see [Color](#color)|
|
||||
|`device_id`/strip/brightness|Sets the brightness of the pixel strip|ja|possible values: 0 - 255|
|
||||
|`device_id`/strip/effect|Set effect|ja|see: [effects](#effects)|
|
||||
|`device_id`/strip/clear|Clears the pixels strip|ja|any value is possible|
|
||||
|`device_id`/strip/length|Set the strip length|ja|Possible values: 0 - length|
|
||||
|`device_id`/strip/pixel/|Range property from 0 - (number of pixels - 1)|yes|Color as uint32_t see [Color](#color)|
|
||||
|`device_id`/strip/color|Range property to set the effects colors 1 & 2 see: [effect colors](#effect-colors)|yes|Color as uint32_t see [Color](#color)|
|
||||
|`device_id`/strip/brightness|Sets the brightness of the pixel strip|yes|possible values: 0 - 255|
|
||||
|`device_id`/strip/effect|Set effect|yes|see: [effects](#effects)|
|
||||
|`device_id`/strip/clear|Clears the pixels strip|yes|any value is possible|
|
||||
|`device_id`/strip/length|Set the strip length|yes|Possible values: 0 - length|
|
||||
|
||||
### Motion sensor
|
||||
|Topic |Descriptions |settable |Values |
|
||||
|---------|--------------|:---------:|---------|
|
||||
|`device_id`/sensor/motion|Activated on motion|no|true or false|
|
||||
|
||||
|
||||
## Color
|
||||
To convert RGB value use the following bash code:
|
||||
|
|
Loading…
Reference in New Issue