hoffmation-base 3.8.0 → 4.1.0

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

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

package/lib/enums/DeviceCapability.js

@@ -27,6 +27,8 @@ var DeviceCapability;
     DeviceCapability[DeviceCapability["garageDoorOpener"] = 21] = "garageDoorOpener";
     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/iAirQualityCollector.d.ts

@@ -1,6 +1,7 @@
 import { iRoomDevice } from './iRoomDevice';
 import { AirQualitySensorChangeAction } from '../../action';
-import { iAirQualityReadings, iAirQualitySensor } from './iAirQualitySensor';
+import { iAirQualityReadings } from './iAirQualityReadings';
+import { iAirQualitySensor } from './iAirQualitySensor';
 /**
  * This interface represents a device measuring air quality.
  *

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

@@ -0,0 +1,50 @@
+/**
+ * The set of air quality metrics a sensor can report.
+ *
+ * Devices differ widely in what they measure, so every member is always present but defaults to
+ * `UNDEFINED_AIR_QUALITY_VALUE` until the device reports it. This mirrors the sentinel approach of
+ * `UNDEFINED_TEMP_VALUE` and spares consumers a null check on every metric; use
+ * {@link iAirQualitySensor.reports} to tell "not measured" apart from a measured zero.
+ */
+export interface iAirQualityReadings {
+    /**
+     * The air quality index as calculated by the device (lower is better)
+     */
+    aqi: number;
+    /**
+     * The carbon dioxide concentration in ppm
+     */
+    co2: number;
+    /**
+     * The nitrogen oxide index (1 equals background level)
+     */
+    nox: number;
+    /**
+     * Particulate matter up to 1.0 µm in µg/m³
+     */
+    pm1p0: number;
+    /**
+     * Particulate matter up to 2.5 µm in µg/m³
+     */
+    pm2p5: number;
+    /**
+     * Particulate matter up to 4.0 µm in µg/m³
+     */
+    pm4p0: number;
+    /**
+     * Particulate matter up to 10.0 µm in µg/m³
+     */
+    pm10p0: number;
+    /**
+     * The total volatile organic compounds in ppb
+     */
+    tvoc: number;
+    /**
+     * The vape detection reading of the device
+     */
+    vape: number;
+    /**
+     * The volatile organic compounds index (100 equals background level)
+     */
+    voc: number;
+}

package/lib/interfaces/baseDevices/iAirQualityReadings.js

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

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

@@ -1,59 +1,6 @@
 import { iJsonOmitKeys } from '../iJsonOmitKeys';
 import { AirQualitySensorChangeAction } from '../../action';
-/**
- * The value reported for a metric the sensor does not measure or has not reported yet.
- */
-export declare const UNDEFINED_AIR_QUALITY_VALUE = -1;
-/**
- * The set of air quality metrics a sensor can report.
- *
- * Devices differ widely in what they measure, so every member is always present but defaults to
- * {@link UNDEFINED_AIR_QUALITY_VALUE} until the device reports it. This mirrors the sentinel approach of
- * {@link UNDEFINED_TEMP_VALUE} and spares consumers a null check on every metric; use
- * {@link iAirQualitySensor.reports} to tell "not measured" apart from a measured zero.
- */
-export interface iAirQualityReadings {
-    /**
-     * The air quality index as calculated by the device (lower is better)
-     */
-    aqi: number;
-    /**
-     * The carbon dioxide concentration in ppm
-     */
-    co2: number;
-    /**
-     * The nitrogen oxide index (1 equals background level)
-     */
-    nox: number;
-    /**
-     * Particulate matter up to 1.0 µm in µg/m³
-     */
-    pm1p0: number;
-    /**
-     * Particulate matter up to 2.5 µm in µg/m³
-     */
-    pm2p5: number;
-    /**
-     * Particulate matter up to 4.0 µm in µg/m³
-     */
-    pm4p0: number;
-    /**
-     * Particulate matter up to 10.0 µm in µg/m³
-     */
-    pm10p0: number;
-    /**
-     * The total volatile organic compounds in ppb
-     */
-    tvoc: number;
-    /**
-     * The vape detection reading of the device
-     */
-    vape: number;
-    /**
-     * The volatile organic compounds index (100 equals background level)
-     */
-    voc: number;
-}
+import { iAirQualityReadings } from './iAirQualityReadings';
 /**
  * Common handling for a device measuring air quality.
  */

