Error adding a Custom Device: Cluster with name xxxxx does not exist

[Danixu]

Hello,

I am trying to make my custom device using an ESP32C6 module which supports Zigbee. With the standard clusters everything works fine and even I was able to manage some switches there. The problem for me comes when I try to use custom clusters ID, which instead to use a "name" uses an ID.

The problem is that my device exports those clusters without problem:

but when I try to use those clusters on the Zigbee2MQTT application, the I receive this error:

zigbee2mqtt    | [2024-08-09 07:17:13] error:   z2m: Failed to configure 'xxxxxxxxxxx', attempt 3 (Error: Cluster with name '64777' does not exist
zigbee2mqtt    |     at getClusterDefinition (/app/node_modules/zigbee-herdsman/src/zspec/zcl/utils.ts:157:19)
zigbee2mqtt    |     at Object.getCluster (/app/node_modules/zigbee-herdsman/src/zspec/zcl/utils.ts:277:29)
zigbee2mqtt    |     at Function.create (/app/node_modules/zigbee-herdsman/src/zspec/zcl/zclFrame.ts:52:31)
zigbee2mqtt    |     at Endpoint.zclCommand (/app/node_modules/zigbee-herdsman/src/controller/model/endpoint.ts:847:33)
zigbee2mqtt    |     at Endpoint.configureReporting (/app/node_modules/zigbee-herdsman/src/controller/model/endpoint.ts:611:20)
zigbee2mqtt    |     at setupAttributes (/app/node_modules/zigbee-herdsman-converters/src/lib/modernExtend.ts:110:28)
zigbee2mqtt    |     at configure (/app/node_modules/zigbee-herdsman-converters/src/lib/modernExtend.ts:155:17)
zigbee2mqtt    |     at Object.configure (/app/node_modules/zigbee-herdsman-converters/src/index.ts:190:21)
zigbee2mqtt    |     at Configure.configure (/app/lib/extension/configure.ts:126:13)
zigbee2mqtt    |     at EventEmitter.wrappedCallback (/app/lib/eventBus.ts:174:17))

My definition file is the follow:

const {temperature, numeric} = require('zigbee-herdsman-converters/lib/modernExtend');

function ph() {
    return numeric({
        name: 'PH',
        cluster: Number(64777),
        attribute: {ID: 0, type: 0x21},
        reporting: {min: '10_SECONDS', max: '1_HOUR', change: 1},
        description: 'PH of the swiming pool',
        //unit: 'ph',
        scale: 100,
        access: 'STATE_GET',
        entityCategory: 'diagnostic'
    });
}


function chlorine() {
    return numeric({
        name: 'Chlorine',
        cluster: Number(64794),
        attribute: {ID: 0, type: 0x21},
        reporting: {min: '10_SECONDS', max: '1_HOUR', change: 1},
        description: 'Chlorine in the swiming pool',
        scale: 100,
        access: 'STATE_GET',
        entityCategory: 'diagnostic'
    });
}

const definition = {
    zigbeeModel: ['Pool Management'],
    model: 'Pool Management',
    vendor: 'Danixu',
    description: 'Pool Management device to measure the chlorine and ph values',
    extend: [
        temperature(),
        ph(),
        chlorine(),
    ],
};

module.exports = definition;

Ironically, the application is receiving the updates:

zigbee2mqtt    | [2024-08-09 07:28:30] info:    z2m:mqtt: MQTT publish: topic 'zigbee2mqtt/0x404ccafffe4ef3f0', payload '{"PH":12.46,"linkquality":255,"temperature":21.61}'

but the "refresh" button is not working and it always gives the same error, and I am not receiving all the clusters updates (for example the Chloring cluster data is lost).

The reason to use custom ID clusters is because the ESP32 zigbee implementation doesn't supports for now the standard PH and Chlorine clusters, so I had to use it. for sure I am doing something wrong with the device definition, but I was not able to find a nice guide. Even maybe I have done anything wrong with the ESP32, but it's strange that is receiving part of the data.

NOTE: I have tried to set the endpoint in the definition too. Same error.

Best regards and thanks!

[Danixu]

Finally I have tried the "old method" of "fromZigbee" and "exposes" instead to use the "extend", and it seems to work:

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

const { temperature, numeric } = require('zigbee-herdsman-converters/lib/modernExtend');

const fzLocal = {
    ph: {
        cluster: '64800', //This part is important
        type: ['readResponse', 'attributeReport'],
        convert: (model, msg, publish, options, meta) => {
            if (msg.data.hasOwnProperty('0')) {
                const ph = parseFloat(msg.data['0'] / 100.0);
                return { ph };
            }
        },
    },

    chlorine: {
        cluster: '64784', //This part is important
        type: ['readResponse', 'attributeReport'],
        convert: (model, msg, publish, options, meta) => {
            if (msg.data.hasOwnProperty('0')) {
                const chlorine = parseFloat(msg.data['0'] / 100.0);
                return { chlorine };
            }
        },
    },
};


