[netatmo] Add doorbell support (#12776)

* Adding doorbell handling to netatmo
Closes #8571

Signed-off-by: clinique <gael@lhopital.org>
This commit is contained in:
Gaël L'hopital
2022-05-24 21:56:55 +02:00
committed by GitHub
parent 308bb3013a
commit 55beb413bd
31 changed files with 424 additions and 141 deletions

View File

@@ -350,16 +350,16 @@ All these channels are read only.
**Supported channels for the Room thing:**
| Channel Group | Channel Id | Item Type | Description |
|------------------|-----------------------|----------------------|---------------------------------------------------------|
| room-temperature | value | Number:Temperature | Current temperature in the room |
| room-properties | window-open | Contact | Windows of the room are opened |
| room-properties | anticipating | Switch | Anticipates next scheduled setpoint |
| room-properties | heating-power-request | Number:Dimensionless | Percentage of heating power |
| setpoint | value | Number:Temperature | Thermostat temperature setpoint |
| setpoint | mode | String | Chosen thermostat mode (home, frost guard, manual, max) |
| setpoint | start | DateTime | Start time of the currently applied setpoint |
| setpoint | end | DateTime | End time of the currently applied setpoint |
| Channel Group | Channel Id | Item Type | Description |
|---------------|-----------------------|----------------------|---------------------------------------------------------|
| temperature | value | Number:Temperature | Current temperature in the room |
| properties | window-open | Contact | Windows of the room are opened |
| properties | anticipating | Switch | Anticipates next scheduled setpoint |
| properties | heating-power-request | Number:Dimensionless | Percentage of heating power |
| setpoint | value | Number:Temperature | Thermostat temperature setpoint |
| setpoint | mode | String | Chosen thermostat mode (home, frost guard, manual, max) |
| setpoint | start | DateTime | Start time of the currently applied setpoint |
| setpoint | end | DateTime | End time of the currently applied setpoint |
All these channels except setpoint and setpoint-mode are read only.
@@ -368,14 +368,14 @@ All these channels except setpoint and setpoint-mode are read only.
**Supported channels for the thermostat module:**
| Channel Group | Channel Id | Item Type | Description |
|---------------------|--------------------|----------------------|--------------------------------------------------|
| th-properties | relay-status | Contact | Indicates if the boiler is currently heating |
| signal | strength | Number | Signal strength (0 for no signal, 1 for weak...) |
| signal | value | Number:Power | Signal strength in dBm |
| battery | value | Number | Battery level |
| battery | low-battery | Switch | Low battery |
| battery | status | String | Description of the battery status (*) |
| Channel Group | Channel Id | Item Type | Description |
|---------------|-------------|--------------|--------------------------------------------------|
| properties | relay | Contact | Indicates if the boiler is currently heating |
| signal | strength | Number | Signal strength (0 for no signal, 1 for weak...) |
| signal | value | Number:Power | Signal strength in dBm |
| battery | value | Number | Battery level |
| battery | low-battery | Switch | Low battery |
| battery | status | String | Description of the battery status (*) |
(*) Can be UNDEF on some modules
@@ -438,7 +438,7 @@ All these channels are read only.
| | TAG_UNINSTALLED | Triggered when a tag gets uninstalled |
| | TAG_OPEN | Triggered when an open event of a tag was detected |
### Welcome and Presence Camera
### Welcome, Presence and Doorbell Cameras
Warnings:
@@ -503,6 +503,33 @@ Warnings:
(*) This channel is configurable : low, poor, high.
**Supported channels for the Welcome Doorbell thing:**
| Channel Group | Channel ID | Item Type | Read/Write | Description |
|---------------|-------------------|--------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| status | sd-card | String | Read-only | State of the SD card |
| status | alim | String | Read-only | State of the power connector |
| live | picture | Image | Read-only | Camera Live Snapshot |
| live | local-picture-url | String | Read-only | Local Url of the live snapshot for this camera |
| live | vpn-picture-url | String | Read-only | Url of the live snapshot for this camera through Netatmo VPN. |
| signal | strength | Number | Read-only | Signal strength (0 for no signal, 1 for weak...) |
| signal | value | Number:Power | Read-only | Signal strength in dBm |
| last-event | type | String | Read-only | Type of event |
| last-event | video-status | String | Read-only | Status of the video (recording, deleted or available) |
| last-event | time | DateTime | Read-only | Time of occurrence of event |
| last-event | local-video-url | String | Read-only | If the last event (depending upon event type) in the home lead a snapshot picture, the corresponding local video URL will be available here |
| last-event | vpn-video-url | String | Read-only | If the last event (depending upon event type) in the home lead a snapshot picture, the corresponding VPN video URL will be available here |
| sub-event | type | String | Read-only | Type of sub-event |
| sub-event | time | DateTime | Read-only | Time of occurrence of sub-event |
| sub-event | message | String | Read-only | Message sent by Netatmo corresponding to given sub-event |
| sub-event | snapshot-url | String | Read-only | Depending upon event type in the home, a snapshot picture of the corresponding local video URL will be available here |
| sub-event | vignette-url | String | Read-only | A vignette representing the snapshot |
| sub-event | snapshot | Image | Read-only | picture of the snapshot |
| sub-event | vignet | Image | Read-only | picture of the vignette |
Note: live feeds either locally or via VPN are not available in Netatmo API.
### Welcome Person
@@ -515,18 +542,18 @@ Person things are automatically created in discovery process for all known perso
**Supported channels for the Person thing:**
| Channel Group | Channel ID | Item Type | Description |
|----------------|----------------|--------------|--------------------------------------------------------|
| person | avatar-url | String | URL for the avatar of this person |
| person | avatar | Image | Avatar of this person |
| person | at-home | Switch | Indicates if this person is known to be at home or not |
| person | last-seen | DateTime | Moment when this person was last seen |
| person-event | subtype | String | Sub-type of event |
| person-event | message | String | Last event message from this person |
| person-event | time | DateTime | Moment of the last event for this person |
| person-event | snapshot | Image | Picture of the last event for this person |
| person-event | snapshot-url | String | URL for the picture of the last event for this person |
| person-event | camera-id | String | ID of the camera that triggered the event |
| Channel Group | Channel ID | Item Type | Description |
|---------------|--------------|-----------|--------------------------------------------------------|
| person | avatar-url | String | URL for the avatar of this person |
| person | avatar | Image | Avatar of this person |
| person | at-home | Switch | Indicates if this person is known to be at home or not |
| person | last-seen | DateTime | Moment when this person was last seen |
| last-event | subtype | String | Sub-type of event |
| last-event | message | String | Last event message from this person |
| last-event | time | DateTime | Moment of the last event for this person |
| last-event | snapshot | Image | Picture of the last event for this person |
| last-event | snapshot-url | String | URL for the picture of the last event for this person |
| last-event | camera-id | String | ID of the camera that triggered the event |
All these channels except at-home are read only.