Unsupported device: Fan Coil Thermostat

[rvalle]

I got this Tuya Smart Zigbee Thermostat for Fan Coil 2 or 4 Pipes Fan Control 0–10V + ON/OFF Valves

Its generated external definition is:

export default {
zigbeeModel: ['TS0601'],
model: 'TS0601',
vendor: '_TZE284_4vbj3fxh',
description: 'Automatically generated definition',
extend: [],
};

Its a Tuya device, so according to documentation should be easier...

I have never done this before, but will try to add support myself. Of course, tips are welcome.

[andrei-lazarov]

Find the most similar device that is already supported and use that as a starting point.

You can trick Z2M into thinking you have a different device:

1. Stop Z2M
2. Open database.db in your Z2M installation folder
3. Replace all occurrences of _TZE284_4vbj3fxh (your device) with _TZ... (supported device)
4. Start Z2M
5. Test the exposed features

[rvalle]

I got it to work pretty decently.

I followed the docs until I managed to add an external converter that did nothing but assign a name to my device. Then because it is tuya, I guess it was easier, just to assign data points... fiddle with the device and reverse engineer what they do.

import * as exposes from "zigbee-herdsman-converters/lib/exposes";
import * as tuya from "zigbee-herdsman-converters/lib/tuya";

const e = exposes.presets;
const ea = exposes.access;

export default {
    fingerprint: [
        {
            modelID: "TS0601",
            manufacturerName: "_TZE284_4vbj3fxh",
        },
    ],
    model: "TS0601_Tuya-L2-T-F-MF",
    vendor: "Tuya",
    description: "Tuya smart Zigbee fan coil thermostat",
    extend: [
        tuya.modernExtend.tuyaBase({
            dp: true,
            timeStart: "1970",
        }),
    ],
    exposes: [
        // Basic Operation

        e.switch().withDescription("Thermostat power"),

        e.temperature().withUnit("°C").withDescription("Measured room temperature"),

        e
            .numeric("current_heating_setpoint", ea.STATE_SET)
            .withUnit("°C")
            .withValueMin(5)
            .withValueMax(45)
            .withValueStep(0.5)
            .withDescription("Target temperature"),

        e.enum("system_mode", ea.STATE_SET, ["cool", "heat", "fan_only"]).withDescription("Operating mode"),

        e.enum("fan_mode", ea.STATE_SET, ["auto", "low", "medium", "high"]).withDescription("Fan speed"),

        // Configuration Parameters

        // MISSING: Night mode only on device ?

        e.numeric("screen_brightness", ea.STATE_SET).withValueMin(1).withValueMax(9).withValueStep(1).withDescription("Display brightness level"),

        e
            .numeric("temperature_compensation", ea.STATE_SET)
            .withUnit("°C")
            .withValueMin(-9)
            .withValueMax(9)
            .withValueStep(1)
            .withDescription("Temperature compensation setting"),

        e
            .numeric("deadband_temperature", ea.STATE_SET)
            .withUnit("°C")
            .withValueMin(0.5)
            .withValueMax(5)
            .withValueStep(0.5)
            .withDescription("Temperature deadband"),

        e
            .numeric("min_temperature_limit", ea.STATE_SET)
            .withUnit("°C")
            .withValueMin(5)
            .withValueMax(15)
            .withValueStep(1)
            .withDescription("Minimum temperature limit"),

        e
            .numeric("max_temperature_limit", ea.STATE_SET)
            .withUnit("°C")
            .withValueMin(16)
            .withValueMax(45)
            .withValueStep(1)
            .withDescription("Maximun temperature limit"),

        e.enum("child_lock", ea.STATE_SET, ["locked", "unlocked"]).withDescription("Child lock"),

        // Max Temp

        e
            .numeric("eco_temperature_heating", ea.STATE_SET)
            .withUnit("°C")
            .withValueMin(20)
            .withValueMax(30)
            .withValueStep(1)
            .withDescription("Eco heating temperature"),

        e
            .numeric("eco_temperature_cooling", ea.STATE_SET)
            .withUnit("°C")
            .withValueMin(20)
            .withValueMax(30)
            .withValueStep(1)
            .withDescription("Eco cooling temperature"),
    ],
    meta: {
        tuyaDatapoints: [
            [1, "state", tuya.valueConverter.onOff],
            [
                2,
                "system_mode",
                tuya.valueConverterBasic.lookup({
                    cool: tuya.enum(0),
                    heat: tuya.enum(1),
                    fan_only: tuya.enum(2),
                }),
            ],
            [16, "temperature", tuya.valueConverter.divideBy10],
            [18, "min_temperature_limit", tuya.valueConverter.divideBy10],
            [34, "max_temperature_limit", tuya.valueConverter.divideBy10],
            [
                39,
                "child_lock",
                tuya.valueConverterBasic.lookup({
                    unlocked: false,
                    locked: true,
                }),
            ],
            [
                49,
                "fan_mode",
                tuya.valueConverterBasic.lookup({
                    auto: tuya.enum(0),
                    high: tuya.enum(1),
                    medium: tuya.enum(2),
                    low: tuya.enum(3),
                }),
            ],
            [50, "current_heating_setpoint", tuya.valueConverter.divideBy10],
            [101, "screen_brightness", tuya.valueConverter.raw],
            [102, "temperature_compensation", tuya.valueConverter.raw],
            [104, "deadband_temperature", tuya.valueConverter.divideBy10],
            [107, "eco_temperature_heating", tuya.valueConverter.raw],
            [109, "eco_temperature_cooling", tuya.valueConverter.raw],
        ],
    },
};

