Skip to main content

Asynchronous library to control Shelly devices.

Project description

codecov ci

Aioshelly

Asynchronous library to control Shelly devices

This library is under development

Requirements

  • Python >= 3.11
  • bluetooth-data-tools
  • aiohttp
  • orjson

Install

pip install aioshelly

Install from Source

Run the following command inside this folder

pip install --upgrade .

Examples

Gen1 Device (Block/CoAP) example:

import asyncio
from pprint import pprint

import aiohttp

from aioshelly.block_device import COAP, BlockDevice
from aioshelly.common import ConnectionOptions
from aioshelly.exceptions import DeviceConnectionError, InvalidAuthError


async def test_block_device():
    """Test Gen1 Block (CoAP) based device."""
    options = ConnectionOptions("192.168.1.165", "username", "password")

    async with aiohttp.ClientSession() as aiohttp_session, COAP() as coap_context:
        try:
            device = await BlockDevice.create(aiohttp_session, coap_context, options)
        except InvalidAuthError as err:
            print(f"Invalid or missing authorization, error: {repr(err)}")
            return
        except DeviceConnectionError as err:
            print(f"Error connecting to {options.ip_address}, error: {repr(err)}")
            return

        for block in device.blocks:
            print(block)
            pprint(block.current_values())
            print()


if __name__ == "__main__":
    asyncio.run(test_block_device())

Gen2 and Gen3 (RPC/WebSocket) device example:

import asyncio
from pprint import pprint

import aiohttp

from aioshelly.common import ConnectionOptions
from aioshelly.exceptions import DeviceConnectionError, InvalidAuthError
from aioshelly.rpc_device import RpcDevice, WsServer


async def test_rpc_device():
    """Test Gen2/Gen3 RPC (WebSocket) based device."""
    options = ConnectionOptions("192.168.1.188", "username", "password")
    ws_context = WsServer()
    await ws_context.initialize(8123)

    async with aiohttp.ClientSession() as aiohttp_session:
        try:
            device = await RpcDevice.create(aiohttp_session, ws_context, options)
        except InvalidAuthError as err:
            print(f"Invalid or missing authorization, error: {repr(err)}")
            return
        except DeviceConnectionError as err:
            print(f"Error connecting to {options.ip_address}, error: {repr(err)}")
            return

        pprint(device.status)


if __name__ == "__main__":
    asyncio.run(test_rpc_device())

Example script

The repository includes example script to quickly try it out.

Connect to a device and print its status whenever we receive a state change:

python3 tools/example.py -ip <ip> [-u <username>] [-p <password] -i

Connect to all the devices in devices.json at once and print their status:

python3 tools/example.py -d -i

Show usage help:

python3 tools/example.py -h

Contribution guidelines

Object hierarchy and property/method names should match the Shelly API.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

aioshelly-12.0.1.tar.gz (42.4 kB view details)

Uploaded Source

Built Distribution

aioshelly-12.0.1-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

Details for the file aioshelly-12.0.1.tar.gz.

File metadata

  • Download URL: aioshelly-12.0.1.tar.gz
  • Upload date:
  • Size: 42.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for aioshelly-12.0.1.tar.gz
Algorithm Hash digest
SHA256 4695b2cf1caf6735687f23861c90fcb7c71114f9ce1c261a327b8bd983c3ae4e
MD5 04b378a0bda733d54e478e545a988702
BLAKE2b-256 eebc5549e416bb95172e2c2b7b4391e39d810abc75b75ca51990042d37f75950

See more details on using hashes here.

File details

Details for the file aioshelly-12.0.1-py3-none-any.whl.

File metadata

  • Download URL: aioshelly-12.0.1-py3-none-any.whl
  • Upload date:
  • Size: 50.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for aioshelly-12.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6c0b5d83b0d7c7c69db22d4275818f4ade7e38cfff8df25fcb63c72eff4aefc3
MD5 fbc9aaefaff897c11297c7c1981bb9eb
BLAKE2b-256 d37368728301f3532d705e6e5dbaa0e10fe0f0f119bcee1be356b825acfd9a54

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