zigbee-herdsman-converters 24.13.0 → 25.0.0

package/dist/lib/tuya.js

@@ -33,13 +33,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.clusters = exports.modernExtend = exports.fz = exports.tz = exports.valueConverter = exports.valueConverterBasic = exports.Bitmap = exports.enum = exports.Enum = exports.whitelabel = exports.fingerprint = exports.configureMagicPacket = exports.skip = exports.exposes = exports.dataTypes = void 0;
+exports.clusters = exports.modernExtend = exports.fz = exports.tz = exports.valueConverter = exports.valueConverterBasic = exports.Bitmap = exports.enum = exports.Enum = exports.whitelabel = exports.fingerprint = exports.configureBindBasic = exports.configureMcuVersionRequest = exports.configureQuery = exports.configureMagicPacket = exports.skip = exports.exposes = exports.dataTypes = void 0;
 exports.convertBufferToNumber = convertBufferToNumber;
-exports.onEvent = onEvent;
 exports.convertDecimalValueTo4ByteHexArray = convertDecimalValueTo4ByteHexArray;
-exports.onEventMeasurementPoll = onEventMeasurementPoll;
-exports.onEventSetTime = onEventSetTime;
-exports.onEventSetLocalTime = onEventSetLocalTime;
 exports.dpValueFromString = dpValueFromString;
 exports.sendDataPointValue = sendDataPointValue;
 exports.sendDataPointBool = sendDataPointBool;
@@ -85,66 +81,6 @@ function convertStringToHexArray(value) {
     }
     return asciiKeys;
 }
