hoffmation-base 3.0.0-alpha.8 → 3.0.0-alpha.81

package/lib/models/command/dimmerSetLightCommand.d.ts

@@ -4,19 +4,24 @@ import { CommandSource } from './commandSource';
 import { BaseCommand } from './baseCommand';
 import { LampSetTimeBasedCommand } from './lampSetTimeBasedCommand';
 import { DimmerSettings } from '../deviceSettings';
+import { BlockAutomaticCommand } from './blockAutomaticCommand';
 export declare class DimmerSetLightCommand extends LampSetLightCommand {
     brightness: number;
     transitionTime: number;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
     /**
-     * @param {CommandSource | BaseCommand} source
-     * @param {boolean} on The desired value
-     * @param {string} reason
-     * @param {number} timeout  A chosen Timeout after which the light should be reset
-     * @param {number} brightness The desired brightness
-     * @param {number} transitionTime The transition time during turnOn/turnOff
+     * Command to change the light of a dimmer
+     * @param source - The source of the command
+     * @param on - The desired value
+     * @param reason - You can provide a reason for clarity
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
+     * @param brightness - The desired brightness
+     * @param transitionTime - The transition time during turnOn/turnOff
      */
-    constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number, brightness?: number, transitionTime?: number);
+    constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, disableAutomatic?: BlockAutomaticCommand | null, brightness?: number, transitionTime?: number);
+    /** @inheritDoc */
     get logMessage(): string;
     static byTimeBased(s: DimmerSettings, c: LampSetTimeBasedCommand): DimmerSetLightCommand;
 }

package/lib/models/command/dimmerSetLightCommand.js

