hoffmation-base 3.0.0-alpha.22 → 3.0.0-alpha.24

package/lib/server/services/ac/ac-device.js

@@ -15,15 +15,19 @@ const settings_service_1 = require("../settings-service");
 const config_1 = require("../../config");
 const blockAutomaticHandler_1 = require("../blockAutomaticHandler");
 class AcDevice {
+    /** @inheritDoc */
     get temperature() {
         return this._roomTemperature;
     }
+    /** @inheritDoc */
     get customName() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get room() {
         return this._room;
     }
+    /** @inheritDoc */
     set room(room) {
         var _a, _b;
         this._room = room;
@@ -33,14 +37,18 @@ class AcDevice {
             (_b = room === null || room === void 0 ? void 0 : room.PraesenzGroup) === null || _b === void 0 ? void 0 : _b.addLastLeftCallback(this.onRoomLastLeave.bind(this));
         }
     }
+    /** @inheritDoc */
     get mode() {
         return this._mode;
     }
     constructor(name, roomName, ip, acDeviceType) {
         this.ip = ip;
         this.acDeviceType = acDeviceType;
+        /** @inheritDoc */
         this.currentConsumption = -1;
+        /** @inheritDoc */
         this.settings = new models_1.AcSettings();
+        /** @inheritDoc */
         this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.ac, DeviceCapability_1.DeviceCapability.blockAutomatic];
         this._activatedByExcessEnergy = false;
         this._desiredTemperatur = devices_1.UNDEFINED_TEMP_VALUE;
@@ -58,32 +66,39 @@ class AcDevice {
         this.loadDeviceSettings();
         this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this));
     }
+    /** @inheritDoc */
     get energySettings() {
         return this.settings.energySettings;
     }
+    /** @inheritDoc */
     get roomTemperature() {
         return this._roomTemperature;
     }
+    /** @inheritDoc */
     get info() {
         return this._info;
     }
     set roomTemperatur(val) {
         this._roomTemperature = val;
     }
-    set info(info) {
-        this._info = info;
-    }
+    /**
+     * The name of this device
+     * @returns The human readable name of this device
+     */
     get name() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `ac-${this.info.room}-${this.info.customName}`;
     }
+    /** @inheritDoc */
     restoreTargetAutomaticValue() {
-        this.log(models_1.LogLevel.Debug, `Restore Target Automatic value`);
+        this.log(models_1.LogLevel.Debug, 'Restore Target Automatic value');
         this.automaticCheck();
     }
