hoffmation-base 3.0.0-alpha.5 → 3.0.0-alpha.50

package/lib/server/devices/dachs/dachs.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Dachs = void 0;
 const devices_1 = require("../../devices");
 const models_1 = require("../../../models");
-const DeviceCapability_1 = require("../DeviceCapability");
 const services_1 = require("../../services");
 const lodash_1 = __importDefault(require("lodash"));
 const dachsSettings_1 = require("../../../models/deviceSettings/dachsSettings");
@@ -14,30 +13,32 @@ const lib_1 = require("./lib");
 const dachsTemperatureSensor_1 = require("./dachsTemperatureSensor");
 const blockAutomaticHandler_1 = require("../../services/blockAutomaticHandler");
 class Dachs {
+    /** @inheritDoc */
     get customName() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get actuatorOn() {
         return this._dachsOn;
     }
-    get tempWarmWater() {
-        return this._tempWarmWater;
-    }
-    get tempHeatStorage() {
-        return this._tempHeatStorage;
-    }
     constructor(options) {
+        var _a, _b;
+        /** @inheritDoc */
         this.settings = new dachsSettings_1.DachsDeviceSettings();
+        /** @inheritDoc */
         this.deviceType = devices_1.DeviceType.Dachs;
+        /** @inheritDoc */
         this.deviceCapabilities = [];
+        /** @inheritDoc */
         this.queuedValue = null;
+        /** @inheritDoc */
+        this.targetAutomaticState = false;
         this._dachsOn = false;
         this._tempWarmWater = 0;
         this._tempHeatStorage = 0;
-        this.targetAutomaticState = false;
-        this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.actuator);
+        this.deviceCapabilities.push(devices_1.DeviceCapability.actuator);
         this._info = new devices_1.DeviceInfo();
-        this._info.fullName = `Dachs`;
+        this._info.fullName = 'Dachs';
         this._info.customName = `Dachs ${options.roomName}`;
         this._info.allDevicesKey = `dachs-${options.roomName}`;
         this._info.room = options.roomName;
@@ -52,32 +53,38 @@ class Dachs {
             flatten: true,
         };
         this.config = modifiedOptions;
-        this.client = new lib_1.DachsHttpClient(this.config.connectionOptions);
+        this.client = new lib_1.DachsHttpClient(this.config.connectionOptions, this.log.bind(this));
         this.warmWaterSensor = new dachsTemperatureSensor_1.DachsTemperatureSensor(this.config.roomName, 'ww', 'Water Temperature');
         this.heatStorageTempSensor = new dachsTemperatureSensor_1.DachsTemperatureSensor(this.config.roomName, 'hs', 'Heat Storage Temperature');
         services_1.Utils.guardedInterval(this.loadData, this.config.refreshInterval, this);
-        this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this));
-    }
-    restoreTargetAutomaticValue(c) {
-        this.log(models_1.LogLevel.Debug, `Restore Target Automatic value`);
-        this.setActuator(new models_1.ActuatorSetStateCommand(c, this.targetAutomaticState, 'Restore Target Automatic value'));
+        this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this), this.log.bind(this));
+        if ((_b = (_a = devices_1.Devices.energymanager) === null || _a === void 0 ? void 0 : _a.deviceCapabilities) === null || _b === void 0 ? void 0 : _b.includes(devices_1.DeviceCapability.batteryDriven)) {
+            const energyManager = devices_1.Devices.energymanager;
+            energyManager.addBatteryLevelCallback(this.onBatteryLevelChange.bind(this));
+        }
     }
+    /** @inheritDoc */
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
+    /** @inheritDoc */
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `sonos-${this.info.room}-${this.info.customName}`;
     }
+    /** @inheritDoc */
+    get room() {
+        return services_1.API.getRoom(this.info.room);
+    }
     get name() {
         return this.info.customName;
     }
-    get room() {
-        return services_1.API.getRoom(this.info.room);
+    /** @inheritDoc */
+    restoreTargetAutomaticValue(c) {
+        this.log(models_1.LogLevel.Debug, 'Restore Target Automatic value');
+        this.setActuator(new models_1.ActuatorSetStateCommand(c, this.targetAutomaticState, 'Restore Target Automatic value'));
     }
+    /** @inheritDoc */
     log(level, message, debugType = services_1.LogDebugType.None) {
         services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
             debugType: debugType,
@@ -86,15 +93,18 @@ class Dachs {
             deviceName: this.name,
         });
     }
