john/room_control
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
root
2023-07-30 22:42:14 -05:00
parent b352b2e4d1
commit 2f1df29184
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -20,7 +20,6 @@ graph TD
| Action | Response | | Action | Response |
|--------------|---------------------------------------------| |--------------|---------------------------------------------|
| Single-press | Toggle the room state (activate/deactivate) | | Single-press | Toggle the room state (activate/deactivate) |
| Long-press | |
| Double-press | Toggle sleep mode, then activate room | | Double-press | Toggle sleep mode, then activate room |
Sample button event data: Sample button event data:
@@ -52,18 +51,21 @@ Activates the room if the door opens when everything in the room is off.
|----------|----------------------------------------------| |----------|----------------------------------------------|
| `entity` | Main entity for the room | | `entity` | Main entity for the room |
| `sensor` | `binary_sensor` (motion) sensor for the room | | `sensor` | `binary_sensor` (motion) sensor for the room |
| `states` | List of states and times for the room. | | `states` | List of states and times for the room. |
#### Optional #### Optional
| Key | Behavior | | Key | Behavior |
|----------------|-----------------------------------------------------------------------------------------| |----------------|-----------------------------------------------------------------------------------------|
| `off_duration` | Default time for the motion sensor to be clear before deactivating the room. `HH:MM:SS` | | `off_duration` | Default time for the motion sensor to be clear before deactivating the room. `HH:MM:SS` |
| `button` | ID of the button to control the room | | `button` | ID of the button to control the room ([Aqara mini switch]) |
| `ha_button` | entity ID of the Home Assistant [input button] |
| `door` | `binary_sensor` (door) sensor for the room | | `door` | `binary_sensor` (door) sensor for the room |
| `sleep` | [input_boolean] of the sleep mode variable | | `sleep` | [input_boolean] of the sleep mode variable |
[input_boolean]: https://www.home-assistant.io/integrations/input_boolean/ [input_boolean]: https://www.home-assistant.io/integrations/input_boolean/
[Aqara mini switch]: https://www.amazon.com/Aqara-WXKG11LM-Switch-Wireless-Remote/dp/B07D19YXND
[input button]: https://www.home-assistant.io/integrations/input_button/
### State Definition ### State Definition