Update to support mqtt based triggers

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
         with:
           node-version: '16'
       - name: Cache node modules
-        uses: actions/cache@v3.0.6
+        uses: actions/cache@v3.2.6
         env:
           cache-name: cache-node-modules
         with:
@@ -43,7 +43,7 @@ jobs:
       - if: always()
         id: eslint
         name: ESLint
-        uses: reviewdog/action-eslint@v1.17
+        uses: reviewdog/action-eslint@v1.18
         with:
           github_token: ${{ secrets.github_token }}
           reporter: github-check
@@ -64,7 +64,7 @@ jobs:
         with:
           node-version: '16'
       - name: Cache node modules
-        uses: actions/cache@v3.0.6
+        uses: actions/cache@v3.2.6
         env:
           cache-name: cache-node-modules
         with:
@@ -79,7 +79,7 @@ jobs:
         run: npm ci
       - id: prettier
         name: Prettier
-        uses: creyD/prettier_action@v4.2
+        uses: creyD/prettier_action@v4.3
         with:
           dry: true
           prettier_options: --write .
@@ -103,7 +103,7 @@ jobs:
         with:
           node-version: '16'
       - name: Cache node modules
-        uses: actions/cache@v3.0.6
+        uses: actions/cache@v3.2.6
         env:
           cache-name: cache-node-modules
         with:
@@ -123,7 +123,7 @@ jobs:
       - name: Create .nojekyll file
         run: touch website/build/.nojekyll
       - name: Deploy to GitHub Pages
-        uses: s0/git-publish-subdir-action@v2.5.1
+        uses: s0/git-publish-subdir-action@v2.6.0
         env:
           REPO: self
           BRANCH: gh-pages

.github/workflows/ci_pr.yml

@@ -17,7 +17,7 @@ jobs:
         with:
           node-version: '16'
       - name: Cache node modules
-        uses: actions/cache@v3.0.6
+        uses: actions/cache@v3.2.6
         env:
           cache-name: cache-node-modules
         with:
@@ -42,7 +42,7 @@ jobs:
         continue-on-error: true
       - id: eslint
         name: ESLint
-        uses: reviewdog/action-eslint@v1.17
+        uses: reviewdog/action-eslint@v1.18
         with:
           github_token: ${{ secrets.github_token }}
           reporter: github-pr-check
@@ -77,7 +77,7 @@ jobs:
         with:
           node-version: '16'
       - name: Cache node modules
-        uses: actions/cache@v3.0.6
+        uses: actions/cache@v3.2.6
         env:
           cache-name: cache-node-modules
         with:
@@ -94,7 +94,7 @@ jobs:
         run: cd website && npm ci
       - id: prettier
         name: Prettier Check
-        uses: creyD/prettier_action@v4.2
+        uses: creyD/prettier_action@v4.3
         with:
           dry: true
           prettier_options: --write .
@@ -121,7 +121,7 @@ jobs:
         with:
           node-version: '16'
       - name: Cache node modules
-        uses: actions/cache@v3.0.6
+        uses: actions/cache@v3.2.6
         env:
           cache-name: cache-node-modules
         with:

.github/workflows/stale.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 90 days stale policy for issues & PRs
-        uses: actions/stale@v5
+        uses: actions/stale@v7
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           days-before-stale: 90

.github/workflows/thread_locker.yml

@@ -19,7 +19,7 @@ jobs:
   action:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/lock-threads@v3
+      - uses: dessant/lock-threads@v4
         with:
           # 30 days of inactivity both for closed issues and PRs
           issue-inactive-days: 30

blueprints/controllers/ikea_e1524_e1810/ikea_e1524_e1810.yaml

@@ -1,5 +1,8 @@
 # Blueprint metadata
 blueprint:
+  domain: automation
+  homeassistant:
+    min_version: 2023.5.0
   name: Controller - IKEA E1524/E1810 TRÅDFRI Wireless 5-Button Remote
   description: |
     # Controller - IKEA E1524/E1810 TRÅDFRI Wireless 5-Button Remote
