Skip to main content

Library implementing Zigpy quirks for ZHA in Home Assistant

Project description

Build Status

ZHA Device Handlers For Home Assistant

ZHA Device Handlers are custom quirks implementations for Zigpy, the library that provides the Zigbee support for the ZHA component in Home Assistant.

ZHA device handlers bridge the functionality gap created when manufacturers deviate from the ZCL specification, handling deviations and exceptions by parsing custom messages to and from Zigbee devices. Zigbee devices that deviate from or do not fully conform to the standard specifications set by the Zigbee Alliance may require the development of custom ZHA Device Handlers (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA component in Home Assistant.

Custom quirks implementations for zigpy implemented as ZHA Device Handlers are a similar concept to that of Hub-connected Device Handlers for the SmartThings Classics platform as well that of Zigbee-Shepherd Converters as used by Zigbee2mqtt, meaning they are virtual representation of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms. See Device Specifics for details.

Contributing

guidelines

Currently Supported Devices:

CentraLite

Xiaomi Aqara

Osram

SmartThings

Configuration:

  1. Update Home Assistant to 0.85.1 or a later version.

NOTE: Some devices will need to be unpaired and repaired in order to see sensor values populate in Home Assistant.

Device Specifics:

Centralite

  • All supported devices report battery level
  • Dimmer Switch publishes events to Home Assistant
  • Dimmer Switch temperature sensor is removed because it is non functional
  • 3321-S reports acceleration
  • 3310-S reports humidity

Osram

  • Dimmer Switch publishes events to Home Assistant and reports battery level
  • Dimmer Switch temperature sensor is removed because it is non functional

Xiaomi Aqara

  • All supported devices report battery level
  • All supported devices report temperature but I am unsure if it is correct or accurate
  • Vibration sensor exposes a binary sensor in Home Assistant that reports current vibration state
  • Vibration sensor sends tilt and drop events to Home Assistant
  • Cube sends the following events: flip (90 and 180 degrees), rotate_left, rotate_right, knock, drop, slide and shake
  • Motion sensor exposes binary sensors for motion and occupancy.
  • Button sends events to Home Assistant

SmartThings

  • All supported devices report battery level
  • tagV4 exposed as a device tracker in Home Assistant. The current implementation will use batteries rapidly
  • MultiV4 reports acceleration

Thanks

  • Special thanks to damarco for the majority of the device tracker code
  • Special thanks to Yoda-x for the Xioami attribute parsing code
  • Special thanks to damarco and Adminiuga for allowing me to bounce ideas off of them and for listening to me ramble

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

zha-quirks-0.0.14.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zha_quirks-0.0.14-py3-none-any.whl (66.3 kB view details)

Uploaded Python 3

File details

Details for the file zha-quirks-0.0.14.tar.gz.

File metadata

  • Download URL: zha-quirks-0.0.14.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for zha-quirks-0.0.14.tar.gz
Algorithm Hash digest
SHA256 4a177b6c6bd751f469688983ddb96d4de60529273432723964a0d8f2702432db
MD5 35efde3f27fa5ac7410aa1be298841e8
BLAKE2b-256 261e745e297c8345ace5c3438d762c38b6fa69cced1de2be1b82ea105763e1d4

See more details on using hashes here.

File details

Details for the file zha_quirks-0.0.14-py3-none-any.whl.

File metadata

  • Download URL: zha_quirks-0.0.14-py3-none-any.whl
  • Upload date:
  • Size: 66.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for zha_quirks-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 533d2ef045563b087e4c1e01960652e16dcf6b1404a4b78c5f89bb581d9dece7
MD5 97668a8185f0d45180b027a6ec7998f8
BLAKE2b-256 0640f6a094eb0656c5b0967f5b0ed7362d90e452c8eea46494c6094ff552bca4

See more details on using hashes here.

Supported by

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