hoffmation-base 3.0.0-alpha.9 → 3.0.0-alpha.90

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

@@ -1,47 +1,87 @@
-import { DeviceInfo, DeviceType, iActuator, iBaseDevice } from '../../devices';
+import { DeviceCapability, DeviceInfo, DeviceType, iActuator, iBaseDevice } from '../../devices';
 import { ActuatorSetStateCommand, ActuatorToggleCommand, ActuatorWriteStateToDeviceCommand, LogLevel, RestoreTargetAutomaticValueCommand, RoomBase } from '../../../models';
-import { DeviceCapability } from '../DeviceCapability';
 import { LogDebugType, OwnSonosDevice } from '../../services';
 import { iDachsSettings } from '../../config/iDachsSettings';
 import { DachsDeviceSettings } from '../../../models/deviceSettings/dachsSettings';
-import { iFlattenedCompleteResponse } from './interfaces';
 import { DachsTemperatureSensor } from './dachsTemperatureSensor';
 import { BlockAutomaticHandler } from '../../services/blockAutomaticHandler';
 export declare class Dachs implements iBaseDevice, iActuator {
+    /** @inheritDoc */
     settings: DachsDeviceSettings;
+    /** @inheritDoc */
     readonly blockAutomationHandler: BlockAutomaticHandler;
+    /** @inheritDoc */
     readonly deviceType: DeviceType;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
+    /**
+     * A reference to the Temperature measuring warm water temperature
+     */
     readonly warmWaterSensor: DachsTemperatureSensor;
+    /**
+     * A reference to the Temperature measuring heat storage temperature
+     */
     readonly heatStorageTempSensor: DachsTemperatureSensor;
+    /**
+     * An external actuator controlling the warm water pump
+     */
+    warmWaterPump?: iActuator;
+    /**
+     * An external actuator controlling the heat rod.
+     */
+    heatingRod?: iActuator;
+    /**
+     * An external actuator to prevent the Dachs from starting.
+     */
+    blockDachsStart?: iActuator;
     private readonly client;
     private readonly config;
-    fetchedData: iFlattenedCompleteResponse | undefined;
+    /** @inheritDoc */
     queuedValue: boolean | null;
+    /** @inheritDoc */
+    targetAutomaticState: boolean;
     private readonly _influxClient;
     private _dachsOn;
     private _tempWarmWater;
     private _tempHeatStorage;
-    targetAutomaticState: boolean;
+    private fetchedData;
+    /** @inheritDoc */
     get customName(): string;
+    /** @inheritDoc */
     get actuatorOn(): boolean;
-    get tempWarmWater(): number;
-    get tempHeatStorage(): number;
     constructor(options: iDachsSettings);
-    restoreTargetAutomaticValue(c: RestoreTargetAutomaticValueCommand): void;
-    protected _info: DeviceInfo;
+    /** @inheritDoc */
     get info(): DeviceInfo;
-    set info(info: DeviceInfo);
+    protected _info: DeviceInfo;
+    /** @inheritDoc */
     get id(): string;
-    get name(): string;
+    /** @inheritDoc */
     get room(): RoomBase | undefined;
+    get name(): string;
+    /** @inheritDoc */
+    restoreTargetAutomaticValue(c: RestoreTargetAutomaticValueCommand): void;
+    /** @inheritDoc */
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    /** @inheritDoc */
     toJSON(): Partial<OwnSonosDevice>;
+    /** @inheritDoc */
     persistDeviceInfo(): void;
+    /** @inheritDoc */
     loadDeviceSettings(): void;
     private loadData;
+    /** @inheritDoc */
     persist(): void;
+    /** @inheritDoc */
     setActuator(c: ActuatorSetStateCommand): void;
+    /** @inheritDoc */
     toggleActuator(c: ActuatorToggleCommand): boolean;
+    /** @inheritDoc */
     writeActuatorStateToDevice(c: ActuatorWriteStateToDeviceCommand): void;
+    /**
+     * Reacts on level Changes of a Energymanager with battery
+     * @param {BatteryLevelChangeAction} action - The action containing the new level
+     */
+    private onBatteryLevelChange;
+    private onTempChange;
+    private checkHeatingRod;
 }

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,40 @@ 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.battery.addBatteryLevelCallback(this.onBatteryLevelChange.bind(this));
+        }
+        this.warmWaterSensor.addTempChangeCallback(this.onTempChange.bind(this));
+        this.heatStorageTempSensor.addTempChangeCallback(this.onTempChange.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 +95,28 @@ class Dachs {
             deviceName: this.name,
         });
     }
