hoffmation-base 3.0.0-alpha.3 → 3.0.0-alpha.30

package/lib/models/command/blockAutomaticCommand.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockAutomaticCommand = void 0;
+const commandType_1 = require("./commandType");
+const collisionSolving_1 = require("../collisionSolving");
+const baseCommand_1 = require("./baseCommand");
+const server_1 = require("../../server");
+class BlockAutomaticCommand extends baseCommand_1.BaseCommand {
+    /**
+     * Command to disable automatic actions for a specific duration.
+     * @param source - The source of the command.
+     * @param durationMS - The duration in milliseconds for the automatic actions to be disabled --> If unset the default value will be used {@link SettingsService.settings.blockAutomaticHandlerDefaults.blockAutomaticDurationMS}
+     * @param reason - You can provide an individual reason here for debugging purpose.
+     * @param onCollideAction - The action to take if a block is already active. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.defaultCollisionSolving}
+     * @param revertToAutomaticAtBlockLift - Whether the device should revert to automatic afterward. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.revertToAutomaticAtBlockLift}
+     */
+    constructor(source, durationMS, reason = '', onCollideAction, revertToAutomaticAtBlockLift) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        super(source, reason);
+        /** @inheritDoc */
+        this._commandType = commandType_1.CommandType.BlockAutomaticCommand;
+        this.durationMS =
+            (_c = durationMS !== null && durationMS !== void 0 ? durationMS : (_b = (_a = server_1.SettingsService.settings) === null || _a === void 0 ? void 0 : _a.blockAutomaticHandlerDefaults) === null || _b === void 0 ? void 0 : _b.blockAutomaticDurationMS) !== null && _c !== void 0 ? _c : 30 * 60 * 1000;
+        this.revertToAutomaticAtBlockLift =
+            (_f = revertToAutomaticAtBlockLift !== null && revertToAutomaticAtBlockLift !== void 0 ? revertToAutomaticAtBlockLift : (_e = (_d = server_1.SettingsService.settings) === null || _d === void 0 ? void 0 : _d.blockAutomaticHandlerDefaults) === null || _e === void 0 ? void 0 : _e.revertToAutomaticAtBlockLift) !== null && _f !== void 0 ? _f : true;
+        this.onCollideAction =
+            (_j = onCollideAction !== null && onCollideAction !== void 0 ? onCollideAction : (_h = (_g = server_1.SettingsService.settings) === null || _g === void 0 ? void 0 : _g.blockAutomaticHandlerDefaults) === null || _h === void 0 ? void 0 : _h.defaultCollisionSolving) !== null && _j !== void 0 ? _j : collisionSolving_1.CollisionSolving.overrideIfGreater;
+    }
+    get logMessage() {
+        return `BlockAutomatic for ${this.durationMS}ms with onCollideAction ${this.onCollideAction} for reason: ${this.reasonTrace}`;
+    }
+    static fromDeviceSettings(c, deviceSettings) {
+        var _a, _b, _c, _d;
+        if ((_a = deviceSettings.blockAutomaticSettings) === null || _a === void 0 ? void 0 : _a.dontBlockAutomaticIfNotProvided) {
+            return null;
+        }
+        return new BlockAutomaticCommand(c, (_b = deviceSettings.blockAutomaticSettings) === null || _b === void 0 ? void 0 : _b.blockAutomaticDurationMS, '', (_c = deviceSettings.blockAutomaticSettings) === null || _c === void 0 ? void 0 : _c.defaultCollisionSolving, (_d = deviceSettings.blockAutomaticSettings) === null || _d === void 0 ? void 0 : _d.revertToAutomaticAtBlockLift);
+    }
+}
+exports.BlockAutomaticCommand = BlockAutomaticCommand;

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

@@ -0,0 +1,18 @@
+import { CommandType } from './commandType';
+import { CommandSource } from './commandSource';
+import { BaseCommand } from './baseCommand';
+export declare class BlockAutomaticLiftBlockCommand extends BaseCommand {
+    /** @inheritDoc */
+    _commandType: CommandType;
+    /**
+     * Whether the device should revert to desired automatic value.
+     */
+    readonly revertToAutomatic: boolean;
+    /**
+     * Command to lift a block --> Restore the automatic actions.
+     * @param source - The source of the command.
+     * @param reason - You can provide an individual reason here for debugging purpose.
+     * @param revertToAutomatic - Whether the device should revert to automatic afterward. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.revertToAutomaticAtBlockLift}
+     */
+    constructor(source: CommandSource | BaseCommand, reason?: string, revertToAutomatic?: boolean);
+}

