device_class water home assistant

[Tomgroot]

I am desperately trying to set the device_class to water inside home assistant in order for to sensor to be displayed inside the energy dashboard. This is my goal for my sensor:

state_class: measurement
zcl_unit_of_measurement: 7
device_type: Water Metering
unit_of_measurement: l/h
friendly_name: ZigbeeHive WaterMeter
device_class: water

However my device_class stays on volume.

Setting the ESP_ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID to ESP_ZB_ZCL_METERING_WATER_METERING and the ESP_ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID to ESP_ZB_ZCL_METERING_UNIT_L_LH_BINARY does not seem to work.

This is my try:

static void esp_zb_task(void *pvParameters) {
    // Initialize Zigbee stack configuration
    esp_zb_cfg_t zb_nwk_cfg = {
        .esp_zb_role = ESP_ZB_DEVICE_TYPE_ED,
        .install_code_policy = false,
        .nwk_cfg.zed_cfg = {
            .ed_timeout = ESP_ZB_ED_AGING_TIMEOUT_64MIN,
            .keep_alive = 3000,
        },
    };
    esp_zb_init(&zb_nwk_cfg);
    
    // Create Attribute List for Metering Cluster
    esp_zb_attribute_list_t *metering_attr_list = esp_zb_zcl_attr_list_create(ESP_ZB_ZCL_CLUSTER_ID_METERING);

    uint8_t metering_device_type = ESP_ZB_ZCL_METERING_WATER_METERING;
    ESP_ERROR_CHECK(
        esp_zb_cluster_add_attr(
            metering_attr_list,
            ESP_ZB_ZCL_CLUSTER_ID_METERING,
            ESP_ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID,
            ESP_ZB_ZCL_ATTR_TYPE_8BIT_ENUM,
            ESP_ZB_ZCL_ATTR_ACCESS_READ_ONLY,
            &metering_device_type
        )
    );

    uint8_t unit_of_measure = ESP_ZB_ZCL_METERING_UNIT_L_LH_BINARY;
    ESP_ERROR_CHECK(
        esp_zb_cluster_add_attr(
            metering_attr_list,
            ESP_ZB_ZCL_CLUSTER_ID_METERING,
            ESP_ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID,
            ESP_ZB_ZCL_ATTR_TYPE_8BIT_ENUM,
            ESP_ZB_ZCL_ATTR_ACCESS_READ_ONLY,
            &unit_of_measure
        )
    );

    esp_zb_uint24_t multiplier = { .low = 1, .high = 0 };
    ESP_ERROR_CHECK(
        esp_zb_cluster_add_attr(
            metering_attr_list,
            ESP_ZB_ZCL_CLUSTER_ID_METERING,
            ESP_ZB_ZCL_ATTR_METERING_MULTIPLIER_ID,
            ESP_ZB_ZCL_ATTR_TYPE_U24,
            ESP_ZB_ZCL_ATTR_ACCESS_READ_ONLY,
            &multiplier
        )
    );

    esp_zb_uint24_t divisor = { .low = 1000, .high = 0 };
    ESP_ERROR_CHECK(
        esp_zb_cluster_add_attr(
            metering_attr_list,
            ESP_ZB_ZCL_CLUSTER_ID_METERING,
            ESP_ZB_ZCL_ATTR_METERING_DIVISOR_ID,
            ESP_ZB_ZCL_ATTR_TYPE_U24,
            ESP_ZB_ZCL_ATTR_ACCESS_READ_ONLY,
            &divisor
        )
    );


    esp_zb_uint48_t current_sum_default = { .low = 0, .high = 0 };
    ESP_ERROR_CHECK(
        esp_zb_cluster_add_attr(
            metering_attr_list,
            ESP_ZB_ZCL_CLUSTER_ID_METERING,
            ESP_ZB_ZCL_ATTR_METERING_CURRENT_SUMMATION_DELIVERED_ID,
            ESP_ZB_ZCL_ATTR_TYPE_U48,
            // ENABLE REPORTING so HA can subscribe to changes
            ESP_ZB_ZCL_ATTR_ACCESS_READ_ONLY | ESP_ZB_ZCL_ATTR_ACCESS_REPORTING, 
            &current_sum_default
        )
    );

    int32_t instantaneous_demand_default = 0;
    ESP_ERROR_CHECK(
        esp_zb_cluster_add_attr(
            metering_attr_list,
            ESP_ZB_ZCL_CLUSTER_ID_METERING,
            ESP_ZB_ZCL_ATTR_METERING_INSTANTANEOUS_DEMAND_ID,
            ESP_ZB_ZCL_ATTR_TYPE_S24,
            ESP_ZB_ZCL_ATTR_ACCESS_READ_ONLY | ESP_ZB_ZCL_ATTR_ACCESS_REPORTING,
            &instantaneous_demand_default
        )
    );
    
    // Create Cluster List and Add Metering Cluster
    esp_zb_cluster_list_t *cluster_list = esp_zb_zcl_cluster_list_create();
    esp_zb_cluster_list_add_metering_cluster(cluster_list, metering_attr_list, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);
    
    // Add Basic and Identify Clusters (Mandatory)
    esp_zb_basic_cluster_cfg_t basic_cfg = { .zcl_version = 0x03, .power_source = 0x03 }; // Battery
    esp_zb_attribute_list_t *basic_attr_list = esp_zb_basic_cluster_create(&basic_cfg);
    esp_zb_basic_cluster_add_attr(basic_attr_list, ESP_ZB_ZCL_ATTR_BASIC_MANUFACTURER_NAME_ID, (void *)"\x0A" ESP_MANUFACTURER_NAME);
    esp_zb_basic_cluster_add_attr(basic_attr_list, ESP_ZB_ZCL_ATTR_BASIC_MODEL_IDENTIFIER_ID, (void *)"\x0A" ESP_MODEL_IDENTIFIER);
    esp_zb_cluster_list_add_basic_cluster(cluster_list, basic_attr_list, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);

    esp_zb_identify_cluster_cfg_t identify_cfg = { .identify_time = 0 };
    esp_zb_attribute_list_t *identify_attr_list = esp_zb_identify_cluster_create(&identify_cfg);
    esp_zb_cluster_list_add_identify_cluster(cluster_list, identify_attr_list, ESP_ZB_ZCL_CLUSTER_SERVER_ROLE);

    // Create Endpoint
    esp_zb_ep_list_t *ep_list = esp_zb_ep_list_create();
    esp_zb_endpoint_config_t endpoint_config = {
        .endpoint = HA_ENDPOINT,
        .app_profile_id = ESP_ZB_AF_HA_PROFILE_ID,
        .app_device_id = ESP_ZB_HA_METER_INTERFACE_DEVICE_ID,
        .app_device_version = 0
    };
    
    esp_zb_ep_list_add_ep(ep_list, cluster_list, endpoint_config);

    // Register Device
    esp_zb_device_register(ep_list);

    // Start Zigbee Stack
    esp_zb_start(false); 
    
    esp_zb_stack_main_loop();
}