const definition = {
    zigbeeModel: ['Pool Management'],
    model: 'Pool Management',
    vendor: 'Danixu',
    description: 'Pool Management device to measure the chlorine and ph values',
    fromZigbee: [fzLocal.ph, fzLocal.chlorine],
    exposes: [
        e.numeric('ph', ea.STATE).withLabel('PH')
            .withDescription('PH value in the swimming pool'),
        e.numeric('chlorine', ea.STATE)
            .withDescription("Chlorine level in the swimming pool")
    ],
    extend: [
        temperature(),
        //chlorine(),
        //ph()
    ],
    configure: async (device, coordinatorEndpoint) => {
        const endpoint_3 = device.getEndpoint(3);
        const binds_3 = ['genOnOff', 'genLevelCtrl', 64800];
        await reporting.bind(endpoint_3, coordinatorEndpoint, binds_3);
        const endpoint_4 = device.getEndpoint(4);
        const binds_4 = ['genOnOff', 'genLevelCtrl', 64784];
        await reporting.bind(endpoint_4, coordinatorEndpoint, binds_4);
    },
};

module.exports = definition;

There is no "refresh" button, so the problem has gone. The binded endpoints allows to get the updates in NRT, so it can be fine. The only that I still suspecting is that maybe the original problem is related with the ESP32 device, because when a predefinided cluster is used it manages all the required things to make it work, and maybe to register the cluster into another list of "Callable Clusters" is part of that things (I don't know how it really works behind the scenes). The custom clusters are just basic clusters and maybe doesn't have such things to manage the "refresh" button. Then the "cluster not found error" is just a symptom and should be solved in the ESP32 side.

Any information is welcome :)

Best regards

[sjorge]

You can just define them from your external converter and use then by name. E.g. #23563 (comment)

[Danixu]

Thanks!!, much better.

const { deviceAddCustomCluster, temperature, numeric } = require('zigbee-herdsman-converters/lib/modernExtend');
const Zcl = require('zigbee-herdsman').Zcl;

function ph() {
    return numeric({
        name: 'PH',
        cluster: "ph",
        attribute: { ID: "measuredValue", type: Zcl.DataType.UINT16 },
        valueMin: 700,
        valueMax: 740,
        reporting: { min: '10_SECONDS', max: '1_HOUR', change: 1 },
        description: 'PH of the swiming pool',
        //unit: 'ph',
        scale: 100,
        access: 'STATE_GET',
        entityCategory: 'diagnostic'
    });
}


function chlorine() {
    return numeric({
        name: 'Chlorine',
        cluster: "chlorine",
        attribute: { ID: "measuredValue", type: Zcl.DataType.UINT16 },
        valueMin: 0,
        valueMax: 1400,
        reporting: { min: '10_SECONDS', max: '1_HOUR', change: 1 },
        description: 'Chlorine in the swiming pool',
        scale: 100,
        access: 'STATE_GET',
        entityCategory: 'diagnostic'
    });
}


const definition = {
    zigbeeModel: ['Pool Management'],
    model: 'Pool Management',
    vendor: 'Danixu',
    description: 'Pool Management device to measure the chlorine and ph values',
    endpoint: (device) => {
        return {
            general: 1,
            pump: 2,
            ph: 3,
            chlorine: 4,
            algaecide: 5
        };
    },
    extend: [
        deviceAddCustomCluster('chlorine', {
            ID: 0xfd10,
            attributes: {
                measuredValue: { ID: 0x0000, type: Zcl.DataType.UINT16 },
                maxeasuredValue: { ID: 0x0001, type: Zcl.DataType.UINT16 },
                minMeasuredValue: { ID: 0x0002, type: Zcl.DataType.UINT16 }
            },
            commands: {},
            commandsResponse: {},
        }),
        deviceAddCustomCluster('ph', {
            ID: 0xfd20,
            attributes: {
                measuredValue: { ID: 0x0000, type: Zcl.DataType.UINT16 },
                maxeasuredValue: { ID: 0x0001, type: Zcl.DataType.UINT16 },
                minMeasuredValue: { ID: 0x0002, type: Zcl.DataType.UINT16 }
            },
            commands: {},
            commandsResponse: {},
        }),
        temperature(),
        chlorine(),
        ph()
    ],
};

module.exports = definition;

Greetings!!

[sjorge]

Since you are specifying the datatype in the customcluster... you can simply this even more.

    return numeric({
        name: 'Chlorine',
        cluster: "chlorine",
        attribute: "measuredValue",
        valueMin: 0,
        valueMax: 1400,
        reporting: { min: '10_SECONDS', max: '1_HOUR', change: 1 },
        description: 'Chlorine in the swiming pool',
        scale: 100,
        access: 'STATE_GET',
        entityCategory: 'diagnostic'
    });