python library for the zigate gateway (zigbee) http://zigate.fr
Project description
zigate
Python library for ZiGate. This library manage communication between python and zigate key, both USB and WiFi key are supported (wifi is almost untested).
ZiGate is an universal gateway compatible with a lot of ZigBee device (like Xiaomi, Philipps Hue, Ikea, etc).
Current coverage :
- Commands : 38 / 53
- Responses : 33 / 40
Getting Started
Installation
To install simply do:
pip3 install zigate
Or if you've planned to use mqtt
pip3 install zigate[mqtt]
Usage
# if you want logging
import logging
logging.basicConfig()
logging.root.setLevel(logging.DEBUG)
import zigate
z = zigate.connect(port=None) # Leave None to auto-discover the port
print(z.get_version())
OrderedDict([('major', 1), ('installer', '30c'), ('rssi', 0), ('version', '3.0c')])
print(z.get_version_text())
3.0c
# refresh devices list
z.get_devices_list()
# start inclusion mode
>>> z.permit_join()
>>> z.is_permitting_join()
True
# list devices
>>> z.devices
[Device 677c , Device b8ce , Device 92a7 , Device 59ef ]
>>> z.devices[0].addr
'677c'
# get all discovered endpoints
>>> z.devices[0].endpoints
{1: {
'clusters': {0: Cluster 0 General: Basic,
1026: Cluster 1026 Measurement: Temperature,
1027: Cluster 1027 Measurement: Atmospheric Pressure,
1029: Cluster 1029 Measurement: Humidity},
}}
# get well known attributes
>>> for attribute in z.devices[0].properties:
print(attribute)
{'data': 'lumi.weather', 'name': 'type', 'attribute': 5, 'value': 'lumi.weather'}
{'data': '0121c70b0421a8010521090006240100000000642932096521851c662bd87c01000a210000', 'name': 'battery', 'value': 3.015, 'unit': 'V', 'attribute': 65281}
{'data': -1983, 'name': 'temperature', 'value': -19.83, 'unit': '°C', 'attribute': 0}
{'data': 9779, 'name': 'pressure2', 'value': 977.9, 'unit': 'mb', 'attribute': 16}
{'data': 977, 'name': 'pressure', 'value': 977, 'unit': 'mb', 'attribute': 0}
{'data': 4484, 'name': 'humidity', 'value': 44.84, 'unit': '%', 'attribute': 0}
# get specific property
>>> z.devices[0].get_property('temperature')
{'data': -1983,
'name': 'temperature',
'value': -19.83,
'unit': '°C',
'attribute': 0}
# call action on devices
z.action_onoff('b8ce', 1, zigate.ON)
or from devices
z.devices[1].action_onoff(zigate.ON)
Callback
We use pydispatcher for callback
from zigate import dispatcher
def my_callback(sender, signal, **kwargs):
print(sender) # zigate instance
print(signal) # one of EVENT
print(kwargs) # contains device and/or attribute changes, etc
dispatcher.connect(my_callback, zigate.ZIGATE_ATTRIBUTE_UPDATED)
z = zigate.connect()
# to catch any events
dispatcher.connect(my_callback, dispatcher.Any)
event can be :
zigate.ZIGATE_DEVICE_ADDED
zigate.ZIGATE_DEVICE_UPDATED
zigate.ZIGATE_DEVICE_REMOVED
zigate.ZIGATE_DEVICE_RENAMED
zigate.ZIGATE_ATTRIBUTE_ADDED
zigate.ZIGATE_ATTRIBUTE_UPDATED
zigate.ZIGATE_DEVICE_NEED_REFRESH
kwargs depends of the event type:
- for
zigate.ZIGATE_DEVICE_ADDEDkwargs contains device. - for
zigate.ZIGATE_DEVICE_UPDATEDkwargs contains device. - for
zigate.ZIGATE_DEVICE_REMOVEDkwargs contains addr (the device short address). - for
zigate.ZIGATE_DEVICE_RENAMEDkwargs contains old_addr and new_addr (used when re-pairing an already known device). - for
zigate.ZIGATE_ATTRIBUTE_ADDEDkwargs contains device and discovered attribute. - for
zigate.ZIGATE_ATTRIBUTE_UPDATEDkwargs contains device and updated attribute.
Wifi ZiGate
WiFi ZiGate is also supported:
import zigate
z = zigate.connect(host='192.168.0.10')
# or if you want to set the port
z = zigate.connect(host='192.168.0.10:1234')
MQTT Broker
This requires paho-mqtt. It could be install as a dependency with pip3 install zigate[mqtt]
python3 -m zigate.mqtt_broker --device auto --mqtt_host localhost:1883
Add --mqtt_username and --mqtt_password as arguments and allow them to be used to establish connection to the MQTT broker.
The broker publish the following topics: zigate/device_changed/[addr]
Payload example :
'zigate/device_changed/522a'
{"addr": "522a", "endpoints": [{"device": 0, "clusters": [{"cluster": 1026, "attributes": [{"value": 22.27, "data": 2227, "unit": "\u00b0C", "name": "temperature", "attribute": 0}]}, {"cluster": 1027, "attributes": [{"value": 977, "data": 977, "unit": "mb", "name": "pressure", "attribute": 0}, {"value": 977.7, "data": 9777, "unit": "mb", "name": "pressure2", "attribute": 16}, {"data": -1, "attribute": 20}]}, {"cluster": 1029, "attributes": [{"value": 35.03, "data": 3503, "unit": "%", "name": "humidity", "attribute": 0}]}], "profile": 0, "out_clusters": [], "in_clusters": [], "endpoint": 1}], "info": {"power_source": 0, "ieee": "158d0002271c25", "addr": "522a", "id": 2, "rssi": 255, "last_seen": "2018-02-21 09:41:27"}}
zigate/device_removed. Payload example :
{"addr": "522a"}
zigate/attribute_changed/[addr]/[endpoint]/[cluster]/[attribute] payload is changed attribute. Payload example :
'zigate/attribute_changed/522a/01/0403/0010'
{"cluster": 1027, "value": 978.5, "data": 9785, "attribute": 16, "unit": "mb", "endpoint": 1, "addr": "522a", "name": "pressure2"}
You can send command to zigate using the topic zigate/command payload should be:
{"function": "function_name", "args": ["optional","args","list"]}
# example to start permit join
payload = '{"function": "permit_join"}'
client.publish('zigate/command', payload)
The broker will publish the result using the topic "zigate/command/result". Payload example :
{"function": "permit_join", "result": 0}
All the zigate functions can be call:
# turn on endpoint 1
payload = '{"function": "action_onoff", "args": ["522a", 1, 1]}'
client.publish('zigate/command', payload)
# turn off endpoint 1
payload = '{"function": "action_onoff", "args": ["522a", 1, 0]}'
client.publish('zigate/command', payload)
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
zigate-0.21.2.tar.gz
(28.9 kB
view details)
Built Distribution
zigate-0.21.2-py3-none-any.whl
(31.9 kB
view details)
File details
Details for the file zigate-0.21.2.tar.gz.
File metadata
- Download URL: zigate-0.21.2.tar.gz
- Upload date:
- Size: 28.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1a95b68a76290c4a8bd19117e5edbaeea58fdbef8987a77eb3d57709b910c1e7 |
|
| MD5 | 760173ba1a4c85cf92024e2ad6c1116d |
|
| BLAKE2b-256 | a8e7b255069b17657f2e1eacc849c098ee6ed943a86e7eda62cdddb35216b261 |
Provenance
File details
Details for the file zigate-0.21.2-py3-none-any.whl.
File metadata
- Download URL: zigate-0.21.2-py3-none-any.whl
- Upload date:
- Size: 31.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 48b29589e39ef9b22dfac4e10bc08dc02b836fef6190b82e7af806b4c0737742 |
|
| MD5 | f433bf288fcc366af6a80ad5d881a5fb |
|
| BLAKE2b-256 | 1fde7adb0667804ff1ee9aa24a266e4941a653e75f433406d2b17d6d26b678e5 |
