more documentation
This commit is contained in:
@@ -6,19 +6,76 @@ Formerly `BasicMotion` and others
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
Room
|
||||
|
||||
Motion --> Room
|
||||
Button --> Room
|
||||
Door --> Room
|
||||
```
|
||||
|
||||
### Behaviors
|
||||
|
||||
#### Button
|
||||
|
||||
| Action | Response |
|
||||
|--------------|---------------------------------------------|
|
||||
| Single-press | Toggle the room state (activate/deactivate) |
|
||||
| Long-press | |
|
||||
|
||||
#### Door
|
||||
|
||||
Activates the room if the door opens when everything in the room is off.
|
||||
|
||||
### Config
|
||||
|
||||
#### Required
|
||||
|
||||
| Key | Behavior |
|
||||
|----------|----------------------------------------------|
|
||||
| `entity` | Main entity for the room |
|
||||
| `sensor` | `binary_sensor` (motion) sensor for the room |
|
||||
| `scene` | List of states and times for the room. |
|
||||
| `sleep` | [input_boolean] of the sleep mode variable |
|
||||
|
||||
[input_boolean]: https://www.home-assistant.io/integrations/input_boolean/
|
||||
|
||||
??? example "Example state for `scene` key"
|
||||
|
||||
```yaml
|
||||
- time: 22:00:00
|
||||
off_duration: 00:02:00 # (1)
|
||||
scene:
|
||||
light.kitchen:
|
||||
state: on
|
||||
color_temp: 650
|
||||
brightness_pct: 10
|
||||
```
|
||||
|
||||
1. (Optional) overrides the default `off_duration` for this period only
|
||||
|
||||
#### Optional
|
||||
|
||||
| Key | Behavior |
|
||||
|----------------|-----------------------------------------------------------------------------------------|
|
||||
| `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 |
|
||||
| `door` | `binary_sensor` (door) sensor for the room |
|
||||
|
||||
??? example "Sample Button Event Data"
|
||||
|
||||
```yaml hl_lines="3"
|
||||
event_type: deconz_event
|
||||
data:
|
||||
id: living_room
|
||||
unique_id: 00:15:8d:00:06:ba:29:70
|
||||
event: 1002
|
||||
device_id: fc0ad75dfb8d3a55abfe842199cc94e9
|
||||
origin: LOCAL
|
||||
time_fired: "2023-04-26T05:40:39.762306+00:00"
|
||||
context:
|
||||
id: 01GYY17ZPJVP57C8PN1K3R4D7J
|
||||
parent_id: null
|
||||
user_id: null
|
||||
```
|
||||
|
||||
## Sleep Setter
|
||||
|
||||
`sleep.py`
|
||||
|
||||
Reference in New Issue
Block a user