Unfortunately some settings are from the device only, and changing them on device did not generate zigbee events: like language setting, or hour format, and some other settings.

[rvalle]

the thermostat is tedious to use in HA. I think it must return a climate (thermostat) entity, or?

[rvalle]

This is a second interaction of the converter, in which presents a thermostat interface (climate).

The device state (ON/OFF) is also mapped into a system mode, which seems to be the preferred UI approach

import * as exposes from "zigbee-herdsman-converters/lib/exposes";
import * as tuya from "zigbee-herdsman-converters/lib/tuya";

const e = exposes.presets;
const ea = exposes.access;

export default {
    fingerprint: [
        {
            modelID: "TS0601",
            manufacturerName: "_TZE284_4vbj3fxh",
        },
    ],
    model: "TS0601_Tuya-L2-T-F-MF",
    vendor: "Tuya",
    description: "Tuya smart Zigbee fan coil thermostat",
    extend: [
        tuya.modernExtend.tuyaBase({
            dp: true,
            timeStart: "1970",
        }),
    ],

    exposes: (device, options) => {
        return [
            // Basic Operation

            //e.switch().withDescription("Thermostat power"), # Mapped into a System mode

            e
                .climate()
                .withLocalTemperature(ea.STATE)
                .withSystemMode(["off", "cool", "heat", "fan_only"], ea.STATE_SET)
                .withFanMode(["low", "medium", "high", "auto"], ea.STATE_SET)
                .withSetpoint("current_heating_setpoint", 5, 45, 0.5, ea.STATE_SET),

            // Configuration Parameters

            e
                .numeric("local_temperature_calibration", ea.STATE_SET)
                .withUnit("°C")
                .withValueMin(-9)
                .withValueMax(9)
                .withValueStep(1)
                .withDescription("Temperature compensation setting"),

            e.numeric("screen_brightness", ea.STATE_SET).withValueMin(1).withValueMax(9).withValueStep(1).withDescription("Display brightness level"),

            e
                .numeric("deadzone_temperature", ea.STATE_SET)
                .withUnit("°C")
                .withValueMin(0.5)
                .withValueMax(5)
                .withValueStep(0.5)
                .withDescription("Temperature deadzone"),

            e
                .numeric("min_temperature_limit", ea.STATE_SET)
                .withUnit("°C")
                .withValueMin(5)
                .withValueMax(15)
                .withValueStep(1)
                .withDescription("Minimum temperature limit"),

            e
                .numeric("max_temperature_limit", ea.STATE_SET)
                .withUnit("°C")
                .withValueMin(16)
                .withValueMax(45)
                .withValueStep(1)
                .withDescription("Maximun temperature limit"),

            e.enum("child_lock", ea.STATE_SET, ["locked", "unlocked"]).withDescription("Child lock"),

            e
                .numeric("eco_temperature_heating", ea.STATE_SET)
                .withUnit("°C")
                .withValueMin(20)
                .withValueMax(30)
                .withValueStep(1)
                .withDescription("Eco heating temperature"),

            e
                .numeric("eco_temperature_cooling", ea.STATE_SET)
                .withUnit("°C")
                .withValueMin(20)
                .withValueMax(30)
                .withValueStep(1)
                .withDescription("Eco cooling temperature"),
        ];
    },
    meta: {
        tuyaDatapoints: [
            // Will handle state (on/off) as a system mode
            [
                1,
                "state",
                {
                    to: async (v, meta) => {},
                    from: (v, meta) => {
                        // when the thermstat is returned to ON, we setup to fan_only, but would be better
                        // to remain in the mode it was (and it is, even while off)
                        meta.state.system_mode = v === true ? (meta.state.system_mode_device ?? "fan_only") : "off";
                        delete meta.state.state;
                    },
                },
            ],
            [
                2,
                "system_mode",
                {
                    to: async (v, meta) => {
                        const ep = meta.device.endpoints[0];

                        if (v === "off") {
                            // mode off we redirect to datapoint 1, and that is
                            await tuya.sendDataPointBool(ep, 1, false, "dataRequest", 1);
                            return;
                        }

                        // any other mode, we force ON state
                        await tuya.sendDataPointBool(ep, 1, true, "dataRequest", 1);

                        if (v === "cool") await tuya.sendDataPointEnum(ep, 2, 0, "dataRequest", 1);
                        if (v === "heat") await tuya.sendDataPointEnum(ep, 2, 1, "dataRequest", 1);
                        if (v === "fan_only") await tuya.sendDataPointEnum(ep, 2, 2, "dataRequest", 1);
                    },
                    from: (v, meta) => {
                        const modes = ["cool", "heat", "fan_only"];
                        meta.state.system_mode_device = modes[v];
                        return modes[v];
                    },
                },
            ],
            [16, "local_temperature", tuya.valueConverter.divideBy10],
            [18, "min_temperature_limit", tuya.valueConverter.divideBy10],
            [34, "max_temperature_limit", tuya.valueConverter.divideBy10],
            [
                39,
                "child_lock",
                tuya.valueConverterBasic.lookup({
                    unlocked: false,
                    locked: true,
                }),
            ],
            [
                49,
                "fan_mode",
                tuya.valueConverterBasic.lookup({
                    auto: tuya.enum(0),
                    high: tuya.enum(1),
                    medium: tuya.enum(2),
                    low: tuya.enum(3),
                }),
            ],
            [50, "current_heating_setpoint", tuya.valueConverter.divideBy10],
            [101, "screen_brightness", tuya.valueConverter.raw],
            [102, "local_temperature_calibration", tuya.valueConverter.raw],
            [104, "deadzone_temperature", tuya.valueConverter.divideBy10],
            [107, "eco_temperature_heating", tuya.valueConverter.raw],
            [109, "eco_temperature_cooling", tuya.valueConverter.raw],
        ],
    },
};

[rvalle]

@andrei-lazarov here is the pull request

CI is giving me an TS typing error, that is not happening in the development console, any ideas what this is about?

[andrei-lazarov]

Not sure, Koenkk will review