package/lib/interfaces/baseDevices/iAirQualitySensor.js

@@ -1,7 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UNDEFINED_AIR_QUALITY_VALUE = void 0;
-/**
- * The value reported for a metric the sensor does not measure or has not reported yet.
- */
-exports.UNDEFINED_AIR_QUALITY_VALUE = -1;

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

@@ -1,6 +1,8 @@
 import { iBaseDevice } from './iBaseDevice';
 import { iDisposable } from '../iDisposeable';
+import { iEnergyHistoryOutlook } from '../iEnergyHistoryOutlook';
 import { iExcessEnergyConsumer } from './iExcessEnergyConsumer';
+import { iMorningReserveVerdict } from '../iMorningReserveVerdict';
 /**
  * Interface for devices that can manage energy consumption and production.
  *
@@ -17,6 +19,47 @@ export interface iEnergyManager extends iBaseDevice, iDisposable {
      * Whether the Energy Manager actively blocks AC
      */
     readonly acBlocked: boolean;
+    /**
+     * What the plant's own recorded history says about the coming morning low, or `undefined` while this
+     * manager cannot say anything about it - no battery, no stated capacity, or no charge level to project
+     * from.
+     *
+     * **Read, not asked with a charge level.** The level of the plant's battery is the manager's own, and a
+     * consumer that handed one in could hand in a different number than the manager itself reads. It is also
+     * why the guard against the "no reading" marker of {@link iBatteryDevice.batteryLevel} lives here, once,
+     * rather than in every consumer.
+     *
+     * **Free to read.** This getter must stay pure arithmetic over what was already read, so that a consumer
+     * asking on every one of its own decisions costs no query and no request quota. The reading itself is driven
+     * separately, from the manager's own loop.
+     *
+     * **Delegate, do not implement.** `EnergyManagerUtils.morningOutlook(this)` answers it for any manager, and
+     * `EnergyManagerUtils.refreshEnergyHistory(this)` in the manager's loop drives the reading - the same pair
+     * both managers in this repository use. There is one energy manager per installation, so the shared
+     * implementation keeps one reading and one shadow record; a manager that builds its own would pay the
+     * bounded weather backfill twice and split that record in half.
+     *
+     * The answer states facts about the plant and no arithmetic on them. The judgement that goes with it is
+     * {@link morningReserveVerdict}; read that one unless you genuinely need the raw quantities.
+     */
+    readonly morningOutlook: iEnergyHistoryOutlook | undefined;
+    /**
+     * Whether the plant expects the coming morning to hold the reserve its battery must not fall below, or
+     * `undefined` while it can say neither.
+     *
+     * **The judgement belongs here, not to the asking consumer.** How low the morning may get is a property of
+     * the battery, and how little sun still counts as none a property of the plant's photovoltaic - a fuel
+     * burning generator and an air conditioner do not want different answers to that. Where they differ is how
+     * sure they want to be before they act, and that is {@link iMorningReserveVerdict.measured}: the verdicts
+     * that need no fitted model may move something, the modelled ones are reported and left alone.
+     *
+     * **Free to read**, for the same reason {@link morningOutlook} is - pure arithmetic over what was already
+     * read.
+     *
+     * **Delegate, do not implement.** `EnergyManagerUtils.morningReserveVerdict(this, this.morningOutlook)`
+     * answers it for any manager.
+     */
+    readonly morningReserveVerdict: iMorningReserveVerdict | undefined;
     /**
      * The total wattaage being injected into the grid at the moment of last calculation.
      */

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

@@ -1,7 +1,6 @@
 import { iRoomDevice } from './iRoomDevice';
 import { HumiditySensorChangeAction } from '../../action';
 import { iHumiditySensor } from './iHumiditySensor';
