mclimate-payload-helper 1.2.18 → 1.2.19

package/README.md

@@ -1 +1,55 @@
 # mclimate-payload-helper
+
+Utilities for working with MClimate IoT device payloads. The package exposes TypeScript helpers to parse uplink payloads, construct downlink command payloads, and reuse the enums/schemas that describe each supported device family.
+
+## Features
+
+- Typed `uplinkPayloadParser` that converts raw payload buffers into structured data for every supported `DeviceType`.
+- Command builders and enums for devices such as Vicki, Relay 16, TFlood, CO₂ sensors, thermostats, and more.
+- Shared error helpers (`CustomError`) and validation schemas so client apps can keep business logic consistent with the firmware payload contracts.
+
+## Installation
+
+```bash
+npm install mclimate-payload-helper
+```
+
+The library ships TypeScript declarations, so no extra typings package is required.
+
+## Usage
+
+```ts
+import { uplinkPayloadParser, CommandBuilder, DeviceType } from 'mclimate-payload-helper'
+
+const uplink = uplinkPayloadParser({
+	deviceType: DeviceType.Relay16,
+	payloadHex: '0100aa34ff...',
+})
+
+const command = new CommandBuilder()
+	.forDevice(DeviceType.Vicki)
+	.useCommand('setTargetTemperature')
+	.withPayload({ temperature: 22 })
+	.build()
+```
+
+Refer to the `src/decoders` and `src/encoders` directories for the complete list of parsers, commands, enums, and helper functions.
+
+## Pre-commit hooks
+
+Husky enforces repository quality gates before every commit (`.husky/pre-commit`):
+
+1. `npm run format:check` – Prettier formatting guard.
+2. `npm run type-check` – Ensures the TypeScript project still compiles.
+3. `npm run lint` – ESLint with the repo ruleset.
+4. `npm run test` – Jest unit tests.
+
+If a hook fails, fix the issue locally before committing again.
+
+## Publishing a new version
+
+1. Bump the version in `package.json` (or run `npm version patch|minor|major` which updates the lockfile and creates a git tag).
+2. Run the full quality suite locally (`npm run format`, `npm run lint`, `npm run type-check`, `npm test`) and ensure `npm run build` succeeds.
+3. Publish the package with `npm publish`. The `prepublishOnly` script will rebuild the dist folder automatically.
+
+Skipping the version bump will cause `npm publish` to fail, so always increment the version before publishing.

package/dist/encoders/Co2DisplayCommonCommands.d.ts

@@ -1,7 +1,3 @@
-import { BaseCommand } from '../encoders';
-import { Co2CommonDisplayCommandTypes } from '../encoders/types';
 export declare class Co2DisplayCommonCommands {
-    static setCo2ImagesVisibility(params: Co2CommonDisplayCommandTypes.SetCo2ImagesVisibilityParams): BaseCommand;
-    static getCo2ImagesVisibility(): BaseCommand;
 }
 //# sourceMappingURL=Co2DisplayCommonCommands.d.ts.map

package/dist/encoders/Co2DisplayCommonCommands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Co2DisplayCommonCommands.d.ts","sourceRoot":"","sources":["../../src/encoders/Co2DisplayCommonCommands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAGxC,OAAO,EAAE,4BAA4B,EAAwB,MAAM,kBAAkB,CAAA;AAErF,qBAAa,wBAAwB;IACpC,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,CAAC,4BAA4B;IAgC/F,MAAM,CAAC,sBAAsB;CAG7B"}
+{"version":3,"file":"Co2DisplayCommonCommands.d.ts","sourceRoot":"","sources":["../../src/encoders/Co2DisplayCommonCommands.ts"],"names":[],"mappings":"AAKA,qBAAa,wBAAwB;CAAG"}

package/dist/encoders/Co2DisplayCommonCommands.js

