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

package/lib/models/groupSettings/heatGroupSettings.js

@@ -9,13 +9,11 @@ class HeatGroupSettings extends groupSettings_1.GroupSettings {
         this.automaticPoints = [];
         /**
          * Whether the temperature should be calculated automatically, or the manualTemperature should be used
-         * @type {boolean}
          */
         this.automaticMode = true;
         this.automaticFallBackTemperatur = 20;
         /**
          * Target temperature when automaticMode is disabled
-         * @type {number}
          */
         this.manualTemperature = 20;
     }

package/lib/models/iIdHolder.d.ts

@@ -3,5 +3,11 @@ import { LogDebugType } from '../server';
 export interface iIdHolder {
     readonly id: string;
     readonly customName: string;
+    /**
+     * Logs a message for this idHolder
+     * @param {LogLevel} level - The log level
+     * @param {string} message - The message to log
+     * @param {LogDebugType} logDebugType - If provided, this message will only be logged if the debug type is enabled in the settings
+     */
     log(level: LogLevel, message: string, logDebugType?: LogDebugType): void;
 }

package/lib/models/objectSettings.d.ts

@@ -4,8 +4,8 @@ export declare abstract class ObjectSettings {
     persist(holder: iIdHolder): void;
     /**
      * Loads the settings from the database
-     * @param {iIdHolder} holder The holder of the settings (e.g. a device)
-     * @param {() => void} loadDoneCb Callback when loading is done
+     * @param holder - The holder of the settings (e.g. a device)
+     * @param loadDoneCb - Callback when loading is done
      */
     initializeFromDb(holder: iIdHolder, loadDoneCb?: () => void): void;
     fromPartialObject(_obj: Partial<ObjectSettings>): void;

package/lib/models/objectSettings.js

@@ -14,8 +14,8 @@ class ObjectSettings {
     }
     /**
      * Loads the settings from the database
-     * @param {iIdHolder} holder The holder of the settings (e.g. a device)
-     * @param {() => void} loadDoneCb Callback when loading is done
+     * @param holder - The holder of the settings (e.g. a device)
+     * @param loadDoneCb - Callback when loading is done
      */
     initializeFromDb(holder, loadDoneCb) {
         var _a;

package/lib/models/rooms/RoomBase.d.ts

@@ -18,7 +18,7 @@ export declare class RoomBase implements iRoomBase, iIdHolder {
     get sunsetShutterCallback(): TimeCallback | undefined;
     /**
      * For Rooms the id is itss name
-     * @returns {string} The Roomname
+     * @returns The Roomname
      */
     get id(): string;
     get customName(): string;
@@ -39,6 +39,7 @@ export declare class RoomBase implements iRoomBase, iIdHolder {
     recalcTimeCallbacks(): void;
     /**
      * Sets the light based on the current time, rollo Position and room Settings
+     * @param c - The command to execute
      */
     setLightTimeBased(c: RoomSetLightTimeBasedCommand): void;
     isNowLightTime(): boolean;

package/lib/models/rooms/RoomBase.js

@@ -41,7 +41,7 @@ class RoomBase {
     }
     /**
      * For Rooms the id is itss name
-     * @returns {string} The Roomname
+     * @returns The Roomname
      */
     get id() {
         return this.roomName;
@@ -106,6 +106,7 @@ class RoomBase {
     }
     /**
      * Sets the light based on the current time, rollo Position and room Settings
+     * @param c - The command to execute
      */
     setLightTimeBased(c) {
         var _a, _b;

package/lib/models/rooms/iRoomBase.d.ts

@@ -7,9 +7,26 @@ export interface iRoomBase {
     sonnenUntergangLichtCallback: TimeCallback | undefined;
     skipNextRolloUp: boolean;
     roomName: string;
+    /**
+     * This function initializes the roomBase object of this room
+     */
     initializeBase(): void;
+    /**
+     * This function stores the roominformation to the database
+     */
     persist(): void;
+    /**
+     * This function recalculates the timecallbacks (e.g. sunset, sunrise handling)
+     */
     recalcTimeCallbacks(): void;
+    /**
+     * This function sets the light in the room based on the command
+     * @param {RoomSetLightTimeBasedCommand} c - The command to execute
+     */
     setLightTimeBased(c: RoomSetLightTimeBasedCommand): void;
+    /**
+     * This function checks if it is now light time respecting the room settings, the current time and the daylight hours for this location.
+     * @returns {boolean}
+     */
     isNowLightTime(): boolean;
 }

package/lib/models/rooms/iRoomImportEnforcer.d.ts

@@ -1,3 +1,7 @@
 export interface iRoomImportEnforcer {
+    /**
+     * This function is called before initializing single devices,
+     * to ensure they can be added to the respective room.
+     */
     addRoomConstructor(): void;
 }

package/lib/server/devices/Griffe.js

@@ -8,7 +8,6 @@ class Griffe {
     static getGriffPosition() {
         const griffe = Griffe.getAllGriffe();
         griffe.sort((a, b) => {
-            a.position;
             return b.position - a.position;
         });
         const response = [`These are the current handle positions:`];

package/lib/server/devices/IoBrokerBaseDevice.d.ts

@@ -23,31 +23,24 @@ export declare abstract class IoBrokerBaseDevice implements iRoomDevice {
     get id(): string;
     /**
      * Getter info
-     * @return {IoBrokerDeviceInfo}
+     * @returns The device info
      */
     get info(): IoBrokerDeviceInfo;
-    /**
-     * Setter info
-     * @param {IoBrokerDeviceInfo} value
-     */
     set info(value: IoBrokerDeviceInfo);
-    /**
-     * Getter ioConn
-     * @return {IOBrokerConnection}
-     */
     get ioConn(): IOBrokerConnection | undefined;
     static addRoom(shortName: string, settings: RoomDeviceAddingSettings): void;
     static checkMissing(): void;
     loadDeviceSettings(): void;
     /**
      * Allows to react on the state change of a given state with the passed cb
-     * @param {string} stateName Last part of the id e.g. "available" not "zigbee.0.00158d00053d3e4b.available"
-     * @param {(val: ioBroker.StateValue) => void} cb Desired Callback Action, with passed ioBroker.StateValue
+     * @param stateName - Last part of the id e.g. "available" not "zigbee.0.00158d00053d3e4b.available"
+     * @param cb - Desired Callback Action, with passed ioBroker.StateValue
      */
     addIndividualStateCallback(stateName: string, cb: (val: ioBroker.StateValue) => void): void;
     /**
      * Returns whether a connection to ioBroker is established or not
-     * @param showError If true, an error message will be written to the log if the connection is not established
+     * @param showError - If true, an error message will be written to the log if the connection is not established
+     * @returns Whether a connection exists
      */
     checkIoConnection(showError?: boolean): boolean;
     abstract update(idSplit: string[], state: ioBroker.State, initial: boolean, pOverride: boolean): void;
@@ -57,10 +50,10 @@ export declare abstract class IoBrokerBaseDevice implements iRoomDevice {
     protected addToCorrectRoom(): void;
     /**
      * Sets the state of a given data point and returns true if that was successful.
-     * @param pointId Data point to write to
-     * @param state Data to write
-     * @param onSuccess Callback to run on successfully written data
-     * @param onError Callback to run if an error has occurred during writing the data
+     * @param pointId - Data point to write to
+     * @param state - Data to write
+     * @param onSuccess - Callback to run on successfully written data
+     * @param onError - Callback to run if an error has occurred during writing the data
      */
     protected setState(pointId: string, state: string | number | boolean | ioBroker.State | ioBroker.SettableState | null, onSuccess?: (() => void) | undefined, onError?: ((error: Error) => void) | undefined): void;
 }

package/lib/server/devices/IoBrokerBaseDevice.js

@@ -37,22 +37,14 @@ class IoBrokerBaseDevice {
     }
     /**
      * Getter info
-     * @return {IoBrokerDeviceInfo}
+     * @returns The device info
      */
     get info() {
         return this._info;
     }
-    /**
-     * Setter info
-     * @param {IoBrokerDeviceInfo} value
-     */
     set info(value) {
         this._info = value;
     }
-    /**
-     * Getter ioConn
-     * @return {IOBrokerConnection}
-     */
     get ioConn() {
         return ioBroker_1.ioBrokerMain.iOConnection;
     }
@@ -74,8 +66,8 @@ class IoBrokerBaseDevice {
     }
     /**
      * Allows to react on the state change of a given state with the passed cb
-     * @param {string} stateName Last part of the id e.g. "available" not "zigbee.0.00158d00053d3e4b.available"
-     * @param {(val: ioBroker.StateValue) => void} cb Desired Callback Action, with passed ioBroker.StateValue
+     * @param stateName - Last part of the id e.g. "available" not "zigbee.0.00158d00053d3e4b.available"
+     * @param cb - Desired Callback Action, with passed ioBroker.StateValue
      */
     addIndividualStateCallback(stateName, cb) {
         let arr = this.individualStateCallbacks.get(stateName);
@@ -89,7 +81,8 @@ class IoBrokerBaseDevice {
     }
     /**
      * Returns whether a connection to ioBroker is established or not
-     * @param showError If true, an error message will be written to the log if the connection is not established
+     * @param showError - If true, an error message will be written to the log if the connection is not established
+     * @returns Whether a connection exists
      */
     checkIoConnection(showError = false) {
         if (!this.ioConn && showError) {
@@ -145,10 +138,10 @@ class IoBrokerBaseDevice {
     }
     /**
      * Sets the state of a given data point and returns true if that was successful.
-     * @param pointId Data point to write to
-     * @param state Data to write
-     * @param onSuccess Callback to run on successfully written data
-     * @param onError Callback to run if an error has occurred during writing the data
+     * @param pointId - Data point to write to
+     * @param state - Data to write
+     * @param onSuccess - Callback to run on successfully written data
+     * @param onError - Callback to run if an error has occurred during writing the data
      */
     setState(pointId, state, onSuccess = undefined, onError = undefined) {
         var _a;

package/lib/server/devices/IoBrokerDeviceInfo.d.ts

@@ -13,8 +13,8 @@ export declare class IoBrokerDeviceInfo extends DeviceInfo {
     private static replaceInvalidIdChars;
     /**
      * 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: deviceConfig, isJsStateChildObject?: boolean);

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,13 +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;
+    /**
+     * 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
+     */
     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;
 }