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 .
Prepare the development environment
Run the following commands inside this folder
python3 -m venv .venv
source .venv/bin/activate
pip install uv
uv sync --all-groups
prek install
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+ (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+ 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.
1 maintainer
Release files for aioshelly 13.33.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aioshelly-13.33.0.tar.gz | 55.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aioshelly-13.33.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 111.3 kB
Release files / aioshelly-13.33.0.tar.gz
| Download URL | aioshelly-13.33.0.tar.gz |
|---|---|
| Size | 55.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
abe181343b53b80df36ba52c7dedd4bcc2edef00e4d35eb289b8d7cccdc94b81
|
|
BLAKE2b-256 checksum How to use checksums |
6426bd4675d62a5733c23f0d6b768dfe3be4c018b40f8c588767613a3672c6d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.
Transparency logRelease files / aioshelly-13.33.0-py3-none-any.whl
| Download URL | aioshelly-13.33.0-py3-none-any.whl |
|---|---|
| Size | 55.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9ed699ca3dae0f1b6483e186a31ef04bfc6bd9efd32b46788928cac507c1998d
|
|
BLAKE2b-256 checksum How to use checksums |
99c301d986924efdb280a62f6639a0a06d02687a9b933049f125b3a7902cc135
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 15, 2026.
Transparency log