package/lib/models/command/blockAutomaticLiftBlockCommand.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockAutomaticLiftBlockCommand = void 0;
+const commandType_1 = require("./commandType");
+const baseCommand_1 = require("./baseCommand");
+const server_1 = require("../../server");
+class BlockAutomaticLiftBlockCommand extends baseCommand_1.BaseCommand {
+    /**
+     * Command to lift a block --> Restore the automatic actions.
+     * @param source - The source of the command.
+     * @param reason - You can provide an individual reason here for debugging purpose.
+     * @param revertToAutomatic - Whether the device should revert to automatic afterward. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.revertToAutomaticAtBlockLift}
+     */
+    constructor(source, reason = '', revertToAutomatic) {
+        var _a, _b, _c;
+        super(source, reason);
+        /** @inheritDoc */
+        this._commandType = commandType_1.CommandType.BlockAutomaticLiftBlockCommand;
+        this.revertToAutomatic =
+            (_c = revertToAutomatic !== null && revertToAutomatic !== void 0 ? revertToAutomatic : (_b = (_a = server_1.SettingsService.settings) === null || _a === void 0 ? void 0 : _a.blockAutomaticHandlerDefaults) === null || _b === void 0 ? void 0 : _b.revertToAutomaticAtBlockLift) !== null && _c !== void 0 ? _c : true;
+    }
+}
+exports.BlockAutomaticLiftBlockCommand = BlockAutomaticLiftBlockCommand;

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

@@ -0,0 +1,26 @@
+import { CommandType } from './commandType';
+import { CommandSource } from './commandSource';
+import { CollisionSolving } from '../collisionSolving';
+import { BaseCommand } from './baseCommand';
+export declare class BlockAutomaticUntilCommand extends BaseCommand {
+    targetDate: Date;
+    /** @inheritDoc */
+    _commandType: CommandType;
+    /**
+     * The action to take if a block is already active.
+     */
+    readonly onCollideAction: CollisionSolving;
+    /**
+     * Whether the device should revert to automatic afterward.
+     */
+    readonly revertToAutomaticAtBlockLift: boolean;
+    /**
+     * Command to disable automatic actions until a specific date.
+     * @param source - The source of the command.
+     * @param targetDate - The date until the automatic actions will be disabled.
+     * @param reason - You can provide an individual reason here for debugging purpose.
+     * @param onCollideAction - The action to take if a block is already active. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.defaultCollisionSolving}
+     * @param revertToAutomaticAtBlockLift - Whether the device should revert to automatic afterward. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.revertToAutomaticAtBlockLift}
+     */
+    constructor(source: CommandSource | BaseCommand, targetDate: Date, reason?: string, onCollideAction?: CollisionSolving, revertToAutomaticAtBlockLift?: boolean);
+}

package/lib/models/command/blockAutomaticUntilCommand.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockAutomaticUntilCommand = void 0;
+const commandType_1 = require("./commandType");
+const collisionSolving_1 = require("../collisionSolving");
+const baseCommand_1 = require("./baseCommand");
+const server_1 = require("../../server");
+class BlockAutomaticUntilCommand extends baseCommand_1.BaseCommand {
+    /**
+     * Command to disable automatic actions until a specific date.
+     * @param source - The source of the command.
+     * @param targetDate - The date until the automatic actions will be disabled.
+     * @param reason - You can provide an individual reason here for debugging purpose.
+     * @param onCollideAction - The action to take if a block is already active. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.defaultCollisionSolving}
+     * @param revertToAutomaticAtBlockLift - Whether the device should revert to automatic afterward. --> Default: {@link SettingsService.settings.blockAutomaticHandlerDefaults.revertToAutomaticAtBlockLift}
+     */
+    constructor(source, targetDate, reason = '', onCollideAction, revertToAutomaticAtBlockLift) {
+        var _a, _b, _c, _d, _e, _f;
+        super(source, reason);
+        this.targetDate = targetDate;
+        /** @inheritDoc */
+        this._commandType = commandType_1.CommandType.BlockAutomaticUntilCommand;
+        this.onCollideAction =
+            (_c = onCollideAction !== null && onCollideAction !== void 0 ? onCollideAction : (_b = (_a = server_1.SettingsService.settings) === null || _a === void 0 ? void 0 : _a.blockAutomaticHandlerDefaults) === null || _b === void 0 ? void 0 : _b.defaultCollisionSolving) !== null && _c !== void 0 ? _c : collisionSolving_1.CollisionSolving.overrideIfGreater;
+        this.revertToAutomaticAtBlockLift =
+            (_f = revertToAutomaticAtBlockLift !== null && revertToAutomaticAtBlockLift !== void 0 ? revertToAutomaticAtBlockLift : (_e = (_d = server_1.SettingsService.settings) === null || _d === void 0 ? void 0 : _d.blockAutomaticHandlerDefaults) === null || _e === void 0 ? void 0 : _e.revertToAutomaticAtBlockLift) !== null && _f !== void 0 ? _f : true;
+    }
+}
+exports.BlockAutomaticUntilCommand = BlockAutomaticUntilCommand;

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

