Add switcher kis auto off service (#9640)

* Prettier recommandations.

* Added switcher_kis.set_auto_off service documantation.
This commit is contained in:
Tomer Figenblat 2019-06-18 11:27:25 +03:00 committed by Franck Nijhof
parent a0dd5a0e01
commit 764fd09b75

View File

@ -57,14 +57,27 @@ device_password:
## {% linkable_title Switch State Attributes %}
| Attribute | Type | Description | Example |
| --------- | ---- | ----------- | ------- |
| `friendly_name` | string | Defaults to the device's configured name. | "Switcher Boiler" |
| `auto_off_set` | string | The auto shutdown time limit configured on the device. | "01:30:00" |
| `remaining_time` | string | Time remaining to shutdown (auto or timer). | "01:29:41" |
| `electric_current` | float | The electric current in amps. | 12.5 |
| `current_power_w` | integer | The current power used in watts. | 2756 |
| Attribute | Type | Description | Example |
| ------------------ | ------- | ------------------------------------------------------ | ----------------- |
| `friendly_name` | string | Defaults to the device's configured name. | "Switcher Boiler" |
| `auto_off_set` | string | The auto shutdown time limit configured on the device. | "01:30:00" |
| `remaining_time` | string | Time remaining to shutdown (auto or timer). | "01:29:41" |
| `electric_current` | float | The electric current in amps. | 12.5 |
| `current_power_w` | integer | The current power used in watts. | 2756 |
<p class='note warning'>
Please note, the following attributes are not eligible when the device is off and therefore will not appear as state attributes: `remaining_time`, `electric_current`, `current_power_w`.
</p>
## {% linkable_title Services %}
### {% linkable_title Service: `switcher_kis.set_auto_off` %}
You can use the `switcher_kis.set_auto_off` service to set the auto-off configuration setting for the device.
Meaning the device will turn itself off when reaching the auto-off configuration limit.
| Service Field | Mandatory | Description | Example |
| ------------- | --------- | -------------------------------------------------------------------------------------- | -------------------------- |
| `entity_id` | Yes | Name of the entity id associated with the integration, used for permission validation. | switch.switcher_kis_boiler |
| `auto_off` | Yes | Time period string containing hours and minutes. | "02:30" |