Home Assistant Eight Sleep integration that works with Eight Sleep's V2 API and OAUTH2

1. Add this repository to HACS AS A CUSTOM REPOSITORY.
2. Search for Eight Sleep, and choose install.
3. Reboot Home Assistant and configure from the "Add Integration" flow.

NOTE: Ensure neither side is in away mode when setting up the Eight Sleep integration.

When setting up the integration you need your Eight Sleep credentials:

• Email
• Password

You can leave the client_id and/or client_secret blank.

The integration will function similarly to the previous Home Assistant core Eight Sleep integration. It will import the Eight Sleep bed sides and account as devices.
Setting the temperature on the bed is between a -100 to 100 range. This range is unit-less in the API.

There are a few services you can use on the <..>_bed_temperature entities:

• Heat Set
  • Sets heating/cooling level for a <..>_bed_temperature entity. Can set the Current, Bedtime, Early, or Late temperature using the Sleep Stage selection.
• Heat Increment
  • Increases/decreases the current heat level for a <..>_bed_temperature entity.
• Side Off
  • Turns off 8 sleep side. Input entity must be a <..>_bed_temperature entity.
• Side On
  • Turns on 8 sleep side in smart mode. Input entity must be a <..>_bed_temperature entity.
• Alarm Snooze
  • Snoozes an active alarm on a <..>_bed_temperature entity for a specified number of minutes.
• Alarm Stop
  • Stops an active alarm on a <..>_bed_temperature entity.
• Alarm Dismiss
  • Dismisses an upcoming alarm on a <..>_bed_temperature entity.
• Start Away Mode
  • Turns on away mode for an 8 sleep side. Input entity must be a <..>_bed_temperature entity.
• Stop Away Mode
  • Turns off away mode for an 8 sleep side. Input entity must be a <..>_bed_temperature entity.
• Prime Pod
  • Will start the bed priming. Input entity must be a <..>_bed_temperature entity. The user side that calls this service is the one that will be notified when it is finished.
• Set Bed Side
  • Will set the bed side for the user selected by the <..>_bed_temperature entity as the target. The options are "Both", "Left", or "Right". While the app has an option to set "Away" for the bed side, the API call does not work like that. If you would like to set away status, use the "Start Away Mode" or "Stop Away Mode" service calls.
• Set One-Off Alarm
  • Create or update a single, one-time alarm for the selected side. Parameters:
    • time (required, HH:MM:SS)
    • enabled (optional, default: true)
    • vibration_enabled (optional, default: true)
    • vibration_power_level (optional, one of 20|50|100, default: 50)
    • vibration_pattern (optional, one of RISE|intense, default: RISE)
    • thermal_enabled (optional, default: true)
    • thermal_level (optional, -100 to 100, default: 0)
• Set Routine Alarm
  • Update the time of an existing alarm in a routine. Parameters:
    • routine_id (required)
    • alarm_id (required)
    • alarm_time (required, HH:MM:SS)
• Set Routine Bedtime
  • Update the bedtime for a routine. Parameters:
    • routine_id (required)
    • bedtime (required, HH:MM:SS)

There are a few possible sensor values for each Eight Sleep side. Some ones with caveats are

• Bed Presence
  • Presence is calculated retroactively by Eight Sleep and is not reliable. For example leaving the bed for an hour does not end the presence. The lack of heart rate measurement is used instead to determine presence with a smaller delay.
• Next Alarm
  • This will be the datetime value of your next alarm. If you have no alarms set, then it will be set to Unknown.

Sensor values are updated every 5 minutes

When the Base is installed, the following entities are available:

These values are updated every minute.

There are alarm switches that will be auto-configured for each alarm you have setup.

Further information about the alarms are available under attributes:

You can now manage alarms directly via services on your <..>_bed_temperature entity:

• Set One-Off Alarm: create/update a single-use alarm.
• Set Routine Alarm: change the time of an existing alarm in a routine.
• Set Routine Bedtime: update a routine's bedtime.

Finding IDs for routine/alarm services:

• Use your <..>_routines sensor. Its attributes include a routines list with each routine id, name, days, and alarms (each alarm includes id, time, and enabled).
• The Next Alarm sensor exposes the next Alarm ID in its attributes.

Example: Set a one-off alarm at 06:45 with medium vibration and +20° thermal boost

service: sensor.set_one_off_alarm
target:
  entity_id: sensor.left_bed_temperature
data:
  time: "06:45:00"
  enabled: true
  vibration_enabled: true
  vibration_power_level: 50   # 20|50|100
  vibration_pattern: RISE     # RISE|intense
  thermal_enabled: true
  thermal_level: 20           # -100..100

Example: Update a routine alarm time (routine and alarm IDs from the <..>_routines sensor)

service: sensor.set_routine_alarm
target:
  entity_id: sensor.right_bed_temperature
data:
  routine_id: "d9f1a1e0-1234-5678-90ab-abcdef012345"
  alarm_id: "a1b2c3d4"
  alarm_time: "07:30:00"

Example: Update a routine bedtime

service: sensor.set_routine_bedtime
target:
  entity_id: sensor.right_bed_temperature
data:
  routine_id: "d9f1a1e0-1234-5678-90ab-abcdef012345"
  bedtime: "22:30:00"

• Translate "Heat Set" and "Heat Increment" values to temperature values in degrees for easier use.
• Add local device functionality for jailbroken devices using the steps in https://github.com/bobobo1618/ninesleep or https://github.com/throwaway31265/free-sleep

• Can I use this integration without an Eight Sleep subscription?
  • I believe you can use this integration without a subscription. This integration uses the same calls as the app. And I believe the app allows the calls the integration is using, even when not having a subscription. I don't have any way to test it out though, because I have a grandfathered account.
• Can I use this integration to get a reliable, current bed presence?
  • No. Presence is calculated retroactively by Eight Sleep based on sensor data. It's neither reliable, nor real-time.
• How do I capture the Eight Sleep app traffic?
  • To get the client_id and client_secret you can setup a packet capture and a mitm CA to get the unencrypted traffic from your app. You can also decompile the APK to get the values.
  • The process I used was:
    • Open pcapdroid and install PCAPDroid mitm
    • download and install rootAVD https://github.com/newbit1/video-files/blob/master/rootAVD_Windows.gif
      • 2 ways to root an AVD (android studio); Magisk (rootAVD) and SuperSU
    • Should auto install magisk
    • Run the avd root install steps then open a cmd in ..\rootavd\rootAVD
    • Install the mitm cert (mitmproxy-ca-cert.cert)
    • https://emanuele-f.github.io/PCAPdroid/tls_decryption the MagiskTrustUserCerts module, and then install the hashed certificate (replace mitmproxy-ca-cert.cer with the PCAPdroid certificate name) as a system certificate.
    • Run the app and capture date in pcapdroid.
      • Make sure you capture the data during an app login session. The data should be in the POST request from the app to auth-api.8slp.net

Thanks to @mezz64 and @raman325 for developing the previous Eight Sleep integration.

This is also based on work from https://github.com/lukas-clarke/pyEight and I will likely maintain this repo over the aforementioned one.