How to send readresponse on OnOff Output Cluster to Coordinator?

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Marte Myrvold — Mon, 07 Feb 2022 14:57:31 GMT

I am glad to hear that you figured this out, and thank you for sharing your solution!

[quote user="Manju_rn"] Not sure why the bind call is required, but without the bind the configure reporting call is not sent to Dongle/ DK from Z2M.[/quote]

When you configure reporting from client to server you need to first create a binding on the cluster. From the ZCL spec when the direction field of the configure reporting command indicates that it is sent from client to server:

The receiver of the Configure Reporting command SHALL Configure Reporting to send to each destination as resolved by the bindings for the cluster hosting the attributes to be reported.

So in order for the server to configure reporting on a cluster, you must first have sent a bind request to create a binding on that cluster.

[quote user="Manju_rn"]I will spend sometime later to sniff the packets from Dongle / DK to Z2M when the server side reporting is configured and find out why this is not working. This will be required, since server (Dongle / DK) as end device are expected to contain all the functionality than depending upon coordinator / network to provide that functionality[/quote]

Please upload the sniffer logs when you do so, and I can help you look. If you are able to share your code I can also test it on my side and see if I can figure out why this is not working.

Best regards,

Marte

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Manju_rn — Mon, 07 Feb 2022 00:14:07 GMT

Here is the status.

1. I was not able to get the reporting configure from server to client (Dongle/DK to Z2M).

2. I was able to get the reporting automatically configured from Z2M to Dongle (without clicking anything on the Z2M). Hence there was no need to add any reporting configuration code in the dongle / DK

So if somebody is working with Z2M and needs to have the reporting configured from client to server, they could utilize the below. The key point here is to use both reporting.bind & endpoint.configureReporting calls in the .js file. Not sure why the bind call is required, but without the bind the configure reporting call is not sent to Dongle/ DK from Z2M. The bind is technically doing nothing as the endpoint specified can be open

const fz = require('zigbee-herdsman-converters/converters/fromZigbee');
const tz = require('zigbee-herdsman-converters/converters/toZigbee');
const exposes = require('zigbee-herdsman-converters/lib/exposes');
const reporting = require('zigbee-herdsman-converters/lib/reporting');
const extend = require('zigbee-herdsman-converters/lib/extend');
const e = exposes.presets;
const ea = exposes.access;

const definition = {
    zigbeeModel: ['DongleSwitch'], // The model ID from: Device with modelID 'lumi.sens' is not supported.
    model: '1.0', // Vendor model number, look on the device for a model number
    vendor: 'DongleNordic', // Vendor of the device (only used for documentation and startup logging)
    description: 'dongle_52840', // Description of the device, copy from vendor site. (only used for documentation and startup logging)
    fromZigbee: [fz.on_off],
    toZigbee: [tz.on_off],
    exposes: [e.switch()],
    configure: async (device, coordinatorEndpoint, logger) => {
       const endpoint = device.getEndpoint(12);
       await reporting.bind(endpoint, coordinatorEndpoint, ['genOnOff']);
       const payload = [{
           attribute: 'onOff',
           minimumReportInterval: 0,
           maximumReportInterval: 0,
            reportableChange: 0,
           }];
       await endpoint.configureReporting('genOnOff', payload);
   },
};

I will spend sometime later to sniff the packets from Dongle / DK to Z2M when the server side reporting is configured and find out why this is not working. This will be required, since server (Dongle / DK) as end device are expected to contain all the functionality than depending upon coordinator / network to provide that functionality

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Manju_rn — Thu, 03 Feb 2022 15:05:04 GMT

