Library, implementing websocket connection to ZWave-Me
Project description
ZWave-Me-WS is a websocket connection library for Z-Wave.Me Z-Way controllers
Installing
To install this package use:
pip install zwave-me-ws
Usage
To use the connector initialize the API using:
from zwave_me_ws import ZWaveMe, ZWaveMeData
zwave_api = ZWaveMe(
on_device_create=on_device_func
on_device_update=on_device_update_func,
on_new_device=on_device_add_func,
token="....", # Z-Way access token in the form .../... (remote) of /... (local)
url="...", # wss://find.z-wave.me or ws://IP:8083
platforms=[...]
)
def on_device_add_func(self, device: ZWaveMeData)
def on_device_create_func(self, devices: list[ZWaveMeData])
def on_device_update_func(self, new_info: ZWaveMeData)
Here platforms
is the list of deviceType fields to handle. Used to filter only types supported by your application. For example,
["sensorBinary", "lightMultilevel", "toggleButton", "thermostat", "motor", "fan", "doorlock", "switchMultilevel", "switchBinary", "sensorMultilevel", "siren", "switchRGBW", "switchRGB"]
.
Available functions:
devices = zwave_api.get_devices()
zwave_api.send_command(device_id, command) # command can be "on", "off", "exact?level=..", "open", "close"
is_connected = zwave_api.get_connection()
zwave_api.close_ws()
Device (ZWaveMeData) has the following fields:
id: str
deviceType: str
title: str
level: Union[str, int, float]
deviceIdentifier: str
probeType: str
scaleTitle: str
min: str
max: str
color: dict
isFailed: bool
locationName: str
manufacturer: str
firmware: str
tags: list[str]
nodeId: str
creatorId: str
Project details
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
zwave_me_ws-0.3.1.tar.gz
(4.9 kB
view hashes)
Built Distribution
Close
Hashes for zwave_me_ws-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12c4c63d4b573fa5a12c5888de70151372d126b7c980cf28f52730fadb47a2b6 |
|
MD5 | 2489dd7dcf78a1f7f509adff6597c49a |
|
BLAKE2b-256 | 397a3ff1ef93ce2bf1f54cfdd7ae4333eccfea1dbd720221a9facf8cef2e8aef |