Add Netatmo temperature services (#29883)

* Add documentation for new services

* Add parameter documentation to other services

* Update documentation to match changes

* tiny tweaks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
deosrc 2023-11-23 07:23:04 +00:00 committed by GitHub
parent 54450b8b11
commit b42133c1d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -87,32 +87,81 @@ The `netatmo` switch platform provides support for Legrand/BTicino switches and
`set_camera_light_mode` `set_camera_light_mode`
Set the outdoor camera light mode. This requires an entity id and a valid state. Set the outdoor camera light mode.
| Service data attribute | Required | Description |
| ---------------------- | -------- | -------------------------- |
| `camera_light_mode` | Yes | Outdoor camera light mode. |
### Set Schedule ### Set Schedule
`set_schedule` `set_schedule`
Set the heating schedule. This requires an entity id and a schedule name. Set the heating schedule.
### Set preset mode with end datetime | Service data attribute | Required | Description |
| ---------------------- | -------- | ------------------------------------- |
| `schedule_name` | Yes | The name of the schedule to activate. |
### Set preset mode with end date & time
`set_preset_mode_with_end_datetime` `set_preset_mode_with_end_datetime`
Set the preset mode for a Netatmo climate device. The preset mode must match a preset mode configured at Netatmo. Set the preset mode for a Netatmo climate device. The preset mode must match a preset mode configured at Netatmo.
| Service data attribute | Required | Description |
| ---------------------- | -------- | ---------------------------------------------------------- |
| `preset_mode` | Yes | Climate preset mode such as Schedule, Away, or Frost Guard. |
| `end_datetime` | Yes | Date & time until which the preset will be active. |
### Set temperature with end date & time
`set_temperature_with_end_datetime`
Sets the target temperature for a Netatmo climate device with an end date & time.
| Service data attribute | Required | Description |
| ---------------------- | -------- | -------------------------------------------------------- |
| `target_temperature` | Yes | The target temperature for the device. |
| `end_datetime` | Yes | Date & time the target temperature will be active until. |
### Set temperature with time period
`set_temperature_with_time_period`
Sets the target temperature for a Netatmo climate device as well as the time period during which this target temperature applies.
| Service data attribute | Required | Description |
| ---------------------- | -------- | ------------------------------------------------------ |
| `target_temperature` | Yes | The target temperature for the device. |
| `time_period` | Yes | Time period during which the target temperature is applied. |
### Clear temperature setting
`clear_temperature_setting`
Clears any temperature setting for a Netatmo climate device reverting it to the current preset or schedule.
### Set Person Home ### Set Person Home
`set_persons_home` `set_persons_home`
Set a list of persons as at home. Person's name must match a name known by the Netatmo Smart Indoor Camera. Set a list of persons as at home. Person's name must match a name known by the Netatmo Smart Indoor Camera.
| Service data attribute | Required | Description |
| ---------------------- | -------- | -------------- |
| `persons` | Yes | List of names. |
### Set Person Away ### Set Person Away
`set_person_away` `set_person_away`
Set a person away. If no person is set the home will be marked as empty. Person's name must match a name known by the Netatmo Smart Indoor Camera. Set a person away. If no person is set the home will be marked as empty. Person's name must match a name known by the Netatmo Smart Indoor Camera.
| Service data attribute | Required | Description |
| ---------------------- | -------- | -------------- |
| `person` | Yes | Person's name. |
### (Un-)Register Webhooks ### (Un-)Register Webhooks
`register_webhook` and `unregister_webhook` `register_webhook` and `unregister_webhook`