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

package/lib/server/devices/IoBrokerDeviceInfo.js

@@ -19,8 +19,8 @@ class IoBrokerDeviceInfo extends DeviceInfo_1.DeviceInfo {
     }
     /**
      * Extracts the relevant infos from the passed deviceConfig and combines them in a new Info object
-     * @param {deviceConfig} pDevConf The device Config based on the extracted devices.json from ioBroker
-     * @param {boolean} isJsStateChildObject Within JS Objects, creating devices is limited,
+     * @param pDevConf - The device Config based on the extracted devices.json from ioBroker
+     * @param isJsStateChildObject - Within JS Objects, creating devices is limited,
      * so we name the first child state for the object creation (e.g. javascript.0.00-EnergyManager.CurrentProduction)
      */
     constructor(pDevConf, isJsStateChildObject = false) {
@@ -46,7 +46,8 @@ class IoBrokerDeviceInfo extends DeviceInfo_1.DeviceInfo {
             if (idSplit.length > 4) {
                 this.valueName = idSplit[4];
             }
-            /** Name-Split
+            /**
+             * Name-Split
              * 0: Indikator own "00"
              * 1: "HmIP"
              * 2: Raum
@@ -60,7 +61,8 @@ class IoBrokerDeviceInfo extends DeviceInfo_1.DeviceInfo {
             return;
         }
         else {
-            /** Name-Split
+            /**
+             * Name-Split
              * 0: Indikator own "00"
              * 1: "EnergyManager"
              * 2: Raum

package/lib/server/devices/baseDeviceInterfaces/iAcDevice.d.ts

@@ -1,18 +1,45 @@
 import { AcSettings } from '../../../models';
 import { AcMode } from '../../services';
 import { iBaseDevice } from './iBaseDevice';
+/**
+ * Interface for normal air-conditioning devices
+ * TODO: Migrate to new Command-Based System
+ * TODO: Extend from iActuator
+ */
 export interface iAcDevice extends iBaseDevice {
+    /**
+     * The settings of the air-conditioning device
+     */
     settings: AcSettings;
+    /**
+     * Whether the air-conditioning device is currently on
+     */
     readonly on: boolean;
+    /**
+     * The current temperature of the air-conditioning device in degrees Celsius
+     */
     readonly temperature: number;
+    /**
+     * The current state of the air-conditioning device
+     */
     readonly mode: AcMode;
     /**
-     * Disable automatic Turn-On for given amount of ms and turn off immediately.
-     * @param {number} timeout
+     * This function should be called to inform the air-conditioning device about a change of the room temperature
+     * @param {number} newTemperatur - The new temperature of the room in degrees Celsius
      */
-    deactivateAutomaticChange(timeout: number): void;
     onTemperaturChange(newTemperatur: number): void;
+    /**
+     * Updates the desired mode of the air-conditioning device and writes it to the device if desired
+     * @param {AcMode} mode - The new desired mode
+     * @param {boolean} writeToDevice - Whether to write the new mode to the device
+     */
     setDesiredMode(mode: AcMode, writeToDevice: boolean): void;
+    /**
+     * Turns the air-conditioning device on without changing the settings
+     */
     turnOn(): void;
+    /**
+     * Turns the air-conditioning device off
+     */
     turnOff(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iActuator.d.ts

@@ -1,11 +1,19 @@
 import { ActuatorSetStateCommand, ActuatorSettings, ActuatorToggleCommand, ActuatorWriteStateToDeviceCommand } from '../../../models';
 import { iRoomDevice } from './iRoomDevice';
 import { iTemporaryDisableAutomatic } from './iTemporaryDisableAutomatic';
+/**
+ * Interface for Actuators.
+ * An actuator can be any device whos primary function is to be on or off e.g a light, an outlet, a fan, etc.
+ */
 export interface iActuator extends iRoomDevice, iTemporaryDisableAutomatic {
     /**
      * The settings for this Actuator primarily for controlling its automatic actions
      */
     settings: ActuatorSettings;
+    /**
+     * The target automatic state of the device.
+     * This is used to store the state the device should be in to fall back to it after automatic was blocked e.g. by a user.
+     */
     targetAutomaticState: boolean;
     /**
      * The state value of the device
@@ -25,6 +33,14 @@ export interface iActuator extends iRoomDevice, iTemporaryDisableAutomatic {
      * @param command
      */
     setActuator(command: ActuatorSetStateCommand): void;
+    /**
+     * Toggles the power state of this actuator
+     * @param command
+     */
     toggleActuator(command: ActuatorToggleCommand): boolean;
+    /**
+     * Writes the desired actuator state to the device
+     * @param command
+     */
     writeActuatorStateToDevice(command: ActuatorWriteStateToDeviceCommand): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iBaseDevice.d.ts

@@ -3,12 +3,37 @@ import { DeviceType } from '../deviceType';
 import { DeviceInfo } from '../DeviceInfo';
 import { DeviceCapability } from '../DeviceCapability';
 import { iIdHolder } from '../../../models/iIdHolder';
+/**
+ * This is the main interface for all devices as it ensures certain base functionality.
+ */
 export interface iBaseDevice extends iIdHolder {
+    /**
+     * The settings of the device which are overridden by the specific device implementation
+     */
     readonly settings: DeviceSettings | undefined;
+    /**
+     * The hardware-type of the device.
+     */
     deviceType: DeviceType;
+    /**
+     * Some basic information about the device (mainly its name, id, room, etc.)
+     */
     info: DeviceInfo;
+    /**
+     * The capabilities of the device thus referencing other interfaces which then can be used to treat devices regardless of their hardware-type.
+     */
     readonly deviceCapabilities: DeviceCapability[];
+    /**
+     * This method writes the device Info to the configured persistence layer, to ensure having foreign keys for all other persisted data.
+     */
     persistDeviceInfo(): void;
+    /**
+     * This method loads the device settings from the configured persistence layer.
+     * Whilst this is normally used during startup, it can be called at any time to refresh the settings in case of manual changes within the database.
+     */
     loadDeviceSettings(): void;
+    /**
+     * This mainly enforces all devices to have a toJSON method to ensure a consistent way of serializing devices.
+     */
     toJSON(): Partial<iBaseDevice>;
 }

package/lib/server/devices/baseDeviceInterfaces/iBatteryDevice.d.ts

@@ -1,10 +1,19 @@
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * Interface for Battery Devices.
+ * A battery device can be any device that is powered by a battery e.g. a remote, a sensor, etc.
+ */
 export interface iBatteryDevice extends iRoomDevice {
+    /**
+     * The last time the battery was persisted (in milliseconds since 1970)
+     */
     readonly lastBatteryPersist: number;
     /**
      * The battery status of the device in percentage
-     * @type {number}
      */
     readonly battery: number;
+    /**
+     * Method to persist the battery status of the device to the persistence layer
+     */
     persistBatteryDevice(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iBluetoothDetector.d.ts

@@ -9,16 +9,16 @@ export interface iBluetoothDetector extends iRoomDevice {
     addProximityCallback(cb: ProximityCallback): void;
     /**
      * Gets the distance of a currently present device
-     * @param {string} deviceName The mapped Device name
-     * @param {number} maxAge The maximum age in seconds to still respect that device
+     * @param {string} deviceName - The mapped Device name
+     * @param {number} maxAge - The maximum age in seconds to still respect that device
      * @returns {number | undefined} Distance in meters or undefined if currently not present
      */
     distanceOfDevice(deviceName: string, maxAge: number): number | undefined;
     /**
      * Check if a device is currently present and below the given Distance
-     * @param {string} deviceName The mapped Device name
-     * @param {number} maxDistance The maximum distance in meters
-     * @param {number} maxAge The maximum age in seconds to still respect that device
+     * @param {string} deviceName - The mapped Device name
+     * @param {number} maxDistance - The maximum distance in meters
+     * @param {number} maxAge - The maximum age in seconds to still respect that device
      * @returns {boolean}
      */
     isDevicePresent(deviceName: string, maxDistance: number, maxAge: number): boolean;

package/lib/server/devices/baseDeviceInterfaces/iButtonSwitch.d.ts

@@ -9,7 +9,20 @@ export interface iButtonSwitch extends iRoomDevice {
     buttonBotRight: Button | undefined;
     buttonBot: Button | undefined;
     buttonTop: Button | undefined;
+    /**
+     * Persist the button press to the persistent storage
+     * @param {string} buttonName - The name of the button
+     * @param {ButtonPressType} pressType - The type of the button press
+     */
     persist(buttonName: string, pressType: ButtonPressType): void;
+    /**
+     * @returns An description of all configured assignments
+     */
     getButtonAssignment(): string;
+    /**
+     * Method to simulate a button press (e.g. for testing or to use a specific logic which is bound to this button)
+     * @param {ButtonPosition} position - The position of the button
+     * @param {ButtonPressType} pressType - The type of the button press
+     */
     pressButton(position: ButtonPosition, pressType: ButtonPressType): Error | null;
 }

package/lib/server/devices/baseDeviceInterfaces/iCameraDevice.d.ts

@@ -9,6 +9,16 @@ export interface iCameraDevice extends iMotionSensor {
     readonly currentImageLink: string;
     readonly alarmBlockedByGriff: boolean;
     readonly alarmBlockedByGriffTimeStamp: number;
+    /**
+     * Inform this camera of certain handles being opened/closed to allow it to react accordingly (e.g. don't send alarm, for owner going into the garden)
+     * @param {boolean} open - Whether the handle is open or closed
+     */
     onGriffUpdate(open: boolean): void;
+    /**
+     * Inform this camera of state updates within iOBroker
+     * TODO: Make camera independent of iOBroker
+     * @param idSplit - The id split of the state
+     * @param state - The state that has been updated
+     */
     update(idSplit: string[], state: ioBroker.State): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iDimmableLamp.d.ts

@@ -1,12 +1,19 @@
 import { iLamp } from './iLamp';
 import { DimmerSetLightCommand, DimmerSettings, LampToggleLightCommand } from '../../../models';
+/**
+ * This interface represents a dimmable lamp device.
+ */
 export interface iDimmableLamp extends iLamp {
     settings: DimmerSettings;
     readonly brightness: number;
+    /**
+     * This function toggles the light on or off.
+     * @param {LampToggleLightCommand} command - The command to execute on the light device.
+     */
     toggleLight(command: LampToggleLightCommand): void;
     /**
-     * This function sets the light to a specific value
-     * Accessible in API
+     * This function sets the light to a specific value.
+     * @param {DimmerSetLightCommand} command - The command to execute on the light device.
      */
     setLight(command: DimmerSetLightCommand): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iEnergyManager.d.ts

@@ -1,12 +1,23 @@
 import { iExcessEnergyConsumer } from './iExcessEnergyConsumer';
 import { iBaseDevice } from './iBaseDevice';
-export interface iEnergyManager extends iBaseDevice {
+import { iDisposable } from '../../services';
+export interface iEnergyManager extends iBaseDevice, iDisposable {
     excessEnergy: number;
     readonly injectingWattage: number;
     readonly drawingWattage: number;
     readonly selfConsumingWattage: number;
+    /**
+     * Add a device that can consume excess energy
+     * @param device - The device that can consume excess energy
+     */
     addExcessConsumer(device: iExcessEnergyConsumer): void;
+    /**
+     * Recalculates power-sharing between devices.
+     */
     recalculatePowerSharing(): void;
-    cleanup(): void;
+    /**
+     * Generates a report stating used energy and devices that consumed it
+     * @returns The report
+     */
     getReport(): string;
 }

package/lib/server/devices/baseDeviceInterfaces/iExcessEnergyConsumer.d.ts

@@ -1,12 +1,26 @@
-import { ExcessEnergyConsumerSettings, LogLevel } from '../../../models';
+import { ExcessEnergyConsumerSettings } from '../../../models';
 import { iBaseDevice } from './iBaseDevice';
 export interface iExcessEnergyConsumer extends iBaseDevice {
     readonly energySettings: ExcessEnergyConsumerSettings;
     currentConsumption: number;
     on: boolean;
+    /**
+     * Check if this device is available to consume excess energy
+     * --> Device might be unavailable due to a force action from the user or other circumstances
+     * @returns {boolean} Whether this device is available to be turned on to consume excess energy
+     */
     isAvailableForExcessEnergy(): boolean;
-    log(level: LogLevel, message: string): void;
+    /**
+     * Turn on this device to consume excess energy
+     */
     turnOnForExcessEnergy(): void;
+    /**
+     * Turn off this device as we don't have enough excess energy to power it
+     */
     turnOffDueToMissingEnergy(): void;
+    /**
+     * Check if this device was activated by excess energy
+     * @returns {boolean} Whether this device was activated by excess energy
+     */
     wasActivatedByExcessEnergy(): boolean;
 }

package/lib/server/devices/baseDeviceInterfaces/iGarageDoorOpener.d.ts

@@ -3,7 +3,17 @@ import { iRoomDevice } from './iRoomDevice';
 export interface iGarageDoorOpener extends iRoomDevice {
     settings: GarageDoorOpenerSettings;
     readonly isClosed: boolean;
+    /**
+     * Open the garage door
+     */
     open(): void;
+    /**
+     * Close the garage door
+     */
     close(): void;
+    /**
+     * Trigger the garage door.
+     * This mostly results in driving the door to the opposite state, but if fired rapidly, it might stop the door in the middle.
+     */
     trigger(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iHandleSensor.d.ts

@@ -3,7 +3,19 @@ import { iRoomDevice } from './iRoomDevice';
 export interface iHandleSensor extends iRoomDevice {
     position: WindowPosition;
     minutesOpen: number;
+    /**
+     * Add a callback that is called when the handle is change to open
+     * @param {(pValue: boolean) => void} pCallback - The callback to fire
+     */
     addOffenCallback(pCallback: (pValue: boolean) => void): void;
+    /**
+     * Add a callback that is called when the handle is changed to ajar
+     * @param {(pValue: boolean) => void} pCallback - The callback to fire
+     */
     addKippCallback(pCallback: (pValue: boolean) => void): void;
+    /**
+     * Add a callback that is called when the handle is changed to closed
+     * @param {(pValue: boolean) => void} pCallback - The callback to fire
+     */
     addClosedCallback(pCallback: (pValue: boolean) => void): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iHeater.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="node" />
 import { HeaterSettings } from '../../../models';
 import { iRoomDevice } from './iRoomDevice';
-export interface iHeater extends iRoomDevice {
+import { iDisposable } from '../../services';
+export interface iHeater extends iRoomDevice, iDisposable {
     settings: HeaterSettings;
     desiredTemperature: number;
     readonly humidity: number;
@@ -10,8 +11,17 @@ export interface iHeater extends iRoomDevice {
     roomTemperature: number;
     readonly persistHeaterInterval: NodeJS.Timeout;
     seasonTurnOff: boolean;
-    stopAutomaticCheck(): void;
+    /**
+     * Perform a check to calculate the new desired heater state
+     */
     checkAutomaticChange(): void;
+    /**
+     * Informs the heater that the temperature of the room has changed
+     * @param newTemperatur - The new temperature in degree Celsius.
+     */
     onTemperaturChange(newTemperatur: number): void;
+    /**
+     * Persists the current heater information to the database
+     */
     persistHeater(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iHumiditySensor.d.ts

@@ -4,6 +4,13 @@ export declare const UNDEFINED_HUMIDITY_VALUE = -1;
 export interface iHumiditySensor extends iRoomDevice {
     readonly persistHumiditySensorInterval: NodeJS.Timeout;
     readonly humidity: number;
+    /**
+     * Add a callback that is called when the humidity changes
+     * @param {(pValue: number) => void} pCallback - The callback to fire
+     */
     addHumidityCallback(pCallback: (pValue: number) => void): void;
+    /**
+     * Persists the current humidity information to the database
+     */
     persistHumiditySensor(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iLamp.d.ts

@@ -5,6 +5,10 @@ export interface iLamp extends iActuator {
      * The state value of the device
      */
     readonly lightOn: boolean;
+    /**
+     * Changes the state of the lamp based on the time
+     * @param {LampSetTimeBasedCommand} command - The command to execute
+     */
     setTimeBased(command: LampSetTimeBasedCommand): void;
     /**
      * Toggles the state of the lamp

package/lib/server/devices/baseDeviceInterfaces/iLedRgbCct.d.ts

@@ -4,5 +4,10 @@ export interface iLedRgbCct extends iDimmableLamp {
     settings: LedSettings;
     readonly color: string;
     readonly colortemp: number;
+    /**
+     * This function sets the light to a specific value
+     * Accessible in API
+     * @param {LedSetLightCommand} c - The command to execute
+     */
     setLight(c: LedSetLightCommand): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iMotionSensor.d.ts

@@ -3,12 +3,18 @@ import { iRoomDevice } from './iRoomDevice';
 export interface iMotionSensor extends iRoomDevice {
     settings: MotionSensorSettings;
     readonly movementDetected: boolean;
+    /**
+     * Time since the last motion was detected in seconds
+     */
     readonly timeSinceLastMotion: number;
     detectionsToday: number;
     /**
      * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
+     * @param pCallback - Function that accepts the new state as parameter
      */
     addMovementCallback(pCallback: (newState: boolean) => void): void;
+    /**
+     * Persists the current motion information to the database
+     */
     persistMotionSensor(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iScene.d.ts

@@ -8,6 +8,13 @@ export interface iScene extends iRoomDevice {
     readonly on: boolean;
     readonly automaticEndTimeout: NodeJS.Timeout | null;
     settings: SceneSettings;
+    /**
+     * Starts the scene for the given duration
+     * @param {number} timeout - If set, the scene will end after the given time in ms
+     */
     startScene(timeout?: number): void;
+    /**
+     * Ends the scene --> This also stops the automatic end timeout.
+     */
     endScene(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iShutter.d.ts

@@ -6,6 +6,13 @@ export interface iShutter extends iRoomDevice {
     currentLevel: number;
     desiredWindowShutterLevel: number;
     window: Window | undefined;
+    /**
+     * Persists the current information of the shutter to the database
+     */
     persist(): void;
+    /**
+     * Sets the level of the shutter
+     * @param {ShutterSetLevelCommand} command - The command to execute
+     */
     setLevel(command: ShutterSetLevelCommand): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iSmokeDetectorDevice.d.ts

@@ -1,5 +1,12 @@
 import { iRoomDevice } from './iRoomDevice';
 export interface iSmokeDetectorDevice extends iRoomDevice {
+    /**
+     * Indicates if the smoke detector is currently detecting smoke
+     */
     readonly smoke: boolean;
+    /**
+     * Stops the alarm of the smoke detector
+     * @param {boolean} quiet - If true, the alarm will be stopped without announcing alarm end.
+     */
     stopAlarm(quiet: boolean): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iSpeaker.d.ts

@@ -1,8 +1,33 @@
 import { iRoomDevice } from './iRoomDevice';
 export interface iSpeaker extends iRoomDevice {
+    /**
+     * Plays an mp3 file on the device
+     * @param {string} mp3Name - The name of the mp3 file to play
+     * @param {number} duration - The duration of the mp3 file in seconds
+     * @param {number} [volume] - The volume to play the mp3 file with
+     * @param {boolean} [onlyWhenPlaying] - If true, the mp3 file will only be played when the device is already playing something
+     * @param {boolean} [resolveAfterRevert] - If true, the promise will be resolved after the device has reverted to the previous state
+     */
     playOnDevice(mp3Name: string, duration: number, volume?: number, onlyWhenPlaying?: boolean, resolveAfterRevert?: boolean): void;
+    /**
+     * Plays a test message on the device
+     */
     playTestMessage(): void;
+    /**
+     * Plays a file from an url on the device
+     * @param {string} url - The url to play
+     */
     playUrl(url: string): void;
+    /**
+     * Stops the current playback on the device
+     */
     stop(): void;
+    /**
+     * Speaks a message on the device using the text-to-speech engine
+     * @param {string} pMessage - The message to speak
+     * @param {number} [volume] - The volume to speak the message with
+     * @param {boolean} [onlyWhenPlaying] - If true, the message will only be spoken when the device is already playing something
+     * @param {boolean} [resolveAfterRevert] - If true, the promise will be resolved after the device has reverted to the previous state
+     */
     speakOnDevice(pMessage: string, volume?: number, onlyWhenPlaying?: boolean, resolveAfterRevert?: boolean): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iTemperatureSensor.d.ts

@@ -6,7 +6,18 @@ export interface iTemperatureSensor extends iRoomDevice {
     roomTemperature: number;
     iTemperature: number;
     sTemperature: string;
+    /**
+     * Adds a callback to be called when the temperature changes
+     * @param {(pValue: number) => void} pCallback - The callback to be called
+     */
     addTempChangeCallback(pCallback: (pValue: number) => void): void;
+    /**
+     * Inform the temperature sensor that the temperature in the room has changed
+     * @param {number} newTemperatur - The new temperature in the room in Celsius
+     */
     onTemperaturChange(newTemperatur: number): void;
+    /**
+     * Persists the current temperature sensor information to the database
+     */
     persistTemperaturSensor(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iTemporaryDisableAutomatic.d.ts

@@ -2,6 +2,13 @@ import { BlockAutomaticHandler } from '../../services/blockAutomaticHandler';
 import { iBaseDevice } from './iBaseDevice';
 import { RestoreTargetAutomaticValueCommand } from '../../../models';
 export interface iTemporaryDisableAutomatic extends iBaseDevice {
+    /**
+     * The block automation handler containing the current block state/time, etc.
+     */
     readonly blockAutomationHandler: BlockAutomaticHandler;
+    /**
+     * Restores the automatic value/state of the device
+     * @param {RestoreTargetAutomaticValueCommand} command - The command to restore the automatic value/state
+     */
     restoreTargetAutomaticValue(command: RestoreTargetAutomaticValueCommand): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iTvDevice.d.ts

@@ -1,8 +1,20 @@
 import { iRoomDevice } from './iRoomDevice';
 export interface iTvDevice extends iRoomDevice {
     readonly on: boolean;
+    /**
+     * Turns the TV on
+     */
     turnOn(): void;
+    /**
+     * Turns the TV off
+     */
     turnOff(): void;
+    /**
+     * Increases the volume of the TV
+     */
     volumeUp(): void;
+    /**
+     * Decreases the volume of the TV
+     */
     volumeDown(): void;
 }

package/lib/server/devices/baseDeviceInterfaces/iVibrationSensor.d.ts

@@ -5,5 +5,4 @@ export interface iVibrationSensor extends iRoomDevice {
     vibrationBlockedByMotion: boolean;
     vibrationBlockedByMotionTimeStamp: number;
     vibration: boolean;
-    alarmCheck(): void;
 }

package/lib/server/devices/blueIris/cameraDevice.d.ts

@@ -43,8 +43,7 @@ export declare class CameraDevice implements iCameraDevice {
     get info(): DeviceInfo;
     set info(info: DeviceInfo);
     /**
-     * Time since Last Motion in seconds
-     * @returns {number}
+     * @inheritDoc
      */
     get timeSinceLastMotion(): number;
     get customName(): string;
@@ -52,7 +51,7 @@ export declare class CameraDevice implements iCameraDevice {
     get room(): RoomBase | undefined;
     /**
      * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
+     * @param pCallback - Function that accepts the new state as parameter
      */
     addMovementCallback(pCallback: (newState: boolean) => void): void;
     onGriffUpdate(open: boolean): void;

package/lib/server/devices/blueIris/cameraDevice.js

@@ -103,8 +103,7 @@ class CameraDevice {
         this._info = info;
     }
     /**
-     * Time since Last Motion in seconds
-     * @returns {number}
+     * @inheritDoc
      */
     get timeSinceLastMotion() {
         return Math.round((services_1.Utils.nowMS() - this._lastMotion) / 1000);
@@ -121,7 +120,7 @@ class CameraDevice {
     }
     /**
      * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
+     * @param pCallback - Function that accepts the new state as parameter
      */
     addMovementCallback(pCallback) {
         this._movementDetectedCallback.push(pCallback);

package/lib/server/devices/dachs/interfaces/KeyListEntity.d.ts

@@ -8,11 +8,3 @@ export interface KeyListEntityResponse<V> {
     rawValue?: string;
     value: V;
 }
-/**
-
- "key": "",
- "doc": "",
- "unit": Number
-
-
- */

package/lib/server/devices/dachs/interfaces/KeyListEntity.js

@@ -1,10 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/**
-
- "key": "",
- "doc": "",
- "unit": Number
-
-
- */