@@ -6,32 +6,38 @@ const commandType_1 = require("./commandType");
 const timeCallback_1 = require("../timeCallback");
 class DimmerSetLightCommand extends lampSetLightCommand_1.LampSetLightCommand {
     /**
-     * @param {CommandSource | BaseCommand} source
-     * @param {boolean} on The desired value
-     * @param {string} reason
-     * @param {number} timeout  A chosen Timeout after which the light should be reset
-     * @param {number} brightness The desired brightness
-     * @param {number} transitionTime The transition time during turnOn/turnOff
+     * Command to change the light of a dimmer
+     * @param source - The source of the command
+     * @param on - The desired value
+     * @param reason - You can provide a reason for clarity
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
+     * @param brightness - The desired brightness
+     * @param transitionTime - The transition time during turnOn/turnOff
      */
-    constructor(source, on, reason = '', timeout = -1, brightness = -1, transitionTime = -1) {
-        super(source, on, reason, timeout);
+    constructor(source, on, reason = '', disableAutomatic, brightness = -1, transitionTime = -1) {
+        super(source, on, reason, disableAutomatic);
         this.brightness = brightness;
         this.transitionTime = transitionTime;
-        this._commandType = commandType_1.CommandType.DimmerSetLightCommand;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.DimmerSetLightCommand;
     }
+    /** @inheritDoc */
     get logMessage() {
-        return `Dimmer setLight to ${this.on} for reason: ${this.reasonTrace}`;
+        var _a;
+        return `Dimmer setLight to ${this.on} with Brightness ${this.brightness} with disable ${(_a = this.disableAutomaticCommand) === null || _a === void 0 ? void 0 : _a.logMessage} for reason: ${this.reasonTrace}`;
     }
     static byTimeBased(s, c) {
+        const manual = c.isForceAction;
         switch (c.time) {
             case timeCallback_1.TimeOfDay.Daylight:
-                return new DimmerSetLightCommand(c, true, 'By TimeBased Daylight', c.timeout, s.dayBrightness);
+                return new DimmerSetLightCommand(c, manual || s.dayOn, 'Daylight', c.disableAutomaticCommand, s.dayBrightness);
             case timeCallback_1.TimeOfDay.BeforeSunrise:
-                return new DimmerSetLightCommand(c, s.dawnOn, '', c.timeout, s.dawnBrightness, undefined);
+                return new DimmerSetLightCommand(c, manual || s.dawnOn, 'Dawn', c.disableAutomaticCommand, s.dawnBrightness, undefined);
             case timeCallback_1.TimeOfDay.AfterSunset:
-                return new DimmerSetLightCommand(c, s.duskOn, '', c.timeout, s.duskBrightness, undefined);
+                return new DimmerSetLightCommand(c, manual || s.duskOn, 'Dusk', c.disableAutomaticCommand, s.duskBrightness, undefined);
             case timeCallback_1.TimeOfDay.Night:
-                return new DimmerSetLightCommand(c, s.nightOn, '', c.timeout, s.nightBrightness, undefined);
+                return new DimmerSetLightCommand(c, manual || s.nightOn, 'Night', c.disableAutomaticCommand, s.nightBrightness, undefined);
             default:
                 throw new Error(`TimeOfDay ${c.time} not supported`);
         }

package/lib/models/command/floorSetAllShuttersCommand.d.ts

@@ -4,13 +4,14 @@ import { CommandType } from './commandType';
 export declare class FloorSetAllShuttersCommand extends BaseCommand {
     readonly position: number;
     readonly specificFloor: number | undefined;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
     /**
      * Creates an instance of FloorSetAllShuttersCommand.
-     * @param {CommandSource | BaseCommand} source
-     * @param {number} position (0 closed, 100 open)
-     * @param {number | undefined} specificFloor  undefined = all floors
-     * @param {string} reason
+     * @param source - The source of the command
+     * @param position - (0 closed, 100 open)
+     * @param specificFloor - undefined = all floors
+     * @param reason - You can provide a reason for clarity
      */
     constructor(source: CommandSource | BaseCommand, position: number, specificFloor?: number | undefined, reason?: string);
 }

package/lib/models/command/floorSetAllShuttersCommand.js

@@ -6,16 +6,17 @@ const commandType_1 = require("./commandType");
 class FloorSetAllShuttersCommand extends baseCommand_1.BaseCommand {
     /**
      * Creates an instance of FloorSetAllShuttersCommand.
-     * @param {CommandSource | BaseCommand} source
-     * @param {number} position (0 closed, 100 open)
-     * @param {number | undefined} specificFloor  undefined = all floors
-     * @param {string} reason
+     * @param source - The source of the command
+     * @param position - (0 closed, 100 open)
+     * @param specificFloor - undefined = all floors
+     * @param reason - You can provide a reason for clarity
      */
     constructor(source, position, specificFloor = undefined, reason = '') {
         super(source, reason);
         this.position = position;
         this.specificFloor = specificFloor;
-        this._commandType = commandType_1.CommandType.FloorSetAllShuttersCommand;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.FloorSetAllShuttersCommand;
     }
 }
 exports.FloorSetAllShuttersCommand = FloorSetAllShuttersCommand;

package/lib/models/command/index.d.ts

@@ -1,3 +1,6 @@
+export { BlockAutomaticCommand } from './blockAutomaticCommand';
+export { BlockAutomaticUntilCommand } from './blockAutomaticUntilCommand';
+export { BlockAutomaticLiftBlockCommand } from './blockAutomaticLiftBlockCommand';
 export { RestoreTargetAutomaticValueCommand } from './restoreTargetAutomaticValueCommand';
 export { ActuatorSetStateCommand } from './actuatorSetStateCommand';
 export { ActuatorToggleCommand } from './actuatorToggleCommand';

package/lib/models/command/index.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WledSetLightCommand = exports.WindowSetRolloByWeatherStatusCommand = exports.WindowSetDesiredPositionCommand = exports.WindowRestoreDesiredPositionCommand = exports.ShutterSunsetDownCommand = exports.ShutterSunriseUpCommand = exports.ShutterSetLevelCommand = exports.RoomSetLightTimeBasedCommand = exports.RoomRestoreShutterPositionCommand = exports.RoomRestoreLightCommand = exports.LightGroupSwitchTimeConditionalCommand = exports.LedSetLightCommand = exports.LampToggleLightCommand = exports.LampSetTimeBasedCommand = exports.LampSetLightCommand = exports.FloorSetAllShuttersCommand = exports.DimmerSetLightCommand = exports.CommandType = exports.CommandSource = exports.BaseCommand = exports.ActuatorWriteStateToDeviceCommand = exports.ActuatorToggleCommand = exports.ActuatorSetStateCommand = exports.RestoreTargetAutomaticValueCommand = void 0;
+exports.WledSetLightCommand = exports.WindowSetRolloByWeatherStatusCommand = exports.WindowSetDesiredPositionCommand = exports.WindowRestoreDesiredPositionCommand = exports.ShutterSunsetDownCommand = exports.ShutterSunriseUpCommand = exports.ShutterSetLevelCommand = exports.RoomSetLightTimeBasedCommand = exports.RoomRestoreShutterPositionCommand = exports.RoomRestoreLightCommand = exports.LightGroupSwitchTimeConditionalCommand = exports.LedSetLightCommand = exports.LampToggleLightCommand = exports.LampSetTimeBasedCommand = exports.LampSetLightCommand = exports.FloorSetAllShuttersCommand = exports.DimmerSetLightCommand = exports.CommandType = exports.CommandSource = exports.BaseCommand = exports.ActuatorWriteStateToDeviceCommand = exports.ActuatorToggleCommand = exports.ActuatorSetStateCommand = exports.RestoreTargetAutomaticValueCommand = exports.BlockAutomaticLiftBlockCommand = exports.BlockAutomaticUntilCommand = exports.BlockAutomaticCommand = void 0;
+var blockAutomaticCommand_1 = require("./blockAutomaticCommand");
+Object.defineProperty(exports, "BlockAutomaticCommand", { enumerable: true, get: function () { return blockAutomaticCommand_1.BlockAutomaticCommand; } });
+var blockAutomaticUntilCommand_1 = require("./blockAutomaticUntilCommand");
+Object.defineProperty(exports, "BlockAutomaticUntilCommand", { enumerable: true, get: function () { return blockAutomaticUntilCommand_1.BlockAutomaticUntilCommand; } });
+var blockAutomaticLiftBlockCommand_1 = require("./blockAutomaticLiftBlockCommand");
+Object.defineProperty(exports, "BlockAutomaticLiftBlockCommand", { enumerable: true, get: function () { return blockAutomaticLiftBlockCommand_1.BlockAutomaticLiftBlockCommand; } });
 var restoreTargetAutomaticValueCommand_1 = require("./restoreTargetAutomaticValueCommand");
 Object.defineProperty(exports, "RestoreTargetAutomaticValueCommand", { enumerable: true, get: function () { return restoreTargetAutomaticValueCommand_1.RestoreTargetAutomaticValueCommand; } });
 var actuatorSetStateCommand_1 = require("./actuatorSetStateCommand");

package/lib/models/command/lampSetLightCommand.d.ts

@@ -2,8 +2,19 @@ import { CommandType } from './commandType';
 import { CommandSource } from './commandSource';
 import { BaseCommand } from './baseCommand';
 import { ActuatorSetStateCommand } from './actuatorSetStateCommand';
+import { BlockAutomaticCommand } from './blockAutomaticCommand';
 export declare class LampSetLightCommand extends ActuatorSetStateCommand {
-    _commandType: CommandType;
-    constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number);
+    /** @inheritDoc */
+    type: CommandType;
+    /**
+     * Command to set the light of a lamp
+     * @param source - The source of the command
+     * @param on - The new state of the light
+     * @param reason - You can provide a reason for clarification
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
+     */
+    constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, disableAutomatic?: BlockAutomaticCommand | null);
+    /** @inheritDoc */
     get logMessage(): string;
 }

package/lib/models/command/lampSetLightCommand.js

@@ -4,12 +4,23 @@ exports.LampSetLightCommand = void 0;
 const commandType_1 = require("./commandType");
 const actuatorSetStateCommand_1 = require("./actuatorSetStateCommand");
 class LampSetLightCommand extends actuatorSetStateCommand_1.ActuatorSetStateCommand {
-    constructor(source, on, reason = '', timeout = -1) {
-        super(source, on, reason, timeout);
-        this._commandType = commandType_1.CommandType.LampSetLightCommand;
+    /**
+     * Command to set the light of a lamp
+     * @param source - The source of the command
+     * @param on - The new state of the light
+     * @param reason - You can provide a reason for clarification
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
+     */
+    constructor(source, on, reason = '', disableAutomatic) {
+        super(source, on, reason, disableAutomatic);
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.LampSetLightCommand;
     }
+    /** @inheritDoc */
     get logMessage() {
-        return `Lamp setLight to ${this.on} for reason: ${this.reasonTrace}`;
+        var _a;
+        return `Lamp setLight to ${this.on} with block ${(_a = this.disableAutomaticCommand) === null || _a === void 0 ? void 0 : _a.logMessage} for reason: ${this.reasonTrace}`;
     }
 }
 exports.LampSetLightCommand = LampSetLightCommand;

package/lib/models/command/lampSetTimeBasedCommand.d.ts

@@ -2,17 +2,24 @@ import { BaseCommand } from './baseCommand';
 import { CommandType } from './commandType';
 import { CommandSource } from './commandSource';
 import { TimeOfDay } from '../timeCallback';
+import { BlockAutomaticCommand } from './blockAutomaticCommand';
 export declare class LampSetTimeBasedCommand extends BaseCommand {
     time: TimeOfDay;
-    timeout: number;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
+    /**
+     * The command to disable automatic actions for a specific duration.
+     * Null = no automatic actions will be disabled.
+     * Undefined = use device or global default
+     */
+    readonly disableAutomaticCommand: BlockAutomaticCommand | null | undefined;
     /**
      * Set's the lamp based on lamp settings for the current time
-     * @param {CommandSource | BaseCommand} source
-     * @param {TimeOfDay} time The time to use for calculation of desired state
-     * @param reason
-     * @param {number} timeout If > 0 this is the time after which the lamp reverts to its original state
+     * @param source - The source of the command
+     * @param time - The time to use for calculation of desired state
+     * @param reason - You can provide a reason for clarity
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
      */
-    constructor(source: CommandSource | BaseCommand, time: TimeOfDay, reason?: string, timeout?: number);
-    get logMessage(): string;
+    constructor(source: CommandSource | BaseCommand, time: TimeOfDay, reason?: string, disableAutomatic?: BlockAutomaticCommand | null);
 }

package/lib/models/command/lampSetTimeBasedCommand.js

@@ -3,23 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LampSetTimeBasedCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
-const timeCallback_1 = require("../timeCallback");
 class LampSetTimeBasedCommand extends baseCommand_1.BaseCommand {
     /**
      * Set's the lamp based on lamp settings for the current time
-     * @param {CommandSource | BaseCommand} source
-     * @param {TimeOfDay} time The time to use for calculation of desired state
-     * @param reason
-     * @param {number} timeout If > 0 this is the time after which the lamp reverts to its original state
+     * @param source - The source of the command
+     * @param time - The time to use for calculation of desired state
+     * @param reason - You can provide a reason for clarity
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
      */
-    constructor(source, time, reason = '', timeout = -1) {
+    constructor(source, time, reason = '', disableAutomatic) {
         super(source, reason);
         this.time = time;
-        this.timeout = timeout;
-        this._commandType = commandType_1.CommandType.LampSetTimeBasedCommand;
-    }
-    get logMessage() {
-        return `Lamp setTimeBased to ${timeCallback_1.TimeOfDay[this.time]} for reason: ${this.reasonTrace}`;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.LampSetTimeBasedCommand;
+        this.disableAutomaticCommand = disableAutomatic;
     }
 }
 exports.LampSetTimeBasedCommand = LampSetTimeBasedCommand;

package/lib/models/command/lampToggleLightCommand.d.ts

@@ -6,13 +6,14 @@ import { TimeOfDay } from '../timeCallback';
 export declare class LampToggleLightCommand extends ActuatorToggleCommand {
     time?: TimeOfDay | undefined;
     readonly calculateTime: boolean;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
     /**
-     *
-     * @param {CommandSource | BaseCommand} source
-     * @param {string} reason
-     * @param {TimeOfDay} time The time to use for calculation of desired state
-     * @param {boolean} calculateTime Alternative to "time", if set the time will be calculated by the lamps room and its settings
+     * Command to toggle the light-state of a lamp
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarity
+     * @param time - The time to use for calculation of desired state
+     * @param calculateTime - Alternative to "time", if set the time will be calculated by the lamps room and its settings
      */
     constructor(source: CommandSource | BaseCommand, reason?: string, time?: TimeOfDay | undefined, calculateTime?: boolean);
     get logMessage(): string;

package/lib/models/command/lampToggleLightCommand.js

@@ -5,17 +5,18 @@ const actuatorToggleCommand_1 = require("./actuatorToggleCommand");
 const commandType_1 = require("./commandType");
 class LampToggleLightCommand extends actuatorToggleCommand_1.ActuatorToggleCommand {
     /**
-     *
-     * @param {CommandSource | BaseCommand} source
-     * @param {string} reason
-     * @param {TimeOfDay} time The time to use for calculation of desired state
-     * @param {boolean} calculateTime Alternative to "time", if set the time will be calculated by the lamps room and its settings
+     * Command to toggle the light-state of a lamp
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarity
+     * @param time - The time to use for calculation of desired state
+     * @param calculateTime - Alternative to "time", if set the time will be calculated by the lamps room and its settings
      */
     constructor(source, reason = '', time, calculateTime = false) {
         super(source, reason);
         this.time = time;
         this.calculateTime = calculateTime;
-        this._commandType = commandType_1.CommandType.LampToggleLightCommand;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.LampToggleLightCommand;
     }
     get logMessage() {
         return `Lamp toggleLight for reason: ${this.reasonTrace}`;

package/lib/models/command/ledSetLightCommand.d.ts

@@ -4,22 +4,32 @@ import { BaseCommand } from './baseCommand';
 import { DimmerSetLightCommand } from './dimmerSetLightCommand';
 import { LampSetTimeBasedCommand } from './lampSetTimeBasedCommand';
 import { LedSettings } from '../deviceSettings';
+import { BlockAutomaticCommand } from './blockAutomaticCommand';
 export declare class LedSetLightCommand extends DimmerSetLightCommand {
     color: string;
     colorTemp: number;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
     /**
-     *
-     * @param {CommandSource | BaseCommand} source
-     * @param {boolean} on
-     * @param {string} reason
-     * @param {number} timeout  A chosen Timeout after which the light should be reset
-     * @param {number} brightness The desired brightness
-     * @param {number} transitionTime The transition time during turnOn/turnOff
-     * @param {string} color The desired color in 6 digit hex Code
-     * @param {number} colorTemp The desired color Temperature (0 = more White)
+     * Command to set the light-state of a Led-Device
+     * @param source - The source of the command
+     * @param on - The desired state-value
+     * @param reason - You can provide a reason for clarity
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
+     * @param brightness - The desired brightness
+     * @param transitionTime - The transition time during turnOn/turnOff
+     * @param color - The desired color in 6 digit hex Code
+     * @param colorTemp - The desired color Temperature (0 = more White)
      */
-    constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number, brightness?: number, transitionTime?: number, color?: string, colorTemp?: number);
+    constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, disableAutomatic?: BlockAutomaticCommand | null, brightness?: number, transitionTime?: number, color?: string, colorTemp?: number);
+    /** @inheritDoc */
     get logMessage(): string;
+    /**
+     * Create a LedSetLightCommand based on a LampSetTimeBasedCommand and LedSettings by respecting the time of day
+     * @param settings - The settings for the Led
+     * @param c - The command to base the LedSetLightCommand on
+     * @returns The created LedSetLightCommand
+     */
     static byTimeBased(settings: LedSettings, c: LampSetTimeBasedCommand): LedSetLightCommand;
 }

package/lib/models/command/ledSetLightCommand.js

@@ -6,35 +6,45 @@ const dimmerSetLightCommand_1 = require("./dimmerSetLightCommand");
 const timeCallback_1 = require("../timeCallback");
 class LedSetLightCommand extends dimmerSetLightCommand_1.DimmerSetLightCommand {
     /**
-     *
-     * @param {CommandSource | BaseCommand} source
-     * @param {boolean} on
-     * @param {string} reason
-     * @param {number} timeout  A chosen Timeout after which the light should be reset
-     * @param {number} brightness The desired brightness
-     * @param {number} transitionTime The transition time during turnOn/turnOff
-     * @param {string} color The desired color in 6 digit hex Code
-     * @param {number} colorTemp The desired color Temperature (0 = more White)
+     * Command to set the light-state of a Led-Device
+     * @param source - The source of the command
+     * @param on - The desired state-value
+     * @param reason - You can provide a reason for clarity
+     * @param disableAutomatic - If provided, the device will remain in the desired state for the given disable action.
+     * If undefined the default value will be used in case it's a non automatic action: {@link SettingsService.settings.blockAutomaticHandlerDefaults}
+     * @param brightness - The desired brightness
+     * @param transitionTime - The transition time during turnOn/turnOff
+     * @param color - The desired color in 6 digit hex Code
+     * @param colorTemp - The desired color Temperature (0 = more White)
      */
-    constructor(source, on, reason = '', timeout = -1, brightness, transitionTime, color = '', colorTemp = -1) {
-        super(source, on, reason, timeout, brightness, transitionTime);
+    constructor(source, on, reason = '', disableAutomatic, brightness, transitionTime, color = '', colorTemp = -1) {
+        super(source, on, reason, disableAutomatic, brightness, transitionTime);
         this.color = color;
         this.colorTemp = colorTemp;
-        this._commandType = commandType_1.CommandType.LedSetLightCommand;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.LedSetLightCommand;
     }
+    /** @inheritDoc */
     get logMessage() {
-        return `Led setLight to state: ${this.on}, timeout: ${this.timeout}, brightness: ${this.brightness}, color: ${this.color}, colorTemp: ${this.colorTemp} for reason: ${this.reasonTrace}`;
+        var _a;
+        return `Led setLight to state: ${this.on}, blockAutomatic: ${(_a = this.disableAutomaticCommand) === null || _a === void 0 ? void 0 : _a.logMessage}, brightness: ${this.brightness}, color: ${this.color}, colorTemp: ${this.colorTemp} for reason: ${this.reasonTrace}`;
     }
+    /**
+     * Create a LedSetLightCommand based on a LampSetTimeBasedCommand and LedSettings by respecting the time of day
+     * @param settings - The settings for the Led
+     * @param c - The command to base the LedSetLightCommand on
+     * @returns The created LedSetLightCommand
+     */
     static byTimeBased(settings, c) {
         switch (c.time) {
             case timeCallback_1.TimeOfDay.Daylight:
-                return new LedSetLightCommand(c, settings.dayOn, '', c.timeout, settings.dayBrightness, undefined, settings.dayColor, settings.dayColorTemp);
+                return new LedSetLightCommand(c, settings.dayOn, `byTimeBased(${timeCallback_1.TimeOfDay[c.time]})`, c.disableAutomaticCommand, settings.dayBrightness, undefined, settings.dayColor, settings.dayColorTemp);
             case timeCallback_1.TimeOfDay.BeforeSunrise:
-                return new LedSetLightCommand(c, settings.dawnOn, '', c.timeout, settings.dawnBrightness, undefined, settings.dawnColor, settings.dawnColorTemp);
+                return new LedSetLightCommand(c, settings.dawnOn, `byTimeBased(${timeCallback_1.TimeOfDay[c.time]})`, c.disableAutomaticCommand, settings.dawnBrightness, undefined, settings.dawnColor, settings.dawnColorTemp);
             case timeCallback_1.TimeOfDay.AfterSunset:
-                return new LedSetLightCommand(c, settings.duskOn, '', c.timeout, settings.duskBrightness, undefined, settings.duskColor, settings.duskColorTemp);
+                return new LedSetLightCommand(c, settings.duskOn, `byTimeBased(${timeCallback_1.TimeOfDay[c.time]})`, c.disableAutomaticCommand, settings.duskBrightness, undefined, settings.duskColor, settings.duskColorTemp);
             case timeCallback_1.TimeOfDay.Night:
-                return new LedSetLightCommand(c, settings.nightOn, '', c.timeout, settings.nightBrightness, undefined, settings.nightColor, settings.nightColorTemp);
+                return new LedSetLightCommand(c, settings.nightOn, `byTimeBased(${timeCallback_1.TimeOfDay[c.time]})`, c.disableAutomaticCommand, settings.nightBrightness, undefined, settings.nightColor, settings.nightColorTemp);
         }
     }
 }

package/lib/models/command/lightGroupSwitchTimeConditionalCommand.d.ts

@@ -4,6 +4,13 @@ import { CommandSource } from './commandSource';
 import { TimeOfDay } from '../timeCallback';
 export declare class LightGroupSwitchTimeConditionalCommand extends BaseCommand {
     readonly time: TimeOfDay;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
+    /**
+     * Command to switch a light group in accordance to a specific time of the day
+     * @param source - The source of the command
+     * @param time - The time of the day to switch the light group
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source: CommandSource | BaseCommand, time: TimeOfDay, reason?: string);
 }

package/lib/models/command/lightGroupSwitchTimeConditionalCommand.js

@@ -4,10 +4,17 @@ exports.LightGroupSwitchTimeConditionalCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class LightGroupSwitchTimeConditionalCommand extends baseCommand_1.BaseCommand {
+    /**
+     * Command to switch a light group in accordance to a specific time of the day
+     * @param source - The source of the command
+     * @param time - The time of the day to switch the light group
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source, time, reason = '') {
         super(source, reason);
         this.time = time;
-        this._commandType = commandType_1.CommandType.LightGroupSwitchTimeConditional;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.LightGroupSwitchTimeConditional;
     }
 }
 exports.LightGroupSwitchTimeConditionalCommand = LightGroupSwitchTimeConditionalCommand;

package/lib/models/command/restoreTargetAutomaticValueCommand.d.ts

@@ -2,7 +2,12 @@ import { BaseCommand } from './baseCommand';
 import { CommandSource } from './commandSource';
 import { CommandType } from './commandType';
 export declare class RestoreTargetAutomaticValueCommand extends BaseCommand {
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
+    /**
+     * Command to restore the target automatic value of an actuator
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source: CommandSource | BaseCommand, reason?: string);
-    get logMessage(): string;
 }

package/lib/models/command/restoreTargetAutomaticValueCommand.js

@@ -4,12 +4,15 @@ exports.RestoreTargetAutomaticValueCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class RestoreTargetAutomaticValueCommand extends baseCommand_1.BaseCommand {
+    /**
+     * Command to restore the target automatic value of an actuator
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source, reason = '') {
         super(source, reason);
-        this._commandType = commandType_1.CommandType.ActuatorRestoreTargetAutomaticValueCommand;
-    }
-    get logMessage() {
-        return `Actuator restore target automatic value due to reason: ${this.reasonTrace}`;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.ActuatorRestoreTargetAutomaticValueCommand;
     }
 }
 exports.RestoreTargetAutomaticValueCommand = RestoreTargetAutomaticValueCommand;

package/lib/models/command/roomRestoreLightCommand.d.ts

@@ -2,6 +2,12 @@ import { BaseCommand } from './baseCommand';
 import { CommandType } from './commandType';
 import { CommandSource } from './commandSource';
 export declare class RoomRestoreLightCommand extends BaseCommand {
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
+    /**
+     * Command to restore the normal automatic light-state of a room
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source: CommandSource | BaseCommand, reason?: string);
 }

package/lib/models/command/roomRestoreLightCommand.js

@@ -4,9 +4,15 @@ exports.RoomRestoreLightCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class RoomRestoreLightCommand extends baseCommand_1.BaseCommand {
+    /**
+     * Command to restore the normal automatic light-state of a room
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source, reason = '') {
         super(source, reason);
-        this._commandType = commandType_1.CommandType.RoomRestoreLightCommand;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.RoomRestoreLightCommand;
     }
 }
 exports.RoomRestoreLightCommand = RoomRestoreLightCommand;

package/lib/models/command/roomRestoreShutterPositionCommand.d.ts

@@ -3,6 +3,13 @@ import { BaseCommand } from './baseCommand';
 import { CommandType } from './commandType';
 export declare class RoomRestoreShutterPositionCommand extends BaseCommand {
     readonly recalc: boolean;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
+    /**
+     * Command to restore the normal automatic shutter position of a room
+     * @param source - The source of the command
+     * @param recalc - Whether to recalculate the shutter position
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source: CommandSource | BaseCommand, recalc?: boolean, reason?: string);
 }

package/lib/models/command/roomRestoreShutterPositionCommand.js

@@ -4,10 +4,17 @@ exports.RoomRestoreShutterPositionCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class RoomRestoreShutterPositionCommand extends baseCommand_1.BaseCommand {
+    /**
+     * Command to restore the normal automatic shutter position of a room
+     * @param source - The source of the command
+     * @param recalc - Whether to recalculate the shutter position
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source, recalc = false, reason = '') {
         super(source, reason);
         this.recalc = recalc;
-        this._commandType = commandType_1.CommandType.RoomRestoreShutterPositionCommand;
+        /** @inheritDoc */
+        this.type = commandType_1.CommandType.RoomRestoreShutterPositionCommand;
     }
 }
 exports.RoomRestoreShutterPositionCommand = RoomRestoreShutterPositionCommand;

package/lib/models/command/roomSetLightTimeBasedCommand.d.ts

@@ -3,12 +3,13 @@ import { CommandType } from './commandType';
 import { CommandSource } from './commandSource';
 export declare class RoomSetLightTimeBasedCommand extends BaseCommand {
     readonly movementDependant: boolean;
-    _commandType: CommandType;
+    /** @inheritDoc */
+    type: CommandType;
     /**
      * Sets the light based on the current time, rollo Position and room Settings
-     * @param source
-     * @param movementDependant Only turn light on if there was a movement in the same room
-     * @param reason
+     * @param source - The source of the command
+     * @param movementDependant - Only turn light on if there was a movement in the same room
+     * @param reason - You can provide a reason for clarity
      */
     constructor(source: CommandSource | BaseCommand, movementDependant?: boolean, reason?: string);
 }