Asynchronous library to control Shelly devices.
Project description
Aioshelly
Asynchronous library to control Shelly devices
This library is under development
Requires Python >= 3.9 and uses asyncio, aiohttp and socket.
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 (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 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())
Included examples
The repository includes two examples to quickly try it out.
Connect to a device and print its status whenever we receive a state change:
python3 example.py -ip <ip> [-u <username>] [-p <password]
Connect to all the devices in devices.json at once and print their status:
python3 example.py -d -i
Show usage help:
python3 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-4.1.1.tar.gz
(19.9 kB
view details)
Built Distribution
aioshelly-4.1.1-py3-none-any.whl
(22.1 kB
view details)
File details
Details for the file aioshelly-4.1.1.tar.gz.
File metadata
- Download URL: aioshelly-4.1.1.tar.gz
- Upload date:
- Size: 19.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b6b9066293741eaadd27729089b9ec86bfc0df31476a45cf28949acebdde12d1 |
|
| MD5 | 715df56fb3498d34439dc4ccd5a91646 |
|
| BLAKE2b-256 | bd1f871ecb65f1f83adbd26fa38635bffefea33e725e7eba8f4b1ade05e772fa |
File details
Details for the file aioshelly-4.1.1-py3-none-any.whl.
File metadata
- Download URL: aioshelly-4.1.1-py3-none-any.whl
- Upload date:
- Size: 22.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 768d998522b15e10b5ce0c5ddcf87d6997893d4052a83204a4dcd6258f5eee4d |
|
| MD5 | 2ffc0e463c44f75d53a966a6a7e104d1 |
|
| BLAKE2b-256 | b22476ebb7d40f88311a9d86554d117ae55782d3aabe22da6061a9a6133ee5a7 |
