Skip to main content

Controller - IKEA E1812 TRÅDFRI Shortcut button

Import this blueprint

My Home Assistant

Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.
(Home Assistant 2021.3.0 or higher)

Direct Link

tip

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 E1812 TRÅDFRI Shortcut button. 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.

tip

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

Optional

If 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 Docs

ZHA Integration

Optional

If 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 Docs

Zigbee2MQTT Integration

Optional

If 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 Docs

Input Text Integration

Required

This 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.

Input Text Integration Docs

Inputs​

Integration Select Required

Integration used for connecting the remote with Home Assistant. Select one of the available values.

Controller Device Device deCONZ, ZHA Required

The controller device to use for the automation. Choose a value only if the remote is integrated with deCONZ, ZHA.

Controller Entity Entity Zigbee2MQTT Required

The action sensor of the controller to use for the automation. Choose a value only if the remote is integrated with Zigbee2MQTT.

Helper - Last Controller Event Entity Required

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.

Button short press Action Optional

Action to run on short button press.

Button long press Action Optional

Action to run on long button press.

Button release Action Optional

Action to run on button release after long press.

Button double press Action Optional

Action to run on double button press.

Button long press - loop until release Boolean Optional

Loop the button action until the button is released.

Button long press - Maximum loop repeats Number Optional

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.

Expose button double press event Boolean Optional

Choose whether or not to expose the virtual double press event for the button. Turn this on if you are providing an action for the button double press event.

Helper - Double Press delay Number Optional

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.

Helper - Debounce delay Number Optional

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​

Virtual double press actions

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​

  • Button short press -> Toggle
  • Button double press -> Color up

Light Hook docs

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​

  • Button short press -> Play/Pause
  • Button long press -> Stop
  • Button double press -> Next track

Media Player Hook docs

Cover​

This Hook blueprint allows to build a controller-based automation to control a cover. Supports opening, closing and tilting the cover.

Default Mapping​

  • Button short press -> Open cover
  • Button long press -> Stop cover and cover tilt
  • Button double press -> Close cover

Cover Hook docs

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.

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.

Changelog​

  • 2021-03-14: first blueprint version 🎉

  • 2021-03-25: ⚠️ Breaking Change: standardize input names across all the Controller blueprints. If you plan to update this blueprint, please update the inputs in your automations as follows:

    • remote -> controller_device
    • zigbee2mqtt_remote -> controller_entity
    • helper_last_loop_event_input -> helper_last_controller_event

  • 2021-03-26: add support for the Cover Hook

  • 2021-04-19: Fix double press events not being detected with deCONZ

  • 2021-04-23: Fix deCONZ events not being recognized

  • 2021-05-15:

    ⚠️ Breaking Change:

    helper_last_controller_event is now a mandatory input. It also simplifies the blueprint setup (reducing issues due to improper configuration missing the helper, which was required only in certain conditions as was stated in the docs), and provides support for advanced features which might be developed in the future.

    If you plan to update this blueprint, please make sure to provide a valid input_text entity for the helper_last_controller_event input. You should create a separate input_text for each Controller blueprint you're configuring, since using the same for multiple automation could lead to inconsistencies and undefined behaviour.

    Other changes:

    • 🎉 Add Debouncing support. Debouncing avoids duplicate action runs which might occur with certain controllers and integrations. The feature is disabled by default, check the documentation to find out how to enable it
    • Prevent undesired endless loops, which might occur in rare cases when the corresponding stop event is not received, by running loop actions a finite number of times, customizable with a new blueprint input
    • Fix inputs wrongly marked as required

  • 2021-05-26: Fix for Zigbee2MQTT reporting null state changes

  • 2021-08-02: Improve inputs documentation and organization

  • 2021-10-26: Standardize blueprints structure and inputs naming across the whole collection. Improve blueprint documentation. No functionality change.

  • 2022-08-08: Optimize characters usage for the helper_last_controller_event text input.