https://github.com/vigonotion/zha_supported_devices
:book: zha supported devices in home assistant
https://github.com/vigonotion/zha_supported_devices
homeassistant quirks zha zigbee
Last synced: about 1 year ago
JSON representation
:book: zha supported devices in home assistant
- Host: GitHub
- URL: https://github.com/vigonotion/zha_supported_devices
- Owner: vigonotion
- License: apache-2.0
- Archived: true
- Created: 2019-04-21T15:10:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-22T09:16:52.000Z (about 7 years ago)
- Last Synced: 2024-11-06T01:40:30.462Z (over 1 year ago)
- Topics: homeassistant, quirks, zha, zigbee
- Size: 63.5 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZHA supported devices
This repository holds a list of all devices which are supported by the [ZHA][link-zha] component of [Home Assistant][link-ha].
## Contributing
Please create a yaml file in the format specified below, and create a pull request on this repository.
## Format
The device files should be placed in a yaml file `/devices/VENDOR/MODEL.yaml`.
Here is an example of how a file could look like:
```yaml
model: LED1545G12
domains:
- light
description: white spectrum, dimmable light
picture_url: ikea_LED1545G12.png
link: https://www.ikea.com/us/en/catalog/products/70353343/
```
Explanation:
| key | optional | description |
|-------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| model | no | Model number of the device. You can find that in the datasheet. This is not "60W opal white", but a specific model number. Only use "60W opal white" model descriptors if you really can't find any model number |
| domains | no | Array of home assistant domains this device creates |
| sensors | yes | If this device has sensors, specify them in a list. E. g.: motion, contact, water |
| description | no | A short description about what this devices does |
| notes | yes | Additional information about this device. If you had to reset the device in a specific way, write it here |
| picture_url | yes | Pictures should be placed in `devices/pictures/DEVICE_PICTURE.png`. This has to be a 300x300px PNG file. Only add `DEVICE_PICTURE.png` here, do not add the full path. |
| source | yes | If this information is from someone else, e. g. from a thread in the forum or on discord, please add a link to the conversation here |
| link | yes | A link to the *vendors* product page. Do not put Amazon or AliExpress links here
## How to view this data
Currently, we only collect the raw data about device support here. In the future, we can write a generator program that builds a markdown/html/... files to add them somewhere.
[link-zha]: https://www.home-assistant.io/components/zha/
[link-ha]: https://www.home-assistant.io/