Skip to content

Integrations

Integrations is a way to abstract the logic from the event extraction in ControllerX. Each integration is resposible for listening the state or event and decoding the events in a way that ControllerX understands. Here you can see which value the controller should have for each of this integrations:

Zigbee2MQTT

This integration(z2m) is meant to be used for zigbee2mqtt. It listens the states from the HA sensor entities. These are the accepted attributes:

  • listen_to: Indicates whether it listens for HA states (ha) or MQTT topics (mqtt). Default is ha.
  • action_key: It is the key inside the topic payload that contains the fired action from the controller. It is normally action or click. By default will be action. Only applicable if listen_to is mqtt.
  • action_group is a list of allowed action groups for the controller configuration. Read more about it here. Only applicable if listen_to is mqtt.
  • topic_prefix: MQTT base topic for Zigbee2MQTT MQTT messages. By default is zigbee2mqtt, and it listens to <topic_prefix>/<controller_id> for changes. Only applicable if listen_to is mqtt.

If you want to use the mqtt, then you will need to change the appdaemon.yaml as it is stated in the MQTT integration section. Imagine we have the following configuration already created for a z2m controller listening to HA state:

livingroom_controller:
  module: controllerx
  class: E1810Controller
  controller: sensor.livingroom_controller_action
  integration: z2m
  light: light.bedroom

Then, if we want to listen to the MQTT topic directly (skipping the HA state machine), we will need to change to:

livingroom_controller:
  module: controllerx
  class: E1810Controller
  controller: livingroom_controller
  integration:
    name: z2m
    listen_to: mqtt
    action_key: action # By default is `action` already
  light: light.bedroom

appdaemon.yaml needs to be changed by adding the MQTT plugin (see here)

deCONZ

This integration(deconz) listens to deconz_event events and actions gets fired by default with the event attribute from the data object. However, you can change the attribute to listen to by adding a type attribute. In addition, you can select which attribute to listen to (id or unique_id) with listen_to. This is an 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

ZHA

This integration(zha) listens to zha_event events and concatenates the command with the argument for the action string. It does not have any additional arguments.

MQTT

This integration (mqtt) listens for the topic sent from the controller attribute. Although this integration makes sense to use together with custom controllers, it works with the actions from zigbee2mqtt. This means that if you have a configuration like the following:

livingroom_controller:
  module: controllerx
  class: E1810Controller
  controller: sensor.livingroom_controller_action
  integration: z2m
  light: light.bedroom

You can remove the layer of HA state and therefore gain some speed by changing it for:

livingroom_controller:
  module: controllerx
  class: E1810Controller
  # This is the action topic from z2m
  controller: zigbee2mqtt/livingroom_controller/action
  integration: mqtt
  light: light.bedroom

By doing this, ControllerX will be listening directly from MQTT rather than Home Assistant (which listens from MQTT). Not only can you use this with zigbee2mqtt, but also with any other MQTT integration. This works for JSON and non-JSON values in the payload. If an specific attribute needs to be extracted from JSON payload, the key (which works like action_key from Zigbee2MQTT integration) attribute can be used:

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 will turn on the light when the following payload is shown for one of the 2 topics in the controller key:

{
  "battery": 99,
  "illuminance": 0,
  "illuminance_lux": 0,
  "linkquality": 255,
  "occupancy": true,
  "temperature": 27,
  "voltage": 2985
}

By default, mqtt will read non-JSON values. Last but not least, the MQTT plugin needs to be enabled.

State

This integration (state) listens for the state of a sensor and the action is fired with the changed event. You can add attribute parameter if you want to listen to state change on the state attribute level. Read more about the options in here. An example could be:

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"

Event

This integration (event) is meant to be used for a custom event and it is not attached to any type of integration. Unless other integration, the following attributes are mandatory:

  • name: This has to be the name of the integration (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}).

For further explanation and example, please check here.

Lutron Caséta

This integration(lutron_caseta) listens to lutron_caseta_button_event events. It creates an action like button_<number>_<action type>. It does not have any additional arguments.

Homematic

This integration (homematic) listens to homematic.keypress events. It creates an action like <action_type>_<channel>. It does not have any additional arguments.

Shelly

This integration (shelly) listens to shelly.click events. It creates an action like <click_type>_<channel>. It does not have any additional arguments.

Shelly for HASS

This integration (shellyforhass) listens to shellyforhass.click events. It creates an action like <action_type>. It does not have any additional arguments.

Tasmota

This integration (tasmota) listens for the MQTT topic sent from the controller attribute, and gets the action from the attribute defined in component. These are the attributes for this integration

  • name (required): This has to be the name of the integration (tasmota).
  • component (required): The component we are listening to (e.g. Button1).
  • key (optional): The key to retrieve the data from. Default: Action.

For this integration to work, SetOption73 (for Buttons) and SetOption114 (for Switches) need to be set in Tasmota.

Tasmota payload:

{
  "Button1": {
    "Action": "TOGGLE"
  }
}

Example Usage:

example_app:
  module: controllerx
  class: TasmotaButtonLightController
  controller: stat/tasmota_device/RESULT
  integration:
    name: tasmota
    component: Button1
  light: light.example_light

Last but not least, the MQTT plugin needs to be enabled.

Back to top