[quote userid="92402" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/351135#351135"]The DK should start reporting the attribute automatically if the Configure Reporting command is successful and the attribute is reportable.[/quote]

Thanks. While the manual push (via Z2M UI) of the configure reporting from Z2M works (I still have not be able to do it automatically when DK joins the Z2M), I would still want to make it work from the DK. I used the methods you mentioned in earlier post, but the reporting still is not working. Can you please let me know from where I should call this?

[quote userid="99558" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350796#350796"]Can you please indicate where should I call this? in the void zboss_signal_handler(zb_bufid_t bufid) for the case ZB_BDB_SIGNAL_STEERING: ? Since I could not find anything like case like ZB_BDB_JOIN.[/quote]

my nrf dongle is broken, I think during one of the experimentation in another thread, so will have to check that on weekend to recover. So sniffer data will have to wait a bit longer

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Marte Myrvold — Thu, 03 Feb 2022 13:59:29 GMT

Hi,

[quote user="Manju_rn"]So can I say that that Z2M is always invoking Client to Server Reporting request. Hence, my DK code did not require the reporting configuration? [/quote]

To configure attribute reporting only one of the devices, either the device reporting the attributes or the one receiving the attributes, need to send a Configure Reporting command. So if the coordinator configures it, then you do not need to do anything extra on the DK. The DK should start reporting the attribute automatically if the Configure Reporting command is successful and the attribute is reportable.

[quote user="Manju_rn"]Well, Z2M allows the max interval to be changed from its UI as well. When I change Max and Min interval to 0, then it sends a configuration request to DK and then DK sends the reporting only on Change.[/quote]

So it behaves as expected now? You are correct that setting max reporting interval to 0 will turn off periodic reporting, causing it to only report on attribute change if this is configured. If this is non-zero it will keep reporting periodically regardless of whether it also reports on attribute change.

[quote user="Manju_rn"]But yeah I am aware that reporting then would not work in other zigbee co-ordinator where such provision may not be there.[/quote]

You will always need one of the devices to configure the reporting anyways. If a device is expected to receive attribute reports from a certain device, then it makes sense that the receiving device is able to configure attribute reporting. All it needs to do is to create a binding for the cluster that should be reported by sending a bind request, and then send a configure reporting command.

Best regards,

Marte

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Manju_rn — Wed, 02 Feb 2022 12:56:40 GMT

[quote userid="92402" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350876#350876"]So the coordinator does configure reporting, but only with a reportable interval and not on change? [/quote]

Yes, here is the code. There is a override also - see the #2 below, I need to figure out how to use it.

1. As given before the code for the device to be registered

https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/switch.js#L19

2. The code for the reporting library used in the above code

https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/lib/reporting.js#L66

You can see that this variable repInterval.HOUR is populated by default for Max interval. However, there is a provision to use override and need to figure out how to use when in #1

    onOff: async (endpoint, overrides) => {
        const p = payload('onOff', 0, repInterval.HOUR, 0, overrides);
        await endpoint.configureReporting('genOnOff', p);

So can I say that that Z2M is always invoking Client to Server Reporting request. Hence, my DK code did not require the reporting configuration?

[quote userid="92402" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350876#350876"]It should not be necessary to set the max interval to 0 in order to get reportable value change as far as I am aware.[/quote]

Well, Z2M allows the max interval to be changed from its UI as well. When I change Max and Min interval to 0, then it sends a configuration request to DK and then DK sends the reporting only on Change.

Hopefully, if the override works fine than I need not configure any reporting on DK. But yeah I am aware that reporting then would not work in other zigbee co-ordinator where such provision may not be there.

Yes, I do have the dongle, will configure this as sniffer later today to capture the packets

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Marte Myrvold — Wed, 02 Feb 2022 12:45:27 GMT

Hi,

So the coordinator does configure reporting, but only with a reportable interval and not on change? From looking at the last code you shared this seems to be correct. If it is the coordinator sending the configure reporting command, do you know where the command is filled and sent? In order to configure reporting on when the attribute value is changed you need to set the reportable change field to the minimum change to the attribute that will result in a report being issued.

[quote user="Manju_rn"]However, the default reporting takes the min interval value as 0, and the max interval value as 3600 (see the snapshot for Z2M). However, the intention was to enable enable reporting based on the value change, so the max interval value should be 0 I believe. [/quote]

It should not be necessary to set the max interval to 0 in order to get reportable value change as far as I am aware.

It would also be useful to get a sniffer log of what packets the coordinator is sending and to be able to see the fields of the packets. Do you have an additional nRF52840 DK or Dongle? If so you can use it as a sniffer using nRF Sniffer for 802.15.4. If you get a sniffer log of this you can upload the log as a pcap file here and I will take a look at it. If so, you need to either start the sniffer before the coordinator starts the network so the packets are decrypted, or share the network key so I can decrypt the packets.

Best regards,

Marte

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Manju_rn — Wed, 02 Feb 2022 09:16:02 GMT

Thanks for the information. Somehow the Z2M still registers the reporting even without specifying the attribute reporting. Maybe I will double check. Here is the code of Z2M to support new devices in Z2M which I had missed earlier https://github.com/Koenkk/zigbee2mqtt.io/blob/master/docs/externalConvertersExample/switch.js#L19

[quote userid="92402" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350793#350793"]This should be called after the device has joined the network[/quote]

Can you please indicate where should I call this? in the void zboss_signal_handler(zb_bufid_t bufid) for the case ZB_BDB_SIGNAL_STEERING: ? Since I could not find anything like case like ZB_BDB_JOIN.

Also, the above Macros do not provide any provision to change the max and min interval. I believe the max and mix intervals needs to be set to 0 to enable the attribute to be reported on every change

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Marte Myrvold — Wed, 02 Feb 2022 09:03:04 GMT

Hi,

Thank you for the link to the source code of the Zigbee2MQTT converter. This makes it clearer what it is you want.

[quote user="Manju_rn"]I was of the assumption that the macro ZB_HA_DECLARE_ON_OFF_OUTPUT_EP would enable the reporting[/quote]

ZB_HA_DECLARE_ON_OFF_OUTPUT_EP does not enable reporting. It only declares the endpoint for a device and defines a Simple Descriptor for the endpoint. This is necessary for the device to be able to report attributes, but it does not in itself configure attribute reporting. You can read more about this in the guide Adding ZCL clusters to application and in Zigbee stack API overview.

Please see Configure reporting command sending and parsing to read more about configuring attribute reporting. Since you want to enable reporting on the DK this will be the server notifying the client that the server has configured attribute reporting and that it will report attribute values to the client. Thus, you should use the macros ZB_ZCL_GENERAL_INIT_CONFIGURE_REPORTING_CLI_REQ and ZB_ZCL_GENERAL_ADD_RECV_REPORT_CONFIGURE_REPORTING_REQ, and then send it with ZB_ZCL_GENERAL_SEND_CONFIGURE_REPORTING_REQ.

I have earlier made an example of this with the measured value attribute in the Temperature cluster. You can see the implementation of the attribute configuration below:

void configure_attr_reporting(zb_bufid_t bufid)
{
    zb_uint8_t * cmd_ptr;
    zb_uint16_t dst_addr = 0x0000;
    zb_uint8_t dst_ep = 64;
    ZB_ZCL_GENERAL_INIT_CONFIGURE_REPORTING_CLI_REQ(bufid,
                                                    cmd_ptr,
                                                    ZB_ZCL_ENABLE_DEFAULT_RESPONSE);
    ZB_ZCL_GENERAL_ADD_RECV_REPORT_CONFIGURE_REPORTING_REQ(cmd_ptr,
                                                           ZB_ZCL_ATTR_TEMP_MEASUREMENT_VALUE_ID,
                                                           0);
    ZB_ZCL_GENERAL_SEND_CONFIGURE_REPORTING_REQ(bufid,
                                                cmd_ptr,
                                                dst_addr,
                                                ZB_APS_ADDR_MODE_16_ENDP_PRESENT,
                                                dst_ep, 
                                                MULTI_SENSOR_ENDPOINT,
                                                ZB_AF_HA_PROFILE_ID, 
                                                ZB_ZCL_CLUSTER_ID_TEMP_MEASUREMENT, 
                                                NULL);
    NRF_LOG_INFO("Attribute reporting configured");
}

This should be called after the device has joined the network. In my example I called it with zb_buf_get_out_delayed() to allocate the out buffer:

zb_buf_get_out_delayed(configure_attr_reporting);

Please note that this example was created in nRF5 SDK, but the Zigbee stack is ZBOSS in both nRF Connect SDK and nRF5 SDK. The one in nRF Connect SDK is just a newer version than the one in nRF5 SDK at the moment, so the parts related to the ZBOSS API are the same or very similar in the two SDKs.

Best regards.

Marte

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Manju_rn — Wed, 02 Feb 2022 08:33:27 GMT

[quote userid="99558" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350714#350714"]ZB_HA_DECLARE_ON_OFF_OUTPUT_EP[/quote]

Realized that there was a small change needed at Z2M to receive the reporting configuration, so the quoted method does indeed initalize the reporting. Hence, the method 'configure_reporting_locally" that was written is not really required to configure reporting.

However, the default reporting takes the min interval value as 0, and the max interval value as 3600 (see the snapshot for Z2M). However, the intention was to enable enable reporting based on the value change, so the max interval value should be 0 I believe.

So I guess I will still have to use the configure_reporting_locally, but somehow the call zb_zcl_put_reporting_info(&rep_info,ZB_TRUE); does not invoke any zigbee message. Is there another method I could use to update the default reporting values of max and Min intervals?

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Manju_rn — Tue, 01 Feb 2022 14:40:27 GMT

[quote userid="92402" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350616#350616"] I have not been able to find a lot of documentation as to what specifically the readResponse in Zigbee2MQTT is, so knowing more about what it is you want to do would make it easier for me to figure out what command you can use[/quote]

Please check the following code in the Zigbee2MQTT Converters. These converters basically a layer in Z2M which parses the Zigbee messages https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/converters/fromZigbee.js#L740

    on_off: {
        cluster: 'genOnOff',
        type: ['attributeReport', 'readResponse'],
        convert: (model, msg, publish, options, meta) => {
            if (msg.data.hasOwnProperty('onOff')) {
                const property = postfixWithEndpointName('state', msg, model);
                return {[property]: msg.data['onOff'] === 1 ? 'ON' : 'OFF'};
            }
        },
    },

It looks for the Cluster 'genOnOff' with type 'readResponse' and the attribute of 'onOff". This is written based on the ZCL specs for OnOff Cluster.

I realized that the reporting is not configured, I was of the assumption that the macro ZB_HA_DECLARE_ON_OFF_OUTPUT_EP would enable the reporting. Anyway, I have configured the reporting like this.

static void configure_reporting_locally(void)
{
  zb_zcl_reporting_info_t rep_info;
  memset(&rep_info, 0, sizeof(rep_info));

  rep_info.direction      = ZB_ZCL_CONFIGURE_REPORTING_SEND_REPORT;
  rep_info.ep             = HA_SWITCH_ENDPOINT;
  rep_info.cluster_id     = ZB_ZCL_CLUSTER_ID_ON_OFF;
  rep_info.cluster_role   = ZB_ZCL_CLUSTER_SERVER_ROLE;
  rep_info.attr_id        = ZB_ZCL_ATTR_ON_OFF_ON_OFF_ID;

  rep_info.u.send_info.min_interval = 0;
  rep_info.u.send_info.max_interval = 0;
  rep_info.u.send_info.delta.u8     = 1;
   
  rep_info.dst.short_addr = 0x0000 ; //Hex 
  rep_info.dst.endpoint   = 12 ;     //Decimal 
  rep_info.dst.profile_id = ZB_AF_HA_PROFILE_ID ;

  zb_zcl_put_reporting_info(&rep_info,ZB_TRUE);
}

void zboss_signal_handler(zb_bufid_t bufid) 
{
	zb_zdo_app_signal_hdr_t *p_sg_p = NULL;
	zb_zdo_app_signal_type_t sig = zb_get_app_signal(bufid, &p_sg_p);
	zb_ret_t status = ZB_GET_APP_SIGNAL_STATUS(bufid);

	/* Update network status LED */
	// zigbee_led_status_update(bufid, ZIGBEE_NETWORK_STATE_LED);

	switch (sig) 
	{
		case ZB_BDB_SIGNAL_DEVICE_REBOOT:
			/* fall-through */
		case ZB_BDB_SIGNAL_STEERING:
			/* Call default signal handler. */
			ZB_ERROR_CHECK(zigbee_default_signal_handler(bufid));
			if (status == RET_OK) 
			{
				LOG_INF("Steering Completed. Going ahead with reporting configuration");
				configure_reporting_locally();
			}
			break;

		default:
			/* Call default signal handler. */
			ZB_ERROR_CHECK(zigbee_default_signal_handler(bufid));
			break;
	}

	if (bufid) 
	{
		zb_buf_free(bufid);
	}
}

The above setting does not send any configuration details to Z2M. Is there some code I need to call specifically to set the reporting?

However, I have noticed that when I send the reporting configuration request from Z2M to DK, then the reporting get enabled. However, this does not help as I want to configure the reporting from the device - DK in this case.

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Marte Myrvold — Tue, 01 Feb 2022 10:23:35 GMT

Hi,

[quote user="Manju_rn"]So my question is there a macro which generates the same zigbee message which is called during initialization?[/quote]

To answer this I need to know what readResponse actually is. In the Zigbee specification you have different types of read responses, but there is nothing simply called read response, which is why I asked for a clarification as to what sort of read response this is. It would be better to know what you want to achieve with the read response. Do you want to read what the value of the OnOff attribute is, and if so on which device? Or is the goal to do something else? I have not been able to find a lot of documentation as to what specifically the readResponse in Zigbee2MQTT is, so knowing more about what it is you want to do would make it easier for me to figure out what command you can use.

[quote user="Manju_rn"]However, when I press the button, as I explained in the above post, I call the macro 'ZB_ZCL_ON_OFF_SEND_REQ which generates the following. Looks like this call modifies the type to 'commandOn' and data payload is empty[/quote]

This is because the macro ZB_ZCL_ON_OFF_SEND_REQ sends an On or Off command from the On/Off cluster. The parameter cmd_id decides which of the commands is sent, and in your code you are using the ID of the On command, so you are sending the On command, resulting in the type in Zigbee2MQTT being 'commandOn'.

[quote user="Manju_rn"]2. For the second point you asked[/quote]

As for your second point the DK is implemented and acting as a light switch in your program, which is why i called it a light switch. It does, however, matter which endpoint the command is sent to if you are sending On/Off command to turn something on or off. But since you are saying that you want to get the read response I am not sure if sending the On command is actually what you want to do or not, so please specify what it is you want to achieve with this program.

Best regards,

Marte

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Manju_rn — Tue, 01 Feb 2022 04:46:15 GMT

Hi Marte,

[quote userid="92402" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350355#350355"]Can you clarify what you mean by the read response? Is this something the DK should send, or the coordinator? Is this as a response to the ON/OFF command, or are you thinking about the Read Attributes command?[/quote]

1. If you check the screenshot above (pasted the text below), it has this debug messages in Zigbee2Mqtt (Z2M). This is issued just when the DK connects to Z2M. So the initial setup of the OnOff Cluster generates the type 'readResponse' from cluster genOnOff and send to co-ordinator

Debug Received Zigbee message from 'dev_board', type 'readResponse', cluster 'genOnOff', data '{"onOff":0}' from endpoint 12 with groupID 0

However, when I press the button, as I explained in the above post, I call the macro 'ZB_ZCL_ON_OFF_SEND_REQ which generates the following. Looks like this call modifies the type to 'commandOn' and data payload is empty. So my question is there a macro which generates the same zigbee message which is called during initialization? This could be reused during button press and send to co-ordinator

Debug Received Zigbee message from 'dev_board', type 'commandOn', cluster 'genOnOff', data '{}' from endpoint 12 with groupID 0

2. For the second point you asked

[quote userid="92402" url="~/f/nordic-q-a/84220/how-to-send-readresponse-on-onoff-output-cluster-to-coordinator/350355#350355"]I see you are sending the ON/OFF command to the endpoint of the light switch. Is the endpoint on the coordinator also 12, so that the command is sent to the correct endpoint?[/quote]

I am just sending the ON/OFF command to the co-ordinator. There is technically no LightSwitch. The Z2M (running as a co-ordinator) just receives the Zigbee messages and converts to MQTT messages. So it does not matter which endpoint the zigbee command from the DK is sent to. As long as the messages is received by the co-ordinator (running Z2M) it it good. And this is what I am trying to indicate, during the initial connect when DK connects, the Zigbee Mesages generate has a correct 'type' - readResponse and 'data' {"onOff":0} , but after button press, I believe the Macro changes the type to 'CommandOn' and the data JSON is empty. Hence, wanted to know how can the same method / macro be used which might be called during initial connect.

Hope I am clear. You may check the main.c for more details

RE: How to send readresponse on OnOff Output Cluster to Coordinator?

Marte Myrvold — Mon, 31 Jan 2022 08:25:41 GMT

Hi,

Can you clarify what you mean by the read response? Is this something the DK should send, or the coordinator? Is this as a response to the ON/OFF command, or are you thinking about the Read Attributes command?

I see you are sending the ON/OFF command to the endpoint of the light switch. Is the endpoint on the coordinator also 12, so that the command is sent to the correct endpoint?

Best regards,

Marte