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.1.0.tar.gz
(29.3 kB
view details)
Built Distribution
aioshelly-8.1.0-py3-none-any.whl
(33.2 kB
view details)
File details
Details for the file aioshelly-8.1.0.tar.gz.
File metadata
- Download URL: aioshelly-8.1.0.tar.gz
- Upload date:
- Size: 29.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d696a2a0429edfedcf5c30081346e3acfb74175acbce34ac1c644fcf7a10eb70 |
|
| MD5 | a4cd5c82fbe03a0547a5f64413405938 |
|
| BLAKE2b-256 | e3604a6f90183f5db5b380a52a813b2b5b939829548e77a948947ce3a2f6c845 |
File details
Details for the file aioshelly-8.1.0-py3-none-any.whl.
File metadata
- Download URL: aioshelly-8.1.0-py3-none-any.whl
- Upload date:
- Size: 33.2 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 | 603659ee0f4a6d9a1026280a2a42bd926a83aed59361a5b8d8309323b039a216 |
|
| MD5 | a5bf5b8bcc8e1a0bed9c5abba6bfeaec |
|
| BLAKE2b-256 | 60d729caeadf40ba550eeabe29ea3facb90f416b2119e8a3ec47d4f12a685cfb |
