Asynchronous library to control Shelly devices.
Project description
Aioshelly
Asynchronous library to control Shelly devices
This library is under development
Requirements
- Python >= 3.10
- 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,
FirmwareUnsupported,
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 FirmwareUnsupported as err:
print(f"Device firmware not supported, error: {repr(err)}")
return
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,
FirmwareUnsupported,
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 FirmwareUnsupported as err:
print(f"Device firmware not supported, error: {repr(err)}")
return
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-8.0.2.tar.gz
(28.9 kB
view details)
Built Distribution
aioshelly-8.0.2-py3-none-any.whl
(32.8 kB
view details)
File details
Details for the file aioshelly-8.0.2.tar.gz.
File metadata
- Download URL: aioshelly-8.0.2.tar.gz
- Upload date:
- Size: 28.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bb3e7912c0b4d58fc060290a93cd46100f59cef1e4aa61793b12956ed4a52479 |
|
| MD5 | 34df11b339fd6033addc40bf25af681b |
|
| BLAKE2b-256 | ca5304eb8e0db1a7a64635f84697bb280fe861e53fd5f1b4fe80f8b1fafa67bc |
File details
Details for the file aioshelly-8.0.2-py3-none-any.whl.
File metadata
- Download URL: aioshelly-8.0.2-py3-none-any.whl
- Upload date:
- Size: 32.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d853d1a112b315bed58d45ccf6325514a8fd1f9ea284b860486881e1f1191815 |
|
| MD5 | aa0d867f6a642b175080531ec352de79 |
|
| BLAKE2b-256 | 2f3f52668abb7430a8dc5246da9825b0cb752f40b660fcfe0484e2223baf74c9 |
