home-assistant.io/source/_integrations/eight_sleep.markdown

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain, ha_platforms

title	description	ha_category	ha_release	ha_iot_class	ha_codeowners	ha_domain	ha_platforms
Eight Sleep	Interface an Eight Sleep smart cover or mattress to Home Assistant	Health Binary Sensor Sensor	0.44	Cloud Polling	@mezz64 @raman325	eight_sleep	binary_sensor sensor

The eight_sleep integration allows Home Assistant to fetch data from your Eight Sleep smart cover or mattress.

There is currently support for the following device types within Home Assistant:

• Binary Sensor - lets observe the presence state of a Eight Sleep cover/mattress through Home Assistant.
• Sensor - This includes bed state, sleep fitness scores, and results of the current and previous sleep sessions.

Configuration

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).

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:

# 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 partner: description: Defines if you'd like to fetch data for both sides of the bed. required: false type: boolean default: false {% endconfiguration %}

Supported features

Sensors and associated attributes:

• eight_left/right_bed_state
  • Attributes:
    • Target Heating Level
    • Heating Active
    • Heating Time Remaining
• eight left/right_sleep_fitness
  • Attributes:
    • Fitness Date
    • Fitness Duration Score
    • Fitness Asleep Score
    • Fitness Out-of-Bed Score
    • Fitness Wakeup Score
• eight_left/right_sleep_session
  • Attributes:
    • Session Start
    • Tosses & Turns
    • Processing (True/False)
    • Time Slept (s)
    • Light Sleep %
    • Deep Sleep %
    • REM Sleep %
    • Respiratory Rate
    • Heart Rate
    • Sleep Stage
    • Room Temperature
    • Bed Temperature
• eight_left/right_previous_sleep_session
  • Attributes:
    • Session Start
    • Tosses & Turns
    • Processing (True/False)
    • Time Slept (s)
    • Light Sleep %
    • Deep Sleep %
    • REM Sleep %
    • Average Respiratory Rate
    • Average Heart Rate
    • Average Room Temperature
    • Average Bed Temperature
• eight_left/right_bed_temperature
• eight_left/right_sleep_stage
• eight_room_temperature

Binary Sensors:

• eight_left/right_bed_presence

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).

Service data attribute	Optional	Description
entity_id	no	Entity ID of bed state to adjust.
target	no	Target cooling/heating level from -100 to 100.
duration	no	Duration to cool/heat at the target level in seconds.

Script Example:

script:
  bed_set_heat:
    sequence:
      - service: eight_sleep.heat_set
        target:
          entity_id: "sensor.eight_left_bed_state"
        data:
          target: 35
          duration: 3600

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.