Skip to main content

Unofficial Python API for SmartRent devices

Project description

SmartRent API

PyPI version Supported Python versions PyPI downloads GitHub

Unofficial api for SmartRent devices

Uses websockets for communication and supports async functions

Known Devices supported

Locks

  • Yale YRD256

Thermostats

  • Honeywell T6 Pro (TH6320ZW2003)

Usage

Installing

pip install smartrent.py

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

Uploaded Source

Built Distribution

smartrent.py-0.0.4-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smartrent.py-0.0.4.tar.gz
  • Upload date:
  • Size: 8.8 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.4.tar.gz
Algorithm Hash digest
SHA256 2456d04653b7d7af0d718056b6b4b94a99422e308d8334e5c9a3c9b49de1e951
MD5 4d28987609f2bedb05c6639fed95cb6b
BLAKE2b-256 361f27834d1a6a196dd576655bb6e5cbd546747ba2ec5742181760829d6a0bd9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: smartrent.py-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 10.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 39747ace78438e5df4573ac040cf7f8636985e4eca9eea97d47b7e783d14cc4c
MD5 f7db3217fe2954db76f85b9f0b9f86cb
BLAKE2b-256 e55e3115a3df514405a037e8ffee29cdf17cf76f0153bc118cdbbe7be20e9272

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