Blueprint updates will be published on Awesome HA Blueprints .
Docs are also fully reported in this post.
Click the badge to import this Blueprint: (needs Home Assistant Core 2021.3 or higher)
Blueprint URL. Copy this if you want to use this blueprint in your installation: https://github.com/EPMatt/awesome-ha-blueprints/blob/main/blueprints/controllers/ikea_e1524_e1810/ikea_e1524_e1810.yaml
this blueprint combines the features of many other blueprints found on this forum. Citing a few sources:
- ZHA - IKEA five button remote for lights blueprint by @frenck
- deCONZ - IKEA five button remote for lights blueprint by @Bram_Kragten
- Zigbee2Mqtt - IKEA five button remote blueprint by @starbuck93
- The ControllerX AppDaemon app by @xaviml which provided suggestions on handling ZHA events
Huge thanks to the original authors!
This blueprint provides universal support for running any custom action when a button is pressed on the provided IKEA E1524/E1810 remote controller. Supports remotes integrated with either Zigbee2MQTT, deCONZ or ZHA. Just specify the integration used to connect the remote to Home Assistant when setting up the automation, and the blueprint will take care of all the rest.
In addition of being able to provide custom actions for every kind of button press supported by the remote, the blueprint allows to loop the long press actions while the corresponding button is being held. Once released, the loop stops. This is useful when holding down a button should result in a continuous action (such as lowering the volume of a media player, or controlling a light brightness).
The blueprint also adds support for virtual double button press events, which are not exposed by the controller itself.
Moreover, automations created with this blueprint can be connected with one or more Hooks supported by this controller.
Hooks allow to easily create controller-based automations for interacting with media players, lights, covers and more. See the list of Hooks available for this controller for additional details.
If you plan to integrate the 5-button remote with Zigbee2MQTT, you must have this integration set up. Installation methods differ between different installation types. Check the documentation for this integration for full details on the required hardware and how to set up Zigbee2MQTT on your system.
(Optional) ZHA Integration
If you plan to integrate the 5-button remote with ZHA, you must have this integration set up. The integration can be setup from the Home Assistant UI. Check the documentation for this integration for full details on the required hardware.
(Optional) deCONZ Integration
If you plan to integrate the 5-button remote with deCONZ, you must have this integration set up. The integration can be setup from the Home Assistant UI and requires an additional container to run deCONZ on. Head over to the documentation for this integration for full details on the required hardware and how to set up deCONZ on your system.
(Optional) Input Text Integration
This integration provides the entity to store the last button event, which is needed when using ZHA to integrate the remote and determining which button has been released. This should be activated by default so unless you tweaked the default configuration you’re good to go.
See the full list of inputs for this blueprint in the docs.
- Up button short press -> Brightness up
- Up button long press & hold -> Brightness up (continuous, until release)
- Down button short press -> Brightness down
- Down button long pres & hold -> Brightness down (continuous, until release)
- Left button short press -> Color down
- Left button long press & hold -> Color down (continuous, until release)
- Right button short press -> Color up
- Right button long press & hold -> Color up (continuous, until release)
- Center button short press -> Toggle
- Up button short press -> Volume up
- Up button long press & hold -> Volume up (continuous, until release)
- Down button short press -> Volume down
- Down button long pres & hold -> Volume down (continuous, until release)
- Left button short press -> Previous Track
- Right button short press -> Next Track
- Center button short press -> Play/Pause
- Center button hold -> Stop
The reason why a text input is required to store the last long press event when using a remote with ZHA is because of the actions mapping for the controller in ZHA. Natively, the controller doesn’t allow to distinguish between different button release events, so the blueprint must store the previous clicked button, using the text input. Make sure the input text is not altered by any other agents, since this could break the automation.
It’s also important to notice that the controller doesn’t natively support double press events. This blueprint provides virtual double press events by relying on the text input, used to store the last short press event, and a delay, which represents the maximum time gap between the first and second short press required to trigger the virtual double press.
When a double press action is defined for a specific button, clicking the button results in the automation first waiting for the second button press, then, if none is received within the provided delay, executing the short press action.
If a double press action is not set for a specific button, the corresponding single press action will be executed immediately when the button is pressed.
- 2021-02-07: fix an issue which prevented to create automations for ZHA or deCONZ.
- 2021-02-08: update example, fix an issue which executed actions twice when the remote was connected via Zigbee2MQTT.
- 2021-02-18: added example for fully controlling a RGB light (thanks @kks36!)
- add support for virtual double press events
- block automation runs for empty and repeated messages
- 2021-03-03: moved the blueprint in the Controllers-Hooks Ecosystem. See announcement here.
This was a rather complex blueprint to build, so if something is not working as it should please let me know. Any feedback is highly appreciated!
Happy automating to everyone!
My other blueprints: