Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for IKEA E2201 RODRET Dimmer. #693

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
768 changes: 768 additions & 0 deletions blueprints/controllers/ikea_e2201/ikea_e2201.yaml

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion blueprints/hooks/cover/cover.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ blueprint:

## More Info

ℹ️ Version 2025.02.16
ℹ️ Version 2025.02.20
📝 [Changelog](https://epmatt.github.io/awesome-ha-blueprints/docs/blueprints/hooks/cover/#changelog)
📕 Full documentation regarding this blueprint is available [here](https://epmatt.github.io/awesome-ha-blueprints/docs/blueprints/hooks/cover).

Expand All @@ -40,6 +40,7 @@ blueprint:
- IKEA E1743 TRÅDFRI On/Off Switch & Dimmer
- IKEA E1766 TRÅDFRI Open/Close Remote
- IKEA E1812 TRÅDFRI Shortcut button
- IKEA E2201 RODRET Dimmer
- SONOFF SNZB-01 Wireless Switch
- Xiaomi WXCJKG11LM Aqara Opple 2 button remote
- Xiaomi WXCJKG12LM Aqara Opple 4 button remote
Expand Down Expand Up @@ -84,6 +85,12 @@ variables:
open_cover: button_short
stop_cover_all: button_long
close_cover: button_double
IKEA E2201 RODRET Dimmer:
open_cover: button_up_short
open_cover_tilt: button_up_long
close_cover: button_down_short
close_cover_tilt: button_down_long
stop_cover_all: button_down_double
SONOFF SNZB-01 Wireless Switch:
open_cover: button_short
stop_cover_all: button_long
Expand Down
18 changes: 17 additions & 1 deletion blueprints/hooks/light/light.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ blueprint:

## More Info

ℹ️ Version 2025.02.16
ℹ️ Version 2025.02.20
📝 [Changelog](https://epmatt.github.io/awesome-ha-blueprints/docs/blueprints/hooks/light/#changelog)
📕 Full documentation regarding this blueprint is available [here](https://epmatt.github.io/awesome-ha-blueprints/docs/blueprints/hooks/light).

Expand Down Expand Up @@ -45,6 +45,8 @@ blueprint:
- IKEA E1812 TRÅDFRI Shortcut button
- IKEA E2001/E2002 STYRBAR Remote control
- IKEA E2001/E2002 STYRBAR Remote control (#2)
- IKEA E2201 RODRET Dimmer
- IKEA E2201 RODRET Dimmer (#2)
- IKEA ICTC-G-1 TRÅDFRI wireless dimmer
- OSRAM AC025XX00NJ SMART+ Switch Mini
- Philips 324131092621 Hue Dimmer switch
Expand Down Expand Up @@ -231,6 +233,20 @@ variables:
color_down_repeat: button_left_long
color_up: button_right_short
color_up_repeat: button_right_long
IKEA E2201 RODRET Dimmer:
turn_on: button_up_short
brightness_up_repeat: button_up_long
color_up: button_up_double
turn_off: button_down_short
brightness_down_repeat: button_down_long
color_down: button_down_double
IKEA E2201 RODRET Dimmer (#2):
brightness_up: button_up_short
brightness_up_repeat: button_up_long
turn_on: button_up_double
brightness_down: button_down_short
brightness_down_repeat: button_down_long
turn_off: button_down_double
IKEA ICTC-G-1 TRÅDFRI wireless dimmer:
brightness_down_repeat: rotate_left
brightness_up_repeat: rotate_right
Expand Down
9 changes: 8 additions & 1 deletion blueprints/hooks/media_player/media_player.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ blueprint:

## More Info

ℹ️ Version 2025.02.16
ℹ️ Version 2025.02.20
📝 [Changelog](https://epmatt.github.io/awesome-ha-blueprints/docs/blueprints/hooks/media_player/#changelog)
📕 Full documentation regarding this blueprint is available [here](https://epmatt.github.io/awesome-ha-blueprints/docs/blueprints/hooks/media_player).

Expand Down Expand Up @@ -42,6 +42,7 @@ blueprint:
- IKEA E1766 TRÅDFRI Open/Close Remote
- IKEA E1812 TRÅDFRI Shortcut button
- IKEA E2001/E2002 STYRBAR Remote control
- IKEA E2201 RODRET Dimmer
- IKEA ICTC-G-1 TRÅDFRI wireless dimmer
- OSRAM AC025XX00NJ SMART+ Switch Mini
- Philips 324131092621 Hue Dimmer switch
Expand Down Expand Up @@ -130,6 +131,12 @@ variables:
volume_down_repeat: button_down_long
prev_track: button_left_short
next_track: button_right_short
IKEA E2201 RODRET Dimmer:
volume_up: button_up_short
volume_up_repeat: button_up_long
next_track: button_up_double
volume_down: button_down_long
play_pause: button_down_double
IKEA ICTC-G-1 TRÅDFRI wireless dimmer:
volume_down_repeat: rotate_left
volume_up_repeat: rotate_right
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
"format": "prettier --write ."
},
"devDependencies": {
"prettier": "^3.5.0"
"prettier": "^3.5.1"
}
}
1 change: 1 addition & 0 deletions website/docs/blueprints/controllers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ _Can't find the controller you're looking for in this list? [Submit a new bluepr
| IKEA | [E1766](/docs/blueprints/controllers/ikea_e1766) | IKEA E1766 TRÅDFRI Open/Close Remote | deCONZ,ZHA,Zigbee2MQTT | <Image>![ikea_e1766](/img/controllers/ikea_e1766.png)</Image> |
| IKEA | [E1812](/docs/blueprints/controllers/ikea_e1812) | IKEA E1812 TRÅDFRI Shortcut button | deCONZ,ZHA,Zigbee2MQTT | <Image>![ikea_e1812](/img/controllers/ikea_e1812.png)</Image> |
| IKEA | [E2001/E2002](/docs/blueprints/controllers/ikea_e2001_e2002) | IKEA E2001/E2002 STYRBAR Remote control | deCONZ,ZHA,Zigbee2MQTT | <Image>![ikea_e2001_e2002](/img/controllers/ikea_e2001_e2002.png)</Image> |
| IKEA | [E2201](/docs/blueprints/controllers/ikea_e2201) | IKEA E2201 RODRET Dimmer | deCONZ,ZHA,Zigbee2MQTT | <Image>![ikea_e2201](/img/controllers/ikea_e2201.png)</Image> |
| IKEA | [ICTC-G-1](/docs/blueprints/controllers/ikea_ictc_g_1) | IKEA ICTC-G-1 TRÅDFRI wireless dimmer | deCONZ,ZHA,Zigbee2MQTT | <Image>![ikea_ictc_g_1](/img/controllers/ikea_ictc_g_1.png)</Image> |
| OSRAM | [AC025XX00NJ](/docs/blueprints/controllers/osram_ac025xx00nj) | OSRAM AC025XX00NJ SMART+ Switch Mini | deCONZ,ZHA,Zigbee2MQTT | <Image>![osram_ac025xx00nj](/img/controllers/osram_ac025xx00nj.png)</Image> |
| Philips | [324131092621](/docs/blueprints/controllers/philips_324131092621) | Philips 324131092621 Hue Dimmer switch | deCONZ,ZHA,Zigbee2MQTT | <Image>![philips_324131092621](/img/controllers/philips_324131092621.png)</Image> |
Expand Down
185 changes: 185 additions & 0 deletions website/docs/blueprints/controllers/ikea_e2201.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
---
title: Controller - IKEA E2201 RODRET Dimmer
description: Controller automation for executing any kind of action triggered by the provided IKEA E2201 RODRET Dimmer. Supports Zigbee2MQTT, ZHA, deCONZ.
---

import { Input, Requirement, ImportCard } from '/src/components/blueprints_docs'

<ImportCard id='ikea_e2201' category='controllers' />

<br />

:::tip
This blueprint is part of the **Controllers-Hooks Ecosystem**. You can read more about this topic [here](/docs/controllers-hooks-ecosystem).
:::

## Description

This blueprint provides universal support for running any custom action when a button is pressed on the provided IKEA E2201 RODRET Dimmer. Supports controllers integrated with Zigbee2MQTT, ZHA, deCONZ. The blueprint will automagically detect the integration type and 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](/docs/blueprints/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](/docs/blueprints/controllers/ikea_e2201#available-hooks) for additional details.
A small note, avoid using both custom actions and Hooks in the same blueprint, otherwise strange things may occur.
:::

## Requirements

<Requirement id='zigbee2mqtt' />
<Requirement id='zha' />
<Requirement id='deconz' />

## Inputs

<Input
name='Controller Device'
description='The controller device to use for the automation. Choose a value only if the remote is integrated with Zigbee2MQTT, ZHA, deCONZ.'
selector='device'
required='Zigbee2MQTT, ZHA, deCONZ'
/>
<Input
name='Up button short press'
description='Action to run on short up button press.'
selector='action'
/>
<Input
name='Up button long press'
description='Action to run on long up button press.'
selector='action'
/>
<Input
name='Up button release'
description='Action to run on up button release after long press.'
selector='action'
/>
<Input
name='Up button double press'
description='Action to run on double up button press.'
selector='action'
virtual
/>
<Input
name='Down button short press'
description='Action to run on short down button press.'
selector='action'
/>
<Input
name='Down button long press'
description='Action to run on long down button press.'
selector='action'
/>
<Input
name='Down button release'
description='Action to run on down button release after long press.'
selector='action'
/>
<Input
name='Down button double press'
description='Action to run on double down button press.'
selector='action'
virtual
/>
<Input
name='Up button long press - Maximum loop repeats'
description='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.'
selector='number'
/>
<Input
name='Down button long press - Maximum loop repeats'
description='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.'
selector='number'
/>
<Input
name='Helper Up/Down button - Long Press Delay'
description='Max delay between the pushing and releasing of a button long press event. Increase this value if you notice that the long press action is not triggered properly.'
selector='number'
/>
<Input
name='Expose up button double press event'
description='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.'
selector='boolean'
/>
<Input
name='Expose down button double press event'
description='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.'
selector='boolean'
/>
<Input
name='Helper - Double Press delay'
description='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.'
selector='number'
/>

## Available Hooks

:::note 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

- Up button short press -> Turn on
- Up button long press -> Brightness up (continuous, until release)
- Up button double press `Virtual` -> Color up
- Down button short press -> Turn off
- Down button long press -> Brightness down (continuous, until release)
- Down button double press `Virtual` -> Color down

#### Mapping #2

- Up button short press -> Brightness up
- Up button long press -> Brightness up (continuous, until release)
- Up button double press `Virtual` -> Turn on
- Down button short press -> Brightness down
- Down button long press -> Brightness down (continuous, until release)
- Down button double press `Virtual` -> Turn off

[Light Hook docs](/docs/blueprints/hooks/light)

### 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 -> Volume up
- Up button long press -> Volume up (continuous, until release)
- Up button double press `Virtual` -> Next track
- Down button short press -> Volume down
- Down button long press -> Volume down
- Down button double press `Virtual` -> Play/Pause

[Media Player Hook docs](/docs/blueprints/hooks/media_player)

### Cover

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

#### Default Mapping

- Up button short press -> Open cover
- Up button long press -> Open the cover tilt
- Down button short press -> Close cover
- Down button long press -> Close the cover tilt
- Down button double press `Virtual` -> Stop cover and cover tilt

[Cover Hook docs](/docs/blueprints/hooks/cover)

## Additional Notes

### Virtual double press events

It's 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](/docs/controllers-hooks-ecosystem#virtual-events).

## Changelog

- **2025-02-20**: Initial release. ([@yarafie](https://github.com/yarafie)) :tada:
3 changes: 3 additions & 0 deletions website/docs/blueprints/hooks/cover.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ This integration provides the entity which represents a cover in Home Assistant.
- [IKEA E1743 TRÅDFRI On/Off Switch & Dimmer](/docs/blueprints/controllers/ikea_e1743)
- [IKEA E1766 TRÅDFRI Open/Close Remote](/docs/blueprints/controllers/ikea_e1766)
- [IKEA E1812 TRÅDFRI Shortcut button](/docs/blueprints/controllers/ikea_e1812)
- [IKEA E2201 RODRET Dimmer](/docs/blueprints/controllers/ikea_e2201)
- [SONOFF SNZB-01 Wireless Switch](/docs/blueprints/controllers/sonoff_snzb01)
- [Xiaomi WXCJKG11LM Aqara Opple 2 button remote](/docs/blueprints/controllers/xiaomi_wxcjkg11lm)
- [Xiaomi WXCJKG12LM Aqara Opple 4 button remote](/docs/blueprints/controllers/xiaomi_wxcjkg12lm)
Expand Down Expand Up @@ -103,3 +104,5 @@ If you want to link multiple covers to the same controller you can either use [C

If you had configured the `controller_model` input to `Xiaomi WXKG11LM Aqara Wireless Switch Mini`, please change it to `Aqara WXKG11LM Wireless Mini Switch`.
The change has been implemented to match the controller with the correct manufacturer name (Aqara).

- **2025-02-20**: Added support for IKEA E2201 RODRET Dimmer. ([@yarafie](https://github.com/yarafie))
5 changes: 5 additions & 0 deletions website/docs/blueprints/hooks/light.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ This integration provides the entity which represents a light in Home Assistant.
- [IKEA E1766 TRÅDFRI Open/Close Remote](/docs/blueprints/controllers/ikea_e1766)
- [IKEA E1812 TRÅDFRI Shortcut button](/docs/blueprints/controllers/ikea_e1812)
- [IKEA E2001/E2002 STYRBAR Remote control](/docs/blueprints/controllers/ikea_e2001_e2002)
- [IKEA E2201 RODRET Dimmer](/docs/blueprints/controllers/ikea_e2201)
- [IKEA ICTC-G-1 TRÅDFRI wireless dimmer](/docs/blueprints/controllers/ikea_ictc_g_1)
- [OSRAM AC025XX00NJ SMART+ Switch Mini](/docs/blueprints/controllers/osram_ac025xx00nj)
- [Philips 324131092621 Hue Dimmer switch](/docs/blueprints/controllers/philips_324131092621)
Expand Down Expand Up @@ -183,3 +184,7 @@ If you want to link multiple lights to the same controller you can either use [L

If you had configured the `controller_model` input to `Xiaomi WXKG11LM Aqara Wireless Switch Mini`, please change it to `Aqara WXKG11LM Wireless Mini Switch`.
The change has been implemented to match the controller with the correct manufacturer name (Aqara).

- **2025-02-20**: Use default int when value is none ([PR#22](https://github.com/EPMatt/awesome-ha-blueprints/pull/22)). ([@mwinkler](https://github.com/mwinkler))

- **2025-02-20**: Added support for IKEA E2201 RODRET Dimmer. ([@yarafie](https://github.com/yarafie))
3 changes: 3 additions & 0 deletions website/docs/blueprints/hooks/media_player.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ This integration provides the entity which represents a media player in Home Ass
- [IKEA E1766 TRÅDFRI Open/Close Remote](/docs/blueprints/controllers/ikea_e1766)
- [IKEA E1812 TRÅDFRI Shortcut button](/docs/blueprints/controllers/ikea_e1812)
- [IKEA E2001/E2002 STYRBAR Remote control](/docs/blueprints/controllers/ikea_e2001_e2002)
- [IKEA E2201 RODRET Dimmer](/docs/blueprints/controllers/ikea_e2201)
- [IKEA ICTC-G-1 TRÅDFRI wireless dimmer](/docs/blueprints/controllers/ikea_ictc_g_1)
- [OSRAM AC025XX00NJ SMART+ Switch Mini](/docs/blueprints/controllers/osram_ac025xx00nj)
- [Philips 324131092621 Hue Dimmer switch](/docs/blueprints/controllers/philips_324131092621)
Expand Down Expand Up @@ -130,3 +131,5 @@ Not all media players support the customization of the number of steps for volum

If you had configured the `controller_model` input to `Xiaomi WXKG11LM Aqara Wireless Switch Mini`, please change it to `Aqara WXKG11LM Wireless Mini Switch`.
The change has been implemented to match the controller with the correct manufacturer name (Aqara).

- **2025-02-20**: Added support for IKEA E2201 RODRET Dimmer. ([@yarafie](https://github.com/yarafie))
8 changes: 4 additions & 4 deletions website/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@
"eslint-plugin-jsx-a11y": "^6.10.2",
"eslint-plugin-react": "^7.37.4",
"eslint-plugin-react-hooks": "^4.6.0 || ^5.1.0",
"prettier": "^3.5.0"
"prettier": "^3.5.1"
}
}
Binary file added website/static/img/controllers/ikea_e2201.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading