(Z2M) OSRAM AC025XX00NJ / Philips 8718699693985: fix and update (#615)

* Updated actions_mapping for Zigbee2MQTT

Updated Actions Mapping as per Z2M docs: https://www.zigbee2mqtt.io/devices/AC0251100NJ_AC0251600NJ_AC0251700NJ.html#actions

* Added Zigbee2MQTT support for Philips 8718699693985 Hue Smart Button

* copy new helper json marshaling from ikea controllers, bump version to 2025.01.05

* docs: add z2m support, update changelog

---------

Co-authored-by: EPMatt <[email protected]>

Author: alexdelprete

blueprints/controllers/osram_ac025xx00nj/osram_ac025xx00nj.yaml

@@ -15,9 +15,11 @@ blueprint:
 
     🚀 This blueprint is part of the **[Awesome HA Blueprints](https://epmatt.github.io/awesome-ha-blueprints) project**.
 
-    ℹ️ Version 2022.08.08
+    ℹ️ Version 2025.01.05
   source_url: https://github.com/EPMatt/awesome-ha-blueprints/blob/main/blueprints/controllers/osram_ac025xx00nj/osram_ac025xx00nj.yaml
   domain: automation
+  homeassistant:
+    min_version: 2023.5.0
   input:
     integration:
       name: (Required) Integration
@@ -264,15 +266,16 @@ variables:
       button_down_long: [move]
       button_down_release: [stop]
     zigbee2mqtt:
-      button_up_short: [up]
-      button_up_long: [up_hold]
-      button_up_release: [up_release]
-      button_center_short: [circle_click]
-      button_center_long: [circle_hold]
-      button_center_release: [circle_release]
-      button_down_short: [down]
-      button_down_long: [down_hold]
-      button_down_release: [down_release]
+      # source: https://www.zigbee2mqtt.io/devices/AC0251100NJ_AC0251600NJ_AC0251700NJ.html#actions
+      button_up_short: ['on']
+      button_up_long: [brightness_move_up]
+      button_up_release: [brightness_stop]
+      button_center_short: [brightness_move_to_level]
+      button_center_long: [move_to_saturation]
+      button_center_release: [hue_stop]
+      button_down_short: ['off']
+      button_down_long: [brightness_move_down]
+      button_down_release: [brightness_stop]
   # pre-choose actions for buttons based on configured integration
   # no need to perform this task at automation runtime
   button_up_short: '{{ actions_mapping[integration_id]["button_up_short"] }}'
@@ -338,7 +341,7 @@ action:
         {%- elif integration_id == "zha" -%}
         {{ trigger.event.data.command }}
         {%- endif -%}
-      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 }}'
+      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 }}'
   # update helper
   - service: input_text.set_value
     data:

blueprints/controllers/philips_8718699693985/philips_8718699693985.yaml

@@ -5,7 +5,7 @@ blueprint:
     # Controller - Philips 8718699693985 Hue Smart Button
 
     Controller automation for executing any kind of action triggered by the provided Philips 8718699693985 Hue Smart Button. Allows to optionally loop an action on a button long press.
