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.2.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: smartrent.py-0.0.2.tar.gz
  • Upload date:
  • Size: 8.4 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.2.tar.gz
Algorithm Hash digest
SHA256 e230468066e04f9cf9ef6e566f1bc090e20adada305344488f4b1f6e347caa88
MD5 77527a44a189b5cb9def28ddf160d0ee
BLAKE2b-256 f45cf6b67c013d87e6415ec0c8d97ea74c578819e1d72319186ace22b12bca14

See more details on using hashes here.

File details

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

File metadata

  • Download URL: smartrent.py-0.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 09ca0537546a6fe55cdd081a0b007d4b1762dcef2f21f918325e7daddda3a7bb
MD5 13cc5c148ba7d2e80ee779bc9cbffb22
BLAKE2b-256 1a98b529eb991db25b4eac6b0b41417e1295dd412fe41f8b173bd4325d5af46b

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