How to use Power Config Cluster

RE: How to use Power Config Cluster

KrystofVydra — Wed, 10 Mar 2021 16:23:05 GMT

Hello Mazis,

I have already made it work --> the attribute value can be written without an error. (There was something bad in my SDK, I had to redownload it and put my project in fresh SDK and just change those few files)

So now, I am trying to receive the attribute reports with zigbee CLI coordinator on my second DK.

I can bind, but I can't subscribe to the power config battery remaining attribute.

I also tried adding the power config to the multi_sensor example, and I can easily bind and subscribe to the other 2 attributes (pressure and temperature measurement), but I can't subscribe to battery reamining percentage.

I get this error (which corresponding to ZCL documentation means FAILURE):

the other 2 attributes from the device can be received easily.

here is the multi_sensor project:

devzone.nordicsemi.com/.../7711.multi_5F00_sensor_5F00_with_5F00_power_5F00_config.zip

the only file I modified is the zb_multi_sensor.h

Could you look at this if you have some spare time? Thanks!

also: 1) the cluster num should be correct, I had to change it otherwise I couln't have seen the Power Config (0x0001) cluster in cluster list in CLI coordinator

2)Yes, I use same macro as you (the EXT one)

3)Yep, I think that is weird. I tried using the WINDOW_COVERING_CLUSTER ID but again, I coulnd't have seen Power Config cluster in CLI coordinator cluster list request

4) So now I somewhat fixed the error when setting the zb_zcl_set_attr_val(), but I still can't subscribe to the attribute.

Thank you very much Mazis!

Best regards,

Krystof Vydra

RE: How to use Power Config Cluster

mazis — Wed, 10 Mar 2021 14:49:08 GMT

Hi Krystof!

I am so sorry but I didn't find anything wrong in your code... All the sensible code is modified, and it looks correct to me. The 0x64 is valid, and the attribute type indeed, is zb_uint8_t.

The only things that I think might be wrong are:

- The number of ZB_HA_WINDOW_COVERING_IN_CLUSTER_NUM or ZB_HA_WINDOW_COVERING_OUT_CLUSTER_NUM might be wrong. Take a look and change them if necessary.

- I also had a issue declaring the cluster. I had to use the extended Macro to declare the attribute list of the power config. Are you using
ZB_ZCL_DECLARE_POWER_CONFIG_BATTERY_ATTRIB_LIST_EXT?

- When I wwas reviewing your code I found what might be a bug in my code. When you call zb_zcl_set_attr_val() and give it the ZB_ZCL_CLUSTER_ID_POWER_CONFIG as parameter, can you try to use the corresponding CLUSTER_ID for the window covering? Just like I am doing, although it seems wrong in my code.

- I would also try setting any other attribute to see if the problem is the parameters you are giving to the function zb_zcl_set_attr_val(). I would also change the cluster.

I hope this helps...
Cheers!

RE: How to use Power Config Cluster

KrystofVydra — Wed, 10 Mar 2021 13:53:17 GMT

Hello Mazis,

Thanks for reply, I was trying to get the reporting to work for almost a week now.

I got myself second nrf52840 DK now, so I use the CLI example on that.

I can already see the power config in the device cluster list in CLI coordinator

But I can't set the battery remaining value. It always gives me error 135 which is invalid Value

I am trying to set value 0x64 which is 100 which should correspond to 50% of battery.

devzone.nordicsemi.com/.../6087.zb_5F00_ha_5F00_window_5F00_covering.h

devzone.nordicsemi.com/.../zb_5F00_zcl_5F00_power_5F00_config.h

devzone.nordicsemi.com/.../zb_5F00_zcl_5F00_window_5F00_covering.h

Here are my files, could you maybe take a look? How do yours zb_zcl_power_config.h, zb_zcl_door_lock.h and zb_ha_door_lock.h files look like?