+    /** @inheritDoc */
     toJSON() {
         return services_1.Utils.jsonFilter(lodash_1.default.omit(this, ['room', 'client', 'config', '_influxClient', 'warmWaterSensor', 'heatStorageTempSensor']));
     }
+    /** @inheritDoc */
     persistDeviceInfo() {
         services_1.Utils.guardedTimeout(() => {
             var _a;
             (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
         }, 5000, this);
     }
+    /** @inheritDoc */
     loadDeviceSettings() {
         this.settings.initializeFromDb(this);
     }
@@ -125,21 +135,25 @@ class Dachs {
             this.persist();
         })
             .catch((error) => {
-            this.log(models_1.LogLevel.Error, `Error while fetching data: ${error}`);
+            this.log(models_1.LogLevel.Error, `Error while fetching data: ${error}`, services_1.LogDebugType.DachsUnreach);
         });
     }
+    /** @inheritDoc */
     persist() {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistActuator(this);
     }
+    /** @inheritDoc */
     setActuator(c) {
         devices_1.LampUtils.setActuator(this, c);
     }
+    /** @inheritDoc */
     toggleActuator(c) {
         const setActuatorCommand = models_1.ActuatorSetStateCommand.byActuatorAndToggleCommand(this, c);
         this.setActuator(setActuatorCommand);
         return setActuatorCommand.on;
     }
+    /** @inheritDoc */
     writeActuatorStateToDevice(c) {
         this.log(models_1.LogLevel.Debug, c.logMessage, services_1.LogDebugType.SetActuator);
         if (!c.stateValue) {
@@ -167,5 +181,18 @@ class Dachs {
             this.log(models_1.LogLevel.Error, `Error while turning on Dachs: ${error}`);
         });
     }
+    /**
+     * Reacts on level Changes of a Energymanager with battery
+     * @param {BatteryLevelChangeAction} action - The action containing the new level
+     */
+    onBatteryLevelChange(action) {
+        if (this._dachsOn || this.settings.batteryLevelTurnOnThreshold < action.newLevel) {
+            // We are already running, or battery level is high enough.
+            return;
+        }
+        const setStateCommand = new models_1.ActuatorSetStateCommand(action, true, 'Energy Level of battery dropped to critical level', null);
+        setStateCommand.overrideCommandSource = models_1.CommandSource.Force;
+        this.setActuator(setStateCommand);
+    }
 }
 exports.Dachs = Dachs;

package/lib/server/devices/dachs/dachsTemperatureSensor.d.ts

@@ -4,35 +4,54 @@ import { LogDebugType, OwnSonosDevice } from '../../services';
 import { DeviceCapability } from '../DeviceCapability';
 import { DeviceType } from '../deviceType';
 import { DeviceInfo } from '../DeviceInfo';
-import { DeviceSettings, LogLevel, RoomBase } from '../../../models';
+import { DeviceSettings, LogLevel, RoomBase, TemperatureSensorChangeAction } from '../../../models';
 export declare class DachsTemperatureSensor implements iTemperatureSensor {
+    /** @inheritDoc */
     settings: DeviceSettings | undefined;
+    /** @inheritDoc */
     readonly deviceType: DeviceType;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
     readonly persistTemperatureSensorInterval: NodeJS.Timeout;
     private _temperaturCallbacks;
     private _roomTemperature;
     protected _info: DeviceInfo;
     constructor(roomName: string, shortKey: string, longKey: string);
+    /** @inheritDoc */
     get customName(): string;
+    /** @inheritDoc */
     get info(): DeviceInfo;
-    set info(info: DeviceInfo);
+    /** @inheritDoc */
     get id(): string;
     get name(): string;
+    /** @inheritDoc */
     get room(): RoomBase | undefined;
+    /** @inheritDoc */
     get roomTemperature(): number;
+    /** @inheritDoc */
     set roomTemperature(value: number);
+    /** @inheritDoc */
     get iTemperature(): number;
+    /** @inheritDoc */
     get sTemperature(): string;
     private _temperature;
     private set temperature(value);
     update(newTemp: number): void;
-    addTempChangeCallback(pCallback: (pValue: number) => void): void;
+    /** @inheritDoc */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    /** @inheritDoc */
     onTemperaturChange(newTemperatur: number): void;
+    /** @inheritDoc */
     persistTemperaturSensor(): void;
+    /** @inheritDoc */
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    /** @inheritDoc */
     toJSON(): Partial<OwnSonosDevice>;
+    /** @inheritDoc */
     persistDeviceInfo(): void;
+    /** @inheritDoc */
     loadDeviceSettings(): void;
+    /** @inheritDoc */
     dispose(): void;
 }

