ikea-styrbar_E2001_E2002_ZHA-Z2M_control-anything

ikea-styrbar_E2001_E2002_ZHA-Z2M_control-anything.yaml

blueprint:
  name: IKEA STYRBAR Remote/Dimmer Controls (ZHA/Z2M)
  description: '## Control anything with IKEA STYRBAR Remote/Dimmer remote (v1.0)


    Only for use with [ZHA](https://www.home-assistant.io/integrations/zha/) or Zigbee2MQTT
    (cf [MQTT](https://www.home-assistant.io/integrations/mqtt) + [Z2M addon](https://www.zigbee2mqtt.io/guide/installation/03_ha_addon.html)).


    Available controls:

    - Press the **on**, **off**, **left** or **right** buttons

    - Double press the **on**, **off**, **left** or **right**  buttons (optional) in **Helper - Double press
    delay** interval. When disabled, there will be no delay for the simple press actions

    - Press and hold the **on**, **off**, **left** or **right** buttons. Actions will be executed every **Helper
    - Hold delay**, but maximum **Helper - Max number of loops** times. '
  source_url: https://gist.github.com/damru/b2c1c780ffb0ddc084952eb89db9573a
  domain: automation
  input:
    remote_device:
      name: (ZHA) Remote
      description: IKEA remote to use. **_Choose if you are using ZHA._**
      default: ''
      selector:
        device:
          filter:
          - integration: zha
            manufacturer: IKEA of Sweden
            model: Remote Control N2
          multiple: false
    remote_name:
      name: (Zigbee2MQTT) Remote Name
      description: The name of the controller (e.g. IKEA Styrbar). **_Choose if you
        are using Zigbee2MQTT._**
      default: ''
    base_topic:
      name: (Zigbee2MQTT) Base mqtt topic
      description: The topic configured in [Z2M addon](https://www.zigbee2mqtt.io/guide/usage/mqtt_topics_and_messages.html).
      default: zigbee2mqtt
    on_press_action:
      name: On - Single press action
      description: Choose action(s) to run when **on** button is pressed.
      default: []
      selector:
        action: {}
    off_press_action:
      name: Off - Single press action
      description: Choose action(s) to run when **off** button is **pressed**.
      default: []
      selector:
        action: {}
    on_hold_action:
      name: On - Hold action
      description: Choose action(s) to run when **on** button is **pressed and hold**.
      default: []
      selector:
        action: {}
    off_hold_action:
      name: Off - Hold action
      description: Choose action(s) to run when **off** button is **pressed and hold**.
      default: []
      selector:
        action: {}
    on_double_press:
      name: On - Double press event
      description: Choose whether or not to expose the virtual **double press** event
        for the **on** button. Turn this on if you are providing an action for the
        **on** button double press event.
      default: false
      selector:
        boolean: {}
    on_double_press_action:
      name: On - Double press action
      description: Choose action(s) to run when pressing the **on** button twice in
        **Helper - Double press delay** interval. **On - Double press event** must
        be exposed.
      default: []
      selector:
        action: {}
    off_double_press:
      name: Off - Double press event
      description: Choose whether or not to expose the virtual **double press** event
        for the **off** button. Turn this on if you are providing an action for the
        **off** button double press event.
      default: false
      selector:
        boolean: {}
    off_double_press_action:
      name: Off - Double press action
      description: Choose action(s) to run when pressing the **off** button twice
        in **Helper - Double press delay** interval. **Off - Double press event**
        must be exposed.
      default: []
      selector:
        action: {}
    left_press_action:
      name: Left - Single press action
      description: Choose action(s) to run when **left** button is pressed.
      default: []
      selector:
        action: {}
    right_press_action:
      name: Right - Single press action
      description: Choose action(s) to run when **off** button is **pressed**.
      default: []
      selector:
        action: {}
    left_hold_action:
      name: Left - Hold action
      description: Choose action(s) to run when **left** button is **pressed and hold**.
      default: []
      selector:
        action: {}
    right_hold_action:
      name: Right - Hold action
      description: Choose action(s) to run when **right** button is **pressed and hold**.
      default: []
      selector:
        action: {}
    left_double_press:
      name: Left - Double press event
      description: Choose whether or not to expose the virtual **double press** event
        for the **left** button. Turn this on if you are providing an action for the
        **left** button double press event.
      default: false
      selector:
        boolean: {}
    left_double_press_action:
      name: Left - Double press action
      description: Choose action(s) to run when pressing the **left** button twice in
        **Helper - Double press delay** interval. **Left - Double press event** must
        be exposed.
      default: []
      selector:
        action: {}
    right_double_press:
      name: Right - Double press event
      description: Choose whether or not to expose the virtual **double press** event
        for the **right** button. Turn this on if you are providing an action for the
        **right** button double press event.
      default: false
      selector:
        boolean: {}
    right_double_press_action:
      name: Right - Double press action
      description: Choose action(s) to run when pressing the **right** button twice
        in **Helper - Double press delay** interval. **Right - Double press event**
        must be exposed.
      default: []
      selector:
        action: {}
    helper_double_press_delay:
      name: Helper - Double press delay
      description: Max delay between the first and the second button press for the
        **Double press events**. Provide a value only if you are using a double press
        action. Increase this value if you notice that the double press action is
        not triggered properly.
      default: 500
      selector:
        number:
          unit_of_measurement: milliseconds
          min: 100.0
          max: 5000.0
          step: 10.0
          mode: slider
    helper_hold_delay:
      name: Helper - Hold delay
      description: Delay between the execution of the **Hold** action(s).
      default: 250
      selector:
        number:
          unit_of_measurement: milliseconds
          min: 100.0
          max: 5000.0
          step: 10.0
          mode: slider
    helper_max_loops:
      name: Helper - Max number of loops
      description: Maximum number of loops when holding down a button.
      default: 20
      selector:
        number:
          min: 1.0
          max: 1000.0
          step: 1.0
          mode: slider
mode: single
max_exceeded: silent
trigger_variables:
  z2m_base_topic: !input base_topic
  z2m_controller: !input remote_name
  zha_remote: !input remote_device
trigger:
#All ZHA events
 # Single Presses
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: 'on'
    cluster_id: 6
    endpoint_id: 1
  id: press-on-zha
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: 'off'
    cluster_id: 6
    endpoint_id: 1
  id: press-off-zha
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: 'press'
    cluster_id: 5
    endpoint_id: 1
    args:
    - 257
    - 13
    - 0
  id: press-left-zha
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: 'press'
    cluster_id: 5
    endpoint_id: 1
    args:
    - 256
    - 13
    - 0
  id: press-right-zha
 # Hold events Up/Down
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: move_with_on_off
    cluster_id: 8
    endpoint_id: 1
    args:
    - 0
    - 83
  id: hold-on-zha
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: move
    cluster_id: 8
    endpoint_id: 1
    args:
    - 1
    - 83
    - 0
    - 0
  id: hold-off-zha
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    endpoint_id: 1
    cluster_id: 8
    command: stop_with_on_off
  id: release-zha
 # Hold events left/right
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: hold
    cluster_id: 5
    endpoint_id: 1
    args:
    - 3329
    - 0
  id: hold-left-zha
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    command: hold
    cluster_id: 5
    endpoint_id: 1
    args:
    - 3328
    - 0
  id: hold-right-zha
- platform: event
  event_type: zha_event
  event_data:
    device_id: '{{ zha_remote }}'
    endpoint_id: 1                  
    cluster_id: 5
    command: release   
  id: release-zha
#Z2MQTT
 # Single Presses
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: 'off'
  id: press-off-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: 'on'
  id: press-on-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: 'arrow_left_click'
  id: press-left-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: 'arrow_right_click'
  id: press-right-z2m
 #Hold On/Off
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: brightness_move_down
  id: hold-off-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: brightness_move_up
  id: hold-on-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: brightness_stop
  id: release-z2m
 #Hold On/Off
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: arrow_left_hold
  id: hold-left-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: arrow_right_hold
  id: hold-right-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: arrow_left_release
  id: release-z2m
- platform: mqtt
  topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
  payload: arrow_right_release
  id: release-z2m
action:
- variables:
    on_double_press: !input on_double_press
    off_double_press: !input off_double_press
    left_double_press: !input left_double_press
    right_double_press: !input right_double_press
    zha_remote: !input remote_device
    z2m_base_topic: !input base_topic
    z2m_controller: !input remote_name
- choose:
  - conditions: #press-on-* & double press-on-*
    - condition: trigger
      id:
      - press-on-zha
      - press-on-z2m
    sequence:
    - if:
      - condition: template
        value_template: '{{ on_double_press }}'
      then:
      - choose: 
        - conditions:
          - condition: trigger
            id:
            - press-on-zha
          sequence:
          - wait_for_trigger:
            - platform: event
              event_type: zha_event
              event_data:
                device_id: '{{ zha_remote }}'
                command: 'on'
                cluster_id: 6
                endpoint_id: 1
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input on_double_press_action
            else: !input on_press_action
        - conditions:
          - condition: trigger
            id:
            - press-on-z2m
          sequence:
          - wait_for_trigger:
            - platform: mqtt
              topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
              payload: 'on'
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input on_double_press_action
            else: !input on_press_action
      else: !input on_press_action
  - conditions: #press-off-* & double press-off-*
    - condition: trigger
      id:
      - press-off-zha
      - press-off-z2m
    sequence:
    - if:
      - condition: template
        value_template: '{{ off_double_press }}'
      then:
      - choose:
        - conditions:
          - condition: trigger
            id:
            - press-off-zha
          sequence:
          - wait_for_trigger:
            - platform: event
              event_type: zha_event
              event_data:
                device_id: '{{ zha_remote }}'
                command: 'off'
                cluster_id: 6
                endpoint_id: 1
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input off_double_press_action
            else: !input off_press_action
        - conditions:
          - condition: trigger
            id:
            - press-off-z2m
          sequence:
          - wait_for_trigger:
            - platform: mqtt
              topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
              payload: 'off'
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input off_double_press_action
            else: !input off_press_action
      else: !input off_press_action
  - conditions: #press-left-* & double press-left-*
    - condition: trigger
      id:
      - press-left-zha
      - press-left-z2m
    sequence:
    - if:
      - condition: template
        value_template: '{{ left_double_press }}'
      then:
      - choose:
        - conditions: #ZHA
          - condition: trigger
            id:
            - press-left-zha
          sequence:
          - wait_for_trigger:
            - platform: event
              event_type: zha_event
              event_data:
                device_id: '{{ zha_remote }}'
                command: 'press'
                cluster_id: 5
                endpoint_id: 1
                args:
                - 257
                - 13
                - 0
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input left_double_press_action
            else: !input left_press_action
        - conditions: #Z2MQTT
          - condition: trigger
            id:
            - press-left-z2m
          sequence:
          - wait_for_trigger:
            - platform: mqtt
              topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
              payload: 'arrow_left_click'
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input left_double_press_action
            else: !input left_press_action
      else: !input left_press_action
  - conditions: #press-right-* & double press-right-*
    - condition: trigger
      id:
      - press-right-zha
      - press-right-z2m
    sequence:
    - if:
      - condition: template
        value_template: '{{ right_double_press }}'
      then:
      - choose:
        - conditions: #ZHA
          - condition: trigger
            id:
            - press-right-zha
          sequence:
          - wait_for_trigger:
            - platform: event
              event_type: zha_event
              event_data:
                device_id: '{{ zha_remote }}'
                command: 'press'
                cluster_id: 5
                endpoint_id: 1
                args:
                - 256
                - 13
                - 0
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input right_double_press_action
            else: !input right_press_action
        - conditions: #Z2MQTT
          - condition: trigger
            id:
            - press-right-z2m
          sequence:
          - wait_for_trigger:
            - platform: mqtt
              topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action'' }}'
              payload: 'arrow_right_click'
            timeout:
              milliseconds: !input helper_double_press_delay
            continue_on_timeout: true
          - if:
            - condition: template
              value_template: '{{ wait.trigger.idx is defined }}'
            then: !input right_double_press_action
            else: !input right_press_action
      else: !input right_press_action  
  - conditions: #hold-on-*
    - condition: trigger
      id:
      - hold-on-zha
      - hold-on-z2m
    sequence:
    - repeat:
        count: !input helper_max_loops
        sequence:
        - parallel:
          - sequence: !input on_hold_action
          - sequence:
            - choose:
              - conditions:
                - condition: trigger
                  id:
                  - hold-on-zha
                sequence:
                - wait_for_trigger:
                  - platform: event
                    event_type: zha_event
                    event_data:
                      device_id: '{{ zha_remote }}'
                      command: stop_with_on_off
                      cluster_id: 8
                      endpoint_id: 1
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
              - conditions:
                - condition: trigger
                  id:
                  - hold-on-z2m
                sequence:
                - wait_for_trigger:
                  - platform: mqtt
                    topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action''
                      }}'
                    payload: brightness_stop
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
  - conditions: #hold-off-*
    - condition: trigger
      id:
      - hold-off-zha
      - hold-off-z2m
    sequence:
    - repeat:
        count: !input helper_max_loops
        sequence:
        - parallel:
          - sequence: !input off_hold_action
          - sequence:
            - choose:
              - conditions:
                - condition: trigger
                  id:
                  - hold-off-zha
                sequence:
                - wait_for_trigger:
                  - platform: event
                    event_type: zha_event
                    event_data:
                      device_id: '{{ zha_remote }}'
                      command: stop
                      cluster_id: 8
                      endpoint_id: 1
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
              - conditions:
                - condition: trigger
                  id:
                  - hold-off-z2m
                sequence:
                - wait_for_trigger:
                  - platform: mqtt
                    topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action''
                      }}'
                    payload: brightness_stop
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
  - conditions: #hold-left-*
    - condition: trigger
      id:
      - hold-left-zha
      - hold-left-z2m
    sequence:
    - repeat:
        count: !input helper_max_loops
        sequence:
        - parallel:
          - sequence: !input left_hold_action
          - sequence: #Wait on release
            - choose:
              - conditions: #ZHA
                - condition: trigger
                  id:
                  - hold-left-zha
                sequence:
                - wait_for_trigger:
                  - platform: event
                    event_type: zha_event
                    event_data:
                      device_id: '{{ zha_remote }}'
                      endpoint_id: 1                  
                      cluster_id: 5
                      command: release   
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
              - conditions: #Z2MQTT
                - condition: trigger
                  id:
                  - hold-left-z2m
                sequence:
                - wait_for_trigger:
                  - platform: mqtt
                    topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action''
                      }}'
                    payload: arrow_left_release
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
  - conditions: #hold-right-*
    - condition: trigger
      id:
      - hold-right-zha
      - hold-right-z2m
    sequence:
    - repeat:
        count: !input helper_max_loops
        sequence:
        - parallel:
          - sequence: !input right_hold_action
          - sequence: #Wait on release
            - choose:
              - conditions: #ZHA
                - condition: trigger
                  id:
                  - hold-right-zha
                sequence:
                - wait_for_trigger:
                  - platform: event
                    event_type: zha_event
                    event_data:
                      device_id: '{{ zha_remote }}'
                      endpoint_id: 1                  
                      cluster_id: 5
                      command: release   
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
              - conditions: #Z2MQTT
                - condition: trigger
                  id:
                  - hold-right-z2m
                sequence:
                - wait_for_trigger:
                  - platform: mqtt
                    topic: '{{ z2m_base_topic ~ ''/'' ~ z2m_controller ~ ''/action''
                      }}'
                    payload: arrow_right_release
                  timeout:
                    milliseconds: !input helper_hold_delay
                  continue_on_timeout: true
                - if:
                  - condition: template
                    value_template: '{{ wait.trigger.idx is defined }}'
                  then:
                  - stop: button released
  - conditions: #Wait for relase and recall 
    - condition: trigger
      id:
      - release-zha
    sequence:
    - wait_for_trigger:
      - platform: event
        event_type: zha_event
        event_data:
          device_id: '{{ zha_remote }}'
          endpoint_id: 1                  
          cluster_id: 5
          command: recall   
      timeout:
        milliseconds: 1200
      continue_on_timeout: true