Here is my implemenation in main.c:

    battery_percentage = 0x64;
    zcl_status = zb_zcl_set_attr_val(HA_WINDOW_COVERING_ENDPOINT,
                                     ZB_ZCL_CLUSTER_ID_POWER_CONFIG, 
                                     ZB_ZCL_CLUSTER_SERVER_ROLE, 
                                     ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_ID,
                                     &battery_percentage, 
                                     ZB_FALSE);
    if(zcl_status != ZB_ZCL_STATUS_SUCCESS)
    {
        NRF_LOG_INFO("Set battery remaining percentage value fail. zcl_status: %d,", zcl_status);
    }

in zcl_device_cb so when I send a command to the device it reports me battery.

battery_percentage here is type zb_uint8_t.

Thank you!

Best regards,

Krystof Vydra

RE: How to use Power Config Cluster

mazis — Fri, 05 Mar 2021 11:49:41 GMT

Hello!

I didn't changed the #define line you are saying... I have that line as follows:

zb_void_t zb_zcl_power_config_init_server(void);
zb_void_t zb_zcl_power_config_init_client(void);
#define ZB_ZCL_CLUSTER_ID_POWER_CONFIG_SERVER_ROLE_INIT zb_zcl_power_config_init_server
#define ZB_ZCL_CLUSTER_ID_POWER_CONFIG_CLIENT_ROLE_INIT zb_zcl_power_config_init_client

About the battery report. If you look the Zigbee reference, (I think that) the only reportable attribute is the remaining battery percentage. I don't know which coordinator are you using but to enable attribute reporting in mine, I had to bind and cofigure reporting for that attribute. If you are using the CLI example, the documentation is pretty good, I would take a look at it. What I do in my code to get the report of the attribute is this:

    UNUSED_RETURN_VALUE(zb_zcl_set_attr_val(MY_DOOR_LOCK_ENDPOINT,
                                            ZB_ZCL_CLUSTER_ID_DOOR_LOCK,
                                            ZB_ZCL_CLUSTER_SERVER_ROLE,
                                            ZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_ID,
                                            &batteryLevel,
                                            ZB_FALSE));

I hope this helps!

RE: How to use Power Config Cluster

KrystofVydra — Thu, 04 Mar 2021 17:36:02 GMT

Hello Mazis,

did you have to modify something in power config? Because I had to add

#define ZB_ZCL_CLUSTER_ID_POWER_CONFIG_SERVER_ROLE_INIT ((zb_zcl_cluster_init_t)NULL)

at the end of the zb_zcl_power_config,h

Otherwise it won't compile.

But I still can't read or report the battery voltage. Is there something special I have to set in main.c in the Zigbee Device Callback?

Thanks

Krystof

RE: How to use Power Config Cluster

Marte Myrvold — Tue, 09 Feb 2021 07:43:11 GMT

Hi,

Great to hear that you managed to implement it, and thank you for sharing your implementation so that others can see it as well!

Best regards,

Marte

RE: How to use Power Config Cluster

mazis — Mon, 08 Feb 2021 12:04:34 GMT

Finally I made the integration of the Power Config cluster within the Door Lock endpoint. I had to modify a few files, so here is the code (it may help somebody else). Marte, please, if you find some potential errors or improvements, just tell me:

First of all I used the ZB_ZCL_DECLARE_POWER_CONFIG_BATTERY_ATTRIB_LIST_EXT to declare the attribute list of the Power Config cluster, the other attribute declarations didn't work for me.