-function onEvent(args) {
-    return async (type, data, device, settings, state) => {
-        // biome-ignore lint/style/noParameterAssign: ignored using `--suppress`
-        args = { queryOnDeviceAnnounce: false, timeStart: "1970", respondToMcuVersionResponse: true, ...args };
-        const endpoint = device.endpoints[0];
-        if (type === "message" && data.cluster === "manuSpecificTuya") {
-            if (args.respondToMcuVersionResponse && data.type === "commandMcuVersionResponse") {
-                await endpoint.command("manuSpecificTuya", "mcuVersionRequest", { seq: 0x0002 });
-            }
-            else if (data.type === "commandMcuGatewayConnectionStatus") {
-                // "payload" can have the following values:
-                // 0x00: The gateway is not connected to the internet.
-                // 0x01: The gateway is connected to the internet.
-                // 0x02: The request timed out after three seconds.
-                const payload = { payloadSize: 1, payload: 1 };
-                await endpoint.command("manuSpecificTuya", "mcuGatewayConnectionStatus", payload, {});
-            }
-        }
-        if (data.type === "commandMcuSyncTime" && data.cluster === "manuSpecificTuya") {
-            try {
-                const offset = args.timeStart === "2000" ? constants.OneJanuary2000 : 0;
-                const utcTime = Math.round((Date.now() - offset) / 1000);
-                const localTime = utcTime - new Date().getTimezoneOffset() * 60;
-                const payload = {
-                    payloadSize: 8,
-                    payload: [...convertDecimalValueTo4ByteHexArray(utcTime), ...convertDecimalValueTo4ByteHexArray(localTime)],
-                };
-                await endpoint.command("manuSpecificTuya", "mcuSyncTime", payload, {});
-            }
-            catch {
-                /* handle error to prevent crash */
-            }
-        }
-        // Some devices require a dataQuery on deviceAnnounce, otherwise they don't report any data
-        if (args.queryOnDeviceAnnounce && type === "deviceAnnounce") {
-            await endpoint.command("manuSpecificTuya", "dataQuery", {});
-        }
-        if (args.queryIntervalSeconds) {
-            if (type === "stop") {
-                clearTimeout(globalStore.getValue(device, "query_interval"));
-                globalStore.clearValue(device, "query_interval");
-            }
-            else if (!globalStore.hasValue(device, "query_interval")) {
-                const setTimer = () => {
-                    const timer = setTimeout(async () => {
-                        try {
-                            await endpoint.command("manuSpecificTuya", "dataQuery", {});
-                        }
-                        catch (error) {
-                            logger_1.logger.error(`Failed to query data of '${device.ieeeAddr}' (${error})`, NS);
-                        }
-                        setTimer();
-                    }, args.queryIntervalSeconds * 1000);
-                    globalStore.putValue(device, "query_interval", timer);
-                };
-                setTimer();
-            }
-        }
-    };
-}
 function getDataValue(dpValue) {
     let dataString = "";
     switch (dpValue.datatype) {
@@ -180,67 +116,6 @@ function convertDecimalValueTo2ByteHexArray(value) {
     const chunk2 = hexValue.substring(2);
     return [chunk1, chunk2].map((hexVal) => Number.parseInt(hexVal, 16));
 }
-function onEventMeasurementPoll(type, data, device, options, electricalMeasurement = true, metering = false) {
-    const endpoint = device.getEndpoint(1);
-    const poll = async () => {
-        if (electricalMeasurement) {
-            await endpoint.read("haElectricalMeasurement", ["rmsVoltage", "rmsCurrent", "activePower"]);
-        }
-        if (metering) {
-            await endpoint.read("seMetering", ["currentSummDelivered"]);
-        }
-    };
-    utils.onEventPoll(type, data, device, options, "measurement", 60, poll);
-}
-async function onEventSetTime(type, data, device) {
-    // FIXME: Need to join onEventSetTime/onEventSetLocalTime to one command
-    if (data.type === "commandMcuSyncTime" && data.cluster === "manuSpecificTuya") {
-        try {
-            const utcTime = Math.round((Date.now() - constants.OneJanuary2000) / 1000);
-            const localTime = utcTime - new Date().getTimezoneOffset() * 60;
-            const endpoint = device.getEndpoint(1);
-            const payload = {
-                payloadSize: 8,
-                payload: [...convertDecimalValueTo4ByteHexArray(utcTime), ...convertDecimalValueTo4ByteHexArray(localTime)],
-            };
-            await endpoint.command("manuSpecificTuya", "mcuSyncTime", payload, {});
-        }
-        catch {
-            // endpoint.command can throw an error which needs to
-            // be caught or the zigbee-herdsman may crash
-            // Debug message is handled in the zigbee-herdsman
-        }
-    }
-}
-// set UTC and Local Time as total number of seconds from 00: 00: 00 on January 01, 1970
-// force to update every device time every hour due to very poor clock
-async function onEventSetLocalTime(type, data, device) {
-    // FIXME: What actually nextLocalTimeUpdate/forceTimeUpdate do?
-    //  I did not find any timers or something else where it was used.
-    //  Actually, there are two ways to set time on Tuya MCU devices:
-    //  1. Respond to the `commandMcuSyncTime` event
-    //  2. Just send `mcuSyncTime` anytime (by 1-hour timer or something else)
-    const nextLocalTimeUpdate = globalStore.getValue(device, "nextLocalTimeUpdate");
-    const forceTimeUpdate = nextLocalTimeUpdate == null || nextLocalTimeUpdate < Date.now();
-    if ((data.type === "commandMcuSyncTime" && data.cluster === "manuSpecificTuya") || forceTimeUpdate) {
-        globalStore.putValue(device, "nextLocalTimeUpdate", Date.now() + 3600 * 1000);
-        try {
-            const utcTime = Math.round(Date.now() / 1000);
-            const localTime = utcTime - new Date().getTimezoneOffset() * 60;
-            const endpoint = device.getEndpoint(1);
-            const payload = {
-                payloadSize: 8,
-                payload: [...convertDecimalValueTo4ByteHexArray(utcTime), ...convertDecimalValueTo4ByteHexArray(localTime)],
-            };
-            await endpoint.command("manuSpecificTuya", "mcuSyncTime", payload, {});
-        }
-        catch {
-            // endpoint.command can throw an error which needs to
-            // be caught or the zigbee-herdsman may crash
-            // Debug message is handled in the zigbee-herdsman
-        }
-    }
-}
 // Return `seq` - transaction ID for handling concrete response
 async function sendDataPoints(entity, dpValues, cmd = "dataRequest", seq) {
     if (seq === undefined) {
@@ -451,6 +326,19 @@ const configureMagicPacket = async (device, coordinatorEndpoint) => {
     }
 };
 exports.configureMagicPacket = configureMagicPacket;
+const configureQuery = async (device, coordinatorEndpoint) => {
+    // Required to get the device to start reporting
+    await device.getEndpoint(1).command("manuSpecificTuya", "dataQuery", {});
+};
+exports.configureQuery = configureQuery;
+const configureMcuVersionRequest = async (device, coordinatorEndpoint) => {
+    await device.getEndpoint(1).command("manuSpecificTuya", "mcuVersionRequest", { seq: 0x0002 });
+};
+exports.configureMcuVersionRequest = configureMcuVersionRequest;
+const configureBindBasic = async (device, coordinatorEndpoint) => {
+    await device.getEndpoint(1).bind("genBasic", coordinatorEndpoint);
+};
+exports.configureBindBasic = configureBindBasic;
 const fingerprint = (modelID, manufacturerNames) => {
     return manufacturerNames.map((manufacturerName) => {
         return { modelID, manufacturerName };
@@ -1457,33 +1345,33 @@ const tuyaTz = {
         key: ["power_on_behavior"],
         convertSet: async (entity, key, value, meta) => {
             const powerOnBehavior = utils.getFromLookup(value, { off: 0, on: 1, previous: 2 });
-            await entity.write("manuSpecificTuya_3", { powerOnBehavior });
+            await entity.write("manuSpecificTuya3", { powerOnBehavior });
             return { state: { [key]: value } };
         },
         convertGet: async (entity, key, meta) => {
-            await entity.read("manuSpecificTuya_3", ["powerOnBehavior"]);
+            await entity.read("manuSpecificTuya3", ["powerOnBehavior"]);
         },
     },
     switch_type: {
         key: ["switch_type"],
         convertSet: async (entity, key, value, meta) => {
             const switchType = utils.getFromLookup(value, { toggle: 0, state: 1, momentary: 2 });
-            await entity.write("manuSpecificTuya_3", { switchType }, { disableDefaultResponse: true });
+            await entity.write("manuSpecificTuya3", { switchType }, { disableDefaultResponse: true });
             return { state: { [key]: value } };
         },
         convertGet: async (entity, key, meta) => {
-            await entity.read("manuSpecificTuya_3", ["switchType"]);
+            await entity.read("manuSpecificTuya3", ["switchType"]);
         },
     },
     switch_type_curtain: {
         key: ["switch_type_curtain"],
         convertSet: async (entity, key, value, meta) => {
             const switchType = utils.getFromLookup(value, { "flip-switch": 0, "sync-switch": 1, "button-switch": 2, "button2-switch": 3 });
-            await entity.write("manuSpecificTuya_3", { switchType }, { disableDefaultResponse: true });
+            await entity.write("manuSpecificTuya3", { switchType }, { disableDefaultResponse: true });
             return { state: { [key]: value } };
         },
         convertGet: async (entity, key, meta) => {
-            await entity.read("manuSpecificTuya_3", ["switchType"]);
+            await entity.read("manuSpecificTuya3", ["switchType"]);
         },
     },
     backlight_indicator_mode_1: {
@@ -1687,7 +1575,7 @@ const tuyaTz = {
             const inching = exports.valueConverter.inchingSwitch.to(value);
             const payload = { payload: inching };
             const endpoint = meta.device.getEndpoint(1);
-            await endpoint.command("manuSpecificTuya_4", "setInchingSwitch", payload, utils.getOptions(meta.mapped, endpoint));
+            await endpoint.command("manuSpecificTuya4", "setInchingSwitch", payload, utils.getOptions(meta.mapped, endpoint));
             return { state: { inching_control_set: value } };
         },
     },
@@ -1704,18 +1592,6 @@ const tuyaFz = {
             }
         },
     },
-    gateway_connection_status: {
-        cluster: "manuSpecificTuya",
-        type: ["commandMcuGatewayConnectionStatus"],
-        convert: async (model, msg, publish, options, meta) => {
-            // "payload" can have the following values:
-            // 0x00: The gateway is not connected to the internet.
-            // 0x01: The gateway is connected to the internet.
-            // 0x02: The request timed out after three seconds.
-            const payload = { payloadSize: 1, payload: 1 };
-            await msg.endpoint.command("manuSpecificTuya", "mcuGatewayConnectionStatus", payload, {});
-        },
-    },
     power_on_behavior_1: {
         cluster: "genOnOff",
         type: ["attributeReport", "readResponse"],
@@ -1728,7 +1604,7 @@ const tuyaFz = {
         },
     },
     power_on_behavior_2: {
-        cluster: "manuSpecificTuya_3",
+        cluster: "manuSpecificTuya3",
         type: ["attributeReport", "readResponse"],
         convert: (model, msg, publish, options, meta) => {
             const attribute = "powerOnBehavior";
@@ -1751,7 +1627,7 @@ const tuyaFz = {
         },
     },
     switch_type: {
-        cluster: "manuSpecificTuya_3",
+        cluster: "manuSpecificTuya3",
         type: ["attributeReport", "readResponse"],
         convert: (model, msg, publish, options, meta) => {
             if (msg.data.switchType !== undefined) {
@@ -1762,7 +1638,7 @@ const tuyaFz = {
         },
     },
     switch_type_curtain: {
-        cluster: "manuSpecificTuya_3",
+        cluster: "manuSpecificTuya3",
         type: ["attributeReport", "readResponse"],
         convert: (model, msg, publish, options, meta) => {
             if (msg.data.switchType !== undefined) {
@@ -1899,7 +1775,7 @@ const tuyaFz = {
         },
     },
     inchingSwitch: {
-        cluster: "manuSpecificTuya_4",
+        cluster: "manuSpecificTuya4",
         type: ["attributeReport", "readResponse"],
         convert: (model, msg, publish, options, meta) => {
             if (msg.data.inching !== undefined) {
@@ -1983,6 +1859,27 @@ function getHandlersForDP(name, dp, type, converter, readOnly, skip, endpoint, u
     return [fromZigbee, toZigbee];
 }
 const tuyaModernExtend = {
+    electricityMeasurementPoll(args = {}) {
+        const { electricalMeasurement = true, metering = false, optionDescription = undefined } = args;
+        let option = exposes.options.measurement_poll_interval();
+        if (optionDescription !== undefined) {
+            option = option.withDescription(optionDescription);
+        }
+        return modernExtend.poll({
+            key: "measurement",
+            option,
+            defaultIntervalSeconds: 60,
+            poll: async (device) => {
+                const endpoint = device.getEndpoint(1);
+                if (typeof electricalMeasurement === "boolean" ? electricalMeasurement : electricalMeasurement(device)) {
+                    await endpoint.read("haElectricalMeasurement", ["rmsVoltage", "rmsCurrent", "activePower"]);
+                }
+                if (typeof metering === "boolean" ? metering : metering(device)) {
+                    await endpoint.read("seMetering", ["currentSummDelivered"]);
+                }
+            },
+        });
+    },
     dpTHZBSettings() {
         const exp = e
             .composite("auto_settings", "auto_settings", ea.STATE_SET)
@@ -2038,14 +1935,104 @@ const tuyaModernExtend = {
         };
     },
     tuyaBase(args) {
+        const { dp = false, queryOnDeviceAnnounce = false, queryOnConfigure = false, bindBasicOnConfigure = false, queryIntervalSeconds = undefined, mcuVersionRequestOnConfigure = false, 
+        // Allow force updating for device with a very bad clock
+        // Every hour when a message is received the time will be updated.
+        forceTimeUpdates = false, timeStart = "1970", respondToMcuVersionResponse = true, } = args;
+        const fzConverter = {
+            type: [
+                "commandMcuSyncTime",
+                "commandMcuVersionResponse",
+                "commandMcuGatewayConnectionStatus",
+                "commandDataResponse",
+                "commandDataReport",
+                "commandActiveStatusReport",
+                "commandActiveStatusReportAlt",
+            ],
+            cluster: "manuSpecificTuya",
+            convert: (model, msg, publish, options, meta) => {
+                let forceTimeUpdate = false;
+                if (forceTimeUpdates) {
+                    const nextLocalTimeUpdate = globalStore.getValue(msg.device, "nextLocalTimeUpdate");
+                    forceTimeUpdate = nextLocalTimeUpdate == null || nextLocalTimeUpdate < Date.now();
+                }
+                if (msg.type === "commandMcuSyncTime" || forceTimeUpdate) {
+                    globalStore.putValue(msg.device, "nextLocalTimeUpdate", Date.now() + 3600 * 1000);
+                    const offset = timeStart === "2000" ? constants.OneJanuary2000 : 0;
+                    const utcTime = Math.round((Date.now() - offset) / 1000);
+                    const localTime = utcTime - new Date().getTimezoneOffset() * 60;
+                    const payload = {
+                        payloadSize: 8,
+                        payload: [...convertDecimalValueTo4ByteHexArray(utcTime), ...convertDecimalValueTo4ByteHexArray(localTime)],
+                    };
+                    msg.endpoint
+                        .command("manuSpecificTuya", "mcuSyncTime", payload, {})
+                        .catch((error) => logger_1.logger.error(`Failed to sync time with '${msg.device.ieeeAddr}' (${error})`, NS));
+                }
+                else if (respondToMcuVersionResponse && msg.type === "commandMcuVersionResponse") {
+                    msg.endpoint
+                        .command("manuSpecificTuya", "mcuVersionRequest", { seq: 0x0002 })
+                        .catch((error) => logger_1.logger.error(`Failed respond to version response '${msg.device.ieeeAddr}' (${error})`, NS));
+                }
+                else if (msg.type === "commandMcuGatewayConnectionStatus") {
+                    // "payload" can have the following values:
+                    // 0x00: The gateway is not connected to the internet.
+                    // 0x01: The gateway is connected to the internet.
+                    // 0x02: The request timed out after three seconds.
+                    msg.endpoint
+                        .command("manuSpecificTuya", "mcuGatewayConnectionStatus", { payloadSize: 1, payload: 1 }, {})
+                        .catch((error) => logger_1.logger.error(`Failed respond to gateway connection status '${msg.device.ieeeAddr}' (${error})`, NS));
+                }
+            },
+        };
         const result = {
             configure: [exports.configureMagicPacket],
-            onEvent: [onEvent(args.onEvent)],
             isModernExtend: true,
+            fromZigbee: [fzConverter],
+            toZigbee: [],
         };
-        if (args?.dp) {
-            result.fromZigbee = [tuyaFz.datapoints];
-            result.toZigbee = [tuyaTz.datapoints];
+        if (queryOnConfigure) {
+            result.configure.push(exports.configureQuery);
+        }
+        if (mcuVersionRequestOnConfigure) {
+            result.configure.push(exports.configureMcuVersionRequest);
+        }
+        if (bindBasicOnConfigure) {
+            result.configure.push(exports.configureBindBasic);
+        }
+        if (queryOnDeviceAnnounce || queryIntervalSeconds !== undefined) {
+            result.onEvent = [
+                (event) => {
+                    // Some devices require a dataQuery on deviceAnnounce, otherwise they don't report any data
+                    if (queryOnDeviceAnnounce && event.type === "deviceAnnounce") {
+                        event.data.device.endpoints[0]
+                            .command("manuSpecificTuya", "dataQuery", {})
+                            .catch((error) => logger_1.logger.error(`Failed to query '${event.data.device.ieeeAddr}' on device announce (${error})`, NS));
+                    }
+                    if (queryIntervalSeconds !== undefined) {
+                        if (event.type === "stop") {
+                            clearTimeout(globalStore.getValue(event.data.ieeeAddr, "query_interval"));
+                            globalStore.clearValue(event.data.ieeeAddr, "query_interval");
+                        }
+                        else if (event.type === "start") {
+                            const setTimer = () => {
+                                const timer = setTimeout(() => {
+                                    event.data.device.endpoints[0]
+                                        .command("manuSpecificTuya", "dataQuery", {})
+                                        .catch((error) => logger_1.logger.error(`Failed to query '${event.data.device.ieeeAddr}' on interval (${error})`, NS));
+                                    setTimer();
+                                }, queryIntervalSeconds * 1000);
+                                globalStore.putValue(event.data.device.ieeeAddr, "query_interval", timer);
+                            };
+                            setTimer();
+                        }
+                    }
+                },
+            ];
+        }
+        if (dp) {
+            result.fromZigbee.push(tuyaFz.datapoints);
+            result.toZigbee.push(tuyaTz.datapoints);
         }
         return result;
     },
@@ -2458,7 +2445,7 @@ const tuyaModernExtend = {
     tuyaSwitchMode: (args) => modernExtend.enumLookup({
         name: "switch_mode",
         lookup: { switch: 0, scene: 1 },
-        cluster: "manuSpecificTuya_3",
+        cluster: "manuSpecificTuya3",
         attribute: "switchMode",
         description: "Work mode for switch",
         entityCategory: "config",
@@ -2501,7 +2488,7 @@ const tuyaModernExtend = {
 };
 exports.modernExtend = tuyaModernExtend;
 const tuyaClusters = {
-    addTuyaCommonPrivateCluster: () => modernExtend.deviceAddCustomCluster("manuSpecificTuya_4", {
+    addTuyaCommonPrivateCluster: () => modernExtend.deviceAddCustomCluster("manuSpecificTuya4", {
         ID: 0xe000,
         attributes: {
             random_timing: { ID: 0xd001, type: zigbee_herdsman_1.Zcl.DataType.CHAR_STR },