Library implementing Zigpy quirks for ZHA in Home Assistant
Project description
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.
How to contribute
For specific Zigbee debugging instructions on capturing logs and more, see the contributing guidelines in the CONTRIBUTING.md file:
If you are looking to make your first code contribution to this project then we also suggest that you follow the steps in these guides:
- https://github.com/firstcontributions/first-contributions/blob/master/README.md
- https://github.com/firstcontributions/first-contributions/blob/master/github-desktop-tutorial.md
Currently Supported Devices:
CentraLite
- Contact Sensor: CentraLite 3300-S
- Motion Sensor: CentraLite 3305-S
- Dimmer Switch: CentraLite 3130
- Water Sensor: CentraLite 3315-S
- Contact Sensor: CentraLite 3320-L
- Motion Sensor: CentraLite 3325-S
- Motion Sensor: CentraLite 3326-L
- Contact Sensor: CentraLite 3321-S
- Temperature / Humidity Sensor: CentraLite 3310-S
- Smart Button: CentraLite 3460-L
- Thermostat: CentraLite 3157100
Xiaomi Aqara
- Cube: lumi.sensor_cube.aqgl01
- Button: lumi.sensor_switch.aq2
- Vibration Sensor: lumi.vibration.aq1
- Contact Sensor: lumi.sensor_magnet.aq2
- Motion Sensor: lumi.sensor_motion.aq2
- Temperature / Humidity Sensor: lumi.weather
- Water Leak: lumi.sensor_wleak.aq1
Osram
SmartThings
- Arrival Sensor: tagv4
- Motion Sensor: MotionV4
- Multi Sensor: MultiV4
Keen Home
- Temperature / Humidity / Pressure Sensor: LUMI RS-THP-MP-1.0
Lutron
- Connected Bulb Remote: Lutron LZL4BWHL01 Remote
WAXMANN
- Water Sensor: leakSMART Water Sensor V2
Digi
- XBee Series 2: xbee
- XBee Series 3: xbee3
Yale
Configuration:
- 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
tiltanddropevents to Home Assistant - Cube sends the following events:
flip (90 and 180 degrees),rotate_left,rotate_right,knock,drop,slideandshake - 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
Lutron
- Connected bulb remote publishes events to Home Assistant
WAXMANN
- leakSMART water sensor is exposed as a binary_sensor with DEVICE_CLASS_MOISTURE
Digi XBee
- Some functionality requires a coordinator device to be XBee as well
- GPIO pins are exposed to Home Assistant as switches
- Analog inputs are exposed as sensors
- Outgoing UART data can be sent with
zha.issue_zigbee_cluster_commandservice - Incoming UART data will generate
zha_eventevent.
For example, the following script replies with an Assistant string to the device once it receives a Home string from it (replace ieee with your actual endpoint device ieee):
automation:
- alias: XBee UART Test
trigger:
platform: event
event_type: zha_event
event_data:
device_ieee: 00:13:a2:00:12:34:56:78
command: receive_data
args: Home
action:
service: zha.issue_zigbee_cluster_command
data:
ieee: 00:13:a2:00:12:34:56:78
endpoint_id: 232
cluster_id: 17
cluster_type: in
command: 0
command_type: server
args: Assistant
Yale
- All supported devices report battery level
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
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
Built Distribution
File details
Details for the file zha-quirks-0.0.29.tar.gz.
File metadata
- Download URL: zha-quirks-0.0.29.tar.gz
- Upload date:
- Size: 41.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0251c416da3c51a94726684119ba51e86840cca62e56083e2be4164d78362800 |
|
| MD5 | c7ff149535cd913bd5d91f524ba487ff |
|
| BLAKE2b-256 | e1f6fd610514345f07561f288ac8f6090d6398a9587b1527bbd209d57e8ea553 |
File details
Details for the file zha_quirks-0.0.29-py3-none-any.whl.
File metadata
- Download URL: zha_quirks-0.0.29-py3-none-any.whl
- Upload date:
- Size: 97.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 65978a782d37a0110e464614fa1728ae1a7d4f4a87b3332004de77bf168f9f34 |
|
| MD5 | f84370593c6c9bf6c755c625ef9b00fd |
|
| BLAKE2b-256 | c3b4023c5f2fa677b156ff11901c86f77da9594e1f7ebee1ae5eed5eddbf593f |
