# ControllerX ControllerX is an AppDaemon app for Home Assistant that turns button controllers (IKEA, Philips Hue, Aqara, Tuya, etc.) into fully working light, media player, switch and cover controllers. Each app is configured in AppDaemon's `apps.yaml` with `module: controllerx`, a device-specific `class` (e.g. `E1810Controller`), the `integration` that receives the button events (z2m, deconz, zha, ...), the `controller` ID and the entity to control (e.g. `light`). Holding a button repeats a Home Assistant service call until it is released. Default button mappings can be replaced with a custom `mapping`. A machine-readable list of the supported devices, with their controller classes and default mappings, is available at https://xaviml.github.io/controllerx/controllers/devices.json # Getting started # ControllerX *Create controller-based automations with ease to control your home devices and scenes from [Home Assistant]() (HA).* *ControllerX* brings the following functionalities to [many controllers](): - Turn on/off any home device (light, switch, media player, etc.) - Manual increase/decrease of brightness and color temperature - Smooth increase/decrease (holding a button) of brightness, color temperature, volume, etc. - Color loop if the light supports xy color - Play/pause music - Open/close covers [Get started]() [Find your controller]() [Build your configuration]() ## Why *ControllerX*? Solutions like Zigbee2MQTT, deCONZ and ZHA have their pros and cons, but one of their benefits is that they remove the dependency on a proprietary hub (e.g. IKEA, Xiaomi, Philips). However, the proprietary hubs not only connect a controller with lights or media players, they also give them behaviour: dimming while a button is held, cycling colors, changing the volume, etc. Without the hub, we end up writing Home Assistant automations, and automations like these quickly get tricky and difficult to maintain. This is where *ControllerX* comes in, together with AppDaemon. It brings back the behaviour that the devices lose without the original hub, and makes it easy to create automations focused on button events. ## How it works ``` flowchart LR A["Controller
(button pressed)"] --> B["Integration
(Zigbee2MQTT, ZHA, deCONZ...)"] B -- "action event
e.g. brightness_up_hold" --> C["ControllerX
(AppDaemon app)"] C -- "mapping
e.g. hold_brightness_up" --> D["Home Assistant
service calls"] D --> E["Light, media player,
switch or cover"] ``` 1. When a button is pressed, the [integration]() fires an action event (e.g. `brightness_up_hold`). 2. ControllerX translates that event into a [predefined action]() (e.g. `hold_brightness_up`) using the default mapping of the device, or your own [custom mapping](). 3. ControllerX calls the Home Assistant services to change the entity. When a button is held, it keeps calling them periodically until the release event arrives, so the brightness, color or volume changes smoothly. ## Quick example With just this configuration placed in your [`apps.yaml`](), you can have the E2002 controller from IKEA (4 buttons) connected to the living room light, and be able to change the brightness and the color temperature or color. ``` livingroom_controller: module: controllerx class: E2002LightController controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.livingroom ``` > [!TIP] > > **Using an AI assistant?** > > This documentation is available in a format that AI assistants can read: [llms.txt]() (index) and [llms-full.txt]() (all the pages in one file). The list of supported devices is available as [JSON](). ## Video examples - [E1810 (IKEA) controlling a light through MQTT]() - [Symfonisk controlling Chromecast volume]() - [Magic Xiaomi Cube controlling a colour light]() - [E1810 (IKEA) controlling a colour light with ZHA]() - [Symfonisk controlling Google Home mini]() - [Symfonisk controlling a light]() - [Showing the colour wheel from HA]() - [E1743 (IKEA) button as a cover controller]() - [E1810 (IKEA) as a TV remote]() - [Double click for the middle button for E1810 (IKEA)]() ## Community Thank you to all these people for sharing content related to ControllerX: - [/u/canaletto]() - [canaletto.fr]() (French) - [/u/jones]() - [jbetzen.net]() (German) - [/u/fribse]() - [YouTube]() (Danish) Questions can be asked in the following channels: - [GitHub issue]() - [Home Assistant Community Forum topic]() # Installation ControllerX is an [AppDaemon]() app, so it needs AppDaemon to run. There are two ways to install it in Home Assistant: - [ControllerX app](<#controllerx-app-recommended>) (recommended): an app with its own AppDaemon instance and ControllerX preinstalled. ControllerX updates like any other app. - [Manual installation](<#manual-installation>): ControllerX copied into the AppDaemon app. Use this if you already run other AppDaemon apps. If you installed ControllerX through HACS, see [Migrating from HACS](<#migrating-from-hacs>). ## ControllerX app (recommended) The ControllerX app runs its own AppDaemon instance with ControllerX preinstalled. Each app update brings the new ControllerX version. > [!NOTE] > > **Info** > > The app's AppDaemon instance is meant only for ControllerX. If you already use the AppDaemon app for other apps, [install ControllerX manually](<#manual-installation>) in it instead, so you keep a single AppDaemon instance. 1. Add the ControllerX app repository to Home Assistant: [![Add repository to Home Assistant]()]() Or go to **Settings → Apps → App store**, select **Repositories** in the top-right menu, and add `https://github.com/xaviml/controllerx-app`. 2. Install the **ControllerX** app and start it. 3. [Configure your controllers]() in `/app_configs/d35634e3_controllerx/apps/apps.yaml`, for example with the Studio Code Server or Samba share apps. The app creates this file with a commented example on its first start. AppDaemon picks up changes to it without a restart. The app keeps all its files in `/app_configs/d35634e3_controllerx/`: ``` /app_configs/d35634e3_controllerx/ ├── appdaemon.yaml AppDaemon configuration (e.g. to enable the MQTT plugin) ├── secrets.yaml Optional, for `!secret` values └── apps/ ├── apps.yaml Your ControllerX configuration └── controllerx/ ControllerX code, replaced on every app start ``` The `d35634e3` prefix is the one you get when adding the repository with the button or URL above. If your folder has a different prefix, look for the one ending in `_controllerx`. To update ControllerX, update the app from **Settings → Apps**. Your files aren't changed by updates. ### Moving your configuration to the app If ControllerX runs in the AppDaemon app today, move its configuration to the ControllerX app. The commands below run in the **Terminal & SSH** app. Set `OLD` to the folder that has your `apps.yaml`: - `/homeassistant/appdaemon/apps` if you installed ControllerX through HACS (some tools show it as `/config/appdaemon/apps`). - `/app_configs/a0d7b954_appdaemon/apps` if you installed it manually in the AppDaemon app's default folder. - Install and start the ControllerX app once, so it creates its folder. - Copy your apps: ``` OLD=/homeassistant/appdaemon/apps cp "$OLD/apps.yaml" /app_configs/d35634e3_controllerx/apps/apps.yaml ``` If the file also has apps other than ControllerX, remove them from the copy; they stay in the AppDaemon app. Don't copy the `controllerx` folder, the app brings its own. - If you use the [MQTT plugin](), copy its `MQTT:` section from the AppDaemon app's `appdaemon.yaml` into `plugins:` in `/app_configs/d35634e3_controllerx/appdaemon.yaml`, and add `client_id: controllerx` to it, so it doesn't clash with the AppDaemon app on the MQTT broker (see [Enable MQTT plugin]()). If you copy other settings too, **leave out the `app_dir` line**: the app always uses its own `apps` folder. Also leave out `secrets: /homeassistant/secrets.yaml`, since the app can't read the Home Assistant configuration folder. - If your configuration uses `!secret`, copy those secrets into `/app_configs/d35634e3_controllerx/secrets.yaml`. - Remove ControllerX from the AppDaemon app: - If you only used AppDaemon for ControllerX, uninstall the AppDaemon app. - Otherwise, remove the ControllerX apps from its `apps.yaml`, delete the ControllerX code with `rm -rf "$OLD/controllerx"`, and restart the AppDaemon app. - Restart the ControllerX app and check its **Log** tab. ## Manual installation 1. Install the **AppDaemon** app from **Settings → Apps → App store** and start it once. It creates its folder in `/app_configs/a0d7b954_appdaemon/`. 2. Install the **Terminal & SSH** app, open its terminal, and run: ``` APPS=/app_configs/a0d7b954_appdaemon/apps; rm -rf "$APPS/controllerx" && mkdir -p "$APPS/controllerx" && curl -fsSL https://github.com/xaviml/controllerx/releases/latest/download/controllerx.zip -o /tmp/controllerx.zip && unzip -oq /tmp/controllerx.zip -d "$APPS/controllerx" && rm /tmp/controllerx.zip ``` This downloads the latest ControllerX release into `/app_configs/a0d7b954_appdaemon/apps/controllerx/`. 3. [Configure your controllers]() in `/app_configs/a0d7b954_appdaemon/apps/apps.yaml`. 4. Restart the AppDaemon app. If you run AppDaemon in some other way, download [controllerx.zip]() and unzip it into a `controllerx` folder inside your AppDaemon apps folder, so that `controllerx.py` ends up in `/controllerx/controllerx.py`. ### Updating Run the same command again and restart the AppDaemon app. It only replaces the `controllerx` folder, so your `apps.yaml` stays as it is. To know when there's a new version, you can watch the [ControllerX releases]() on GitHub (**Watch → Custom → Releases**). ## Migrating from HACS HACS no longer supports AppDaemon apps. ControllerX installed through HACS keeps working, but it won't get updates anymore. HACS installed it in `/homeassistant/appdaemon/apps/controllerx`, next to your `apps.yaml`. Switch to one of the installation methods above: - **Stay with the AppDaemon app:** you don't need to move anything. Update ControllerX with the [manual installation](<#manual-installation>) command, using your current folder, and restart the AppDaemon app: ``` APPS=/homeassistant/appdaemon/apps; rm -rf "$APPS/controllerx" && mkdir -p "$APPS/controllerx" && curl -fsSL https://github.com/xaviml/controllerx/releases/latest/download/controllerx.zip -o /tmp/controllerx.zip && unzip -oq /tmp/controllerx.zip -d "$APPS/controllerx" && rm /tmp/controllerx.zip ``` Keep the `app_dir: /homeassistant/appdaemon/apps` line in your `appdaemon.yaml`, it's what points AppDaemon to this folder. - **Switch to the ControllerX app:** follow [Moving your configuration to the app](<#moving-your-configuration-to-the-app>). > [!WARNING] > > Keep only one copy of ControllerX running. If the same controller is configured in both the AppDaemon app and the ControllerX app, every button press runs twice (for example, a toggle turns the light on and straight back off). ## Enabling the MQTT plugin (optional) If you use the Zigbee2MQTT integration, [enable the MQTT plugin](), since the [Home Assistant sensor listener is deprecated](). Once [ControllerX has been installed](), you can proceed to configure ControllerX in `apps.yaml`: `/app_configs/d35634e3_controllerx/apps/apps.yaml` with the ControllerX app, or `apps.yaml` in the AppDaemon apps folder if you installed it manually. This file follows the [AppDaemon specifications](). Each ControllerX app links one controller with one entity (or group of entities), like: ``` example_app: module: controllerx class: controller: integration: light: ``` or: ``` example_app: module: controllerx class: controller: integration: light: name: color_mode: auto | xy_color | color_temp ``` or: ``` example_app: module: controllerx class: controller: integration: media_player: ``` or: ``` example_app: module: controllerx class: controller: integration: switch: ``` > [!TIP] > > The [configuration builder]() generates this configuration for your device. ## Parameters These are the generic app parameters for all types of controllers. The parameters specific to each controller type (light, media player, switch and cover) are described in [type configuration](). | key | type | value | description | | --- | --- | --- | --- | | `module`\* | string | `controllerx` | The Python module | | `class`\* | string | `E1810Controller` | The Python class. Check the classes for each controller on the [supported controllers]() page. | | `controller`\* | string \| list | `sensor.controller` or `hue_switch1, hue_switch2` | The controller ID, which depends on the integration. Each integration page explains how to find it. | | `integration`\* | string \| dict | See [here]() the available integrations. | The integration through which the device is connected to Home Assistant. | | `actions` | list | All actions | This is a list of actions to be included and controlled by the app. To see the actions of each controller, check its page in [supported controllers](). This attribute cannot be used together with `excluded_actions`. | | `excluded_actions` | list | Empty list | This is a list of actions to be excluded. To see which actions has each controller check the individual controller pages in [here](). This attribute cannot be used together with `actions`. | | `action_delta` | dict \| int | 300 | This is the threshold time between the previous action and the next one (being the same action). If the time difference between the two actions is less than this attribute, then the action won't be called. I recommend changing this if you see the same action being called twice. A different `action_delta` per action can be defined in a mapping. | | `multiple_click_delay` | int | 500 | Indicates the delay (in milliseconds) when a multiple click action should be triggered. The higher the number, the more time there can be between clicks, but there will be more delay for the action to be triggered. | | `action_delay` | dict \| int | 0 | This can be used to set a delay to each action. By default, the delay for all actions is 0. If defining a map, the key for the map is the action and the value is the delay in seconds. Otherwise, we can set a default time like `action_delay: 10`, and this will add a delay to all actions. | | `previous_state` | dict \| str | \- | This can be used to restrict when an action is performed depending on the previous state of the entity. This is just applicable for `state` and `z2m` (when not listening to MQTT) integrations. For example, it can be used when we want the action to be triggered only with a specific previous state. | | `mapping` | dict | \- | This can be used to replace the behaviour of the controller and manually select what each button should be doing. By default it will ignore this parameter. Read more about it [here](). The functionality included in this attribute will remove the default mapping. | | `merge_mapping` | dict | \- | This can be used to merge the default mapping from the controller and manually select what each button should be doing. By default it will ignore this parameter. Read more about it in [here](). The functionality included in this attribute is added on top of the default mapping. | | `mode` | dict \| int | `single` | This defines what to do when an action is already executing. The options and the behaviour are the same as [Home Assistant automation modes]() since it is based on that. The only difference is that `queued` only queues 1 task after the one being executed. One can define a mapping for each action event with different modes. | Integration dictionary for `integration` attribute. | key | type | value | description | | --- | --- | --- | --- | | `name`\* | string | See [here]() the available integrations. | This is the integration that the device was integrated. | In addition, you can add arguments. Each [integration]() has its own arguments. *\* Required fields* #### Explained with YAML ``` example_app: # It can be anything module: controllerx # `class` value depends on the controller you want to use # Check the classes for each controller on the supported controllers page # Supported controller page: https://xaviml.github.io/controllerx/controllers/ class: Controller # or E1810Controller, LightController, HueDimmerController, etc. # `controller` value depends on the integration used (z2m, deconz, zha). # Each integration page explains how to find it: https://xaviml.github.io/controllerx/start/integrations/ controller: livingroom_controller # or my_controller_id or 00:67:88:56:06:78:9b:3f # `integration` is the integration used for your controller # It can be a string (e.g. `integration: deconz`) or an object with extra arguments # Check https://xaviml.github.io/controllerx/start/integrations/ for more info integration: name: z2m # or deconz, zha, state, mqtt, etc. listen_to: mqtt # `actions` and `excluded_actions` can be used to indicate which actions from the default mapping # will be used or not. These 2 attributes cannot be used at the same time. actions: # or excluded_actions. This is optional. - toggle - brightness_up_click # `action_delta` is the threshold to avoid firing the same action twice action_delta: 300 # default. This is optional. # `multiple_click_delay` is used for the multiclick functionality # Check https://xaviml.github.io/controllerx/advanced/multiple-clicks for more info multiple_click_delay: 500 # default. This is optional. # `action_delay` lets you configure delays to existing actions action_delay: # This is optional. toggle: 10 # This will fire `toggle` action in 10 seconds after pressed. # `mode` allows you to define the strategy when an action is already executing # Possible values are `single`, `restart`, `queued` and `parallel` mode: single # default. This is optional. # `mapping` and `merge_mapping` let you override the default behaviour of your controller. # `merge_mapping` updates the default mapping, and `mapping` overrides it completely. # Check https://xaviml.github.io/controllerx/advanced/ for more info merge_mapping: # or `mapping`. This is optional. brightness_up_click: toggle_full_brightness # use predefined actions toggle: # or HA service calls service: scene.turn_on data: entity_id: scene.my_scene toggle$2: # These scripts will be called when toggle is fired twice within 500ms (multiple_click_delay) - service: script.my_script - service: script.my_script_with_arguments data: my_attr: test # From here on, we can include specific attributes from type controllers like # Light, MediaPlayer, Switch or Cover controller for example # Check https://xaviml.github.io/controllerx/start/type-configuration for more info light: light.my_light # or media_player, switch, cover ``` Each device supports one or more controller types, and the controller type defines what the device can control (a light, a media player, a switch or a cover). Here you can check the specific parameters that each type of controller needs. Check the [configuration]() page for the generic parameters. ## Light controller This controller allows the devices to control a light or a group of lights. It allows you to: - Turn on/off light(s) - Toggle light(s) - Manual increase/decrease of brightness and color - Smooth increase/decrease (holding button) of brightness and color - Color loop changing if the light supports xy color. | key | type | value | description | | --- | --- | --- | --- | | `light`\* | string \| dictionary | `group.livingroom_lights` or `light.kitchen` | The light (or group of lights) you want to control | | `manual_steps` | int | 10 | Number of steps to go from min to max when clicking. If the value is 2 with one click you will set the light to 50% and with another one to 100%. | | `automatic_steps` | int | 10 | Number of steps to go from min to max when holding a button (smooth functionality). | | `min_brightness` | int | 1 | The minimum brightness to set to the light. | | `max_brightness` | int | 255 | The maximum brightness to set to the light. | | `min_white_value` | int | 1 | The minimum white value to set to the light. | | `max_white_value` | int | 255 | The maximum white value to set to the light. | | `min_color_temp` | int | 153 | The minimum color temperature to set to the light. | | `max_color_temp` | int | 500 | The maximum color temperature to set to the light. | | `smooth_power_on` | boolean | False | If `True` the associated light will be set to minimum brightness when brightness up is clicked or held and the light is off. | | `delay` | int | [Controller specific]() | Delay in milliseconds between the instructions sent to the light when holding a button (smooth functionality). If it is set to 0, you might get unexpected behavior. | | `max_loops` | int | 50 | Maximum number of loops when holding. The loop will stop either with a release action or reaching the `max_loops` value. | | `hold_release_toggle` | boolean | False | If `true`, a `hold` action will work as a release when another `hold` is running. This is useful when you have a button with just one action event and you want to use the hold-release feature, then you just need to map that event to a `hold` action. | | `release_delay` | float | 0 | `release` actions will be delayed this amount of time (in seconds). This is to avoid cases where `release` is sent almost at the same time as `hold` actions. | | `transition` | int | 300 | Time in milliseconds the light takes to transition from one state to another. | | `add_transition` | boolean | True | If `true` adds transition if supported, otherwise it does not add the `transition` attribute. | | `add_transition_turn_toggle` | boolean | True | If `false` does not add transition when turning on/off or toggling, otherwise it adds the `transition` attribute to the call. See [FAQ \#6]() for a further explanation on the use of this parameter. | | `color_wheel` | string \| list | `default_color_wheel` | It defines the color wheel used when changing the xy color with click or hold actions. See the options below. | | `supported_features` | int | `0b101100` or `44` | See [below](<#supported_features-field>) for the explanation. | | `supported_color_modes` | list | `["xy", "rgb"]` | It overrides the `supported_color_modes` that can be found in light attributes. Values can be `color_temp`, `hs`, `xy`, `rgb`, `rgbw` and `rgbww`. | | `update_supported_features` | boolean | False | If `true`, it will check the supported features field every time before calling any call service action. Useful in case the supported features of the device entity changes over time. | | `hold_toggle_direction_init` | string | `up` | It indicates the first direction of the hold toggle actions (`up` or `down`). | *\* Required fields* *Light dictionary for the `light` attribute:* | key | type | value | description | | --- | --- | --- | --- | | `name`\* | string | `light.kitchen` | The light (or group of lights) you want to control | | `color_mode` | string | `auto` | This attribute can take `auto`, `xy_color` or `color_temp` as value. `auto` will check first if the light supports `xy_color` and then `color_temp`. `xy_color` will cycle through different colors infinitely. `color_temp` will change the color temperature attribute of the light. If a light supports both, you can pick which one to use for the light(s). | *\* Required fields* *Information about `color_wheel` attribute:* This attribute can be either a string or a list. These are the possible string values: | value | description | | --- | --- | | `default_color_wheel` | These are the 24 colors that appear in the Home Assistant color wheel. | | `color_temp_wheel` | These are the xy colors translated from color temperature (2000K to 6488K). They were extracted from [here](). | Otherwise, a custom xy color list can be defined like the following: ``` example_app: module: controllerx class: < device class or LightController > controller: < your controller id > integration: < your integration > light: light.your_light color_wheel: - [0.525, 0.411] - [0.167, 0.338] - [0.324, 0.329] ``` ## Zigbee2MQTT Light controller This controller (`Z2MLightController`) allows the devices to control Zigbee2MQTT lights. It allows you to: - Turn on/off light - Toggle light - Manual increase/decrease of brightness and color - Smooth increase/decrease (holding button) of brightness and color You can read more about this specific controller [here](). | key | type | value | description | | --- | --- | --- | --- | | `light`\* | string \| dictionary | `my_light` | The light you want to control. This is the Zigbee2MQTT friendly name of the light. | | `click_steps` | float | 70 | Number of steps that are passed to Zigbee2MQTT for click actions. | | `hold_steps` | float | 70 | Number of steps that are passed to Zigbee2MQTT for hold actions. | | `transition` | float | 0.5 | Transition sent to Zigbee2MQTT when changing brightness or color temp. | | `use_onoff` | bool | `false` | This allows click and hold actions to turn on/off the light when off or minimum brightness is reached. | *\* Required fields* *Light dictionary for the `light` attribute:* | key | type | value | description | | --- | --- | --- | --- | | `name`\* | string | `my_light` | The light you want to control. This is the Zigbee2MQTT friendly name of the light. | | `mode` | string | `ha` | This attribute can take `ha` or `mqtt`. On the one hand, `ha` will send the mqtt messages through Home Assistant with [`mqtt.publish` service](). On the other hand, `mqtt` will send the MQTT messages through MQTT plugin from AppDaemon (hence skipping HA). | | `topic_prefix` | string | `zigbee2mqtt` | MQTT base topic for Zigbee2MQTT MQTT messages. The topic sent will be `//set`. | *\* Required fields* ## Media player controller This allows you to control media players. It supports volume, play/pause and skipping forward/backward the track and the source. | key | type | value | description | | --- | --- | --- | --- | | `media_player`\* | string | `group.livingroom_speakers` or `media_player.bedroom_speaker` | The media player (or group of media players) you want to control | | `volume_steps` | int | 10 | Number of steps to go from min to max when clicking or holding. If the value is 2 with one click you will set the volume to 50% and with another one to 100%. | | `delay` | int | [Controller specific]() | Delay in milliseconds between the volume up/down instructions when holding a button. The maximum value is 1000, and if it is set to 0, you might get unexpected behavior. | | `max_loops` | int | 50 | Maximum number of loops when holding. The loop will stop either with a release action or reaching the `max_loops` value. | | `hold_release_toggle` | boolean | False | If `true`, a `hold` action will work as a release when another `hold` is running. This is useful when you have a button with just one action event and you want to use the hold-release feature, then you just need to map that event to a `hold` action. | | `release_delay` | float | 0 | `release` actions will be delayed this amount of time. This is to avoid cases where `release` is sent almost at the same time as `hold` actions. | | `supported_features` | int | `0b10111111` or `191` | See [below](<#supported_features-field>) for the explanation. | | `update_supported_features` | boolean | False | If `true`, it will check the supported features field every time before calling any call service action. Useful in case the supported features of the device entity changes over time. | *\* Required fields* ## Switch controller This allows you to control `switch` entities as well as `input_boolean` and `binary_sensor`. It supports turning on/off and toggling. | key | type | value | description | | --- | --- | --- | --- | | `switch`\* | string | `group.switches` or `switch.dishwasher` | The switch (or group of switches) you want to control | *\* Required fields* ## Cover controller This allows you to control covers. It supports opening, closing and stopping covers. | key | type | value | description | | --- | --- | --- | --- | | `cover`\* | string | `group.all_covers` or `cover.kitchen` | The cover (or group of covers) you want to control | | `open_position` | number | 100 | The open position (between 0 and 100) | | `close_position` | number | 0 | The close position (between 0 and 100) | | `cover_duration` | number | \- | Duration of the cover to open and/or close in seconds, so `toggle_open` and `toggle_close` can stop the cover if the cover is still moving. This is recommended to be used when the cover does not report `opening` and `closing` states, otherwise, it is not necessary. | | `supported_features` | int | `0b10111111` or `191` | See [below](<#supported_features-field>) for the explanation. | | `update_supported_features` | boolean | False | If `true`, it will check the supported features field every time before calling any call service action. Useful in case the supported features of the device entity changes over time. | *\* Required fields* ### "supported\_features" field This field will override the `supported_features` attribute from the entity (light, media player, etc). By default, ControllerX will check this value from Home Assistant, however, sometimes this attribute does not properly reflect the features that the entity supports. ControllerX automatically selects one action or another depending on this value, so it is important that it reflects the supported features. This is defined as a bit field in Home Assistant, so the binary representation of the number defines which features it supports. You can see the values for each entity below. #### Light | feature | value | | --- | --- | | EFFECT | 4 | | FLASH | 8 | | TRANSITION | 32 | If you want to express support for everything, the value is `0b101100` or `44`. #### Media player | feature | value | | --- | --- | | PAUSE | 1 | | SEEK | 2 | | VOLUME\_SET | 4 | | VOLUME\_MUTE | 8 | | PREVIOUS\_TRACK | 16 | | NEXT\_TRACK | 32 | | TURN\_ON | 128 | | TURN\_OFF | 256 | | PLAY\_MEDIA | 512 | | VOLUME\_STEP | 1024 | | SELECT\_SOURCE | 2048 | | STOP | 4096 | | CLEAR\_PLAYLIST | 8192 | | PLAY | 16384 | | SHUFFLE\_SET | 32768 | | SELECT\_SOUND\_MODE | 65536 | | SUPPORT\_BROWSE\_MEDIA | 131072 | | SUPPORT\_REPEAT\_SET | 262144 | | SUPPORT\_GROUPING | 524288 | If you want to express support for everything, the value is `0b1111111111110111111` or `524223`. #### Cover | feature | value | | --- | --- | | OPEN | 1 | | CLOSE | 2 | | SET\_COVER\_POSITION | 4 | | STOP | 8 | | OPEN\_TILT | 16 | | CLOSE\_TILT | 32 | | STOP\_TILT | 64 | | SET\_TILT\_POSITION | 128 | If you want to express support for everything, the value is `0b11111111` or `255`. # Configuration builder Choose your device, what you want to control with it and the integration that receives its events. Then, copy the configuration into your [`apps.yaml`](). The configuration builder needs JavaScript. You can build the configuration by hand following the steps below. ## How the configuration is built Every ControllerX app in `apps.yaml` links one controller with one entity, and it has the following shape: ``` livingroom_controller: # (1)! module: controllerx class: E1810Controller # (2)! integration: # (3)! name: z2m listen_to: mqtt controller: livingroom_remote # (4)! light: light.livingroom # (5)! ``` 1. A unique name for the app. It can be anything, but each app needs a different one. 2. The controller class. It depends on the device and on what you want to control (light, media player, switch, cover...). Find it in the page of your device in [supported controllers](). 3. The [integration]() that receives the events from the device (Zigbee2MQTT, deCONZ, ZHA, etc.). 4. The controller ID. Each integration page explains how to find it. 5. The entity to control. The parameter name depends on the controller type: `light`, `media_player`, `switch` or `cover`. Read more in [type configuration](). The rest of the parameters are optional and are described in [configuration]() and [type configuration](). # Integrations This integration (**`deconz`**) listens to `deconz_event` events, and the action is taken by default from the `event` attribute of the `data` object. You can change the attribute that contains the action with the `type` parameter. In addition, you can select which attribute identifies the controller (`id` or `unique_id`) with `listen_to`. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `deconz` | | `listen_to` | Attribute that identifies the controller (`id` or `unique_id`). | `id` | | `type` | Attribute that contains the action. | `event` | *\* Required fields* ## How to extract the `controller` attribute To find the controller ID for deCONZ, go to `Developer Tools > Events`, subscribe to `deconz_event` at the bottom of the page and start listening. Then, press any button on the controller and copy the `id` from the `data` object of the event. ## Example ``` example_app: module: controllerx class: MFKZQ01LMLightController controller: magic_cube integration: name: deconz listen_to: unique_id # defaults to `id` type: gesture # defaults to `event` light: light.example_light ``` The `event` integration is meant to be used with any custom Home Assistant event, so it is not tied to a specific integration. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `event` | | `event_type`\* | The event we are listening to (e.g. `zha_event`). | `-` | | `controller_key`\* | The attribute of the controller to listen to (e.g. `device_ieee`). | `-` | | `action_template`\* | The action template that will be built from the event data (e.g. `action_{command}`). | `-` | *\* Required fields* ### How to extract the `controller` attribute To find the controller ID for Event, go to `Developer Tools > Events`, subscribe to the event type you are interested in at the bottom of the page and start listening. Then, press any button on the controller and copy the relevant attribute from the `data` object of the event. For further explanation and examples, check [here](). This integration ([**`homematic`**]()) listens to `homematic.keypress` events. It creates an action like `_`. It does not have any additional arguments. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `homematic` | *\* Required fields* ## How to extract the `controller` attribute To find the controller ID for Homematic, go to `Developer Tools > Events`, subscribe to `homematic.keypress` at the bottom of the page and start listening. Then, press any button on the controller and copy the `name` from the `data` object of the event. Integrations abstract how ControllerX receives the events from the controllers. Each integration is responsible for listening to a state, an event or an MQTT topic, and for decoding the controller events into actions that ControllerX understands. These are the integrations supported by ControllerX. ### Integrations with mappings These integrations have a default mapping for specific controllers (see [supported controllers]()). | Integration | Configuration value | | --- | --- | | [Zigbee2MQTT]() | `z2m` | | [deCONZ]() | `deconz` | | [ZHA]() | `zha` | | [Homematic]() | `homematic` | | [Lutron Caséta]() | `lutron_caseta` | | [Shelly]() | `shelly` | | [Shelly for HASS]() | `shellyforhass` | | [Tasmota]() | `tasmota` | ### Custom integrations These integrations do not have a default mapping, so they are meant to be used with a [custom mapping](). | Integration | Configuration value | | --- | --- | | [State]() | `state` | | [MQTT]() | `mqtt` | | [Event]() | `event` | ## Example The integration name can be placed directly in the `integration` parameter: ``` example_app: module: controllerx ... integration: z2m ... ``` Or in the `name` parameter inside `integration`, in case you want to add other integration parameters: ``` example_app: module: controllerx ... integration: name: z2m listen_to: mqtt ... ``` This integration (**`lutron_caseta`**) listens to `lutron_caseta_button_event` events. It creates an action like `button__`. It does not have any additional arguments. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `lutron_caseta` | *\* Required fields* ## How to extract the `controller` attribute To find the controller ID for Lutron Caséta, go to `Developer Tools > Events`, subscribe to `lutron_caseta_button_event` at the bottom of the page and start listening. Then, press any button on the controller and copy the `serial` from the `data` object of the event. This integration (**`mqtt`**) listens to the MQTT topic set in the `controller` attribute. Although this integration is meant to be used with a [custom mapping](), it also works with the actions from Zigbee2MQTT. ControllerX listens directly to MQTT rather than to Home Assistant. Not only can you use this with Zigbee2MQTT, but also with any other MQTT integration. This works for JSON and non-JSON payloads. If a specific attribute needs to be extracted from a JSON payload, the `key` parameter (which works like `action_key` in the Zigbee2MQTT integration) can be used. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `mqtt` | | `key` | The key to retrieve the data from. | `-` | *\* Required fields* ## How to extract the `controller` attribute For MQTT, the `controller` attribute is the MQTT topic to listen to. Unless `key` is set, the payload of the topic must contain the action name directly, not JSON. This means that when using the MQTT integration with a Zigbee2MQTT controller, the topic to listen to must be `zigbee2mqtt//action` or `zigbee2mqtt//click`. You can see the topics in the Zigbee2MQTT logs. ## Example ``` example_app: module: controllerx class: LightController controller: - zigbee2mqtt/stairway_sensor01_occupancy - zigbee2mqtt/stairway_sensor02_occupancy light: light.stairway integration: name: mqtt key: occupancy mapping: "true": "on" "false": "off" ``` This example turns on the light when the following payload is published to one of the 2 topics in the `controller` key: ``` { "battery": 99, "illuminance": 0, "illuminance_lux": 0, "linkquality": 255, "occupancy": true, "temperature": 27, "voltage": 2985 } ``` Without `key`, the integration reads non-JSON payloads. Last but not least, the [MQTT plugin needs to be enabled](). This integration ([**`shelly`**]()) listens to `shelly.click` events. It creates an action like `_`. It does not have any additional arguments. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `shelly` | *\* Required fields* ## How to extract the `controller` attribute To find the controller ID for Shelly, go to `Developer Tools > Events`, subscribe to `shelly.click` at the bottom of the page and start listening. Then, press any button on the controller and copy the `device` from the `data` object of the event. You can read more about the event [here](). This integration ([**`shellyforhass`**]()) listens to `shellyforhass.click` events. It creates an action like ``. It does not have any additional arguments. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `shellyforhass` | *\* Required fields* ## How to extract the `controller` attribute To find the controller ID for Shelly for HASS, go to `Developer Tools > Events`, subscribe to `shellyforhass.click` at the bottom of the page and start listening. Then, press any button on the controller and copy the `entity_id` from the `data` object of the event. You can read more about the event [here](). This integration (**`state`**) listens to the state changes of an entity, and the new state is used as the action. Add the `attribute` parameter if you want to listen to the changes of an attribute instead. Read more about the options [here](). ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `state` | | `attribute` | The attribute to listen to for state changes. | `-` | *\* Required fields* ## How to extract the `controller` attribute To find the controller ID for State, go to `Developer Tools > States` and find the entity ID of the sensor you want to use. ## Example Listening for the attribute `click` from the sensor `sensor.my_custom_button`: ``` example_app: module: controllerx class: LightController controller: sensor.my_custom_button integration: name: state attribute: click light: light.example_light mapping: 1_click: "on" 2_click: "off" ``` This integration ([**`tasmota`**]()) listens to the MQTT topic set in the `controller` attribute, and gets the action from the attribute defined in `component`. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `tasmota` | | `component`\* | The component we are listening to (e.g. `Button1`). | `-` | | `key` | The key to retrieve the data from. | `Action` | *\* Required fields* For this integration to work, SetOption73 (for Buttons) and SetOption114 (for Switches) need to be set in Tasmota. Tasmota payload: ``` { "Button1": { "Action": "TOGGLE" } } ``` ## How to extract the `controller` attribute The Tasmota integration relies on the [MQTT plugin](), so the `controller` is the MQTT topic to listen to (e.g. `stat/tasmota_device/RESULT`). ## Example ``` example_app: module: controllerx class: TasmotaButtonLightController controller: stat/tasmota_device/RESULT integration: name: tasmota component: Button1 light: light.example_light ``` This integration (**`zha`**) listens to `zha_event` events and builds the action by concatenating the command with its arguments. It does not have any additional arguments. ## Parameters | Parameter | Description | Default | | --- | --- | --- | | `name`\* | Integration name. | `zha` | *\* Required fields* ## How to extract the `controller` attribute To find the controller ID for ZHA, go to `Developer Tools > Events`, subscribe to `zha_event` at the bottom of the page and start listening. Then, press any button on the controller and copy the `device_ieee` from the `data` object of the event. It looks like `00:67:88:56:06:78:9b:3f`. This integration (**`z2m`**) is meant to be used with Zigbee2MQTT. It can listen to MQTT topics directly (`listen_to: mqtt`, recommended), to Home Assistant event entities (`listen_to: event`) or to the deprecated Home Assistant action sensors (`listen_to: ha`). ## Parameters | Parameters | Description | Default | | --- | --- | --- | | `name` | Integration name | `z2m` | | `listen_to` | Indicates whether it listens for HA states (`ha`), MQTT topics (`mqtt`) or HA Event state (`event`). | `ha` | | `action_key` | The key inside the topic payload that contains the fired action from the controller. | `action` | | `action_group` | A list of allowed action groups for the controller configuration. | `-` | | `topic_prefix` | MQTT base topic for Zigbee2MQTT MQTT messages. | `zigbee2mqtt` | ## How to extract the `controller` attribute ### MQTT topics `listen_to: mqtt` > [!NOTE] > > This option requires [enabling the MQTT plugin](). This is the recommended option. The `controller` attribute is the friendly name of the controller in Zigbee2MQTT, which can be found in the Zigbee2MQTT configuration of the device. For example, if the MQTT topic is `zigbee2mqtt/livingroom_controller`, the friendly name (and `controller` attribute) of the controller would be `livingroom_controller`. ### Event state `listen_to: event` > [!NOTE] > > This option requires enabling `experimental_event_entities` in Zigbee2MQTT. This can be done in Zigbee2MQTT `Settings > Home Assistant integration`. Then enable `Home Assistant experimental event entities`. Note that this option is experimental since Zigbee2MQTT 2.0. To find the controller ID for Zigbee2MQTT, go to `Settings > Devices & services > MQTT` and select the controller. The parameter you need is the entity ID of the action event without the `event.` prefix. E.g. if the event is `event.livingroom_controller_action`, the `controller` attribute should be `livingroom_controller_action`. ### HA States (`listen_to: ha`, deprecated) > [!WARNING] > > This option is deprecated since ControllerX v4.29.0. > [!NOTE] > > This option requires enabling `legacy_action_sensor` in Zigbee2MQTT. This can be done in Zigbee2MQTT `Settings > Home Assistant integration`. Then enable `Home Assistant legacy action sensors`. Note that this option is deprecated since Zigbee2MQTT 2.0 and will be removed in the future. To find the controller ID for Zigbee2MQTT, go to `Settings > Devices & services > MQTT` and select the controller. The parameter you need is the entity ID of the sensor that by default finishes in `_action`. ## Example Imagine we have the following configuration already created for a `z2m` controller listening to the (deprecated) HA state: ``` livingroom_controller: module: controllerx class: E1810Controller controller: sensor.livingroom_controller_action integration: name: z2m listen_to: ha light: light.bedroom ``` Then, if we want to listen to the MQTT topic directly (skipping the HA state machine), we need to change it to: ``` livingroom_controller: module: controllerx class: E1810Controller controller: livingroom_controller integration: name: z2m listen_to: mqtt action_key: action # `action` by default light: light.bedroom ``` # Supported controllers # Supported controllers ControllerX supports **72** devices out of the box. Select your device to see its default button mapping and an example configuration, or use the [configuration builder]() to generate the configuration for it. If your device is not listed, you can still use it with a [custom mapping]() on top of the generic controllers (`LightController`, `MediaPlayerController`, `SwitchController`, `CoverController` and `Z2MLightController`). > [!TIP] > > **For tools and AI assistants** > > This list is also available as [JSON](), including the controller classes and the default mapping of every device. All manufacturers ADEO Aqara Aurora Homematic IKEA Legrand Linkind Livarno Lutron Müller Licht Namron OSRAM Philips Prolight RGB Genie ROBB Sengled Shelly Smartkontakten SmartThings SONOFF Tasmota Terncy Trust Tuya All integrations Zigbee2MQTT deCONZ ZHA State Lutron Caseta Homematic Shelly ShellyForHass Tasmota All controller types Light Zigbee2MQTT Light Media Player Switch Cover | Picture | Device | Manufacturer | Controller types | Integrations | | --- | --- | --- | --- | --- | | ![ADEO HRC99CZC045]() | [AdeoHRC99CZC045]() | ADEO | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![Aurora AUA1ZBR2GW]() | [AUA1ZBR2GW]() | Aurora | Light | ZHA | | ![IKEA E1743]() | [E1743]() | IKEA | Light, Zigbee2MQTT Light, Media Player, Switch, Cover | Zigbee2MQTT, deCONZ, ZHA | | ![IKEA E1744]() | [E1744]() | IKEA | Light, Zigbee2MQTT Light, Media Player | Zigbee2MQTT, deCONZ, ZHA | | ![IKEA E1766]() | [E1766]() | IKEA | Light, Zigbee2MQTT Light, Switch, Cover | Zigbee2MQTT, deCONZ, ZHA | | ![IKEA E1810]() | [E1810]() | IKEA | Light, Zigbee2MQTT Light, Media Player | Zigbee2MQTT, deCONZ, ZHA | | ![IKEA E1812]() | [E1812]() | IKEA | Light, Zigbee2MQTT Light, Switch | Zigbee2MQTT, deCONZ, ZHA | | ![Sengled E1EG7F]() | [E1EG7F]() | Sengled | Light, Zigbee2MQTT Light | Zigbee2MQTT, ZHA | | ![IKEA E2002]() | [E2002]() | IKEA | Light, Zigbee2MQTT Light, Media Player | Zigbee2MQTT, deCONZ, ZHA | | ![IKEA E2123]() | [E2123]() | IKEA | Media Player | Zigbee2MQTT, deCONZ, ZHA | | ![IKEA E2201]() | [E2201]() | IKEA | Light, Zigbee2MQTT Light, Media Player, Switch, Cover | Zigbee2MQTT, deCONZ, ZHA | | ![IKEA E2213]() | [E2213]() | IKEA | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![Livarno HG06323]() | [HG06323]() | Livarno | Light, Zigbee2MQTT Light | Zigbee2MQTT, ZHA | | ![Homematic HMPB2WM552]() | [HMPB2WM552]() | Homematic | Light | Homematic | | ![Homematic HMPB6WM55]() | [HMPB6WM55]() | Homematic | Light | Homematic | | ![Homematic HMPBI4FM]() | [HMPBI4FM]() | Homematic | Light | Homematic | | ![Homematic HMSenMDIRWM55]() | [HMSenMDIRWM55]() | Homematic | Light | Homematic | | ![Philips HueDimmer]() | [HueDimmer]() | Philips | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ, ZHA | | ![Philips HueSmartButton]() | [HueSmartButton]() | Philips | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ | | ![IKEA ICTCG1]() | [ICTCG1]() | IKEA | Light, Zigbee2MQTT Light, Media Player | Zigbee2MQTT, deCONZ, ZHA | | ![Legrand 600083]() | [Legrand600083]() | Legrand | Light, Zigbee2MQTT Light | Zigbee2MQTT, ZHA | | ![Legrand 600088]() | [Legrand600088]() | Legrand | Light, Zigbee2MQTT Light | Zigbee2MQTT, ZHA | | ![Lutron PJ22B]() | [LutronPJ22B]() | Lutron | Light, Media Player | State, Lutron Caseta | | ![Lutron PJ22BRL]() | [LutronPJ22BRL]() | Lutron | Light, Media Player | State | | ![Lutron PJ23BRL]() | [LutronPJ23BRL]() | Lutron | Light, Media Player | State, Lutron Caseta | | ![Lutron PJ24B]() | [LutronPJ24B]() | Lutron | Light, Media Player | State | | ![Lutron LZL4BWHL01]() | [LZL4BWHL01]() | Lutron | Light | deCONZ, ZHA | | ![Aqara MFKZQ01LM]() | [MFKZQ01LM]() | Aqara | Light | Zigbee2MQTT, deCONZ, ZHA | | ![Müller Licht MLI404002]() | [MLI404002]() | Müller Licht | Light, Zigbee2MQTT Light | Zigbee2MQTT, ZHA | | ![Müller Licht MLI404011]() | [MLI404011]() | Müller Licht | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ | | ![Namron 4512773]() | [Namron4512773]() | Namron | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![OSRAM AC025XX00NJ]() | [OsramAC025XX00NJ]() | OSRAM | Light | deCONZ, ZHA | | ![Philips 929002398602]() | [Philips929002398602]() | Philips | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ, ZHA | | ![Philips 929003017102]() | [Philips929003017102]() | Philips | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ, ZHA | | ![Philips RDM002]() | [PhilipsRDM002]() | Philips | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![Prolight 5412748727388]() | [Prolight5412748727388]() | Prolight | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![Philips PTM215X]() | [PTM215X]() | Philips | Light | Zigbee2MQTT, deCONZ | | ![ROBB ROB2000070]() | [ROB2000070]() | ROBB | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![Shelly 25]() | [Shelly25]() | Shelly | Light | Shelly | | ![Shelly Dimmer2]() | [ShellyDimmer2]() | Shelly | Light | Shelly | | ![Shelly I3]() | [ShellyI3]() | Shelly | Light | ShellyForHass | | ![Shelly PlusI4]() | [ShellyPlusI4]() | Shelly | Light | Shelly | | ![Smartkontakten SK5700002228949]() | [SK5700002228949]() | Smartkontakten | Light | deCONZ | | ![SmartThings Button]() | [SmartThingsButton]() | SmartThings | Light, Media Player | Zigbee2MQTT, deCONZ, ZHA | | ![SONOFF SNZB01]() | [SNZB01]() | SONOFF | Light | Zigbee2MQTT, ZHA | | ![Tasmota Button]() | [TasmotaButton]() | Tasmota | Light, Zigbee2MQTT Light, Switch, Cover | Tasmota | | ![Tasmota Switch]() | [TasmotaSwitch]() | Tasmota | Light, Zigbee2MQTT Light, Switch, Cover | Tasmota | | ![Terncy PP01]() | [TerncyPP01]() | Terncy | Light | ZHA | | ![Terncy SD01]() | [TerncySD01]() | Terncy | Light, Media Player | ZHA | | ![Tuya TS0042]() | [TS0042]() | Tuya | Light | ZHA | | ![Tuya TS0043]() | [TS0043]() | Tuya | Light, Cover | Zigbee2MQTT, ZHA | | ![Tuya TS0044]() | [TS0044]() | Tuya | Light | Zigbee2MQTT | | ![Tuya TS0044F]() | [TS0044F]() | Tuya | Light | Zigbee2MQTT | | ![Tuya ERS10TZBVKAA]() | [TuYaERS10TZBVKAA]() | Tuya | Light, Zigbee2MQTT Light, Media Player | Zigbee2MQTT, ZHA | | ![Aqara WXCJKG11LM]() | [WXCJKG11LM]() | Aqara | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ | | ![Aqara WXCJKG12LM]() | [WXCJKG12LM]() | Aqara | Light, Zigbee2MQTT Light | Zigbee2MQTT, ZHA | | ![Aqara WXCJKG13LM]() | [WXCJKG13LM]() | Aqara | Light, Zigbee2MQTT Light, Media Player | Zigbee2MQTT, deCONZ, ZHA | | ![Aqara WXKG01LM]() | [WXKG01LM]() | Aqara | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ, ZHA | | ![Aqara WXKG02LM]() | [WXKG02LM]() | Aqara | Light, Zigbee2MQTT Light, Switch | Zigbee2MQTT, deCONZ, ZHA | | ![Aqara WXKG06LM]() | [WXKG06LM]() | Aqara | Light, Switch | Zigbee2MQTT, deCONZ | | ![Aqara WXKG07LM]() | [WXKG07LM]() | Aqara | Light, Zigbee2MQTT Light, Switch | Zigbee2MQTT, deCONZ, ZHA | | ![Aqara WXKG11LMRemote]() | [WXKG11LMRemote]() | Aqara | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ, ZHA | | ![Aqara WXKG11LMSensorSwitch]() | [WXKG11LMSensorSwitch]() | Aqara | Light | deCONZ, ZHA | | ![Aqara WXKG12LM]() | [WXKG12LM]() | Aqara | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ | | ![Aqara WXKG15LM]() | [WXKG15LM]() | Aqara | Light, Zigbee2MQTT Light, Switch | Zigbee2MQTT | | ![Lutron Z31BRL]() | [Z31BRL]() | Lutron | Light, Zigbee2MQTT Light | Zigbee2MQTT, deCONZ | | ![RGB Genie ZB3009]() | [ZB3009]() | RGB Genie | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![RGB Genie ZB5121]() | [ZB5121]() | RGB Genie | Light | ZHA | | ![RGB Genie ZB5122]() | [ZB5122]() | RGB Genie | Light | ZHA | | ![Aqara ZNXNKG02LM]() | [ZNXNKG02LM]() | Aqara | Light, Media Player | Zigbee2MQTT | | ![Linkind ZS23000278]() | [ZS23000278]() | Linkind | Light, Zigbee2MQTT Light | Zigbee2MQTT | | ![Trust ZYCT202]() | [ZYCT202]() | Trust | Light, Zigbee2MQTT Light, Media Player | Zigbee2MQTT | # Aurora AUA1ZBR2GW ![Aurora AUA1ZBR2GW]() - **Manufacturer:** Aurora - **Device ID:** `AUA1ZBR2GW` - **Controller types:** [Light](<#light>) (`AUA1ZBR2GWLightController`) - **Integrations:** [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `AUA1ZBR2GWLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ZHA | [Predefined action]() | | --- | --- | | `1_toggle`, `2_toggle` | `toggle` | | `1_step_up`, `2_step_up` | `click_brightness_up` | | `1_step_down`, `2_step_down` | `click_brightness_down` | | `1_step_color_temp_up`, `2_step_color_temp_up` | `click_colortemp_up` | | `1_step_color_temp_down`, `2_step_color_temp_down` | `click_colortemp_down` | ### Example configuration ``` example_app: module: controllerx class: AUA1ZBR2GWLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # ADEO HRC99CZC045 ![ADEO HRC99CZC045]() - **Manufacturer:** ADEO - **Device ID:** `AdeoHRC99CZC045` - **Controller types:** [Light](<#light>) (`AdeoHRC99CZC045LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`AdeoHRC99CZC045Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `AdeoHRC99CZC045LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_step_up` | `hold_brightness_up` | | `brightness_step_down` | `hold_brightness_down` | | `brightness_stop`, `color_stop` | `release` | | `color_hue_step_up`, `color_saturation_step_up` | `hold_color_up` | | `color_hue_step_down`, `color_saturation_step_down` | `hold_color_down` | | `color_temperature_step_up` | `hold_colortemp_up` | | `color_temperature_step_down` | `hold_colortemp_down` | | `scene_1`, `scene_2`, `scene_3`, `scene_4` | *No action* | ### Example configuration ``` example_app: module: controllerx class: AdeoHRC99CZC045LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: AdeoHRC99CZC045LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `AdeoHRC99CZC045Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_step_up` | `hold_brightness_up` | | `brightness_step_down` | `hold_brightness_down` | | `brightness_stop`, `color_stop` | `release` | | `color_hue_step_up`, `color_saturation_step_up`, `color_temperature_step_up` | `hold_colortemp_up` | | `color_hue_step_down`, `color_saturation_step_down`, `color_temperature_step_down` | `hold_colortemp_down` | | `scene_1`, `scene_2`, `scene_3`, `scene_4` | *No action* | ### Example configuration ``` example_app: module: controllerx class: AdeoHRC99CZC045Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: AdeoHRC99CZC045Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # IKEA E1743 ![IKEA E1743]() - **Manufacturer:** IKEA - **Device ID:** `E1743` - **Controller types:** [Light](<#light>) (`E1743Controller`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E1743Z2MLightController`), [Media Player](<#media-player>) (`E1743MediaPlayerController`), [Switch](<#switch>) (`E1743SwitchController`), [Cover](<#cover>) (`E1743CoverController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `E1743Controller` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `on` | | `"off"` | `2002` | `"off"` | `off` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `hold_brightness_up` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `hold_brightness_down` | | `brightness_stop` | `1003`, `2003` | `stop`, `stop_with_on_off` | `release` | ### Example configuration ``` example_app: module: controllerx class: E1743Controller integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1743Controller integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1743Controller integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1743Controller integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E1743Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: E1743Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E1743Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `E1743MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `play_pause` | | `"off"` | `2002` | `"off"` | `next_track` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `hold_volume_up` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `hold_volume_down` | | `brightness_stop` | `1003`, `2003` | `stop`, `stop_with_on_off` | `release` | ### Example configuration ``` example_app: module: controllerx class: E1743MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1743MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1743MediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1743MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` ## Switch - **Class:** `E1743SwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `on` | | `"off"` | `2002` | `"off"` | `off` | ### Example configuration ``` example_app: module: controllerx class: E1743SwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1743SwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1743SwitchController integration: deconz controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1743SwitchController integration: zha controller: 00:11:22:33:44:55:66:77:88 switch: switch.my_entity_id ``` ## Cover - **Class:** `E1743CoverController` - **Entity parameter:** `cover` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `toggle_open` | | `"off"` | `2002` | `"off"` | `toggle_close` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `open` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `close` | | `brightness_stop` | `1003`, `2003` | `stop`, `stop_with_on_off` | `stop` | ### Example configuration ``` example_app: module: controllerx class: E1743CoverController integration: name: z2m listen_to: mqtt controller: my_controller cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E1743CoverController integration: name: z2m listen_to: event controller: my_controller_action cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E1743CoverController integration: deconz controller: my_controller cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E1743CoverController integration: zha controller: 00:11:22:33:44:55:66:77:88 cover: cover.my_entity_id ``` # IKEA E1744 ![IKEA E1744]() - **Manufacturer:** IKEA - **Device ID:** `E1744` - **Controller types:** [Light](<#light>) (`E1744LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E1744Z2MLightController`), [Media Player](<#media-player>) (`E1744MediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes If you want to use the default controller, you will need to set `legacy: false` in the Zigbee2MQTT configuration. Read more [here](). ## Light - **Class:** `E1744LightController` - **Entity parameter:** `light` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `brightness_move_down` | `3001` | `move_1_195_0_0` | `hold_brightness_down` | | `brightness_move_up` | `2001` | `move_0_195_0_0` | `hold_brightness_up` | | `brightness_stop` | `2003`, `3003` | `stop` | `release` | | `toggle` | `1002` | `toggle` | `toggle` | | `brightness_step_up` | `1004` | `step_0_1_0_0_0` | `on_full_brightness` | | `brightness_step_down` | `1005` | `step_1_1_0_0_0` | `on_min_brightness` | ### Example configuration ``` example_app: module: controllerx class: E1744LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1744LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1744LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1744LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E1744Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `brightness_move_down` | `hold_brightness_down` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_stop` | `release` | | `toggle` | `toggle` | | `brightness_step_up` | `on_full_brightness` | | `brightness_step_down` | `on_min_brightness` | ### Example configuration ``` example_app: module: controllerx class: E1744Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E1744Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `E1744MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `brightness_move_down` | `3001` | `move_1_195_0_0` | `hold_volume_down` | | `brightness_move_up` | `2001` | `move_0_195_0_0` | `hold_volume_up` | | `brightness_stop` | `2003`, `3003` | `stop` | `release` | | `toggle` | `1002` | `toggle` | `play_pause` | | `brightness_step_up` | `1004` | `step_0_1_0_0_0` | `next_track` | | `brightness_step_down` | `1005` | `step_1_1_0_0_0` | `previous_track` | ### Example configuration ``` example_app: module: controllerx class: E1744MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1744MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1744MediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1744MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # IKEA E1766 ![IKEA E1766]() - **Manufacturer:** IKEA - **Device ID:** `E1766` - **Controller types:** [Light](<#light>) (`E1766LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E1766Z2MLightController`), [Switch](<#switch>) (`E1766SwitchController`), [Cover](<#cover>) (`E1766CoverController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `E1766LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `open` | `1002` | `up_open` | `on` | | `close` | `2002` | `down_close` | `off` | | | `1003` | | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: E1766LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1766LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1766LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1766LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E1766Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `open` | `on` | | `close` | `off` | ### Example configuration ``` example_app: module: controllerx class: E1766Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E1766Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Switch - **Class:** `E1766SwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `open` | `1002` | `up_open` | `on` | | `close` | `2002` | `down_close` | `off` | ### Example configuration ``` example_app: module: controllerx class: E1766SwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1766SwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1766SwitchController integration: deconz controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1766SwitchController integration: zha controller: 00:11:22:33:44:55:66:77:88 switch: switch.my_entity_id ``` ## Cover - **Class:** `E1766CoverController` - **Entity parameter:** `cover` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `open` | `1002` | `up_open` | `toggle_open` | | `close` | `2002` | `down_close` | `toggle_close` | | `stop` | `1003`, `2003` | `stop` | `stop` | ### Example configuration ``` example_app: module: controllerx class: E1766CoverController integration: name: z2m listen_to: mqtt controller: my_controller cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E1766CoverController integration: name: z2m listen_to: event controller: my_controller_action cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E1766CoverController integration: deconz controller: my_controller cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E1766CoverController integration: zha controller: 00:11:22:33:44:55:66:77:88 cover: cover.my_entity_id ``` # IKEA E1810 ![IKEA E1810]() - **Manufacturer:** IKEA - **Device ID:** `E1810` - **Controller types:** [Light](<#light>) (`E1810Controller`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E1810Z2MLightController`), [Media Player](<#media-player>) (`E1810MediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes This device mapping also supports the E1524 controller. ## Light - **Class:** `E1810Controller` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `toggle` | `1002` | `toggle` | `toggle` | | `toggle_hold` | `1001` | `press_2_0_0` | `sync` | | `brightness_up_click` | `2002` | `step_with_on_off_0_43_5` | `click_brightness_up` | | `brightness_down_click` | `3002` | `step_1_43_5_0_0` | `click_brightness_down` | | `arrow_left_click` | `4002` | `press_257_13_0` | `click_color_down` | | `arrow_right_click` | `5002` | `press_256_13_0` | `click_color_up` | | `brightness_up_hold` | `2001` | `move_with_on_off_0_83`, `move_with_on_off_0_84` | `hold_brightness_up` | | `brightness_up_release`, `brightness_down_release`, `arrow_left_release`, `arrow_right_release` | `2003`, `3003`, `4003`, `5003` | `stop`, `stop_with_on_off`, `release` | `release` | | `brightness_down_hold` | `3001` | `move_1_83_0_0`, `move_1_84_0_0` | `hold_brightness_down` | | `arrow_left_hold` | `4001` | `hold_3329_0` | `hold_color_down` | | `arrow_right_hold` | `5001` | `hold_3328_0` | `hold_color_up` | ### Example configuration ``` example_app: module: controllerx class: E1810Controller integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1810Controller integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1810Controller integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1810Controller integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E1810Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `toggle` | `toggle` | | `toggle_hold` | `on_full_brightness` | | `brightness_up_click` | `click_brightness_up` | | `brightness_down_click` | `click_brightness_down` | | `arrow_left_click` | `click_colortemp_down` | | `arrow_right_click` | `click_colortemp_up` | | `brightness_up_hold` | `hold_brightness_up` | | `brightness_up_release`, `brightness_down_release`, `arrow_left_release`, `arrow_right_release` | `release` | | `brightness_down_hold` | `hold_brightness_down` | | `arrow_left_hold` | `hold_colortemp_down` | | `arrow_right_hold` | `hold_colortemp_up` | ### Example configuration ``` example_app: module: controllerx class: E1810Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E1810Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `E1810MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `toggle` | `1002` | `toggle` | `play_pause` | | `brightness_up_click` | `2002` | `step_with_on_off_0_43_5` | `click_volume_up` | | `brightness_down_click` | `3002` | `step_1_43_5_0_0` | `click_volume_down` | | `arrow_left_click` | `4002` | `press_257_13_0` | `previous_track` | | `arrow_right_click` | `5002` | `press_256_13_0` | `next_track` | | `arrow_left_hold` | `4001` | `hold_3329_0` | `previous_source` | | `arrow_right_hold` | `5001` | `hold_3328_0` | `next_source` | | `brightness_up_hold` | `2001` | `move_with_on_off_0_83`, `move_with_on_off_0_84` | `hold_volume_up` | | `brightness_up_release`, `brightness_down_release` | `2003`, `3003` | `stop`, `stop_with_on_off`, `release` | `release` | | `brightness_down_hold` | `3001` | `move_1_83_0_0`, `move_1_84_0_0` | `hold_volume_down` | ### Example configuration ``` example_app: module: controllerx class: E1810MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1810MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1810MediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E1810MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # IKEA E1812 ![IKEA E1812]() - **Manufacturer:** IKEA - **Device ID:** `E1812` - **Controller types:** [Light](<#light>) (`E1812LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E1812Z2MLightController`), [Switch](<#switch>) (`E1812SwitchController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `E1812LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `toggle` | | `brightness_move_up` | `1001` | `move_with_on_off` | `hold_brightness_toggle` | | `brightness_stop` | `1003` | `stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: E1812LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1812LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1812LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1812LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E1812Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `toggle` | | `brightness_move_up` | `hold_brightness_toggle` | | `brightness_stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: E1812Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E1812Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Switch - **Class:** `E1812SwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `toggle` | ### Example configuration ``` example_app: module: controllerx class: E1812SwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1812SwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1812SwitchController integration: deconz controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E1812SwitchController integration: zha controller: 00:11:22:33:44:55:66:77:88 switch: switch.my_entity_id ``` # Sengled E1EG7F ![Sengled E1EG7F]() - **Manufacturer:** Sengled - **Device ID:** `E1EG7F` - **Controller types:** [Light](<#light>) (`E1EG7FLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E1EG7FZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `E1EG7FLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `"on"` | `"on"` | `on` | | `on_long` | `on_long` | `click_color_up` | | `on_double` | `on_double` | `on_full_color_temp` | | `up` | `step_0_1_0` | `click_brightness_up` | | `up_long` | `step_0_2_0` | `on_full_brightness` | | `down` | `step_1_1_0` | `click_brightness_down` | | `down_long` | `step_1_2_0` | `on_min_brightness` | | `"off"` | `"off"` | `off` | | `off_long` | `off_long` | `click_color_down` | | `off_double` | `off_double` | `on_min_color_temp` | ### Example configuration ``` example_app: module: controllerx class: E1EG7FLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1EG7FLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E1EG7FLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E1EG7FZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `on_long` | `click_colortemp_up` | | `on_double` | `on_full_color_temp` | | `up` | `click_brightness_up` | | `up_long` | `on_full_brightness` | | `down` | `click_brightness_down` | | `down_long` | `on_min_brightness` | | `"off"` | `off` | | `off_long` | `click_colortemp_down` | | `off_double` | `on_min_color_temp` | ### Example configuration ``` example_app: module: controllerx class: E1EG7FZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E1EG7FZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # IKEA E2002 ![IKEA E2002]() - **Manufacturer:** IKEA - **Device ID:** `E2002` - **Controller types:** [Light](<#light>) (`E2002LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E2002Z2MLightController`), [Media Player](<#media-player>) (`E2002MediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes This controller fires the "on" action when the arrows are held, as well as the hold arrow action. This means that when long pressing the arrows, the light(s) will turn on before changing the color. This device mapping also supports the E2001 controller. ## Light - **Class:** `E2002LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `on` | | `"off"` | `2002` | `"off"` | `off` | | `arrow_left_click` | `3002` | `press_257_13_0` | `click_color_down` | | `arrow_right_click` | `4002` | `press_256_13_0` | `click_color_up` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `hold_brightness_up` | | `brightness_stop`, `arrow_left_release`, `arrow_right_release` | `1003`, `2003`, `3003`, `4003` | `stop`, `stop_with_on_off`, `release` | `release` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `hold_brightness_down` | | `arrow_left_hold` | `3001` | `hold_3329_0` | `hold_color_down` | | `arrow_right_hold` | `4001` | `hold_3328_0` | `hold_color_up` | ### Example configuration ``` example_app: module: controllerx class: E2002LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E2002LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E2002LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E2002LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E2002Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `arrow_left_click` | `click_colortemp_down` | | `arrow_right_click` | `click_colortemp_up` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_stop`, `arrow_left_release`, `arrow_right_release` | `release` | | `brightness_move_down` | `hold_brightness_down` | | `arrow_left_hold` | `hold_colortemp_down` | | `arrow_right_hold` | `hold_colortemp_up` | ### Example configuration ``` example_app: module: controllerx class: E2002Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E2002Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `E2002MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `play_pause` | | `"off"` | `2002` | `"off"` | `click_volume_down` | | `arrow_left_click` | `3002` | `press_257_13_0` | `previous_track` | | `arrow_right_click` | `4002` | `press_256_13_0` | `next_track` | | `arrow_left_hold` | `3001` | `hold_3329_0` | `previous_source` | | `arrow_left_release`, `arrow_right_release`, `brightness_stop` | `1003`, `2003`, `3003`, `4003` | `stop`, `stop_with_on_off`, `release` | `release` | | `arrow_right_hold` | `4001` | `hold_3328_0` | `next_source` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `hold_volume_up` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `hold_volume_down` | ### Example configuration ``` example_app: module: controllerx class: E2002MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2002MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2002MediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2002MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # IKEA E2123 ![IKEA E2123]() - **Manufacturer:** IKEA - **Device ID:** `E2123` - **Controller types:** [Media Player](<#media-player>) (`E2123MediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes The device supports other events which are not added to the default mapping. Please check [this GitHub issue]() for more information. ## Media Player - **Class:** `E2123MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `toggle`, `play_pause` | | `toggle`, `play_pause` | `play_pause` | | `track_next` | `5002` | `step_0_1_0_0_0` | `next_track` | | `track_previous` | `4002` | `step_1_1_0_0_0` | `previous_track` | | `volume_up`, `volume_up_hold` | | `move_with_on_off_0_255` | `click_volume_up` | | `volume_down`, `volume_down_hold` | | `move_with_on_off_1_255` | `click_volume_down` | | `dots_1_initial_press` | `6000` | `2_initial_press_0` | `previous_source` | | `dots_2_initial_press` | `7000` | `3_initial_press_0` | `next_source` | | | `1002` | | `play` | | | `2001` | `move_0_255_0_0` | `hold_volume_up` | | | `2002`, `3002` | | `release` | | | `3001` | `move_1_255_0_0` | `hold_volume_down` | ### Example configuration ``` example_app: module: controllerx class: E2123MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2123MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2123MediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2123MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # IKEA E2201 ![IKEA E2201]() - **Manufacturer:** IKEA - **Device ID:** `E2201` - **Controller types:** [Light](<#light>) (`E2201LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E2201Z2MLightController`), [Media Player](<#media-player>) (`E2201MediaPlayerController`), [Switch](<#switch>) (`E2201SwitchController`), [Cover](<#cover>) (`E2201CoverController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `E2201LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `on` | | `"off"` | `2002` | `"off"` | `off` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `hold_brightness_up` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `hold_brightness_down` | | `brightness_stop` | `1003`, `2003` | `stop`, `stop_with_on_off` | `release` | ### Example configuration ``` example_app: module: controllerx class: E2201LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E2201LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: E2201LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E2201LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E2201Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: E2201Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E2201Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `E2201MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `play_pause` | | `"off"` | `2002` | `"off"` | `next_track` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `hold_volume_up` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `hold_volume_down` | | `brightness_stop` | `1003`, `2003` | `stop`, `stop_with_on_off` | `release` | ### Example configuration ``` example_app: module: controllerx class: E2201MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2201MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2201MediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: E2201MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` ## Switch - **Class:** `E2201SwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `on` | | `"off"` | `2002` | `"off"` | `off` | ### Example configuration ``` example_app: module: controllerx class: E2201SwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E2201SwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E2201SwitchController integration: deconz controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: E2201SwitchController integration: zha controller: 00:11:22:33:44:55:66:77:88 switch: switch.my_entity_id ``` ## Cover - **Class:** `E2201CoverController` - **Entity parameter:** `cover` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `"on"` | `1002` | `"on"` | `toggle_open` | | `"off"` | `2002` | `"off"` | `toggle_close` | | `brightness_move_up` | `1001` | `move_with_on_off_0_83` | `open` | | `brightness_move_down` | `2001` | `move_1_83_0_0` | `close` | | `brightness_stop` | `1003`, `2003` | `stop`, `stop_with_on_off` | `stop` | ### Example configuration ``` example_app: module: controllerx class: E2201CoverController integration: name: z2m listen_to: mqtt controller: my_controller cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E2201CoverController integration: name: z2m listen_to: event controller: my_controller_action cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E2201CoverController integration: deconz controller: my_controller cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: E2201CoverController integration: zha controller: 00:11:22:33:44:55:66:77:88 cover: cover.my_entity_id ``` # IKEA E2213 ![IKEA E2213]() - **Manufacturer:** IKEA - **Device ID:** `E2213` - **Controller types:** [Light](<#light>) (`E2213LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`E2213Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `E2213LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `1_long_press` | `hold_brightness_up` | | `2_long_press` | `hold_brightness_down` | | `1_short_release` | `on` | | `2_short_release` | `off` | | `1_long_release`, `2_long_release` | `release` | | `1_double_press` | `hold_color_up` | | `2_double_press` | `hold_color_down` | ### Example configuration ``` example_app: module: controllerx class: E2213LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: E2213LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `E2213Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `1_long_press` | `hold_brightness_up` | | `2_long_press` | `hold_brightness_down` | | `1_short_release` | `on` | | `2_short_release` | `off` | | `1_long_release`, `2_long_release` | `release` | | `1_double_press` | `hold_colortemp_up` | | `2_double_press` | `hold_colortemp_down` | ### Example configuration ``` example_app: module: controllerx class: E2213Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: E2213Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Livarno HG06323 ![Livarno HG06323]() - **Manufacturer:** Livarno - **Device ID:** `HG06323` - **Controller types:** [Light](<#light>) (`HG06323LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`HG06323Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `HG06323LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `"on"` | `"on"` | `on` | | `brightness_step_up` | `step_0_51_10` | `click_brightness_up` | | `brightness_move_up` | `move_0_51` | `hold_brightness_up` | | `brightness_stop` | `stop` | `release` | | `brightness_step_down` | `step_1_51_10` | `click_brightness_down` | | `brightness_move_down` | `move_1_51` | `hold_brightness_down` | | `"off"` | `"off"` | `off` | ### Example configuration ``` example_app: module: controllerx class: HG06323LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: HG06323LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: HG06323LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `HG06323Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `brightness_step_up` | `click_brightness_up` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_stop` | `release` | | `brightness_step_down` | `click_brightness_down` | | `brightness_move_down` | `hold_brightness_down` | | `"off"` | `off` | ### Example configuration ``` example_app: module: controllerx class: HG06323Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: HG06323Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Homematic HMPB2WM552 ![Homematic HMPB2WM552]() - **Manufacturer:** Homematic - **Device ID:** `HMPB2WM552` - **Controller types:** [Light](<#light>) (`HMPB2WM552LightController`) - **Integrations:** [Homematic]() (`homematic`) [Build the configuration for this device]() ## Light - **Class:** `HMPB2WM552LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Homematic | [Predefined action]() | | --- | --- | | `PRESS_SHORT_1` | `off` | | `PRESS_LONG_1` | `hold_brightness_down` | | `PRESS_CONT_1`, `PRESS_CONT_2` | *No action* | | `PRESS_LONG_RELEASE_1`, `PRESS_LONG_RELEASE_2` | `release` | | `PRESS_SHORT_2` | `on` | | `PRESS_LONG_2` | `hold_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: HMPB2WM552LightController integration: homematic controller: my_controller light: light.my_entity_id ``` # Homematic HMPB6WM55 ![Homematic HMPB6WM55]() - **Manufacturer:** Homematic - **Device ID:** `HMPB6WM55` - **Controller types:** [Light](<#light>) (`HMPB6WM55LightController`) - **Integrations:** [Homematic]() (`homematic`) [Build the configuration for this device]() ## Light - **Class:** `HMPB6WM55LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Homematic | [Predefined action]() | | --- | --- | | `PRESS_SHORT_1` | `off` | | `PRESS_CONT_1`, `PRESS_CONT_2`, `PRESS_CONT_3`, `PRESS_CONT_4`, `PRESS_CONT_5`, `PRESS_CONT_6` | *No action* | | `PRESS_LONG_1`, `PRESS_LONG_2` | `sync` | | `PRESS_LONG_RELEASE_1`, `PRESS_LONG_RELEASE_2`, `PRESS_LONG_RELEASE_3`, `PRESS_LONG_RELEASE_4`, `PRESS_LONG_RELEASE_5`, `PRESS_LONG_RELEASE_6` | `release` | | `PRESS_SHORT_2` | `on` | | `PRESS_SHORT_3` | `click_brightness_down` | | `PRESS_LONG_3` | `hold_brightness_down` | | `PRESS_SHORT_4` | `click_brightness_up` | | `PRESS_LONG_4` | `hold_brightness_up` | | `PRESS_SHORT_5` | `click_color_down` | | `PRESS_LONG_5` | `hold_color_down` | | `PRESS_SHORT_6` | `click_color_up` | | `PRESS_LONG_6` | `hold_color_up` | ### Example configuration ``` example_app: module: controllerx class: HMPB6WM55LightController integration: homematic controller: my_controller light: light.my_entity_id ``` # Homematic HMPBI4FM ![Homematic HMPBI4FM]() - **Manufacturer:** Homematic - **Device ID:** `HMPBI4FM` - **Controller types:** [Light](<#light>) (`HMPBI4FMLightController`) - **Integrations:** [Homematic]() (`homematic`) [Build the configuration for this device]() ## Light - **Class:** `HMPBI4FMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Homematic | [Predefined action]() | | --- | --- | | `PRESS_SHORT_1` | `off` | | `PRESS_CONT_1`, `PRESS_CONT_2`, `PRESS_CONT_3`, `PRESS_CONT_4` | *No action* | | `PRESS_LONG_1` | `click_color_down` | | `PRESS_SHORT_2` | `on` | | `PRESS_LONG_2` | `click_color_up` | | `PRESS_SHORT_3` | `click_brightness_down` | | `PRESS_LONG_3` | `on_min_brightness` | | `PRESS_SHORT_4` | `click_brightness_up` | | `PRESS_LONG_4` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: HMPBI4FMLightController integration: homematic controller: my_controller light: light.my_entity_id ``` # Homematic HMSenMDIRWM55 ![Homematic HMSenMDIRWM55]() - **Manufacturer:** Homematic - **Device ID:** `HMSenMDIRWM55` - **Controller types:** [Light](<#light>) (`HMSenMDIRWM55LightController`) - **Integrations:** [Homematic]() (`homematic`) [Build the configuration for this device]() ## Light - **Class:** `HMSenMDIRWM55LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Homematic | [Predefined action]() | | --- | --- | | `PRESS_SHORT_1` | `off` | | `PRESS_LONG_1` | `hold_brightness_down` | | `PRESS_CONT_1`, `PRESS_CONT_2` | *No action* | | `PRESS_LONG_RELEASE_1`, `PRESS_LONG_RELEASE_2` | `release` | | `PRESS_SHORT_2` | `on` | | `PRESS_LONG_2` | `hold_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: HMSenMDIRWM55LightController integration: homematic controller: my_controller light: light.my_entity_id ``` # Philips HueDimmer ![Philips HueDimmer]() - **Manufacturer:** Philips - **Device ID:** `HueDimmer` - **Controller types:** [Light](<#light>) (`HueDimmerController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`HueDimmerZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes When using **z2m**, the device needs to be flagged as `legacy: false`, as the [Zigbee2MQTT documentation recommends](). When using **z2m** and the multiple clicks functionality, make sure to remove the `multiple_press_timeout` option from the device-specific configuration (`devices.yaml`). When using **deCONZ**, all the click actions are mapped to the X002 actions, which are fired when the button is released after being clicked. ## Light - **Class:** `HueDimmerController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `on_press_release` | `1002` | `on_short_release` | `on` | | `on_hold` | `1001` | `on_hold` | `hold_color_up` | | `on_hold_release`, `up_hold_release`, `down_hold_release`, `off_hold_release` | `1003`, `2003`, `3003`, `4003` | `off_long_release`, `down_long_release`, `up_long_release`, `on_long_release` | `release` | | `up_press_release` | `2002` | `up_short_release` | `click_brightness_up` | | `up_hold` | `2001` | `up_hold` | `hold_brightness_up` | | `down_press_release` | `3002` | `down_short_release` | `click_brightness_down` | | `down_hold` | `3001` | `down_hold` | `hold_brightness_down` | | `off_press_release` | `4002` | `off_short_release` | `off` | | `off_hold` | `4001` | `off_hold` | `hold_color_down` | ### Example configuration ``` example_app: module: controllerx class: HueDimmerController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: HueDimmerController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: HueDimmerController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: HueDimmerController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `HueDimmerZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `on_press_release` | `on` | | `on_hold` | `hold_colortemp_up` | | `on_hold_release`, `up_hold_release`, `down_hold_release`, `off_hold_release` | `release` | | `up_press_release` | `click_brightness_up` | | `up_hold` | `hold_brightness_up` | | `down_press_release` | `click_brightness_down` | | `down_hold` | `hold_brightness_down` | | `off_press_release` | `off` | | `off_hold` | `hold_colortemp_down` | ### Example configuration ``` example_app: module: controllerx class: HueDimmerZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: HueDimmerZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Philips HueSmartButton ![Philips HueSmartButton]() - **Manufacturer:** Philips - **Device ID:** `HueSmartButton` - **Controller types:** [Light](<#light>) (`HueSmartButtonLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`HueSmartButtonZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Light - **Class:** `HueSmartButtonLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `"on"`, `"off"` | `1002` | `toggle` | | `hold` | `1001` | `hold_brightness_toggle` | | `release` | `1003` | `release` | | | `1000` | *No action* | ### Example configuration ``` example_app: module: controllerx class: HueSmartButtonLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: HueSmartButtonLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: HueSmartButtonLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `HueSmartButtonZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"`, `"off"` | `toggle` | | `hold` | `hold_brightness_toggle` | | `release` | `release` | ### Example configuration ``` example_app: module: controllerx class: HueSmartButtonZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: HueSmartButtonZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # IKEA ICTCG1 ![IKEA ICTCG1]() - **Manufacturer:** IKEA - **Device ID:** `ICTCG1` - **Controller types:** [Light](<#light>) (`ICTCG1Controller`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`ICTCG1Z2MLightController`), [Media Player](<#media-player>) (`ICTCG1MediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `ICTCG1Controller` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `brightness_move_up` | | `move_with_on_off_0_70` | `hold_brightness_up` | | `brightness_move_down` | | `move_1_70`, `move_1_195` | `hold_brightness_down` | | `brightness_stop` | | `stop` | `release` | | `brightness_move_to_level` | | | `brightness_from_controller_level` | | | `1002` | `move_to_level_with_on_off_255_1` | `rotate_right_quick` | | | `2002` | | `click_brightness_up` | | | `3002` | | `click_brightness_down` | | | `4002` | `move_to_level_with_on_off_0_1` | `rotate_left_quick` | | | | `move_with_on_off_0_195` | `on` | ### Example configuration ``` example_app: module: controllerx class: ICTCG1Controller integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: ICTCG1Controller integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: ICTCG1Controller integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: ICTCG1Controller integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `ICTCG1Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `brightness_move_to_level` | `brightness_from_controller_level` | ### Example configuration ``` example_app: module: controllerx class: ICTCG1Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: ICTCG1Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `ICTCG1MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `brightness_move_up` | | `move_with_on_off_0_70`, `move_with_on_off_0_195` | `hold_volume_up` | | `brightness_move_down` | | `move_1_70`, `move_1_195` | `hold_volume_down` | | `brightness_stop` | | `stop` | `release` | | | `1002` | `move_to_level_with_on_off_255_1` | `rotate_right_quick` | | | `2002` | | `click_volume_up` | | | `3002` | | `click_volume_down` | | | `4002` | `move_to_level_with_on_off_0_1` | `rotate_left_quick` | ### Example configuration ``` example_app: module: controllerx class: ICTCG1MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: ICTCG1MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: ICTCG1MediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: ICTCG1MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # Lutron LZL4BWHL01 ![Lutron LZL4BWHL01]() - **Manufacturer:** Lutron - **Device ID:** `LZL4BWHL01` - **Controller types:** [Light](<#light>) (`LZL4BWHL01LightController`) - **Integrations:** [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `LZL4BWHL01LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | | `1002` | `move_to_level_with_on_off_254_4` | `on_full_brightness` | | `2001` | `step_with_on_off_0_30_6` | `hold_brightness_up` | | `2003`, `3003` | `stop` | `release` | | `3001` | `step_1_30_6` | `hold_brightness_down` | | `4002` | `move_to_level_with_on_off_0_4` | `off` | ### Example configuration ``` example_app: module: controllerx class: LZL4BWHL01LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: LZL4BWHL01LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Legrand 600083 ![Legrand 600083]() - **Manufacturer:** Legrand - **Device ID:** `Legrand600083` - **Controller types:** [Light](<#light>) (`Legrand600083LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`Legrand600083Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `Legrand600083LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `"on"` | `1_on` | `on` | | `"off"` | `1_off` | `off` | | `brightness_move_up` | `1_move_up` | `hold_brightness_up` | | `brightness_move_down` | `1_move_down` | `hold_brightness_down` | | `brightness_stop` | `1_stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: Legrand600083LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Legrand600083LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: Legrand600083LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `Legrand600083Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: Legrand600083Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: Legrand600083Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Legrand 600088 ![Legrand 600088]() - **Manufacturer:** Legrand - **Device ID:** `Legrand600088` - **Controller types:** [Light](<#light>) (`Legrand600088LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`Legrand600088Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `Legrand600088LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `on_left` | `1_on` | `on` | | `off_left` | `1_off` | `off` | | `brightness_move_up_left` | `1_move_up` | `hold_color_up` | | `brightness_move_down_left` | `1_move_down` | `hold_color_down` | | `brightness_stop_left`, `brightness_stop_right` | `1_stop`, `2_stop` | `release` | | `on_right` | `2_on` | `on_full_brightness` | | `off_right` | `2_off` | `on_min_brightness` | | `brightness_move_up_right` | `2_move_up` | `hold_brightness_up` | | `brightness_move_down_right` | `2_move_down` | `hold_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: Legrand600088LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Legrand600088LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: Legrand600088LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `Legrand600088Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `on_left` | `on` | | `off_left` | `off` | | `brightness_move_up_left` | `hold_colortemp_up` | | `brightness_move_down_left` | `hold_colortemp_down` | | `brightness_stop_left`, `brightness_stop_right` | `release` | | `on_right` | `on_full_brightness` | | `off_right` | `on_min_brightness` | | `brightness_move_up_right` | `hold_brightness_up` | | `brightness_move_down_right` | `hold_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: Legrand600088Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: Legrand600088Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Lutron PJ22B ![Lutron PJ22B]() - **Manufacturer:** Lutron - **Device ID:** `LutronPJ22B` - **Controller types:** [Light](<#light>) (`LutronPJ22BLightController`), [Media Player](<#media-player>) (`LutronPJ22BMediaPlayerController`) - **Integrations:** [State]() (`state`), [Lutron Caseta]() (`lutron_caseta`) [Build the configuration for this device]() ## Notes For the State integration, it requires the [LutronCasetaPro]() **custom** integration by upsert. **This will not work with the default Lutron Caseta integration.** All Lutron Caseta Pro Pico remotes supported by LutronCasetaPro are supported using this controller type, except for the 4-button PJ2-4B remotes, which have their own controller. ## Light - **Class:** `LutronPJ22BLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | Lutron Caseta | [Predefined action]() | | --- | --- | --- | | `1` | | `on_full_brightness` | | `4` | `button_4_press` | `off` | | | `button_2_press` | `on` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ22BLightController integration: state controller: sensor.my_custom_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: LutronPJ22BLightController integration: lutron_caseta controller: 87654321 light: light.my_entity_id ``` ## Media Player - **Class:** `LutronPJ22BMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | Lutron Caseta | [Predefined action]() | | --- | --- | --- | | `1` | `button_2_press` | `play_pause` | | `4` | `button_4_press` | `next_track` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ22BMediaPlayerController integration: state controller: sensor.my_custom_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: LutronPJ22BMediaPlayerController integration: lutron_caseta controller: 87654321 media_player: media_player.my_entity_id ``` # Lutron PJ22BRL ![Lutron PJ22BRL]() - **Manufacturer:** Lutron - **Device ID:** `LutronPJ22BRL` - **Controller types:** [Light](<#light>) (`LutronPJ22BRLLightController`), [Media Player](<#media-player>) (`LutronPJ22BRLMediaPlayerController`) - **Integrations:** [State]() (`state`) [Build the configuration for this device]() ## Notes For the State integration, it requires the [LutronCasetaPro]() **custom** integration by upsert. **This will not work with the default Lutron Caseta integration.** All Lutron Caseta Pro Pico remotes supported by LutronCasetaPro are supported using this controller type, except for the 4-button PJ2-4B remotes, which have their own controller. ## Light - **Class:** `LutronPJ22BRLLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | [Predefined action]() | | --- | --- | | `1` | `on_full_brightness` | | `8` | `hold_brightness_up` | | `16` | `hold_brightness_down` | | `4` | `off` | | `0` | `release` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ22BRLLightController integration: state controller: sensor.my_custom_controller light: light.my_entity_id ``` ## Media Player - **Class:** `LutronPJ22BRLMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | [Predefined action]() | | --- | --- | | `1` | `play_pause` | | `8` | `hold_volume_up` | | `16` | `hold_volume_down` | | `4` | `next_track` | | `0` | `release` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ22BRLMediaPlayerController integration: state controller: sensor.my_custom_controller media_player: media_player.my_entity_id ``` # Lutron PJ23BRL ![Lutron PJ23BRL]() - **Manufacturer:** Lutron - **Device ID:** `LutronPJ23BRL` - **Controller types:** [Light](<#light>) (`LutronPJ23BRLLightController`), [Media Player](<#media-player>) (`LutronPJ23BRLMediaPlayerController`) - **Integrations:** [State]() (`state`), [Lutron Caseta]() (`lutron_caseta`) [Build the configuration for this device]() ## Notes For the State integration, it requires the [LutronCasetaPro]() **custom** integration by upsert. **This will not work with the default Lutron Caseta integration.** All Lutron Caseta Pro Pico remotes supported by LutronCasetaPro are supported using this controller type, except for the 4-button PJ2-4B remotes, which have their own controller. ## Light - **Class:** `LutronPJ23BRLLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | Lutron Caseta | [Predefined action]() | | --- | --- | --- | | `1` | `button_2_press` | `on_full_brightness` | | `8` | `button_5_press` | `hold_brightness_up` | | `2` | `button_3_press` | `set_half_brightness` | | `16` | `button_6_press` | `hold_brightness_down` | | `4` | `button_4_press` | `off` | | `0` | `button_5_release`, `button_6_release` | `release` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ23BRLLightController integration: state controller: sensor.my_custom_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: LutronPJ23BRLLightController integration: lutron_caseta controller: 87654321 light: light.my_entity_id ``` ## Media Player - **Class:** `LutronPJ23BRLMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | Lutron Caseta | [Predefined action]() | | --- | --- | --- | | `1` | `button_2_press` | `play_pause` | | `8` | `button_5_press` | `hold_volume_up` | | `2` | `button_3_press` | `next_source` | | `16` | `button_6_press` | `hold_volume_down` | | `4` | `button_4_press` | `next_track` | | `0` | `button_5_release`, `button_6_release` | `release` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ23BRLMediaPlayerController integration: state controller: sensor.my_custom_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: LutronPJ23BRLMediaPlayerController integration: lutron_caseta controller: 87654321 media_player: media_player.my_entity_id ``` # Lutron PJ24B ![Lutron PJ24B]() - **Manufacturer:** Lutron - **Device ID:** `LutronPJ24B` - **Controller types:** [Light](<#light>) (`LutronPJ24BLightController`), [Media Player](<#media-player>) (`LutronPJ24BMediaPlayerController`) - **Integrations:** [State]() (`state`) [Build the configuration for this device]() ## Notes For the State integration, it requires the [LutronCasetaPro]() **custom** integration by upsert. **This will not work with the default Lutron Caseta integration.** ## Light - **Class:** `LutronPJ24BLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | [Predefined action]() | | --- | --- | | `1` | `on_full_brightness` | | `2` | `hold_brightness_up` | | `4` | `hold_brightness_down` | | `8` | `off` | | `0` | `release` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ24BLightController integration: state controller: sensor.my_custom_controller light: light.my_entity_id ``` ## Media Player - **Class:** `LutronPJ24BMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | State | [Predefined action]() | | --- | --- | | `1` | `play_pause` | | `2` | `hold_volume_up` | | `4` | `hold_volume_down` | | `8` | `next_track` | | `0` | `release` | ### Example configuration ``` example_app: module: controllerx class: LutronPJ24BMediaPlayerController integration: state controller: sensor.my_custom_controller media_player: media_player.my_entity_id ``` # Aqara MFKZQ01LM ![Aqara MFKZQ01LM]() - **Manufacturer:** Aqara - **Device ID:** `MFKZQ01LM` - **Controller types:** [Light](<#light>) (`MFKZQ01LMLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes This controller does not have a self-explanatory way to be used, since its main purpose is to be customized. This is why we recommend customizing it with a [custom mapping](). The deCONZ integration should be added with [type gesture](). ## Light - **Class:** `MFKZQ01LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `shake` | `1` | `shake` | `on_min_brightness` | | `tap` | `6` | `knock` | `toggle` | | `slide` | `5` | `slide` | `on_full_brightness` | | `flip180` | `4` | `flip180` | `click_color_up` | | `flip90` | `3` | `flip90` | `click_color_down` | | `rotate_left` | `8` | `rotate_left` | `click_brightness_down` | | `rotate_right` | `7` | `rotate_right` | `click_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: MFKZQ01LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: MFKZQ01LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: MFKZQ01LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: MFKZQ01LMLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Müller Licht MLI404002 ![Müller Licht MLI404002]() - **Manufacturer:** Müller Licht - **Device ID:** `MLI404002` - **Controller types:** [Light](<#light>) (`MLI404002LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`MLI404002Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `MLI404002LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `"on"`, `"off"` | `"on"`, `"off"` | `toggle` | | `brightness_step_up` | `step_up` | `click_brightness_up` | | `brightness_step_down` | `step_down` | `click_brightness_down` | | `brightness_move_up` | `move_up` | `hold_brightness_up` | | `brightness_move_down` | `move_down` | `hold_brightness_down` | | `brightness_stop` | `stop` | `release` | | `recall_1` | `recall` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: MLI404002LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: MLI404002LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: MLI404002LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `MLI404002Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"`, `"off"` | `toggle` | | `brightness_step_up` | `click_brightness_up` | | `brightness_step_down` | `click_brightness_down` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `recall_1` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: MLI404002Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: MLI404002Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Müller Licht MLI404011 ![Müller Licht MLI404011]() - **Manufacturer:** Müller Licht - **Device ID:** `MLI404011` - **Controller types:** [Light](<#light>) (`MLI404011LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`MLI404011Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Notes Some buttons are not mapped yet for either integration. Read more about it [here (deCONZ)]() and [here (z2m)](). ## Light - **Class:** `MLI404011LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `"on"`, `"off"` | `1002` | `toggle` | | `brightness_down_click` | `3002` | `click_brightness_down` | | `brightness_down_hold` | `3001` | `hold_brightness_down` | | `brightness_down_release`, `brightness_up_release` | `2003`, `3003` | `release` | | `brightness_up_click` | `2002` | `click_brightness_up` | | `brightness_up_hold` | `2001` | `hold_brightness_up` | | `color_wheel` | `6002` | `xycolor_from_controller` | | `color_temp` | | `colortemp_from_controller` | | `scene_1`, `scene_2`, `scene_3`, `scene_4`, `scene_5`, `scene_6` | `7002`, `8002`, `9002`, `10002`, `11002`, `12002` | *No action* | | | `4002` | `click_color_up` | | | `5002` | `click_color_down` | ### Example configuration ``` example_app: module: controllerx class: MLI404011LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: MLI404011LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: MLI404011LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `MLI404011Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"`, `"off"` | `toggle` | | `brightness_down_click` | `click_brightness_down` | | `brightness_down_hold` | `hold_brightness_down` | | `brightness_down_release`, `brightness_up_release` | `release` | | `brightness_up_click` | `click_brightness_up` | | `brightness_up_hold` | `hold_brightness_up` | | `color_wheel` | `xycolor_from_controller` | | `color_temp` | `colortemp_from_controller` | | `scene_1`, `scene_2`, `scene_3`, `scene_4`, `scene_5`, `scene_6` | *No action* | ### Example configuration ``` example_app: module: controllerx class: MLI404011Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: MLI404011Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Namron 4512773 ![Namron 4512773]() - **Manufacturer:** Namron - **Device ID:** `Namron4512773` - **Controller types:** [Light](<#light>) (`Namron4512773LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`Namron4512773Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Notes The Namron 4512773 has four groups, and with swappable physical buttons it is intended to control one, two, or four buttons. To make this work with ControllerX, you can use one app per light you want to control. ## Light - **Class:** `Namron4512773LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `on_l1`, `on_l2`, `on_l3`, `on_l4` | `on` | | `off_l1`, `off_l2`, `off_l3`, `off_l4` | `off` | | `brightness_move_up_l1`, `brightness_move_up_l2`, `brightness_move_up_l3`, `brightness_move_up_l4` | `hold_brightness_up` | | `brightness_move_down_l1`, `brightness_move_down_l2`, `brightness_move_down_l3`, `brightness_move_down_l4` | `hold_brightness_down` | | `brightness_stop_l1`, `brightness_stop_l2`, `brightness_stop_l3`, `brightness_stop_l4` | `release` | ### Example configuration ``` example_app: module: controllerx class: Namron4512773LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Namron4512773LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `Namron4512773Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `on_l1`, `on_l2`, `on_l3`, `on_l4` | `on` | | `off_l1`, `off_l2`, `off_l3`, `off_l4` | `off` | | `brightness_move_up_l1`, `brightness_move_up_l2`, `brightness_move_up_l3`, `brightness_move_up_l4` | `hold_brightness_up` | | `brightness_move_down_l1`, `brightness_move_down_l2`, `brightness_move_down_l3`, `brightness_move_down_l4` | `hold_brightness_down` | | `brightness_stop_l1`, `brightness_stop_l2`, `brightness_stop_l3`, `brightness_stop_l4` | `release` | ### Example configuration ``` example_app: module: controllerx class: Namron4512773Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: Namron4512773Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # OSRAM AC025XX00NJ ![OSRAM AC025XX00NJ]() - **Manufacturer:** OSRAM - **Device ID:** `OsramAC025XX00NJ` - **Controller types:** [Light](<#light>) (`OsramAC025XX00NJLightController`) - **Integrations:** [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes This controller is supported for AC0251100NJ / AC0251400NJ / AC0251600NJ / AC0251700NJ. The different models are just different colours. ## Light - **Class:** `OsramAC025XX00NJLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | | `1002` | `1_on` | `on` | | `1001` | `1_move_with_on_off` | `hold_brightness_up` | | `1003`, `2003`, `3003` | `1_stop`, `3_move_hue`, `2_stop` | `release` | | `2002` | `2_off` | `off` | | `2001` | `2_move` | `hold_brightness_down` | | `3002` | `3_move_to_color_temp` | `sync` | | `3001` | `3_move_to_saturation` | `hold_color_up` | | | `3_move_to_level_with_on_off` | *No action* | ### Example configuration ``` example_app: module: controllerx class: OsramAC025XX00NJLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: OsramAC025XX00NJLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Philips PTM215X ![Philips PTM215X]() - **Manufacturer:** Philips - **Device ID:** `PTM215X` - **Controller types:** [Light](<#light>) (`PTM215XLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Notes Check the button mapping [here](). ## Light - **Class:** `PTM215XLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `press_1` | `1002` | `on` | | `release_1`, `release_2`, `release_3`, `release_4`, `release_1_and_3`, `release_2_and_4` | `3003`, `4003`, `5003`, `6003` | `release` | | `press_2` | `2002` | `off` | | `press_3` | `3002` | `on_full_brightness` | | `press_4` | `4002` | `on_min_brightness` | | `press_1_and_3` | `5002` | `on_full_color_temp` | | `press_2_and_4` | `6002` | `on_min_color_temp` | | `press_energy_bar` | `1001`, `2001` | `sync` | | | `1000`, `1003`, `2000`, `2003`, `3000`, `4000`, `5000`, `6000` | *No action* | | | `3001` | `hold_brightness_up` | | | `4001` | `hold_brightness_down` | | | `5001` | `hold_color_up` | | | `6001` | `hold_color_down` | ### Example configuration ``` example_app: module: controllerx class: PTM215XLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: PTM215XLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: PTM215XLightController integration: deconz controller: my_controller light: light.my_entity_id ``` # Philips 929002398602 ![Philips 929002398602]() - **Manufacturer:** Philips - **Device ID:** `Philips929002398602` - **Controller types:** [Light](<#light>) (`Philips929002398602LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`Philips929002398602Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `Philips929002398602LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `on_press_release`, `on_hold` | `1002`, `1001` | `on_hold`, `on_short_release` | `toggle` | | `on_hold_release`, `up_hold_release`, `down_hold_release`, `off_hold_release` | `1003`, `2003`, `3003`, `4003` | `off_long_release`, `down_long_release`, `up_long_release`, `on_long_release` | `release` | | `up_press_release` | `2002` | `up_short_release` | `click_brightness_up` | | `up_hold` | `2001` | `up_hold` | `hold_brightness_up` | | `down_press_release` | `3002` | `down_short_release` | `click_brightness_down` | | `down_hold` | `3001` | `down_hold` | `hold_brightness_down` | | `off_press_release` | `4002` | `off_short_release` | `click_color_up` | | `off_hold` | `4001` | `off_hold` | `hold_color_down` | ### Example configuration ``` example_app: module: controllerx class: Philips929002398602LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Philips929002398602LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: Philips929002398602LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Philips929002398602LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `Philips929002398602Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `on_press_release` | `on` | | `on_hold` | `hold_colortemp_up` | | `on_hold_release`, `up_hold_release`, `down_hold_release`, `off_hold_release` | `release` | | `up_press_release` | `click_brightness_up` | | `up_hold` | `hold_brightness_up` | | `down_press_release` | `click_brightness_down` | | `down_hold` | `hold_brightness_down` | | `off_press_release` | `off` | | `off_hold` | `hold_colortemp_down` | ### Example configuration ``` example_app: module: controllerx class: Philips929002398602Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: Philips929002398602Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Philips 929003017102 ![Philips 929003017102]() - **Manufacturer:** Philips - **Device ID:** `Philips929003017102` - **Controller types:** [Light](<#light>) (`Philips929003017102LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`Philips929003017102Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes This controller has 4 modes, and depending on which one is used, it will trigger one action or another: single\_rocker, single\_push\_button, dual\_rocker, dual\_push\_button. You can read more about it in these threads: [deCONZ]() and [Zigbee2MQTT](). ## Light - **Class:** `Philips929003017102LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `left_press_release`, `right_press_release` | `1002`, `2002` | `left_press_release`, `right_short_release` | `toggle` | | `left_hold`, `right_hold` | `1001`, `2001` | `left_hold`, `right_hold` | `hold_brightness_toggle` | | `left_hold_release`, `right_hold_release` | `1003`, `2003` | `left_hold_release`, `right_long_release` | `release` | | | `1000`, `2000` | | *No action* | ### Example configuration ``` example_app: module: controllerx class: Philips929003017102LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Philips929003017102LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: Philips929003017102LightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Philips929003017102LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `Philips929003017102Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `left_press_release`, `right_press_release` | `toggle` | | `left_hold`, `right_hold` | `hold_brightness_toggle` | | `left_hold_release`, `right_hold_release` | `release` | ### Example configuration ``` example_app: module: controllerx class: Philips929003017102Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: Philips929003017102Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Philips RDM002 ![Philips RDM002]() - **Manufacturer:** Philips - **Device ID:** `PhilipsRDM002` - **Controller types:** [Light](<#light>) (`PhilipsRDM002LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`PhilipsRDM002Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `PhilipsRDM002LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `button_1_press_release` | `off` | | `button_1_hold` | `hold_brightness_down` | | `button_1_hold_release`, `button_2_hold_release`, `button_3_hold_release`, `button_4_hold_release` | `release` | | `button_2_press_release` | `on` | | `button_2_hold` | `hold_brightness_up` | | `button_3_press_release` | `click_color_down` | | `button_3_hold` | `hold_color_down` | | `button_4_press_release` | `click_color_up` | | `button_4_hold` | `hold_color_up` | | `dial_rotate_left_step` | `click_brightness_down` | | `dial_rotate_left_slow` | `on_min_color_temp` | | `dial_rotate_left_fast` | `on_min_brightness` | | `dial_rotate_right_step` | `click_brightness_up` | | `dial_rotate_right_slow` | `on_full_color_temp` | | `dial_rotate_right_fast` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: PhilipsRDM002LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: PhilipsRDM002LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `PhilipsRDM002Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `button_1_press_release` | `off` | | `button_1_hold` | `hold_brightness_down` | | `button_1_hold_release`, `button_2_hold_release`, `button_3_hold_release`, `button_4_hold_release` | `release` | | `button_2_press_release` | `on` | | `button_2_hold` | `hold_brightness_up` | | `button_3_press_release` | `click_colortemp_down` | | `button_3_hold` | `hold_colortemp_down` | | `button_4_press_release` | `click_colortemp_up` | | `button_4_hold` | `hold_colortemp_up` | | `dial_rotate_left_step` | `click_brightness_down` | | `dial_rotate_left_slow` | `on_min_color_temp` | | `dial_rotate_left_fast` | `on_min_brightness` | | `dial_rotate_right_step` | `click_brightness_up` | | `dial_rotate_right_slow` | `on_full_color_temp` | | `dial_rotate_right_fast` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: PhilipsRDM002Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: PhilipsRDM002Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Prolight 5412748727388 ![Prolight 5412748727388]() - **Manufacturer:** Prolight - **Device ID:** `Prolight5412748727388` - **Controller types:** [Light](<#light>) (`Prolight5412748727388LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`Prolight5412748727388Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `Prolight5412748727388LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `brightness_move_to_level` | `brightness_from_controller_level` | | `color_temperature_move` | `colortemp_from_controller` | | `color_temperature_move_up` | `click_colortemp_up` | | `color_temperature_move_down` | `click_colortemp_down` | | `color_move` | `xycolor_from_controller` | ### Example configuration ``` example_app: module: controllerx class: Prolight5412748727388LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Prolight5412748727388LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `Prolight5412748727388Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `brightness_move_to_level` | `brightness_from_controller_level` | | `color_temperature_move` | `colortemp_from_controller` | | `color_temperature_move_up` | `click_colortemp_up` | | `color_temperature_move_down` | `click_colortemp_down` | | `color_move` | `xycolor_from_controller` | ### Example configuration ``` example_app: module: controllerx class: Prolight5412748727388Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: Prolight5412748727388Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # ROBB ROB2000070 ![ROBB ROB2000070]() - **Manufacturer:** ROBB - **Device ID:** `ROB2000070` - **Controller types:** [Light](<#light>) (`ROB2000070LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`ROB2000070Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Notes Note that each button performs the same actions. This is because ControllerX is designed to control just one entity (light or media player). So, you can include the `actions` parameter to include the actions needed, or use the `mapping` attribute to define a [custom mapping](). You can check [here]() for reference. This controller is a white-label version of the Sunricher SR-ZG9001K8-DIM. ## Light - **Class:** `ROB2000070LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `on_1`, `on_2`, `on_3`, `on_4` | `on` | | `off_1`, `off_2`, `off_3`, `off_4` | `off` | | `brightness_move_up_1`, `brightness_move_up_2`, `brightness_move_up_3`, `brightness_move_up_4` | `hold_brightness_up` | | `brightness_move_down_1`, `brightness_move_down_2`, `brightness_move_down_3`, `brightness_move_down_4` | `hold_brightness_down` | | `brightness_stop_1`, `brightness_stop_2`, `brightness_stop_3`, `brightness_stop_4` | `release` | ### Example configuration ``` example_app: module: controllerx class: ROB2000070LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: ROB2000070LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `ROB2000070Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `on_1`, `on_2`, `on_3`, `on_4` | `on` | | `off_1`, `off_2`, `off_3`, `off_4` | `off` | | `brightness_move_up_1`, `brightness_move_up_2`, `brightness_move_up_3`, `brightness_move_up_4` | `hold_brightness_up` | | `brightness_move_down_1`, `brightness_move_down_2`, `brightness_move_down_3`, `brightness_move_down_4` | `hold_brightness_down` | | `brightness_stop_1`, `brightness_stop_2`, `brightness_stop_3`, `brightness_stop_4` | `release` | ### Example configuration ``` example_app: module: controllerx class: ROB2000070Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: ROB2000070Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Smartkontakten SK5700002228949 ![Smartkontakten SK5700002228949]() - **Manufacturer:** Smartkontakten - **Device ID:** `SK5700002228949` - **Controller types:** [Light](<#light>) (`SK5700002228949LightController`) - **Integrations:** [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Light - **Class:** `SK5700002228949LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | deCONZ | [Predefined action]() | | --- | --- | | `1002` | `on` | | `1001` | `hold_brightness_up` | | `1003`, `3003`, `2003`, `4003` | `release` | | `3002` | `off` | | `3001` | `hold_brightness_down` | | `2002` | `click_color_up` | | `2001` | `hold_color_up` | | `4002` | `click_color_down` | | `4001` | `hold_color_down` | ### Example configuration ``` example_app: module: controllerx class: SK5700002228949LightController integration: deconz controller: my_controller light: light.my_entity_id ``` # SONOFF SNZB01 ![SONOFF SNZB01]() - **Manufacturer:** SONOFF - **Device ID:** `SNZB01` - **Controller types:** [Light](<#light>) (`SNZB01LightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `SNZB01LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `single` | `toggle` | `toggle` | | `double` | `"on"` | `on_full_brightness` | | `long` | `"off"` | `on_min_brightness` | ### Example configuration ``` example_app: module: controllerx class: SNZB01LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: SNZB01LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: SNZB01LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Shelly 25 ![Shelly 25]() - **Manufacturer:** Shelly - **Device ID:** `Shelly25` - **Controller types:** [Light](<#light>) (`Shelly25LightController`) - **Integrations:** [Shelly]() (`shelly`) [Build the configuration for this device]() ## Light - **Class:** `Shelly25LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Shelly | [Predefined action]() | | --- | --- | | `single_push_1` | `on` | | `long_push_1` | `hold_brightness_up` | | `btn_up_1`, `btn_up_2` | `release` | | `double_push_1` | `on_full_brightness` | | `single_push_2` | `off` | | `long_push_2` | `hold_brightness_down` | | `double_push_2` | `on_min_brightness` | ### Example configuration ``` example_app: module: controllerx class: Shelly25LightController integration: shelly controller: shellybutton-ABC123456 light: light.my_entity_id ``` # Shelly Dimmer2 ![Shelly Dimmer2]() - **Manufacturer:** Shelly - **Device ID:** `ShellyDimmer2` - **Controller types:** [Light](<#light>) (`ShellyDimmer2LightController`) - **Integrations:** [Shelly]() (`shelly`) [Build the configuration for this device]() ## Light - **Class:** `ShellyDimmer2LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Shelly | [Predefined action]() | | --- | --- | | `single_1`, `long_1` | `toggle` | | `single_2`, `long_2` | *No action* | ### Example configuration ``` example_app: module: controllerx class: ShellyDimmer2LightController integration: shelly controller: shellybutton-ABC123456 light: light.my_entity_id ``` # Shelly I3 ![Shelly I3]() - **Manufacturer:** Shelly - **Device ID:** `ShellyI3` - **Controller types:** [Light](<#light>) (`ShellyI3LightController`) - **Integrations:** [ShellyForHass]() (`shellyforhass`) [Build the configuration for this device]() ## Light - **Class:** `ShellyI3LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ShellyForHass | [Predefined action]() | | --- | --- | | `single` | `click_brightness_up` | | `long` | `click_brightness_down` | | `double` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: ShellyI3LightController integration: shellyforhass controller: binary_sensor.shelly_button_switch light: light.my_entity_id ``` # Shelly PlusI4 ![Shelly PlusI4]() - **Manufacturer:** Shelly - **Device ID:** `ShellyPlusI4` - **Controller types:** [Light](<#light>) (`ShellyPlusI4LightController`) - **Integrations:** [Shelly]() (`shelly`) [Build the configuration for this device]() ## Light - **Class:** `ShellyPlusI4LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Shelly | [Predefined action]() | | --- | --- | | `single_push_1` | `on` | | `long_push_1` | `hold_color_up` | | `btn_up_1`, `btn_up_2`, `btn_up_3`, `btn_up_4` | `release` | | `double_push_1` | `on_full_color_temp` | | `single_push_2` | `off` | | `long_push_2` | `hold_color_down` | | `double_push_2` | `on_min_color_temp` | | `single_push_3` | `click_brightness_up` | | `long_push_3` | `hold_brightness_up` | | `double_push_3` | `on_full_brightness` | | `single_push_4` | `click_brightness_down` | | `long_push_4` | `hold_brightness_down` | | `double_push_4` | `on_min_brightness` | ### Example configuration ``` example_app: module: controllerx class: ShellyPlusI4LightController integration: shelly controller: shellybutton-ABC123456 light: light.my_entity_id ``` # SmartThings Button ![SmartThings Button]() - **Manufacturer:** SmartThings - **Device ID:** `SmartThingsButton` - **Controller types:** [Light](<#light>) (`SmartThingsButtonLightController`), [Media Player](<#media-player>) (`SmartThingsButtonMediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `SmartThingsButtonLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single` | `1002` | `button_single_1_0_0_0` | `toggle` | | `double` | `1004` | `button_double_2_0_0_0` | `on_full_brightness` | | `hold` | `1001` | `button_hold_3_0_0_0` | `set_half_brightness` | ### Example configuration ``` example_app: module: controllerx class: SmartThingsButtonLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: SmartThingsButtonLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: SmartThingsButtonLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: SmartThingsButtonLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Media Player - **Class:** `SmartThingsButtonMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single_click` | `1002` | `button_single_1_0_0_0` | `play_pause` | | `double_click` | `1004` | `button_double_2_0_0_0` | `next_track` | | `hold` | `1001` | `button_hold_3_0_0_0` | `previous_track` | ### Example configuration ``` example_app: module: controllerx class: SmartThingsButtonMediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: SmartThingsButtonMediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: SmartThingsButtonMediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: SmartThingsButtonMediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # Tuya TS0042 ![Tuya TS0042]() - **Manufacturer:** Tuya - **Device ID:** `TS0042` - **Controller types:** [Light](<#light>) (`TS0042LightController`) - **Integrations:** [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `TS0042LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ZHA | [Predefined action]() | | --- | --- | | `1_remote_button_short_press` | `on` | | `1_remote_button_double_press` | `click_brightness_up` | | `1_remote_button_long_press` | `on_full_brightness` | | `2_remote_button_short_press` | `off` | | `2_remote_button_double_press` | `on_min_brightness` | ### Example configuration ``` example_app: module: controllerx class: TS0042LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Tuya TS0043 ![Tuya TS0043]() - **Manufacturer:** Tuya - **Device ID:** `TS0043` - **Controller types:** [Light](<#light>) (`TS0043LightController`), [Cover](<#cover>) (`TS0043CoverController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `TS0043LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `1_single`, `2_single`, `3_single` | `1_remote_button_short_press`, `2_remote_button_short_press`, `3_remote_button_short_press` | `toggle` | | `1_double`, `2_double`, `3_double` | `1_remote_button_double_press`, `2_remote_button_double_press`, `3_remote_button_double_press` | `click_brightness_up` | | `1_hold`, `2_hold`, `3_hold` | `1_remote_button_long_press`, `2_remote_button_long_press`, `3_remote_button_long_press` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: TS0043LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: TS0043LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: TS0043LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Cover - **Class:** `TS0043CoverController` - **Entity parameter:** `cover` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `1_single` | `open` | | `2_single` | `stop` | | `3_single` | `close` | ### Example configuration ``` example_app: module: controllerx class: TS0043CoverController integration: name: z2m listen_to: mqtt controller: my_controller cover: cover.my_entity_id ``` ``` example_app: module: controllerx class: TS0043CoverController integration: name: z2m listen_to: event controller: my_controller_action cover: cover.my_entity_id ``` # Tuya TS0044 ![Tuya TS0044]() - **Manufacturer:** Tuya - **Device ID:** `TS0044` - **Controller types:** [Light](<#light>) (`TS0044LightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Notes Note that each button performs the same actions. This is because ControllerX is designed to control just one entity (light or media player). So, you can include the `actions` parameter to include the actions needed, or use the `mapping` attribute to define a [custom mapping](). You can check [here]() for reference. Also, this controller supports the hold action, but not release. This means that there are no smooth brightness changes when holding, just step by step every time it is held. ## Light - **Class:** `TS0044LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `1_single`, `2_single`, `3_single`, `4_single` | `toggle` | | `1_double`, `2_double`, `3_double`, `4_double` | `click_brightness_up` | | `1_hold`, `2_hold`, `3_hold`, `4_hold` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: TS0044LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: TS0044LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` # Tuya TS0044F ![Tuya TS0044F]() - **Manufacturer:** Tuya - **Device ID:** `TS0044F` - **Controller types:** [Light](<#light>) (`TS0044FLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Notes This device is very similar to the TS0044 Tuya, except that it doesn't support hold actions or double clicks. Note that each button performs the same actions. This is because ControllerX is designed to control just one entity (light or media player). So, you can include the `actions` parameter to include the actions needed, or use the `mapping` attribute to define a [custom mapping](). You can check [here]() for reference. Since this controller doesn't support the hold action, there are no smooth brightness changes, just step by step every time it is pressed. ## Light - **Class:** `TS0044FLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"`, `"off"` | `toggle` | | `brightness_step_up` | `click_brightness_up` | | `brightness_step_down` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: TS0044FLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: TS0044FLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` # Tasmota Button ![Tasmota Button]() - **Manufacturer:** Tasmota - **Device ID:** `TasmotaButton` - **Controller types:** [Light](<#light>) (`TasmotaButtonLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`TasmotaButtonZ2MLightController`), [Switch](<#switch>) (`TasmotaButtonSwitchController`), [Cover](<#cover>) (`TasmotaButtonCoverController`) - **Integrations:** [Tasmota]() (`tasmota`) [Build the configuration for this device]() ## Light - **Class:** `TasmotaButtonLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE`, `SINGLE` | `toggle` | | `DOUBLE` | `on_min_brightness` | | `TRIPLE` | `set_half_brightness` | | `QUAD` | `on_full_brightness` | | `PENTA` | *No action* | | `HOLD` | `hold_brightness_toggle` | | `CLEAR` | `release` | ### Example configuration ``` example_app: module: controllerx class: TasmotaButtonLightController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `TasmotaButtonZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE`, `SINGLE` | `toggle` | | `DOUBLE` | `on_min_brightness` | | `TRIPLE` | `set_half_brightness` | | `QUAD` | `on_full_brightness` | | `PENTA` | *No action* | | `HOLD` | `hold_brightness_toggle` | | `CLEAR` | `release` | ### Example configuration ``` example_app: module: controllerx class: TasmotaButtonZ2MLightController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT light: my_entity_id ``` ## Switch - **Class:** `TasmotaButtonSwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE`, `SINGLE` | `toggle` | | `DOUBLE` | `on` | | `TRIPLE` | `off` | | `QUAD`, `PENTA`, `HOLD`, `CLEAR` | *No action* | ### Example configuration ``` example_app: module: controllerx class: TasmotaButtonSwitchController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT switch: switch.my_entity_id ``` ## Cover - **Class:** `TasmotaButtonCoverController` - **Entity parameter:** `cover` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE`, `SINGLE` | `toggle_open` | | `DOUBLE`, `HOLD` | `close` | | `TRIPLE`, `QUAD`, `PENTA`, `CLEAR` | *No action* | ### Example configuration ``` example_app: module: controllerx class: TasmotaButtonCoverController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT cover: cover.my_entity_id ``` # Tasmota Switch ![Tasmota Switch]() - **Manufacturer:** Tasmota - **Device ID:** `TasmotaSwitch` - **Controller types:** [Light](<#light>) (`TasmotaSwitchLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`TasmotaSwitchZ2MLightController`), [Switch](<#switch>) (`TasmotaSwitchSwitchController`), [Cover](<#cover>) (`TasmotaSwitchCoverController`) - **Integrations:** [Tasmota]() (`tasmota`) [Build the configuration for this device]() ## Light - **Class:** `TasmotaSwitchLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE` | `toggle` | | `ON` | `on` | | `OFF` | `off` | | `HOLD` | `on_min_max_brightness` | ### Example configuration ``` example_app: module: controllerx class: TasmotaSwitchLightController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `TasmotaSwitchZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE` | `toggle` | | `ON` | `on` | | `OFF` | `off` | | `HOLD` | `set_half_brightness` | ### Example configuration ``` example_app: module: controllerx class: TasmotaSwitchZ2MLightController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT light: my_entity_id ``` ## Switch - **Class:** `TasmotaSwitchSwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE` | `toggle` | | `ON` | `on` | | `OFF` | `off` | | `HOLD` | *No action* | ### Example configuration ``` example_app: module: controllerx class: TasmotaSwitchSwitchController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT switch: switch.my_entity_id ``` ## Cover - **Class:** `TasmotaSwitchCoverController` - **Entity parameter:** `cover` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Tasmota | [Predefined action]() | | --- | --- | | `TOGGLE` | `toggle_open` | | `ON` | `open` | | `OFF` | `close` | | `HOLD` | `toggle_close` | ### Example configuration ``` example_app: module: controllerx class: TasmotaSwitchCoverController integration: name: tasmota component: MyComponent controller: stat/tasmota_device/RESULT cover: cover.my_entity_id ``` # Terncy PP01 ![Terncy PP01]() - **Manufacturer:** Terncy - **Device ID:** `TerncyPP01` - **Controller types:** [Light](<#light>) (`TerncyPP01LightController`) - **Integrations:** [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `TerncyPP01LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ZHA | [Predefined action]() | | --- | --- | | `button_single` | `toggle` | | `button_double` | `on_full_brightness` | | `button_triple` | `on_min_brightness` | | `button_quadruple` | `set_half_brightness` | | `button_quintuple` | `set_half_color_temp` | ### Example configuration ``` example_app: module: controllerx class: TerncyPP01LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Terncy SD01 ![Terncy SD01]() - **Manufacturer:** Terncy - **Device ID:** `TerncySD01` - **Controller types:** [Light](<#light>) (`TerncySD01LightController`), [Media Player](<#media-player>) (`TerncySD01MediaPlayerController`) - **Integrations:** [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `TerncySD01LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ZHA | [Predefined action]() | | --- | --- | | `button_single` | `toggle` | | `button_double` | `on_full_brightness` | | `button_triple` | `on_min_brightness` | | `button_quadruple` | `set_half_brightness` | | `button_quintuple` | `set_half_color_temp` | | `rotate_left` | `click_brightness_down` | | `rotate_right` | `click_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: TerncySD01LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Media Player - **Class:** `TerncySD01MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ZHA | [Predefined action]() | | --- | --- | | `button_single` | `play_pause` | | `button_double` | `mute` | | `button_triple` | `next_track` | | `button_quadruple` | `previous_track` | | `button_quintuple` | `next_source` | | `rotate_left` | `click_volume_down` | | `rotate_right` | `click_volume_up` | ### Example configuration ``` example_app: module: controllerx class: TerncySD01MediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # Tuya ERS10TZBVKAA ![Tuya ERS10TZBVKAA]() - **Manufacturer:** Tuya - **Device ID:** `TuYaERS10TZBVKAA` - **Controller types:** [Light](<#light>) (`TuYaERS10TZBVKAALightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`TuYaERS10TZBVKAAZ2MLightController`), [Media Player](<#media-player>) (`TuYaERS10TZBVKAAMediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `TuYaERS10TZBVKAALightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `brightness_step_up`, `rotate_right` | | `click_brightness_up` | | `brightness_step_down`, `rotate_left` | | `click_brightness_down` | | `toggle`, `single` | `toggle` | `toggle` | | `hue_move` | | `hold_brightness_toggle` | | `hue_stop` | | `release` | | `color_temperature_step_up` | | `click_color_up` | | `color_temperature_step_down` | | `click_color_down` | | `double` | | `on_full_brightness` | | `hold` | | `on_min_brightness` | | | `step_brightness` | `brightness_from_controller_step` | | | `step_color_temp` | `colortemp_from_controller_step` | ### Example configuration ``` example_app: module: controllerx class: TuYaERS10TZBVKAALightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: TuYaERS10TZBVKAALightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: TuYaERS10TZBVKAALightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `TuYaERS10TZBVKAAZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `brightness_step_up`, `rotate_right` | `click_brightness_up` | | `brightness_step_down`, `rotate_left` | `click_brightness_down` | | `toggle`, `single` | `toggle` | | `hue_move` | `hold_brightness_toggle` | | `hue_stop` | `release` | | `color_temperature_step_up` | `click_colortemp_up` | | `color_temperature_step_down` | `click_colortemp_down` | | `double` | `on_full_brightness` | | `hold` | `on_min_brightness` | ### Example configuration ``` example_app: module: controllerx class: TuYaERS10TZBVKAAZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: TuYaERS10TZBVKAAZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `TuYaERS10TZBVKAAMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `brightness_step_up`, `rotate_right` | `click_volume_up` | | `brightness_step_down`, `rotate_left` | `click_volume_down` | | `toggle`, `single` | `play_pause` | | `hue_move` | `hold_volume_up` | | `hue_stop` | `release` | | `color_temperature_step_up`, `double` | `next_track` | | `color_temperature_step_down`, `hold` | `previous_track` | ### Example configuration ``` example_app: module: controllerx class: TuYaERS10TZBVKAAMediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: TuYaERS10TZBVKAAMediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` # Aqara WXCJKG11LM ![Aqara WXCJKG11LM]() - **Manufacturer:** Aqara - **Device ID:** `WXCJKG11LM` - **Controller types:** [Light](<#light>) (`WXCJKG11LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXCJKG11LMZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Light - **Class:** `WXCJKG11LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `button_1_single` | `1002` | `off` | | `button_1_double` | | `on_min_brightness` | | `button_1_hold` | `1001` | `hold_brightness_down` | | `button_1_release`, `button_2_release` | `1003`, `2003` | `release` | | `button_2_single` | `2002` | `on` | | `button_2_double` | | `on_full_brightness` | | `button_2_hold` | `2001` | `hold_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: WXCJKG11LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG11LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG11LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXCJKG11LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `button_1_single` | `off` | | `button_1_double` | `on_min_brightness` | | `button_1_hold` | `hold_brightness_down` | | `button_1_release`, `button_2_release` | `release` | | `button_2_single` | `on` | | `button_2_double` | `on_full_brightness` | | `button_2_hold` | `hold_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: WXCJKG11LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG11LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Aqara WXCJKG12LM ![Aqara WXCJKG12LM]() - **Manufacturer:** Aqara - **Device ID:** `WXCJKG12LM` - **Controller types:** [Light](<#light>) (`WXCJKG12LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXCJKG12LMZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `WXCJKG12LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | ZHA | [Predefined action]() | | --- | --- | --- | | `button_1_single` | `1_single` | `off` | | `button_1_double` | `1_double` | `on_min_color_temp` | | `button_1_triple`, `button_2_triple`, `button_3_triple`, `button_4_triple` | `1_triple`, `2_triple`, `3_triple`, `4_triple` | *No action* | | `button_1_hold` | `1_long press` | `hold_color_down` | | `button_1_release`, `button_2_release`, `button_3_release`, `button_4_release` | `1_release`, `2_release`, `3_release`, `4_release` | `release` | | `button_2_single` | `2_single` | `on` | | `button_2_double` | `2_double` | `on_full_color_temp` | | `button_2_hold` | `2_long press` | `hold_color_up` | | `button_3_single` | `3_single` | `click_brightness_down` | | `button_3_double` | `3_double` | `on_min_brightness` | | `button_3_hold` | `3_long press` | `hold_brightness_down` | | `button_4_single` | `4_single` | `click_brightness_up` | | `button_4_double` | `4_double` | `on_full_brightness` | | `button_4_hold` | `4_long press` | `hold_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: WXCJKG12LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG12LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG12LMLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXCJKG12LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `button_1_single` | `off` | | `button_1_double` | `on_min_color_temp` | | `button_1_triple`, `button_2_triple`, `button_3_triple`, `button_4_triple` | *No action* | | `button_1_hold` | `hold_colortemp_down` | | `button_1_release`, `button_2_release`, `button_3_release`, `button_4_release` | `release` | | `button_2_single` | `on` | | `button_2_double` | `on_full_color_temp` | | `button_2_hold` | `hold_colortemp_up` | | `button_3_single` | `click_brightness_down` | | `button_3_double` | `on_min_brightness` | | `button_3_hold` | `hold_brightness_down` | | `button_4_single` | `click_brightness_up` | | `button_4_double` | `on_full_brightness` | | `button_4_hold` | `hold_brightness_up` | ### Example configuration ``` example_app: module: controllerx class: WXCJKG12LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG12LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Aqara WXCJKG13LM ![Aqara WXCJKG13LM]() - **Manufacturer:** Aqara - **Device ID:** `WXCJKG13LM` - **Controller types:** [Light](<#light>) (`WXCJKG13LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXCJKG13LMZ2MLightController`), [Media Player](<#media-player>) (`WXCJKG13LMMediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `WXCJKG13LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `button_1_single` | `1002` | `1_single` | `off` | | `button_1_double`, `button_2_double` | `1004`, `2004` | `1_double`, `2_double` | `sync` | | `button_1_triple`, `button_1_hold`, `button_1_release`, `button_2_triple`, `button_2_hold`, `button_2_release`, `button_3_triple`, `button_4_triple`, `button_5_triple`, `button_6_triple` | `1005`, `1001`, `1003`, `2005`, `2001`, `2003`, `3005`, `4005`, `5005`, `6005` | `1_triple`, `1_long`, `1_release`, `2_triple`, `2_long`, `2_release`, `3_triple`, `4_triple`, `5_triple`, `6_triple` | *No action* | | `button_2_single` | `2002` | `2_single` | `on` | | `button_3_single` | `3002` | `3_single` | `click_brightness_down` | | `button_3_double` | `3004` | `3_double` | `on_min_brightness` | | `button_3_hold` | `3001` | `3_long` | `hold_brightness_down` | | `button_3_release`, `button_4_release`, `button_5_release`, `button_6_release` | `3003`, `4003`, `5003`, `6003` | `3_release`, `4_release`, `5_release`, `6_release` | `release` | | `button_4_single` | `4002` | `4_single` | `click_brightness_up` | | `button_4_double` | `4004` | `4_double` | `on_full_brightness` | | `button_4_hold` | `4001` | `4_long` | `hold_brightness_up` | | `button_5_single` | `5002` | `5_single` | `click_color_down` | | `button_5_double` | `5004` | `5_double` | `on_min_color_temp` | | `button_5_hold` | `5001` | `5_long` | `hold_color_down` | | `button_6_single` | `6002` | `6_single` | `click_color_up` | | `button_6_double` | `6004` | `6_double` | `on_full_color_temp` | | `button_6_hold` | `6001` | `6_long` | `hold_color_up` | ### Example configuration ``` example_app: module: controllerx class: WXCJKG13LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG13LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG13LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG13LMLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXCJKG13LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `button_1_single` | `off` | | `button_1_double`, `button_2_double`, `button_4_double` | `on_full_brightness` | | `button_1_triple`, `button_1_hold`, `button_1_release`, `button_2_triple`, `button_2_hold`, `button_2_release`, `button_3_triple`, `button_4_triple`, `button_5_triple`, `button_6_triple` | *No action* | | `button_2_single` | `on` | | `button_3_single` | `click_brightness_down` | | `button_3_double` | `on_min_brightness` | | `button_3_hold` | `hold_brightness_down` | | `button_3_release`, `button_4_release`, `button_5_release`, `button_6_release` | `release` | | `button_4_single` | `click_brightness_up` | | `button_4_hold` | `hold_brightness_up` | | `button_5_single` | `click_colortemp_down` | | `button_5_double` | `on_min_color_temp` | | `button_5_hold` | `hold_colortemp_down` | | `button_6_single` | `click_colortemp_up` | | `button_6_double` | `on_full_color_temp` | | `button_6_hold` | `hold_colortemp_up` | ### Example configuration ``` example_app: module: controllerx class: WXCJKG13LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG13LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `WXCJKG13LMMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `button_1_single` | `1002` | `1_single` | `click_volume_down` | | `button_1_double` | `1004` | `1_double` | `mute` | | `button_1_triple`, `button_2_triple`, `button_3_double`, `button_3_triple`, `button_3_hold`, `button_3_release`, `button_4_double`, `button_4_triple`, `button_4_hold`, `button_4_release`, `button_5_double`, `button_5_triple`, `button_5_hold`, `button_5_release`, `button_6_double`, `button_6_triple`, `button_6_hold`, `button_6_release` | `1005`, `2005`, `3001`, `3003`, `3004`, `3005`, `4001`, `4003`, `4004`, `4005`, `5001`, `5003`, `5004`, `5005`, `6001`, `6003`, `6004`, `6005` | `1_triple`, `2_triple`, `3_double`, `3_triple`, `3_long`, `3_release`, `4_double`, `4_triple`, `4_long`, `4_release`, `5_double`, `5_triple`, `5_long`, `6_double`, `6_triple`, `6_long`, `6_release` | *No action* | | `button_1_hold` | `1001` | `1_long` | `hold_volume_down` | | `button_1_release`, `button_2_release` | `1003`, `2003` | `1_release`, `2_release`, `5_release` | `release` | | `button_2_single` | `2002` | `2_single` | `click_volume_up` | | `button_2_double` | `2004` | `2_double` | `play_pause` | | `button_2_hold` | `2001` | `2_long` | `hold_volume_up` | | `button_3_single` | `3002` | `3_single` | `previous_track` | | `button_4_single` | `4002` | `4_single` | `next_track` | | `button_5_single` | `5002` | `5_single` | `previous_source` | | `button_6_single` | `6002` | `6_single` | `next_source` | ### Example configuration ``` example_app: module: controllerx class: WXCJKG13LMMediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG13LMMediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG13LMMediaPlayerController integration: deconz controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: WXCJKG13LMMediaPlayerController integration: zha controller: 00:11:22:33:44:55:66:77:88 media_player: media_player.my_entity_id ``` # Aqara WXKG01LM ![Aqara WXKG01LM]() - **Manufacturer:** Aqara - **Device ID:** `WXKG01LM` - **Controller types:** [Light](<#light>) (`WXKG01LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXKG01LMZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes The ZHA implementation of this button does not support hold and release actions yet. ## Light - **Class:** `WXKG01LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single` | `1002` | `single` | `toggle` | | `double` | `1004` | `double` | `on_full_brightness` | | `triple` | `1005` | `triple` | `on_min_brightness` | | `quadruple` | `1006` | `quadruple` | `set_half_brightness` | | `many` | `1010` | | *No action* | | `hold` | `1001` | | `hold_brightness_toggle` | | `release` | `1003` | | `release` | ### Example configuration ``` example_app: module: controllerx class: WXKG01LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG01LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG01LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG01LMLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXKG01LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single` | `toggle` | | `double` | `on_full_brightness` | | `triple` | `on_min_brightness` | | `quadruple` | `set_half_brightness` | | `many` | *No action* | | `hold` | `hold_brightness_toggle` | | `release` | `release` | ### Example configuration ``` example_app: module: controllerx class: WXKG01LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXKG01LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Aqara WXKG02LM ![Aqara WXKG02LM]() - **Manufacturer:** Aqara - **Device ID:** `WXKG02LM` - **Controller types:** [Light](<#light>) (`WXKG02LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXKG02LMZ2MLightController`), [Switch](<#switch>) (`WXKG02LMSwitchController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes Note that all actions related to both left and right do the same. This is because ControllerX is designed to control just one entity (light or media player). So, you can include the `actions` parameter to include the actions needed. You can check [here]() for reference. Also, this controller supports the hold action, but not release. This means that there are no smooth brightness changes when holding, just step by step every time it is held. ## Light - **Class:** `WXKG02LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single_both`, `single_left`, `single_right` | `1002`, `2002`, `3002` | `both_single`, `left_single`, `right_single` | `toggle` | | `double_both`, `double_left`, `double_right` | `1004`, `2004`, `3004` | `both_double`, `left_double`, `right_double` | `click_brightness_up` | | `hold_both`, `hold_left`, `hold_right` | `1001`, `2001`, `3001` | `both_long press`, `left_long press`, `right_long press` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: WXKG02LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG02LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG02LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG02LMLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXKG02LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single_both`, `single_left`, `single_right` | `toggle` | | `double_both`, `double_left`, `double_right` | `click_brightness_up` | | `hold_both`, `hold_left`, `hold_right` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: WXKG02LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXKG02LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Switch - **Class:** `WXKG02LMSwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single_both`, `single_left`, `single_right` | `1002`, `2002`, `3002` | `both_single`, `left_single`, `right_single` | `toggle` | ### Example configuration ``` example_app: module: controllerx class: WXKG02LMSwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG02LMSwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG02LMSwitchController integration: deconz controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG02LMSwitchController integration: zha controller: 00:11:22:33:44:55:66:77:88 switch: switch.my_entity_id ``` # Aqara WXKG06LM ![Aqara WXKG06LM]() - **Manufacturer:** Aqara - **Device ID:** `WXKG06LM` - **Controller types:** [Light](<#light>) (`WXKG06LMLightController`), [Switch](<#switch>) (`WXKG06LMSwitchController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Notes This controller supports the hold action, but not release. This means that there are no smooth brightness changes when holding, just step by step every time it is held. ## Light - **Class:** `WXKG06LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `single` | `1002` | `toggle` | | `double`, `hold` | `1004` | `click_brightness_up` | | | `1001` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: WXKG06LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG06LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG06LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ## Switch - **Class:** `WXKG06LMSwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `single` | `1002` | `toggle` | ### Example configuration ``` example_app: module: controllerx class: WXKG06LMSwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG06LMSwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG06LMSwitchController integration: deconz controller: my_controller switch: switch.my_entity_id ``` # Aqara WXKG07LM ![Aqara WXKG07LM]() - **Manufacturer:** Aqara - **Device ID:** `WXKG07LM` - **Controller types:** [Light](<#light>) (`WXKG07LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXKG07LMZ2MLightController`), [Switch](<#switch>) (`WXKG07LMSwitchController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Notes Note that all actions related to both left and right do the same. This is because ControllerX is designed to control just one entity (light or media player). So, you can include the `actions` parameter to include the actions needed. You can check [here]() for reference. Also, this controller supports the hold action, but not release. This means that there are no smooth brightness changes when holding, just step by step every time it is held. ## Light - **Class:** `WXKG07LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single_both`, `single_left`, `single_right` | `1002`, `2002`, `3002` | `both_single`, `left_single`, `right_single` | `toggle` | | `double_both`, `double_left`, `double_right` | `1004`, `2004`, `3004` | `both_double`, `left_double`, `right_double` | `click_brightness_up` | | `hold_both`, `hold_left`, `hold_right` | `1001`, `2001`, `3001` | `both_long press`, `left_long press`, `right_long press` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: WXKG07LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG07LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG07LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG07LMLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXKG07LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single_both`, `single_left`, `single_right` | `toggle` | | `double_both`, `double_left`, `double_right` | `click_brightness_up` | | `hold_both`, `hold_left`, `hold_right` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: WXKG07LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXKG07LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Switch - **Class:** `WXKG07LMSwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single_both`, `single_left`, `single_right` | `1002`, `2002`, `3002` | `both_single`, `left_single`, `right_single` | `toggle` | ### Example configuration ``` example_app: module: controllerx class: WXKG07LMSwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG07LMSwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG07LMSwitchController integration: deconz controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG07LMSwitchController integration: zha controller: 00:11:22:33:44:55:66:77:88 switch: switch.my_entity_id ``` # Aqara WXKG11LMRemote ![Aqara WXKG11LMRemote]() - **Manufacturer:** Aqara - **Device ID:** `WXKG11LMRemote` - **Controller types:** [Light](<#light>) (`WXKG11LMRemoteLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXKG11LMRemoteZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `WXKG11LMRemoteLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | --- | | `single` | `1002` | `single` | `toggle` | | `double` | `1004` | `double` | `on_full_brightness` | | `hold` | `1001` | `hold` | `hold_brightness_toggle` | | `release` | `1003` | `release` | `release` | ### Example configuration ``` example_app: module: controllerx class: WXKG11LMRemoteLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG11LMRemoteLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG11LMRemoteLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG11LMRemoteLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXKG11LMRemoteZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single` | `toggle` | | `double` | `on_full_brightness` | | `hold` | `hold_brightness_toggle` | | `release` | `release` | ### Example configuration ``` example_app: module: controllerx class: WXKG11LMRemoteZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXKG11LMRemoteZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Aqara WXKG11LMSensorSwitch ![Aqara WXKG11LMSensorSwitch]() - **Manufacturer:** Aqara - **Device ID:** `WXKG11LMSensorSwitch` - **Controller types:** [Light](<#light>) (`WXKG11LMSensorSwitchLightController`) - **Integrations:** [deCONZ]() (`deconz`), [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `WXKG11LMSensorSwitchLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | deCONZ | ZHA | [Predefined action]() | | --- | --- | --- | | `1002` | `single` | `toggle` | | `1004` | `double` | `on_full_brightness` | | `1005` | `triple` | `on_min_brightness` | | `1006` | `quadruple` | `set_half_brightness` | ### Example configuration ``` example_app: module: controllerx class: WXKG11LMSensorSwitchLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG11LMSensorSwitchLightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Aqara WXKG12LM ![Aqara WXKG12LM]() - **Manufacturer:** Aqara - **Device ID:** `WXKG12LM` - **Controller types:** [Light](<#light>) (`WXKG12LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXKG12LMZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Light - **Class:** `WXKG12LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `single` | `1002` | `toggle` | | `double` | `1004` | `on_full_brightness` | | `shake` | `1007` | `on_min_brightness` | | `hold` | `1001` | `hold_brightness_toggle` | | `release` | `1003` | `release` | ### Example configuration ``` example_app: module: controllerx class: WXKG12LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG12LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG12LMLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXKG12LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single` | `toggle` | | `double` | `on_full_brightness` | | `shake` | `on_min_brightness` | | `hold` | `hold_brightness_toggle` | | `release` | `release` | ### Example configuration ``` example_app: module: controllerx class: WXKG12LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXKG12LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Aqara WXKG15LM ![Aqara WXKG15LM]() - **Manufacturer:** Aqara - **Device ID:** `WXKG15LM` - **Controller types:** [Light](<#light>) (`WXKG15LMLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`WXKG15LMZ2MLightController`), [Switch](<#switch>) (`WXKG15LMSwitchController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `WXKG15LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single_both`, `single_left`, `single_right` | `toggle` | | `double_both`, `double_left`, `double_right` | `click_brightness_up` | | `triple_both`, `triple_left`, `triple_right` | `click_brightness_down` | | `hold_both`, `hold_left`, `hold_right` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: WXKG15LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: WXKG15LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `WXKG15LMZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single_both`, `single_left`, `single_right` | `toggle` | | `double_both`, `double_left`, `double_right` | `click_brightness_up` | | `triple_both`, `triple_left`, `triple_right` | `click_brightness_down` | | `hold_both`, `hold_left`, `hold_right` | `on_full_brightness` | ### Example configuration ``` example_app: module: controllerx class: WXKG15LMZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: WXKG15LMZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Switch - **Class:** `WXKG15LMSwitchController` - **Entity parameter:** `switch` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single_both`, `single_left`, `single_right` | `toggle` | ### Example configuration ``` example_app: module: controllerx class: WXKG15LMSwitchController integration: name: z2m listen_to: mqtt controller: my_controller switch: switch.my_entity_id ``` ``` example_app: module: controllerx class: WXKG15LMSwitchController integration: name: z2m listen_to: event controller: my_controller_action switch: switch.my_entity_id ``` # Lutron Z31BRL ![Lutron Z31BRL]() - **Manufacturer:** Lutron - **Device ID:** `Z31BRL` - **Controller types:** [Light](<#light>) (`Z31BRLLightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`Z31BRLZ2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`), [deCONZ]() (`deconz`) [Build the configuration for this device]() ## Light - **Class:** `Z31BRLLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | deCONZ | [Predefined action]() | | --- | --- | --- | | `brightness_move_to_level` | | `brightness_from_controller_level` | | | `1002` | `toggle` | | | `2002` | `click_brightness_up` | | | `3002` | `click_brightness_down` | ### Example configuration ``` example_app: module: controllerx class: Z31BRLLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: Z31BRLLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ``` example_app: module: controllerx class: Z31BRLLightController integration: deconz controller: my_controller light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `Z31BRLZ2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `brightness_move_to_level` | `brightness_from_controller_level` | ### Example configuration ``` example_app: module: controllerx class: Z31BRLZ2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: Z31BRLZ2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # RGB Genie ZB3009 ![RGB Genie ZB3009]() - **Manufacturer:** RGB Genie - **Device ID:** `ZB3009` - **Controller types:** [Light](<#light>) (`ZB3009LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`ZB3009Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `ZB3009LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"`, `"off"` | `toggle` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `color_temperature_move_down` | `click_colortemp_down` | | `color_temperature_move_up` | `click_colortemp_up` | | `color_temperature_move` | `colortemp_from_controller` | | `color_move` | `xycolor_from_controller` | | `hue_move`, `recall_1`, `recall_3`, `recall_2` | *No action* | ### Example configuration ``` example_app: module: controllerx class: ZB3009LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: ZB3009LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `ZB3009Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"`, `"off"` | `toggle` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `color_temperature_move_down` | `click_colortemp_down` | | `color_temperature_move_up` | `click_colortemp_up` | | `color_temperature_move` | `colortemp_from_controller` | | `color_move` | `xycolor_from_controller` | | `hue_move`, `recall_1`, `recall_3`, `recall_2` | *No action* | ### Example configuration ``` example_app: module: controllerx class: ZB3009Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: ZB3009Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # RGB Genie ZB5121 ![RGB Genie ZB5121]() - **Manufacturer:** RGB Genie - **Device ID:** `ZB5121` - **Controller types:** [Light](<#light>) (`ZB5121LightController`) - **Integrations:** [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `ZB5121LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ZHA | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `step_with_on_off_0_32_0` | `click_brightness_up` | | `move_with_on_off_0_50` | `hold_brightness_up` | | `step_with_on_off_1_32_0` | `click_brightness_down` | | `move_with_on_off_1_50` | `hold_brightness_down` | | `recall_0_1` | *No action* | | `stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: ZB5121LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # RGB Genie ZB5122 ![RGB Genie ZB5122]() - **Manufacturer:** RGB Genie - **Device ID:** `ZB5122` - **Controller types:** [Light](<#light>) (`ZB5122LightController`) - **Integrations:** [ZHA]() (`zha`) [Build the configuration for this device]() ## Light - **Class:** `ZB5122LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | ZHA | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `hold_brightness_up` | `hold_brightness_up` | | `hold_brightness_down` | `hold_brightness_down` | | `stop`, `stop_move_hue`, `stop_move_step` | `release` | | `move_to_color` | `click_xycolor_up` | | `move_hue` | `hold_xycolor_up` | | `move_to_color_temp` | `colortemp_from_controller` | | `move_color_temp` | `hold_colortemp_toggle` | | `recall_0_1` | *No action* | ### Example configuration ``` example_app: module: controllerx class: ZB5122LightController integration: zha controller: 00:11:22:33:44:55:66:77:88 light: light.my_entity_id ``` # Aqara ZNXNKG02LM ![Aqara ZNXNKG02LM]() - **Manufacturer:** Aqara - **Device ID:** `ZNXNKG02LM` - **Controller types:** [Light](<#light>) (`ZNXNKG02LMLightController`), [Media Player](<#media-player>) (`ZNXNKG02LMMediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `ZNXNKG02LMLightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single` | `toggle` | | `double` | `on_full_brightness` | | `hold` | `hold_color_toggle` | | `release`, `stop_rotating` | `release` | | `start_rotating` | `brightness_from_controller_angle` | ### Example configuration ``` example_app: module: controllerx class: ZNXNKG02LMLightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: ZNXNKG02LMLightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Media Player - **Class:** `ZNXNKG02LMMediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `single` | `play_pause` | | `double` | `next_track` | | `hold` | `previous_track` | | `release`, `stop_rotating` | `release` | | `start_rotating` | `volume_from_controller_angle` | ### Example configuration ``` example_app: module: controllerx class: ZNXNKG02LMMediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: ZNXNKG02LMMediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` # Linkind ZS23000278 ![Linkind ZS23000278]() - **Manufacturer:** Linkind - **Device ID:** `ZS23000278` - **Controller types:** [Light](<#light>) (`ZS23000278LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`ZS23000278Z2MLightController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `ZS23000278LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_step_up` | `click_brightness_up` | | `brightness_step_down` | `click_brightness_down` | | `brightness_move_to_level` | `brightness_from_controller_level` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `color_temperature_move` | `colortemp_from_controller` | | `color_temperature_move_up` | `click_colortemp_up` | | `color_temperature_move_down` | `click_colortemp_down` | | `color_move` | `xycolor_from_controller` | ### Example configuration ``` example_app: module: controllerx class: ZS23000278LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: ZS23000278LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `ZS23000278Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `"off"` | `off` | | `brightness_step_up` | `click_brightness_up` | | `brightness_step_down` | `click_brightness_down` | | `brightness_move_to_level` | `brightness_from_controller_level` | | `brightness_move_up` | `hold_brightness_up` | | `brightness_move_down` | `hold_brightness_down` | | `brightness_stop` | `release` | | `color_temperature_move` | `colortemp_from_controller` | | `color_temperature_move_up` | `click_colortemp_up` | | `color_temperature_move_down` | `click_colortemp_down` | | `color_move` | `xycolor_from_controller` | ### Example configuration ``` example_app: module: controllerx class: ZS23000278Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: ZS23000278Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` # Trust ZYCT202 ![Trust ZYCT202]() - **Manufacturer:** Trust - **Device ID:** `ZYCT202` - **Controller types:** [Light](<#light>) (`ZYCT202LightController`), [Zigbee2MQTT Light](<#zigbee2mqtt-light>) (`ZYCT202Z2MLightController`), [Media Player](<#media-player>) (`ZYCT202MediaPlayerController`) - **Integrations:** [Zigbee2MQTT]() (`z2m`) [Build the configuration for this device]() ## Light - **Class:** `ZYCT202LightController` - **Entity parameter:** `light` - **Default delay:** `350ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `up-press` | `hold_brightness_up` | | `down-press` | `hold_brightness_down` | | `"off"` | `off` | | `stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: ZYCT202LightController integration: name: z2m listen_to: mqtt controller: my_controller light: light.my_entity_id ``` ``` example_app: module: controllerx class: ZYCT202LightController integration: name: z2m listen_to: event controller: my_controller_action light: light.my_entity_id ``` ## Zigbee2MQTT Light - **Class:** `ZYCT202Z2MLightController` - **Entity parameter:** `light` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"` | `on` | | `up-press` | `hold_brightness_up` | | `down-press` | `hold_brightness_down` | | `"off"` | `off` | | `stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: ZYCT202Z2MLightController integration: name: z2m listen_to: mqtt controller: my_controller light: my_entity_id ``` ``` example_app: module: controllerx class: ZYCT202Z2MLightController integration: name: z2m listen_to: event controller: my_controller_action light: my_entity_id ``` ## Media Player - **Class:** `ZYCT202MediaPlayerController` - **Entity parameter:** `media_player` - **Default delay:** `500ms` ### Default mapping Each row shows the events fired by the device for each integration and the [predefined action]() they trigger by default. You can change it with a [custom mapping](). | Zigbee2MQTT | [Predefined action]() | | --- | --- | | `"on"`, `"off"` | `play_pause` | | `up-press` | `hold_volume_up` | | `down-press` | `hold_volume_down` | | `stop` | `release` | ### Example configuration ``` example_app: module: controllerx class: ZYCT202MediaPlayerController integration: name: z2m listen_to: mqtt controller: my_controller media_player: media_player.my_entity_id ``` ``` example_app: module: controllerx class: ZYCT202MediaPlayerController integration: name: z2m listen_to: event controller: my_controller_action media_player: media_player.my_entity_id ``` # Advanced *This page assumes you already know how the [`mapping` attribute]() works.* An action type is a reduced version of the Home Assistant [script syntax](). It defines one action or a sequence of actions to execute when an event is fired. The available action types are [predefined actions](), service calls, scene activation and delays. ``` ... mapping: # or merge_mapping ## Predefined actions # `toggle` is a light predefined action : action: toggle # The previous action type can be reduced as: : toggle ## Call services # Call any service the same way as it is done through `Developer Tools > Services` in HA : service: script.my_script data: attr1: 42 attr2: foo # `entity_id` can be passed directly like this or through `data`. # Additionally, if the service is within the same domain # (light, media_player, etc) as the main entity from the configuration, # and entity_id is not passed, then it will use the one from the configuration. # This is handy, so there is no need to repeat the same entity over and over again. # Priority order for entity_id: # - Inside data # - In the same level as "service" # - From the main config if the domain matches : service: light.turn_on entity_id: light.my_light ## Scene activation # Activate any HA Scene : scene: scene.my_scene ## Delay # `delay` is useful when defining a list of actions, and you want # an action to be triggered after some defined time. # The value of the attribute only accepts seconds. : - on_min_brightness # predefined action - delay: 5 # wait 5 seconds - on_full_brightness # predefined action ``` *The `` key is the event from your controller and integration.* If an action is still executing (most likely because of a `delay`) and the same event gets fired again, the behaviour depends on the [`mode`]() parameter, which works like the [Home Assistant automation modes](). By default (`mode: single`), the new execution is ignored and a warning is logged. Use `mode: restart` to cancel the running action and start a new one. Actions are executed sequentially, so it is not recommended to use a list of `hold` predefined actions, since it will not result in the expected behaviour. This is because `hold` actions are blocking operations, and they do not finish until a `release` action is fired. *This is supported since ControllerX v4.14.0* ControllerX allows entity controllers (LightController, MediaPlayerController, CoverController, etc.) to work with grouped entities. All that is needed is an entity with an `entity_id` attribute containing the list of entities controlled by the group. For example, we can use a group entity from the [Group integration](), or from the [Light Group integration](). ControllerX reads the attributes from the main entity (the first one in the list), but runs the actions on the grouped entity. Let's imagine we have a Light Group entity (`light.livingroom`): ``` light: - platform: group name: livingroom entities: - light.livingroom_1 - light.livingroom_2 - light.livingroom_3 ``` Then, we could configure the following in the `apps.yaml` file: ``` example_app: module: controllerx class: E2002LightController controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.livingroom ``` `light.livingroom_1` will be the main light that ControllerX reads from, but `light.livingroom` will be the grouped entity that ControllerX performs the actions on. For example, if `light.livingroom_1` does not support `brightness`, but `light.livingroom_2` and `light.livingroom_3` do, then the configuration will not work because ControllerX will not be able to read the `brightness` attribute from `light.livingroom_1`. *This is supported since ControllerX v4.23.0* Most of the integrations supported by ControllerX are defined for a specific use case (Zigbee2MQTT, deCONZ, ZHA), but there is also the [`State` integration](), a more generic integration that allows us to listen to any Home Assistant entity state and build a mapping from it. Since ControllerX v4.23.0, we can also use the [`Event` integration](), which allows us to define the event we want to listen to and how to build the actions from it. Each event has its own payload that could look like: ``` { "device_ieee": "00:67:88:56:06:78:9b:3f", "device_name": "my_device", "command": "step", "args": { "direction": "up" } } ``` Then, ControllerX needs to convert this JSON-like data into an action string, such as `action_step_up`, so we can build our mapping on it. Following this use case, we can create our own ControllerX configuration with this custom event: ``` example_app: module: controllerx class: LightController controller: my_device # The value of the `controller_key` attribute defined below light: light.my_light integration: name: event # Required event_type: my_custom_event controller_key: device_name action_template: "action_{command}_{args[direction]}" mapping: action_step_up: click_brightness_up action_step_down: click_brightness_down ``` Let's break down the configuration for the integration: - `event_type`: This is the event we will be listening to. For example, ZHA uses `zha_event`. - `controller_key`: This is the attribute of the event data that identifies the controller. Its value must match the `controller` parameter. Note that the following names cannot be used for this field: `name`, `event`, `callback`, `namespace` or `cb`. - `action_template`: This is the template used to build the name of the actions. We can use `{}` to retrieve the keys from the data, and `[]` inside them to access nested attributes, as shown in the example. *This page assumes you already know how the [`mapping` attribute]() and [predefined actions]() work.* Since ControllerX v4.16.0, the hold and click actions can be configured. Before that, there were only the `{hold,click}_{brightness,color_temp,white_color,...}_{up,down,toggle}` predefined actions like: - `hold_brightness_toggle` - `hold_color_up` - `click_colortemp_up` - `click_brightness_down` - ... They allow using click (1 step) or hold (smooth dim) with different attributes and directions. However, it became difficult to extend them with more functionality, so the `click` and `hold` actions can now be configured as follows: ``` example_app: module: controllerx class: E1810Controller integration: deconz controller: my_controller light: light.my_light merge_mapping: 2001: action: click # [click, hold] This is the predefined action. attribute: brightness # [brightness, color_temp, white_value, color, xy_color] direction: up # [up, down, toggle (only for hold)] mode: stop # [stop, loop, bounce (only for hold)] Stepper mode steps: 10 # It overrides the `manual_steps` and `automatic_steps` global attributes ``` The fields are the following: - **action**: This is the [predefined action](), which in this case is `click` or `hold`. - **attribute**: Attribute we want to act on. The available values are: `brightness`, `color_temp`, `white_value`, `color`, and `xy_color`. However, `xy_color` will ignore the `mode` and `steps` attributes since it already loops through the color wheel. - **direction**: Direction to start. Options are `up`, `down`, and `toggle`. The `click` action does not accept `toggle`. - **`up`**: It goes up. - **`down`**: It goes down. - **`toggle`**: It changes direction every time the action is performed. - **mode**: This is the stepper mode. Options are `stop`, `loop`, and `bounce`. The `click` action does not accept `bounce`. - **`stop`**: This is the default behaviour. It stops when it reaches either end (min or max). - **`loop`**: It loops through all the values under the same direction, so when reaching the end, it will start over. For example, if you configure the brightness with direction `up`, it will go from the current value up to 255 (default max), and then it will start over from 1 (default min) without releasing the button. This `mode` will not stop unless there is a `release` action or it reaches the `max_loops` attribute (default is 50 steps). - **`bounce`**: It bounces at the ends, so when reaching an end it switches direction. For example, if you configure the brightness with direction `down`, it will go from the current value down to 1 (default min), then it will start going up until reaching 255, and then bounce back again. This `mode` will not stop unless there is a `release` action or it reaches the `max_loops` attribute (default is 50 steps). As you can see, the configuration is much more flexible, but it needs more lines than the direct predefined actions. For this reason, the predefined actions like `{hold,click}_{brightness,color_temp,white_color,...}_{up,down,toggle}` will not be removed, but no new ones will be added, since they can now be configured this way. For example, this configuration: ``` example_app: module: controllerx class: E1810Controller integration: deconz controller: my_controller light: light.my_light merge_mapping: 2001: action: hold attribute: brightness direction: up ``` is the same as: ``` example_app: module: controllerx class: E1810Controller integration: deconz controller: my_controller light: light.my_light merge_mapping: 2001: action: hold_brightness_up ``` The old predefined actions have `stop` as a default mode. We can use the `mapping` attribute to completely override the default behaviour of a controller, or `merge_mapping` to override just the specified events and keep the rest of the default mapping. Both work the same way: - **key**: The event fired by the controller. You can check these events in the page of each device in [supported controllers](). Note that they change depending on the controller and the integration (z2m, deconz, zha). The [multiple clicks functionality]() can be configured in the `key` part. - **value**: An [action type]() or a list of them. These are the actions executed when the event (`key`) is fired. Let's see an example: ``` example_app: module: controllerx class: E1743Controller controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.livingroom merge_mapping: "off": - scene: scene.night - service: notify.telegram data: message: '"off" clicked' ``` In this example, the `key` is `"off"` (extracted from the Zigbee2MQTT mapping of the [E1743 IKEA controller]()) and the value is a list of 2 action types: one to activate a scene and the other to send a message through a HA service call. *This page assumes you already know how the [`mapping` attribute]() works.* Some controllers fire events for double, triple (or even quadruple) clicks, but others only fire single click events. This feature allows you to manage multiple clicks virtually, especially for those single click events. When adding a new custom mapping for your controller, you can use a token (`$`) to indicate how many times an event needs to occur for the action to be fired. Let's see an example: ``` example_app: module: controllerx class: E1810Controller controller: my_controller integration: name: z2m listen_to: mqtt light: light.my_light multiple_click_delay: 500 # default mapping: brightness_up_click: "on" toggle: click_color_down toggle$1: click_color_up toggle$2: "off" ``` This might be a silly example, but it is enough to highlight some points about this feature. In this configuration we see 2 actions: `brightness_up_click` (not "multi-clickable") and `toggle` ("multi-clickable"). We also see an attribute called `multiple_click_delay`, which indicates the delay (in milliseconds, 500 by default) before a multiple click action is triggered. Let's go over the following scenarios: - `brightness_up_click` is clicked once: The `on` action will be triggered immediately, with no delay. - `toggle` is clicked once: The `click_color_up` action will be triggered after 500ms. Also note that `toggle` and `toggle$1` are basically the same, so if both are present, the one with the token (`$`) prevails. So `click_color_down` will never be called. - `toggle` is clicked twice (with less than 500ms between clicks): The `off` action will be triggered 500ms after the second click. The next example shows a real use of this feature with the E1810 controller from IKEA. ``` livingroom: module: controllerx class: E1810Controller controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.livingroom_lamp smooth_power_on: true merge_mapping: toggle$2: service: light.toggle data: entity_id: light.livingroom_fairylights toggle$3: service: light.toggle data: entity_id: light.bedroom ``` This will keep the default mapping for the E1810 controller by using `merge_mapping` and add new actions when clicking the middle button 2 and 3 times, to toggle the fairy lights and the bedroom lamp. Note that ControllerX registers the multiple-click events in the initialization phase by checking the events with `$`, so it records whether it needs to wait to trigger the multiple-click event or not. If the triggered event is not registered as multiple-clickable, then it will be triggered immediately. However, if the triggered event is multiple-clickable, then it will wait as long as specified in `multiple_click_delay` to detect whether another click is issued or not. If no second (n-th) click is registered, then the event is triggered. Therefore, all multi-clickable events will have a delay specified by `multiple_click_delay`. *This page assumes you already know how the [`mapping` attribute]() works.* Here you can find a list of predefined actions (one of the [action types]()) for each type of controller. ## Light When using a [light controller]() (e.g. `E1743Controller`) or `LightController`, the following actions can be used as a predefined action: | value | description | parameters | | --- | --- | --- | | `"on"` | It turns on the light | \- `attributes`: a mapping with attribute and value | | `"off"` | It turns off the light | | | `toggle` | It toggles the light | \- `attributes`: a mapping with attribute and value | | `toggle_full_brightness` | It toggles the light, setting the brightness to the maximum value when turning on. | | | `toggle_full_white_value` | It toggles the light, setting the white value to the maximum value when turning on. | | | `toggle_full_color_temp` | It toggles the light, setting the color temperature to the maximum value when turning on. | | | `toggle_min_brightness` | It toggles the light, setting the brightness to the minimum value when turning on. | | | `toggle_min_white_value` | It toggles the light, setting the white value to the minimum value when turning on. | | | `toggle_min_color_temp` | It toggles the light, setting the color temperature to the minimum value when turning on. | | | `release` | It stops `hold` actions | | | `on_full_brightness` | It sets the brightness to the maximum value | | | `on_full_white_value` | It sets the white value to the maximum value | | | `on_full_color_temp` | It sets the color temp to the maximum value | | | `on_min_brightness` | It sets the brightness to the minimum value | | | `on_min_white_value` | It sets the white value to the minimum value | | | `on_min_color_temp` | It sets the color temp to the minimum value | | | `on_min_max_brightness` | It sets the brightness to the minimum value if the light is off or the brightness is different from the minimum value; otherwise, it sets the brightness to the maximum value. | | | `on_max_min_brightness` | It sets the brightness to the maximum value if the light is off or the brightness is different from the maximum value; otherwise, it sets the brightness to the minimum value. | | | `on_min_max_color_temp` | It sets the color temp to the minimum value if the light is off or the color temp is different from the minimum value; otherwise, it sets the color temp to the maximum value. | | | `on_max_min_color_temp` | It sets the color temp to the maximum value if the light is off or the color temp is different from the maximum value; otherwise, it sets the color temp to the minimum value. | | | `set_half_brightness` | It sets the brightness to 50% | | | `set_half_white_value` | It sets the white value to 50% | | | `set_half_color_temp` | It sets the color temp to 50% | | | `sync` | It syncs the light(s) to full brightness and white color or 2700K (370 mireds) | \- `brightness`
\- `color_temp`
\- `xy_color` | | `click` | It increases/decreases the attribute according to the `manual_steps` attribute, and allows passing parameters through the YAML config. You can read more about it [here](). | \- `attribute`
\- `direction`
\- `mode`
\- `steps` | | `click_brightness_up` | It increases the brightness according to the `manual_steps` attribute | | | `click_brightness_down` | It decreases the brightness according to the `manual_steps` attribute | | | `click_white_value_up` | It turns the white value up according to the `manual_steps` attribute | | | `click_white_value_down` | It turns the white value down according to the `manual_steps` attribute | | | `click_color_up` | It turns the color up according to the `manual_steps` attribute | | | `click_color_down` | It turns the color down according to the `manual_steps` attribute | | | `click_colortemp_up` | It turns the color temp up according to the `manual_steps` attribute | | | `click_colortemp_down` | It turns the color temp down according to the `manual_steps` attribute | | | `click_xycolor_up` | It turns the xy color up according to the `manual_steps` attribute | | | `click_xycolor_down` | It turns the xy color down according to the `manual_steps` attribute | | | `hold` | It increases/decreases the attribute until release according to the `automatic_steps` attribute, and allows passing parameters through the YAML config. You can read more about it [here](). | \- `attribute`
\- `direction`
\- `mode`
\- `steps` | | `hold_brightness_up` | It increases the brightness until release according to the `automatic_steps` attribute | | | `hold_brightness_down` | It decreases the brightness until release according to the `automatic_steps` attribute | | | `hold_brightness_toggle` | It increases/decreases the attribute until release according to the `automatic_steps` attribute and alternates the direction on each click | | | `hold_white_value_up` | It turns the white value up until release according to the `automatic_steps` attribute | | | `hold_white_value_down` | It turns the white value down until release according to the `automatic_steps` attribute | | | `hold_white_value_toggle` | It turns the white value up/down until release according to the `automatic_steps` attribute and alternates the direction on each click | | | `hold_color_up` | It turns the color up until release according to the `automatic_steps` attribute | | | `hold_color_down` | It turns the color down until release according to the `automatic_steps` attribute | | | `hold_color_toggle` | It turns the color up/down until release according to the `automatic_steps` attribute and alternates the direction on each click | | | `hold_colortemp_up` | It turns the color temp up until release according to the `automatic_steps` attribute | | | `hold_colortemp_down` | It turns the color temp down until release according to the `automatic_steps` attribute | | | `hold_colortemp_toggle` | It turns the color temp up/down until release according to the `automatic_steps` attribute and alternates the direction on each click | | | `hold_xycolor_up` | It turns the xy color up until release according to the `automatic_steps` attribute | | | `hold_xycolor_down` | It turns the xy color down until release according to the `automatic_steps` attribute | | | `hold_xycolor_toggle` | It turns the xy color up/down until release according to the `automatic_steps` attribute and alternates the direction on each click | | | `xycolor_from_controller` | It changes the xy color of the light from the value sent by the controller (if supported) | | | `colortemp_from_controller` | It changes the color temperature of the light from the value sent by the controller (if supported) | | | `brightness_from_controller_level` | It changes the brightness of the light from the value sent by the controller `action_level` (if supported) | | | `brightness_from_controller_angle` | It changes the brightness of the light from the value sent by the controller `action_rotation_angle` (if supported). This fires a `hold` action, so a `release` action is needed to stop the brightness change. | \- `mode`
\- `steps` | | `brightness_from_controller_step` | It changes the brightness of the light from the value sent by the controller `step_mode`/`step_size` (if supported). | | | `colortemp_from_controller_step` | It changes the color temperature of the light from the value sent by the controller `step_mode`/`step_size` (if supported). | | ## Zigbee2MQTT Light When using a [Zigbee2MQTT light controller]() (e.g. `E1743Z2MLightController`) or `Z2MLightController`, the following actions can be used as a predefined action: | value | description | parameters | | --- | --- | --- | | `"on"` | It turns on the light | \- `attributes`: a mapping with attribute and value | | `"off"` | It turns off the light | | | `toggle` | It toggles the light | | | `release` | It stops `hold` actions | | | `on_full_brightness` | It sets the brightness to the maximum value | | | `on_full_color_temp` | It sets the color temp to the maximum value | | | `on_min_brightness` | It sets the brightness to the minimum value | | | `on_min_color_temp` | It sets the color temp to the minimum value | | | `set_half_brightness` | It sets the brightness to 50% | | | `set_half_color_temp` | It sets the color temp to 50% | | | `click` | It increases/decreases the attribute according to the `click_steps` attribute, and allows passing parameters through the YAML config. You can read more about it [here](). | \- `attribute`
\- `direction`
\- `steps`
\- `transition`
\- `use_onoff` | | `click_brightness_up` | It increases the brightness according to the `click_steps` attribute | | | `click_brightness_down` | It decreases the brightness according to the `click_steps` attribute | | | `click_colortemp_up` | It turns the color temp up according to the `click_steps` attribute | | | `click_colortemp_down` | It turns the color temp down according to the `click_steps` attribute | | | `hold` | It increases/decreases the attribute until release according to the `hold_steps` attribute, and allows passing parameters through the YAML config. You can read more about it [here](). | \- `attribute`
\- `direction`
\- `steps`
\- `use_onoff` | | `hold_brightness_up` | It increases the brightness until release according to the `hold_steps` attribute | | | `hold_brightness_down` | It decreases the brightness until release according to the `hold_steps` attribute | | | `hold_brightness_toggle` | It increases/decreases the attribute until release according to the `hold_steps` attribute and alternates the direction on each click | | | `hold_colortemp_up` | It turns the color temp up until release according to the `hold_steps` attribute | | | `hold_colortemp_down` | It turns the color temp down until release according to the `hold_steps` attribute | | | `hold_colortemp_toggle` | It turns the color temp up/down until release according to the `hold_steps` attribute and alternates the direction on each click | | | `xycolor_from_controller` | It changes the xy color of the light from the value sent by the controller (if supported) | | | `colortemp_from_controller` | It changes the color temperature of the light from the value sent by the controller (if supported) | | | `brightness_from_controller_level` | It changes the brightness of the light from the value sent by the controller `action_level` (if supported) | | | `brightness_from_controller_angle` | It changes the brightness of the light from the value sent by the controller `action_rotation_angle` (if supported). This fires a `hold` action, so a `release` action is needed to stop the brightness change. | \- `steps`
\- `use_onoff` | ## Media Player When using a [media player controller]() (e.g. `E1743MediaPlayerController`) or `MediaPlayerController`, the following actions can be used as a predefined action: | value | description | parameters | | --- | --- | --- | | `hold_volume_down` | It turns the volume down until `release` is called | | | `hold_volume_up` | It turns the volume up until `release` is called | | | `click_volume_down` | It turns the volume down one step | | | `click_volume_up` | It turns the volume up one step | | | `volume_set` | It sets the volume to the given level | \- `volume_level`: volume level (from 0 to 1) | | `release` | It calls `release` for `hold` actions | | | `play` | It plays the media | | | `pause` | It pauses the media | | | `play_pause` | It toggles play/pause | | | `next_track` | It skips the track forward | | | `previous_track` | It skips the track backward | | | `next_source` | It changes to the next source | | | `previous_source` | It changes to the previous source | | | `mute` | It mutes the media player | | | `tts` | Text-to-Speech | \- `message`
\- `service`: the service to call without "tts." (str; default: "google\_translate\_say")
\- `cache` (bool; default: None)
\- `language` (str; default: None)
\- `options` (dict; default: None) | | `volume_from_controller_angle` | It changes the volume based on the controller angle (if supported). This fires a `hold` action, so a `release` action is needed to stop the volume change. | | ## Switch When using a [switch controller]() (e.g. `E1743SwitchController`) or `SwitchController`, the following actions can be used as a predefined action: | value | description | parameters | | --- | --- | --- | | `"on"` | It turns the switch on | | | `"off"` | It turns the switch off | | | `toggle` | It toggles the state of the switch | | ## Cover When using a [cover controller]() (e.g. `E1743CoverController`) or `CoverController`, the following actions can be used as a predefined action: | value | description | parameters | | --- | --- | --- | | `open` | It opens the cover | | | `close` | It closes the cover | | | `stop` | It stops the cover | | | `toggle_open` | It stops the cover if it is moving, and opens it otherwise | | | `toggle_close` | It stops the cover if it is moving, and closes it otherwise | | ## How to pass parameters When passing parameters to predefined actions, we need to use the `action` keyword together with the parameters. This is an example that changes the default parameters of the `sync` action: ``` example_app: module: controllerx class: E1810Controller controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.my_light merge_mapping: toggle_hold: action: sync brightness: 128 color_temp: 153 ``` And this is another example for the `toggle` action: ``` example_app: module: controllerx class: E1810Controller controller: controller integration: name: z2m listen_to: mqtt light: light.my_light merge_mapping: toggle: action: toggle attributes: brightness: 128 xy_color: [0.323, 0.329] ``` This page describes how to define a state to execute one action or another depending on the selected state. This is not a ControllerX feature itself, but a combination of the Home Assistant [Input Select]() (a.k.a. Dropdown) and the AppDaemon [callback constraints](). In this page, we will go over a simple example to set up a single controller to manage multiple lights. However, this can also be used for other use cases like: - Change/cycle the state of the controller to run different commands over the same device (e.g. light). - Cycle through a series of light states. First, we need to set up an Input Select. Home Assistant allows you to create one through the UI in `Settings > Devices & services > Helpers`, and then clicking `Dropdown`, but we can also create one through YAML: ``` input_select: controller_state: options: - state_0 - state_1 ``` Once we have the entity in Home Assistant, we can create the following ControllerX configurations: ``` example_app_0: module: controllerx class: E1810Controller controller: your_controller integration: name: z2m listen_to: mqtt light: light.my_light_1 merge_mapping: arrow_left_click: service: input_select.select_previous entity_id: input_select.controller_state arrow_right_click: service: input_select.select_next entity_id: input_select.controller_state constrain_input_select: input_select.controller_state,state_0 example_app_1: module: controllerx class: E1810Controller controller: your_controller integration: name: z2m listen_to: mqtt light: light.my_light_2 merge_mapping: arrow_left_click: service: input_select.select_previous entity_id: input_select.controller_state arrow_right_click: service: input_select.select_next entity_id: input_select.controller_state constrain_input_select: input_select.controller_state,state_1 ``` From this configuration, we see the following: - `arrow_left_click` and `arrow_right_click` are used to change the `input_select.controller_state` state. This service cycles through the options, so we could use only one of them (e.g. `input_select.select_next`). - `constrain_input_select` is used to select which configuration is active depending on the state from `input_select.controller_state`. - The first configuration controls `light.my_light_1`, and the second one controls `light.my_light_2`. This particular example could be simplified if we configured the `input_select` with the names of the `light` entities: ``` input_select: controller_state: options: - light.my_light_1 - light.my_light_2 ``` Then, thanks to [templating](), the configuration would be simplified to the following: ``` example_app: module: controllerx class: E1810Controller controller: your_controller integration: name: z2m listen_to: mqtt light: "{{ states('input_select.controller_state') }}" merge_mapping: arrow_left_click: service: input_select.select_previous entity_id: input_select.controller_state arrow_right_click: service: input_select.select_next entity_id: input_select.controller_state ``` Note that `constrain_input_select` is no longer necessary, since `light` already has a template that gets the entity name dynamically. However, if we want to do any specific mapping depending on the light, we would need to go back to the previous configuration since it is more flexible and allows us to define a mapping for each state. The `Advanced` section of the [examples page]() has more examples using this feature. Templating can be used to set some parameters dynamically when an action is executed, based on the current state of Home Assistant. It uses the [HA templating]() system with the same syntax. It can be used for these types of parameters: - Device types (`light`, `media_player`, `switch`, `cover`) - Predefined actions - Scene activation - Call services ## Examples It can be used to control the media player that is currently playing. This example assumes there is a sensor that gets updated when the current media player changes. ``` example_app: module: controllerx class: E1810MediaPlayerController controller: my_controller integration: name: z2m listen_to: mqtt media_player: "{{ states('sensor.current_media_player') }}" ``` It can also be used to get data for service calls. For example, to set a random effect on our WLED light. ``` example_app: module: controllerx class: Controller controller: my_controller integration: name: z2m listen_to: mqtt mapping: toggle: service: wled.effect data: entity_id: light.wled effect: "{{ state_attr('light.wled', 'effect_list') | random }}" ``` # Examples This page shows some real configuration examples. These configurations are placed in your [`apps.yaml`](). ## Basic E1524/E1810 controller with z2m event entities that controls all the living room lights. ``` livingroom_controller: module: controllerx class: E1810Controller controller: livingroom_controller_action integration: name: z2m listen_to: event light: group.livingroom_lights ``` E1524/E1810 controller integrated with Zigbee2MQTT, but using `mqtt` directly instead of the `z2m` integration. ``` office_light: module: controllerx class: E1810Controller controller: office_controller # This is the Z2M friendly name of the device integration: name: z2m listen_to: mqtt light: light.office ``` Controlling a media player with the E1744 and deCONZ: ``` bedroom_speaker: module: controllerx class: E1744MediaPlayerController controller: symfonisk_controller integration: deconz media_player: media_player.bedroom_speaker ``` Controlling a light (just on/off) with the E1743 and ZHA: ``` bedroom_light: module: controllerx class: E1743Controller controller: 00:67:88:56:06:78:9b:3f integration: zha light: light.simple_light actions: - "on" - "off" ``` Controlling two lights with the Aqara double key wireless switch (z2m): ``` controller_left_switch: module: controllerx class: DoubleKeyWirelessAqaraController controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.light1 manual_steps: 7 actions: - left - left_double - left_long controller_right_switch: module: controllerx class: DoubleKeyWirelessAqaraController controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.light2 manual_steps: 7 actions: - right - right_double - right_long ``` Controlling just the color with the E1810 and z2m, because toggle and brightness are controlled with Zigbee groups. ``` example_app: module: controllerx class: E1810Controller controller: controller integration: name: z2m listen_to: mqtt light: light.light1 actions: - arrow_left_hold - arrow_left_release - arrow_right_hold - arrow_right_release - arrow_right_click - arrow_left_click ``` Controlling a simple light with the Lutron Caseta Pro Pico, but giving the light a slower transition of 800ms: ``` example_app: module: controllerx class: LutronCasetaProPicoLightController integration: state controller: sensor.controller_action light: light.example_light transition: 800 ``` Hue Bridge HA integration for the lights and z2m for the E1810 IKEA controller. ``` hallway_light_group_no_toggle: # all actions, but toggle/hold for smooth operation with light groups on Hue Bridge # use HA groups to control dimming and color/color temp change # use Hue bridge light group for even and synchronized on/off function module: controllerx class: E1810Controller controller: "x90fd9ffffe17d796" integration: name: z2m listen_to: mqtt # transition: 1000 # transition attribute works on Hue bridge smooth_power_on: true light: group.hallway # HA group. ControllerX syncs values from first group entity with remaining entities in group actions: - arrow_left_hold - arrow_left_release - arrow_right_hold - arrow_right_release - arrow_right_click - arrow_left_click - brightness_up_click - brightness_down_click - brightness_up_release - brightness_down_release - brightness_up_hold - brightness_down_hold hallway_light_group_toggle: # toggle/hold for smooth operation with light groups on Hue Bridge # use Hue bridge light group for even and synchronized on/off function module: controllerx class: E1810Controller controller: "x90fd9ffffe17d796" integration: name: z2m listen_to: mqtt # transition: 1000 # transition attribute works on Hue bridge light: light.hallway # Hue light group. On/off completely in sync, as zigbee group commands are used by Hue bridge actions: - toggle - toggle_hold ``` Regular use of the E1743 controller for a light, but delaying the `off` action by 10 seconds. A use case could be a switch at the beginning of a corridor, where we do not want the light to turn off until some time has passed. ``` corridor_controller: module: controllerx class: E1743Controller controller: corridor_controller integration: deconz light: light.corridor action_delay: 2002: 10 ``` Using an xy color light bulb as a color temperature one when it supports color temperature. ``` office: module: controllerx class: E1810Controller controller: office_controller # This is the Z2M friendly name of the device integration: name: z2m listen_to: mqtt light: name: light.office color_mode: color_temp ``` Using an xy color light bulb as a color temperature one when it does NOT support color temperature. ``` office: module: controllerx class: E1810Controller controller: zigbee2mqtt/office_controller/action integration: mqtt light: light.office color_wheel: color_temp_wheel ``` ## Advanced Controlling different lights with the same controller depending on where you are. ``` livingroom_controller: module: controllerx class: E1810Controller controller: controller_id integration: deconz light: light.light1 constrain_input_select: input_select.where_am_i,livingroom controller_bedroom: module: controllerx class: E1810Controller controller: controller_id integration: deconz light: light.light2 constrain_input_select: input_select.where_am_i,bedroom controller_bathroom: module: controllerx class: E1810Controller controller: controller_id integration: deconz light: light.light3 constrain_input_select: input_select.where_am_i,bathroom ``` Controlling different lights with the E1810 controller. Using brightness buttons for one light, arrows for another one and the center to turn off a group of lights. ``` light1_controller: module: controllerx class: LightController controller: e1810_controller integration: deconz light: light.light1 mapping: 2002: "on" 3002: "off" 2001: hold_brightness_up 2003: release 3001: hold_brightness_down 3003: release light2_controller: module: controllerx class: LightController controller: e1810_controller integration: deconz light: light.light2 mapping: 4002: "on" 5002: "off" 4001: hold_brightness_down 4003: release 5001: hold_brightness_up 5003: release all_lights_controller: module: controllerx class: LightController controller: e1810_controller integration: deconz light: group.all_lights mapping: 1002: "off" ``` Extending the smooth power on functionality of the E1810, so when each button is clicked or held while the light is off, it sets the light to its minimum or maximum brightness or color, depending on the button pressed. This assumes you have a light that supports color temperature. ``` livingroom_light_on: module: controllerx class: E1810Controller controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.livingroom constrain_input_boolean: light.livingroom,on livingroom_light_off: module: controllerx class: LightController controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.livingroom mapping: toggle: toggle brightness_up_click: on_full_brightness brightness_down_click: on_min_brightness brightness_up_hold: on_full_brightness brightness_down_hold: on_min_brightness arrow_right_click: on_full_color_temp arrow_left_click: on_min_color_temp arrow_right_hold: on_full_color_temp arrow_left_hold: on_min_color_temp constrain_input_boolean: light.livingroom,off ``` Customising the Aqara magic cube with deCONZ. The keys were extracted from the deCONZ column of its [device page](), and the values from the [predefined media player action list](). ``` example_app: module: controllerx class: MediaPlayerController controller: my_magic_cube_id integration: name: deconz type: gesture media_player: media_player.livingroom_speaker mapping: 1: play_pause # Shake 8: click_volume_down # Rotate left 7: click_volume_up # Rotate right 3: next_track # Flip90 4: previous_track # Flip180 ``` Customising the Aqara magic cube with z2m. This uses the `mapping` attribute to turn on different HA scenes. ``` cube_bedroom: module: controllerx class: Controller controller: cube_bedroom integration: name: z2m listen_to: mqtt mapping: flip90: service: scene.turn_on data: entity_id: scene.bedroom1 flip180: service: scene.turn_on data: entity_id: scene.bedroom2 tap: service: scene.turn_on data: entity_id: scene.bedroom3 ``` Customising the Aqara WXKG01LM. We want to toggle the light, always turning it on with brightness 20 (min: 0, max: 255). For this, we create one app configuration for the default behaviour of the controller, excluding `single`, which toggles the light. Then, we create a custom controller with the `mapping` attribute to give a behaviour to the `single` action. ``` mando_aqara_salon: module: controllerx class: WXKG01LMLightController controller: "0x00158d00027b6d79" integration: name: z2m listen_to: mqtt light: light.0x000d6ffffec2620d_light merge_mapping: single: # Give an action to the `single` event service: light.toggle data: entity_id: light.0x000d6ffffec2620d_light brightness: 20 ``` Customising the E1810 to invert the click and hold actions and control a group of Sonos devices. By default, it skips the track when pressing; with this configuration, it skips the source instead. ``` sonos_speaker: module: controllerx class: MediaPlayerController controller: "0x90fd9ffffe0cbd69" integration: name: z2m listen_to: mqtt media_player: group.sonos_all mapping: toggle: play_pause brightness_up_click: click_volume_up brightness_down_click: click_volume_down brightness_up_hold: hold_volume_up brightness_down_hold: hold_volume_down brightness_up_release: release brightness_up_release: release arrow_right_click: next_source arrow_left_click: previous_source arrow_right_hold: next_track arrow_left_hold: previous_track ``` The next configuration shows the use of the multiple clicks functionality and `merge_mapping`. We want to use the E1810 for a light (`light.light1`), and toggle another light (`light.light2`) when clicking the toggle button twice. We could do this in one app configuration, as you can see in the [multiple clicks page](), but we will do it separately to show that the first configuration needs to change `toggle` to `toggle$1`, so it is detected as a multiple-clickable action. Otherwise, when the center button is clicked twice, it will also toggle `light.light1`. ``` example_app_1: module: controllerx class: E1810Controller controller: my_controller integration: name: z2m listen_to: mqtt light: light.light1 merge_mapping: toggle$1: toggle example_app_2: module: controllerx class: E1810Controller controller: my_controller integration: name: z2m listen_to: mqtt light: light.light2 mapping: toggle$2: toggle ``` The following configuration is a tricky one, but it also shows the power of ControllerX to adapt to any use case. Imagine we want the following for our Symfonisk controller (E1744) with deCONZ: - 1 click: Toggle light on/off. - 2 clicks: Toggle between (predefined) warm and cold white. - 3 clicks: "Switch to alternate behavior". Instead of the default dimming behavior when turning left/right, it changes the color temperature: turning left makes the light colder (more blueish) and turning right makes it warmer (more reddish). - Rotate left/right: This depends on the state set when clicking 3 times. Assuming you have created the following input booleans in HA (`input_boolean.light_mode`, `input_boolean.light_colortemp_mode`), we can use the following configuration: ``` example_app: module: controllerx class: E1744LightController controller: symfonisk_controller integration: deconz light: light.livingroom_lamp automatic_steps: 15 delay: 150 mapping: 2001: hold_brightness_up # Right turn 3001: hold_brightness_down # Left turn 2003: release # Stop right turn 3003: release # Stop left turn constrain_input_boolean: input_boolean.light_mode,on example_app2: module: controllerx class: E1744LightController controller: symfonisk_controller integration: deconz light: light.livingroom_lamp automatic_steps: 15 delay: 150 mapping: 2001: hold_color_up # Right turn 3001: hold_color_down # Left turn 2003: release # Stop right turn 3003: release # Stop left turn constrain_input_boolean: input_boolean.light_mode,off example_app3: module: controllerx class: E1744LightController controller: symfonisk_controller integration: deconz light: light.livingroom_lamp min_color_temp: 200 mapping: 1004: on_min_color_temp # 2 clicks constrain_input_boolean: input_boolean.light_colortemp_mode,on example_app4: module: controllerx class: E1744LightController controller: symfonisk_controller integration: deconz light: light.livingroom_lamp max_color_temp: 400 mapping: 1004: on_full_color_temp # 2 clicks constrain_input_boolean: input_boolean.light_colortemp_mode,off example_app5: module: controllerx class: E1744LightController controller: symfonisk_controller integration: deconz light: light.livingroom_lamp mapping: 1002: toggle # 1 clicks 1004: # 2 clicks service: input_boolean.toggle data: entity_id: input_boolean.light_colortemp_mode 1005: # 3 clicks service: input_boolean.toggle data: entity_id: input_boolean.light_mode ``` The following example shows the potential of [templating](). Let's say we want to execute different [predefined actions]() every time we click a button (E1810 in this case). First, we can create an input select through the UI or YAML in HA: ``` input_select: light_state: options: - on_min_brightness - on_full_brightness - set_half_brightness ``` Then, we can define the following ControllerX configuration to change the option of the input select and apply the selected predefined action: ``` example_app: module: controllerx class: E1810Controller controller: livingroom_controller integration: name: z2m listen_to: mqtt light: light.my_light mapping: toggle: - service: input_select.select_next data: entity_id: input_select.light_state - action: "{{ states('input_select.light_state') }}" ``` ![Three different Sonos displays]() ![Three different Sonos displays]() Using ControllerX - Controlling your Sonos speakers has never been easier 😎 But the occasional wish for a visual check on what’s actually playing, volume setting, media artist/title, active speakers in group etc. is still there 👀 Leaving you with no other choice than adding a display integration as the obvious solution for this need 😉 All it takes is an ESP8266 with ESPHome software, an appropriate display, a handful (well, actually 2 handfuls and then some) of HA sensors and you’re all set to go 🚀 ESPHome is a system framework for ESP8266 units that has support for several I2C OLED/E-ink display types and numerous sensors, has direct HA integration via add-on and easy, yet powerful YAML configuration. Read more about ESPHome and how to set it up in HA here: https://esphome.io/ **Current v1.1 display code uses newly merged display on/off and brightness commands. Use ESPHome version [1.15.0b4]() or newer !** YAML has been tested on NodeMCUv2, Wemos D1 Mini and NodeMCU with integrated display using both SSD1306 & SSD1309 displays (I2C connected). ### Hardware: I initially used the simple and inexpensive (less than 2 US$ ) SSD1306 0,96" OLED display for this build. Resolution is only 128x64. But still enough, when using several pages to be displayed continuously. The SSD1306 has a 'big brother' in the SSD1309 display. This display has identical resolution as SSD1306, is priced at some 14 US$, can use same drivers/library as SSD1306 but is much, much larger at 2,42". I really like this good sized and simple I2C display and ended up using this display in the final build, as it's much easier to read from a distance 🙂 An optional PIR sensor or microwave radar sensor can be added for automatic dimming (brightness control) and turning the display on/off completely. The RCWL 0516 sensor is cheap, but can be somewhat difficult to use in 'tight' builds as it's somewhat sensitive to many things - WiFi in particular. So you could experience some false triggers using this sensor if fitted very close to the ESP8266. AM 312 is a cheap and simple 'no nonsense' PIR sensor that just always works as expected. Sensor can also be used for other purposes as well in HA 🙂 Sensor is configured in YAML using pin D5 (GPIO14). Display is set to dim down after 5 minutes with no PIR triggers and completely off after additional 10 minutes without registered movement. Please note that (at least on my display version) SSD1309 display can't be turned completely off with `id(display_id).set_brightness(0)` command, but this works perfectly on my SSD1306 display. Instead SSD1309 has to be turned on/off with specific `id(display_id).turn_on()`/`id(display_id).turn_off()` commands. Check what works on **your** display and revise implementation method/ESPHome yaml config code accordingly. I've collected some hardware link examples below. These are just some random sellers I've picked. Not necessarily the cheapest or best sellers. [Wemos D1 mini – ESP8266]() [0,96" 12864 SSD1306 OLED display]() [2,42” 12864 SSD1309 OLED display]() (direct replacement for the much smaller 0,96” SSD1306 display and can use same library) Alternatively you can use a [Wemos NodeMCU ESP8266 with integrated 0,96" OLED display]() **Optional sensors to dim display when no movement is detected.** Movement sensor 1: [RCWL 0516 Microwave Micro Wave Radar Sensor Board]() Movement sensor 2: [AM312 \# PIR Motion Human Sensor]() **One note on the SSD1309 display** In order to get display to work with I2C instead of SPI, you need to do a bit of soldering. On the specific display type I bought, you need to bridge (short) R5 and move R4 to R3. Remember that display will NOT work unless RES is connected to RST on ESP8266 (or any available pin and controlled in ESPHome sw). Note: Display only supports 3,3v on VCC. Some have reported that display tolerates 5v (some might). I wouldn’t take that risk, though! I’ve kept both CS and DS ‘floating’. Haven’t had any I2C address issues so far. Use pull-up/down resistors if you experience issues. **Connections:** **SSD1306/1309 --\> Wemos D1 mini** ``` VCC: 3,3v !!! (SSD1306 only: 3,3v-5v) GND: GND SDA: D1 SCL: D2 ``` **SSD1309 only --\> Wemos D1 mini** ``` RES: D0 or RST CS : NC (No Connection - 'floating'. Default I2C address 0x3c) DC : NC (No Connection - 'floating') ``` ### Display setup: My current display setup consists of four pages that all are displayed for 5 seconds. Following information is displayed on the screen: **All pages:** Source (if not present, display ‘Sonos/Playlist’), mute sign, volume setting and play/pause/idle status. Also displays shuffle sign when active for playlists **Page 1:** Active main/passive speakers. **Page 2:** Media artist/media title (if not available from stream, display time instead) **Page 3:** Time **Page 4:** Outdoor temperature sensor value ### True Type Fonts: Three 'standard' Calibri TT fonts are used plus a 'special' version of Heydings Icons font in which I've included some Heydings Controls icons as well. If you experience some strange characters on the display, you probably need to edit the glyphs in ESPHome YAML and add whatever language specific characters you find are missing. Calibri TTF fonts [link]() Heydings Icons special file [link]() Copy Calibri Bold, Calibri Regular, Calibri Light fonts plus the special Heydings Icons Symbols font file to the ESPHome folder `/config/esphome/` ### Home Assistant sensors: Below you’ll find the HA template sensors needed in `configuration.yaml` for the ESPHome display to work. ESPHome will establish some four HA sensors as well, presented on HA frontend: PIR sensor, connection status, WiFi strength and display on/off sensor. If display on/off is turned off from HA, then triggering PIR will not turn on display or alter brightness. Note: `media_artist` and `media_title` attributes from HA's Sonos integration *could* be swapped for some radio stations, as these attributes are split from one combined string in the stream. Some radio stations have artist - title order, others use title - artist. You really can't tell... My danish radio stations (source list) all use the 'swapped' version, so my templates below swap these two attributes for radio stations. Enter your main speaker as trigger entity ID for all templates but the first two (search for `media_player.office` and replace with your main speaker entity). Without this specific hardcoded trigger entity, templates simply don't always update correctly. So unfortunately they're needed for now, until I hopefully find a 'cleaner' and more dynamic solution. ``` # Sonos sensors sensor: - platform: template sensors: sonos_main_friendly: friendly_name: "Sonos main Friendly" entity_id: group.sonos_all value_template: "{{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'friendly_name') }}" sonos_passives_friendly: friendly_name: "Sonos passives Friendly" entity_id: group.sonos_all value_template: >- {% for entity_id in state_attr("group.sonos_all", "entity_id")[1:] -%} {% set friendly_name = state_attr(entity_id, "friendly_name") %} {%- if loop.last %}{{ friendly_name }}{% else %}{{ friendly_name }}, {% endif -%} {%- endfor %} media_title: # Swap title/artist if 'source' attribute is not present = radio entity_id: media_player.office # Sonos main speaker value_template: >- {% if is_state('sensor.media_source' , "no source") %} {{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'media_title') }} {% else %} {{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'media_artist') }} {% endif %} media_artist: # Swap title/artist if 'source' attribute is not present = radio entity_id: media_player.office # Sonos main speaker value_template: >- {% if is_state('sensor.media_source' , "no source") %} {{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'media_artist') }} {% else %} {{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'media_title') }} {% endif %} media_album_name: entity_id: media_player.office # Sonos main speaker value_template: "{{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'media_album_name') }}" media_source: # Remove all after 'DR P4 Fyn' as source (to fit on display) entity_id: media_player.office # Sonos main speaker value_template: >- {% if state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'source') %} {{states.media_player.office.attributes.source.split('96.8')[0]}} {% else %} no source {% endif %} volume: entity_id: media_player.office # Sonos main speaker value_template: "{{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'volume_level')|float * 100 }}" sonos_main_group_entities: entity_id: media_player.office # Sonos main speaker value_template: "{{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'sonos_group') }}" ``` ### Home Assistant group: Here you define your Sonos speaker entities. The main speaker has to be entered as the first entity, and that's all that's actually needed. Active passive speakers will dynamically be added on HA restart or when group configuration is changed (e.g. via the Sonos app or HA service calls). If you're only using one speaker, you still need to create the group in `groups.yaml` and populate with that single main speaker entity, as the group entity is needed in the code. **One note on main speaker, passives and Sonos groups** Your defined main speaker actually doesn't need to be ***the*** main speaker. As long as it's part of the group (main ***or*** passive), then display will still show data for the group. But if defined main speaker is removed from the group, it will be a 'single speaker group' on its own, and display will reflect main speaker data only. ``` sonos_all: name: sonos_all entities: - media_player.office # This HAS to be your main speaker # - media_player.kitchen # Optional - passive speaker #1 # - media_player.livingroom # Optional - passive speaker #2 ``` ### Home Assistant automations: First automation is identical with the one I've already used in my ControllerX Sonos group setup example [link](). Second automation is purely optional, and not really directly related to the display. It's just a quick shortcut to easily reset active speakers within group, volume and source playing to some defaults you've defined in the automation. Really nice when you have teenagers in the house, messing with active speaker entities in the group, playlists and volume all the time... 😉 The automation is written for an Ikea E1810 remote with z2m ControllerX HA integration. Here `toggle_hold` (press and hold center button for appx. 3.5 seconds) is used as trigger. ``` - id: Dynamic Sonos groups alias: Dynamic Sonos groups trigger: platform: state entity_id: sensor.sonos_main_group_entities # Same as defined in configuration.yaml platform: homeassistant event: start action: - service: group.set data_template: object_id: sonos_all # Name of Sonos group in groups.yaml entities: "{{ state_attr(state_attr('group.sonos_all', 'entity_id')[0], 'sonos_group') | join(',') }}" - id: Sonos reset to defaults settings alias: Sonos reset to defaults settings trigger: platform: state entity_id: sensor.your_E1810_sensor_action to: 'toggle_hold' action: - service: sonos.join data: main: media_player.office # This HAS to be your main speaker entity_id: - media_player.kitchen # passive speaker #1 - media_player.livingroom # passive speaker #2 - service: media_player.volume_set # Reset volume to 25 for all speakers data_template: entity_id: - media_player.office - media_player.kitchen - media_player.livingroom volume_level: 0.25 - service: media_player.select_source # Reset to your default choice of source data: entity_id: media_player.office # This HAS to be your main speaker source: 'DR P4 Fyn 96.8 (Nyheder)' - service: media_player.media_play # Start playing entity_id: media_player.office # This HAS to be your main speaker ``` ### ESPHome YAML configuration: As ESPHome currently doesn't support attributes, all data to be displayed has to be in separate HA sensors. Hence the huge amount of sensors. If you're not using a movement sensor in your build, you could (but actually don't need to) revise YAML. If you experience issues with the 'floating' GPIO used for the PIR sensor, just pull pin D5 permanently low or high. Two entities need to be entered. Your Sonos main speaker and optional temperature sensor. If temperature sensor is omitted, you can just revise YAML and delete page 3 & 4 from the display lambda configuration. Also remember to revise `interval` page count from 4 to 2. Revise `sonos_status` and `outdoor_temp` sensors in YAML below, to match your HA entities for Sonos main speaker and outdoor temperature sensor. Create a new ESPHome node and configure it with your ESP8266 board settings and WiFi credentials. Edit node and copy/paste revised YAML below to your node. Remember to insert your node's autogenerated WiFi ap settings to YAML. Save it, upload and enjoy! 🎉😎 **One final note on current YAML configuration** ESPHome is at **max** with all these included sensors, schedulers running and the quite extensive display lambda. Adding just one extra sensor to current YAML, will make ESPHome crash on boot. Omitting `fast_connect: true` from the WiFi configuration in YAML will also send ESPHome into an eternal stack trace error boot loop 🚀💀 So 'tweak' YAML with care! 😁😉 ``` substitutions: devicename: sonos_display friendly_name: Sonos Display device_description: Sonos SSD1306/1309 display for Sonos groups esphome: name: $devicename comment: ${device_description} platform: ESP8266 board: d1_mini wifi: ssid: "your_ssid" password: "your_password" fast_connect: true # Mandatory for fast WiFi connect to avoid stack trace error on boot manual_ip: static_ip: 192.168.XX.XX # Enter your static IP address. Needed for fast WiFi connect to avoid stack trace error on boot gateway: 192.168.XX.XX # Enter your gateway subnet: 255.255.255.0 # Enter your subnet # Enable fallback hotspot (captive portal) in case wifi connection fails. Replace with your own node settings ap: ssid: "Sonos Display Fallback Hotspot" password: "your_autogenerated_password" captive_portal: # Enable logging logger: # Enable Home Assistant API api: ota: time: - platform: homeassistant id: esptime switch: # ** Not used - Currently ESPHome can't handle more sensors/switches than already installed *** #- platform: restart # name: "${friendly_name} Restart" # icon: "mdi:restart" - platform: template name: "${friendly_name} On/Off" id: sonos_display turn_on_action: - switch.template.publish: id: sonos_display state: ON - lambda: |- id(sonos).turn_on(); id(sonos).set_brightness(1); turn_off_action: - switch.template.publish: id: sonos_display state: OFF - lambda: |- id(sonos).turn_off(); sensor: # Outdoor temperature sensor - only used in display lambda page 4 - platform: homeassistant id: outdoor_temp entity_id: sensor.your_temperature_sensor internal: true - platform: homeassistant id: sonos_volume entity_id: sensor.volume internal: true # Create WiFi signal sensor in HA - platform: wifi_signal name: "${friendly_name} WiFi Signal" update_interval: 60s text_sensor: # Sonos main speaker - platform: homeassistant id: sonos_status entity_id: media_player.your_main_speaker internal: true - platform: homeassistant id: media_source entity_id: sensor.media_source internal: true - platform: homeassistant id: media_artist entity_id: sensor.media_artist internal: true - platform: homeassistant id: media_title entity_id: sensor.media_title internal: true # ** Not yet used - Currently ESPHome can't handle more sensors than already installed *** #- platform: homeassistant # id: media_album_title # entity_id: sensor.media_album_title // Not in use yet # internal: true - platform: homeassistant id: sonos_main entity_id: sensor.sonos_main_friendly internal: true - platform: homeassistant id: sonos_passives entity_id: sensor.sonos_passives_friendly internal: true binary_sensor: - platform: homeassistant id: mute entity_id: binary_sensor.is_volume_muted internal: true - platform: homeassistant id: shuffle entity_id: binary_sensor.shuffle internal: true - platform: gpio pin: D5 name: "${friendly_name} PIR" device_class: motion on_press: then: - binary_sensor.template.publish: id: dim_display state: ON - binary_sensor.template.publish: id: display_off state: ON on_release: then: - binary_sensor.template.publish: id: dim_display state: OFF - binary_sensor.template.publish: id: display_off state: OFF # Create HA connected sensor - platform: status name: "${friendly_name} Status" - platform: template id: dim_display filters: - delayed_off: 5min # Dim display after 5 minutes on_press: # brightness is float (from 0 to 1). 1 = 100% then: - lambda: |- if (id(sonos_display).state == true) { id(sonos).turn_on(); id(sonos).set_brightness(1); } on_release: # brightness is float (from 0 to 1). 0.01 = 1% then: - lambda: |- id(sonos).set_brightness(0.01); - platform: template id: display_off filters: - delayed_off: 15min # Turn off display after 15 minutes on_release: then: - lambda: |- id(sonos).turn_off(); font: - file: "Calibri Bold.ttf" id: font_large size: 23 glyphs: '!%"()+,-_.:°0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz█£$@æøåÆØÅ&#''´’?üöäé' - file: "Calibri Regular.ttf" id: font_medium size: 19 glyphs: '!%"()+,-_.:°0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz█£$@æøåÆØÅ&#''´’?üöäé' - file: "Calibri Light.ttf" id: font_small size: 11 glyphs: '!%"()+,-_.:°0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz█£$@æøåÆØÅ&#''´’?üöäé' - file: "Calibri Bold.ttf" id: font_small_bold size: 12 glyphs: '!%"()+,-_.:°0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz█£$@æøåÆØÅ&#''´’?üöäé' - file: "HeydingsIconsSymbols.ttf" id: font_icons_large size: 23 glyphs: "0679HADJabjsmx" - file: "HeydingsIconsSymbols.ttf" id: font_icons_medium size: 19 glyphs: "0679HADJabjsmx" - file: "HeydingsIconsSymbols.ttf" id: font_icons_14 size: 14 glyphs: "0679HADJabjsmx" - file: "HeydingsIconsSymbols.ttf" id: font_icons_small size: 11 glyphs: "0679HADJabjsmx" globals: - id: display_page type: int restore_value: no initial_value: "0" # On first boot, value=0 initiates display.turn_on() command. Can't run as on_boot command interval: - interval: 5s # Show each page for 5 seconds then: - lambda: |- if (id(display_page) == 0) { id(sonos_display).turn_on(); } if (id(display_page) < 4) { id(display_page)++; } else { id(display_page) = 1; } i2c: sda: D1 scl: D2 frequency: 100khz # Default 50kHz. Min. setting at 100kHz needed. Otherwise lambda is so slow that warnings appear in log display: - platform: ssd1306_i2c model: "SSD1306 128x64" reset_pin: D0 address: 0x3C # Default address for most SSD1306/1309 displays brightness: 100% update_interval: 1s id: sonos pages: lambda: |- if (id(media_source).state != "no source") { it.printf(64, 0, id(font_large), TextAlign::TOP_CENTER, "%.12s", id(media_source).state.c_str()); } else { if (id(display_page) == 1 or (id(display_page) == 3)) { it.printf(64, 0, id(font_large), TextAlign::TOP_CENTER, "Sonos"); // if no source list attribute, display Sonos Playlist instead } else { it.printf(64, 0, id(font_large), TextAlign::TOP_CENTER, "Playlist"); // if no source list attribute, display Sonos Playlist instead } if (id(shuffle).state) { it.printf(127, 17, id(font_icons_large), TextAlign::BOTTOM_RIGHT, "x"); // shuffle playlist sign at top right position } } if (id(mute).state) { it.printf(0, 20, id(font_icons_medium), TextAlign::TOP_LEFT, "0"); // speaker mute sign } else { it.printf(0, 20, id(font_icons_medium), TextAlign::TOP_LEFT, "m"); // speaker on sign } it.printf(21, 22, id(font_medium), TextAlign::TOP_LEFT, "%.f", id(sonos_volume).state); if (id(sonos_status).state == "playing") { it.printf(127, 18, id(font_icons_medium), TextAlign::TOP_RIGHT, "6"); // pause sign } else if (id(sonos_status).state == "paused") { it.printf(127, 18, id(font_icons_medium), TextAlign::TOP_RIGHT, "7"); // play sign } else { it.printf(127, 18, id(font_icons_medium), TextAlign::TOP_RIGHT, "9"); // stop sign } it.printf(107, 22, id(font_medium), TextAlign::TOP_RIGHT, "%s", id(sonos_status).state.c_str()); if (id(display_page) == 1) { it.printf(00, 53, id(font_icons_small), TextAlign::BOTTOM_LEFT, "s"); // star sign for main speaker it.printf(64, 53, id(font_small_bold), TextAlign::BOTTOM_CENTER, "%s", id(sonos_main).state.c_str()); it.printf(00, 65, id(font_icons_small), TextAlign::BOTTOM_LEFT, "a"); // chain sign for passive speaker(s) it.printf(64, 65, id(font_small), TextAlign::BOTTOM_CENTER, "%s", id(sonos_passives).state.c_str()); } else if (id(display_page) == 2) { if (id(media_title).state != "None") { it.printf(73, 53, id(font_small), TextAlign::BOTTOM_CENTER, "%.24s", id(media_title).state.c_str()); it.printf(73, 65, id(font_small), TextAlign::BOTTOM_CENTER, "%.24s", id(media_artist).state.c_str()); it.printf(00, 51, id(font_icons_14), TextAlign::BOTTOM_LEFT, "j"); // note sign (title) it.printf(00, 65, id(font_icons_small), TextAlign::BOTTOM_LEFT, "A"); // person sign (artist) } else { it.strftime(64, 42, id(font_large), TextAlign::TOP_CENTER, "%H:%M:%S", id(esptime).now()); } } else if (id(display_page) == 3) { it.strftime(64, 42, id(font_large), TextAlign::TOP_CENTER, "%H:%M:%S", id(esptime).now()); } else { it.printf(64, 42, id(font_large), TextAlign::TOP_CENTER, "Out: %.1f°C", id(outdoor_temp).state); } ``` ## Change log - Initial version published July, 2020 - v1.1 published September, 2020 - Added optional sensor for brightness control & display on/off - Added 'shuffle' & 'mute' signs - When idle, display 'stop' sign and 'idle' text - Revised display lambda page code - Four ESPHome sensors exposed in HA - Connected status - WiFi strength - Display on/off - PIR Future plans: - Design 2,9" E-paper display version - Improve/simplify HA sensor templates (if possible) - Remove need for main entity everywhere in config files Thank you Xavi for providing the perfect solution for some of my templating issues 👍😎 September, 2020 *[@htvekov]()* ![Three different Sonos displays]() ### SONOS/SYMFONISK single speaker ControllerX can control single speakers 'out of the box' with the following small app setup. Supports: - Toggle play/pause, volume up/down, previous/next song (in playlist) and previous/next favourites from Sonos app (source list). This favourites list can consist of both radio stations, playlists, podcasts etc. The source list is 'circular', meaning that choosing next when at the last source in the list will skip to the first one, and vice versa. ``` office_sonos_controller: module: controllerx class: E1810MediaPlayerController controller: controller integration: name: z2m listen_to: mqtt volume_steps: 20 # default setting is 10. This will increase default steps to 20 from no volume to full volume media_player: media_player.office ``` ### SONOS/SYMFONISK groups ControllerX supports Sonos groups as well. If `media_player` in the app is set to a group, ControllerX will read the Sonos source list from the FIRST `entity_id` in the group. So this has to be your chosen main speaker! This setup will work perfectly, if you only use static groups that are never altered (via Sonos app/HA or otherwise). But if your Sonos group changes through the day (other family members redefine the group speakers to their liking), you need a dynamic group setting. This can easily be achieved by adding only one sensor and one small automation to your HA configuration. #### HA configuration.yaml ``` - platform: template sensors: sonos_main_group_entities: value_template: "{{ state_attr('media_player.office', 'sonos_group') }}" #main speaker ``` #### HA automation.yaml ``` id: dynamic_sonos_groups alias: dynamic_sonos_groups trigger: platform: state entity_id: sensor.sonos_main_group_entities # Same as defined in configuration.yaml action: - service: group.set data_template: object_id: sonos_all #name of sonos group in groups.yaml entities: "{{ state_attr('media_player.office', 'sonos_group') | join(',') }}" #main speaker ``` #### HA groups.yaml ``` name: sonos_all entities: - media_player.office #this HAS to be your main speaker - media_player.kitchen #passive speaker #1 - media_player.livingroom #passive speaker #2 ``` And with the following ControllerX configuration, you will be able to control the dynamic group in HA, which will be updated immediately if the group is changed, e.g. from the Sonos app. The app below has 'flipped' the arrow functions, so click changes the source and hold changes to the previous/next song in the playlist. This behaviour will most likely fit better for users that primarily use favourites (radio stations). #### AppDaemon apps.yaml ``` sonos_group: module: controllerx class: MediaPlayerController controller: controller integration: name: z2m listen_to: mqtt volume_steps: 20 media_player: group.sonos_all # Sonos group in groups.yaml mapping: toggle: play_pause brightness_up_click: click_volume_up brightness_down_click: click_volume_down brightness_up_hold: hold_volume_up brightness_down_hold: hold_volume_down brightness_up_release: release brightness_down_release: release arrow_right_click: next_source arrow_left_click: previous_source arrow_right_hold: next_track arrow_left_hold: previous_track ``` *This example was provided by [@htvekov]()* **Updated November, 2022.** ### Control a single RGB light using a Tasmota device with two buttons This example shows how to control an RGB light using the `Button1` to decrease brightness, color temperature, and color, and the `Button2` to increase brightness, color temperature, and color. For that, and as explained in the [docs](), you should set `SetOption73 1` to detach the buttons from the relays you might have, and to make the device publish MQTT messages instead. #### Motivation In most of my rooms, I have a Sonoff Mini behind the switch in the wall, connected to one or more Zigbee RGB bulbs. Then, I replaced the wall switches with double push buttons of the same brand and model (to keep aesthetics and have my wife's approval). The Sonoff Mini allows connecting a button to the terminal header, plus another button to GPIO16 on the board itself through a pin header used to activate the DIY mode, so I connected those two buttons to the Sonoff so I can control the bulbs without cutting the power when the switch is toggled. I use the left button as `Button1` and the right button as `Button2`. #### Requirements Tasmota: v12.2.0 or newer ControllerX: v4.24.0 or newer #### This example will - toggle light on low brightness and warm white on `Button1` single press - toggle light on high brightness and warm white on `Button2` single press - decrease light brightness when `Button1` is held - increase light brightness when `Button2` is held - decrease color temperature on `Button1` double pressed - increase color temperature on `Button2` double pressed - rotate XY color down on `Button1` triple pressed - rotate XY color up on `Button2` triple pressed #### ControllerX apps.yaml example ##### Button1 (decrease) ``` test_light_down: module: controllerx class: TasmotaButtonLightController controller: stat/test_device/RESULT # define your device topic here integration: name: tasmota component: Button1 light: light.example_light # define your own light entity manual_steps: 5 merge_mapping: SINGLE: action: toggle attributes: brightness: 76 color_temp: 500 DOUBLE: click_colortemp_down TRIPLE: click_xycolor_down HOLD: action: hold_brightness_down ``` ##### Button2 (increase) ``` test_light_up: module: controllerx class: TasmotaButtonLightController controller: stat/test_device/RESULT # define your device topic here integration: name: tasmota component: Button2 light: light.example_light # define your own light entity manual_steps: 5 merge_mapping: SINGLE: action: toggle attributes: brightness: 254 color_temp: 500 DOUBLE: click_colortemp_up TRIPLE: click_xycolor_up HOLD: action: hold_brightness_up ``` *This example was provided by [@cmiguelcabral]()* **Updated August, 2020. Changelog at last page** ### Tasmota SwitchMode 11/12 wall switch implementation with Home Assistant / ControllerX Want to make your 'dumb' wall switches smart and at the same time improve installation of smart lights WAF 👩‍🦰 ? Then the solution could be to 'Tasmotize' your wall switches, and use Home Assistant with the ControllerX app to control the smart light connected to that switch. With this setup, you'll be able to toggle, turn lights on at full brightness, sync and dim your lights directly from your wall switch. Today, many WIFI switches are so small, that they can fit behind wall outlets/switches or in ceiling outlets. Personally, I've used [Shelly One devices]() and [Itead Sonoff Mini's](). Both are easy to flash with Tasmota using either USB-to-UART adapter or directly OTA. No soldering is actually needed these days. The flash part and build instructions are too comprehensive to elaborate on further in this documentation. Instructions are 'out there' - Google it! 😉 One of my Sonoff Mini installations behind a wall switch. Danish wall switch modules are typically not larger than appx. 50x50mm pr. module (outside measurements). I’ve LK Opus 66 installed, which is a slightly larger type measuring 66mm in width. Still I can squeeze a Sonoff Mini in behind a ‘typical’ double module wall switch. Shelly devices are a bit smaller, round in shape and in general easier to fit than the Sonoff Mini’s. ![switchmode11-12.jpeg]() **One final warning:** Using Shelly/Sonoff devices behind wall switches/outlets involves fiddling with **⚡HIGH VOLTAGE⚡** that could potentially **INJURE OR KILL YOU 🩸😱💀**, if not handled/installed correctly !! Furthermore, local building code might prohibit use of such devices in wall outlets and unauthorized installation will most likely be illegal in most countries. If you don't know EXACTLY what you're doing - then DON'T proceed with this project !! Now you've been warned !! Following example is with a Shelly One device, placed in the wall socket behind the switch, to control an Ikea WS bulb in the ceiling outlet. The bulb is connected to Home Assistant via Zigbee2MQTT. I've refitted my wall switch with a spring, so it'll act like a push button. The Switchmode11/12 option in Tasmota, gives the user six different switch commands to be used for automation. With ControllerX only four of these commands are needed, as ControllerX internally controls changes in dimming direction. These commands (events) are sent directly to ControllerX via MQTT. #### Switchmode11/12 Tasmota output commands are: ``` Switchstate=2: toggle (Normal TOGGLE function. One single press) Switchstate=4: inc-dec (HOLD function. Sent after delay defined with Setoption32) Switchstate=5: inv (INVERSE dim direction function. Not used in this implementation, as ControllerX handles this internally) Switchstate=6: clear (Delayed RELEASE function. Sent when button is released AFTER delay defined with Setoption32. Not used in this implementation) Switchstate=7: clear (Normal RELEASE function. Sent immediately after button is released) Switchstate=8: double (DOUBLE press function. Two consecutive presses within time delay defined with SetOption32) ``` #### Requirements: Tasmota: v8.4.0.2 or newer ControllerX: v3.4.0b1 or newer #### Shelly device Tasmota setup (Use switchmode 11 !!): Module type: Shelly 1 (46): #### Sonoff Mini device Tasmota setup (Use switchmode 12 !!): Module type: Sonoff Basic (1) GPIO4: Switch1 (9) #### Setup ControllerX app: Both examples listed below will: - toggle light(s) upon single button press - dim light(s) up/down when button is held - Turn light(s) on at full brightness upon double press First example is with two separate controllers. This will also handle `HOLD FROM LIGHTS OFF` situation. Which, when lights are off, will `SYNC` light/lights when button is held for 0,8 sec. ##### ControllerX apps.yaml example no. 1: ``` controller_switchmode11_on: module: controllerx class: LightController controller: tasmota_topic # Normally z2m friendly name. Here topic used in Tasmota rules integration: state name: z2m listen_to: mqtt action_key: action # Defaults to action if not specified light: light.your_light # define your own light entity constrain_input_boolean: light.your_light,on # This whole configuration will work when the light is on mapping: toggle: toggle inc-dec: hold_brightness_toggle clear: release double: on_full_brightness controller_switchmode11_off: module: controllerx class: LightController controller: tasmota_topic # Normally z2m friendly name. Here topic used in Tasmota rules integration: state name: z2m listen_to: mqtt action_key: action # Defaults to action if not specified light: light.your_light # define your own light entity constrain_input_boolean: light.your_light,off # This whole configuration will work when the light is off mapping: toggle: toggle inc-dec: sync double: on_full_brightness ``` Second example is a more simple setup, where `smooth_power_on` is enabled instead, when button is held from lights off position. ##### ControllerX apps.yaml example no. 2: ``` tasmota_switchmode11: module: controllerx class: LightController controller: tasmota_topic # Normally z2m friendly name. Here topic used in Tasmota rules integration: state name: z2m listen_to: mqtt action_key: action # Defaults to action if not specified smooth_power_on: true # enable 'smooth power on' feature when button is held from lights off delay: 250 # change delay if you want faster/slower dimming response (default: 350 ms.) light: light.your_light # define your own light entity mapping: toggle: toggle inc-dec: hold_brightness_toggle clear: release double: on_full_brightness ``` #### Notes on Appdaemon and HA's state machine: Things unfortunately take time when HA's state machine is involved! This can be noticeable for some (for others not), when AppDaemon apps have to check HA states, e.g. by using `constrain_input_boolean` (as in example 1) or change HA states by toggling lights. In my setup, using a constrain\_input\_boolean adds some 100 ms. delay on execution. Not much on its own, but still worth to keep in mind. Toggling lights via HA automation is also some 100 ms. faster than toggling through Appdaemon/ControllerX. So in order to get the fastest possible toggle of lights, I'm personally using a simple HA automation for toggling lights and let ControllerX handle everything else 🙂 Optional HA toggle automation below. Remember to remove `toggle` from mapping in Appdaemon/ControllerX apps.yaml 😉 ``` # Toggle lights through HA using direct MQTT events. Quicker response than using platform state or directly in appdaemon ControllerX app - alias: tasmota_switchmode11_toggle trigger: platform: mqtt topic: zigbee2mqtt/tasmota_topic payload: "{\"action\": \"toggle\"}" # escape characters needed ! action: service: light.toggle data: entity_id: light.your_light ``` #### Setup needed commands and rules in Tasmota software via console: ``` Powerretain1 1 Retain Tasmota power settings in HA in event of power outage Setoption1 1 Allow only single, double and hold press button actions Setoption32 8 Delay for HOLD button (in 0,1 sec.). I use 8 = 0,8 sec. Max value allowed is 63 !! Setoption34 50 Minimize delay between backlog commands to 50 ms. (Default 200 ms.) Switchtopic 0 Disable switchtopic. Needed when using rules in Tasmota. Switchmode1 11 Set Tasmota to switchmode11 RULE1 on switch1#state=2 do publish zigbee2mqtt/tasmota_topic {"action": "toggle"} endon on switch1#state=8 do publish zigbee2mqtt/tasmota_topic {"action": "double"} endon on switch1#state=7 do backlog publish zigbee2mqtt/tasmota_topic {"action": "clear"};rule3 1 endon RULE2 on mqtt#disconnected do rule1 0 endon on mqtt#connected do rule1 1 endon RULE3 5 on switch1#state=4 do backlog publish zigbee2mqtt/tasmota_topic {"action": "inc-dec"};rule3 0 endon ``` **NB: Note the extra decimal '5' in RULE3 !!** **RULE1** sends the TOGGLE and DOUBLE press command via MQTT . CLEAR command is fired upon button release and RULE3 is enabled again (ready for next HOLD command). **RULE2** handles the 'fall back' to direct switch control if MQTT server is unavailable. Nice WAF feature, if HA/MQTT server is down. Then lights still can be toggled on/off using the wall switch. **RULE3** sends the HOLD command and disables itself (to ensure only one HOLD command is fired). RULE3 is set as 'run once' in Tasmota (with the decimal 5 after the rule number) to prevent extra HOLD commands from being fired before the rule is disabled. Rules also need to be 'escaped', if used with HA automation. Tasmota will automatically add needed escape characters, if rules are entered without. #### Changelog: **doc v1.0:** - Initial example documentation May, 2020 **doc v1.1:** - Deprecated use of custom controllers in example. These will shortly be deprecated as well in ControllerX - Changed from HA sensor state to official z2m MQTT event implementation using JSON objects (speed improvement!) - New switchmode 11/12 `DOUBLE` press command implemented *This example was provided by [@htvekov]()* # Optional If we want to use the `mqtt` or `tasmota` integrations, `listen_to: mqtt` in the `z2m` integration, or the `Z2MLightController` with `mode: mqtt`, we need to enable the MQTT plugin in the AppDaemon configuration (`appdaemon.yaml`). Depending on how you [installed ControllerX](), this file is in: - ControllerX app: `/app_configs/d35634e3_controllerx/appdaemon.yaml` - AppDaemon app: `/app_configs/a0d7b954_appdaemon/appdaemon.yaml` Add the following highlighted section to that file: ``` --- appdaemon: latitude: X.XXXXXXX longitude: X.XXXXXXX elevation: XXXX time_zone: XXXXXXXX missing_app_warnings: 0 # (1) plugins: HASS: type: hass token: !env_var SUPERVISOR_TOKEN MQTT: type: mqtt namespace: mqtt # This is important client_id: controllerx # (2) client_host: core-mosquitto # (3) client_user: XXXXX # (4) client_password: !secret mqtt_password # (5) http: url: http://0.0.0.0:5050 admin: api: ``` 1. Extra tip: you can add `missing_app_warnings` if you don't want any warning spam from ControllerX when starting AppDaemon. 2. A name no other MQTT client uses. Without it, AppDaemon connects as `appdaemon_mqtt_client`, so if both the ControllerX app and the AppDaemon app use MQTT, the broker keeps disconnecting one of them. 3. `core-mosquitto` if you use the Mosquitto broker app. Otherwise, the host of your MQTT broker without the port (e.g. 192.168.1.10). 4. The user and password of your MQTT broker. 5. Add `mqtt_password: ` to `secrets.yaml`, next to `appdaemon.yaml` (or to the file set in `secrets:`, if your `appdaemon.yaml` has that line). You can also write the password here directly. Then restart the ControllerX app or the AppDaemon app. [AppDaemon]() lets you write Home Assistant automations in Python instead of YAML. For simple automations, YAML or the automation editor are great, but when automations get more complicated, they become difficult to manage in YAML. This is where AppDaemon comes in. This is the reason this project is built on top of AppDaemon. Now you might be convinced, but have no idea how to install and set it up. If you are using Home Assistant OS, the [installation]() page explains your two options: the ControllerX app, which includes its own AppDaemon, or the `AppDaemon` app from the app store with ControllerX installed in it. How to update ControllerX depends on how you [installed it](): - **ControllerX app:** update the app from **Settings → Apps**. The app restarts on its own. - **Manual installation:** follow the [updating steps]() and restart the AppDaemon app. Note that AppDaemon needs to be restarted after installing a new version of ControllerX, since AppDaemon does not reimport the modules. If AppDaemon is not restarted, it will keep running the old version. *Zigbee2MQTT HA sensor deprecated since ControllerX v4.29.0* Zigbee2MQTT 2.0.0 brought [some breaking changes](), and one of them was to deprecate the [Home Assistant action sensors](), which is the default option of the [Zigbee2MQTT integration]() in ControllerX. You might be here because of a warning in the AppDaemon logs that looks like the following: > [!NOTE] > > **Quote** > > ⚠️ Listening to HA sensor actions is now deprecated and will be removed in the future. Use `listen_to: mqtt` or `listen_to: event` instead. Read more about it here: https://xaviml.github.io/controllerx/others/z2m-ha-sensor-deprecated This might be because your controller configuration looks like: ``` livingroom_controller: module: controllerx class: E1810Controller controller: sensor.livingroom_controller_action integration: z2m light: light.livingroom ``` The issue is `integration: z2m`, which reads a HA `sensor` by default. You need to switch to either [`mqtt`]() (recommended) or HA [`event`]() (experimental). ## Switch to MQTT listener (recommended) To switch to MQTT (as [recommended by Zigbee2MQTT]()), you first need to [enable the MQTT plugin](). Then, change your configuration to something like the following: ``` livingroom_controller: module: controllerx class: E1810Controller controller: livingroom_controller # (1) integration: name: z2m listen_to: mqtt # (2) light: light.livingroom ``` 1. This is the friendly name of the device in Zigbee2MQTT. Check [here]() how to get this value. 2. With `mqtt`, ControllerX listens to the MQTT topic of the controller. ## Switch to HA Event sensor listener (experimental) Another option is to listen to the new (and experimental) event entity from Zigbee2MQTT 2.0.0. First, enable the experimental feature in Zigbee2MQTT as explained [here](). Then, change your configuration to something like: ``` livingroom_controller: module: controllerx class: E1810Controller controller: livingroom_controller_action # (1) integration: name: z2m listen_to: event # (2) light: light.livingroom ``` 1. This is the event entity without the `event.` prefix. Check [here]() how to get this value. 2. With `event`, ControllerX listens to the changes of the event entity. *This is supported since ControllerX v4.21.0* ControllerX has always supported the [Light Controller](), which, amongst other features, smoothly changes attributes (brightness, color temperature) by periodically requesting the changes to Home Assistant. This works with lights from many integrations (e.g. Zigbee2MQTT, deCONZ, WLED, Hue). However, this generalization penalizes Zigbee2MQTT, which has its own mechanism to change the brightness and color temperature over time, and works much more smoothly than the Light Controller. Zigbee2MQTT allows sending a payload like `{"brightness_move": -40}` to the `zigbee2mqtt/FRIENDLY_NAME/set` topic, which decreases the brightness 40 steps per second over time. Then, we can send the following payload to the same topic to make it stop: `{"brightness_move": "stop"}`. Zigbee2MQTT does not have a specific page documenting this, since it depends on the device. For example, we can see all this further explained for the [LED1545G12]() light. Ideally, this would be part of the Light Controller, but there are many features that are not compatible with what Zigbee2MQTT offers: - [Hold/Click modes]() (bounce, loop) - Color looping - Minimum and maximum attribute values For this reason, there is a separate controller type, [Z2M Light Controller](), which offers most of the functionality of the Light Controller, but uses the MQTT features from Zigbee2MQTT. Imagine we have a light with the friendly name `livingroom` in Zigbee2MQTT and the entity `light.livingroom` in Home Assistant. Then, let's say we had the following ControllerX configuration for [E1810](): ``` livingroom_controller: module: controllerx class: E1810Controller # (1) controller: livingroom_controller_action integration: name: z2m listen_to: event light: light.livingroom ``` 1. `E1810Controller` is a `Light Controller` This allows us to control the `livingroom` light with the Light Controller. However, if we replace `E1810Controller` with `E1810Z2MLightController`, and `light.livingroom` with `livingroom`, we will be using the Z2M Light Controller: ``` livingroom_controller: module: controllerx class: E1810Z2MLightController # (1) controller: livingroom_controller_action integration: name: z2m listen_to: event light: livingroom # (2) ``` 1. This is a `Z2M Light Controller` 2. This is the Zigbee2MQTT friendly name of the light This sends the MQTT messages through Home Assistant, but if we have the [MQTT plugin enabled]() in AppDaemon, we can send them through the MQTT plugin instead: ``` livingroom_controller: module: controllerx class: E1810Z2MLightController controller: livingroom_controller_action integration: name: z2m listen_to: event light: name: livingroom mode: mqtt # (1) ``` 1. `mode` can either be `ha` or `mqtt` (default: `ha`). On the one hand, `ha` sends the MQTT messages through Home Assistant with the [`mqtt.publish` service](). On the other hand, `mqtt` sends the MQTT messages through the AppDaemon MQTT plugin (hence skipping HA). Finally, we can have ControllerX both listening and sending to the MQTT broker directly, without going through Home Assistant: ``` livingroom_controller: module: controllerx class: E1810Z2MLightController controller: livingroom_controller # (1) integration: name: z2m listen_to: mqtt light: name: livingroom mode: mqtt ``` 1. `livingroom_controller` is the Zigbee2MQTT friendly name of the controller With this configuration, we can keep using the light even if Home Assistant is down, since all the interactions go: ``` Zigbee2MQTT <> MQTT Broker <> AppDaemon (ControllerX) ``` Many of the supported devices have a Zigbee2MQTT light controller class, which can be used in `class` the same way as their light controller class. Check the [supported controllers]() pages to see the class names. #### 1\. I placed the configuration in configuration.yaml and it doesn't work ControllerX depends on AppDaemon, and all the configuration for AppDaemon apps goes into `apps.yaml` in the AppDaemon apps folder (see [Installation]()) and not `/config/configuration.yaml`. #### 2\. I updated ControllerX to a new version and it does not work If you installed ControllerX manually, the AppDaemon app (or server) needs to be restarted after updating ControllerX. The ControllerX app restarts on its own when updated. #### 3\. I properly configured E1744 (symfonisk) with z2m but it doesn't work The Zigbee2MQTT documentation recommends setting the `debounce` attribute. However, when it is set, the controller does not send an empty state, and its state stays active instead of being removed. This causes problems for ControllerX, so if you want to use this controller, I recommend removing the `debounce` attribute, since ControllerX already handles repeated events by itself. #### 4\. I have a group of lights and it does not work properly Please read [entity groups]() to understand how grouped entities work. #### 5\. Error: "Value for X attribute could not be retrieved from light Y" This error is shown when the light supports the X attribute (e.g. brightness or color\_temp), but the attribute is not in the state attributes of the entity. You can check whether the attribute X is shown in the state attributes in "Developer Tools \> States". #### 6\. Light is not turning on to the previous brightness Zigbee does not support transitions natively for lights, so this depends on the integration you use for your light. By default, ControllerX adds a transition when changing the brightness or color, but not when turning the light on/off. So if this is happening to you, it might be because `add_transition_turn_toggle: true` is set in your controller configuration. These are the issues related to this problem in the different integrations: - [Zigbee2MQTT]() (FIXED) - [Hue integration]() (CLOSED, but not fixed) #### 7\. When holding or rotating the controller (especially the Symfonisk - E1744), it doesn't stop changing the brightness or volume This is a known issue that cannot be fixed in the code. Controllers with hold-release functionality fire 2 events: one when the holding/rotation starts and another one when it stops rotating or is released. In between, ControllerX periodically calls HA services to update your brightness, volume, etc. (see [how it works]()). If this happens to you sometimes, it is because the stop/release action has not been received. This can happen because: - The rotation is too fast, so the controller cannot tell whether it stopped or not. - The network is overloaded. - The server cannot handle the requests on time. - The controller and the light are far away from the coordinator. However, these are some things you can do to reduce how often this happens: - If the `release` action is sent at almost the same time as the `hold` one, you can use the [`release_delay` attribute]() to delay `release` actions by some time after they are fired. For example: `release_delay: 0.01` (time in seconds). - If using z2m, change the integration to listen to MQTT directly, so it avoids the HA state machine layer. Read more about it [here](). - If using deCONZ and you just want to dim your lights smoothly, then you can consider using [this AppDaemon app]() from [*@Burningstone91*](). It brightens/dims your lights with deCONZ calls instead of calling HA periodically, which means that deCONZ handles the dimming for you. - Play around with the `delay` (default is 350ms) and `automatic_steps` (default is 10) attributes. You can read more about them [here](). The lower the delay, the more requests are sent to HA. The higher `automatic_steps`, the more steps it takes to get from min to max, and vice versa. - Add more Zigbee routers to the network. #### 8\. Symfonisk controller (E1744) is not working with Zigbee2MQTT integration Do you have a configuration that seems to be right, but is not working? The default mapping for E1744 uses the actions of the new (non-legacy) Zigbee2MQTT implementation for this controller, so you will need to [deactivate the legacy mode]() for this controller in Zigbee2MQTT. If you use the Zigbee2MQTT app, the device-specific configuration is in `/share/zigbee2mqtt/devices.yaml`. Add `legacy: false` to your E1744 controller as shown in the Zigbee2MQTT documentation, and restart Zigbee2MQTT. While you are here, I strongly recommend checking [FAQ \#9](<#9-symfonisk-controller-e1744-works-but-pretty-laggy>) if your controller feels slow. #### 9\. Symfonisk controller (E1744) works, but pretty laggy If you are using the `sensor` entity as your controller, I recommend changing the configuration to listen to MQTT directly instead of HA. For this, you will need to change your controller configuration (`apps.yaml`) and your AppDaemon configuration (`appdaemon.yaml`). Your new controller configuration will look like this: ``` example_app: module: controllerx class: E1744MediaPlayerController controller: my_z2m_friendly_name # This is the Zigbee2MQTT friendly name integration: name: z2m listen_to: mqtt media_player: media_player.my_media_player ``` Notice how we added the `listen_to` attribute and changed the `controller` to the Zigbee2MQTT friendly name. Finally, you will also need to have the [MQTT plugin enabled]().