-export declare const UNDEFINED_HUMIDITY_VALUE = -1;
 /**
  * This interface represents a humidity sensor device.
  *

package/lib/interfaces/baseDevices/iHumidityCollector.js

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

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/iTemperatureCollector.d.ts

@@ -1,7 +1,6 @@
 import { iRoomDevice } from './iRoomDevice';
 import { TemperatureSensorChangeAction } from '../../action';
 import { iTemperatureSensor } from './iTemperatureSensor';
-export declare const UNDEFINED_TEMP_VALUE = -99;
 /**
  * This interface represents a temperature sensor device.
  *

package/lib/interfaces/baseDevices/iTemperatureCollector.js

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

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

@@ -13,7 +13,14 @@ export * from './iGarageDoorOpener';
 export * from './iHandle';
 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';
 export * from './iLamp';

package/lib/interfaces/baseDevices/index.js

@@ -28,7 +28,14 @@ __exportStar(require("./iGarageDoorOpener"), exports);
 __exportStar(require("./iHandle"), exports);
 __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);
 __exportStar(require("./iLamp"), exports);

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

@@ -0,0 +1,4 @@
+/**
+ * The value reported for a metric the sensor does not measure or has not reported yet.
+ */
+export declare const UNDEFINED_AIR_QUALITY_VALUE = -1;

package/lib/interfaces/baseDevices/undefinedAirQualityValue.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNDEFINED_AIR_QUALITY_VALUE = void 0;
+/**
+ * The value reported for a metric the sensor does not measure or has not reported yet.
+ */
+exports.UNDEFINED_AIR_QUALITY_VALUE = -1;

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

@@ -0,0 +1,4 @@
+/**
+ * The value reported while a device has no humidity reading of its own yet.
+ */
+export declare const UNDEFINED_HUMIDITY_VALUE = -1;

package/lib/interfaces/baseDevices/undefinedHumidityValue.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNDEFINED_HUMIDITY_VALUE = void 0;
+/**
+ * The value reported while a device has no humidity reading of its own yet.
+ */
+exports.UNDEFINED_HUMIDITY_VALUE = -1;

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;

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

@@ -0,0 +1,4 @@
+/**
+ * The value reported while a device has no temperature reading of its own yet.
+ */
+export declare const UNDEFINED_TEMP_VALUE = -99;

package/lib/interfaces/baseDevices/undefinedTempValue.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNDEFINED_TEMP_VALUE = void 0;
+/**
+ * The value reported while a device has no temperature reading of its own yet.
+ */
+exports.UNDEFINED_TEMP_VALUE = -99;

package/lib/interfaces/dachs/KeyListEntity.d.ts

@@ -3,8 +3,3 @@ export interface KeyListEntity {
     doc: string;
     unit: (x: string) => boolean | string | number;
 }
-export interface KeyListEntityResponse<V> {
-    key?: KeyListEntity;
-    rawValue?: string;
-    value: V;
-}

package/lib/interfaces/dachs/KeyListEntityResponse.d.ts

@@ -0,0 +1,6 @@
+import { KeyListEntity } from './KeyListEntity';
+export interface KeyListEntityResponse<V> {
+    key?: KeyListEntity;
+    rawValue?: string;
+    value: V;
+}

package/lib/interfaces/dachs/KeyListEntityResponse.js

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

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

@@ -4,3 +4,4 @@ export * from './influxDbConnectionOptions';
 export * from './IReadKeyList';
 export * from './IWriteKeyList';
 export * from './KeyListEntity';
+export * from './KeyListEntityResponse';

package/lib/interfaces/dachs/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./influxDbConnectionOptions"), exports);
 __exportStar(require("./IReadKeyList"), exports);
 __exportStar(require("./IWriteKeyList"), exports);
 __exportStar(require("./KeyListEntity"), exports);
+__exportStar(require("./KeyListEntityResponse"), exports);

package/lib/interfaces/deviceSettings/iDachsDeviceSettings.d.ts

@@ -73,6 +73,21 @@ export interface iDachsDeviceSettings extends iActuatorSettings {
      * Defines the desired minimum temperature for heat storage during winter.
      */
     winterMinimumPreNightHeatStorageTemp: number;
+    /**
+     * Defines the desired maximum temperature for warm water using dachs outside of winter heating mode.
+     * Applies in place of {@link warmWaterDesiredMaxTemp} whenever the heating mode is not winter.
+     */
+    summerWarmWaterDesiredMaxTemp: number;
+    /**
+     * The rated electrical output of the unit in watt, used to remove its own contribution from a historical day.
+     * @default 5500
+     */
+    dachsRatedElectricalWattage: number;
+    /**
+     * The share of the produced electrical energy that reaches the battery.
+     * @default 0.8
+     */
+    dachsConversionFactor: number;
     /**
      *
      */