typedef  struct contexto_alimentacion_s
{
    zb_uint8_t battery_voltage; // Atributo 3.3.2.2.3.1
    zb_uint8_t battery_size; // Atributo 3.3.2.2.4.2
    zb_uint8_t battery_quantity; // Atributo 3.3.2.2.4.4
    zb_uint8_t battery_rated_voltage; // Atributo 3.3.2.2.4.5
    zb_uint8_t battery_alarm_mask; // Atributo 3.3.2.2.4.6
    zb_uint8_t battery_voltage_min_threshold; // Atributo 3.3.2.2.4.7
    zb_uint8_t battery_percentage_remaining; // Atributo 3.3.2.2.3.1
    zb_uint8_t battery_voltage_threshold_1; // Atributo 3.3.2.2.4.8
    zb_uint8_t battery_voltage_threshold_2; // Atributo 3.3.2.2.4.8
    zb_uint8_t battery_voltage_threshold_3; // Atributo 3.3.2.2.4.8
    zb_uint8_t battery_percentage_min_threshold; // Atributo 3.3.2.2.4.9
    zb_uint8_t battery_percentage_threshold_1; // Atributo 3.3.2.2.4.10
    zb_uint8_t battery_percentage_threshold_2; // Atributo 3.3.2.2.4.10
    zb_uint8_t battery_percentage_threshold_3; // Atributo 3.3.2.2.4.10
    zb_uint32_t battery_alarm_state; // Atributo 3.3.2.2.4.11
} contexto_alimentacion_t;

static contexto_alimentacion_t contexto_alimentacion;

ZB_ZCL_DECLARE_POWER_CONFIG_BATTERY_ATTRIB_LIST_EXT(lista_atributos_alimentacion,
                                                    &contexto_alimentacion.battery_voltage,
                                                    &contexto_alimentacion.battery_size,
                                                    &contexto_alimentacion.battery_quantity,
                                                    &contexto_alimentacion.battery_rated_voltage,
                                                    &contexto_alimentacion.battery_alarm_mask,
                                                    &contexto_alimentacion.battery_voltage_min_threshold,
                                                    &contexto_alimentacion.battery_percentage_remaining,
                                                    &contexto_alimentacion.battery_voltage_threshold_1,
                                                    &contexto_alimentacion.battery_voltage_threshold_2,
                                                    &contexto_alimentacion.battery_voltage_threshold_3,
                                                    &contexto_alimentacion.battery_percentage_min_threshold,
                                                    &contexto_alimentacion.battery_percentage_threshold_1,
                                                    &contexto_alimentacion.battery_percentage_threshold_2,
                                                    &contexto_alimentacion.battery_percentage_threshold_3,
                                                    &contexto_alimentacion.battery_alarm_state);

To declare the cluster within the Door Lock endpoint, I modified the Macro ZB_HA_DECLARE_DOOR_LOCK_CLUSTER_LIST and create my own as follows:

#define ZB_HA_DECLARE_MY_DOOR_LOCK_CLUSTER_LIST(                      \
      cluster_list_name,                                              \
      door_lock_attr_list,                                            \
      basic_attr_list,                                                \
      identify_attr_list,                                             \
      groups_attr_list,                                               \
      scenes_attr_list,                                               \
      power_config_attr_list)                                         \
      zb_zcl_cluster_desc_t cluster_list_name[] =                     \
      {                                                               \
        ZB_ZCL_CLUSTER_DESC(                                          \
          ZB_ZCL_CLUSTER_ID_IDENTIFY,                                 \
          ZB_ZCL_ARRAY_SIZE(identify_attr_list, zb_zcl_attr_t),       \
          (identify_attr_list),                                       \
          ZB_ZCL_CLUSTER_SERVER_ROLE,                                 \
          ZB_ZCL_MANUF_CODE_INVALID                                   \
        ),                                                            \
        ZB_ZCL_CLUSTER_DESC(                                          \
          ZB_ZCL_CLUSTER_ID_BASIC,                                    \
          ZB_ZCL_ARRAY_SIZE(basic_attr_list, zb_zcl_attr_t),          \
          (basic_attr_list),                                          \
          ZB_ZCL_CLUSTER_SERVER_ROLE,                                 \
          ZB_ZCL_MANUF_CODE_INVALID                                   \
        ),                                                            \
        ZB_ZCL_CLUSTER_DESC(                                          \
          ZB_ZCL_CLUSTER_ID_DOOR_LOCK,                                \
          ZB_ZCL_ARRAY_SIZE(door_lock_attr_list, zb_zcl_attr_t),      \
          (door_lock_attr_list),                                      \
          ZB_ZCL_CLUSTER_SERVER_ROLE,                                 \
          ZB_ZCL_MANUF_CODE_INVALID                                   \
        ),                                                            \
        ZB_ZCL_CLUSTER_DESC(                                          \
          ZB_ZCL_CLUSTER_ID_SCENES,                                   \
          ZB_ZCL_ARRAY_SIZE(scenes_attr_list, zb_zcl_attr_t),         \
          (scenes_attr_list),                                         \
          ZB_ZCL_CLUSTER_SERVER_ROLE,                                 \
          ZB_ZCL_MANUF_CODE_INVALID                                   \
        ),                                                            \
        ZB_ZCL_CLUSTER_DESC(                                          \
          ZB_ZCL_CLUSTER_ID_GROUPS,                                   \
          ZB_ZCL_ARRAY_SIZE(groups_attr_list, zb_zcl_attr_t),         \
          (groups_attr_list),                                         \
          ZB_ZCL_CLUSTER_SERVER_ROLE,                                 \
          ZB_ZCL_MANUF_CODE_INVALID                                   \
        ),                                                            \
        ZB_ZCL_CLUSTER_DESC(                                          \
          ZB_ZCL_CLUSTER_ID_POWER_CONFIG,                             \
          ZB_ZCL_ARRAY_SIZE(power_config_attr_list, zb_zcl_attr_t),   \
          (power_config_attr_list),                                   \
          ZB_ZCL_CLUSTER_SERVER_ROLE,                                 \
          ZB_ZCL_MANUF_CODE_INVALID                                   \
        )                                                             \
      }