package/lib/server/devices/dachs/dachsTemperatureSensor.js

@@ -11,11 +11,16 @@ const deviceType_1 = require("../deviceType");
 const DeviceInfo_1 = require("../DeviceInfo");
 const devices_1 = require("../devices");
 const lodash_1 = __importDefault(require("lodash"));
+const models_1 = require("../../../models");
 class DachsTemperatureSensor {
     constructor(roomName, shortKey, longKey) {
+        /** @inheritDoc */
         this.settings = undefined;
+        /** @inheritDoc */
         this.deviceType = deviceType_1.DeviceType.DachsWarmWaterTemperature;
+        /** @inheritDoc */
         this.deviceCapabilities = [];
+        /** @inheritDoc */
         this.persistTemperatureSensorInterval = services_1.Utils.guardedInterval(() => {
             this.persistTemperaturSensor();
         }, 5 * 60 * 1000, this, false);
@@ -33,15 +38,15 @@ class DachsTemperatureSensor {
         this.persistDeviceInfo();
         services_1.Utils.guardedTimeout(this.loadDeviceSettings, 200, this);
     }
+    /** @inheritDoc */
     get customName() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
+    /** @inheritDoc */
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `dachs-${this.info.room}-${this.info.customName}`;
@@ -49,43 +54,52 @@ class DachsTemperatureSensor {
     get name() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get room() {
         return services_1.API.getRoom(this.info.room);
     }
+    /** @inheritDoc */
     get roomTemperature() {
         return this._roomTemperature;
     }
+    /** @inheritDoc */
     set roomTemperature(value) {
         this._roomTemperature = value;
     }
+    /** @inheritDoc */
     get iTemperature() {
         return this._temperature;
     }
+    /** @inheritDoc */
     get sTemperature() {
         return `${this._temperature}°C`;
     }
     set temperature(val) {
         this._temperature = val;
         for (const cb of this._temperaturCallbacks) {
-            cb(val);
+            cb(new models_1.TemperatureSensorChangeAction(this, val));
         }
     }
     update(newTemp) {
         this.temperature = newTemp;
     }
+    /** @inheritDoc */
     addTempChangeCallback(pCallback) {
         this._temperaturCallbacks.push(pCallback);
         if (this._temperature > baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE) {
-            pCallback(this._temperature);
+            pCallback(new models_1.TemperatureSensorChangeAction(this, this._temperature));
         }
     }
+    /** @inheritDoc */
     onTemperaturChange(newTemperatur) {
         this.roomTemperature = newTemperatur;
     }
+    /** @inheritDoc */
     persistTemperaturSensor() {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistTemperatureSensor(this);
     }
+    /** @inheritDoc */
     log(level, message, debugType = services_1.LogDebugType.None) {
         services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
             debugType: debugType,
@@ -94,19 +108,23 @@ class DachsTemperatureSensor {
             deviceName: this.name,
         });
     }
+    /** @inheritDoc */
     toJSON() {
         return services_1.Utils.jsonFilter(lodash_1.default.omit(this, ['room', 'client', 'config', '_influxClient']));
     }
+    /** @inheritDoc */
     persistDeviceInfo() {
         services_1.Utils.guardedTimeout(() => {
             var _a;
             (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
         }, 5000, this);
     }
+    /** @inheritDoc */
     loadDeviceSettings() {
         var _a;
         (_a = this.settings) === null || _a === void 0 ? void 0 : _a.initializeFromDb(this);
     }
+    /** @inheritDoc */
     dispose() {
         if (this.persistTemperatureSensorInterval) {
             clearInterval(this.persistTemperatureSensorInterval);

package/lib/server/devices/dachs/interfaces/DachsClientOptions.d.ts

@@ -1,12 +1,42 @@
+/**
+ * Options to connect to a Dachs CHP device
+ */
 export interface DachsClientOptions {
+    /**
+     * The hostname or IP address of the Dachs device
+     */
     host: string;
+    /**
+     * The protocol to use
+     */
     protocol?: 'http' | 'https';
+    /**
+     * The port to use
+     */
     port?: number;
+    /**
+     * The username to use for authentication
+     */
     username?: string;
+    /**
+     * The password to use for authentication
+     */
     password?: string;
+    /**
+     * Settings to define the result of requests
+     */
     resultConfig?: {
+        /**
+         * Whether to add the raw value to the result
+         */
         addRawValue?: boolean;
+        /**
+         * Whether to add the key object to the result
+         */
         addKeyObject?: boolean;
+        /**
+         * Whether to flatten the result
+         */
         flatten?: boolean;
     };
 }

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

@@ -8,11 +8,3 @@ export interface KeyListEntityResponse<V> {
     rawValue?: string;
     value: V;
 }
-/**
-
- "key": "",
- "doc": "",
- "unit": Number
-
-
- */

package/lib/server/devices/dachs/interfaces/KeyListEntity.js

@@ -1,10 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/**
-
- "key": "",
- "doc": "",
- "unit": Number
-
-
- */

package/lib/server/devices/dachs/interfaces/dachsInfluxDataPoint.d.ts

@@ -1,6 +1,18 @@
+/**
+ * Represents a data point that can be written to the persistence layer
+ */
 export interface DachsInfluxDataPoint {
+    /**
+     * The timestamp of the data point
+     */
     timestamp: Date;
+    /**
+     * The measurement of the data point
+     */
     measurement: string;
+    /**
+     * The fields of the data point
+     */
     fields: {
         [key: string]: string | number | boolean;
     };

package/lib/server/devices/dachs/interfaces/influxDbConnectionOptions.d.ts

@@ -1,9 +1,29 @@
+/**
+ * The options needed for connecting to an InfluxDB database
+ */
 export interface InfluxDbConnectionOptions {
+    /**
+     * The host address of the InfluxDB server (or its ip address)
+     */
     host: string;
+    /**
+     * The port of the InfluxDB server
+     */
     port: number;
+    /**
+     * The name of the database to connect to
+     */
     database: string;
+    /**
+     * The username to use for authentication
+     */
     username: string;
+    /**
+     * The password to use for authentication
+     */
     password: string;
+    /**
+     * The retention policy to use for writing data (if not specified, the default retention policy is used)
+     */
     retentionPolicy?: string;
-    batchIntervalSeconds?: number;
 }

package/lib/server/devices/dachs/lib/dachsHttpClient.d.ts

@@ -1,5 +1,7 @@
 import { AxiosResponse } from 'axios';
 import { DachsClientOptions, iFlattenedCompleteResponse, KeyListEntityResponse } from '../interfaces';
+import { LogDebugType } from '../../../services';
+import { LogLevel } from '../../../../models';
 /**
  * axios HTTP Client Class
  * - with some prepared fetch functions for data
@@ -8,10 +10,11 @@ import { DachsClientOptions, iFlattenedCompleteResponse, KeyListEntityResponse }
  * @class
  */
 export declare class DachsHttpClient {
+    private readonly _logger;
     private options;
-    private url;
+    private readonly url;
     private axiosInstance;
-    constructor(options: DachsClientOptions);
+    constructor(options: DachsClientOptions, _logger: (level: LogLevel, message: string, logDebugType?: LogDebugType) => void);
     /**
      * Takes every key and add the key to the get parameter list
      * @param {string[]} keys - Array of request keys

package/lib/server/devices/dachs/lib/dachsHttpClient.js

@@ -41,8 +41,9 @@ const models_1 = require("../../../../models");
  * @class
  */
 class DachsHttpClient {
-    constructor(options) {
+    constructor(options, _logger) {
         var _a;
+        this._logger = _logger;
         this.options = options;
         //combine parameter to baseUrl
         //check http prefix
@@ -61,7 +62,7 @@ class DachsHttpClient {
         this.axiosInstance.interceptors.response.use((response) => {
             return response;
         }, (error) => {
-            services_1.ServerLogService.writeLog(models_1.LogLevel.Error, `DachsHttpClient: ${error.message}`);
+            this._logger(models_1.LogLevel.Error, `DachsHttpClient: ${error.message}`, services_1.LogDebugType.DachsUnreach);
         });
     }
     /**
@@ -89,7 +90,7 @@ class DachsHttpClient {
     fetchByKeys(...keys) {
         return new Promise((resolve, reject) => {
             this.axiosInstance
-                .get(`/getKey` + this.urlBuilder(keys))
+                .get('/getKey' + this.urlBuilder(keys))
                 .then((res) => {
                 if (!res.data)
                     reject('No data received');
@@ -117,7 +118,7 @@ class DachsHttpClient {
     setKeys(data) {
         return new Promise((resolve, reject) => {
             this.axiosInstance
-                .post(`/setKeys`, Object.entries(data)
+                .post('/setKeys', Object.entries(data)
                 .map(([key, value]) => `${key}=${value}`)
                 .join('&'))
                 .then((res) => {

package/lib/server/devices/device-cluster.d.ts

@@ -10,6 +10,9 @@ export declare class DeviceCluster {
     addByDeviceType(device: iBaseDevice): void;
     addToList(type: DeviceClusterType, device: iBaseDevice): void;
     toJSON(): Partial<DeviceCluster & {
+        /**
+         * Dictionary representation of the normal device map
+         */
         deviceDict?: {
             [p: string]: DeviceList;
         };

package/lib/server/devices/device-cluster.js

@@ -11,7 +11,7 @@ class DeviceCluster {
     }
     getIoBrokerDevicesByType(type) {
         if (type === device_cluster_type_1.DeviceClusterType.Speaker) {
-            throw new Error(`This is no IoBroker Device`);
+            throw new Error('This is no IoBroker Device');
         }
         return this.getDevicesByType(type);
     }

package/lib/server/devices/deviceUpdater.d.ts

@@ -1,8 +1,5 @@
 import { IDeviceUpdater } from './iDeviceUpdater';
-import { Devices } from './devices';
 export declare class DeviceUpdater implements IDeviceUpdater {
-    devices: Devices;
-    constructor(pDevices: Devices);
     updateObject(pId: string, pObj: ioBroker.Object): void;
     updateState(id: string, state: ioBroker.State, initial?: boolean): void;
 }

package/lib/server/devices/deviceUpdater.js

@@ -7,9 +7,6 @@ const devices_1 = require("./devices");
 const mqtt_1 = require("./mqtt");
 const IoBrokerDeviceInfo_1 = require("./IoBrokerDeviceInfo");
 class DeviceUpdater {
-    constructor(pDevices) {
-        this.devices = pDevices;
-    }
     updateObject(pId, pObj) {
         const idSplit = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.idSplitter(pId);
         if (idSplit.length < 2)
@@ -40,7 +37,7 @@ class DeviceUpdater {
             classifier = devices_1.Devices.IDENTIFIER_ZIGBEE;
             devId = idSplit[2].substring(2);
         }
-        const device = devices_1.Devices.alLDevices[`${classifier}-${devId}`];
+        const device = services_1.API.getDevice(`${classifier}-${devId}`, false);
         if (typeof device === 'undefined' || device.update === undefined) {
             return;
         }

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

@@ -3,18 +3,54 @@ import { iBaseDevice, iEnergyManager, iTemperatureSensor } from './baseDeviceInt
 import { Dachs } from './dachs';
 import { iConfig } from '../config';
 export declare class Devices {
-    static IDENTIFIER_HOMEMATIC: string;
-    static IDENTIFIER_JS: string;
-    static IDENTIFIER_Shelly: string;
-    static IDENTIFIER_TUYA: string;
-    static IDENTIFIER_ZIGBEE: string;
-    static IDENTIFIER_ZIGBEE2MQTT: string;
-    static IDENTIFIER_WLED: string;
+    /**
+     * A constant for the identifier of HM-IP Adapter devices
+     */
+    static readonly IDENTIFIER_HOMEMATIC: string;
+    /**
+     * A constant for the identifier of JavaScript Adapter devices
+     */
+    static readonly IDENTIFIER_JS: string;
+    /**
+     * A constant for the identifier of Shelly Adapter devices
+     */
+    static readonly IDENTIFIER_Shelly: string;
+    /**
+     * A constant for the identifier of Tuya Adapter devices
+     */
+    static readonly IDENTIFIER_TUYA: string;
+    /**
+     * A constant for the identifier of Zigbee Adapter devices
+     */
+    static readonly IDENTIFIER_ZIGBEE: string;
+    /**
+     * A constant for the identifier of Zigbee2Mqtt Adapter devices
+     */
+    static readonly IDENTIFIER_ZIGBEE2MQTT: string;
+    /**
+     * A constant for the identifier of WLED Adapter devices
+     */
+    static readonly IDENTIFIER_WLED: string;
+    /**
+     * A Map containing all devices
+     */
     static alLDevices: {
         [id: string]: iBaseDevice;
     };
+    /**
+     * A reference to globally active energy manager
+     * @default undefined (no Energy-Manager)
+     */
     static energymanager?: iEnergyManager;
+    /**
+     * A reference to the Dachs device
+     * @default undefined (no Dachs CHP)
+     */
     static dachs?: Dachs;
+    /**
+     * A reference to the temperature sensor measuring the warm water temperature
+     * @default undefined (no warm water temperature sensor)
+     */
     static temperatureWarmWater?: iTemperatureSensor;
     constructor(pDeviceData: {
         [id: string]: deviceConfig;