@@ -1,45 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Co2DisplayCommonCommands = void 0;
-const encoders_1 = require("../encoders");
-const zod_1 = require("zod");
-const utils_1 = require("../utils");
-const types_1 = require("../encoders/types");
 class Co2DisplayCommonCommands {
-    static setCo2ImagesVisibility(params) {
-        try {
-            types_1.DeviceCommandSchemas.Co2CommonDisplayCommandSchemas.setCo2ImagesVisibility.parse(params);
-            const { chart, digital_value, emoji } = params;
-            const chartValue = chart ? 1 : 0;
-            const digitalValue = digital_value ? 1 : 0;
-            const emojiValue = emoji ? 1 : 0;
-            let bin = '00000000'.split('');
-            bin[7] = emojiValue.toString();
-            bin[6] = digitalValue.toString();
-            bin[5] = chartValue.toString();
-            const binValue = parseInt(bin.join(''), 2);
-            return new encoders_1.BaseCommand('SetCo2ImagesVisibility', 0x82, (0, utils_1.decToHex)(binValue));
-        }
-        catch (e) {
-            if (e instanceof zod_1.ZodError) {
-                throw new utils_1.CustomError({
-                    message: 'Zod validation error during SetCo2ImagesVisibility execution',
-                    command: 'SetCo2ImagesVisibility',
-                    originalError: e,
-                });
-            }
-            else {
-                throw new utils_1.CustomError({
-                    message: 'Error during SetCo2ImagesVisibility execution',
-                    command: 'SetCo2ImagesVisibility',
-                    originalError: e,
-                });
-            }
-        }
-    }
-    static getCo2ImagesVisibility() {
-        return new encoders_1.BaseCommand('GetCo2ImagesVisibility', 0x83);
-    }
 }
 exports.Co2DisplayCommonCommands = Co2DisplayCommonCommands;
 //# sourceMappingURL=Co2DisplayCommonCommands.js.map

package/dist/encoders/Co2DisplayCommonCommands.js.map

@@ -1 +1 @@
-{"version":3,"file":"Co2DisplayCommonCommands.js","sourceRoot":"","sources":["../../src/encoders/Co2DisplayCommonCommands.ts"],"names":[],"mappings":";;;AAAA,yCAAwC;AACxC,6BAA8B;AAC9B,mCAA+C;AAC/C,4CAAqF;AAErF,MAAa,wBAAwB;IACpC,MAAM,CAAC,sBAAsB,CAAC,MAAiE;QAC9F,IAAI,CAAC;YACJ,4BAAoB,CAAC,8BAA8B,CAAC,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YACxF,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;YAC9C,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAChC,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAEhC,IAAI,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;YAC9B,GAAG,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAA;YAC9B,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAA;YAChC,GAAG,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAA;YAC9B,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAE1C,OAAO,IAAI,sBAAW,CAAC,wBAAwB,EAAE,IAAI,EAAE,IAAA,gBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAA;QAC3E,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,IAAI,CAAC,YAAY,cAAQ,EAAE,CAAC;gBAC3B,MAAM,IAAI,mBAAW,CAAC;oBACrB,OAAO,EAAE,8DAA8D;oBACvE,OAAO,EAAE,wBAAwB;oBACjC,aAAa,EAAE,CAAC;iBAChB,CAAC,CAAA;YACH,CAAC;iBAAM,CAAC;gBACP,MAAM,IAAI,mBAAW,CAAC;oBACrB,OAAO,EAAE,+CAA+C;oBACxD,OAAO,EAAE,wBAAwB;oBACjC,aAAa,EAAE,CAAU;iBACzB,CAAC,CAAA;YACH,CAAC;QACF,CAAC;IACF,CAAC;IAED,MAAM,CAAC,sBAAsB;QAC5B,OAAO,IAAI,sBAAW,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAA;IACvD,CAAC;CACD;AApCD,4DAoCC"}
+{"version":3,"file":"Co2DisplayCommonCommands.js","sourceRoot":"","sources":["../../src/encoders/Co2DisplayCommonCommands.ts"],"names":[],"mappings":";;;AAKA,MAAa,wBAAwB;CAAG;AAAxC,4DAAwC"}

package/dist/encoders/FanCoilThermostat.d.ts