I also had to modify the ZB_ZCL_DECLARE_DOOR_LOCK_SIMPLE_DESC Macro:

#define ZB_ZCL_DECLARE_DOOR_LOCK_SIMPLE_DESC(ep_name, ep_id, in_clust_num, out_clust_num) \
      ZB_DECLARE_SIMPLE_DESC(in_clust_num, out_clust_num);                  \
      ZB_AF_SIMPLE_DESC_TYPE(in_clust_num, out_clust_num)  simple_desc_##ep_name = \
      {                                                                     \
        ep_id,                                                              \
        ZB_AF_HA_PROFILE_ID,                                                \
        ZB_HA_DOOR_LOCK_DEVICE_ID,                                          \
        ZB_HA_DEVICE_VER_DOOR_LOCK,                                         \
        0,                                                                  \
        in_clust_num,                                                       \
        out_clust_num,                                                      \
        {                                                                   \
          ZB_ZCL_CLUSTER_ID_BASIC,                                          \
          ZB_ZCL_CLUSTER_ID_IDENTIFY,                                       \
          ZB_ZCL_CLUSTER_ID_DOOR_LOCK,                                      \
          ZB_ZCL_CLUSTER_ID_SCENES,                                         \
          ZB_ZCL_CLUSTER_ID_GROUPS,                                         \
          ZB_ZCL_CLUSTER_ID_POWER_CONFIG                                    \
        }                                                                   \
      }

Another important change to be made is to update the ZB_HA_DOOR_LOCK_IN_CLUSTER_NUM parameter. Because we are adding a new cluster, we have to increase the number of clusters according to the new clusters added.

RE: How to use Power Config Cluster

Marte Myrvold — Fri, 05 Feb 2021 08:21:34 GMT

Hi,

No, you don't have to create a new endpoint for each cluster, you can add the clusters to your existing endpoint. Whether you want to have multiple endpoints or not depends on what you want, and how you want your application to work. In this case I believe having one endpoint would be best. And yes, you should add the power config cluster to the door lock cluster list if you want to add the power config cluster to the existing endpoint.

Best regards,

Marte

RE: How to use Power Config Cluster

mazis — Mon, 01 Feb 2021 15:50:45 GMT

Hello Marte! Thanks for your fast response!

