Skip to main content

SleepIQ API for Python

Project description

Sleepyq is an library for accessing the SleepIQ API from Python. SleepIQ is an addon for SleepNumber beds.

To install:

python3 -m pip install sleepyq

To get started using the library, here’s the full usage:

>>> from sleepyq import Sleepyq
>>> from pprint import pprint
>>>
>>> client = Sleepyq('your-login', 'your-password')
>>> client.login()
>>> pprint(client.sleepers())
>>> pprint(client.beds())
>>> pprint(client.bed_family_status())
>>> client.set_lights(bedNumber, lightNumber, setting)
>>> pprint(client.get_lights(bedNumber, lightNumber))
>>> client.preset(bedNumber, preset, side, slowSpeed=False)
>>> client.adjust_bed(bedNumber, actuator, position, side, slowSpeed=False)
>>> client.bed_massage(bedNumber, footSpeed, headSpeed, side, timer=0, mode=0)
>>> client.set_sleepnumber(bedNumber, side, sleepnumber)
>>> client.set_favsleepnumber(bedNumber, side, sleepnumber)
>>> pprint(client.get_favsleepnumber(bedNumber))
>>> client.stop_motion(bedNumber, side)
>>> client.stop_pump(bedNumber)
>>> pprint(client.foundation_status(bedNumber))
>>> pprint(client.foundation_system(bedNumber))
>>> pprint(client.foundation_features(bedNumber))

The API is undocumented, so this library does not make much attempt to structure the data from the API into objects.

Development Notes

The SleepIQ API was announced at CES 2016 but there has yet to be any public documentation.

https://sleepiq.sleepnumber.com appears to use the SleepIQ API internally, and methods here were written based on observing use of the site with Chrome Developer Tools and by running the Android app through a proxy. There was also prior art at https://github.com/erichelgeson/sleepiq (the API has changed since then) and https://github.com/natecj/sleepiq-php

The first request to happen is to login. This returns a key (_k) that needs to be used on subsequent requests as a parameter. Subsequent requests also need to be part of the same ‘session’, since those calls expect some cookies to be set.

Todo

  • Error check response for non-200 code, or errors returned as JSON

  • Explore API more. There are a few more API calls out there, like updating profile, modifying sleep for previous night, but they seem less immediately useful for automation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sleepyq-0.8.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

sleepyq-0.8-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file sleepyq-0.8.tar.gz.

File metadata

  • Download URL: sleepyq-0.8.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.4.2 requests/2.21.0 setuptools/50.3.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sleepyq-0.8.tar.gz
Algorithm Hash digest
SHA256 ce9b02bb3619f0c1ff3209739454ddb5059c536be24f87415c1dac36c9a0cee9
MD5 1d91fba4d33cc6a469e260e9d4e3d300
BLAKE2b-256 b019863ef56d9aa25232756edfca802c554205f6c994c04fee504d0dcb3de300

See more details on using hashes here.

File details

Details for the file sleepyq-0.8-py3-none-any.whl.

File metadata

  • Download URL: sleepyq-0.8-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.4.2 requests/2.21.0 setuptools/50.3.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for sleepyq-0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d9cdda8ba512cd3b1bbed7a1829470426f82979e36cadf9144c898c8e4836241
MD5 c9441d83a86194d21f2aa0fedb9c999c
BLAKE2b-256 e3aa10af04e7bfbf6a0d9cefe2a08b27f6cf160aece0cf6ad9f2006b5cd0adce

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page