[New device support]: Tuya 214C Ultrasonic water meter with valve

[michaeleverist]

Link

https://www.alibaba.com/product-detail/Smart-Ultrasonic-Water-Flow-Meter-With_1600722839075.html

Database entry

{"id":15,"type":"EndDevice","ieeeAddr":"0xa4c1384c55aa7d9b","nwkAddr":23333,"manufId":4417,"manufName":"_TZE200_vuwtqx0t","powerSource":"Battery","modelId":"TS0601","epList":[1],"endpoints":{"1":{"profId":260,"epId":1,"devId":81,"inClusterList":[4,5,61184,0],"outClusterList":[25,10],"clusters":{"genBasic":{"attributes":{"65506":56,"65508":1,"65534":0,"appVersion":72,"modelId":"TS0601","manufacturerName":"_TZE200_vuwtqx0t","powerSource":3,"zclVersion":3,"stackVersion":0,"hwVersion":1,"dateCode":""}}},"binds":[],"configuredReportings":[],"meta":{}}},"appVersion":72,"stackVersion":0,"hwVersion":1,"dateCode":"","zclVersion":3,"interviewCompleted":true,"meta":{"configured":-708457359},"lastSeen":1707216891922}

Comments

I've tried following the guide and i think I am close. I got the Tuya DP's from the dev portal as well as i think the datatypes. I'm getting let down in my lack of knowledge of JS/TS and Zigbee2MQTT in general.

Current WIP external converter: https://gist.github.com/michaeleverist/f8399bb79ac08a7667883bc2bef1b11f

Output from the script in tuya_dev: {"1":"Water consumption","2":"Month consumption","3":"Daily consumption","4":"Report period set","5":"Warning","6":"Month and daily frozen time set","13":"Switch","14":"Enable auto clean","16":"Meter ID","18":"Reverse Water Consumption","21":"Instantaneous Flow Rate","22":"Working temperature","26":"Power supply voltage"}

Tuya Dev device debugging info:

Not sure if I've missed anything else? Happy to keep working on it myself but am getting caught on the relationship between exposes :[] and mete tuyaDatapoints and how exposes knows which datapoint to use.

External defintion

const definition = {
    zigbeeModel: ['TS0601'],
    model: 'TS0601',
    vendor: '_TZE200_vuwtqx0t',
    description: 'Automatically generated definition',
    extend: [],
    meta: {},
};

module.exports = definition;

[michaeleverist]

I have made a little progress with this but still my lack of understanding has hampered. The basic functions (total water consumed, valve open/close) work but the other values aren't being translated correctly.

I'd appreciate anyone who can offer help!

const {} = require('zigbee-herdsman-converters/lib/modernExtend');
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 tuya = require('zigbee-herdsman-converters/lib/tuya');