+    /** @inheritDoc */
     toJSON() {
-        return services_1.Utils.jsonFilter(lodash_1.default.omit(this, ['room', 'client', 'config', '_influxClient', 'warmWaterSensor', 'heatStorageTempSensor']));
+        return services_1.Utils.jsonFilter(lodash_1.default.omit(this, [
+            'room',
+            'client',
+            'config',
+            '_influxClient',
+            'warmWaterSensor',
+            'heatStorageTempSensor',
+            'warmWaterPump',
+            'heatingRod',
+            'blockDachsStart',
+        ]));
     }
+    /** @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 +147,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 +193,92 @@ 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) {
+        this.checkHeatingRod(action);
+        if (this.blockDachsStart !== undefined) {
+            if (action.newLevel > this.settings.batteryLevelPreventStartThreshold) {
+                const blockAction = new models_1.ActuatorSetStateCommand(action, true, `Battery reached ${action.newLevel}%, Dachs should not run any more`, null);
+                blockAction.overrideCommandSource = models_1.CommandSource.Force;
+                this.blockDachsStart.setActuator(blockAction);
+                return;
+            }
+            else if (action.newLevel < this.settings.batteryLevelAllowStartThreshold) {
+                const liftAction = new models_1.ActuatorSetStateCommand(action, false, `Battery reached ${action.newLevel}%, Dachs is now allowed to run if needed`, null);
+                this.blockDachsStart.setActuator(liftAction);
+            }
+            else if (this.blockDachsStart.actuatorOn) {
+                // We haven't reached the lower threshold yet --> nothing to do
+                return;
+            }
+        }
+        if (this._dachsOn) {
+            // We are already running
+            return;
+        }
+        const dayType = services_1.TimeCallbackService.dayType(new services_1.SunTimeOffsets());
+        if ((dayType === models_1.TimeOfDay.Daylight || dayType === models_1.TimeOfDay.BeforeSunrise) &&
+            action.newLevel > this.settings.batteryLevelTurnOnThreshold) {
+            // It is daytime (maybe solar power) and it is no critical battery level
+            return;
+        }
+        if (action.newLevel > this.settings.batteryLevelBeforeNightTurnOnThreshold) {
+            // It is not daylight but 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);
+    }
+    onTempChange(action) {
+        if (this.warmWaterPump === undefined) {
+            // We have no control over the warm water pump --> nothing to do
+            return;
+        }
+        const wwTemp = this._tempWarmWater;
+        const heatStorageTemp = this._tempHeatStorage;
+        let desiredState = false;
+        let reason = '';
+        if (wwTemp > this.settings.warmWaterDesiredMinTemp + 3) {
+            desiredState = false;
+            reason = `Temperature of warm water pump ${wwTemp}°C is above desired minimum temperature ${this.settings.warmWaterDesiredMinTemp}°C`;
+        }
+        else if (wwTemp > heatStorageTemp) {
+            desiredState = false;
+            reason = `Temperature of warm water pump ${wwTemp}°C is higher than temperature of heat storage ${heatStorageTemp}°C`;
+        }
+        else if (heatStorageTemp < this.settings.warmWaterDesiredMinTemp - 4) {
+            desiredState = false;
+            reason = `Temperature of heat storage ${heatStorageTemp}°C is too low to heat water.`;
+        }
+        else if (wwTemp < this.settings.warmWaterDesiredMinTemp) {
+            desiredState = true;
+            reason = `Temperature of warm water pump ${wwTemp}°C is lower than desired minimum temperature ${this.settings.warmWaterDesiredMinTemp}°C`;
+        }
+        else {
+            // We are somewhere between states, let's not change anything
+            return;
+        }
+        if (desiredState === this.warmWaterPump.actuatorOn) {
+            // Nothing to do
+            return;
+        }
+        const setAction = new models_1.ActuatorSetStateCommand(action, desiredState, reason, null);
+        this.warmWaterPump.setActuator(setAction);
+    }
+    checkHeatingRod(action) {
+        if (this.heatingRod === undefined) {
+            return;
+        }
+        const shouldBeOff = action.newLevel < this.settings.batteryLevelHeatingRodThreshold;
+        if (this.heatingRod.actuatorOn !== shouldBeOff) {
+            return;
+        }
+        const setAction = new models_1.ActuatorSetStateCommand(action, !shouldBeOff, `Battery reached ${action.newLevel}%, heating rod should be turned ${shouldBeOff ? 'off' : 'on'}`, null);
+        this.heatingRod.setActuator(setAction);
+    }
 }
 exports.Dachs = Dachs;

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

@@ -1,38 +1,51 @@
-/// <reference types="node" />
 import { iTemperatureSensor } from '../baseDeviceInterfaces';
 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';
+import { TemperatureSensor } from '../sharedFunctions';
 export declare class DachsTemperatureSensor implements iTemperatureSensor {
+    /** @inheritDoc */
     settings: DeviceSettings | undefined;
