Update eight_sleep docs for config flow (#22956)

This commit is contained in:
Raman Gupta 2022-06-11 02:22:35 -04:00 committed by GitHub
parent 9c670101c0
commit 6528638ba6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -24,33 +24,9 @@ There is currently support for the following device types within Home Assistant:
- Binary Sensor - lets observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant. - Binary Sensor - lets observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant.
- Sensor - This includes bed state, sleep fitness scores, and results of the current and previous sleep sessions. - Sensor - This includes bed state, sleep fitness scores, and results of the current and previous sleep sessions.
## Configuration {% include integrations/config_flow.md %}
It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the cooling/heating level and duration of the bed (cooling is only available for the POD mattress). ## Supported features
You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component.
To get started add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
eight_sleep:
username: YOUR_E_MAIL_ADDRESS
password: YOUR_PASSWORD
```
{% configuration %}
username:
description: The email address associated with your Eight Sleep account.
required: true
type: string
password:
description: The password associated with your Eight Sleep account.
required: true
type: string
{% endconfiguration %}
### Supported features
Sensors and associated attributes: Sensors and associated attributes:
@ -101,13 +77,13 @@ Binary Sensors:
- eight_left/right_bed_presence - eight_left/right_bed_presence
### Service `heat_set` ## Service `heat_set`
You can use the service eight_sleep/heat_set to adjust the target cooling/heating level and heating duration of your bed (cooling is only available for the POD mattress). You can use the service eight_sleep/heat_set to adjust the target cooling/heating level and heating duration of your bed (cooling is only available for the POD mattress).
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Entity ID of bed state to adjust. | `entity_id` | no | Entity ID for a sensor on the side to be adjusted.
| `target` | no | Target cooling/heating level from -100 to 100. | `target` | no | Target cooling/heating level from -100 to 100.
| `duration` | no | Duration to cool/heat at the target level in seconds. | `duration` | no | Duration to cool/heat at the target level in seconds.
@ -119,12 +95,12 @@ script:
sequence: sequence:
- service: eight_sleep.heat_set - service: eight_sleep.heat_set
target: target:
entity_id: "sensor.eight_left_bed_state" entity_id: "sensor.eight_johns_bed_temperature"
data: data:
target: 35 target: 35
duration: 3600 duration: 3600
``` ```
### Notice ## Notice
Please note this component relies on an undocumented API utilized by the Eight Sleep mobile app to communicate with the Eight Sleep servers. It is not supported by Eight Sleep and may malfunction if changes are made to either the mobile app operation or the API format. Please note this component relies on an undocumented API utilized by the Eight Sleep mobile app to communicate with the Eight Sleep servers. It is not supported by Eight Sleep and may malfunction if changes are made to either the mobile app operation or the API format.