@@ -1,8 +1,27 @@
 export declare enum CommandSource {
+    /**
+     * In case of unclear command stack/source this should be used.
+     */
     Unknown = 0,
+    /**
+     * This should mark all startup commands, as this allows devices to treat this correctly.
+     */
     Initial = 1,
+    /**
+     * This should mark all commands that are executed as an automatic response to a certain action/change.
+     */
     Automatic = 2,
+    /**
+     * This should mark all commands that are executed by a user thus having a higher priority than other automatic commands.
+     */
     Manual = 3,
+    /**
+     * This should mark all commands that are executed by an API call.
+     * !WARNING! API could be an automatic call, but also a manual call e.g. using hoffmation-ios or homebridge-hoffmation --> So this is a higher priority than Automatic but still lower than manual/force.
+     */
     API = 4,
+    /**
+     * This should mark all commands that have highest priority, thus overruling/ignoring certain controls/safety mechanisms.
+     */
     Force = 5
 }

package/lib/models/command/commandSource.js

@@ -1,12 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandSource = void 0;
+// Definition: Enum for command source.
 var CommandSource;
 (function (CommandSource) {
+    /**
+     * In case of unclear command stack/source this should be used.
+     */
     CommandSource[CommandSource["Unknown"] = 0] = "Unknown";
+    /**
+     * This should mark all startup commands, as this allows devices to treat this correctly.
+     */
     CommandSource[CommandSource["Initial"] = 1] = "Initial";
+    /**
+     * This should mark all commands that are executed as an automatic response to a certain action/change.
+     */
     CommandSource[CommandSource["Automatic"] = 2] = "Automatic";
+    /**
+     * This should mark all commands that are executed by a user thus having a higher priority than other automatic commands.
+     */
     CommandSource[CommandSource["Manual"] = 3] = "Manual";
+    /**
+     * This should mark all commands that are executed by an API call.
+     * !WARNING! API could be an automatic call, but also a manual call e.g. using hoffmation-ios or homebridge-hoffmation --> So this is a higher priority than Automatic but still lower than manual/force.
+     */
     CommandSource[CommandSource["API"] = 4] = "API";
+    /**
+     * This should mark all commands that have highest priority, thus overruling/ignoring certain controls/safety mechanisms.
+     */
     CommandSource[CommandSource["Force"] = 5] = "Force";
 })(CommandSource || (exports.CommandSource = CommandSource = {}));

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

@@ -1,4 +1,7 @@
 export declare enum CommandType {
+    BlockAutomaticLiftBlockCommand = "BlockAutomaticLiftBlockCommand",
+    BlockAutomaticCommand = "BlockAutomaticCommand",
+    BlockAutomaticUntilCommand = "BlockAutomaticUntilCommand",
     ActuatorToggleCommand = "ActuatorToggleCommand",
     ActuatorSetStateCommand = "ActuatorSetStateCommand",
     ActuatorRestoreTargetAutomaticValueCommand = "ActuatorRestoreTargetAutomaticValueCommand",

package/lib/models/command/commandType.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandType = void 0;
 var CommandType;
 (function (CommandType) {
+    CommandType["BlockAutomaticLiftBlockCommand"] = "BlockAutomaticLiftBlockCommand";
+    CommandType["BlockAutomaticCommand"] = "BlockAutomaticCommand";
+    CommandType["BlockAutomaticUntilCommand"] = "BlockAutomaticUntilCommand";
     CommandType["ActuatorToggleCommand"] = "ActuatorToggleCommand";
     CommandType["ActuatorSetStateCommand"] = "ActuatorSetStateCommand";
     CommandType["ActuatorRestoreTargetAutomaticValueCommand"] = "ActuatorRestoreTargetAutomaticValueCommand";

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;
+    /** @inheritDoc */
     _commandType: 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;
+        /** @inheritDoc */
         this._commandType = 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;
+    /** @inheritDoc */
     _commandType: 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,15 +6,16 @@ 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;
+        /** @inheritDoc */
         this._commandType = commandType_1.CommandType.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 {
+    /** @inheritDoc */
     _commandType: CommandType;
-    constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number);
+    /**
+     * 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);
+    /**
+     * 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._commandType = commandType_1.CommandType.LampSetLightCommand;
     }
+    /** @inheritDoc */
     get logMessage() {
-        return `Lamp setLight to ${this.on} from ${this.source} 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;
+    /** @inheritDoc */
     _commandType: 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;
+        /** @inheritDoc */
         this._commandType = commandType_1.CommandType.LampSetTimeBasedCommand;
-    }
-    get logMessage() {
-        return `Lamp setTimeBased to ${timeCallback_1.TimeOfDay[this.time]} from ${this.source}`;
+        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;
+    /** @inheritDoc */
     _commandType: 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,20 +5,21 @@ 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;
+        /** @inheritDoc */
         this._commandType = commandType_1.CommandType.LampToggleLightCommand;
     }
     get logMessage() {
-        return `Lamp toggleLight from ${this.source} for reason: ${this.reasonTrace}`;
+        return `Lamp toggleLight for reason: ${this.reasonTrace}`;
     }
 }
 exports.LampToggleLightCommand = LampToggleLightCommand;

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;
+    /** @inheritDoc */
     _commandType: 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;
 }