fix(ignore): Refactor fromZigbee to TS (#6284)

Koenkk · Oct 14, 2023 · 602a921 · 602a921
1 parent 72d3775
commit 602a921
Show file tree

Hide file tree

Showing 9 changed files with 950 additions and 940 deletions.
diff --git a/src/converters/fromZigbee.js → src/converters/fromZigbee.ts b/src/converters/fromZigbee.js → src/converters/fromZigbee.ts
diff --git a/src/devices/datek.ts b/src/devices/datek.ts
@@ -173,7 +173,6 @@ const definitions: Definition[] = [
                 data.data &&
                 data.data.userid !== undefined &&
                 // Don't read RF events, we can do this with retrieve_state
-                // @ts-expect-error
                 (data.data.programeventsrc === undefined || constants.lockSourceName[data.data.programeventsrc] != 'rf')
             ) {
                 await device.endpoints[0].command('closuresDoorLock', 'getPinCode', {userid: data.data.userid}, {});

diff --git a/src/devices/develco.ts b/src/devices/develco.ts
@@ -105,7 +105,6 @@ const develco = {
                 if (msg.data.hasOwnProperty('develcoInterfaceMode')) {
                     result[utils.postfixWithEndpointName('interface_mode', msg, model, meta)] =
                         constants.develcoInterfaceMode.hasOwnProperty(msg.data['develcoInterfaceMode']) ?
-                            // @ts-expect-error
                             constants.develcoInterfaceMode[msg.data['develcoInterfaceMode']] :
                             msg.data['develcoInterfaceMode'];
                 }
@@ -169,15 +168,15 @@ const develco = {
         voc_battery: {
             cluster: 'genPowerCfg',
             type: ['attributeReport', 'readResponse'],
-            convert: (model, msg, publish, options, meta) => {
+            convert: async (model, msg, publish, options, meta) => {
                 /*
                  * Per the technical documentation for AQSZB-110:
                  * To detect low battery the system can monitor the "BatteryVoltage" by setting up a reporting interval of every 12 hour.
                  * When a voltage of 2.5V is measured the battery should be replaced.
                  * Low batt LED indication–RED LED will blink twice every 60 second.
                  */
-                const result = fz.battery.convert(model, msg, publish, options, meta);
-                result.battery_low = (result.voltage <= 2500);
+                const result = await fz.battery.convert(model, msg, publish, options, meta);
+                if (result) result.battery_low = (result.voltage <= 2500);
                 return result;
             },
         } as Fz.Converter,

diff --git a/src/devices/dresden_elektronik.ts b/src/devices/dresden_elektronik.ts
@@ -1,6 +1,6 @@
 import {Definition} from '../lib/types';
 import * as exposes from '../lib/exposes';
-import * as fz from '../converters/fromZigbee';
+import fz from '../converters/fromZigbee';
 import * as ota from '../lib/ota';
 import * as reporting from '../lib/reporting';
 import extend from '../lib/extend';

diff --git a/src/devices/sinope.ts b/src/devices/sinope.ts
@@ -83,11 +83,9 @@ const fzLocal = {
                 result.unoccupied_cooling_setpoint = precisionRound(msg.data['unoccupiedCoolingSetpoint'], 2) / 100;
             }
             if (msg.data.hasOwnProperty('ctrlSeqeOfOper')) {
-                // @ts-expect-error
                 result.control_sequence_of_operation = constants.thermostatControlSequenceOfOperations[msg.data['ctrlSeqeOfOper']];
             }
             if (msg.data.hasOwnProperty('systemMode')) {
-                // @ts-expect-error
                 result.system_mode = constants.thermostatSystemModes[msg.data['systemMode']];
             }
             if (msg.data.hasOwnProperty('pIHeatingDemand')) {

diff --git a/src/devices/tuya.ts b/src/devices/tuya.ts
@@ -346,9 +346,9 @@ const fzLocal = {
     } as Fz.Converter,
     TS0222_humidity: {
         ...fz.humidity,
-        convert: (model, msg, publish, options, meta) => {
-            const result = fz.humidity.convert(model, msg, publish, options, meta);
-            result.humidity *= 10;
+        convert: async (model, msg, publish, options, meta) => {
+            const result = await fz.humidity.convert(model, msg, publish, options, meta);
+            if (result) result.humidity *= 10;
             return result;
         },
     } as Fz.Converter,
@@ -444,8 +444,8 @@ const fzLocal = {
     } as Fz.Converter,
     TS011F_electrical_measurement: {
         ...fz.electrical_measurement,
-        convert: (model, msg, publish, options, meta) => {
-            const result: KeyValueAny = fz.electrical_measurement.convert(model, msg, publish, options, meta);
+        convert: async (model, msg, publish, options, meta) => {
+            const result = await fz.electrical_measurement.convert(model, msg, publish, options, meta);
             const lookup: KeyValueString = {power: 'activePower', current: 'rmsCurrent', voltage: 'rmsVoltage'};
 
             // Wait 5 seconds before reporting a 0 value as this could be an invalid measurement.

diff --git a/src/devices/weiser.ts b/src/devices/weiser.ts
@@ -29,7 +29,6 @@ const definitions: Definition[] = [
                 data.data &&
                 data.data.userid !== undefined &&
                 // Don't read RF events, we can do this with retrieve_state
-                // @ts-expect-error
                 (data.data.programeventsrc === undefined || constants.lockSourceName[data.data.programeventsrc] != 'rf')
             ) {
                 await device.endpoints[0].command('closuresDoorLock', 'getPinCode', {userid: data.data.userid}, {});
@@ -59,7 +58,6 @@ const definitions: Definition[] = [
                 data.data &&
                 data.data.userid !== undefined &&
                 // Don't read RF events, we can do this with retrieve_state
-                // @ts-expect-error
                 (data.data.programeventsrc === undefined || constants.lockSourceName[data.data.programeventsrc] != 'rf')
             ) {
                 await device.endpoints[0].command('closuresDoorLock', 'getPinCode', {userid: data.data.userid}, {});

diff --git a/src/lib/constants.ts b/src/lib/constants.ts
@@ -1,3 +1,5 @@
+import {KeyValueAny, KeyValueNumberString} from './types';
+
 export const OneJanuary2000 = new Date('January 01, 2000 00:00:00 UTC+00:00').getTime();
 
 export const defaultBindGroup = 901;
@@ -12,7 +14,7 @@ export const repInterval = {
     MINUTE: 60,
 };
 
-export const thermostatControlSequenceOfOperations = {
+export const thermostatControlSequenceOfOperations: KeyValueNumberString = {
     0: 'cooling_only',
     1: 'cooling_with_reheat',
     2: 'heating_only',
@@ -21,14 +23,14 @@ export const thermostatControlSequenceOfOperations = {
     5: 'cooling_and_heating_4-pipes_with_reheat',
 };
 
-export const thermostatProgrammingOperationModes = {
+export const thermostatProgrammingOperationModes: KeyValueNumberString = {
     0: 'setpoint',
     1: 'schedule',
     3: 'schedule_with_preheat',
     4: 'eco',
 };
 
-export const thermostatSystemModes = {
+export const thermostatSystemModes: KeyValueNumberString = {
     0: 'off',
     1: 'auto',
     3: 'cool',
@@ -40,13 +42,13 @@ export const thermostatSystemModes = {
     9: 'sleep',
 };
 
-export const thermostatRunningMode= {
+export const thermostatRunningMode: KeyValueNumberString= {
     0: 'off',
     3: 'cool',
     4: 'heat',
 };
 
-export const thermostatDayOfWeek = {
+export const thermostatDayOfWeek: KeyValueNumberString = {
     0: 'sunday',
     1: 'monday',
     2: 'tuesday',
@@ -57,7 +59,7 @@ export const thermostatDayOfWeek = {
     7: 'away_or_vacation',
 };
 
-export const thermostatRunningStates = {
+export const thermostatRunningStates: KeyValueAny = {
     0: 'idle',
     1: 'heat',
     2: 'cool',
@@ -75,7 +77,7 @@ export const thermostatRunningStates = {
     22: 'cool',
 };
 
-export const thermostatAcLouverPositions = {
+export const thermostatAcLouverPositions: KeyValueNumberString = {
     0: 'fully_closed',
     1: 'fully_closed',
     2: 'fully_open',
@@ -84,7 +86,7 @@ export const thermostatAcLouverPositions = {
     5: 'three_quarters_open',
 };
 
-export const thermostatScheduleMode = {
+export const thermostatScheduleMode: KeyValueNumberString = {
     0: 'heat',
     1: 'cool',
 };
@@ -99,51 +101,51 @@ export const fanMode = {
     'smart': 6,
 };
 
-export const temperatureDisplayMode = {
+export const temperatureDisplayMode: KeyValueNumberString = {
     0: 'celsius',
     1: 'fahrenheit',
 };
 
-export const danfossAdaptionRunStatus= {
+export const danfossAdaptionRunStatus: KeyValueNumberString= {
     0: 'none',
     1: 'in_progress',
     2: 'found',
     4: 'lost',
 };
 
-export const danfossAdaptionRunControl = {
+export const danfossAdaptionRunControl: KeyValueNumberString = {
     0: 'none',
     1: 'initiate_adaptation',
     2: 'cancel_adaptation',
 };
 
-export const danfossWindowOpen = {
+export const danfossWindowOpen: KeyValueNumberString = {
     0: 'quarantine',
     1: 'closed',
     2: 'hold',
     3: 'open',
     4: 'external_open',
 };
 
-export const danfossRoomStatusCode = {
+export const danfossRoomStatusCode: KeyValueNumberString = {
     0x0000: 'no_error',
     0x0101: 'missing_rt',
     0x0201: 'rt_touch_error',
     0x0401: 'floor_sensor_short_circuit',
     0x0801: 'floor_sensor_disconnected',
 };
 
-export const danfossOutputStatus = {
+export const danfossOutputStatus: KeyValueNumberString = {
     0: 'inactive',
     1: 'active',
 };
 
-export const danfossSystemStatusWater = {
+export const danfossSystemStatusWater: KeyValueNumberString = {
     0: 'hot_water_flow_in_pipes',
     1: 'cool_water_flow_in_pipes',
 };
 
-export const danfossSystemStatusCode = {
+export const danfossSystemStatusCode: KeyValueNumberString = {
     0x0000: 'no_error',
     0x0101: 'missing_expansion_board',
     0x0201: 'missing_radio_module',
@@ -156,14 +158,14 @@ export const danfossSystemStatusCode = {
     0x0102: 'error_on_one_or_more_output',
 };
 
-export const danfossMultimasterRole = {
+export const danfossMultimasterRole: KeyValueNumberString = {
     0: 'invalid_unused',
     1: 'master',
     2: 'slave_1',
     3: 'slave_2',
 };
 
-export const develcoInterfaceMode = {
+export const develcoInterfaceMode: KeyValueAny = {
     0: 'electricity',
     1: 'gas',
     2: 'water',
@@ -174,7 +176,7 @@ export const develcoInterfaceMode = {
     260: 'DSMR-4.0',
 };
 
-export const keypadLockoutMode = {
+export const keypadLockoutMode: KeyValueAny = {
     0: 'unlock',
     1: 'lock1',
     2: 'lock2',
@@ -183,15 +185,15 @@ export const keypadLockoutMode = {
     5: 'lock5',
 };
 
-export const lockSourceName = {
+export const lockSourceName: KeyValueNumberString = {
     0: 'keypad',
     1: 'rf',
     2: 'manual',
     3: 'rfid',
     4: 'fingerprint',
 };
 
-export const armMode = {
+export const armMode: KeyValueNumberString = {
     0: 'disarm',
     1: 'arm_day_zones',
     2: 'arm_night_zones',
@@ -231,13 +233,13 @@ export const colorModeLookup = {
 
 export const lockSoundVolume = ['silent_mode', 'low_volume', 'high_volume'];
 
-export const lockUserStatus = {
+export const lockUserStatus: KeyValueNumberString = {
     0: 'available',
     1: 'enabled',
     3: 'disabled',
 };
 
-export const easyCodeTouchActions = {
+export const easyCodeTouchActions: KeyValueNumberString = {
     // First byte are source / msg.data[3]
     // 0x00 KeyPad: If the user uses the code panel.
     // 0x02 Manual: If the user used a key, button or fingerprint.
@@ -274,7 +276,7 @@ export const easyCodeTouchActions = {
     0xFF0E: 'zigbee_unlock',
 };
 
-export const wiserDimmerControlMode = {
+export const wiserDimmerControlMode: KeyValueNumberString = {
     0: 'auto',
     1: 'rc',
     2: 'rl',

diff --git a/src/lib/xiaomi.ts b/src/lib/xiaomi.ts
@@ -26,7 +26,7 @@ export interface TrvScheduleConfig {
 }
 
 
-const buffer2DataObject = (meta: Fz.Meta, model: Definition, buffer: Buffer) => {
+export const buffer2DataObject = (meta: Fz.Meta, model: Definition, buffer: Buffer) => {
     const dataObject: KeyValue = {};
 
     if (buffer !== null && Buffer.isBuffer(buffer)) {
@@ -157,7 +157,7 @@ const buffer2DataObject = (meta: Fz.Meta, model: Definition, buffer: Buffer) =>
     return dataObject;
 };
 
-const numericAttributes2Payload = async (msg: Fz.Message, meta: Fz.Meta, model: Definition, options: KeyValue, dataObject: KeyValue) => {
+export const numericAttributes2Payload = async (msg: Fz.Message, meta: Fz.Meta, model: Definition, options: KeyValue, dataObject: KeyValue) => {
     let payload: KeyValue = {};
 
     for (const [key, value] of Object.entries(dataObject)) {
@@ -750,7 +750,7 @@ export const VOCKQJK11LMDisplayUnit = {
     'ppb_fahrenheit': 0x11, // ppb, °F
 };
 
-const numericAttributes2Options = (definition: Definition) => {
+export const numericAttributes2Options = (definition: Definition) => {
     const supported = ['temperature', 'device_temperature', 'illuminance', 'illuminance_lux',
         'pressure', 'power', 'current', 'voltage', 'energy', 'power'];
     const precisionSupported = ['temperature', 'humidity', 'pressure', 'power', 'current', 'voltage', 'energy', 'power'];