const definition = {
    fingerprint: [
        {
            modelID: 'TS0601',         
            manufacturerName: '_TZE200_vuwtqx0t',
        },
    ],
    model: 'TS0601',
    vendor: 'TuYa',
    description: 'Tuya water meter with valve',
    fromZigbee: [tuya.fz.datapoints],
    toZigbee: [tuya.tz.datapoints],
    onEvent: tuya.onEventSetTime, 
    configure: tuya.configureMagicPacket,
    exposes: [       
        e.numeric('water_consumed', ea.STATE).withUnit('L').withDescription('Total water consumed'),
        
        // Need to fix this month and daily consumption - currently shows as JSON
        e.numeric('month_consumption', ea.STATE).withDescription('month consumption'),
        e.numeric('daily_consumption', ea.STATE).withDescription('daily consumption'),        
        
        // Not sure what this does or how to change it
        e.numeric('month_and_daily_frozen_set', ea.STATE).withDescription('Month Daily Frozen Set'),
        
        //  I can't seem to get this to work - when i try to change the value i get an error in zigbee2mqtt, stuck on 1 Hour
        e.enum('report_period', ea.STATE_SET, ['1', '2', '3', '4', '6', '8', '12', '24']).withDescription('Temperature Report interval'),       
        e.text('warning', ea.STATE),  // FIX THIS - BITMAP -> fault types        
              
        // These are attempts at getting the valve open/closed switch and the autoclean switch working together.        
        // Valve Open/Close -  (Name isnt correct in Zigbee2MQTT)
        // e.switch().setAccess('state', ea.STATE_SET).withDescription('Valve Open / Close'),
        // tuya.exposes.switch().withDescription('Valve Open / Close'),
        e.binary('state', ea.STATE_SET, 'ON', 'OFF').withDescription('Valve position'),
        
        // Autoclean switch - deactivated because I dont know how to get it working independently to the valve open/close switch
        // e.binary('state', ea.STATE_SET, 'ON', 'OFF').withDescription('Auto Clean'),
        // e.switch().setAccess('state', ea.STATE_SET).withDescription('Auto Clean'),
        // tuya.exposes.switch().withDescription('Auto Clean'),                

        // Note sure what this does - it wasnt in the tuya DP's extracted from the IOT portal?
        e.text('something', ea.STATE).withDescription('Something'),
        e.text('meter_id', ea.STATE).withDescription('Meter ID (ID of device)'),        
        // Reverse consumption and instantaneous flow are appearing as JSON, in tuya they are a Base 64 but I dont know how to get it to show correctly
        e.numeric('reverse_water_consumption', ea.STATE).withUnit('L').withDescription('reverse water flow'),
        e.numeric('instantaneous_flow_rate', ea.STATE).withUnit('L/hr').withDescription('Inst flow rate'),        
        
        e.temperature().withDescription('Water Temperature'),
        //Voltage works but doesnt show as the battery voltage in Z2M - no doubt something i havent understood
        e.battery_voltage('battery_voltage', ea.STATE).withDescription('battery voltage'),
        ],

    meta: {        
        tuyaDatapoints: [
            [1,'water_consumed', tuya.valueConverter.raw],  // dtype number
            [2,'month_consumption', tuya.valueConverter.raw],   // dtype 0 - raw
            [3,'daily_consumption', tuya.valueConverter.raw],   // dtype 0 - raw            
            // [4,'report_period', tuya.valueConverterBasic.lookup({'1': tuya.enum(0), '2': tuya.enum(1), '3h': tuya.enum(2),
            //                                                         '4h': tuya.enum(3), '6h': tuya.enum(4), '8h': tuya.enum(5),
            //                                                         '12h': tuya.enum(6), '24h': tuya.enum(7)
            //                                                     })],   // dtype 4 - enum            
                                                
            [4,'report_period', tuya.valueConverterBasic.lookup({'1': tuya.enum(0), '2': tuya.enum(1), '3': tuya.enum(2),
                                                                '4': tuya.enum(3), '6': tuya.enum(4), '8': tuya.enum(5),
                                                                '12': tuya.enum(6), '24': tuya.enum(7)
                                                            })],   // dtype 4 - enum                                                                            
            [5,'warning', tuya.dataTypes.enum], // bitmap,
            [6,'month_and_daily_frozen_set', tuya.valueConverter.raw],  // dtype 0 - raw
            [13,'state', tuya.valueConverter.onOff],   // Bool   VALVE OPEN CLOSE
            // [14,'auto_clean', tuya.valueConverter.onOff],   // Bool   AUTOCLEAN SW -  DISABLED  UNTILL I CAN FIGURE IT OUT
            [15,'something', tuya.valueConverter.raw],   // dtype 0 - raw  - No idea what this does?
            [16,'meter_id', tuya.valueConverter.raw],  //dtype 3 - raw   METER ID
            [18,'reverse_water_consumption', tuya.valueConverterBasic.numeric],   // dtype 0 - raw
            [21,'instantaneous_flow_rate', tuya.valueConverter.numeric], // dtype 0 - raw
            [22,'temperature', tuya.valueConverter.divideBy100],
            [26,'battery_voltage', tuya.valueConverter.raw],
        ],
    },
};
module.exports = definition;

