hoffmation-base 3.0.0-beta.5 → 3.0.0-beta.6

package/lib/server/devices/sharedFunctions/temperatureSensor.d.ts

@@ -8,6 +8,12 @@ export declare class TemperatureSensor implements iJsonOmitKeys {
      * The current room temperature as a number in Celsius
      */
     roomTemperature: number;
+    /**
+     * Temperature correction coefficient to mitigate outdoor temperature, e.g. if this is closely placed to a window.
+     * @remarks Default: 0 and difference to 21°C
+     * @example With outdoor temp of 10°C and a coefficient of 0.5, the temperature correction will be +5.5°C
+     */
+    outdoorTemperatureCorrectionCoefficient: number;
     /**
      * The interval to persist the temperature sensor information
      */

package/lib/server/devices/sharedFunctions/temperatureSensor.js

@@ -13,6 +13,12 @@ class TemperatureSensor {
          * The current room temperature as a number in Celsius
          */
         this.roomTemperature = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
+        /**
+         * Temperature correction coefficient to mitigate outdoor temperature, e.g. if this is closely placed to a window.
+         * @remarks Default: 0 and difference to 21°C
+         * @example With outdoor temp of 10°C and a coefficient of 0.5, the temperature correction will be +5.5°C
+         */
+        this.outdoorTemperatureCorrectionCoefficient = 0;
         /**
          * The interval to persist the temperature sensor information
          */
@@ -23,9 +29,13 @@ class TemperatureSensor {
         this._temperaturCallbacks = [];
     }
     set temperature(val) {
-        this._temperature = val;
+        let correctedValue = val;
+        if (this.outdoorTemperatureCorrectionCoefficient !== 0 && services_1.WeatherService.currentTemp !== baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE) {
+            correctedValue = val + this.outdoorTemperatureCorrectionCoefficient * (21 - services_1.WeatherService.currentTemp);
+        }
+        this._temperature = correctedValue;
         for (const cb of this._temperaturCallbacks) {
-            cb(new models_1.TemperatureSensorChangeAction(this._device, val));
+            cb(new models_1.TemperatureSensorChangeAction(this._device, correctedValue));
         }
     }
     get temperature() {

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

@@ -3,6 +3,10 @@ import { iHumiditySensor, iTemperatureSensor } from '../baseDeviceInterfaces';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 import { HumiditySensor, TemperatureSensor } from '../sharedFunctions';
 import { HumiditySensorChangeAction, TemperatureSensorChangeAction } from '../../../models';
+/**
+ * A smart window handle with integrated temperature and humidity sensor.
+ * As the temperature sensor is so close to the window it might be off, which is why the correction coefficient is set to 0.22°C per outdoor diff to 21°C
+ */
 export declare class ZigbeeSodaHandle extends ZigbeeWindowHandle implements iTemperatureSensor, iHumiditySensor {
     /** @inheritDoc */
     temperatureSensor: TemperatureSensor;

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

@@ -6,6 +6,10 @@ const deviceType_1 = require("../deviceType");
 const DeviceCapability_1 = require("../DeviceCapability");
 const sharedFunctions_1 = require("../sharedFunctions");
 const models_1 = require("../../../models");
+/**
+ * A smart window handle with integrated temperature and humidity sensor.
+ * As the temperature sensor is so close to the window it might be off, which is why the correction coefficient is set to 0.22°C per outdoor diff to 21°C
+ */
 class ZigbeeSodaHandle extends BaseDevices_1.ZigbeeWindowHandle {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeSodaHandle);
@@ -15,6 +19,7 @@ class ZigbeeSodaHandle extends BaseDevices_1.ZigbeeWindowHandle {
         this.humiditySensor = new sharedFunctions_1.HumiditySensor(this);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.humiditySensor);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.temperatureSensor);
+        this.temperatureSensor.outdoorTemperatureCorrectionCoefficient = 0.22;
     }
     /** @inheritDoc */
     get roomTemperature() {