zigbee2mqtt how to override payload ?

Configuration Zigbee
1

I have some IOMZB-110 devices, and I want to use the “On with timed off” ability of the devices, but I’m not yet aware of how to override the payload.

Any hint please

2

I am currently using this script with ZHA to press for 500 ms. It works without MQTT though.

sequence:
  - action: zha.issue_zigbee_cluster_command
    metadata: {}
    data:
      cluster_type: in
      ieee: xx:xx:xx:xx:xx:xx:xx:xx
      endpoint_id: 116
      cluster_id: 6
      command: 66
      command_type: server
      params:
        on_time: 5
        off_wait_time: 10
        on_off_control: []
3

You will use the mqtt.publish service/action and send the command including your payload towards the mqtt-broker.

I figured my only one zigbee actor is capable too and did some testing with the help of @Kool, the one from @sullivan in this post and looking at Zigbee-herdsman - cluster.ts.

You’ll need to send the onWithTimedOff command (66) of the cluster genOnOff (6) including all required attributes (ontime, offwaittime, ctrlbits):

action: mqtt.publish
data:
  topic: zigbee2mqtt/Schlafzimmer/set
  payload: |-
    {
      "command": {
        "cluster": 6,
        "command": 66,
        "payload": {
          "ontime": 5,
          "offwaittime": 10,
          "ctrlbits": 0
        }
      }
    }

Above action was successfully published and interpreted. You can try by removing one of the payload attributes like ontime - looking at the Zigbee2Mqtt-Logs you will then see an error as Parameter 'ontime' is missing:

z2m: Publish 'set' 'command' to 'Schlafzimmer' failed: 'Error: ZCL command 0x1234567890/1 genOnOff.onWithTimedOff({"on_time":5,"off_wait_time":10,"ctrlbits":0}, {"timeout":10000,"disableResponse":false,"disableRecovery":false,"disableDefaultResponse":false,"direction":0,"reservedBits":0,"writeUndiv":false}) failed (Parameter 'ontime' is missing)'

Sadly I think my LED driver from 2016 doesn’t do anything with the payload (The Zigbee2Mqtt page of a similar Paulmann device as mine isn’t contained in the device list tells: “Support depends on the light firmware”). At least the command is executed as the light turns on blinking once (maybe some kind of what do you want from me? not knowing what to do with the payload :grinning:).

So keep us informed if it works out for you :slight_smile:

4

I tried it in a script, but I’m now stuck with it. The command seem’s to be sent, but the relay will not switch, and I get an timeout:

2025-01-19 13:52:59] error: z2m: Publish ‘set’ ‘command’ to ‘Hoftor’ failed: ‘Error: ZCL command 0x0015bc0042001c26/1 genOnOff.onWithTimedOff({“ontime”:5,“offwaittime”:0,“ctrlbits”:0}, {“timeout”:10000,“disableResponse”:false,“disableRecovery”:false,“disableDefaultResponse”:false,“direction”:0,“reservedBits”:0,“writeUndiv”:false}) failed (Timeout - 52618 - 1 - 109 - 6 - 11 after 10000ms)’

A workaround I found is an automatisation which triggers on the on state and switches the relay off immediately

5

Other workaround I found is to use a script with a sequence of commands:

- action: mqtt.publish
  data:
    topic: "zigbee2mqtt/Hoftor/set"
    payload: '{"state_l11" : "ON"}'
- delay: "00:00:0.2"
- action: mqtt.publish
  data:
    topic: "zigbee2mqtt/Hoftor/set"
    payload: '{"state_l11" : "OFF"}'

But would be nice to know why the OnWIthTimedOff does not work

6

Hi Klaus,

so at least you successfully triggered some action with the device. Maybe the device cannot handle the wait_time commands. I don’t know if @Kool actually used the IOMZB-110. I wasn’t and eventually could see some reaction with my device type.

Zigbee2Mqtt - devices - IOMZB-110 tells Support depends on the switch firmware. I could not find any source of information actually confirming the support. Maybe these text blocks are always written with these kind of devices on the Zigbee2Mqtt page :-).

Did you try some variants of your script according to above link?

- action: mqtt.publish
  data:
    topic: "zigbee2mqtt/Hoftor/set"
    payload: '{"state_l11" : "ON", "on_time": 300, "off_wait_time": 120}'

or exactly as they have written: payload: '{"state" : "ON", "on_time": 300, "off_wait_time": 120}'

That’s only some trail&error…

7

For info it is a “FRIENT - Module I/O Zigbee 3.0”, it reports itself as “model”: “IOMZB-110”. It works currently as a garage module.