Skip to main content

Unofficial Python API for SmartRent devices

Project description

SmartRent API

Unnoficial api for SmartRent devices

Uses websockets for communication and supports async functions

Known Devices supported

Locks

  • Yale YRD256

Thermostats

  • Honeywell T6 Pro (TH6320ZW2003)

Usage

Getting an API Object

In order to get an api object to interact with, you must login with the async_login function. This starts and handles a web session with SmartRent's webserver.

import asyncio

from smartrent import async_login

async def main():
    api = await async_login('<EMAIL>', '<PASSWORD>')

asyncio.run(main())

Getting Devices

You can get lists of your devices from the api with the get_locks and get_thermostats functions. You can then interact with the devices with thier getter and setter functions.

import asyncio

from smartrent import async_login

async def main():
    api = await async_login('<EMAIL>', '<PASSWORD>')

    lock = api.get_locks()[0]
    locked = lock.get_locked()

    if not locked:
        await lock.async_set_locked(True)

asyncio.run(main())

Automatic Updating

If you need to get live updates to your device object from SmartRent, you can do that by calling start_updater. You can stop getting updates by calling stop_updater.

You can also set a callback function via set_update_callback that will be called when an update is triggered.

For example, if you want to set your thermostat to Dad Mode you can trigger an event every time the cooling_setpoint is changed and just change it back to your own desired value.

import asyncio

from smartrent import async_login

async def main():
    api = await async_login('<EMAIL>', '<PASSWORD>')

    thermo = api.get_thermostats()[0]
    thermo.start_updater()

    CONSTANT_COOL = 80

    async def on_evt():
        if CONSTANT_COOL != thermo.get_cooling_setpoint():
            await thermo.async_set_cooling_setpoint(CONSTANT_COOL)

    thermo.set_update_callback(on_evt)

    while True:
        await asyncio.sleep(60)

asyncio.run(main())

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

smartrent.py-0.0.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

smartrent.py-0.0.1-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file smartrent.py-0.0.1.tar.gz.

File metadata

  • Download URL: smartrent.py-0.0.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.8.2 Darwin/20.5.0

File hashes

Hashes for smartrent.py-0.0.1.tar.gz
Algorithm Hash digest
SHA256 a23a053ae1f03434fcd717bbac382ec24a4ab5d75ec1e24f29b4e286dde7e867
MD5 3892f1b5e71f8386ae6ae7d22599aaa7
BLAKE2b-256 122e9b2e1342f5ccc167e76a479791fe997492d670c928abd737905001705295

See more details on using hashes here.

File details

Details for the file smartrent.py-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: smartrent.py-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.8.2 Darwin/20.5.0

File hashes

Hashes for smartrent.py-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b88b6afc492d3e223e09177a1e71ecf23e5494b196fc92ecf08039ce0601539
MD5 9f25deed10aeea1032e43b5b3fb507c4
BLAKE2b-256 1d242a022cc397e3fe916b7de54046b9d3aaf7576b777ef24eecef7454ed4ca1

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