Hue bulb brightness and colour temperature with group bindings and zigbee2mqtt

[deviantintegral]

I recently redid my basement with Philips Hue downlights (and a few bulbs) and Inovelli switches. It works great! Except, for Adaptive lighting, turning on at the switch with the group bindings led to them turning on with their last off values, and then Adaptive Lighting fixing them to the right values in a few seconds. It was a bit disorienting when turning the lights on first thing in the morning (or in the middle of the night).

Issue #1022 was helpful in this - it seems like this could be fixed in AL directly if desired. There's also Koenkk/zigbee2mqtt#18699 - note it looks like ZHA has this built in, but I can't test with that.

The trick is that Hue bulbs will accept colour and brightness commands while switched off, if you set the ZCL ExecuteIfOff option bit on the Color Control and Level Control clusters. Z2M documents this as color_options: {execute_if_off: true}, but that converter isn't exposed on my Hue devices. The first automation writes attribute 0x000F directly on both clusters instead. It runs on HA start and whenever Z2M reconnects, which also covers a replacement bulb once it's added to the Zigbee group. The second automation then pushes Adaptive Lighting's current target into each group whenever it turns off, and every 10 minutes after, so the bulbs are already correct (or close enough!) the moment the switch closes.

alias: Re-assert ExecuteIfOff on staged Zigbee groups
description: >-
  The bulb-staging automation depends on the ZCL ExecuteIfOff option bit
  (attribute 0x000F = 1) being set on both the Color Control and Level Control
  clusters. Without it, commands sent to an off bulb are silently discarded and
  staging fails invisibly - the staging automation keeps publishing happily and
  nothing works. This re-asserts the bit on every staged group after a Home
  Assistant restart or a Zigbee2MQTT bridge reconnect. The 60 second delay lets
  the mesh settle first, since a write to a bulb that has not rejoined is lost.
  Attribute writes groupcast, so one publish per group covers all its members.
mode: single
triggers:
  - event: start
    trigger: homeassistant
  - entity_id: binary_sensor.zigbee2mqtt_bridge_connection_state
    to: "on"
    trigger: state
actions:
  - alias: Let the mesh settle before writing attributes
    delay:
      seconds: 60
  - repeat:
      for_each: ["11", "13", "15", "16", "18", "19", "21", "22"]
      sequence:
        - action: mqtt.publish
          alias: ExecuteIfOff for colour
          data:
            payload: >-
              {"write":{"cluster":"lightingColorCtrl","options":{},"payload":{"options":1}}}
            topic: zigbee2mqtt/{{ repeat.item }}/set
        - action: mqtt.publish
          alias: ExecuteIfOff for level
          data:
            payload: >-
              {"write":{"cluster":"genLevelCtrl","options":{},"payload":{"options":1}}}
            topic: zigbee2mqtt/{{ repeat.item }}/set
        - delay:
            milliseconds: 500

alias: Stage Zigbee bulbs to adaptive values while off
description: >-
  Philips Hue bulbs bound directly to switches come on at their last state, then
  Adaptive Lighting corrects them a second or two later - jarring at night. This
  pre-loads AL's current target into each Zigbee group while it is OFF, using the
  ZCL ExecuteIfOff option, so the bulbs light at the correct value immediately.
  Colour uses moveToColor (xy) in sleep mode and the normal color_temp converter
  otherwise, mirroring AL's own behaviour. Brightness uses a raw moveToLevel
  command because Z2M's 'brightness' key sends moveToLevelWithOnOff, which would
  turn the bulb on; Hue ignores the onLevel attribute, so that is not a viable
  alternative. Requires the ExecuteIfOff bit (attribute 0x000F = 1) on both the
  Color Control and Level Control clusters - the companion re-assert automation
  handles that and is the only setup step needed. Turn this automation off to
  disable staging entirely.
