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

package/lib/server/services/govee/govee-service.js

@@ -1,65 +1,90 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GooveeService = void 0;
 const log_service_1 = require("../log-service");
 const models_1 = require("../../../models");
-const govee_lan_controller_1 = require("@j3lte/govee-lan-controller");
+const http = __importStar(require("http"));
+const utils_1 = require("../utils");
 class GooveeService {
     static addOwnDevices(gvDevice) {
         this.ownDevices = gvDevice;
     }
-    static initialize() {
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Initializing Goovee-Service`);
-        this.all = [];
-        this.goveeApi = new govee_lan_controller_1.Govee({
-            discover: true,
-            discoverInterval: 300000,
-        });
-        this.goveeApi.on(govee_lan_controller_1.GoveeEventTypes.Scan, (data) => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `GoveeDevice ${data.ip} scanned`);
-        });
-        this.goveeApi.on(govee_lan_controller_1.GoveeEventTypes.Ready, () => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Govee ready`);
-        });
-        this.goveeApi.on(govee_lan_controller_1.GoveeEventTypes.Error, (err) => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `Govee-Error: ${err}`);
-        });
-        this.goveeApi.on(govee_lan_controller_1.GoveeEventTypes.NewDevice, (device) => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Trace, `GoveeDevice ${device.id} joined`);
-            GooveeService.initializeDevice(device);
-        });
-        this.goveeApi.on(govee_lan_controller_1.GoveeEventTypes.UnknownDevice, (_data) => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `GoveeDevice unknown`);
-        });
-        this.goveeApi.on(govee_lan_controller_1.GoveeEventTypes.UnknownMessage, (data) => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `GoveeDevice unknown message: ${data}`);
-        });
-        this.goveeApi.discover();
+    static initialize(config) {
+        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'Initializing Goovee-Service');
+        this._serverUrl = config.url;
+        this._refreshInterval = utils_1.Utils.guardedInterval(this.loadDevices, 5000, this, true);
     }
-    static initializeDevice(d) {
-        this.devicesDict[d.id] = d;
-        if (this.ownDevices[d.id] === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `Unknown Govee Device "${d.id}"`);
-            return;
+    static cleanup() {
+        if (this._refreshInterval !== null) {
+            clearInterval(this._refreshInterval);
+            this._refreshInterval = null;
         }
-        const ownDevice = this.ownDevices[d.id];
-        ownDevice.device = d;
-        ownDevice.update(d.getState());
-        d.on(govee_lan_controller_1.GoveeDeviceEventTypes.StateChange, (data) => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Govee ${d.id} state changed`);
-            this.updateDevice(d, data);
+    }
+    static async sendCommand(device, command) {
+        return new Promise((resolve, _reject) => {
+            const requestLink = `${this._serverUrl}/device/${device.deviceId}/${command}`;
+            const req = http.get(requestLink, (res) => {
+                if (res.statusCode !== 200) {
+                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `Failed to send Govee Command(${requestLink}): ${res.statusCode} - ${res.statusMessage}`);
+                    resolve(false);
+                    return;
+                }
+                resolve(true);
+                return;
+            });
+            req.on('error', (e) => {
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Govee Error: ${e.message}`);
+            });
         });
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Govee ${d.id} found at address ${d.ipAddr}`);
     }
-    static updateDevice(device, data) {
-        if (this.ownDevices[device.id] === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `Unknown Govee Device "${device.id}"`);
-            return;
-        }
-        this.ownDevices[device.id].update(data);
+    static loadDevices() {
+        const req = http.get(`${this._serverUrl}/devices`, (res) => {
+            if (res.statusCode !== 200) {
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `Failed to load Govee Devices: ${res.statusCode}`);
+                return;
+            }
+            res.on('data', (d) => {
+                const data = JSON.parse(d.toString());
+                Object.keys(data).forEach((key) => {
+                    const deviceData = data[key];
+                    const ownDevice = this.ownDevices[key];
+                    if (ownDevice === undefined) {
+                        log_service_1.ServerLogService.writeLog(models_1.LogLevel.DeepTrace, `Unknown Govee Device "${key}"`);
+                        return;
+                    }
+                    ownDevice.update(deviceData);
+                });
+            });
+        });
+        req.on('error', (e) => {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Govee Error: ${e.message}`);
+        });
     }
 }
 exports.GooveeService = GooveeService;