+    /** @inheritDoc */
     isAvailableForExcessEnergy() {
         var _a, _b;
         if (this.settings.useAutomatic || (((_b = (_a = this.room) === null || _a === void 0 ? void 0 : _a.HeatGroup) === null || _b === void 0 ? void 0 : _b.settings.automaticMode) && this.settings.heatingAllowed)) {
@@ -97,22 +112,23 @@ class AcDevice {
         }
         return this.calculateDesiredMode() !== ac_mode_1.AcMode.Off;
     }
+    /** @inheritDoc */
     calculateDesiredMode() {
         var _a, _b, _c, _d, _e, _f, _g;
         const acOn = this.on;
         const heatGroup = (_a = this.room) === null || _a === void 0 ? void 0 : _a.HeatGroup;
         if (!heatGroup) {
-            this.log(models_1.LogLevel.Warn, `Can't calculate AC Mode as we have no heat group`);
+            this.log(models_1.LogLevel.Warn, "Can't calculate AC Mode as we have no heat group");
             return ac_mode_1.AcMode.Off;
         }
         this._desiredTemperatur = heatGroup.desiredTemp;
         if (this.settings.manualDisabled) {
-            acOn && this.log(models_1.LogLevel.Info, `We should turn off now, as manual disable force is set.`);
+            acOn && this.log(models_1.LogLevel.Info, 'We should turn off now, as manual disable force is set.');
             return ac_mode_1.AcMode.Off;
         }
         // Check Turn Off Time
         if (!utils_1.Utils.timeWithinBorders(this.settings.minimumHours, this.settings.minimumMinutes, this.settings.maximumHours, this.settings.maximumMinutes)) {
-            acOn && this.log(models_1.LogLevel.Info, `We should turn off now, to respect night settings.`);
+            acOn && this.log(models_1.LogLevel.Info, 'We should turn off now, to respect night settings.');
             return ac_mode_1.AcMode.Off;
         }
         if (this.settings.useOwnTemperature) {
@@ -130,11 +146,11 @@ class AcDevice {
         }
         const temp = this.roomTemperature;
         if (temp === undefined || temp === devices_1.UNDEFINED_TEMP_VALUE) {
-            this.log(models_1.LogLevel.Warn, `Can't calculate AC Mode as we have no room temperature`);
+            this.log(models_1.LogLevel.Warn, "Can't calculate AC Mode as we have no room temperature");
             return ac_mode_1.AcMode.Off;
         }
         if (!heatGroup) {
-            this.log(models_1.LogLevel.Warn, `Can't calculate AC Mode as we have no heat group`);
+            this.log(models_1.LogLevel.Warn, "Can't calculate AC Mode as we have no heat group");
             return ac_mode_1.AcMode.Off;
         }
         let threshold = acOn ? 0.5 : 1.5;
@@ -163,9 +179,13 @@ class AcDevice {
         }
         return desiredMode;
     }
+    /** @inheritDoc */
     onTemperaturChange(newTemperatur) {
         this.roomTemperatur = newTemperatur;
     }
+    /**
+     * Persists the current AC-Information to the database
+     */
     persist() {
         var _a;
         if (!utils_1.Utils.anyDboActive || this.on === undefined) {
@@ -173,6 +193,7 @@ class AcDevice {
         }
         (_a = utils_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistAC(this);
     }
+    /** @inheritDoc */
     turnOnForExcessEnergy() {
         if (this.blockAutomationHandler.automaticBlockActive) {
             return;
@@ -181,10 +202,17 @@ class AcDevice {
         this.setDesiredMode(this.calculateDesiredMode(), false);
         this.turnOn();
     }
+    /** @inheritDoc */
     turnOffDueToMissingEnergy() {
         this.turnOff();
     }
-    // TODO: Migrate to new command system
+    /**
+     * Sets the state of the AC
+     * TODO: Migrate to new command system
+     * @param mode - The desired mode
+     * @param desiredTemp - The desired temperature (if unset it will be calculated)
+     * @param forceTime - The time in ms to force the AC to stay in this state (default 1h)
+     */
     setState(mode, desiredTemp, forceTime = 60 * 60 * 1000) {
         this.blockAutomationHandler.disableAutomatic(new models_1.BlockAutomaticCommand(models_1.CommandSource.Unknown, forceTime));
         this._mode = mode;
@@ -195,6 +223,7 @@ class AcDevice {
         this.setDesiredMode(mode, false, desiredTemp);
         this.turnOn();
     }
+    /** @inheritDoc */
     log(level, message, debugType = log_service_1.LogDebugType.None) {
         var _a, _b;
         log_service_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
@@ -204,12 +233,15 @@ class AcDevice {
             deviceName: this.name,
         });
     }
+    /** @inheritDoc */
     wasActivatedByExcessEnergy() {
         return this._activatedByExcessEnergy;
     }
+    /** @inheritDoc */
     loadDeviceSettings() {
         this.settings.initializeFromDb(this);
     }
+    /** @inheritDoc */
     persistDeviceInfo() {
         utils_1.Utils.guardedTimeout(() => {
             var _a;
@@ -237,16 +269,17 @@ class AcDevice {
         if (!this.settings.noCoolingOnMovement || !this.on || this.mode === ac_mode_1.AcMode.Heating) {
             return;
         }
-        this.log(models_1.LogLevel.Info, `Someone entered the room. Turning off AC`);
+        this.log(models_1.LogLevel.Info, 'Someone entered the room. Turning off AC');
         this.turnOff();
     }
     onRoomLastLeave() {
         if (!this.settings.noCoolingOnMovement) {
             return;
         }
-        this.log(models_1.LogLevel.Info, `Last person left the room. Checking if we should turn on AC`);
+        this.log(models_1.LogLevel.Info, 'Last person left the room. Checking if we should turn on AC');
         this.restoreTargetAutomaticValue();
     }
+    /** @inheritDoc */
     toJSON() {
         // eslint-disable-next-line
         const result = lodash_1.default.omit(this, ['room', '_room']);

package/lib/server/services/ac/daikin-service.js

@@ -41,14 +41,14 @@ class DaikinService {
             DaikinService.setAll(true);
             Telegram_1.TelegramService.sendMessage([m.chat.id], 'Command executed');
             return true;
-        }, `Turns all Ac's on without changing any settings`));
+        }, "Turns all Ac's on without changing any settings"));
         Telegram_1.TelegramService.addMessageCallback(new Telegram_1.TelegramMessageCallback('AcOff', /\/ac_off/, async (m) => {
             if (m.from === undefined)
                 return false;
             DaikinService.setAll(false, true);
             Telegram_1.TelegramService.sendMessage([m.chat.id], 'Command executed');
             return true;
-        }, `Turns all Ac's off without changing any settings`));
+        }, "Turns all Ac's off without changing any settings"));
         return new Promise((res, _rej) => {
             var _a, _b;
             this._daikinManager = new daikin_controller_1.DaikinManager({

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

@@ -1,5 +1,8 @@
 import { AcDevice } from './ac-device';
 export declare class OwnAcDevices {
+    /**
+     * A dict containing the AC-Devices
+     */
     static ownDevices: {
         [name: string]: AcDevice;
     };

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

@@ -12,4 +12,7 @@ class OwnAcDevices {
     }
 }
 exports.OwnAcDevices = OwnAcDevices;
+/**
+ * A dict containing the AC-Devices
+ */
 OwnAcDevices.ownDevices = {};

package/lib/server/services/ac/own-daikin-device.d.ts

@@ -5,22 +5,39 @@ import { DeviceType } from '../../devices';
 export declare class OwnDaikinDevice extends AcDevice {
     private _device;
     private _mac;
+    /**
+     * The desired state of the device
+     */
     desiredState: boolean;
+    /**
+     * The desired humidity-state of the device
+     * @default 'AUTO'
+     */
     desiredHum: number | 'AUTO';
+    /**
+     * The desired mode of the device
+     * @default Mode.COLD
+     */
     desiredMode: number;
+    /** @inheritDoc */
     deviceType: DeviceType;
     private _on;
     constructor(name: string, roomName: string, ip: string, _device: DaikinAC | undefined, _mac?: string | undefined);
     get device(): DaikinAC | undefined;
+    /** @inheritDoc */
     get on(): boolean;
     set device(device: DaikinAC | undefined);
+    /** @inheritDoc */
     setDesiredMode(mode: AcMode, writeToDevice?: boolean, desiredTemp?: number): void;
+    /** @inheritDoc */
     turnOn(): void;
+    /** @inheritDoc */
     turnOff(): void;
     protected automaticCheck(): void;
     private setDesiredInfo;
     private updateInfo;
     private handleDeviceUnreach;
     private handleParamNg;
+    /** @inheritDoc */
     toJSON(): Partial<OwnDaikinDevice>;
 }

package/lib/server/services/ac/own-daikin-device.js

@@ -20,15 +20,28 @@ class OwnDaikinDevice extends ac_device_1.AcDevice {
         super(name, roomName, ip, acDeviceType_1.AcDeviceType.Daikin);
         this._device = _device;
         this._mac = _mac;
+        /**
+         * The desired state of the device
+         */
         this.desiredState = daikin_controller_1.Power.OFF;
+        /**
+         * The desired humidity-state of the device
+         * @default 'AUTO'
+         */
         this.desiredHum = 'AUTO';
+        /**
+         * The desired mode of the device
+         * @default Mode.COLD
+         */
         this.desiredMode = daikin_controller_1.Mode.COLD;
+        /** @inheritDoc */
         this.deviceType = devices_1.DeviceType.Daikin;
         this._on = false;
     }
     get device() {
         return this._device;
     }
+    /** @inheritDoc */
     get on() {
         return this._on;
     }
@@ -45,6 +58,7 @@ class OwnDaikinDevice extends ac_device_1.AcDevice {
         }
         void this.updateInfo();
     }
+    /** @inheritDoc */
     setDesiredMode(mode, writeToDevice = true, desiredTemp) {
         let newMode = -1;
         switch (mode) {
@@ -67,13 +81,15 @@ class OwnDaikinDevice extends ac_device_1.AcDevice {
             this.setDesiredInfo(false, desiredTemp);
         }
     }
+    /** @inheritDoc */
     turnOn() {
-        this.log(models_1.LogLevel.Info, `Turning on`);
+        this.log(models_1.LogLevel.Info, 'Turning on');
         this.desiredState = daikin_controller_1.Power.ON;
         this.setDesiredInfo();
     }
+    /** @inheritDoc */
     turnOff() {
-        this.log(models_1.LogLevel.Info, `Turning off`);
+        this.log(models_1.LogLevel.Info, 'Turning off');
         this._activatedByExcessEnergy = false;
         this.desiredState = daikin_controller_1.Power.OFF;
         this._mode = ac_mode_1.AcMode.Off;
@@ -128,7 +144,7 @@ class OwnDaikinDevice extends ac_device_1.AcDevice {
                 this.persist();
             }
             else {
-                this.log(models_1.LogLevel.Warn, `No Error, but also no response...`);
+                this.log(models_1.LogLevel.Warn, 'No Error, but also no response...');
             }
         });
     }
@@ -169,6 +185,7 @@ class OwnDaikinDevice extends ac_device_1.AcDevice {
             }
         });
     }
+    /** @inheritDoc */
     toJSON() {
         // eslint-disable-next-line
         const result = lodash_1.default.omit(this, ['room', '_room', 'device', '_device']);

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

@@ -45,7 +45,7 @@ export declare class API {
      * @param state - The desired new state
      * @param timeout - Desired time after which this should be reverted to normal state
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.lampSetLight" instead
+     * @deprecated Use {@link API.lampSetLight} instead
      * TODO: Remove deprecated API method
      */
     static setLamp(deviceId: string, state: boolean, timeout?: number): Error | null;
@@ -62,7 +62,7 @@ export declare class API {
      * @param state - The desired new state
      * @param timeout - Desired time after which this should be reverted to automatic state
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.actuatorSetState" instead
+     * @deprecated Use {@link API.actuatorSetState} instead
      * TODO: Remove deprecated API method
      */
     static setActuator(deviceId: string, state: boolean, timeout?: number): Error | null;
@@ -81,7 +81,7 @@ export declare class API {
      * @param brightness - The desired brightness
      * @param transitionTime - The transition time during turnOn/turnOff
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.dimmerSetLight" instead
+     * @deprecated Use {@link API.dimmerSetLight} instead
      * TODO: Remove deprecated API method
      */
     static setDimmer(deviceId: string, state: boolean, timeout?: number, brightness?: number, transitionTime?: number): Error | null;
@@ -102,7 +102,7 @@ export declare class API {
      * @param color - The desired color in 6 digit hex Code
      * @param colorTemp - The desired color Temperature (0 = more White)
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.ledSetLight" instead
+     * @deprecated Use {@link API.ledSetLight} instead
      * TODO: Remove deprecated API method
      */
     static setLedLamp(deviceId: string, state: boolean, timeout?: number, brightness?: number, transitionTime?: number, color?: string, colorTemp?: number): Error | null;
@@ -119,7 +119,7 @@ export declare class API {
      * @param deviceId - The device Id of the shutter
      * @param level - The desired new level (0 being open, 100 being closed)
      * @returns Error if there is no shutter with the given id
-     * @deprecated Use "API.shutterSetLevel" instead
+     * @deprecated Use {@link API.shutterSetLevel} instead
      * TODO: Remove deprecated API method
      */
     static setShutter(deviceId: string, level: number): Error | null;
@@ -162,8 +162,8 @@ export declare class API {
      * Lifts a previously started Block of automatic
      * @param deviceId - The target device
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.blockAutomaticLiftAutomaticBlock" instead
-     * TODO: Remove deprecated API method
+     * @deprecated Use {@link API.blockAutomaticLiftAutomaticBlock} instead
+     * TODO: V4 Remove deprecated API method
      */
     static liftAutomaticBlock(deviceId: string): Error | null;
     /**
@@ -179,7 +179,7 @@ export declare class API {
      * @param duration - The duration in ms for which the device should remain in current state
      * @param onCollision - The desired Collision Solving strategy, in case the automatic being blocked already
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.blockAutomaticDisable" instead
+     * @deprecated Use {@link API.blockAutomaticSetBlock} instead
      * TODO: Remove deprecated API method
      */
     static blockAutomatic(deviceId: string, duration: number, onCollision?: CollisionSolving): Error | null;

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

@@ -23,7 +23,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.scene)) {
             return new Error(`Device with ID ${deviceId} is no scene`);
         }
-        d.log(models_1.LogLevel.Info, `API Call to end this.`);
+        d.log(models_1.LogLevel.Info, 'API Call to end this.');
         d.endScene();
         return null;
     }
@@ -50,7 +50,7 @@ class API {
         if (d === undefined) {
             log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `Api.getDevice() --> "${id}" not found`);
         }
-        return devices_1.Devices.alLDevices[id];
+        return d;
     }
     // TODO: Missing Comment
     static getGroup(id) {
@@ -118,11 +118,11 @@ class API {
      * @param state - The desired new state
      * @param timeout - Desired time after which this should be reverted to normal state
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.lampSetLight" instead
+     * @deprecated Use {@link API.lampSetLight} instead
      * TODO: Remove deprecated API method
      */
     static setLamp(deviceId, state, timeout = 60 * 60 * 1000) {
-        return this.lampSetLight(deviceId, new models_1.LampSetLightCommand(models_1.CommandSource.API, state, '', timeout));
+        return this.lampSetLight(deviceId, new models_1.LampSetLightCommand(models_1.CommandSource.API, state, '', new models_1.BlockAutomaticCommand(models_1.CommandSource.API, timeout)));
     }
     /**
      * Changes the status of a given Lamp
@@ -138,7 +138,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.lamp)) {
             return new Error(`Device with ID ${deviceId} is no Lamp`);
         }
-        d.log(models_1.LogLevel.Info, `Received LampSetLightCommand API call.`);
+        d.log(models_1.LogLevel.Info, 'Received LampSetLightCommand API call.');
         d.setLight(c);
         return null;
     }
@@ -148,11 +148,11 @@ class API {
      * @param state - The desired new state
      * @param timeout - Desired time after which this should be reverted to automatic state
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.actuatorSetState" instead
+     * @deprecated Use {@link API.actuatorSetState} instead
      * TODO: Remove deprecated API method
      */
     static setActuator(deviceId, state, timeout = 60 * 60 * 1000) {
-        return this.actuatorSetState(deviceId, new models_1.ActuatorSetStateCommand(models_1.CommandSource.API, state, '', timeout));
+        return this.actuatorSetState(deviceId, new models_1.ActuatorSetStateCommand(models_1.CommandSource.API, state, '', new models_1.BlockAutomaticCommand(models_1.CommandSource.API, timeout)));
     }
     /**
      * Changes the status of a given actuator
@@ -168,7 +168,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.actuator)) {
             return new Error(`Device with ID ${deviceId} is no actuator`);
         }
-        d.log(models_1.LogLevel.Info, `Received ActuatorSetStateCommand API call.`);
+        d.log(models_1.LogLevel.Info, 'Received ActuatorSetStateCommand API call.');
         d.setActuator(c);
         return null;
     }
@@ -180,11 +180,11 @@ class API {
      * @param brightness - The desired brightness
      * @param transitionTime - The transition time during turnOn/turnOff
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.dimmerSetLight" instead
+     * @deprecated Use {@link API.dimmerSetLight} instead
      * TODO: Remove deprecated API method
      */
     static setDimmer(deviceId, state, timeout, brightness, transitionTime) {
-        return this.dimmerSetLight(deviceId, new models_1.DimmerSetLightCommand(models_1.CommandSource.API, state, '', timeout, brightness, transitionTime));
+        return this.dimmerSetLight(deviceId, new models_1.DimmerSetLightCommand(models_1.CommandSource.API, state, '', new models_1.BlockAutomaticCommand(models_1.CommandSource.API, timeout), brightness, transitionTime));
     }
     /**
      * Changes the status of the given dimmer
@@ -200,7 +200,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.dimmablelamp)) {
             return new Error(`Device with ID ${deviceId} is no dimmablelamp`);
         }
-        d.log(models_1.LogLevel.Info, `Received dimmerSetLight API call.`);
+        d.log(models_1.LogLevel.Info, 'Received dimmerSetLight API call.');
         d.setLight(command);
         return null;
     }
@@ -214,11 +214,11 @@ class API {
      * @param color - The desired color in 6 digit hex Code
      * @param colorTemp - The desired color Temperature (0 = more White)
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.ledSetLight" instead
+     * @deprecated Use {@link API.ledSetLight} instead
      * TODO: Remove deprecated API method
      */
     static setLedLamp(deviceId, state, timeout, brightness, transitionTime, color, colorTemp) {
-        return this.ledSetLight(deviceId, new models_1.LedSetLightCommand(models_1.CommandSource.API, state, '', timeout, brightness, transitionTime, color, colorTemp));
+        return this.ledSetLight(deviceId, new models_1.LedSetLightCommand(models_1.CommandSource.API, state, '', new models_1.BlockAutomaticCommand(models_1.CommandSource.API, timeout), brightness, transitionTime, color, colorTemp));
     }
     /**
      * Changes the status of a given led-device
@@ -234,7 +234,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.ledLamp)) {
             return new Error(`Device with ID ${deviceId} is no LED`);
         }
-        d.log(models_1.LogLevel.Info, `Received ledSetLight API call.`);
+        d.log(models_1.LogLevel.Info, 'Received ledSetLight API call.');
         d.setLight(command);
         return null;
     }
@@ -244,7 +244,7 @@ class API {
      * @param deviceId - The device Id of the shutter
      * @param level - The desired new level (0 being open, 100 being closed)
      * @returns Error if there is no shutter with the given id
-     * @deprecated Use "API.shutterSetLevel" instead
+     * @deprecated Use {@link API.shutterSetLevel} instead
      * TODO: Remove deprecated API method
      */
     static setShutter(deviceId, level) {
@@ -272,7 +272,7 @@ class API {
         else {
             d.setLevel(command);
         }
-        d.log(models_1.LogLevel.Info, `Received shutterSetLevel API call.`);
+        d.log(models_1.LogLevel.Info, 'Received shutterSetLevel API call.');
         return null;
     }
     // TODO: Missing Comment
@@ -302,7 +302,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.scene)) {
             return new Error(`Device with ID ${deviceId} is no scene`);
         }
-        d.log(models_1.LogLevel.Info, `API Call to start this.`);
+        d.log(models_1.LogLevel.Info, 'API Call to start this.');
         d.startScene(turnOffTimeout);
         return null;
     }
@@ -315,11 +315,11 @@ class API {
             return new Error(`Device with ID ${deviceId} is no Garage Door Opener`);
         }
         if (open) {
-            d.log(models_1.LogLevel.Info, `API Call to open Garage Door`);
+            d.log(models_1.LogLevel.Info, 'API Call to open Garage Door');
             d.open();
         }
         else {
-            d.log(models_1.LogLevel.Info, `API Call to close Garage Door`);
+            d.log(models_1.LogLevel.Info, 'API Call to close Garage Door');
             d.close();
         }
         return null;
@@ -387,14 +387,14 @@ class API {
     // TODO: Missing Comment
     static persistAllDeviceSettings() {
         var _a;
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `API Call to persist all device settings`);
+        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'API Call to persist all device settings');
         for (const device of Object.values(devices_1.Devices.alLDevices)) {
             (_a = device.settings) === null || _a === void 0 ? void 0 : _a.persist(device);
         }
     }
     // TODO: Missing Comment
     static loadAllDeviceSettingsFromDb() {
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `API Call to load all device settings`);
+        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'API Call to load all device settings');
         for (const device of Object.values(devices_1.Devices.alLDevices)) {
             device.loadDeviceSettings();
         }
@@ -403,8 +403,8 @@ class API {
      * Lifts a previously started Block of automatic
      * @param deviceId - The target device
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.blockAutomaticLiftAutomaticBlock" instead
-     * TODO: Remove deprecated API method
+     * @deprecated Use {@link API.blockAutomaticLiftAutomaticBlock} instead
+     * TODO: V4 Remove deprecated API method
      */
     static liftAutomaticBlock(deviceId) {
         return this.blockAutomaticLiftAutomaticBlock(deviceId, new models_1.BlockAutomaticLiftBlockCommand(models_1.CommandSource.API));
@@ -423,7 +423,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.blockAutomatic)) {
             return new Error(`Device with ID ${deviceId} is not capable of blocking automatic`);
         }
-        d.log(models_1.LogLevel.Info, `Received API Call to lift automatic block.`);
+        d.log(models_1.LogLevel.Info, 'Received API Call to lift automatic block.');
         d.blockAutomationHandler.liftAutomaticBlock(command);
         return null;
     }
@@ -433,7 +433,7 @@ class API {
      * @param duration - The duration in ms for which the device should remain in current state
      * @param onCollision - The desired Collision Solving strategy, in case the automatic being blocked already
      * @returns In case it failed the Error containing the reason
-     * @deprecated Use "API.blockAutomaticDisable" instead
+     * @deprecated Use {@link API.blockAutomaticSetBlock} instead
      * TODO: Remove deprecated API method
      */
     static blockAutomatic(deviceId, duration, onCollision) {
@@ -454,7 +454,7 @@ class API {
         if (!d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.blockAutomatic)) {
             return new Error(`Device with ID ${deviceId} is not capable of blocking automatic`);
         }
-        d.log(models_1.LogLevel.Info, `Received API Call to block automatic.`);
+        d.log(models_1.LogLevel.Info, 'Received API Call to block automatic.');
         d.blockAutomationHandler.disableAutomatic(command);
         return null;
     }

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

@@ -1,4 +1,8 @@
 import { BlockAutomaticCommand, BlockAutomaticLiftBlockCommand, BlockAutomaticUntilCommand, RestoreTargetAutomaticValueCommand } from '../../models';
+/**
+ * This class is responsible for blocking automatic actions for a specific duration.
+ * It also provides the possibility to lift the block before the duration is over {@link BlockAutomaticLiftBlockCommand}.
+ */
 export declare class BlockAutomaticHandler {
     private readonly _restoreAutomatic;
     private _automaticBlockedUntil;
@@ -10,6 +14,7 @@ export declare class BlockAutomaticHandler {
     disableAutomatic(c: BlockAutomaticCommand): void;
     disableAutomaticUntil(c: BlockAutomaticUntilCommand): void;
     liftAutomaticBlock(c: BlockAutomaticLiftBlockCommand): void;
+    private removeRestoreTimeout;
     private updateRestoreTimeout;
     toJSON(): Partial<BlockAutomaticHandler>;
 }