hoffmation-base 3.0.0-alpha.9 → 3.0.0-alpha.90

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

@@ -1,14 +1,57 @@
 import { iMotionSensor } from './iMotionSensor';
 import { CameraSettings } from '../../../models';
+import { iBaseDevice } from './iBaseDevice';
+/**
+ * An interface for any device with {@link DeviceCapability.camera} capability
+ */
 export interface iCameraDevice extends iMotionSensor {
+    /**
+     * The settings of the camera device
+     */
     settings: CameraSettings;
+    /**
+     * The last image taken by the camera as a base64 encoded string
+     */
     readonly lastImage: string;
+    /**
+     * The link to access the mpeg stream of the camera
+     */
     readonly mpegStreamLink: string;
+    /**
+     * The link to access the h264 stream of the camera
+     */
     readonly h264IosStreamLink: string;
+    /**
+     * The link to access the rtsp stream of the camera
+     */
     readonly rtspStreamLink: string;
+    /**
+     * The link to obtain a fresh image from the camera
+     */
     readonly currentImageLink: string;
-    readonly alarmBlockedByGriff: boolean;
-    readonly alarmBlockedByGriffTimeStamp: number;
-    onGriffUpdate(open: boolean): void;
+    /**
+     * Whether the alarm is currently blocked by a certain device (e.g. an open handle for house-to-garden door)
+     */
+    readonly alarmBlockedByDevices: boolean;
+    /**
+     * Whether the camera has currently detected a dog
+     */
+    readonly dogDetected: boolean;
+    /**
+     * Whether the camera has currently detected a human
+     */
+    readonly personDetected: boolean;
+    /**
+     * Inform this camera of a device, which blocks the alarm (or should unlift its block)
+     * @param device - The device to block/unblock the alarm for
+     * @param block - Whether to block the alarm for the device or lift the block
+     */
+    blockForDevice(device: iBaseDevice, block: 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,27 @@
 import { iLamp } from './iLamp';
 import { DimmerSetLightCommand, DimmerSettings, LampToggleLightCommand } from '../../../models';
+/**
+ * This interface represents a dimmable lamp device.
+ *
+ * For devices with {@link DeviceCapability.dimmablelamp} capability.
+ */
 export interface iDimmableLamp extends iLamp {
+    /**
+     * The settings of the dimmer providing e.g. brightness settings for different times of the day.
+     */
     settings: DimmerSettings;
+    /**
+     * The current brightness of the light in percent.
+     */
     readonly brightness: number;
+    /**
+     * This function toggles the light on or off.
+     * @param 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 command - The command to execute on the light device.
      */
     setLight(command: DimmerSetLightCommand): void;
 }

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

@@ -1,12 +1,46 @@
 import { iExcessEnergyConsumer } from './iExcessEnergyConsumer';
 import { iBaseDevice } from './iBaseDevice';
-export interface iEnergyManager extends iBaseDevice {
+import { iDisposable } from '../../services';
+/**
+ * Interface for devices that can manage energy consumption and production.
+ *
+ * For devices with {@link DeviceCapability.energyManager} capability.
+ */
+export interface iEnergyManager extends iBaseDevice, iDisposable {
+    /**
+     * The total energy being excessive at the moment of last calculation.
+     *
+     * For devices with {@link DeviceCapability.energyManager} capability.
+     */
     excessEnergy: number;
+    /**
+     * Whether the Energy Manager actively blocks AC
+     */
+    readonly acBlocked: boolean;
+    /**
+     * The total wattaage being injected into the grid at the moment of last calculation.
+     */
     readonly injectingWattage: number;
+    /**
+     * The total wattage being drawn from the grid at the moment of last calculation.
+     */
     readonly drawingWattage: number;
+    /**
+     * The total wattage being consumed within the house at the moment of last calculation.
+     */
     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,40 @@
-import { ExcessEnergyConsumerSettings, LogLevel } from '../../../models';
+import { ExcessEnergyConsumerSettings } from '../../../models';
 import { iBaseDevice } from './iBaseDevice';
+/**
+ * This interface represents a device that can consume excess energy.
+ *
+ * For devices with {@link DeviceCapability.excessEnergyConsumer} capability.
+ */
 export interface iExcessEnergyConsumer extends iBaseDevice {
+    /**
+     * The energy consuming settings for this device
+     */
     readonly energySettings: ExcessEnergyConsumerSettings;
+    /**
+     * Consumption in Watts, needed to manage the Excess consumer
+     */
     currentConsumption: number;
+    /**
+     * Whether this consumer is currently on or off
+     */
     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 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 Whether this device was activated by excess energy
+     */
     wasActivatedByExcessEnergy(): boolean;
 }

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

@@ -1,9 +1,30 @@
 import { GarageDoorOpenerSettings } from '../../../models';
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * This interface represents a garage door opener device.
+ *
+ * For devices with {@link DeviceCapability.garageDoorOpener} capability.
+ */
 export interface iGarageDoorOpener extends iRoomDevice {
+    /**
+     * The settings of the garage door opener
+     */
     settings: GarageDoorOpenerSettings;
+    /**
+     * Whether the garage door is currently closed
+     */
     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

@@ -1,9 +1,43 @@
 import { WindowPosition } from '../models';
 import { iRoomDevice } from './iRoomDevice';
+import { HandleSensor } from '../sharedFunctions';
+import { Window } from '../groups';
+/**
+ * Interface for Handle Sensors.
+ * A handle sensor can be any device that is capable of detecting the position of a window handle e.g. a sensor, a window handle, etc.
+ *
+ * For devices with {@link DeviceCapability.handleSensor} capability.
+ */
 export interface iHandleSensor extends iRoomDevice {
+    /**
+     * A common object for all handle sensors handling stuff like persist and callbacks
+     */
+    handleSensor: HandleSensor;
+    /**
+     * The current position of the handle
+     */
     position: WindowPosition;
+    /**
+     * The time the handle was open in minutes
+     */
     minutesOpen: number;
+    /**
+     * If known the window this handle is attached to
+     */
+    window: Window | undefined;
+    /**
+     * Add a callback that is called when the handle is change to open
+     * @param 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 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 pCallback - The callback to fire
+     */
     addClosedCallback(pCallback: (pValue: boolean) => void): void;
 }

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

@@ -1,17 +1,52 @@
-/// <reference types="node" />
 import { HeaterSettings } from '../../../models';
 import { iRoomDevice } from './iRoomDevice';
-export interface iHeater extends iRoomDevice {
+import { iDisposable } from '../../services';
+/**
+ * This interface represents a heater device.
+ *
+ * For devices with {@link DeviceCapability.heater} capability.
+ */
+export interface iHeater extends iRoomDevice, iDisposable {
+    /**
+     * The settings of the heater
+     */
     settings: HeaterSettings;
+    /**
+     * The desired temperature in degree Celsius for this room.
+     */
     desiredTemperature: number;
-    readonly humidity: number;
+    /**
+     * The current valve position of the heater (between 0 and 1.0)
+     */
     readonly iLevel: number;
+    /**
+     * The current temperature in degree Celsius of the heater
+     */
     readonly iTemperature: number;
-    roomTemperature: number;
+    /**
+     * The current room temperature in degree Celsius
+     */
+    readonly roomTemperature: number;
+    /**
+     * The interval to persist the heater information
+     * This mainly enforces the interval to be implemented.
+     */
     readonly persistHeaterInterval: NodeJS.Timeout;
+    /**
+     * Whether the heater is currently in a season turnoff state (no heating in summer)
+     */
     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

@@ -1,9 +1,24 @@
-/// <reference types="node" />
 import { iRoomDevice } from './iRoomDevice';
+import { HumiditySensorChangeAction } from '../../../models';
+import { HumiditySensor } from '../sharedFunctions';
 export declare const UNDEFINED_HUMIDITY_VALUE = -1;
+/**
+ * This interface represents a humidity sensor device.
+ *
+ * For devices with {@link DeviceCapability.humiditySensor} capability.
+ */
 export interface iHumiditySensor extends iRoomDevice {
-    readonly persistHumiditySensorInterval: NodeJS.Timeout;
+    /**
+     * Common humidity sensor handling like persisting
+     */
+    readonly humiditySensor: HumiditySensor;
+    /**
+     * The current humidity in percent
+     */
     readonly humidity: number;
-    addHumidityCallback(pCallback: (pValue: number) => void): void;
-    persistHumiditySensor(): void;
+    /**
+     * Add a callback that is called when the humidity changes
+     * @param pCallback - The callback to fire
+     */
+    addHumidityCallback(pCallback: (action: HumiditySensorChangeAction) => void): void;
 }

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

@@ -1,4 +1,15 @@
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * This interface represents a illumination sensor device.
+ *
+ * For devices with {@link DeviceCapability.illuminationSensor} capability.
+ */
 export interface iIlluminationSensor extends iRoomDevice {
+    /**
+     * The current illumination level detected by the sensor
+     *
+     * For {@link DeviceType.ZigbeeAquaraMotion} devices, this is the current illuminance in lux.
+     * TODO: Add unit and make it comparable
+     */
     currentIllumination: number;
 }

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

@@ -1,10 +1,15 @@
 import { LampSetLightCommand, LampSetTimeBasedCommand, LampToggleLightCommand } from '../../../models';
 import { iActuator } from './iActuator';
+/**
+ * This interface represents a lamp device.
+ *
+ * For devices with {@link DeviceCapability.lamp} capability.
+ */
 export interface iLamp extends iActuator {
     /**
-     * The state value of the device
+     * Changes the state of the lamp based on the time
+     * @param command - The command to execute
      */
-    readonly lightOn: boolean;
     setTimeBased(command: LampSetTimeBasedCommand): void;
     /**
      * Toggles the state of the lamp

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

@@ -1,8 +1,28 @@
 import { LedSetLightCommand, LedSettings } from '../../../models';
 import { iDimmableLamp } from './iDimmableLamp';
+/**
+ * Interface for RGB-CCT LED-Devices.
+ * A RGB-CCT LED-Device is a LED-Device that is capable of emitting light in different colors and color temperatures.
+ *
+ * For devices with {@link DeviceCapability.ledLamp} capability.
+ */
 export interface iLedRgbCct extends iDimmableLamp {
+    /**
+     * The settings of the LED-Device (e.g. brightness, color, colortemp) for different times of the day
+     */
     settings: LedSettings;
+    /**
+     * The currently active color in HEX representation
+     */
     readonly color: string;
+    /**
+     * The currently active color temperature
+     */
     readonly colortemp: number;
+    /**
+     * This function sets the light to a specific value
+     * Accessible in API
+     * @param c - The command to execute
+     */
     setLight(c: LedSetLightCommand): void;
 }

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

@@ -1,3 +1,8 @@
+/**
+ * Interface for a device that can measure the load power in Watts
+ *
+ * For devices with {@link DeviceCapability.loadMetering} capability.
+ */
 export interface iLoadMeter {
     /**
      * The current load power in Watts

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

@@ -0,0 +1,31 @@
+import { iRoomDevice } from './iRoomDevice';
+import { MagnetPosition } from '../models';
+/**
+ * This interface represents a magnet sensor device.
+ *
+ * For devices with {@link DeviceCapability.magnetSensor} capability.
+ */
+export interface iMagnetSensor extends iRoomDevice {
+    /**
+     * The current state of the Magnet Contact
+     */
+    position: MagnetPosition;
+    /**
+     * Whether a telegram message should be sent when the magnet contact is opened
+     */
+    telegramOnOpen: boolean;
+    /**
+     * Whether to announce when the magnet contact is opened using {@link iSpeaker}
+     */
+    speakOnOpen: boolean;
+    /**
+     * Add a callback that is called when the magnet contact is opened
+     * @param pCallback - The callback to fire
+     */
+    addOpenCallback(pCallback: (pValue: boolean) => void): void;
+    /**
+     * Add a callback that is called when the magnet contact is closed
+     * @param pCallback - The callback to fire
+     */
+    addClosedCallback(pCallback: (pValue: boolean) => void): void;
+}

package/lib/server/devices/baseDeviceInterfaces/iMagnetSensor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,14 +1,34 @@
-import { MotionSensorSettings } from '../../../models';
+import { MotionSensorAction, MotionSensorSettings } from '../../../models';
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * This interface represents a motion sensor device.
+ *
+ * For devices with {@link DeviceCapability.motionSensor} capability.
+ */
 export interface iMotionSensor extends iRoomDevice {
+    /**
+     * The settings of the MotionSensor
+     */
     settings: MotionSensorSettings;
+    /**
+     * Whether motion is currently detected
+     */
     readonly movementDetected: boolean;
+    /**
+     * Time since the last motion was detected in seconds
+     */
     readonly timeSinceLastMotion: number;
+    /**
+     * The number of detections today so far
+     */
     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: (action: MotionSensorAction) => void): void;
+    /**
+     * Persists the current motion information to the database
      */
-    addMovementCallback(pCallback: (newState: boolean) => void): void;
     persistMotionSensor(): void;
 }

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

@@ -1,5 +1,11 @@
 import { RoomBase } from '../../../models';
 import { iBaseDevice } from './iBaseDevice';
+/**
+ * This interface represents a device that is located in a single room.
+ */
 export interface iRoomDevice extends iBaseDevice {
+    /**
+     * The room the device is in (this might be undefined if the device is not yet properly initialized)
+     */
     room: RoomBase | undefined;
 }

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

@@ -1,13 +1,42 @@
-/// <reference types="node" />
 import { iRoomDevice } from './index';
 import { SceneSettings } from '../../../models';
+/**
+ * This interface represents a scene which for simplification is considered as a device.
+ *
+ * For devices with {@link DeviceCapability.scene} capability.
+ */
 export interface iScene extends iRoomDevice {
+    /**
+     * The settings for the scene
+     */
+    settings: SceneSettings;
+    /**
+     * A description of the scene providing the user with information about what the scene does
+     */
     description: string;
+    /**
+     * Callback to be executed when the scene should be started
+     */
     readonly onSceneStart: () => void;
+    /**
+     * Callback to be executed when the scene should be ended
+     */
     readonly onSceneEnd: () => void;
+    /**
+     * Whether the scene is currently active
+     */
     readonly on: boolean;
+    /**
+     * The timeout for the automatic end of the scene
+     */
     readonly automaticEndTimeout: NodeJS.Timeout | null;
-    settings: SceneSettings;
+    /**
+     * Starts the scene for the given duration
+     * @param 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

@@ -1,11 +1,35 @@
 import { Window } from '../groups';
 import { iRoomDevice } from './iRoomDevice';
 import { ShutterSetLevelCommand, ShutterSettings } from '../../../models';
+/**
+ * This interface represents a shutter device.
+ *
+ * For devices with {@link DeviceCapability.shutter} capability.
+ */
 export interface iShutter extends iRoomDevice {
+    /**
+     * The settings for the shutter
+     */
     settings: ShutterSettings;
-    currentLevel: number;
+    /**
+     * The current level of the shutter (0 = closed, 100 = open)
+     */
+    readonly currentLevel: number;
+    /**
+     * The desired level of the shutter for this window (this might be different from the current level due to the desired level being set by the user)
+     */
     desiredWindowShutterLevel: number;
+    /**
+     * The window this shutter is located within
+     */
     window: Window | undefined;
+    /**
+     * Persists the current information of the shutter to the database
+     */
     persist(): void;
+    /**
+     * Sets the level of the shutter
+     * @param command - The command to execute
+     */
     setLevel(command: ShutterSetLevelCommand): void;
 }

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

@@ -1,5 +1,17 @@
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * This interface represents a smoke detector device.
+ *
+ * For devices with {@link DeviceCapability.smokeSensor} capability.
+ */
 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 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,38 @@
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * This interface represents a speaker device.
+ *
+ * For devices with {@link DeviceCapability.speaker} capability.
+ */
 export interface iSpeaker extends iRoomDevice {
+    /**
+     * Plays an mp3 file on the device
+     * @param mp3Name - The name of the mp3 file to play
+     * @param duration - The duration of the mp3 file in seconds
+     * @param [volume] - The volume to play the mp3 file with
+     * @param [onlyWhenPlaying] - If true, the mp3 file will only be played when the device is already playing something
+     * @param [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 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 pMessage - The message to speak
+     * @param [volume] - The volume to speak the message with
+     * @param [onlyWhenPlaying] - If true, the message will only be spoken when the device is already playing something
+     * @param [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;
 }