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 .

Install development requirements

Run the following command inside this folder

pip install .[dev] .[lint]

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

Uploaded Source

Built Distribution

aioshelly-13.7.2-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aioshelly-13.7.2.tar.gz
  • Upload date:
  • Size: 39.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for aioshelly-13.7.2.tar.gz
Algorithm Hash digest
SHA256 bbd83cc5a2120139e77a02b06b364e8ee91d16019f9ee22f3591f86a84b14aef
MD5 804caa8df16f7e15bea170d9e3de2faf
BLAKE2b-256 9d378229f866803d2af3d18581a10170ab45cfd210549a300f140c30235751e2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aioshelly-13.7.2-py3-none-any.whl
  • Upload date:
  • Size: 39.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for aioshelly-13.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 72b549a11f23125f7a9784a64e95dcbfdfb8dc06f4e047fd4f31d98855cb94ba
MD5 4738772482bd7b485c73287d57825c1c
BLAKE2b-256 16be9ad7bf7ea39b4260bd8ed241901ec486f9553f9f65114af5cfee631a9975

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page