python library for the zigate gateway (zigbee) http://zigate.fr

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Sbastien.Ramage from gravatar.com Sbastien.Ramage

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

# zigate
python library for zigate http://zigate.fr/


This library manage communication between python and zigate key, both USB and WiFi key are supported (wifi is almost untested)


Usage :

```
# if you want logging
import logging
logging.basicConfig()
logging.root.setLevel(logging.DEBUG)

import zigate
z = zigate.ZiGate(port=None) # Leave None to auto-discover the port

>>> print(z.get_version())
OrderedDict([('major', 1), ('installer', '30b'), ('rssi', 0), ('version', '3.0b')])

>>> print(z.get_version_text())
3.0b

# 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: {'0405_0000': {'endpoint': 1,
'data': 3997,
'cluster': 1029,
'attribute': 0,
'status': 0,
'friendly_name': 'humidity',
'value': 39.97,
'unit': '%'},
'0000_0005': {'endpoint': 1,
'data': '6c756d692e77656174686572',
'cluster': 0,
'attribute': 5,
'status': 0,
'friendly_name': 'type',
'value': 'lumi.weather',
'unit': ''},
'0000_0001': {'cluster': 0,
'endpoint': 1,
'status': 0,
'attribute': 1,
'data': 3},
'0403_0000': {'endpoint': 1,
'data': 976,
'cluster': 1027,
'attribute': 0,
'status': 0,
'friendly_name': 'pressure',
'value': 976,
'unit': 'mb'},
'0000_ff01': {'cluster': 0,
'endpoint': 1,
'status': 0,
'attribute': 65281,
'data': '0121ef0b0421a81305210800062401000000006429a6096521a30f662b737d01000a210000'},
'0403_0010': {'endpoint': 1,
'data': 9762,
'cluster': 1027,
'attribute': 16,
'status': 0,
'friendly_name': 'detailled pressure',
'value': 976.2,
'unit': 'mb'},
'0403_0014': {'cluster': 1027,
'endpoint': 1,
'status': 0,
'attribute': 20,
'data': -1},
'0402_0000': {'endpoint': 1,
'data': 2447,
'cluster': 1026,
'attribute': 0,
'status': 0,
'friendly_name': 'temperature',
'value': 24.47,
'unit': '°C'}}}


get well known attributes
>>> for attribute in z.devices[0].properties:
print(attribute)
{'endpoint': 1, 'data': 3997, 'cluster': 1029, 'attribute': 0, 'status': 0, 'friendly_name': 'humidity', 'value': 39.97, 'unit': '%'}
{'endpoint': 1, 'data': '6c756d692e77656174686572', 'cluster': 0, 'attribute': 5, 'status': 0, 'friendly_name': 'type', 'value': 'lumi.weather', 'unit': ''}
{'endpoint': 1, 'data': 976, 'cluster': 1027, 'attribute': 0, 'status': 0, 'friendly_name': 'pressure', 'value': 976, 'unit': 'mb'}
{'endpoint': 1, 'data': 9762, 'cluster': 1027, 'attribute': 16, 'status': 0, 'friendly_name': 'detailled pressure', 'value': 976.2, 'unit': 'mb'}
{'endpoint': 1, 'data': 2447, 'cluster': 1026, 'attribute': 0, 'status': 0, 'friendly_name': 'temperature', 'value': 24.47, 'unit': '°C'}

# get specific property
>>> z.devices[0].get_property('temperature')
{'endpoint': 1,
'data': 2447,
'cluster': 1026,
'attribute': 0,
'status': 0,
'friendly_name': 'temperature',
'value': 24.47,
'unit': '°C'}


```

You can use callback to catch some events

```
def my_callback(event, **kwargs):
print(event)
print(kwargs)

z = ZiGate(callback=my_callback)
```

event can be :
zigate.ZGT_CMD_NEW_DEVICE = 'new_device'
zigate.ZGT_CMD_DEVICE_UPDATE = 'device_update'
zigate.ZGT_CMD_REMOVE_DEVICE = 'remove_device'