-    Supports deCONZ, ZHA.
+    Supports deCONZ, ZHA, Zigbee2MQTT.
 
     Automations created with this blueprint can be connected with one or more [Hooks](https://epmatt.github.io/awesome-ha-blueprints/docs/blueprints/hooks) supported by this controller.
     Hooks allow to easily create controller-based automations for interacting with media players, lights, covers and more.
@@ -15,9 +15,11 @@ blueprint:
 
     🚀 This blueprint is part of the **[Awesome HA Blueprints](https://epmatt.github.io/awesome-ha-blueprints) project**.
 
-    ℹ️ Version 2022.08.08
+    ℹ️ Version 2025.01.05
   source_url: https://github.com/EPMatt/awesome-ha-blueprints/blob/main/blueprints/controllers/philips_8718699693985/philips_8718699693985.yaml
   domain: automation
+  homeassistant:
+    min_version: 2023.5.0
   input:
     integration:
       name: (Required) Integration
@@ -27,12 +29,20 @@ blueprint:
           options:
             - deCONZ
             - 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.
       default: ''
       selector:
         device:
+    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.
+      default: ''
+      selector:
+        entity:
+          domain: sensor
     helper_last_controller_event:
       name: (Required) Helper - Last Controller Event
       description: Input Text used to store the last event fired by the controller. You will need to manually create a text input entity for this, please read the blueprint Additional Notes for more info.
@@ -141,17 +151,28 @@ variables:
       button_short: [on_short_release]
       button_long: [on_hold]
       button_release: [on_long_release]
+    zigbee2mqtt:
+      # source: https://www.zigbee2mqtt.io/devices/8718699693985.html#action-enum
+      button_short: [press]
+      button_long: [hold]
+      button_release: [release]
   # pre-choose actions for buttons based on configured integration
   # no need to perform this task at automation runtime
   button_short: '{{ actions_mapping[integration_id]["button_short"] }}'
   button_long: '{{ actions_mapping[integration_id]["button_long"] }}'
   button_release: '{{ actions_mapping[integration_id]["button_release"] }}'
   # build data to send within a controller event
+  controller_entity: !input controller_entity
   controller_device: !input controller_device
-  controller_id: '{{controller_device}}'
+  controller_id: '{% if integration_id=="zigbee2mqtt" %}{{controller_entity}}{% else %}{{controller_device}}{% endif %}'
 mode: restart
 max_exceeded: silent
 trigger:
+  # trigger for zigbee2mqtt
+  - platform: event
+    event_type: state_changed
+    event_data:
+      entity_id: !input controller_entity
   # trigger for other integrations
   - platform: event
     event_type:
@@ -172,6 +193,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
+  # 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 }}'
+
 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
@@ -189,7 +214,7 @@ action:
         {%- elif integration_id == "zha" -%}
         {{ trigger.event.data.command }}
         {%- endif -%}
-      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 }}'
+      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 }}'
   # update helper
   - service: input_text.set_value
     data:

website/docs/blueprints/controllers/osram_ac025xx00nj.mdx

@@ -240,3 +240,6 @@ This blueprint supports any variant of the Osram SMART+ Switch Mini controller (
 - **2021-08-02**: Improve inputs documentation and organization
 - **2021-10-26**: Standardize blueprints structure and inputs naming across the whole collection. Improve blueprint documentation. No functionality change.
 - **2022-08-08**: Optimize characters usage for the `helper_last_controller_event` text input.
+- **2025-01-05**:
+  - Updated Actions Mapping as per Z2M [docs](https://www.zigbee2mqtt.io/devices/AC0251100NJ_AC0251600NJ_AC0251700NJ.html#actions) for the device. ([@alexdelprete](https://github.com/alexdelprete))
+  - Fix regex for updated helper JSON serialization starting from Home Assistant 2023.5.0.

website/docs/blueprints/controllers/philips_8718699693985.mdx

@@ -30,6 +30,7 @@ Hooks allow to easily create controller-based automations for interacting with m
 
 <Requirement id='deconz'/>
 <Requirement id='zha'/>
+<Requirement id='zigbee2mqtt'/>
 <Requirement name='Input Text Integration' required>
 
 This integration provides the entity which must be provided to the blueprint in the **Helper - Last Controller Event** input. Learn more about this helper by reading the dedicated section in the [Additional Notes](#helper---last-controller-event).
@@ -52,6 +53,12 @@ This integration provides the entity which must be provided to the blueprint in
   selector='device'
   required='deCONZ, ZHA'
 />
+<Input
+  name='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.'
+  selector='entity'
+  required='Zigbee2MQTT'
+/>
 <Input
   name='Helper - Last Controller Event'
   description='Input Text used to store the last event fired by the controller. You will need to manually create a text input entity for this, please read the blueprint Additional Notes for more info.'
@@ -148,3 +155,6 @@ It's also important to note that the controller doesn't natively support double
 - **2021-08-02**: Improve inputs documentation and organization
 - **2021-10-26**: Standardize blueprints structure and inputs naming across the whole collection. Improve blueprint documentation. No functionality change.
 - **2022-08-08**: Optimize characters usage for the `helper_last_controller_event` text input.
+- **2025-01-05**:
+  - Added support for Zigbee2MQTT. ([@alexdelprete](https://github.com/alexdelprete))
+  - Fix regex for updated helper JSON serialization starting from Home Assistant 2023.5.0.