Zigbee Battery Voltage Reporting

RE: Zigbee Battery Voltage Reporting

bikerglen — Mon, 25 Mar 2024 23:05:54 GMT

It's a bit of kluge and likely not compliant with the Zigbee spec (technically the battery voltage is not a reportable attribute) but I was able to read the battery voltage and generate an attribute report every eight hours containing it. The complete source code is in my Github repository for the project. Two separate boards and software for them are in the main repo link.

github.com/.../homebrew_zigbee_devices

nrf52840-four-input/zigbee_switch_v2 is the first software build for the first board and
nrf52840-contact/zigbee_contact_v1 is the second software build for the second board.

RE: Zigbee Battery Voltage Reporting

bikerglen — Tue, 27 Feb 2024 07:37:55 GMT

Hi, Marte. Thanks for the clarification on the way those fields work! I'm working through an interrupt issue at the moment then hope to post the code on github later in the week or this weekend. Once the code is there, I'll mark my reply with the link to the code as the correct answer.

RE: Zigbee Battery Voltage Reporting

Marte Myrvold — Mon, 26 Feb 2024 14:36:18 GMT

Hi,

Great to hear that you managed to figure it out!

You are correct that you need to set the reporting intervals. If the maximum reporting interval is set to 0xffff then the device shall not issue any reports for the attribute. If it is set to 0x0000 and minimum reporting interval is set to something other than 0xffff then the device shall not do periodic reporting. It can still send reports on value change in the last case, but not periodic.

Best regards,
Marte

RE: Zigbee Battery Voltage Reporting

bikerglen — Mon, 26 Feb 2024 03:10:03 GMT

I may have figured it out. I initialized most of the fields in the reporting info struct. Setting the default min interval and default max interval fields seems to have done the trick. I'm getting battery voltage attribute reports every 10 to 30 seconds or so. Now to move these from the dev board and sandbox project to my real hardware and real project.

    batt_rep_info.direction = ZB_ZCL_CONFIGURE_REPORTING_SEND_REPORT;
    batt_rep_info.ep = LIGHT_SWITCH_ENDPOINT;
    batt_rep_info.cluster_id = ZB_ZCL_CLUSTER_ID_POWER_CONFIG;
    batt_rep_info.cluster_role = ZB_ZCL_CLUSTER_SERVER_ROLE;
    batt_rep_info.attr_id = ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID;
    batt_rep_info.dst.short_addr = 0x0000;
    batt_rep_info.dst.endpoint = 1;
    batt_rep_info.dst.profile_id = ZB_AF_HA_PROFILE_ID;
    batt_rep_info.u.send_info.min_interval = 3;       // 3 seconds
    batt_rep_info.u.send_info.max_interval = 15;     // 15 seconds
    batt_rep_info.u.send_info.delta.u8 = 0x00;         // x 100 mV
    batt_rep_info.u.send_info.reported_value.u8 = 0xFF;
    batt_rep_info.u.send_info.def_min_interval = 10;
    batt_rep_info.u.send_info.def_max_interval = 30;

RE: Zigbee Battery Voltage Reporting

bikerglen — Mon, 26 Feb 2024 02:52:21 GMT

I don't have any idea if this is compliant with the zigbee spec or is how the API is supposed to be used, but it lets me send an attribute report after a button press:

During initialization, I run the following the code:

    zb_ret_t status;
    
    zb_zcl_reporting_info_t batt_rep_info;
    memset(&batt_rep_info, 0, sizeof(batt_rep_info));
    
    batt_rep_info.direction = ZB_ZCL_CONFIGURE_REPORTING_SEND_REPORT;
    batt_rep_info.ep = LIGHT_SWITCH_ENDPOINT;
    batt_rep_info.cluster_id = ZB_ZCL_CLUSTER_ID_POWER_CONFIG;
    batt_rep_info.cluster_role = ZB_ZCL_CLUSTER_SERVER_ROLE;
    batt_rep_info.attr_id = ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID;
    batt_rep_info.dst.profile_id = ZB_AF_HA_PROFILE_ID;
    batt_rep_info.u.send_info.min_interval = 3;       // 3 seconds
    batt_rep_info.u.send_info.max_interval = 15;     // 15 seconds
    batt_rep_info.u.send_info.delta.u8 = 0x00;         // x 100 mV
        
    status = zb_zcl_put_reporting_info(&batt_rep_info, ZB_TRUE);       

    status = zb_zcl_start_attr_reporting(
            LIGHT_SWITCH_ENDPOINT,
            ZB_ZCL_CLUSTER_ID_POWER_CONFIG,  
            ZB_ZCL_CLUSTER_SERVER_ROLE,  
            ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID);

Then after a button press, I run the following code:

    zb_zcl_set_attr_val(LIGHT_SWITCH_ENDPOINT,
                                     ZB_ZCL_CLUSTER_ID_POWER_CONFIG, 
                                     ZB_ZCL_CLUSTER_SERVER_ROLE, 
                                     ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID,
                                     &battery_voltage, 
                                     ZB_FALSE);
    zb_zcl_mark_attr_for_reporting (
           LIGHT_SWITCH_ENDPOINT,
           ZB_ZCL_CLUSTER_ID_POWER_CONFIG,
           ZB_ZCL_CLUSTER_SERVER_ROLE,
           ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID);

This gets me an attribute report after the button press containing the battery voltage but no periodic reports.

What do I need to kick off the report timers?

RE: Zigbee Battery Voltage Reporting

bikerglen — Sun, 25 Feb 2024 23:11:38 GMT

Addendum: Is there a function I can call that will send an attribute report? This might be the path of least resistance.