kwargs depends of the event type
for zigate.ZGT_CMD_NEW_DEVICE:
kwargs contains device

for zigate.ZGT_CMD_DEVICE_UPDATE
kwargs contains device
and attribute updated (if applicable)

for zigate.ZGT_CMD_REMOVE_DEVICE
kwargs contains addr (the device short address)



Wifi ZiGate:

```
import zigate
z = zigate.ZiGateWiFi(host='192.168.0.10', port=9999)
print(z.get_version())

# list devices
z.devices

# start inclusion mode
z.permit_join()
```



Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Sbastien.Ramage from gravatar.com Sbastien.Ramage

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

0.40.12

0.40.11

0.40.10

0.40.9

0.40.8

0.40.7

0.40.6

0.40.5

0.40.4

0.40.3

0.40.2

0.40.1

0.40.0

0.39.0

0.38.9

0.38.8

0.38.7

0.38.6

0.38.5

0.38.4

0.38.3

0.38.2

0.38.1

0.38.0

0.37.4

0.37.3

0.37.2

0.37.1

0.37.0

0.36.2

0.36.1

0.36.0

0.35.4

0.35.3

0.35.2

0.35.1

0.35.0

0.34.1

0.34.0

0.33.1

0.33.0

0.32.3

0.32.2

0.32.1

0.32.0

0.31.4

0.31.3

0.31.2

0.31.1

0.31.0

0.30.1

0.30.0

0.29.11

0.29.10

0.29.9

0.29.8

0.29.7

0.29.6

0.29.5

0.29.4

0.29.3

0.29.2

0.29.1

0.29.0

0.28.4

0.28.3

0.28.2

0.28.1

0.28.0

0.27.9

0.27.8

0.27.7

0.27.6

0.27.5

0.27.4

0.27.3

0.27.2

0.27.1

0.27.0

0.26.4

0.26.3

0.26.2

0.26.1

0.26.0

0.25.1

0.25.0

0.24.2

0.24.1

0.24.0

0.23.1

0.23.0

0.22.0

0.21.2

0.21.1

0.21.0

0.20.2

0.20.1

0.20.0

0.19.1

0.19.0

0.18.5

0.18.4

0.18.3

0.18.2

0.18.1

0.18.0

0.17.3

0.17.2

0.17.1

0.17.0

0.16.5

0.16.4

0.16.3

0.16.2

0.16.1

0.16.0

0.15.5

0.15.4

0.15.3

0.15.2

0.15.1

0.15.0

0.14.1

0.14.0

0.13.4

0.13.3

0.13.2

0.13.1

0.13.0

0.12.3

0.12.2

0.12.1

0.12.0

0.11.3

0.11.2

0.11.1

0.11.0

0.10.9

0.10.8

0.10.7

0.10.6

0.10.5

0.10.4

0.10.3

0.10.2

0.10.1

0.10.0

0.9.2

0.9.1

0.9.0

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.7.3

0.7.2

0.7.1

0.7.0

This version

0.6.0

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.1

0.4.0

0.3.1

0.2.1

0.2.0

0.1.1

0.1.0

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.6.0.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

zigate-0.6.0-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file zigate-0.6.0.tar.gz.

File metadata

  • Download URL: zigate-0.6.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for zigate-0.6.0.tar.gz
Algorithm Hash digest
SHA256 4cdc7b19e0238f50a9ae9047725c4940a6c7d5b293dc1b4617de6905c57d8f3f
MD5 5d182d7048a77402a817870ff1f13139
BLAKE2b-256 52d3e1febc296a7fb6f5256b2547ec30055de30af1be53aec5d3025eed3f5411

See more details on using hashes here.

Provenance

File details

Details for the file zigate-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for zigate-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ff059f5a6953789eaf3e0c58bd336f3b037e3daa125d283b8e32be7fa215f00
MD5 3445f62a34a2f2a075144a2e96431e08
BLAKE2b-256 eb83f561befa155d086a483a8a2589430bb23318192c5d4c20daef3007e3af34

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page