A curated collection of Home Assistant ZHA blueprints, organized by manufacturer and device model.
This project's goal is to feature a vast collection of blueprints for as many devices by as many manufacturers as possible, making finding fitting and flexible blueprints easier. The goal is also to feature different types of blueprints for the same device, for different user's skill level. Hopefully this can be an alternative way of finding blueprints that fit the device the user want to use.
This project is made for two types of users.
- Beginners who want plug-and-play solutions for their devices
- Advanced users who want to contribute with their own blueprints, do custom blueprints for others or find more complex ones.
For the library to have a functional structure it is split up by the model shown below:
manufacturer/
├── IKEA/
│ └── SOMRIG shortcut button/
│ └── SOMRIG shortcut button (unlocked).yaml
├── PhilipsHUE/
│ ├── RDM002/
│ │ └── Philips Tap Dial Switch (lights only).yaml
│ └── RWL022/
│ ├── Philips Dim Switch v2 (native).yaml
│ └── Philips Dim Switch v2 (unlocked).yaml
...This is to make finding something suitable for your device easier. Just follow your device's manufacturer and model to find blueprints that suit your device.
If you don't know the manufacturer or model name of your device, you can find it by going into your Home Assistant and go to Settings > Devices & services > Zigbee Home Automation integration and click the device you want a blueprint for. The manufacturer and model is displayed under "Device info".
Note: Some devices might not have the name you'd expect.
- IKEA shows as expected, "IKEA of Sweden"
- Philips HUE shows as unexpected, "Signify Netherlands B.V.".
If unsure, check the physical device as it might give a hint to the manufacturer/model name.
All blueprints in a model folder start with the device name, followed by a short description in parentheses. Like in the Philips Tap Dial Switch (lights only).yaml), where the only allowed entities are lights.
Other blueprints, feature the descriptors unlocked or native. These are special blueprints that hopefully will provide flexibility and/or an easy way of using certain devices.
-
Unlocked blueprints are made with maximum freedom. These blueprints essentially just give each button (often both tap and hold) a building block so that the user can do whatever with a certain action. Some people might not want switches for lights only, so these blueprints offer a greater flexibility for more skilled users.
-
Native blueprints are a little stricter. These types of blueprints aim to make blueprints that are as close to the manufacturers intended use-cases. For example, the Philips HUE RWL002 (or Philips Dim Switch v2) use case in its native app, is made for only a certain light or all lights in a certain room, where the dim buttons only dim the light(s). The fourth HUE buttons change the scene of the light(s). A native blueprint then aims to do the same but outside of its native app. An unlocked blueprint for this device would simply open all buttons to whatever service the user associates with it.
The goal is to provide both user-friendly and advanced-user options.
- Find a blueprint you're interested in.
- Copy the raw YAML URL.
- In Home Assistant, go to Settings > Automations & Scenes > Blueprints > Import Blueprint.
- Paste the URL and click Preview.
- Enter the fields in the blueprint and customize to your desire.
Made with ❤️ by Tim Svensson and the Contributers.
Speical thanks to Jeremy Fisher (apollo1220) for his Philips Hue Tap Dial Switch ZHA Blueprint that inspired this entire project.
Contributions welcome! See CONTRIBUTING.md for more info.