-
-
Notifications
You must be signed in to change notification settings - Fork 271
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added support for IKEA E2201 RODRET Dimmer.
- Loading branch information
Showing
14 changed files
with
1,008 additions
and
13 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,6 @@ | |
"format": "prettier --write ." | ||
}, | ||
"devDependencies": { | ||
"prettier": "^3.5.0" | ||
"prettier": "^3.5.1" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.