@@ -0,0 +1,61 @@
+import { BaseCommand } from '../encoders';
+import { FanCoilThermostatCommandTypes } from '../encoders/types';
+export declare class FanCoilThermostatCommands {
+    static setTargetTemperatureStep(params: FanCoilThermostatCommandTypes.SetTargetTemperatureStepParams): BaseCommand;
+    static getTargetTemperatureStep(): BaseCommand;
+    static setKeysLock(params: FanCoilThermostatCommandTypes.SetKeysLockParams): BaseCommand;
+    static getKeysLock(): BaseCommand;
+    static setFanCoilTarget(params: FanCoilThermostatCommandTypes.SetFanCoilTargetParams): BaseCommand;
+    static setTargetTemperature(params: FanCoilThermostatCommandTypes.SetTargetTemperatureFanCoilParams): BaseCommand;
+    static setFctOperationalMode(params: FanCoilThermostatCommandTypes.SetFctOperationalModeParams): BaseCommand;
+    static setValveOpenCloseTime(params: FanCoilThermostatCommandTypes.SetValveOpenCloseTimeParams): BaseCommand;
+    static getValveOpenCloseTime(): BaseCommand;
+    static setExtAutomaticTemperatureControl(params: FanCoilThermostatCommandTypes.SetExtAutomaticTemperatureControlParams): BaseCommand;
+    static getExtAutomaticTemperatureControl(): BaseCommand;
+    static setFanSpeed(params: FanCoilThermostatCommandTypes.SetFanSpeedParams): BaseCommand;
+    static getFanSpeed(): BaseCommand;
+    static setFanSpeedLimit(params: FanCoilThermostatCommandTypes.SetFanSpeedLimitParams): BaseCommand;
+    static getFanSpeedLimit(): BaseCommand;
+    static setEcmVoltageRange(params: FanCoilThermostatCommandTypes.SetEcmVoltageRangeParams): BaseCommand;
+    static getEcmVoltageRange(): BaseCommand;
+    static setEcmStartUpTime(params: FanCoilThermostatCommandTypes.SetEcmStartUpTimeParams): BaseCommand;
+    static getEcmStartUpTime(): BaseCommand;
+    static setEcmRelay(params: FanCoilThermostatCommandTypes.SetEcmRelayParams): BaseCommand;
+    static getEcmRelay(): BaseCommand;
+    static setFrostProtection(params: FanCoilThermostatCommandTypes.SetFrostProtectionParams): BaseCommand;
+    static getFrostProtection(): BaseCommand;
+    static setFrostProtectionSettings(params: FanCoilThermostatCommandTypes.SetFrostProtectionSettingsParams): BaseCommand;
+    static getFrostProtectionSettings(): BaseCommand;
+    static setAllowedOperationalModes(params: FanCoilThermostatCommandTypes.SetAllowedOperationalModesParams): BaseCommand;
+    static getAllowedOperationalModes(): BaseCommand;
+    static setCoolingSetpointNotOccupied(params: FanCoilThermostatCommandTypes.SetCoolingSetpointNotOccupiedParams): BaseCommand;
+    static getCoolingSetpointNotOccupied(): BaseCommand;
+    static setHeatingSetpointNotOccupied(params: FanCoilThermostatCommandTypes.SetHeatingSetpointNotOccupiedParams): BaseCommand;
+    static getHeatingSetpointNotOccupied(): BaseCommand;
+    static setTempSensorCompensation(params: FanCoilThermostatCommandTypes.SetTempSensorCompensationParams): BaseCommand;
+    static getTempSensorCompensation(): BaseCommand;
+    static setFanSpeedNotOccupied(params: FanCoilThermostatCommandTypes.SetFanSpeedNotOccupiedParams): BaseCommand;
+    static getFanSpeedNotOccupied(): BaseCommand;
+    static setAutomaticChangeover(params: FanCoilThermostatCommandTypes.SetAutomaticChangeoverParams): BaseCommand;
+    static getAutomaticChangeover(): BaseCommand;
+    static setWiringDiagram(params: FanCoilThermostatCommandTypes.SetWiringDiagramParams): BaseCommand;
+    static getWiringDiagram(): BaseCommand;
+    static setOccFunction(params: FanCoilThermostatCommandTypes.SetOccFunctionParams): BaseCommand;
+    static getOccFunction(): BaseCommand;
+    static setAutomaticChangeoverThreshold(params: FanCoilThermostatCommandTypes.SetAutomaticChangeoverThresholdParams): BaseCommand;
+    static getAutomaticChangeoverThreshold(): BaseCommand;
+    static setDeviceStatus(params: FanCoilThermostatCommandTypes.SetDeviceStatusParams): BaseCommand;
+    static getDeviceStatus(): BaseCommand;
+    static setReturnOfPowerOperation(params: FanCoilThermostatCommandTypes.SetReturnOfPowerOperationParams): BaseCommand;
+    static getReturnOfPowerOperation(): BaseCommand;
+    static setDeltaTemperature1(params: FanCoilThermostatCommandTypes.SetDeltaTemperature1Params): BaseCommand;
+    static getDeltaTemperature1(): BaseCommand;
+    static setDeltaTemperature2and3(params: FanCoilThermostatCommandTypes.SetDeltaTemperature2and3Params): BaseCommand;
+    static getDeltaTemperature2and3(): BaseCommand;
+    static getFrostProtectionStatus(): BaseCommand;
+    static getOccupancySensorStatusSetPoint(): BaseCommand;
+    static getOccupancySensorStatus(): BaseCommand;
+    static getDewPointSensorStatus(): BaseCommand;
+    static getFilterAlarm(): BaseCommand;
+}
+//# sourceMappingURL=FanCoilThermostat.d.ts.map