-GooveeService.all = [];
-GooveeService.devicesDict = {};
+GooveeService._serverUrl = 'http://127.0.0.1:3000';
 GooveeService.ownDevices = {};
+GooveeService._refreshInterval = null;

package/lib/server/services/govee/own-govee-device.d.ts

@@ -3,46 +3,49 @@ import { ActuatorSetStateCommand, ActuatorToggleCommand, ActuatorWriteStateToDev
 import { LogDebugType } from '../log-service';
 import { DeviceCapability } from '../../devices/DeviceCapability';
 import { iLedRgbCct } from '../../devices/baseDeviceInterfaces/iLedRgbCct';
-import { Device as GoveeDevice, DeviceStateInfo as GoveeDeviceStateInfo } from '@j3lte/govee-lan-controller';
 import { BlockAutomaticHandler } from '../blockAutomaticHandler';
-import { DeviceState as GoveeDeviceState } from '@j3lte/govee-lan-controller/build/types/device';
+import { GoveeDeviceData } from './govee-device-data';
 export declare class OwnGoveeDevice implements iLedRgbCct, iTemporaryDisableAutomatic {
-    device: GoveeDevice | undefined;
+    /** @inheritDoc */
     settings: LedSettings;
+    /** @inheritDoc */
     readonly deviceType: DeviceType;
+    /**
+     * The id of the device
+     */
     readonly deviceId: string;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
     readonly blockAutomationHandler: BlockAutomaticHandler;
-    on: boolean;
+    /** @inheritDoc */
     queuedValue: boolean | null;
+    /** @inheritDoc */
     brightness: number;
+    /** @inheritDoc */
     targetAutomaticState: boolean;
-    constructor(deviceId: string, ownDeviceName: string, roomName: string, device: GoveeDevice | undefined);
+    protected _info: DeviceInfo;
+    private _actuatorOn;
     private _color;
-    get color(): string;
     private _colortemp;
-    get colortemp(): number;
     private _room;
+    protected _lastPersist: number;
+    constructor(deviceId: string, ownDeviceName: string, roomName: string);
+    get color(): string;
+    get colortemp(): number;
     get room(): RoomBase;
     get customName(): string;
     get actuatorOn(): boolean;
-    get lightOn(): boolean;
-    protected _info: DeviceInfo;
     get info(): DeviceInfo;
-    set info(info: DeviceInfo);
     get id(): string;
     get name(): string;
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
     toJSON(): Partial<OwnGoveeDevice>;
     persistDeviceInfo(): void;
     loadDeviceSettings(): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setTimeBased(c: LampSetTimeBasedCommand): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setLight(c: LedSetLightCommand): void;
     setActuator(c: ActuatorSetStateCommand): void;
     restoreTargetAutomaticValue(c: RestoreTargetAutomaticValueCommand): void;
@@ -50,7 +53,7 @@ export declare class OwnGoveeDevice implements iLedRgbCct, iTemporaryDisableAuto
     toggleActuator(c: ActuatorToggleCommand): boolean;
     toggleLight(c: LampToggleLightCommand): boolean;
     writeActuatorStateToDevice(c: ActuatorWriteStateToDeviceCommand): void;
-    update(data: GoveeDeviceState & GoveeDeviceStateInfo): void;
+    update(data: GoveeDeviceData): void;
     private setBrightness;
     private setColor;
     private turnOn;

package/lib/server/services/govee/own-govee-device.js

@@ -12,24 +12,31 @@ const lodash_1 = __importDefault(require("lodash"));
 const DeviceCapability_1 = require("../../devices/DeviceCapability");
 const api_1 = require("../api");
 const blockAutomaticHandler_1 = require("../blockAutomaticHandler");
+const govee_service_1 = require("./govee-service");
 class OwnGoveeDevice {
-    constructor(deviceId, ownDeviceName, roomName, device) {
-        this.device = device;
+    constructor(deviceId, ownDeviceName, roomName) {
+        /** @inheritDoc */
         this.settings = new models_1.LedSettings();
+        /** @inheritDoc */
         this.deviceType = devices_1.DeviceType.GoveeLed;
+        /** @inheritDoc */
         this.deviceCapabilities = [
             DeviceCapability_1.DeviceCapability.ledLamp,
             DeviceCapability_1.DeviceCapability.lamp,
             DeviceCapability_1.DeviceCapability.dimmablelamp,
             DeviceCapability_1.DeviceCapability.blockAutomatic,
         ];
-        this.on = false;
+        /** @inheritDoc */
         this.queuedValue = null;
+        /** @inheritDoc */
         this.brightness = -1;
+        /** @inheritDoc */
         this.targetAutomaticState = false;
+        this._actuatorOn = false;
         this._color = '#fcba32';
         this._colortemp = 500;
         this._room = undefined;
+        this._lastPersist = 0;
         this.deviceId = deviceId;
         this._info = new devices_1.DeviceInfo();
         this._info.fullName = `Govee ${roomName} ${ownDeviceName}`;
@@ -38,7 +45,7 @@ class OwnGoveeDevice {
         this._info.allDevicesKey = `govee-${roomName}-${deviceId}`;
         devices_1.Devices.alLDevices[`govee-${roomName}-${deviceId}`] = this;
         this.persistDeviceInfo();
-        this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this));
+        this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this), this.log.bind(this));
         utils_1.Utils.guardedTimeout(this.loadDeviceSettings, 300, this);
     }
     get color() {
@@ -57,17 +64,11 @@ class OwnGoveeDevice {
         return this.info.customName;
     }
     get actuatorOn() {
-        return this.on;
-    }
-    get lightOn() {
-        return this.on;
+        return this._actuatorOn;
     }
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `govee-${this.info.room}-${this.info.customName}`;
@@ -77,7 +78,7 @@ class OwnGoveeDevice {
     }
     log(level, message, debugType = log_service_1.LogDebugType.None) {
         var _a, _b;
-        log_service_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
+        log_service_1.ServerLogService.writeLog(level, message, {
             debugType: debugType,
             room: (_b = (_a = this._room) === null || _a === void 0 ? void 0 : _a.roomName) !== null && _b !== void 0 ? _b : '',
             deviceId: this.name,
@@ -96,28 +97,34 @@ class OwnGoveeDevice {
     loadDeviceSettings() {
         this.settings.initializeFromDb(this);
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setTimeBased(c) {
         this.setLight(models_1.LedSetLightCommand.byTimeBased(this.settings, c));
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setLight(c) {
         if (c.on && c.brightness === -1 && this.brightness < 10) {
             c.brightness = 10;
         }
         this.log(models_1.LogLevel.Debug, c.logMessage, log_service_1.LogDebugType.SetActuator);
-        const formattedColor = utils_1.Utils.formatHex(c.color);
-        if (formattedColor !== null) {
-            this.setColor(c.color);
+        if (c.on) {
+            // Changing the color turns the device on as well --> Only change color on turn on actions
+            const formattedColor = utils_1.Utils.formatHex(c.color);
+            if (formattedColor !== null) {
+                this.setColor(c.color);
+            }
         }
         const dontBlock = devices_1.LampUtils.checkUnBlock(this, c);
         if (devices_1.LampUtils.checkBlockActive(this, c)) {
             return;
         }
+        if (c.isAutomaticAction) {
+            // Preserve the target state for the automatic handler, as
+            this.targetAutomaticState = c.on;
+        }
+        if (devices_1.LampUtils.canDimmerChangeBeSkipped(this, c)) {
+            return;
+        }
         if (c.brightness > -1 && c.on) {
             this.setBrightness(c.brightness, () => {
                 this.turnOn();
@@ -129,20 +136,24 @@ class OwnGoveeDevice {
         else {
             this.turnOff();
         }
-        if (c.timeout > -1 && !dontBlock) {
-            this.blockAutomationHandler.disableAutomatic(c.timeout, models_1.CollisionSolving.overrideIfGreater);
+        if (c.disableAutomaticCommand && !dontBlock) {
+            this.blockAutomationHandler.disableAutomatic(c.disableAutomaticCommand);
         }
     }
     setActuator(c) {
         this.setLight(new models_1.LedSetLightCommand(c, c.on, c.reason));
     }
     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.setActuator(new models_1.ActuatorSetStateCommand(c, this.targetAutomaticState));
     }
     persist() {
         var _a;
+        const now = utils_1.Utils.nowMS();
+        if (this._lastPersist + 1000 > now) {
+            return;
+        }
         (_a = utils_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistActuator(this);
+        this._lastPersist = now;
     }
     toggleActuator(c) {
         const setActuatorCommand = models_1.ActuatorSetStateCommand.byActuatorAndToggleCommand(this, c);
@@ -163,54 +174,57 @@ class OwnGoveeDevice {
     }
     update(data) {
         this.queuedValue = null;
-        this.on = data.onOff === 1;
+        const anyChanged = this._actuatorOn !== data.actuatorOn ||
+            this.brightness !== data.brightness ||
+            this._color !== data.hexColor ||
+            this._colortemp !== data.colortemp;
+        if (!anyChanged) {
+            return;
+        }
+        this._actuatorOn = data.actuatorOn;
         this.brightness = data.brightness;
-        this._color = `#${data.color.r.toString(16)}${data.color.g.toString(16)}${data.color.b.toString(16)}`;
-        this._colortemp = data.colorTemInKelvin;
+        this._color = data.hexColor;
+        this._colortemp = data.colortemp;
+        this.persist();
     }
     setBrightness(brightness, cb) {
-        var _a;
-        (_a = this.device) === null || _a === void 0 ? void 0 : _a.setBrightness(brightness).then(() => {
+        govee_service_1.GooveeService.sendCommand(this, `brightness/${brightness}`).then((result) => {
+            if (!result) {
+                this.log(models_1.LogLevel.Error, 'Govee set brightness resulted in error');
+            }
             cb();
-        }).catch((error) => {
-            this.log(models_1.LogLevel.Error, `Govee set brightness resulted in error: ${error}`);
         });
     }
     setColor(color) {
-        var _a;
-        if (color === this._color) {
-            return;
-        }
-        const colors = utils_1.Utils.hexToRgb(color);
-        if (colors === null) {
-            this.log(models_1.LogLevel.Error, `Govee set color resulted in error: ${color} is not a valid color`);
-            return;
-        }
-        (_a = this.device) === null || _a === void 0 ? void 0 : _a.setColorRGB(colors).then(() => {
-            this.log(models_1.LogLevel.Debug, `Govee set color to ${color}`, log_service_1.LogDebugType.SetActuator);
-        }).catch((error) => {
-            this.log(models_1.LogLevel.Error, `Govee set color resulted in error: ${error}`);
+        govee_service_1.GooveeService.sendCommand(this, `color/${color.replace('#', '')}`).then((result) => {
+            if (!result) {
+                this.log(models_1.LogLevel.Error, 'Govee set color resulted in error');
+            }
+            else {
+                this.log(models_1.LogLevel.Debug, `Govee set color to ${color}`, log_service_1.LogDebugType.SetActuator);
+            }
         });
     }
     turnOn() {
-        var _a;
-        if (this.on) {
-            return;
-        }
         this.queuedValue = true;
-        (_a = this.device) === null || _a === void 0 ? void 0 : _a.turnOn().then(() => {
-            this.log(models_1.LogLevel.Debug, `Govee turned on`, log_service_1.LogDebugType.SetActuator);
-        }).catch((error) => {
-            this.log(models_1.LogLevel.Error, `Govee turn on resulted in error: ${error}`);
+        govee_service_1.GooveeService.sendCommand(this, `on/true`).then((result) => {
+            if (!result) {
+                this.log(models_1.LogLevel.Error, 'Govee turn on resulted in error');
+            }
+            else {
+                this.log(models_1.LogLevel.Debug, `Govee turned on`, log_service_1.LogDebugType.SetActuator);
+            }
         });
     }
     turnOff() {
-        var _a;
         this.queuedValue = false;
-        (_a = this.device) === null || _a === void 0 ? void 0 : _a.turnOff().then(() => {
-            this.log(models_1.LogLevel.Debug, `Govee turned off`, log_service_1.LogDebugType.SetActuator);
-        }).catch((error) => {
-            this.log(models_1.LogLevel.Error, `Govee turn off resulted in error: ${error}`);
+        govee_service_1.GooveeService.sendCommand(this, `on/false`).then((result) => {
+            if (!result) {
+                this.log(models_1.LogLevel.Error, 'Govee turn off resulted in error');
+            }
+            else {
+                this.log(models_1.LogLevel.Debug, `Govee turned off`, log_service_1.LogDebugType.SetActuator);
+            }
         });
     }
 }

package/lib/server/services/govee/own-govee-devices.d.ts

@@ -1,5 +1,8 @@
 import { OwnGoveeDevice } from './own-govee-device';
 export declare class OwnGoveeDevices {
+    /**
+     * A Dictionary of all own Govee devices
+     */
     static ownDevices: {
         [name: string]: OwnGoveeDevice;
     };

package/lib/server/services/govee/own-govee-devices.js

@@ -10,4 +10,7 @@ class OwnGoveeDevices {
     }
 }
 exports.OwnGoveeDevices = OwnGoveeDevices;
+/**
+ * A Dictionary of all own Govee devices
+ */
 OwnGoveeDevices.ownDevices = {};

package/lib/server/services/https-service.d.ts

@@ -4,8 +4,9 @@ export declare class HTTPSService {
     /**
      * Downloads a file from a given url to the given location.
      * If the location doesn't exist, it will be created quietly.
-     * @param url URL to download file from
-     * @param filePath Path to save file to
+     * @param url - URL to download file from
+     * @param filePath - Path to save file to
+     * @returns A promise that resolves to true if the file was downloaded successfully, false otherwise
      */
     static downloadFile(url: string, filePath: string): Promise<boolean>;
     private static defaultCallback;

package/lib/server/services/https-service.js

@@ -54,7 +54,7 @@ class HTTPSService {
                 }, 100);
             }
             else {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `HTTPS request failed after retries`);
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, 'HTTPS request failed after retries');
             }
         });
         if (postData !== '') {
@@ -65,8 +65,9 @@ class HTTPSService {
     /**
      * Downloads a file from a given url to the given location.
      * If the location doesn't exist, it will be created quietly.
-     * @param url URL to download file from
-     * @param filePath Path to save file to
+     * @param url - URL to download file from
+     * @param filePath - Path to save file to
+     * @returns A promise that resolves to true if the file was downloaded successfully, false otherwise
      */
     static async downloadFile(url, filePath) {
         return new Promise((resolve, reject) => {

package/lib/server/services/index.d.ts

@@ -19,3 +19,4 @@ export * from './ShutterService';
 export * from './tibber-service';
 export * from './victron/index';
 export * from './time-callback-service';
+export { FileInfo } from './file-info';

package/lib/server/services/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileInfo = void 0;
 __exportStar(require("./ac/index"), exports);
 __exportStar(require("./api/index"), exports);
 __exportStar(require("./calendar/index"), exports);
@@ -35,3 +36,5 @@ __exportStar(require("./ShutterService"), exports);
 __exportStar(require("./tibber-service"), exports);
 __exportStar(require("./victron/index"), exports);
 __exportStar(require("./time-callback-service"), exports);
+var file_info_1 = require("./file-info");
+Object.defineProperty(exports, "FileInfo", { enumerable: true, get: function () { return file_info_1.FileInfo; } });

package/lib/server/services/log-service/index.d.ts

@@ -1,3 +1,4 @@
 export * from './log-service';
 export * from './log-object';
 export * from './log-filter-data';
+export { LogDebugType } from './log-debug-type';

package/lib/server/services/log-service/index.js

@@ -14,6 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogDebugType = void 0;
 __exportStar(require("./log-service"), exports);
 __exportStar(require("./log-object"), exports);
 __exportStar(require("./log-filter-data"), exports);
+var log_debug_type_1 = require("./log-debug-type");
+Object.defineProperty(exports, "LogDebugType", { enumerable: true, get: function () { return log_debug_type_1.LogDebugType; } });

package/lib/server/services/log-service/log-debug-type.d.ts

@@ -0,0 +1,13 @@
+export declare enum LogDebugType {
+    None = 0,
+    SkipUnchangedActuatorCommand = 1,
+    SkipUnchangedRolloPosition = 2,
+    SetActuator = 3,
+    ShutterPositionChange = 4,
+    NewMovementState = 5,
+    SkipUnchangedMovementState = 6,
+    DaikinSuccessfullControlInfo = 7,
+    EuroHeaterValveLogging = 8,
+    Trilateration = 9,
+    DachsUnreach = 10
+}

package/lib/server/services/log-service/log-debug-type.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogDebugType = void 0;
+var LogDebugType;
+(function (LogDebugType) {
+    LogDebugType[LogDebugType["None"] = 0] = "None";
+    LogDebugType[LogDebugType["SkipUnchangedActuatorCommand"] = 1] = "SkipUnchangedActuatorCommand";
+    LogDebugType[LogDebugType["SkipUnchangedRolloPosition"] = 2] = "SkipUnchangedRolloPosition";
+    LogDebugType[LogDebugType["SetActuator"] = 3] = "SetActuator";
+    LogDebugType[LogDebugType["ShutterPositionChange"] = 4] = "ShutterPositionChange";
+    LogDebugType[LogDebugType["NewMovementState"] = 5] = "NewMovementState";
+    LogDebugType[LogDebugType["SkipUnchangedMovementState"] = 6] = "SkipUnchangedMovementState";
+    LogDebugType[LogDebugType["DaikinSuccessfullControlInfo"] = 7] = "DaikinSuccessfullControlInfo";
+    LogDebugType[LogDebugType["EuroHeaterValveLogging"] = 8] = "EuroHeaterValveLogging";
+    LogDebugType[LogDebugType["Trilateration"] = 9] = "Trilateration";
+    LogDebugType[LogDebugType["DachsUnreach"] = 10] = "DachsUnreach";
+})(LogDebugType || (exports.LogDebugType = LogDebugType = {}));

package/lib/server/services/log-service/log-filter-data.d.ts

@@ -1,21 +1,30 @@
 import { LogSource } from '../../../models/logSource';
-export declare enum LogDebugType {
-    None = 0,
-    SkipUnchangedActuatorCommand = 1,
-    SkipUnchangedRolloPosition = 2,
-    SetActuator = 3,
-    ShutterPositionChange = 4,
-    NewMovementState = 5,
-    SkipUnchangedMovementState = 6,
-    DaikinSuccessfullControlInfo = 7,
-    EuroHeaterValveLogging = 8,
-    Trilateration = 9
-}
+import { LogDebugType } from './log-debug-type';
 export declare class LogFilterData {
+    /**
+     * If given, the room this log-item is related to
+     */
     room?: string;
+    /**
+     * If given, the device this log-item is related to identified by its ID
+     */
     deviceId?: string;
+    /**
+     * If given, the name of the device this log-item is related to
+     */
     deviceName?: string;
+    /**
+     * If given, the group this log-item can be associated with
+     * @example WindowGroup
+     */
     groupType?: string;
+    /**
+     * If given, a source identifying the origin of the log-item
+     * TODO: Add further sources
+     */
     source?: LogSource;
+    /**
+     * If given, the debug-type which in accordance to {@link iLogSettings} might result in this being filtered out
+     */
     debugType?: LogDebugType;
 }

package/lib/server/services/log-service/log-filter-data.js

@@ -1,22 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogFilterData = exports.LogDebugType = void 0;
-var LogDebugType;
-(function (LogDebugType) {
-    LogDebugType[LogDebugType["None"] = 0] = "None";
-    LogDebugType[LogDebugType["SkipUnchangedActuatorCommand"] = 1] = "SkipUnchangedActuatorCommand";
-    LogDebugType[LogDebugType["SkipUnchangedRolloPosition"] = 2] = "SkipUnchangedRolloPosition";
-    LogDebugType[LogDebugType["SetActuator"] = 3] = "SetActuator";
-    LogDebugType[LogDebugType["ShutterPositionChange"] = 4] = "ShutterPositionChange";
-    LogDebugType[LogDebugType["NewMovementState"] = 5] = "NewMovementState";
-    LogDebugType[LogDebugType["SkipUnchangedMovementState"] = 6] = "SkipUnchangedMovementState";
-    LogDebugType[LogDebugType["DaikinSuccessfullControlInfo"] = 7] = "DaikinSuccessfullControlInfo";
-    LogDebugType[LogDebugType["EuroHeaterValveLogging"] = 8] = "EuroHeaterValveLogging";
-    LogDebugType[LogDebugType["Trilateration"] = 9] = "Trilateration";
-})(LogDebugType || (exports.LogDebugType = LogDebugType = {}));
+exports.LogFilterData = void 0;
+const log_debug_type_1 = require("./log-debug-type");
 class LogFilterData {
     constructor() {
-        this.debugType = LogDebugType.None;
+        /**
+         * If given, the debug-type which in accordance to {@link iLogSettings} might result in this being filtered out
+         */
+        this.debugType = log_debug_type_1.LogDebugType.None;
     }
 }
 exports.LogFilterData = LogFilterData;