@@ -15,12 +18,9 @@ blueprint:
 
     🚀 This blueprint is part of the **[Awesome HA Blueprints](https://epmatt.github.io/awesome-ha-blueprints) project**.
 
-    ℹ️ Version 2025.01.03-EPMATT
-  source_url: https://github.com/lsismeiro/awesome-ha-blueprints/blob/main/blueprints/controllers/ikea_e1524_e1810/ikea_e1524_e1810.yaml
-
-  domain: automation
-  homeassistant:
-    min_version: 2023.5.0
+    ℹ️ Version 2025.01.03
+    ℹ️ Version 2025.01.07 - Added support for z2m 2.x mqtt device triggers - yarafie
+  source_url: https://github.com/EPMatt/awesome-ha-blueprints/blob/main/blueprints/controllers/ikea_e1524_e1810/ikea_e1524_e1810.yaml
   input:
     integration:
       name: (Required) Integration
@@ -32,11 +32,31 @@ blueprint:
             - ZHA
             - Zigbee2MQTT
     controller_device:
-      name: (deCONZ, ZHA) Controller Device
-      description: The controller device to use for the automation. Choose a value only if the remote is integrated with deCONZ, ZHA.
+      # **YAR** - ADD - To Support zigbee2mqtt mqtt device triggers when legacy=false
+      name: (deCONZ, ZHA, Zigbee2MQTT) Controller Device
+      description: The controller device to use for the automation. Choose a value only if the remote is integrated with deCONZ, ZHA, Zigbee2MQTT.
       default: ''
+      # **YAR** - ADD - Selector for devices to choose from
       selector:
         device:
+          # **YAR** - https://www.zigbee2mqtt.io/devices/E1524_E1810.html#ikea-e1524-e1810
+          filter:
+          - integration: mqtt
+            manufacturer: IKEA
+            model: TRADFRI remote control
+          # **For backwards compatability with z2m 1.x. model_id is added to end of model rather than a seperate attribute in z2m 2.x
+          - integration: mqtt
+            manufacturer: IKEA
+            model: TRADFRI remote control (E1524/E1810)
+          # **YAR** - https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Supported-Devices
+          - integration: zha
+            manufacturer: IKEA of Sweden
+            model: TRADFRI remote control
+          - integration: deconz
+            manufacturer: IKEA of Sweden
+            model: TRADFRI remote control
+          multiple: false
+      # **YAR** - ADD END
     controller_entity:
       name: (Zigbee2MQTT) Controller Entity
       description: The action sensor of the controller to use for the automation. Choose a value only if the remote is integrated with Zigbee2MQTT.
@@ -344,14 +364,15 @@ variables:
       button_right_short: [press_256_13_0]
       button_right_long: [hold_3328_0]
       button_right_release: [release]
-      button_up_short: [step_with_on_off_StepMode.Up_43_5]
-      button_up_long: [move_with_on_off_MoveMode.Up_83]
-      button_up_release: [stop_with_on_off]
-      button_down_short: [step_StepMode.Down_43_5_0_0]
-      button_down_long: [move_MoveMode.Down_83]
+      button_up_short: [step_with_on_off_0_43_5]
+      button_up_long: [move_with_on_off_0_83, move_with_on_off_0_84]
+      button_up_release: [stop]
+      button_down_short: [step_1_43_5]
+      button_down_long: [move_1_83, move_1_84]
       button_down_release: [stop]
       button_center_short: [toggle]
       button_center_long: [press_2_0_0]
+    # **YAR** - https://www.zigbee2mqtt.io/devices/E1524_E1810.html#ikea-e1524-e1810
     zigbee2mqtt:
       button_left_short: [arrow_left_click]
       button_left_long: [arrow_left_hold]
@@ -384,19 +405,97 @@ variables:
   button_center_short: '{{ actions_mapping[integration_id]["button_center_short"] }}'
   button_center_long: '{{ actions_mapping[integration_id]["button_center_long"] }}'
   # integrations which need to store the previous press event to determine which button was released
-  integrations_with_prev_event_storage: [zha]
+  integrations_with_prev_event_storage: [zha, zigbee2mqtt]
   # build data to send within a controller event
   controller_entity: !input controller_entity
   controller_device: !input controller_device
-  controller_id: '{% if integration_id=="zigbee2mqtt" %}{{controller_entity}}{% else %}{{controller_device}}{% endif %}'
+  # **YAR** ADD - Logic to handle z2m legacy
+  # **YAR** If user provided input for controller_entity assume legacy **Maybe There Is A Better Way To Do This**
+  # **YAR** setting z2m_legacy to true with below code and set controller_id accordingly
+  z2m_legacy: '{{ integration_id == "zigbee2mqtt" and controller_entity not in ["", None, undefined] }}'
+  controller_id: '{% if z2m_legacy %}{{controller_entity}}{% else %}{{controller_device}}{% endif %}'
+  # **YAR** ADD END
 mode: restart
 max_exceeded: silent
 trigger:
-  # trigger for zigbee2mqtt
+  # trigger for zigbee2mqtt entity sensor action events (legacy)
   - platform: event
     event_type: state_changed
     event_data:
       entity_id: !input controller_entity
+  # **YAR** - ADD - zigbee2mqtt mqtt device action triggers
+  # triggers for zigbee2mqtt mqtt device action
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: arrow_left_click
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: arrow_left_hold
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: arrow_left_release
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: arrow_right_click
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: arrow_right_hold
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: arrow_right_release
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: brightness_up_click
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: brightness_up_hold
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: brightness_up_release
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: brightness_down_click
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: brightness_down_hold
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: brightness_down_release
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: toggle
+  - platform: device
+    domain: mqtt
+    device_id: !input controller_device
+    type: action
+    subtype: toggle_hold
+  # **YAR** - ADD END
   # trigger for other integrations
   - platform: event
     event_type:
@@ -408,9 +507,12 @@ condition:
   - condition: and
     conditions:
       # check that the button event is not empty
+      # **YAR** - ADD zigbee2mqtt checks for device or entity
       - >-
         {%- set trigger_action -%}
-        {%- if integration_id == "zigbee2mqtt" -%}
+        {%- if integration_id == "zigbee2mqtt" and z2m_legacy == false -%}
+        {{ trigger.payload }}
+        {%- elif integration_id == "zigbee2mqtt" and z2m_legacy == true -%}
         {{ trigger.event.data.new_state.state }}
         {%- elif integration_id == "deconz" -%}
         {{ trigger.event.data.event }}
@@ -419,9 +521,10 @@ condition:
         {%- endif -%}
         {%- endset -%}
         {{ trigger_action not in ["","None"] }}
-      # only for zigbee2mqtt, check if the event is relative to a real state change, and not only some minor changes in the sensor attributes
+      # only for zigbee2mqtt in legacy mode, check if the event is relative to a real state change, and not only some minor changes in the sensor attributes
       # this is required since multiple state_changed events are fired for a single button press, with the result of the automation being triggered multiple times
-      - '{{ integration_id != "zigbee2mqtt" or trigger.event.data.new_state.state != trigger.event.data.old_state.state }}'
+      - '{{ not (integration_id == "zigbee2mqtt" and z2m_legacy) or trigger.event.data.new_state.state != trigger.event.data.old_state.state }}'
+      # **YAR** - ADD END
 action:
   # debouncing - when automation is triggered multiple times, the last automation run is the one which completes execution, due to mode restart
   # therefore previous runs must wait for the debounce delay before executing any other action
@@ -431,17 +534,20 @@ action:
   # extract button event from the trigger
   # provide a single string value to check against
   - variables:
+      # **YAR** - ADD zigbee2mqtt actions for device or entity
       trigger_action: >-
-        {%- if integration_id == "zigbee2mqtt" -%}
+        {%- if integration_id == "zigbee2mqtt" and z2m_legacy == false -%}
+        {{ trigger.payload }}
+        {%- elif integration_id == "zigbee2mqtt" and z2m_legacy == true -%}
         {{ trigger.event.data.new_state.state }}
         {%- elif integration_id == "deconz" -%}
         {{ trigger.event.data.event }}
         {%- elif integration_id == "zha" -%}
         {{ trigger.event.data.command }}{{"_" if trigger.event.data.args|length > 0}}{{ trigger.event.data.args|join("_") }}
         {%- endif -%}
+      # **YAR** - ADD END
       trigger_delta: '{{ (as_timestamp(now()) - ((states(helper_last_controller_event) | from_json).t if helper_last_controller_event is not none and (states(helper_last_controller_event) | regex_match("^\{((\"a\":\".*\"|\"t\":\d+\.\d+)(,)?){2}\}$")) else as_timestamp("1970-01-01 00:00:00"))) * 1000 }}'
       last_controller_event: '{{ (states(helper_last_controller_event) | from_json).a if helper_last_controller_event is not none and (states(helper_last_controller_event) | regex_match("^\{((\"a\":\".*\"|\"t\":\d+\.\d+)(,)?){2}\}$")) else "" }}'
-
   # update helper
   - service: input_text.set_value
     data: