Asynchronous library to control Shelly devices.
Project description
Aioshelly
Asynchronous library to control Shelly devices
This library is under development
Requires Python 3 and uses asyncio, aiohttp and socket.
From release 1.0.0 and up library has breaking changes to support Shelly Gen2 devices Gen1 Device class moved under block_device
Gen1 Device (Block/CoAP) example:
import asyncio
from pprint import pprint
import aiohttp
import async_timeout
from aioshelly.block_device import COAP, BlockDevice
from aioshelly.common import ConnectionOptions
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:
async with async_timeout.timeout(10):
device = await BlockDevice.create(
aiohttp_session, coap_context, options
)
except asyncio.TimeoutError:
print("Timeout connecting to", ConnectionOptions.ip_address)
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
import async_timeout
from aioshelly.common import ConnectionOptions
from aioshelly.rpc_device import RpcDevice
async def test_rpc_device():
"""Test Gen2 RPC (WebSocket) based device."""
options = ConnectionOptions("192.168.1.188", "username", "password")
async with aiohttp.ClientSession() as aiohttp_session:
try:
async with async_timeout.timeout(10):
device = await RpcDevice.create(aiohttp_session, options)
except asyncio.TimeoutError:
print("Timeout connecting to", ConnectionOptions.ip_address)
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-1.0.0.tar.gz
(17.1 kB
view details)
Built Distribution
aioshelly-1.0.0-py3-none-any.whl
(19.0 kB
view details)
File details
Details for the file aioshelly-1.0.0.tar.gz.
File metadata
- Download URL: aioshelly-1.0.0.tar.gz
- Upload date:
- Size: 17.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 248315023cb552410c2843705e2efbd3e16edd3be77bc812e76d948af50449d6 |
|
| MD5 | 3131f4248ffd9614b548405715c5bba9 |
|
| BLAKE2b-256 | faa96c024c5da39265979e03b5345a2aaf3aea13f71f83b205b0e3e8a7f79b82 |
File details
Details for the file aioshelly-1.0.0-py3-none-any.whl.
File metadata
- Download URL: aioshelly-1.0.0-py3-none-any.whl
- Upload date:
- Size: 19.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83f4edbbc5f0ba571612655b40cd7723f43e933860057bc1b673ce30856e6cc9 |
|
| MD5 | adae8202fc847111dfd61ffe0b79867e |
|
| BLAKE2b-256 | fe59d577fafcf7f8cd5e047ddeedfcc50dc625aaf692aeaef8171fbb33237da3 |