package/dist/encoders/FanCoilThermostat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FanCoilThermostat.d.ts","sourceRoot":"","sources":["../../src/encoders/FanCoilThermostat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAGxC,OAAO,EAAwB,6BAA6B,EAAE,MAAM,kBAAkB,CAAA;AAEtF,qBAAa,yBAAyB;IACrC,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,6BAA6B,CAAC,8BAA8B;IAsBpG,MAAM,CAAC,wBAAwB;IAI/B,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,6BAA6B,CAAC,iBAAiB;IAsB1E,MAAM,CAAC,WAAW;IAIlB,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,6BAA6B,CAAC,sBAAsB;IAsBpF,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,6BAA6B,CAAC,iCAAiC;IAsBnG,MAAM,CAAC,qBAAqB,CAAC,MAAM,EAAE,6BAA6B,CAAC,2BAA2B;IAsB9F,MAAM,CAAC,qBAAqB,CAAC,MAAM,EAAE,6BAA6B,CAAC,2BAA2B;IAsB9F,MAAM,CAAC,qBAAqB;IAI5B,MAAM,CAAC,iCAAiC,CACvC,MAAM,EAAE,6BAA6B,CAAC,uCAAuC;IAuB9E,MAAM,CAAC,iCAAiC;IAIxC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,6BAA6B,CAAC,iBAAiB;IAsB1E,MAAM,CAAC,WAAW;IAIlB,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,6BAA6B,CAAC,sBAAsB;IAsBpF,MAAM,CAAC,gBAAgB;IAIvB,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,6BAA6B,CAAC,wBAAwB;IAsBxF,MAAM,CAAC,kBAAkB;IAIzB,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,6BAA6B,CAAC,uBAAuB;IAsBtF,MAAM,CAAC,iBAAiB;IAIxB,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,6BAA6B,CAAC,iBAAiB;IAsB1E,MAAM,CAAC,WAAW;IAIlB,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,6BAA6B,CAAC,wBAAwB;IAsBxF,MAAM,CAAC,kBAAkB;IAIzB,MAAM,CAAC,0BAA0B,CAAC,MAAM,EAAE,6BAA6B,CAAC,gCAAgC;IAsBxG,MAAM,CAAC,0BAA0B;IAIjC,MAAM,CAAC,0BAA0B,CAAC,MAAM,EAAE,6BAA6B,CAAC,gCAAgC;IAsBxG,MAAM,CAAC,0BAA0B;IAIjC,MAAM,CAAC,6BAA6B,CAAC,MAAM,EAAE,6BAA6B,CAAC,mCAAmC;IAsB9G,MAAM,CAAC,6BAA6B;IAIpC,MAAM,CAAC,6BAA6B,CAAC,MAAM,EAAE,6BAA6B,CAAC,mCAAmC;IAsB9G,MAAM,CAAC,6BAA6B;IAIpC,MAAM,CAAC,yBAAyB,CAAC,MAAM,EAAE,6BAA6B,CAAC,+BAA+B;IAsBtG,MAAM,CAAC,yBAAyB;IAIhC,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,6BAA6B,CAAC,4BAA4B;IAsBhG,MAAM,CAAC,sBAAsB;IAI7B,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,6BAA6B,CAAC,4BAA4B;IAsBhG,MAAM,CAAC,sBAAsB;IAI7B,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,6BAA6B,CAAC,sBAAsB;IAsBpF,MAAM,CAAC,gBAAgB;IAIvB,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,6BAA6B,CAAC,oBAAoB;IAsBhF,MAAM,CAAC,cAAc;IAIrB,MAAM,CAAC,+BAA+B,CAAC,MAAM,EAAE,6BAA6B,CAAC,qCAAqC;IA2BlH,MAAM,CAAC,+BAA+B;IAItC,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,6BAA6B,CAAC,qBAAqB;IAsBlF,MAAM,CAAC,eAAe;IAItB,MAAM,CAAC,yBAAyB,CAAC,MAAM,EAAE,6BAA6B,CAAC,+BAA+B;IAsBtG,MAAM,CAAC,yBAAyB;IAIhC,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,6BAA6B,CAAC,0BAA0B;IAsB5F,MAAM,CAAC,oBAAoB;IAI3B,MAAM,CAAC,wBAAwB,CAAC,MAAM,EAAE,6BAA6B,CAAC,8BAA8B;IA2BpG,MAAM,CAAC,wBAAwB;IAI/B,MAAM,CAAC,wBAAwB;IAI/B,MAAM,CAAC,gCAAgC;IAIvC,MAAM,CAAC,wBAAwB;IAI/B,MAAM,CAAC,uBAAuB;IAI9B,MAAM,CAAC,cAAc;CAGrB"}