My main question regards the declaration of a new endpoint. Should I create a new endpoint for each cluster or can I use the same endpoint for the doorlock cluster and the power config one? What is the better way to do it? I would have to modify some lines from de zb_zcl_door_lock.h to integrate the power config into the doorlock cluster, right?.

If I wanted to declare another endpoint for the power config cluster, do I need to modify the zb_zcl_power_config.h? Adding declarations for endpoint and context as it is done with the doorlock cluster.

RE: How to use Power Config Cluster

Marte Myrvold — Mon, 01 Feb 2021 14:24:36 GMT

Hi,

You can declare a set of endpoints on a node, so you should be able to declare an endpoint for the power configuration cluster.

I'm afraid we don't have any examples of how this particular cluster can be implemented, but if you haven't already you should check out the Zigbee stack API overview page. There you can find information about how to implement a Zigbee end product with ZCL, such as declaring attributes, clusters, cluster lists, and endpoints, as well as registering device context.

Best regards,

Marte

RE: How to use Power Config Cluster

mazis — Mon, 01 Feb 2021 11:50:52 GMT

Hello all!

I made some updates to the code, now it looks like this:

typedef  struct contexto_alimentacion_s
{
    zb_uint8_t battery_voltage; // Atributo 3.3.2.2.3.1
    zb_uint8_t battery_size; // Atributo 3.3.2.2.4.2
    zb_uint8_t battery_quantity; // Atributo 3.3.2.2.4.4
    zb_uint8_t battery_rated_voltage; // Atributo 3.3.2.2.4.5
    zb_uint8_t battery_alarm_mask; // Atributo 3.3.2.2.4.6
    zb_uint8_t battery_voltage_min_threshold; // Atributo 3.3.2.2.4.7
    zb_uint8_t battery_percentage_remaining; // Atributo 3.3.2.2.3.1
    zb_uint8_t battery_voltage_threshold_1; // Atributo 3.3.2.2.4.8
    zb_uint8_t battery_voltage_threshold_2; // Atributo 3.3.2.2.4.8
    zb_uint8_t battery_voltage_threshold_3; // Atributo 3.3.2.2.4.8
    zb_uint8_t battery_percentage_min_threshold; // Atributo 3.3.2.2.4.9
    zb_uint8_t battery_percentage_threshold_1; // Atributo 3.3.2.2.4.10
    zb_uint8_t battery_percentage_threshold_2; // Atributo 3.3.2.2.4.10
    zb_uint8_t battery_percentage_threshold_3; // Atributo 3.3.2.2.4.10
    zb_uint32_t battery_alarm_state; // Atributo 3.3.2.2.4.11
} contexto_alimentacion_t;

static contexto_alimentacion_t contexto_alimentacion;

ZB_ZCL_DECLARE_POWER_CONFIG_BATTERY_ATTRIB_LIST_EXT(lista_atributos_alimentacion,
                                                    &contexto_alimentacion.battery_voltage,
                                                    &contexto_alimentacion.battery_size,
                                                    &contexto_alimentacion.battery_quantity,
                                                    &contexto_alimentacion.battery_rated_voltage,
                                                    &contexto_alimentacion.battery_alarm_mask,
                                                    &contexto_alimentacion.battery_voltage_min_threshold,
                                                    &contexto_alimentacion.battery_percentage_remaining,
                                                    &contexto_alimentacion.battery_voltage_threshold_1,
                                                    &contexto_alimentacion.battery_voltage_threshold_2,
                                                    &contexto_alimentacion.battery_voltage_threshold_3,
                                                    &contexto_alimentacion.battery_percentage_min_threshold,
                                                    &contexto_alimentacion.battery_percentage_threshold_1,
                                                    &contexto_alimentacion.battery_percentage_threshold_2,
                                                    &contexto_alimentacion.battery_percentage_threshold_3,
                                                    &contexto_alimentacion.battery_alarm_state);

The next step might be to declare and endpoint for this cluster, or should I use the doorlock cluster and set the power config cluster as a part of the required clusters? There is an older post where it is discussed.