[xieqinan]

Setting the ESP_ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID to ESP_ZB_ZCL_METERING_WATER_METERING and the ESP_ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID to ESP_ZB_ZCL_METERING_UNIT_L_LH_BINARY does not seem to work.

Why not use the esp_zb_zcl_get_attribute() of esp-zigbee-sdk and HA read_attr function to get the atttribute value, then compare they whether are consistent and as expected?

[Tomgroot]

It seems to return just the expected numbers.

I (12774) ZIGBEE_METER: Unit of Measure: 7
I (12774) ZIGBEE_METER: Device Type: 2

With:

    esp_zb_zcl_attr_t *unit_of_measure_attr = esp_zb_zcl_get_attribute(
        HA_ENDPOINT,
        ESP_ZB_ZCL_CLUSTER_ID_METERING,
        ESP_ZB_ZCL_CLUSTER_SERVER_ROLE,
        ESP_ZB_ZCL_ATTR_METERING_UNIT_OF_MEASURE_ID
    );

    ESP_LOGI(TAG, "Unit of Measure: %d", *(uint8_t *)unit_of_measure_attr->data_p);

    esp_zb_zcl_attr_t *device_type_attr = esp_zb_zcl_get_attribute(
        HA_ENDPOINT,
        ESP_ZB_ZCL_CLUSTER_ID_METERING,
        ESP_ZB_ZCL_CLUSTER_SERVER_ROLE,
        ESP_ZB_ZCL_ATTR_METERING_METERING_DEVICE_TYPE_ID
    );

    ESP_LOGI(TAG, "Device Type: %d", *(uint8_t *)device_type_attr->data_p);
    ```

[xieqinan]

So, the meter cluster configuration may be correct. Please also share what is presented in the HA.