Controller - IKEA E2001/E2002 STYRBAR Remote control
Import this blueprint
My Home Assistant
(Home Assistant 2021.3.0 or higher)
Direct Link
This blueprint is part of the Controllers-Hooks Ecosystem. You can read more about this topic here.
Description​
This blueprint provides universal support for running any custom action when a button is pressed on the provided IKEA E2001/E2002 STYRBAR Remote control. Supports controllers integrated with deCONZ, ZHA, Zigbee2MQTT. 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.
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.
Requirements​
deCONZ Integration
OptionalIf you plan to integrate the with deCONZ, you must have this integration set up. The deCONZ integration can be configured from the Home Assistant UI and requires an additional container to run deCONZ on. Head over to the documentation for full details on the required hardware and how to set up deCONZ on your system.
deCONZ Integration DocsZHA Integration
OptionalIf you plan to integrate the with ZHA, you must have this integration set up. The ZHA integration can be configured from the Home Assistant UI. Check the documentation for full details on the required hardware and how to set up ZHA on your system.
ZHA Integration DocsZigbee2MQTT Integration
OptionalIf you plan to integrate the with Zigbee2MQTT, you must have this integration set up. Installation methods differ between different installation types. Check out the documentation for full details on the required hardware and how to set up Zigbee2MQTT on your system.
Zigbee2MQTT DocsInput Text Integration
RequiredThis integration provides the entity which must be provided to the blueprint in the Helper - Last Controller Event input. Learn more about this helper by reading the dedicated section in the Additional Notes.
Inputs​
Integration used for connecting the remote with Home Assistant. Select one of the available values.
The controller device to use for the automation. Choose a value only if the remote is integrated with deCONZ, ZHA.
The action sensor of the controller to use for the automation. Choose a value only if the remote is integrated with Zigbee2MQTT.
Input Text used to store the last event fired by the controller. You will need to manually create a text input entity for this, please read the blueprint Additional Notes for more info.
Action to run on short left button press.
Action to run on long left button press.
Action to run on left button release after long press.
Action to run on double left button press.
Action to run on short right button press.
Action to run on long right button press.
Action to run on right button release after long press.
Action to run on double right button press.
Action to run on short up button press.
Action to run on long up button press.
Action to run on up button release after long press.
Action to run on double up button press.
Action to run on short down button press.
Action to run on long down button press.
Action to run on down button release after long press.
Action to run on double down button press.
Loop the left button action until the button is released.
Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.
Loop the right button action until the button is released.
Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.
Loop the up button action until the button is released.
Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.
Loop the down button action until the button is released.
Maximum number of repeats for the custom action, when looping is enabled. Use it as a safety limit to prevent an endless loop in case the corresponding stop event is not received.
Choose whether or not to expose the virtual double press event for the left button. Turn this on if you are providing an action for the left button double press event.
Choose whether or not to expose the virtual double press event for the right button. Turn this on if you are providing an action for the right button double press event.
Choose whether or not to expose the virtual double press event for the up button. Turn this on if you are providing an action for the up button double press event.
Choose whether or not to expose the virtual double press event for the down button. Turn this on if you are providing an action for the down button double press event.
Max delay between the first and the second button press for the double press event. Provide a value only if you are using a double press action. Increase this value if you notice that the double press action is not triggered properly.
Delay used for debouncing RAW controller events, by default set to 0. A value of 0 disables the debouncing feature. Increase this value if you notice custom actions or linked Hooks running multiple times when interacting with the device. When the controller needs to be debounced, usually a value of 100 is enough to remove all duplicate events.
Available Hooks​
Some of the following mappings might include actions for virtual double press events, which are disabled by default. If you are using a hook mapping which provides an action for a virtual double press event, please make sure to enable support for virtual double press on the corresponding buttons with the corresponding blueprint input.
Light​
This Hook blueprint allows to build a controller-based automation to control a light. Supports brightness and color control both for white temperature and rgb lights.
Default Mapping​
- Up button short press -> Turn on
- Up button long press -> Brightness up (continuous, until release)
- Down button short press -> Turn off
- Down button long press -> Brightness down (continuous, until release)
- Left button short press -> Color down
- Left button long press -> Color down (continuous, until release)
- Right button short press -> Color up
- Right button long press -> Color up (continuous, until release)
Mapping #2​
- Up button short press -> Brightness up
- Up button long press -> Brightness up (continuous, until release)
- Up button double press -> Turn on
- Down button short press -> Brightness down
- Down button long press -> Brightness down (continuous, until release)
- Down button double press -> Turn off
- Left button short press -> Color down
- Left button long press -> Color down (continuous, until release)
- Right button short press -> Color up
- Right button long press -> Color up (continuous, until release)
Media Player​
This Hook blueprint allows to build a controller-based automation to control a media player. Supports volume setting, play/pause and track selection.
Default Mapping​
- Up button short press -> Play/Pause
- Up button long press -> Volume up (continuous, until release)
- Down button short press -> Stop
- Down button long press -> Volume down (continuous, until release)
- Left button short press -> Previous track
- Right button short press -> Next track
Additional Notes​
Helper - Last Controller Event​
The helper_last_controller_event (Helper - Last Controller Event) input serves as a permanent storage area for the automation. The stored info is used to implement the blueprint's core functionality. To learn more about the helper, how it's used and why it's required, you can read the dedicated section in the Controllers-Hooks Ecosystem documentation.
The helper is used to determine button release events when the controller is integrated with ZHA, Zigbee2MQTT, because of the actions mapping for the controller with these integrations. Natively, the controller doesn't allow to distinguish between different button release events, so the blueprint must store the previous clicked button.
Virtual double press events​
It's also important to note that the controller doesn't natively support double press events. Instead , this blueprint provides virtual double press events. You can read more about them in the general Controllers-Hooks Ecosystem documentation.
Issues with Zigbee2MQTT and the device firing duplicate events​
It has been reported that IKEA E2001/E2002 controllers integrated with Zigbee2MQTT might fire duplicate events from time to time, during interaction. This issue is not relative to the blueprint itself.
If you notice your controller is not behaving as expected please reset the device and repeat the pairing process with Zigbee2MQTT, then try again.
Changelog​
- 2021-11-07: first blueprint version 🎉
- 2022-08-08: Optimize characters usage for the
helper_last_controller_eventtext input.