Examples
The purpose of this page is to show some real examples for the configuration. These are configurations placed in /homeassistant/appdaemon/apps/apps.yaml
Basic
E1524/E1810 controller with z2m that controls all the livingroom lights.
livingroom_controller:
module: controllerx
class: E1810Controller
controller: sensor.livingroom_controller_action
integration: z2m
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 E1744 with 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 E1743 with 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 Aqara double key wireless switch (z2m):
controller_left_switch:
module: controllerx
class: DoubleKeyWirelessAqaraController
controller: sensor.controller_action
light: light.light1
integration: z2m
manual_steps: 7
actions:
- left
- left_double
- left_long
controller_right_switch:
module: controllerx
class: DoubleKeyWirelessAqaraController
controller: sensor.controller_action
light: light.light2
integration: z2m
manual_steps: 7
actions:
- right
- right_double
- right_long
Controlling just the color with E1810 and z2m because toggle and brightness is controlled with zigbee groups.
example_app:
module: controllerx
class: E1810Controller
controller: sensor.controller_action
integration: z2m
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 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 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 syncronized on/off function
module: controllerx
class: E1810Controller
controller: sensor.0x90fd9ffffe17d796_action
integration: z2m
# 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 syncronized on/off function
module: controllerx
class: E1810Controller
controller: sensor.0x90fd9ffffe17d796_action
integration: z2m
# 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 E1743 controller for a light, but delaying the off action for 10 seconds. The use case could be for when we have a switch at the beginning of the corridor and we do not want the light to turn off until a certain period of time.
corridor_controller:
module: controllerx
class: E1743Controller
controller: corridor_controller
integration: deconz
light: light.corridor
action_delay:
2002: 10
Using a xy color light bulb as a color temperature one when it does support it.
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 a xy color light bulb as a color temperature one when it does NOT support it.
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 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 functionality of the smooth power onfor the E1810, so when clicked or hold each button when 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 with support to color temperature.
livingroom_light_on:
module: controllerx
class: E1810Controller
controller: sensor.livingroom_controller_action
integration: z2m
light: light.livingroom
constrain_input_boolean: light.livingroom,on
livingroom_light_off:
module: controllerx
class: LightController
controller: sensor.livingroom_controller_action
integration: z2m
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 Aqara magic cube with deCONZ. The key values were extracted from the deCONZ section in here and the values were extracted 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 Aqara magic cube with z2m. This makes use of the mapping attribute to turn on different HA scenes.
cube_bedroom:
module: controllerx
class: Controller
controller: sensor.cube_bedroom_action
integration: z2m
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 WXKG01LM de Aqara. We want to toggle the light and turn it on always to brightness 20 (min: 0, max: 255). For this we create one instance app configuration for the default behaviour of the controller, but 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: sensor.0x00158d00027b6d79_click
integration: z2m
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 track when pressing, whit this it skips source by pressing.
sonos_speaker:
module: controllerx
class: MediaPlayerController
controller: sensor.0x90fd9ffffe0cbd69_action
integration: z2m
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
This next configuration shows the use of multiple click functionality, and merge_mapping. We want to use the E1810 for a light (light.light1) and toggle another light (light.light2) when clicking twice the toggle button. We could do this in one application configuration as you can see in the multiple click page, but we will do it separatelly to show that the first config needs to change the toggle for toggle$1 to be 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 at the same time 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 click: Toggle between (pre-defined) Warm - and Cold-White.
- 3 click: "switch to alternate behavior" - instead of the default dimming-behavior when turning left/right - change color-temperature by turning turning left makes light colder (more blueish) and right make it warmer (more reds).
- rotate left/right: This will depend on the state 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 render. 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 UI or YAML in HA:
Then we can define the following ControllerX config to change the option of the input_select and apply the predefined action that is selected: