hoffmation-base 4.0.0 → 4.1.0

package/lib/action/index.d.ts

@@ -5,6 +5,7 @@ export { MotionSensorAction } from './motionSensorAction';
 export { PresenceGroupLastLeftAction } from './presenceGroupLastLeftAction';
 export { PresenceGroupFirstEnterAction } from './presenceGroupFirstEnterAction';
 export { ShutterPositionChangedAction } from './shutterPositionChangedAction';
+export { SoilSensorChangeAction } from './soilSensorChangeAction';
 export { TemperatureSensorChangeAction } from './temperatureSensorChangeAction';
 export { ActuatorChangeAction } from './actuatorChangeAction';
 export { BatteryLevelChangeAction } from './batteryLevelChangeAction';

package/lib/action/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DingSensorAction = exports.HandleChangeAction = exports.PresenceGroupAnyMovementAction = exports.BatteryLevelChangeAction = exports.ActuatorChangeAction = exports.TemperatureSensorChangeAction = exports.ShutterPositionChangedAction = exports.PresenceGroupFirstEnterAction = exports.PresenceGroupLastLeftAction = exports.MotionSensorAction = exports.HumiditySensorChangeAction = exports.BaseAction = exports.AirQualitySensorChangeAction = void 0;
+exports.DingSensorAction = exports.HandleChangeAction = exports.PresenceGroupAnyMovementAction = exports.BatteryLevelChangeAction = exports.ActuatorChangeAction = exports.TemperatureSensorChangeAction = exports.SoilSensorChangeAction = exports.ShutterPositionChangedAction = exports.PresenceGroupFirstEnterAction = exports.PresenceGroupLastLeftAction = exports.MotionSensorAction = exports.HumiditySensorChangeAction = exports.BaseAction = exports.AirQualitySensorChangeAction = void 0;
 var airQualitySensorChangeAction_1 = require("./airQualitySensorChangeAction");
 Object.defineProperty(exports, "AirQualitySensorChangeAction", { enumerable: true, get: function () { return airQualitySensorChangeAction_1.AirQualitySensorChangeAction; } });
 var baseAction_1 = require("./baseAction");
@@ -15,6 +15,8 @@ var presenceGroupFirstEnterAction_1 = require("./presenceGroupFirstEnterAction")
 Object.defineProperty(exports, "PresenceGroupFirstEnterAction", { enumerable: true, get: function () { return presenceGroupFirstEnterAction_1.PresenceGroupFirstEnterAction; } });
 var shutterPositionChangedAction_1 = require("./shutterPositionChangedAction");
 Object.defineProperty(exports, "ShutterPositionChangedAction", { enumerable: true, get: function () { return shutterPositionChangedAction_1.ShutterPositionChangedAction; } });
+var soilSensorChangeAction_1 = require("./soilSensorChangeAction");
+Object.defineProperty(exports, "SoilSensorChangeAction", { enumerable: true, get: function () { return soilSensorChangeAction_1.SoilSensorChangeAction; } });
 var temperatureSensorChangeAction_1 = require("./temperatureSensorChangeAction");
 Object.defineProperty(exports, "TemperatureSensorChangeAction", { enumerable: true, get: function () { return temperatureSensorChangeAction_1.TemperatureSensorChangeAction; } });
 var actuatorChangeAction_1 = require("./actuatorChangeAction");

package/lib/action/soilSensorChangeAction.d.ts

@@ -0,0 +1,16 @@
+import { BaseAction } from './baseAction';
+import { CommandType } from '../enums';
+import { iSoilCollector } from '../interfaces';
+export declare class SoilSensorChangeAction extends BaseAction {
+    /** @inheritDoc */
+    type: CommandType;
+    /**
+     * The new soil moisture in percent
+     */
+    readonly newSoilMoisture: number;
+    /**
+     * The sensor that triggered the action
+     */
+    readonly sensor: iSoilCollector;
+    constructor(sensor: iSoilCollector, newSoilMoisture: number);
+}

package/lib/action/soilSensorChangeAction.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SoilSensorChangeAction = void 0;
+const baseAction_1 = require("./baseAction");
+const enums_1 = require("../enums");
+class SoilSensorChangeAction extends baseAction_1.BaseAction {
+    constructor(sensor, newSoilMoisture) {
+        super(enums_1.CommandSource.Automatic, `${sensor.customName} detected ${newSoilMoisture}% soil moisture`);
+        /** @inheritDoc */
+        this.type = enums_1.CommandType.SoilSensorChangeAction;
+        this.newSoilMoisture = newSoilMoisture;
+        this.sensor = sensor;
+    }
+}
+exports.SoilSensorChangeAction = SoilSensorChangeAction;

package/lib/devices/device-cluster.js

@@ -58,6 +58,13 @@ class DeviceCluster {
                 clusterTypes.push(enums_1.DeviceClusterType.TemperaturSensor);
                 clusterTypes.push(enums_1.DeviceClusterType.HumiditySensor);
                 break;
+            case enums_1.DeviceType.ZigbeeCooloSoilSensor:
+                // Counts towards the room aggregates as well: this sensor sits in a pot indoors, so its air readings
+                // are readings of the room air. A sensor in a bed or a lawn would only get the soil cluster.
+                clusterTypes.push(enums_1.DeviceClusterType.SoilSensor);
+                clusterTypes.push(enums_1.DeviceClusterType.TemperaturSensor);
+                clusterTypes.push(enums_1.DeviceClusterType.HumiditySensor);
+                break;
             case enums_1.DeviceType.HmIpGriff:
                 clusterTypes.push(enums_1.DeviceClusterType.Handle);
                 break;

package/lib/devices/devices.js

@@ -229,6 +229,9 @@ class Devices {
             case 'BlitzShp':
                 d = new zigbee_1.ZigbeeBlitzShp(zigbeeInfo);
                 break;
+            case 'CooloSoil':
+                d = new zigbee_1.ZigbeeCooloSoilSensor(zigbeeInfo);
+                break;
             case 'HeimanSmoke':
                 d = new zigbee_1.ZigbeeHeimanSmoke(zigbeeInfo);
                 break;

package/lib/devices/sharedFunctions/index.d.ts

@@ -4,4 +4,5 @@ export * from './handleSensor';
 export * from './humiditySensor';
 export * from './lampUtils';
 export * from './shutterUtils';
+export * from './soilSensor';
 export * from './temperatureSensor';

package/lib/devices/sharedFunctions/index.js

@@ -20,4 +20,5 @@ __exportStar(require("./handleSensor"), exports);
 __exportStar(require("./humiditySensor"), exports);
 __exportStar(require("./lampUtils"), exports);
 __exportStar(require("./shutterUtils"), exports);
+__exportStar(require("./soilSensor"), exports);
 __exportStar(require("./temperatureSensor"), exports);

package/lib/devices/sharedFunctions/soilSensor.d.ts

@@ -0,0 +1,23 @@
+import { iSoilCollector, iSoilSensor } from '../../interfaces';
+import { SoilSensorChangeAction } from '../../action';
+export declare class SoilSensor implements iSoilSensor {
+    private readonly _device;
+    /** @inheritDoc */
+    readonly jsonOmitKeys: string[];
+    private _soilMoistureCallbacks;
+    private _soilMoisture;
+    private readonly _persistSoilSensorInterval;
+    constructor(_device: iSoilCollector);
+    /** @inheritDoc */
+    get soilMoisture(): number;
+    /** @inheritDoc */
+    set soilMoisture(val: number);
+    /** @inheritDoc */
+    persist(): void;
+    /** @inheritDoc */
+    addSoilMoistureCallback(pCallback: (action: SoilSensorChangeAction) => void): void;
+    /** @inheritDoc */
+    dispose(): void;
+    /** @inheritDoc */
+    toJSON(): Partial<SoilSensor>;
+}

package/lib/devices/sharedFunctions/soilSensor.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SoilSensor = void 0;
+const interfaces_1 = require("../../interfaces");
+const action_1 = require("../../action");
+const utils_1 = require("../../utils");
+const services_1 = require("../../services");
+class SoilSensor {
+    constructor(_device) {
+        this._device = _device;
+        /** @inheritDoc */
+        this.jsonOmitKeys = ['_device'];
+        this._soilMoistureCallbacks = [];
+        this._soilMoisture = interfaces_1.UNDEFINED_SOIL_MOISTURE_VALUE;
+        this._persistSoilSensorInterval = utils_1.Utils.guardedInterval(() => {
+            this.persist();
+        }, 5 * 60 * 1000, this, false);
+    }
+    /** @inheritDoc */
+    get soilMoisture() {
+        return this._soilMoisture;
+    }
+    /** @inheritDoc */
+    set soilMoisture(val) {
+        this._soilMoisture = val;
+        for (const cb of this._soilMoistureCallbacks) {
+            cb(new action_1.SoilSensorChangeAction(this._device, val));
+        }
+    }
+    /** @inheritDoc */
+    persist() {
+        var _a;
+        if (this._soilMoisture === interfaces_1.UNDEFINED_SOIL_MOISTURE_VALUE) {
+            // Nothing was ever reported --> persisting would only write a row of the sentinel, which reads like a
+            // measured -1 % in every later query.
+            return;
+        }
+        (_a = services_1.Persistence.dbo) === null || _a === void 0 ? void 0 : _a.persistSoilSensor(this._device);
+    }
+    /** @inheritDoc */
+    addSoilMoistureCallback(pCallback) {
+        this._soilMoistureCallbacks.push(pCallback);
+        if (this._soilMoisture !== interfaces_1.UNDEFINED_SOIL_MOISTURE_VALUE) {
+            pCallback(new action_1.SoilSensorChangeAction(this._device, this._soilMoisture));
+        }
+    }
+    /** @inheritDoc */
+    dispose() {
+        if (this._persistSoilSensorInterval) {
+            clearInterval(this._persistSoilSensorInterval);
+        }
+    }
+    /** @inheritDoc */
+    toJSON() {
+        return utils_1.Utils.jsonFilter(this, this.jsonOmitKeys);
+    }
+}
+exports.SoilSensor = SoilSensor;

package/lib/devices/zigbee/BaseDevices/index.d.ts

@@ -6,6 +6,7 @@ export * from './zigbeeLedRGBCCT';
 export * from './zigbeeMagnetContact';
 export * from './zigbeeMotionSensor';
 export * from './zigbeeShutter';
+export * from './zigbeeSoilSensor';
 export * from './zigbeeSwitch';
 export { ZigbeeLamp } from './zigbeeLamp';
 export { ZigbeeWindowHandle } from './zigbeeWindowHandle';

package/lib/devices/zigbee/BaseDevices/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./zigbeeLedRGBCCT"), exports);
 __exportStar(require("./zigbeeMagnetContact"), exports);
 __exportStar(require("./zigbeeMotionSensor"), exports);
 __exportStar(require("./zigbeeShutter"), exports);
+__exportStar(require("./zigbeeSoilSensor"), exports);
 __exportStar(require("./zigbeeSwitch"), exports);
 var zigbeeLamp_1 = require("./zigbeeLamp");
 Object.defineProperty(exports, "ZigbeeLamp", { enumerable: true, get: function () { return zigbeeLamp_1.ZigbeeLamp; } });

package/lib/devices/zigbee/BaseDevices/zigbeeSoilSensor.d.ts

@@ -0,0 +1,33 @@
+import { iBatteryDevice, iSoilCollector, iSoilSensor } from '../../../interfaces';
+import { BatteryLevelChangeAction, SoilSensorChangeAction } from '../../../action';
+import { ZigbeeDevice } from './zigbeeDevice';
+import { Battery } from '../../sharedFunctions';
+import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
+import { DeviceType } from '../../../enums';
+/**
+ * The common part of every zigbee device measuring the moisture of the soil it sits in.
+ *
+ * Carries the smallest honest contract: soil moisture and battery, the two states every such sensor reports.
+ * Ambient temperature and humidity are deliberately NOT here - a sensor that only reads the soil would then
+ * claim capabilities it does not have. A device that measures them adds those axes itself, see
+ * {@link ZigbeeCooloSoilSensor}.
+ */
+export declare class ZigbeeSoilSensor extends ZigbeeDevice implements iSoilCollector, iBatteryDevice {
+    /** @inheritDoc */
+    soilSensor: iSoilSensor;
+    /** @inheritDoc */
+    battery: Battery;
+    constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
+    /** @inheritDoc */
+    get batteryLevel(): number;
+    /** @inheritDoc */
+    get soilMoisture(): number;
+    /** @inheritDoc */
+    addBatteryLevelCallback(pCallback: (action: BatteryLevelChangeAction) => void): void;
+    /** @inheritDoc */
+    addSoilMoistureCallback(pCallback: (action: SoilSensorChangeAction) => void): void;
+    /** @inheritDoc */
+    update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
+    /** @inheritDoc */
+    dispose(): void;
+}

package/lib/devices/zigbee/BaseDevices/zigbeeSoilSensor.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZigbeeSoilSensor = void 0;
+const zigbeeDevice_1 = require("./zigbeeDevice");
+const sharedFunctions_1 = require("../../sharedFunctions");
+const enums_1 = require("../../../enums");
+/**
+ * The common part of every zigbee device measuring the moisture of the soil it sits in.
+ *
+ * Carries the smallest honest contract: soil moisture and battery, the two states every such sensor reports.
+ * Ambient temperature and humidity are deliberately NOT here - a sensor that only reads the soil would then
+ * claim capabilities it does not have. A device that measures them adds those axes itself, see
+ * {@link ZigbeeCooloSoilSensor}.
+ */
+class ZigbeeSoilSensor extends zigbeeDevice_1.ZigbeeDevice {
+    constructor(pInfo, pType) {
+        super(pInfo, pType);
+        /** @inheritDoc */
+        this.soilSensor = new sharedFunctions_1.SoilSensor(this);
+        /** @inheritDoc */
+        this.battery = new sharedFunctions_1.Battery(this);
+        this.deviceCapabilities.push(enums_1.DeviceCapability.soilSensor);
+        this.deviceCapabilities.push(enums_1.DeviceCapability.batteryDriven);
+    }
+    /** @inheritDoc */
+    get batteryLevel() {
+        return this.battery.level;
+    }
+    /** @inheritDoc */
+    get soilMoisture() {
+        return this.soilSensor.soilMoisture;
+    }
+    /** @inheritDoc */
+    addBatteryLevelCallback(pCallback) {
+        this.battery.addBatteryLevelCallback(pCallback);
+    }
+    /** @inheritDoc */
+    addSoilMoistureCallback(pCallback) {
+        this.soilSensor.addSoilMoistureCallback(pCallback);
+    }
+    /** @inheritDoc */
+    update(idSplit, state, initial = false) {
+        super.update(idSplit, state, initial, true);
+        switch (idSplit[3]) {
+            case 'battery':
+                this.battery.level = state.val;
+                if (this.batteryLevel < 20) {
+                    this.log(enums_1.LogLevel.Warn, 'Das Zigbee Gerät hat unter 20% Batterie.');
+                }
+                break;
+            case 'soil_moisture':
+                this.soilSensor.soilMoisture = state.val;
+                break;
+        }
+    }
+    /** @inheritDoc */
+    dispose() {
+        this.soilSensor.dispose();
+        super.dispose();
+    }
+}
+exports.ZigbeeSoilSensor = ZigbeeSoilSensor;

package/lib/devices/zigbee/index.d.ts

@@ -6,6 +6,7 @@ export * from './zigbeeAqaraPresence';
 export * from './zigbeeAquaraVibra';
 export * from './zigbeeAquaraWater';
 export * from './zigbeeBlitzShp';
+export * from './zigbeeCooloSoilSensor';
 export * from './zigbeeEuroHeater';
 export * from './zigbeeHeimanSmoke';
 export * from './zigbeeIkeaSteckdose';

package/lib/devices/zigbee/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./zigbeeAqaraPresence"), exports);
 __exportStar(require("./zigbeeAquaraVibra"), exports);
 __exportStar(require("./zigbeeAquaraWater"), exports);
 __exportStar(require("./zigbeeBlitzShp"), exports);
+__exportStar(require("./zigbeeCooloSoilSensor"), exports);
 __exportStar(require("./zigbeeEuroHeater"), exports);
 __exportStar(require("./zigbeeHeimanSmoke"), exports);
 __exportStar(require("./zigbeeIkeaSteckdose"), exports);

package/lib/devices/zigbee/zigbeeCooloSoilSensor.d.ts

@@ -0,0 +1,44 @@
+import { iHumidityCollector, iHumiditySensor, iTemperatureCollector } from '../../interfaces';
+import { HumiditySensorChangeAction, TemperatureSensorChangeAction } from '../../action';
+import { ZigbeeSoilSensor } from './BaseDevices';
+import { TemperatureSensor } from '../sharedFunctions';
+import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
+/**
+ * The COOLO CS-201Z soil sensor.
+ *
+ * Beyond the soil moisture and battery of {@link ZigbeeSoilSensor} it measures the air around it, so it adds
+ * the ambient temperature and humidity axes. Those are three separate quantities: `soil_moisture` and
+ * `humidity` are both percentages and can be told apart by nothing but which state they arrived on - the
+ * device reported 15 % soil against 91 % air on the same message.
+ *
+ * The configuration states the device exposes (`soil_calibration`, `soil_warning`, `temperature_calibration`,
+ * `temperature_sampling`, `soil_sampling`, `temperature_unit`) and the `dry` flag it derives from its own
+ * threshold are deliberately not mapped. They stay reachable through `stateMap` and `send_payload`.
+ */
+export declare class ZigbeeCooloSoilSensor extends ZigbeeSoilSensor implements iTemperatureCollector, iHumidityCollector {
+    /** @inheritDoc */
+    temperatureSensor: TemperatureSensor;
+    /** @inheritDoc */
+    humiditySensor: iHumiditySensor;
+    constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
+    get roomTemperature(): number;
+    /** @inheritDoc */
+    set roomTemperature(value: number);
+    /** @inheritDoc */
+    get humidity(): number;
+    /** @inheritDoc */
+    get iTemperature(): number;
+    /** @inheritDoc */
+    get sTemperature(): string;
+    /** @inheritDoc */
+    addHumidityCallback(pCallback: (action: HumiditySensorChangeAction) => void): void;
+    /** @inheritDoc */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    /** @inheritDoc */
+    onTemperaturChange(newTemperatur: number): void;
+    /** @inheritDoc */
+    update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
+    /** @inheritDoc */
+    dispose(): void;
+}

package/lib/devices/zigbee/zigbeeCooloSoilSensor.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZigbeeCooloSoilSensor = void 0;
+const BaseDevices_1 = require("./BaseDevices");
+const sharedFunctions_1 = require("../sharedFunctions");
+const enums_1 = require("../../enums");
+/**
+ * The COOLO CS-201Z soil sensor.
+ *
+ * Beyond the soil moisture and battery of {@link ZigbeeSoilSensor} it measures the air around it, so it adds
+ * the ambient temperature and humidity axes. Those are three separate quantities: `soil_moisture` and
+ * `humidity` are both percentages and can be told apart by nothing but which state they arrived on - the
+ * device reported 15 % soil against 91 % air on the same message.
+ *
+ * The configuration states the device exposes (`soil_calibration`, `soil_warning`, `temperature_calibration`,
+ * `temperature_sampling`, `soil_sampling`, `temperature_unit`) and the `dry` flag it derives from its own
+ * threshold are deliberately not mapped. They stay reachable through `stateMap` and `send_payload`.
+ */
+class ZigbeeCooloSoilSensor extends BaseDevices_1.ZigbeeSoilSensor {
+    constructor(pInfo) {
+        super(pInfo, enums_1.DeviceType.ZigbeeCooloSoilSensor);
+        /** @inheritDoc */
+        this.temperatureSensor = new sharedFunctions_1.TemperatureSensor(this);
+        /** @inheritDoc */
+        this.humiditySensor = new sharedFunctions_1.HumiditySensor(this);
+        this.deviceCapabilities.push(enums_1.DeviceCapability.temperatureSensor);
+        this.deviceCapabilities.push(enums_1.DeviceCapability.humiditySensor);
+    }
+    /** @inheritDoc */
+    get roomTemperature() {
+        return this.temperatureSensor.roomTemperature;
+    }
+    /** @inheritDoc */
+    set roomTemperature(value) {
+        this.temperatureSensor.roomTemperature = value;
+    }
+    /** @inheritDoc */
+    get humidity() {
+        return this.humiditySensor.humidity;
+    }
+    /** @inheritDoc */
+    get iTemperature() {
+        return this.temperatureSensor.temperature;
+    }
+    /** @inheritDoc */
+    get sTemperature() {
+        return `${this.temperatureSensor.temperature}°C`;
+    }
+    /** @inheritDoc */
+    addHumidityCallback(pCallback) {
+        this.humiditySensor.addHumidityCallback(pCallback);
+    }
+    /** @inheritDoc */
+    addTempChangeCallback(pCallback) {
+        this.temperatureSensor.addTempChangeCallback(pCallback);
+    }
+    /** @inheritDoc */
+    onTemperaturChange(newTemperatur) {
+        this.roomTemperature = newTemperatur;
+    }
+    /** @inheritDoc */
+    update(idSplit, state, initial = false) {
+        // The base class handles `soil_moisture` and `battery`; these two are the air around the pot.
+        super.update(idSplit, state, initial);
+        switch (idSplit[3]) {
+            case 'humidity':
+                this.humiditySensor.humidity = state.val;
+                break;
+            case 'temperature':
+                this.temperatureSensor.temperature = state.val;
+                break;
+        }
+    }
+    /** @inheritDoc */
+    dispose() {
+        this.temperatureSensor.dispose();
+        this.humiditySensor.dispose();
+        super.dispose();
+    }
+}
+exports.ZigbeeCooloSoilSensor = ZigbeeCooloSoilSensor;

package/lib/enums/DeviceCapability.d.ts

@@ -24,6 +24,7 @@ export declare enum DeviceCapability {
     magnetSensor = 22,
     airQualitySensor = 23,
     fossilGenerator = 24,
+    soilSensor = 25,
     bluetoothDetector = 101,
     trackableDevice = 102,
     scene = 103,

package/lib/enums/DeviceCapability.js

@@ -28,6 +28,7 @@ var DeviceCapability;
     DeviceCapability[DeviceCapability["magnetSensor"] = 22] = "magnetSensor";
     DeviceCapability[DeviceCapability["airQualitySensor"] = 23] = "airQualitySensor";
     DeviceCapability[DeviceCapability["fossilGenerator"] = 24] = "fossilGenerator";
+    DeviceCapability[DeviceCapability["soilSensor"] = 25] = "soilSensor";
     DeviceCapability[DeviceCapability["bluetoothDetector"] = 101] = "bluetoothDetector";
     DeviceCapability[DeviceCapability["trackableDevice"] = 102] = "trackableDevice";
     DeviceCapability[DeviceCapability["scene"] = 103] = "scene";

package/lib/enums/commandType.d.ts

@@ -29,6 +29,7 @@ export declare enum CommandType {
     RoomRestoreLightCommand = "RoomRestoreLightCommand",
     RoomSetLightTimeBasedCommand = "RoomSetLightTimeBasedCommand",
     ShutterPositionChangedAction = "ShutterPositionChangedAction",
+    SoilSensorChangeAction = "SoilSensorChangeAction",
     ShutterSetLevelCommand = "ShutterSetLevelCommand",
     ShutterSunriseUpCommand = "ShutterSunriseUpCommand",
     SunsetDownCommand = "SunsetDownCommand",

package/lib/enums/commandType.js

@@ -33,6 +33,7 @@ var CommandType;
     CommandType["RoomRestoreLightCommand"] = "RoomRestoreLightCommand";
     CommandType["RoomSetLightTimeBasedCommand"] = "RoomSetLightTimeBasedCommand";
     CommandType["ShutterPositionChangedAction"] = "ShutterPositionChangedAction";
+    CommandType["SoilSensorChangeAction"] = "SoilSensorChangeAction";
     CommandType["ShutterSetLevelCommand"] = "ShutterSetLevelCommand";
     CommandType["ShutterSunriseUpCommand"] = "ShutterSunriseUpCommand";
     CommandType["SunsetDownCommand"] = "SunsetDownCommand";

package/lib/enums/device-cluster-type.d.ts

@@ -19,5 +19,6 @@ export declare enum DeviceClusterType {
     Ac = 18,
     WLED = 19,
     Tv = 20,
-    Camera = 21
+    Camera = 21,
+    SoilSensor = 22
 }

package/lib/enums/device-cluster-type.js

@@ -24,4 +24,5 @@ var DeviceClusterType;
     DeviceClusterType[DeviceClusterType["WLED"] = 19] = "WLED";
     DeviceClusterType[DeviceClusterType["Tv"] = 20] = "Tv";
     DeviceClusterType[DeviceClusterType["Camera"] = 21] = "Camera";
+    DeviceClusterType[DeviceClusterType["SoilSensor"] = 22] = "SoilSensor";
 })(DeviceClusterType || (exports.DeviceClusterType = DeviceClusterType = {}));

package/lib/enums/deviceType.d.ts

@@ -41,6 +41,7 @@ export declare enum DeviceType {
     ZigbeeSodaHandle = 227,
     ZigbeeTuyaMotion = 228,
     ZigbeeAqaraPresence = 229,
+    ZigbeeCooloSoilSensor = 230,
     JsEnergyManager = 301,
     RoomScene = 401,
     ShellyTrv = 402,

package/lib/enums/deviceType.js

@@ -45,6 +45,7 @@ var DeviceType;
     DeviceType[DeviceType["ZigbeeSodaHandle"] = 227] = "ZigbeeSodaHandle";
     DeviceType[DeviceType["ZigbeeTuyaMotion"] = 228] = "ZigbeeTuyaMotion";
     DeviceType[DeviceType["ZigbeeAqaraPresence"] = 229] = "ZigbeeAqaraPresence";
+    DeviceType[DeviceType["ZigbeeCooloSoilSensor"] = 230] = "ZigbeeCooloSoilSensor";
     DeviceType[DeviceType["JsEnergyManager"] = 301] = "JsEnergyManager";
     DeviceType[DeviceType["RoomScene"] = 401] = "RoomScene";
     DeviceType[DeviceType["ShellyTrv"] = 402] = "ShellyTrv";

package/lib/interfaces/baseDevices/iSoilCollector.d.ts

@@ -0,0 +1,23 @@
+import { iRoomDevice } from './iRoomDevice';
+import { SoilSensorChangeAction } from '../../action';
+import { iSoilSensor } from './iSoilSensor';
+/**
+ * This interface represents a device measuring the moisture of the soil it sits in.
+ *
+ * For devices with {@link DeviceCapability.soilSensor} capability.
+ */
+export interface iSoilCollector extends iRoomDevice {
+    /**
+     * Service which handles common aspects of the soil sensor like persisting
+     */
+    readonly soilSensor: iSoilSensor;
+    /**
+     * The current soil moisture in percent
+     */
+    readonly soilMoisture: number;
+    /**
+     * Add a callback that is called when the soil moisture changes
+     * @param pCallback - The callback to fire
+     */
+    addSoilMoistureCallback(pCallback: (action: SoilSensorChangeAction) => void): void;
+}

package/lib/interfaces/baseDevices/iSoilCollector.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/baseDevices/iSoilSensor.d.ts

@@ -0,0 +1,32 @@
+import { iJsonOmitKeys } from '../iJsonOmitKeys';
+import { SoilSensorChangeAction } from '../../action';
+/**
+ * Common handling for a device measuring the moisture of the soil it sits in.
+ *
+ * Deliberately its own axis rather than a second {@link iHumiditySensor}: a device can measure the moisture of
+ * the soil and the humidity of the air around it at the same time, and those are two different quantities that
+ * happen to share a unit. Sharing the slot would force one of the two readings out.
+ */
+export interface iSoilSensor extends iJsonOmitKeys {
+    /**
+     * The current soil moisture in percent, or {@link UNDEFINED_SOIL_MOISTURE_VALUE} while nothing was reported
+     */
+    soilMoisture: number;
+    /**
+     * Persists the current soil moisture to the database
+     */
+    persist(): void;
+    /**
+     * Adds a callback to be called when the soil moisture changes
+     * @param pCallback - The callback to be called
+     */
+    addSoilMoistureCallback(pCallback: (action: SoilSensorChangeAction) => void): void;
+    /**
+     * Frees up the resources of this sensor
+     */
+    dispose(): void;
+    /**
+     * @returns The serializable representation of this sensor
+     */
+    toJSON(): Partial<iSoilSensor>;
+}

package/lib/interfaces/baseDevices/iSoilSensor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/baseDevices/index.d.ts

@@ -15,8 +15,11 @@ export * from './iHeater';
 export * from './iAirQualityCollector';
 export * from './iAirQualityReadings';
 export * from './iAirQualitySensor';
+export * from './iSoilCollector';
+export * from './iSoilSensor';
 export * from './undefinedAirQualityValue';
 export * from './undefinedHumidityValue';
+export * from './undefinedSoilMoistureValue';
 export * from './undefinedTempValue';
 export * from './iHumidityCollector';
 export * from './iIlluminationSensor';

package/lib/interfaces/baseDevices/index.js

@@ -30,8 +30,11 @@ __exportStar(require("./iHeater"), exports);
 __exportStar(require("./iAirQualityCollector"), exports);
 __exportStar(require("./iAirQualityReadings"), exports);
 __exportStar(require("./iAirQualitySensor"), exports);
+__exportStar(require("./iSoilCollector"), exports);
+__exportStar(require("./iSoilSensor"), exports);
 __exportStar(require("./undefinedAirQualityValue"), exports);
 __exportStar(require("./undefinedHumidityValue"), exports);
+__exportStar(require("./undefinedSoilMoistureValue"), exports);
 __exportStar(require("./undefinedTempValue"), exports);
 __exportStar(require("./iHumidityCollector"), exports);
 __exportStar(require("./iIlluminationSensor"), exports);

package/lib/interfaces/baseDevices/undefinedSoilMoistureValue.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The value reported while a device has no soil moisture reading of its own yet.
+ *
+ * Negative on purpose: soil moisture is a percentage, so no reading the sensor can take collides with it.
+ */
+export declare const UNDEFINED_SOIL_MOISTURE_VALUE = -1;

package/lib/interfaces/baseDevices/undefinedSoilMoistureValue.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNDEFINED_SOIL_MOISTURE_VALUE = void 0;
+/**
+ * The value reported while a device has no soil moisture reading of its own yet.
+ *
+ * Negative on purpose: soil moisture is a percentage, so no reading the sensor can take collides with it.
+ */
+exports.UNDEFINED_SOIL_MOISTURE_VALUE = -1;