[Koenkk]

What values are not translated correctly?

[michaeleverist]

Hi Koenkk, When i say not translated correctly I mean I am not using the correct exposes and/or meta (due to lack of understanding :) )

Below is screenshot of zigbee2mqtt.

• I still have the autoclean switch disabled as if i enable it (enen with the different DP's in the meta) pressing one switch operates both.
• The instantaneous and reverse should be saying 0 and 1 i think.
• the report period set gives an error whenever i choose something from the dropdown.
• I'm not too sure how to best approach the daily and monthly consumption values.

[Koenkk]

I still have the autoclean switch disabled as if i enable it (enen with the different DP's in the meta) pressing one switch operates both.

It also operates the main switch (valve)?

The instantaneous and reverse should be saying 0 and 1 i think.

I think you need to use tuya.valueConverter.raw for these

the report period set gives an error whenever i choose something from the dropdown.

What's the error?

I'm not too sure how to best approach the daily and monthly consumption values.

I'm suprised a string is reported here, would expect it to be a number

[michaeleverist]

Thanks for looking at this.

I still have the autoclean switch disabled as if i enable it (enen with the different DP's in the meta) pressing one switch operates both.

It also operates the main switch (valve)?

Yes - I added

e.binary('state', ea.STATE_SET, 'ON', 'OFF').withDescription('Auto Clean'),

and [14,'auto_clean', tuya.valueConverter.onOff],

And i get another switch that changes state with the first one:

The instantaneous and reverse should be saying 0 and 1 i think. I think you need to use tuya.valueConverter.raw for these.

I originally had them as raw but there was no difference. I've changed back to raw now.

the report period set gives an error whenever i choose something from the dropdown.

What's the error?

see below:

To be honest, the one of value is the total consumed, as the daily/monthly can be derived in Home Assistant. The instantaneous flow seems pointless since there is a 1hr min reporting period.

The 2 things that would be good to obtain are the battery voltage and the error codes.

• Battery voltage shows in the state tab but as N/A in 'exposes'
• Error shows 6144 and is type bitmap with what i think are the translations in my original post

Current State and Exposes:

[Koenkk]

• Use e.binary('auto_clean', ea.STATE_SET, 'ON', 'OFF').withDescription('Auto Clean'),
• For the report period, change toZigbee: [tuya.tz.datapoints], to toZigbee: [tzdatapoints], and above const definition = { add:

const tzdatapoints = {
    key: [...tuya.tz.datapoints, 'report_period'],
    ...tuya.tz.datapoints,
}

[michaeleverist]

for the report_period:
When I add the above the device isnt recognised. If i comment out the tzdatapoints added it is recognised again. I added a semicolon at the end too but no change.

The auto_clean switch now appears to switch independently of the other switch but gives a no converter available for auto_clean "ON" when pressing it

[Koenkk]

You also need to add that, e.g. key: [...tuya.tz.datapoints, 'report_period', 'auto_clean'],

[michaeleverist]

Thanks, - I really appreciate you taking the time to help with this!

Whenever I have the const tzdatapoints = { .... The device isnt recognised.

full config now:

const {} = require('zigbee-herdsman-converters/lib/modernExtend');
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 tuya = require('zigbee-herdsman-converters/lib/tuya');

const tzdatapoints = {
    key: [...tuya.tz.datapoints, 'report_period', 'auto_clean'],
    ...tuya.tz.datapoints,
};

const definition = {
    fingerprint: [
        {
            modelID: 'TS0601',         
            manufacturerName: '_TZE200_vuwtqx0t',
        },
    ],
    model: 'TS0601',
    vendor: 'TuYa',
    description: 'Tuya water meter with valve',
    fromZigbee: [tuya.fz.datapoints],
    // toZigbee: [tuya.tz.datapoints],
    toZigbee: [tzdatapoints],    
    onEvent: tuya.onEventSetTime, 
    configure: tuya.configureMagicPacket,
    exposes: [       
        e.numeric('water_consumed', ea.STATE).withUnit('L').withDescription('Total water consumed'),
        
        // Need to fix this month and daily consumption - currently shows as JSON
        e.numeric('month_consumption', ea.STATE).withDescription('month consumption'),
        e.numeric('daily_consumption', ea.STATE).withDescription('daily consumption'),        
        
        // Not sure what this does or how to change it
        e.numeric('month_and_daily_frozen_set', ea.STATE).withDescription('Month Daily Frozen Set'),
        
        //  I can't seem to get this to work - when i try to change the value i get an error in zigbee2mqtt, stuck on 1 Hour
        e.enum('report_period', ea.STATE_SET, ['1h', '2h', '3h', '4h', '6h', '8h', '12h', '24h']).withDescription('Temperature Report interval'),       
        e.text('warning', ea.STATE),  // FIX THIS - BITMAP -> fault types        
              
        // These are attempts at getting the valve open/closed switch and the autoclean switch working together.        
        // Valve Open/Close -  (Name isnt correct in Zigbee2MQTT)
        // e.switch().setAccess('state', ea.STATE_SET).withDescription('Valve Open / Close'),
        // tuya.exposes.switch().withDescription('Valve Open / Close'),
        e.binary('state', ea.STATE_SET, 'ON', 'OFF').withDescription('Valve position'),
        
        // Autoclean switch - deactivated because I dont know how to get it working independently to the valve open/close switch
        e.binary('auto_clean', ea.STATE_SET, 'ON', 'OFF').withDescription('Auto Clean'),
        
        // e.switch().setAccess('state', ea.STATE_SET).withDescription('Auto Clean'),
        // tuya.exposes.switch().withDescription('Auto Clean'),                

        // Note sure what this does - it wasnt in the tuya DP's extracted from the IOT portal?
        e.text('something', ea.STATE).withDescription('Something'),
        e.text('meter_id', ea.STATE).withDescription('Meter ID (ID of device)'),        
        // Reverse consumption and instantaneous flow are appearing as JSON, in tuya they are a Base 64 but I dont know how to get it to show correctly
        e.numeric('reverse_water_consumption', ea.STATE).withDescription('reverse water flow'),
        e.numeric('instantaneous_flow_rate', ea.STATE).withDescription('Inst flow rate'),        
        
        e.temperature().withDescription('Water Temperature'),
        //Voltage works but doesnt show as the battery voltage in Z2M - no doubt something i havent understood
        e.battery_voltage('battery_voltage', ea.STATE).withDescription('battery voltage'),
        ],

    meta: {        
        tuyaDatapoints: [
            [1,'water_consumed', tuya.valueConverter.raw],  // dtype number
            [2,'month_consumption', tuya.valueConverter.raw],   // dtype 0 - raw
            [3,'daily_consumption', tuya.valueConverter.raw],   // dtype 0 - raw                                                                    
            [4,'report_period', tuya.valueConverterBasic.lookup({'1h': tuya.enum(0), '2h': tuya.enum(1), '3h': tuya.enum(2),
                                                                '4h': tuya.enum(3), '6h': tuya.enum(4), '8h': tuya.enum(5),
                                                                '12h': tuya.enum(6), '24h': tuya.enum(7)
                                                            })],   // dtype 4 - enum                                                                            
            [5,'warning', tuya.dataTypes.enum], // bitmap,
            [6,'month_and_daily_frozen_set', tuya.valueConverter.raw],  // dtype 0 - raw
            [13,'state', tuya.valueConverter.onOff],   // Bool   VALVE OPEN CLOSE
            [14,'auto_clean', tuya.valueConverter.onOff],   // Bool   AUTOCLEAN SW -  DISABLED  UNTILL I CAN FIGURE IT OUT
            [15,'something', tuya.valueConverter.raw],   // dtype 0 - raw  - No idea what this does?
            [16,'meter_id', tuya.valueConverter.raw],  //dtype 3 - raw   METER ID
            [18,'reverse_water_consumption', tuya.valueConverter.raw],   // dtype 0 - raw
            [21,'instantaneous_flow_rate', tuya.valueConverter.raw], // dtype 0 - raw
            [22,'temperature', tuya.valueConverter.divideBy100],
            [26,'battery_voltage', tuya.valueConverter.raw],
        ],
    },
};
module.exports = definition;

[Koenkk]

Made a mistake, use:

const tzdatapoints = {
    key: [...tuya.tz.datapoints.key, 'report_period', 'auto_clean'],
    ...tuya.tz.datapoints,
};

[Perfect-Web]

hi guys, any news about this ?

[michaeleverist]

I didnt have any further success - i can open and close the valve as well as view total consumption updated every hour - I'm not using the other consumption values. I will go back to it at some stage but have settled for the basics.

I still cant see battery voltage although i can see the value, and cant set the reporting period or the autoclean switch.

[bkujszczyk]

Good morning

I have the same counter using this external converter. I have a situation where the valve closes automatically from time to time and remains closed until it is manually opened.

Do you also have this situation? how to solve this problem?

[cosmico89]

HI, after purchasing the valve I uploaded your file to check what really worked and what didn't, let's say that I only needed two main functions VALVE STATUS (open/closed) and FLOW RATE. unfortunately I know that only the VALVE STATUS works Is there any way to help "find" the missing parameters?

Thank you!

[bkujszczyk]

Very strange

My file (attached) shows the flow and valve status (open/closed)

Unfortunately, it closes the valve every now and then for an indefinite and irregular period of time. most often when I'm not at home. The manufacturer doesn't know anything.

Connected to tuya it does not cause such surprises.

I don't know what is the cause _TZE200_vuwtqx0t.txt

[cosmico89]

Now I'll try your file, but if you turn on the water after how long do you see the instantflow move? always if it works for you

update: I compared my file with yours and it is exactly identical, so the question is does the instantaneous_flow_rate item work for you?

[bkujszczyk]

That's how it works the counter measures the amount of liquid. but unfortunately it comes out at unexpected moments. I don't know why and there's nothing in the logs that could help me

[osonatech2021]

No puedo visualizar ningun valor, me sale que no esta soportado. Como hizieron para poder visualizar el dispositivo des de zigbee2mqtt?

Gracias gente

[bkujszczyk]

I received an instruction video from the manufacturer

It's in the link

https://drive.google.com/file/d/1QDs58Q_XxV7qWa0PvZjHPiM6tdpggiuy/view?usp=sharing

[osonatech2021]

El dispositivo, ya esta vinculado a z2m, pero no me lee ninguna entrada

[osonatech2021]

Donde consigo los ficheros que faltan?

[bkujszczyk]

https://community.home-assistant.io/t/solved-z2mqtt-problem-error-cannot-find-module-zigbee-herdsman-converters-lib-extend/347835

[osonatech2021]

Gracias por los aportes familia, al final lo consegui, pero... solo recibo los datos cada 12h, al modificar a 1h o la que sea, sale: no converter avalible, o no sale nada, pero no modifica el valor

[osonatech2021]

por cierto, en el apartado de icono se puede poner: https://th.bing.com/th/id/OIP.XLrfQ0N_eVoD-tkLs2wpDAHaGd?w=223&h=195&c=7&r=0&o=5&pid=1.7 asi sale el dibujo del contador

[gabrielpowerc]

Hello, I have this water meter installed in z2mqtt and worked fine until approximative one or two month ago. Since then, the device is unsupported. I'm using the external converter posted by bkujszczyk

In z2m I found the following errors: [2024-10-08 12:21:23] error: z2m: Failed to load external converter file 'TS0601.js' (tuya.tz.datapoints.key is not iterable) [2024-10-08 12:21:23] error: z2m: Probably there is a syntax error in the file or the external converter is not compatible with the current Zigbee2MQTT version [2024-10-08 12:21:23] error: z2m: Note that external converters are not meant for long term usage, it's meant for local testing after which a pull request should be created to add out-of-the-box support for the device

Do you have any solution?

[paissad]

Hi @gabrielpowerc & @osonatech2021

I just purchased and added this water metering product in z2m and used the file content available through https://github.com/Koenkk/zigbee2mqtt/issues/21255#issuecomment-2129529803 After that, I restarted zigbee2mqtt, but I still don't see anything into the Expose tab of the device into the UI of z2m

Here is what I did to be precise:

1. Added the tool (pairing mode) through z2m
2. Created water_meter.js file next to the zigbee2mqtt/configuration.yaml file with the file content I said above
3. Updated zigbee2mqtt/configuration.yaml file with the following content:

external_converters:
  - water_meter.js

4. Restarted zigbee2mqtt

Did I miss something? Or am I doing something wrong?

Thanks in advance for your help 🙏

[gabrielpowerc]

Hello @paissad & @Koenkk The water meter worked for about 2 month and I suppose that after an update, stopped working - it is present in z2m but unsupported.

The error is in the external converter:

[2024-10-28 19:22:14] error: z2m: Failed to load external converter file 'TS0601.js' (tuya.tz.datapoints.key is not iterable) [2024-10-28 19:22:14] error: z2m: Probably there is a syntax error in the file or the external converter is not compatible with the current Zigbee2MQTT version [2024-10-28 19:22:14] error: z2m: Note that external converters are not meant for long term usage, it's meant for local testing after which a pull request should be created to add out-of-the-box support for the device

Thank you!

Hi @gabrielpowerc & @osonatech2021

I just purchased and added this water metering product in z2m and used the file content available through #21255 (comment) After that, I restarted zigbee2mqtt, but I still don't see anything into the Expose tab of the device into the UI of z2m

Here is what I did to be precise:

1. Added the tool (pairing mode) through z2m
2. Created water_meter.js file next to the zigbee2mqtt/configuration.yaml file with the file content I said above
3. Updated zigbee2mqtt/configuration.yaml file with the following content:

external_converters:
  - water_meter.js

4. Restarted zigbee2mqtt

Did I miss something? Or am I doing something wrong?

Thanks in advance for your help 🙏

[danielewyss]

Hi, thanks to all for the effort. Is there something that I could take to make it working? Or at least partially working ?

[paissad]

Hi everyone,

I'm also eager to participate and help make it work and 100 have it 100% supported

[MiAutomations]

Hello @paissad & @Koenkk The water meter worked for about 2 month and I suppose that after an update, stopped working - it is present in z2m but unsupported.

The error is in the external converter:

[2024-10-28 19:22:14] error: z2m: Failed to load external converter file 'TS0601.js' (tuya.tz.datapoints.key is not iterable) [2024-10-28 19:22:14] error: z2m: Probably there is a syntax error in the file or the external converter is not compatible with the current Zigbee2MQTT version [2024-10-28 19:22:14] error: z2m: Note that external converters are not meant for long term usage, it's meant for local testing after which a pull request should be created to add out-of-the-box support for the device

Thank you!

Hi @gabrielpowerc & @osonatech2021 I just purchased and added this water metering product in z2m and used the file content available through #21255 (comment) After that, I restarted zigbee2mqtt, but I still don't see anything into the Expose tab of the device into the UI of z2m Here is what I did to be precise:

1. Added the tool (pairing mode) through z2m
2. Created water_meter.js file next to the zigbee2mqtt/configuration.yaml file with the file content I said above
3. Updated zigbee2mqtt/configuration.yaml file with the following content:

external_converters:
  - water_meter.js

4. Restarted zigbee2mqtt

Did I miss something? Or am I doing something wrong? Thanks in advance for your help 🙏

Hello To all

I created also the file as external_converters I restarted the Z2M I try to pairing the device using the last versions of Z2M 1.41.0, but I still facing the same issue described by the @gabrielpowerc the device still as unsupported and there aren't any control available od data about this device on the Z2M GUI

Is there any think to do in order to fix this? Thank in advance for your support Best regards