Asynchronous library to control Shelly devices.
Project description
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.
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-11.1.0.tar.gz
(36.1 kB
view details)
Built Distribution
File details
Details for the file aioshelly-11.1.0.tar.gz.
File metadata
- Download URL: aioshelly-11.1.0.tar.gz
- Upload date:
- Size: 36.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9be8be0566b25745fb869c62a832d66fe485f4be9a3d9845424e18a99928c91e |
|
| MD5 | 3e2ae01cd2d0e24a76781cc44e2b1c26 |
|
| BLAKE2b-256 | 0dc312b032a8c2621e8c888e4f8d9ec5b7814142c87b0aab1dc091c08023a9dc |
File details
Details for the file aioshelly-11.1.0-py3-none-any.whl.
File metadata
- Download URL: aioshelly-11.1.0-py3-none-any.whl
- Upload date:
- Size: 43.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 041f609f0481393a1754700f766a9993c9bede8857b2ee4732c847da7f8bb6e3 |
|
| MD5 | c3fe4a50d0f241298e967e50d4448d71 |
|
| BLAKE2b-256 | 6c08341fb92a4e222574ae21e07b46c5c2fac1741383e55a0afead7728e4fc05 |