mode: queued
max: 10
triggers:
  - minutes: /10
    trigger: time_pattern
  - event: start
    trigger: homeassistant
  - entity_id:
      - light.andrew_s_office_lights
      - light.theatre_back_lights
      - light.theatre_front_lights
      - light.basement_stairs_top
      - light.basement_stairs_bottom
      - light.basement_bathroom_pot_lights
      - light.basement_bathroom_wall_sconces
      - light.guest_bedroom_lights
    to: "off"
    trigger: state
conditions: []
variables:
  targets:
    - al: switch.adaptive_lighting_andrews_office
      light: light.andrew_s_office_lights
      sleep: switch.adaptive_lighting_sleep_mode_andrews_office
      topic: "11"
    - al: switch.adaptive_lighting_guest_bedroom
      light: light.guest_bedroom_lights
      sleep: switch.adaptive_lighting_sleep_mode_guest_bedroom
      topic: "13"
    - al: switch.adaptive_lighting_basement_bathroom
      light: light.basement_bathroom_pot_lights
      sleep: switch.adaptive_lighting_sleep_mode_basement_bathroom
      topic: "15"
    - al: switch.adaptive_lighting_basement_bathroom
      light: light.basement_bathroom_wall_sconces
      sleep: switch.adaptive_lighting_sleep_mode_basement_bathroom
      topic: "16"
    - al: switch.adaptive_lighting_basement_lights
      light: light.theatre_back_lights
      sleep: switch.adaptive_lighting_sleep_mode_basement_lights
      topic: "18"
    - al: switch.adaptive_lighting_basement_lights
      light: light.theatre_front_lights
      sleep: switch.adaptive_lighting_sleep_mode_basement_lights
      topic: "19"
    - al: switch.adaptive_lighting_basement_lights
      light: light.basement_stairs_top
      sleep: switch.adaptive_lighting_sleep_mode_basement_lights
      topic: "21"
    - al: switch.adaptive_lighting_basement_lights
      light: light.basement_stairs_bottom
      sleep: switch.adaptive_lighting_sleep_mode_basement_lights
      topic: "22"
actions:
  - repeat:
      for_each: "{{ targets }}"
      sequence:
        - alias: Only stage groups that are off, with a live AL switch
          if:
            - condition: template
              value_template: >-
                {{ is_state(repeat.item.light, 'off') and
                is_state(repeat.item.al, 'on') and state_attr(repeat.item.al,
                'brightness_pct') is not none and state_attr(repeat.item.al,
                'xy_color') is not none }}
          then:
            - alias: "Colour: xy in sleep mode, colour temp otherwise"
              if:
                - condition: template
                  value_template: "{{ is_state(repeat.item.sleep, 'on') }}"
              then:
                - action: mqtt.publish
                  data:
                    payload: >-
                      {"command":{"cluster":"lightingColorCtrl","command":"moveToColor","payload":{"colorx":{{
                      (state_attr(repeat.item.al,'xy_color')[0] * 65535) | round
                      | int }},"colory":{{
                      (state_attr(repeat.item.al,'xy_color')[1] * 65535) | round
                      | int }},"transtime":0}}}
                    topic: zigbee2mqtt/{{ repeat.item.topic }}/set
              else:
                - action: mqtt.publish
                  data:
                    payload: >-
                      {"color_temp": {{ (1000000 /
                      state_attr(repeat.item.al,'color_temp_kelvin')) | round |
                      int }}}
                    topic: zigbee2mqtt/{{ repeat.item.topic }}/set
            - action: mqtt.publish
              alias: Brightness via raw moveToLevel so the bulb stays off
              data:
                payload: >-
                  {"command":{"cluster":"genLevelCtrl","command":"moveToLevel","payload":{"level":{{
                  [ (state_attr(repeat.item.al,'brightness_pct') * 2.54) | round
                  | int, 1 ] | max }},"transtime":0}}}
                topic: zigbee2mqtt/{{ repeat.item.topic }}/set
            - alias: Stagger to avoid a burst on the mesh
              delay:
                milliseconds: 300