hoffmation-base 3.0.0-beta.0 → 3.0.0-beta.1

package/lib/models/deviceSettings/heaterSettings.d.ts

@@ -10,6 +10,10 @@ export declare class HeaterSettings extends DeviceSettings {
      * @default true
      */
     useOwnTemperatur: boolean;
+    /**
+     * Whether this devices temperature measurement should be included in the room temperature calculation.
+     */
+    useOwnTemperatureForRoomTemperature: boolean;
     /**
      * Whether this device should be controlled using only valve position
      * @default false

package/lib/models/deviceSettings/heaterSettings.js

@@ -16,6 +16,10 @@ class HeaterSettings extends deviceSettings_1.DeviceSettings {
          * @default true
          */
         this.useOwnTemperatur = true;
+        /**
+         * Whether this devices temperature measurement should be included in the room temperature calculation.
+         */
+        this.useOwnTemperatureForRoomTemperature = true;
         /**
          * Whether this device should be controlled using only valve position
          * @default false
@@ -55,16 +59,18 @@ class HeaterSettings extends deviceSettings_1.DeviceSettings {
         this.manualDisabled = false;
     }
     fromPartialObject(data) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         this.automaticMode = (_a = data.automaticMode) !== null && _a !== void 0 ? _a : this.automaticMode;
         this.useOwnTemperatur = (_b = data.useOwnTemperatur) !== null && _b !== void 0 ? _b : this.useOwnTemperatur;
-        this.controlByPid = (_c = data.controlByPid) !== null && _c !== void 0 ? _c : this.controlByPid;
-        this.controlByTempDiff = (_d = data.controlByTempDiff) !== null && _d !== void 0 ? _d : this.controlByTempDiff;
-        this.seasonalTurnOffActive = (_e = data.seasonalTurnOffActive) !== null && _e !== void 0 ? _e : this.seasonalTurnOffActive;
-        this.seasonTurnOffDay = (_f = data.seasonTurnOffDay) !== null && _f !== void 0 ? _f : this.seasonTurnOffDay;
-        this.seasonTurnOnDay = (_g = data.seasonTurnOnDay) !== null && _g !== void 0 ? _g : this.seasonTurnOnDay;
-        this.pidForcedMinimum = (_h = data.pidForcedMinimum) !== null && _h !== void 0 ? _h : this.pidForcedMinimum;
-        this.manualDisabled = (_j = data.manualDisabled) !== null && _j !== void 0 ? _j : this.manualDisabled;
+        this.useOwnTemperatureForRoomTemperature =
+            (_c = data.useOwnTemperatureForRoomTemperature) !== null && _c !== void 0 ? _c : this.useOwnTemperatureForRoomTemperature;
+        this.controlByPid = (_d = data.controlByPid) !== null && _d !== void 0 ? _d : this.controlByPid;
+        this.controlByTempDiff = (_e = data.controlByTempDiff) !== null && _e !== void 0 ? _e : this.controlByTempDiff;
+        this.seasonalTurnOffActive = (_f = data.seasonalTurnOffActive) !== null && _f !== void 0 ? _f : this.seasonalTurnOffActive;
+        this.seasonTurnOffDay = (_g = data.seasonTurnOffDay) !== null && _g !== void 0 ? _g : this.seasonTurnOffDay;
+        this.seasonTurnOnDay = (_h = data.seasonTurnOnDay) !== null && _h !== void 0 ? _h : this.seasonTurnOnDay;
+        this.pidForcedMinimum = (_j = data.pidForcedMinimum) !== null && _j !== void 0 ? _j : this.pidForcedMinimum;
+        this.manualDisabled = (_k = data.manualDisabled) !== null && _k !== void 0 ? _k : this.manualDisabled;
         super.fromPartialObject(data);
     }
     toJSON() {

package/lib/server/devices/baseDeviceInterfaces/iHeater.d.ts

@@ -1,12 +1,13 @@
 import { HeaterSettings } from '../../../models';
 import { iRoomDevice } from './iRoomDevice';
 import { iDisposable } from '../../services';
+import { iTemperatureSensor } from './iTemperatureSensor';
 /**
  * This interface represents a heater device.
  *
  * For devices with {@link DeviceCapability.heater} capability.
  */
-export interface iHeater extends iRoomDevice, iDisposable {
+export interface iHeater extends iTemperatureSensor, iRoomDevice, iDisposable {
     /**
      * The settings of the heater
      */
@@ -19,14 +20,6 @@ export interface iHeater extends iRoomDevice, iDisposable {
      * The current valve position of the heater (between 0 and 1.0)
      */
     readonly iLevel: number;
-    /**
-     * The current temperature in degree Celsius of the heater
-     */
-    readonly iTemperature: number;
-    /**
-     * The current room temperature in degree Celsius
-     */
-    readonly roomTemperature: number;
     /**
      * The interval to persist the heater information
      * This mainly enforces the interval to be implemented.
@@ -40,11 +33,6 @@ export interface iHeater extends iRoomDevice, iDisposable {
      * Perform a check to calculate the new desired heater state
      */
     checkAutomaticChange(): void;
-    /**
-     * Informs the heater that the temperature of the room has changed
-     * @param newTemperatur - The new temperature in degree Celsius.
-     */
-    onTemperaturChange(newTemperatur: number): void;
     /**
      * Persists the current heater information to the database
      */

package/lib/server/devices/groups/heatGroup.js

@@ -47,8 +47,13 @@ class HeatGroup extends base_group_1.BaseGroup {
     get temperature() {
         let temp = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         let count = 0;
-        this.getTempSensors().forEach((sensor) => {
-            const sensorValue = sensor.iTemperature;
+        const usedIds = [];
+        this.getHeater().forEach((heaterAsSensor) => {
+            usedIds.push(heaterAsSensor.id);
+            if (!heaterAsSensor.settings.useOwnTemperatureForRoomTemperature) {
+                return;
+            }
+            const sensorValue = heaterAsSensor.iTemperature;
             if (sensorValue === baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE) {
                 return;
             }
@@ -59,11 +64,12 @@ class HeatGroup extends base_group_1.BaseGroup {
             }
             temp = (temp * count + sensorValue) / ++count;
         });
-        this.getHeater().forEach((heaterAsSensor) => {
-            if (!heaterAsSensor.settings.useOwnTemperatur) {
+        this.getTempSensors().forEach((sensor) => {
+            if (usedIds.includes(sensor.id)) {
+                // Heater which correctly implement sensor as well.
                 return;
             }
-            const sensorValue = heaterAsSensor.iTemperature;
+            const sensorValue = sensor.iTemperature;
             if (sensorValue === baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE) {
                 return;
             }
@@ -155,10 +161,15 @@ class HeatGroup extends base_group_1.BaseGroup {
         if (temp == baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE) {
             return;
         }
+        const usedIds = [];
         this.getHeater().forEach((heater) => {
+            usedIds.push(heater.id);
             heater.onTemperaturChange(temp);
         });
         this.getTempSensors().forEach((sensor) => {
+            if (usedIds.includes(sensor.id)) {
+                return;
+            }
             sensor.onTemperaturChange(temp);
         });
         this.getOwnAcDevices().forEach((ac) => {

package/lib/server/devices/shelly/shellyTrv.d.ts

@@ -1,14 +1,16 @@
 import { ShellyDevice } from './shellyDevice';
-import { iBatteryDevice, iHeater } from '../baseDeviceInterfaces';
-import { HeaterSettings } from '../../../models';
+import { iBatteryDevice, iHeater, iTemperatureSensor } from '../baseDeviceInterfaces';
+import { HeaterSettings, TemperatureSensorChangeAction } from '../../../models';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
-import { Battery } from '../sharedFunctions';
-export declare class ShellyTrv extends ShellyDevice implements iHeater, iBatteryDevice {
+import { Battery, TemperatureSensor } from '../sharedFunctions';
+export declare class ShellyTrv extends ShellyDevice implements iHeater, iTemperatureSensor, iBatteryDevice {
     /** @inheritDoc */
     readonly battery: Battery;
     /** @inheritDoc */
     settings: HeaterSettings;
     /** @inheritDoc */
+    temperatureSensor: TemperatureSensor;
+    /** @inheritDoc */
     readonly persistHeaterInterval: NodeJS.Timeout;
     protected _seasonTurnOff: boolean;
     protected _roomTemperature: number;
@@ -19,7 +21,6 @@ export declare class ShellyTrv extends ShellyDevice implements iHeater, iBattery
     private _level;
     private _minimumValveLevel;
     private _recalcTimeout;
-    private _temperatur;
     private _targetTempVal;
     private _desiredTemperatur;
     private _useExternalTemperatureEnabled;
@@ -47,9 +48,13 @@ export declare class ShellyTrv extends ShellyDevice implements iHeater, iBattery
     /** @inheritDoc */
     get iTemperature(): number;
     /** @inheritDoc */
+    get sTemperature(): string;
+    /** @inheritDoc */
     get roomTemperature(): number;
     private set roomTemperatur(value);
     /** @inheritDoc */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    /** @inheritDoc */
     checkAutomaticChange(): void;
     /** @inheritDoc */
     onTemperaturChange(newTemperatur: number): void;

package/lib/server/devices/shelly/shellyTrv.js

@@ -17,6 +17,8 @@ class ShellyTrv extends shellyDevice_1.ShellyDevice {
         /** @inheritDoc */
         this.settings = new models_1.HeaterSettings();
         /** @inheritDoc */
+        this.temperatureSensor = new sharedFunctions_1.TemperatureSensor(this);
+        /** @inheritDoc */
         this.persistHeaterInterval = services_1.Utils.guardedInterval(() => {
             this.persistHeater();
         }, 5 * 60 * 1000, this, false);
@@ -28,7 +30,6 @@ class ShellyTrv extends shellyDevice_1.ShellyDevice {
         this._level = 0;
         this._minimumValveLevel = 0;
         this._recalcTimeout = null;
-        this._temperatur = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this._targetTempVal = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this._desiredTemperatur = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this._useExternalTemperatureEnabled = false;
@@ -98,19 +99,23 @@ class ShellyTrv extends shellyDevice_1.ShellyDevice {
     }
     /** @inheritDoc */
     get iTemperature() {
-        if (this.settings.useOwnTemperatur) {
-            return this._temperatur;
+        if (this.settings.useOwnTemperatureForRoomTemperature) {
+            return this.temperatureSensor.temperature;
         }
         else {
             return this._roomTemperature;
         }
     }
     /** @inheritDoc */
+    get sTemperature() {
+        return `${this.iTemperature}°C`;
+    }
+    /** @inheritDoc */
     get roomTemperature() {
-        return this._roomTemperature;
+        return this.temperatureSensor.roomTemperature;
     }
     set roomTemperatur(val) {
-        this._roomTemperature = val;
+        this.temperatureSensor.roomTemperature = val;
         if (this.settings.useOwnTemperatur) {
             return;
         }
@@ -120,6 +125,10 @@ class ShellyTrv extends shellyDevice_1.ShellyDevice {
         }
     }
     /** @inheritDoc */
+    addTempChangeCallback(pCallback) {
+        this.temperatureSensor.addTempChangeCallback(pCallback);
+    }
+    /** @inheritDoc */
     checkAutomaticChange() {
         var _a;
         if (!this._initialSeasonCheckDone) {
@@ -177,7 +186,7 @@ class ShellyTrv extends shellyDevice_1.ShellyDevice {
             this._minimumValveLevel = state.val;
         }
         else if (idSplit[3] === 'tmp' && idSplit[4] === 'temperatureC') {
-            this._temperatur = state.val;
+            this.temperatureSensor.temperature = state.val;
         }
         else if (idSplit[3] === 'tmp' && idSplit[4] === 'automaticTemperatureControl') {
             this._automaticMode = state.val;

package/lib/server/devices/zigbee/BaseDevices/zigbeeHeater.d.ts

@@ -1,16 +1,18 @@
 import { ZigbeeDevice } from './zigbeeDevice';
 import { iBatteryDevice, iHeater } from '../../baseDeviceInterfaces';
-import { HeaterSettings } from '../../../../models';
+import { HeaterSettings, TemperatureSensorChangeAction } from '../../../../models';
 import { DeviceType } from '../../deviceType';
 import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
 import { PIDController } from '../../../../liquid-pid';
-import { Battery } from '../../sharedFunctions';
+import { Battery, TemperatureSensor } from '../../sharedFunctions';
 export declare class ZigbeeHeater extends ZigbeeDevice implements iHeater, iBatteryDevice {
     /** @inheritDoc */
     readonly battery: Battery;
     /** @inheritDoc */
     readonly persistHeaterInterval: NodeJS.Timeout;
     /** @inheritDoc */
+    temperatureSensor: TemperatureSensor;
+    /** @inheritDoc */
     settings: HeaterSettings;
     protected _battery: number;
     protected _iAutomaticInterval: NodeJS.Timeout | undefined;
@@ -21,7 +23,6 @@ export declare class ZigbeeHeater extends ZigbeeDevice implements iHeater, iBatt
     protected _desiredTemperatur: number;
     protected _pidController: PIDController;
     protected _seasonTurnOff: boolean;
-    protected _roomTemperature: number;
     constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
     /** @inheritDoc */
     get batteryLevel(): number;
@@ -36,12 +37,15 @@ export declare class ZigbeeHeater extends ZigbeeDevice implements iHeater, iBatt
     get sLevel(): string;
     /** @inheritDoc */
     get iLevel(): number;
-    get sTemperatur(): string;
     /** @inheritDoc */
     get iTemperature(): number;
     /** @inheritDoc */
+    get sTemperature(): string;
+    /** @inheritDoc */
     get roomTemperature(): number;
-    protected set roomTemperatur(val: number);
+    protected set roomTemperature(val: number);
+    /** @inheritDoc */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
     /** @inheritDoc */
     checkAutomaticChange(): void;
     /** @inheritDoc */

package/lib/server/devices/zigbee/BaseDevices/zigbeeHeater.js

@@ -18,6 +18,8 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
             this.persistHeater();
         }, 5 * 60 * 1000, this, false);
         /** @inheritDoc */
+        this.temperatureSensor = new sharedFunctions_1.TemperatureSensor(this);
+        /** @inheritDoc */
         this.settings = new models_1.HeaterSettings();
         this._battery = -99;
         this._initialSeasonCheckDone = false;
@@ -36,7 +38,6 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
             Kd: 9, // PID: Kd in 1/1000
         });
         this._seasonTurnOff = false;
-        this._roomTemperature = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.heater);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
         this._iAutomaticInterval = services_1.Utils.guardedInterval(this.checkAutomaticChange, 300000, this); // Alle 5 Minuten prüfen
@@ -76,24 +77,29 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
     get iLevel() {
         return this._level;
     }
-    get sTemperatur() {
-        return `${this.iTemperature}°C`;
-    }
     /** @inheritDoc */
     get iTemperature() {
-        if (this.settings.useOwnTemperatur) {
-            return this._temperatur;
+        if (this.settings.useOwnTemperatureForRoomTemperature) {
+            return this.temperatureSensor.temperature;
         }
         else {
-            return this._roomTemperature;
+            return this.roomTemperature;
         }
     }
     /** @inheritDoc */
+    get sTemperature() {
+        return `${this.iTemperature}°C`;
+    }
+    /** @inheritDoc */
     get roomTemperature() {
-        return this._roomTemperature;
+        return this.temperatureSensor.roomTemperature;
     }
-    set roomTemperatur(val) {
-        this._roomTemperature = val;
+    set roomTemperature(val) {
+        this.temperatureSensor.roomTemperature = val;
+    }
+    /** @inheritDoc */
+    addTempChangeCallback(pCallback) {
+        this.temperatureSensor.addTempChangeCallback(pCallback);
     }
     /** @inheritDoc */
     checkAutomaticChange() {
@@ -121,7 +127,7 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
     }
     /** @inheritDoc */
     onTemperaturChange(newTemperatur) {
-        this.roomTemperatur = newTemperatur;
+        this.roomTemperature = newTemperatur;
     }
     persistHeater() {
         var _a;
@@ -151,12 +157,12 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
         super.dispose();
     }
     getNextPidLevel() {
-        if (this.seasonTurnOff || this._roomTemperature < 0) {
+        if (this.seasonTurnOff || this.roomTemperature < 0) {
             return 0;
         }
         this._pidController.setPoint(this.desiredTemperature);
-        const newValue = this._pidController.calculate(this._roomTemperature);
-        this.log(models_1.LogLevel.Debug, `New PID Value ${newValue}% (cTemp: ${this._roomTemperature}, dTemp: ${this.desiredTemperature})`);
+        const newValue = this._pidController.calculate(this.roomTemperature);
+        this.log(models_1.LogLevel.Debug, `New PID Value ${newValue}% (cTemp: ${this.roomTemperature}, dTemp: ${this.desiredTemperature})`);
         return newValue;
     }
     checkSeasonTurnOff() {

package/lib/server/devices/zigbee/zigbeeEuroHeater.d.ts

@@ -22,7 +22,7 @@ export declare class ZigbeeEuroHeater extends ZigbeeHeater implements iDisposabl
     get desiredTemperature(): number;
     /** @inheritDoc */
     set desiredTemperature(val: number);
-    protected set roomTemperatur(value: number);
+    protected set roomTemperature(value: number);
     private get tempDiff();
     /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;

package/lib/server/devices/zigbee/zigbeeEuroHeater.js

@@ -39,7 +39,7 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
     }
     /** @inheritDoc */
     get roomTemperature() {
-        return this._roomTemperature;
+        return super.roomTemperature;
     }
     /** @inheritDoc */
     get desiredTemperature() {
@@ -50,8 +50,8 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
         this._desiredTemperatur = val;
         this.recalcLevel();
     }
-    set roomTemperatur(value) {
-        this._roomTemperature = value;
+    set roomTemperature(value) {
+        super.roomTemperature = value;
         if (this.settings.useOwnTemperatur) {
             return;
         }
@@ -134,7 +134,7 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
             return;
         }
         this._lastRecalc = services_1.Utils.nowMS();
-        const desiredDiff = services_1.Utils.round(this.desiredTemperature - this._roomTemperature, 1);
+        const desiredDiff = services_1.Utils.round(this.desiredTemperature - this.roomTemperature, 1);
         const currentDiff = this.tempDiff;
         const missingDiff = services_1.Utils.round(desiredDiff - currentDiff, 1);
         if (Math.abs(missingDiff) < 0.15) {
@@ -150,7 +150,7 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
         }
         const newLocalDiff = Math.sign(desiredDiff) * -9;
         this.setLocalDiff(newLocalDiff);
-        this.setTargetTemperatur(this._temperatur + this._roomTemperature + newLocalDiff + this.desiredTemperature);
+        this.setTargetTemperatur(this._temperatur + this.roomTemperature + newLocalDiff + this.desiredTemperature);
     }
     setLocalDiff(newLocalDiff) {
         this.log(models_1.LogLevel.Debug, `Setting new Local Calibration Diff (${newLocalDiff}) for Euro Valve`);

package/lib/server/devices/zigbee/zigbeeTuyaValve.d.ts

@@ -16,8 +16,9 @@ export declare class ZigbeeTuyaValve extends ZigbeeHeater {
     set seasonTurnOff(value: boolean);
     /** @inheritDoc */
     set desiredTemperature(val: number);
+    get roomTemperature(): number;
     /** @inheritDoc */
-    protected set roomTemperatur(value: number);
+    protected set roomTemperature(value: number);
     private get tempDiff();
     /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;

package/lib/server/devices/zigbee/zigbeeTuyaValve.js

@@ -31,9 +31,12 @@ class ZigbeeTuyaValve extends BaseDevices_1.ZigbeeHeater {
         this._desiredTemperatur = val;
         this.checkTempDiff();
     }
+    get roomTemperature() {
+        return super.roomTemperature;
+    }
     /** @inheritDoc */
-    set roomTemperatur(value) {
-        this._roomTemperature = value;
+    set roomTemperature(value) {
+        super.roomTemperature = value;
         if (this.settings.useOwnTemperatur) {
             return;
         }
@@ -81,7 +84,7 @@ class ZigbeeTuyaValve extends BaseDevices_1.ZigbeeHeater {
         if (this.settings.useOwnTemperatur) {
             return;
         }
-        const desiredDiff = services_1.Utils.round(this.desiredTemperature - this._roomTemperature, 1);
+        const desiredDiff = services_1.Utils.round(this.desiredTemperature - this.roomTemperature, 1);
         const currentDiff = this.tempDiff;
         const missingDiff = services_1.Utils.round(desiredDiff - currentDiff, 1);
         if (Math.abs(missingDiff) < 0.15) {
@@ -97,7 +100,7 @@ class ZigbeeTuyaValve extends BaseDevices_1.ZigbeeHeater {
         }
         const newLocalDiff = Math.sign(desiredDiff) * -9;
         this.setLocalDiff(newLocalDiff);
-        this.setTargetTemperatur(this._localTempVal + this._roomTemperature + newLocalDiff + this.desiredTemperature);
+        this.setTargetTemperatur(this._localTempVal + this.roomTemperature + newLocalDiff + this.desiredTemperature);
     }
     setLocalDiff(newLocalDiff) {
         this.log(models_1.LogLevel.Debug, `Setting new Local Calibration Diff (${newLocalDiff}) for Tuya Valve`);