hoffmation-base 3.0.0-alpha.20 → 3.0.0-alpha.21

package/lib/liquid-pid.d.ts

@@ -4,12 +4,9 @@
  *
  * I'm a NodeJS guy not a scientist, so please be a careful!!!
  * FYI: http://en.wikipedia.org/wiki/PID_controller
- *
- * @module controller
- *
  * @author https://github.com/hekike/liquid-pid
- * @licence MIT
- **/
+ * licence: MIT
+ */
 export declare class PIDController {
     private _Tref;
     private readonly _Pmax;

package/lib/liquid-pid.js

@@ -7,12 +7,9 @@ exports.PIDController = void 0;
  *
  * I'm a NodeJS guy not a scientist, so please be a careful!!!
  * FYI: http://en.wikipedia.org/wiki/PID_controller
- *
- * @module controller
- *
  * @author https://github.com/hekike/liquid-pid
- * @licence MIT
- **/
+ * licence: MIT
+ */
 class PIDController {
     constructor(options) {
         var _a, _b, _c, _d, _f, _g;

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

@@ -5,6 +5,13 @@ export declare class ShutterSetLevelCommand extends BaseCommand {
     readonly level: number;
     readonly skipOpenWarning: boolean;
     _commandType: CommandType;
+    /**
+     * Command to set the level of a shutter
+     * @param source - The source of the command
+     * @param level - The level to set the shutter to (0: close, 100: completely open)
+     * @param reason - You can provide a reason for clarification
+     * @param skipOpenWarning - Whether to skip the warning of window being open
+     */
     constructor(source: CommandSource | BaseCommand, level: number, reason?: string, skipOpenWarning?: boolean);
     get logMessage(): string;
 }

package/lib/models/command/ShutterSetLevelCommand.js

@@ -4,7 +4,13 @@ exports.ShutterSetLevelCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class ShutterSetLevelCommand extends baseCommand_1.BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Command to set the level of a shutter
+     * @param source - The source of the command
+     * @param level - The level to set the shutter to (0: close, 100: completely open)
+     * @param reason - You can provide a reason for clarification
+     * @param skipOpenWarning - Whether to skip the warning of window being open
+     */
     constructor(source, level, reason = '', skipOpenWarning = false) {
         super(source, reason);
         this.level = level;

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

@@ -3,5 +3,10 @@ import { CommandSource } from './commandSource';
 import { CommandType } from './commandType';
 export declare class WindowRestoreDesiredPositionCommand extends BaseCommand {
     _commandType: CommandType;
+    /**
+     * Command to restore the desired position of the shutter of a window
+     * @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/WindowRestoreDesiredPositionCommand.js

@@ -4,7 +4,11 @@ exports.WindowRestoreDesiredPositionCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class WindowRestoreDesiredPositionCommand extends baseCommand_1.BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Command to restore the desired position of the shutter of a window
+     * @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.WindowRestoreDesiredPositionCommand;

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

@@ -4,5 +4,11 @@ import { CommandType } from './commandType';
 export declare class WindowSetDesiredPositionCommand extends BaseCommand {
     readonly position: number;
     _commandType: CommandType;
+    /**
+     * Command to set the desired position of the shutter of a window
+     * @param source - The source of the command
+     * @param position - The desired position of the shutter (0 closed, 100 open)
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source: CommandSource | BaseCommand, position: number, reason?: string);
 }

package/lib/models/command/WindowSetDesiredPositionCommand.js

@@ -4,7 +4,12 @@ exports.WindowSetDesiredPositionCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class WindowSetDesiredPositionCommand extends baseCommand_1.BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Command to set the desired position of the shutter of a window
+     * @param source - The source of the command
+     * @param position - The desired position of the shutter (0 closed, 100 open)
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source, position, reason = '') {
         super(source, reason);
         this.position = position;

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

@@ -3,5 +3,10 @@ import { CommandSource } from './commandSource';
 import { CommandType } from './commandType';
 export declare class WindowSetRolloByWeatherStatusCommand extends BaseCommand {
     _commandType: CommandType;
+    /**
+     * Command to set the desired position of the shutter of a window based on the weather status
+     * @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/WindowSetRolloByWeatherStatusCommand.js

@@ -4,7 +4,11 @@ exports.WindowSetRolloByWeatherStatusCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class WindowSetRolloByWeatherStatusCommand extends baseCommand_1.BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Command to set the desired position of the shutter of a window based on the weather status
+     * @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.WindowSetRolloByWeatherStatusCommand;

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

@@ -7,6 +7,13 @@ export declare class ActuatorSetStateCommand extends BaseCommand {
     readonly on: boolean;
     timeout: number;
     _commandType: CommandType;
+    /**
+     * Command to set the state of an actuator
+     * @param source - The source of the command
+     * @param on - The new state of the actuator
+     * @param reason - You can provide a reason for clarification
+     * @param timeout - If provided, the device automatic will be turned off for the given time in ms
+     */
     constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number);
     get logMessage(): string;
     static byActuatorAndToggleCommand(device: iActuator, c: ActuatorToggleCommand): ActuatorSetStateCommand;

package/lib/models/command/actuatorSetStateCommand.js

@@ -4,7 +4,13 @@ exports.ActuatorSetStateCommand = void 0;
 const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 class ActuatorSetStateCommand extends baseCommand_1.BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Command to set the state of an actuator
+     * @param source - The source of the command
+     * @param on - The new state of the actuator
+     * @param reason - You can provide a reason for clarification
+     * @param timeout - If provided, the device automatic will be turned off for the given time in ms
+     */
     constructor(source, on, reason = '', timeout = -1) {
         super(source, reason);
         this.on = on;

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

@@ -3,6 +3,11 @@ import { BaseCommand } from './baseCommand';
 import { CommandSource } from './commandSource';
 export declare class ActuatorToggleCommand extends BaseCommand {
     _commandType: CommandType;
+    /**
+     * Command to toggle the state 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/actuatorToggleCommand.js

@@ -4,7 +4,11 @@ exports.ActuatorToggleCommand = void 0;
 const commandType_1 = require("./commandType");
 const baseCommand_1 = require("./baseCommand");
 class ActuatorToggleCommand extends baseCommand_1.BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Command to toggle the state 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.ActuatorToggleCommand;

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

@@ -4,6 +4,12 @@ import { CommandSource } from './commandSource';
 export declare class ActuatorWriteStateToDeviceCommand extends BaseCommand {
     readonly stateValue: boolean;
     _commandType: CommandType;
+    /**
+     * Command to write the state of an actuator to the device
+     * @param source - The source of the command
+     * @param stateValue - The new state of the actuator
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source: CommandSource | BaseCommand, stateValue: boolean, reason?: string);
     get logMessage(): string;
 }

package/lib/models/command/actuatorWriteStateToDeviceCommand.js

@@ -5,7 +5,12 @@ const baseCommand_1 = require("./baseCommand");
 const commandType_1 = require("./commandType");
 const actuatorSetStateCommand_1 = require("./actuatorSetStateCommand");
 class ActuatorWriteStateToDeviceCommand extends baseCommand_1.BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Command to write the state of an actuator to the device
+     * @param source - The source of the command
+     * @param stateValue - The new state of the actuator
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source, stateValue, reason = '') {
         super(source, reason);
         this.stateValue = stateValue;

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

@@ -5,6 +5,16 @@ export declare abstract class BaseCommand {
     readonly reason: string;
     readonly timestamp: Date;
     abstract _commandType: CommandType;
+    /**
+     * If set, this will be used in regards to checking if this is a force/manual/automatic action.
+     * @type {CommandSource | undefined} The source of the command
+     */
+    overrideCommandSource: CommandSource | undefined;
+    /**
+     * Base class for all commands
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarification
+     */
     protected constructor(source?: CommandSource | BaseCommand, reason?: string);
     get isAutomaticAction(): boolean;
     get isForceAction(): boolean;

package/lib/models/command/baseCommand.js

@@ -3,7 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseCommand = void 0;
 const commandSource_1 = require("./commandSource");
 class BaseCommand {
-    // TODO: Missing Comment
+    /**
+     * Base class for all commands
+     * @param source - The source of the command
+     * @param reason - You can provide a reason for clarification
+     */
     constructor(source = commandSource_1.CommandSource.Unknown, reason = '') {
         this.source = source;
         this.reason = reason;
@@ -16,18 +20,29 @@ class BaseCommand {
         return this.source === commandSource_1.CommandSource.Automatic;
     }
     get isForceAction() {
+        if (this.overrideCommandSource !== undefined) {
+            return (this.overrideCommandSource === commandSource_1.CommandSource.Manual ||
+                this.overrideCommandSource === commandSource_1.CommandSource.API ||
+                this.overrideCommandSource === commandSource_1.CommandSource.Force);
+        }
         if (this.source instanceof BaseCommand) {
             return this.source.isForceAction;
         }
         return (this.source === commandSource_1.CommandSource.Manual || this.source === commandSource_1.CommandSource.API || this.source === commandSource_1.CommandSource.Force);
     }
     get isManual() {
+        if (this.overrideCommandSource !== undefined) {
+            return this.overrideCommandSource === commandSource_1.CommandSource.Manual || this.overrideCommandSource === commandSource_1.CommandSource.API;
+        }
         if (this.source instanceof BaseCommand) {
             return this.source.isManual;
         }
         return this.source === commandSource_1.CommandSource.Manual || this.source === commandSource_1.CommandSource.API;
     }
     get isInitial() {
+        if (this.overrideCommandSource !== undefined) {
+            return this.overrideCommandSource === commandSource_1.CommandSource.Initial;
+        }
         if (this.source instanceof BaseCommand) {
             return this.source.isInitial;
         }

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

@@ -8,10 +8,10 @@ export declare class BlockAutomaticCommand extends BaseCommand {
     _commandType: CommandType;
     /**
      * Command to disable automatic actions for a specific duration.
-     * @param {CommandSource} source The source of the command.
-     * @param {number} durationMS The duration in milliseconds for the automatic actions to be disabled.
-     * @param reason You can provide an individual reason here for debugging purpose.
-     * @param {CollisionSolving} onCollideAction The action to take if a block is already active. --> Default: overrideIfGreater
+     * @param source - The source of the command.
+     * @param durationMS - The duration in milliseconds for the automatic actions to 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: overrideIfGreater
      */
     constructor(source: CommandSource | BaseCommand, durationMS: number, reason?: string, onCollideAction?: CollisionSolving);
 }

package/lib/models/command/blockAutomaticCommand.js

@@ -7,10 +7,10 @@ const baseCommand_1 = require("./baseCommand");
 class BlockAutomaticCommand extends baseCommand_1.BaseCommand {
     /**
      * Command to disable automatic actions for a specific duration.
-     * @param {CommandSource} source The source of the command.
-     * @param {number} durationMS The duration in milliseconds for the automatic actions to be disabled.
-     * @param reason You can provide an individual reason here for debugging purpose.
-     * @param {CollisionSolving} onCollideAction The action to take if a block is already active. --> Default: overrideIfGreater
+     * @param source - The source of the command.
+     * @param durationMS - The duration in milliseconds for the automatic actions to 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: overrideIfGreater
      */
     constructor(source, durationMS, reason = '', onCollideAction = collisionSolving_1.CollisionSolving.overrideIfGreater) {
         super(source, reason);

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

@@ -5,8 +5,8 @@ export declare class BlockAutomaticLiftBlockCommand extends BaseCommand {
     _commandType: CommandType;
     /**
      * Command to lift a block --> Restore the automatic actions.
-     * @param {CommandSource | BaseCommand} source The source of the command.
-     * @param {string} reason You can provide an individual reason here for debugging purpose.
+     * @param source - The source of the command.
+     * @param reason - You can provide an individual reason here for debugging purpose.
      */
     constructor(source: CommandSource | BaseCommand, reason?: string);
 }

package/lib/models/command/blockAutomaticLiftBlockCommand.js

@@ -6,8 +6,8 @@ const baseCommand_1 = require("./baseCommand");
 class BlockAutomaticLiftBlockCommand extends baseCommand_1.BaseCommand {
     /**
      * Command to lift a block --> Restore the automatic actions.
-     * @param {CommandSource | BaseCommand} source The source of the command.
-     * @param {string} reason You can provide an individual reason here for debugging purpose.
+     * @param source - The source of the command.
+     * @param reason - You can provide an individual reason here for debugging purpose.
      */
     constructor(source, reason = '') {
         super(source, reason);

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

@@ -8,10 +8,10 @@ export declare class BlockAutomaticUntilCommand extends BaseCommand {
     _commandType: CommandType;
     /**
      * Command to disable automatic actions until a specific date.
-     * @param {CommandSource} source The source of the command.
-     * @param {Date} targetDate The date until the automatic actions will be disabled.
-     * @param reason You can provide an individual reason here for debugging purpose.
-     * @param {CollisionSolving} onCollideAction The action to take if a block is already active. --> Default: overrideIfGreater
+     * @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: overrideIfGreater
      */
     constructor(source: CommandSource | BaseCommand, targetDate: Date, reason?: string, onCollideAction?: CollisionSolving);
 }

package/lib/models/command/blockAutomaticUntilCommand.js

@@ -7,10 +7,10 @@ const baseCommand_1 = require("./baseCommand");
 class BlockAutomaticUntilCommand extends baseCommand_1.BaseCommand {
     /**
      * Command to disable automatic actions until a specific date.
-     * @param {CommandSource} source The source of the command.
-     * @param {Date} targetDate The date until the automatic actions will be disabled.
-     * @param reason You can provide an individual reason here for debugging purpose.
-     * @param {CollisionSolving} onCollideAction The action to take if a block is already active. --> Default: overrideIfGreater
+     * @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: overrideIfGreater
      */
     constructor(source, targetDate, reason = '', onCollideAction = collisionSolving_1.CollisionSolving.overrideIfGreater) {
         super(source, reason);

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,13 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandSource = void 0;
-// TODO: Missing Comment
+// 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/dimmerSetLightCommand.d.ts

@@ -9,12 +9,13 @@ export declare class DimmerSetLightCommand extends LampSetLightCommand {
     transitionTime: number;
     _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 timeout - A chosen Timeout after which the light should be reset
+     * @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);
     get logMessage(): string;

package/lib/models/command/dimmerSetLightCommand.js

@@ -6,12 +6,13 @@ 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 timeout - A chosen Timeout after which the light should be reset
+     * @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);

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

@@ -7,10 +7,10 @@ export declare class FloorSetAllShuttersCommand extends BaseCommand {
     _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,10 +6,10 @@ 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);

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

@@ -4,6 +4,13 @@ import { BaseCommand } from './baseCommand';
 import { ActuatorSetStateCommand } from './actuatorSetStateCommand';
 export declare class LampSetLightCommand extends ActuatorSetStateCommand {
     _commandType: 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 timeout - If provided, the device automatic will be turned off for the given time in ms --> Reverts to automatic after the timeout.
+     */
     constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number);
     get logMessage(): string;
 }

package/lib/models/command/lampSetLightCommand.js

@@ -4,7 +4,13 @@ exports.LampSetLightCommand = void 0;
 const commandType_1 = require("./commandType");
 const actuatorSetStateCommand_1 = require("./actuatorSetStateCommand");
 class LampSetLightCommand extends actuatorSetStateCommand_1.ActuatorSetStateCommand {
-    // TODO: Missing Comment
+    /**
+     * 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 timeout - If provided, the device automatic will be turned off for the given time in ms --> Reverts to automatic after the timeout.
+     */
     constructor(source, on, reason = '', timeout = -1) {
         super(source, on, reason, timeout);
         this._commandType = commandType_1.CommandType.LampSetLightCommand;

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

@@ -8,10 +8,10 @@ export declare class LampSetTimeBasedCommand extends BaseCommand {
     _commandType: CommandType;
     /**
      * 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 timeout - If > 0 this is the time after which the lamp reverts to its original state
      */
     constructor(source: CommandSource | BaseCommand, time: TimeOfDay, reason?: string, timeout?: number);
     get logMessage(): string;

package/lib/models/command/lampSetTimeBasedCommand.js

@@ -7,10 +7,10 @@ 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 timeout - If > 0 this is the time after which the lamp reverts to its original state
      */
     constructor(source, time, reason = '', timeout = -1) {
         super(source, reason);

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

@@ -8,11 +8,11 @@ export declare class LampToggleLightCommand extends ActuatorToggleCommand {
     readonly calculateTime: boolean;
     _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,11 +5,11 @@ 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);