+    /** @inheritDoc */
     readonly deviceType: DeviceType;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
-    readonly persistTemperatureSensorInterval: NodeJS.Timeout;
-    private _temperaturCallbacks;
-    private _roomTemperature;
+    /** @inheritDoc */
+    temperatureSensor: TemperatureSensor;
     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;
-    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

@@ -4,24 +4,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DachsTemperatureSensor = void 0;
-const baseDeviceInterfaces_1 = require("../baseDeviceInterfaces");
 const services_1 = require("../../services");
 const DeviceCapability_1 = require("../DeviceCapability");
 const deviceType_1 = require("../deviceType");
 const DeviceInfo_1 = require("../DeviceInfo");
 const devices_1 = require("../devices");
 const lodash_1 = __importDefault(require("lodash"));
+const sharedFunctions_1 = require("../sharedFunctions");
 class DachsTemperatureSensor {
     constructor(roomName, shortKey, longKey) {
+        /** @inheritDoc */
         this.settings = undefined;
+        /** @inheritDoc */
         this.deviceType = deviceType_1.DeviceType.DachsWarmWaterTemperature;
+        /** @inheritDoc */
         this.deviceCapabilities = [];
-        this.persistTemperatureSensorInterval = services_1.Utils.guardedInterval(() => {
-            this.persistTemperaturSensor();
-        }, 5 * 60 * 1000, this, false);
-        this._temperaturCallbacks = [];
-        this._roomTemperature = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
-        this._temperature = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
+        /** @inheritDoc */
+        this.temperatureSensor = new sharedFunctions_1.TemperatureSensor(this);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.temperatureSensor);
         this._info = new DeviceInfo_1.DeviceInfo();
         this._info.fullName = longKey;
@@ -33,15 +32,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 +48,38 @@ 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;
+        return this.temperatureSensor.roomTemperature;
     }
+    /** @inheritDoc */
     set roomTemperature(value) {
-        this._roomTemperature = value;
+        this.temperatureSensor.roomTemperature = value;
     }
+    /** @inheritDoc */
     get iTemperature() {
-        return this._temperature;
+        return this.temperatureSensor.temperature;
     }
+    /** @inheritDoc */
     get sTemperature() {
-        return `${this._temperature}°C`;
-    }
-    set temperature(val) {
-        this._temperature = val;
-        for (const cb of this._temperaturCallbacks) {
-            cb(val);
-        }
+        return `${this.temperatureSensor.temperature}°C`;
     }
     update(newTemp) {
-        this.temperature = newTemp;
+        this.temperatureSensor.temperature = newTemp;
     }
+    /** @inheritDoc */
     addTempChangeCallback(pCallback) {
-        this._temperaturCallbacks.push(pCallback);
-        if (this._temperature > baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE) {
-            pCallback(this._temperature);
-        }
+        this.temperatureSensor.addTempChangeCallback(pCallback);
     }
+    /** @inheritDoc */
     onTemperaturChange(newTemperatur) {
         this.roomTemperature = newTemperatur;
     }
-    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,23 +88,25 @@ 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);
-        }
+        this.temperatureSensor.dispose();
     }
 }
 exports.DachsTemperatureSensor = DachsTemperatureSensor;

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;
 }