smartrent-py 0.2.2

Unofficial Python API for SmartRent devices

SmartRent API

Unofficial api for SmartRent devices

Uses websockets for communication and supports async functions

Feel free to ⭐️ this repo to get notified about the latest features!

📚 Read the docs! 📚

Supported Devices

This client supports:

• 🔐 Door Locks
• 🌡 Thermostats
• 💧 Leak Sensors
• 💡 Binary Switches

Usage

Installation

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.

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 their 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())

Development

Setting up dev enviornment

pip install -r requirements_test.txt

Running the code formatter

Black is used for quick and easy code formatting

black smartrent

Special thanks

Much inspiration was taken from these projects:

AMcPherran/SmartRent-MQTT-Bridge

natanweinberger/smartrent-python

Burry/homebridge-smartrent

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

TODOs

• Add support for Two Factor Auth