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

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

@@ -1,12 +1,37 @@
-/// <reference types="node" />
 import { iRoomDevice } from './iRoomDevice';
+import { TemperatureSensorChangeAction } from '../../../models';
+import { TemperatureSensor } from '../sharedFunctions';
 export declare const UNDEFINED_TEMP_VALUE = -99;
+/**
+ * This interface represents a temperature sensor device.
+ *
+ * For devices with {@link DeviceCapability.temperatureSensor} capability.
+ */
 export interface iTemperatureSensor extends iRoomDevice {
-    readonly persistTemperatureSensorInterval: NodeJS.Timeout;
+    /**
+     * Service which handles common aspects of the temperature sensor like persisting
+     */
+    readonly temperatureSensor: TemperatureSensor;
+    /**
+     * The current room temperature as a number in Celsius
+     */
     roomTemperature: number;
-    iTemperature: number;
+    /**
+     * The devices measured Temperature as a number in Celsius
+     */
+    readonly iTemperature: number;
+    /**
+     * Formatted Temperature as a string in Celsius
+     */
     sTemperature: string;
-    addTempChangeCallback(pCallback: (pValue: number) => void): void;
+    /**
+     * Adds a callback to be called when the temperature changes
+     * @param pCallback - The callback to be called
+     */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    /**
+     * Inform the temperature sensor that the temperature in the room has changed
+     * @param newTemperatur - The new temperature in the room in Celsius
+     */
     onTemperaturChange(newTemperatur: number): void;
-    persistTemperaturSensor(): void;
 }

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

@@ -1,7 +1,20 @@
 import { BlockAutomaticHandler } from '../../services/blockAutomaticHandler';
 import { iBaseDevice } from './iBaseDevice';
 import { RestoreTargetAutomaticValueCommand } from '../../../models';
+/**
+ * This interface represents a device which automatic action can be temporarily disabled.
+ * E.g. Forcing a lamp to stay on, even if the automatic would turn it off.
+ *
+ * For devices with {@link DeviceCapability.blockAutomatic} capability.
+ */
 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 command - The command to restore the automatic value/state
+     */
     restoreTargetAutomaticValue(command: RestoreTargetAutomaticValueCommand): void;
 }

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

@@ -1,8 +1,28 @@
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * This interface represents a TV device.
+ *
+ * For devices with {@link DeviceCapability.tv} capability.
+ */
 export interface iTvDevice extends iRoomDevice {
+    /**
+     * Whether the TV is currently on
+     */
     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

@@ -1,9 +1,28 @@
 import { iRoomDevice } from './iRoomDevice';
+/**
+ * This interface represents a vibration sensor device.
+ *
+ * For devices with {@link DeviceCapability.vibrationSensor} capability.
+ */
 export interface iVibrationSensor extends iRoomDevice {
-    vibrationBlockedByGriff: boolean;
-    vibrationBlockedByGriffTimeStamp: number;
+    /**
+     * Whether the vibration sensor is currently blocked by a handle.
+     */
+    vibrationBlockedByHandle: boolean;
+    /**
+     * The timestamp when the vibration sensor was blocked by a handle.
+     */
+    readonly vibrationBlockedByHandleTimeStamp: number;
+    /**
+     * Whether the vibration sensor is currently blocked by a motion event.
+     */
     vibrationBlockedByMotion: boolean;
-    vibrationBlockedByMotionTimeStamp: number;
-    vibration: boolean;
-    alarmCheck(): void;
+    /**
+     * The timestamp when the vibration sensor was last blocked by a motion event.
+     */
+    readonly vibrationBlockedByMotionTimeStamp: number;
+    /**
+     * Whether the vibration sensor is currently detecting a vibration.
+     */
+    readonly vibration: boolean;
 }

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

@@ -22,3 +22,4 @@ export * from './iTemperatureSensor';
 export * from './iTemporaryDisableAutomatic';
 export * from './iTvDevice';
 export * from './iVibrationSensor';
+export { iMagnetSensor } from './iMagnetSensor';

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

@@ -1,68 +1,83 @@
-import { iCameraDevice, iRoomDevice } from '../baseDeviceInterfaces';
-import { CameraSettings, LogLevel, RoomBase } from '../../../models';
+import { iBaseDevice, iCameraDevice, iRoomDevice } from '../baseDeviceInterfaces';
+import { CameraSettings, LogLevel, MotionSensorAction, RoomBase } from '../../../models';
 import { LogDebugType } from '../../services';
 import { DeviceInfo } from '../DeviceInfo';
 import { DeviceCapability } from '../DeviceCapability';
 import { DeviceType } from '../deviceType';
 export declare class CameraDevice implements iCameraDevice {
+    /**
+     * The name of the camera in BlueIris
+     */
     readonly blueIrisName: string;
+    /** @inheritDoc */
+    settings: CameraSettings;
+    /** @inheritDoc */
+    readonly deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
+    deviceType: DeviceType;
+    /**
+     * The human readable name of this device
+     */
+    readonly name: string;
+    /** @inheritDoc */
+    readonly mpegStreamLink: string;
+    /** @inheritDoc */
+    readonly h264IosStreamLink: string;
+    /** @inheritDoc */
+    readonly rtspStreamLink: string;
+    /** @inheritDoc */
+    readonly currentImageLink: string;
+    /** @inheritDoc */
+    detectionsToday: number;
+    protected _lastMotion: number;
     private _personDetectFallbackTimeout;
     private _movementDetectFallbackTimeout;
     private _dogDetectFallbackTimeout;
     private _personDetectedStateId;
     private _dogDetectedStateId;
     private _movementDetectedStateId;
-    get lastImage(): string;
-    settings: CameraSettings;
-    readonly deviceCapabilities: DeviceCapability[];
-    deviceType: DeviceType;
-    readonly name: string;
-    protected _lastMotion: number;
     private _initialized;
     private _movementDetectedCallback;
     private _lastImage;
     private _personDetected;
     private _dogDetected;
-    private _alarmGriffBlockCount;
-    private _alarmBlockedByGriffTimeStamp;
-    readonly mpegStreamLink: string;
-    readonly h264IosStreamLink: string;
-    readonly rtspStreamLink: string;
-    readonly currentImageLink: string;
+    private _devicesBlockingAlarmMap;
+    private _movementDetected;
+    private _info;
+    constructor(mqttName: string, roomName: string, blueIrisName: string);
+    /** @inheritDoc */
+    get lastImage(): string;
+    /** @inheritDoc */
     get dogDetected(): boolean;
+    /** @inheritDoc */
     get personDetected(): boolean;
-    get alarmBlockedByGriffTimeStamp(): number;
-    get alarmBlockedByGriff(): boolean;
-    constructor(mqttName: string, roomName: string, blueIrisName: string);
-    private _detectionsToday;
-    get detectionsToday(): number;
-    set detectionsToday(pVal: number);
-    private _movementDetected;
+    /** @inheritDoc */
+    get alarmBlockedByDevices(): boolean;
+    /** @inheritDoc */
     get movementDetected(): boolean;
-    private _info;
+    /** @inheritDoc */
     get info(): DeviceInfo;
-    set info(info: DeviceInfo);
-    /**
-     * Time since Last Motion in seconds
-     * @returns {number}
-     */
+    /** @inheritDoc */
     get timeSinceLastMotion(): number;
+    /** @inheritDoc */
     get customName(): string;
+    /** @inheritDoc */
     get id(): string;
+    /** @inheritDoc */
     get room(): RoomBase | undefined;
-    /**
-     * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
-     */
-    addMovementCallback(pCallback: (newState: boolean) => void): void;
-    onGriffUpdate(open: boolean): void;
+    /** @inheritDoc */
+    addMovementCallback(pCallback: (action: MotionSensorAction) => void): void;
+    /** @inheritDoc */
+    blockForDevice(device: iBaseDevice, block: boolean): void;
+    /** @inheritDoc */
     persistMotionSensor(): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State): void;
-    updateMovement(newState: boolean): void;
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
     toJSON(): Partial<iRoomDevice>;
     persistDeviceInfo(): void;
     loadDeviceSettings(): void;
+    private updateMovement;
     private resetPersonDetectFallbackTimer;
     private resetDogDetectFallbackTimer;
     private resetMovementFallbackTimer;

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

@@ -14,45 +14,37 @@ const DeviceCapability_1 = require("../DeviceCapability");
 const deviceType_1 = require("../deviceType");
 const ioBroker_1 = require("../../ioBroker");
 class CameraDevice {
-    get lastImage() {
-        return this._lastImage;
-    }
-    get dogDetected() {
-        return this._dogDetected;
-    }
-    get personDetected() {
-        return this._personDetected;
-    }
-    get alarmBlockedByGriffTimeStamp() {
-        return this._alarmBlockedByGriffTimeStamp;
-    }
-    get alarmBlockedByGriff() {
-        return this._alarmGriffBlockCount > 0;
-    }
     constructor(mqttName, roomName, blueIrisName) {
         var _a;
+        /** @inheritDoc */
+        this.settings = new models_1.CameraSettings();
+        /** @inheritDoc */
+        this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.camera, DeviceCapability_1.DeviceCapability.motionSensor];
+        /** @inheritDoc */
+        this.deviceType = deviceType_1.DeviceType.Camera;
+        /** @inheritDoc */
+        this.mpegStreamLink = '';
+        /** @inheritDoc */
+        this.h264IosStreamLink = '';
+        /** @inheritDoc */
+        this.rtspStreamLink = '';
+        /** @inheritDoc */
+        this.currentImageLink = '';
+        /** @inheritDoc */
+        this.detectionsToday = 0;
+        this._lastMotion = 0;
         this._personDetectFallbackTimeout = null;
         this._movementDetectFallbackTimeout = null;
         this._dogDetectFallbackTimeout = null;
         this._personDetectedStateId = undefined;
         this._dogDetectedStateId = undefined;
         this._movementDetectedStateId = undefined;
-        this.settings = new models_1.CameraSettings();
-        this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.camera, DeviceCapability_1.DeviceCapability.motionSensor];
-        this.deviceType = deviceType_1.DeviceType.Camera;
-        this._lastMotion = 0;
         this._initialized = false;
         this._movementDetectedCallback = [];
         this._lastImage = '';
         this._personDetected = false;
         this._dogDetected = false;
-        this._alarmGriffBlockCount = 0;
-        this._alarmBlockedByGriffTimeStamp = 0;
-        this.mpegStreamLink = '';
-        this.h264IosStreamLink = '';
-        this.rtspStreamLink = '';
-        this.currentImageLink = '';
-        this._detectionsToday = 0;
+        this._devicesBlockingAlarmMap = new Map();
         this._movementDetected = false;
         this.blueIrisName = blueIrisName;
         this.name = mqttName;
@@ -87,59 +79,67 @@ class CameraDevice {
             });
         }
     }
-    get detectionsToday() {
-        return this._detectionsToday;
+    /** @inheritDoc */
+    get lastImage() {
+        return this._lastImage;
+    }
+    /** @inheritDoc */
+    get dogDetected() {
+        return this._dogDetected;
+    }
+    /** @inheritDoc */
+    get personDetected() {
+        return this._personDetected;
     }
-    set detectionsToday(pVal) {
-        this._detectionsToday = pVal;
+    /** @inheritDoc */
+    get alarmBlockedByDevices() {
+        return this._devicesBlockingAlarmMap.size > 0;
     }
+    /** @inheritDoc */
     get movementDetected() {
         return this._movementDetected;
     }
+    /** @inheritDoc */
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
-    /**
-     * Time since Last Motion in seconds
-     * @returns {number}
-     */
+    /** @inheritDoc */
     get timeSinceLastMotion() {
         return Math.round((services_1.Utils.nowMS() - this._lastMotion) / 1000);
     }
+    /** @inheritDoc */
     get customName() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `camera-${this.info.room}-${this.info.customName}`;
     }
+    /** @inheritDoc */
     get room() {
         return services_1.API.getRoom(this.info.room);
     }
-    /**
-     * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
-     */
+    /** @inheritDoc */
     addMovementCallback(pCallback) {
         this._movementDetectedCallback.push(pCallback);
     }
-    onGriffUpdate(open) {
-        this._alarmGriffBlockCount += open ? 1 : -1;
-        if (this._alarmGriffBlockCount < 0) {
-            this._alarmGriffBlockCount = 0;
+    /** @inheritDoc */
+    blockForDevice(device, block) {
+        if (block) {
+            this._devicesBlockingAlarmMap.set(device.id, device);
         }
-        if (this._alarmGriffBlockCount == 1) {
-            this._alarmBlockedByGriffTimeStamp = new Date().getTime();
+        else {
+            this._devicesBlockingAlarmMap.delete(device.id);
         }
-        this.log(models_1.LogLevel.Debug, `Handle change to open (${open}), new open amount: ${this._alarmGriffBlockCount}`);
+        this.log(models_1.LogLevel.Debug, `Handle device ${block ? 'block' : 'unblock'}, new blocking amount: ${this._devicesBlockingAlarmMap.size}`);
     }
+    /** @inheritDoc */
     persistMotionSensor() {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistMotionSensor(this);
     }
+    /** @inheritDoc */
     update(idSplit, state) {
         const stateName = idSplit[4];
         switch (stateName) {
@@ -160,7 +160,7 @@ class CameraDevice {
                 const newValue = state.val === 1;
                 this.log(models_1.LogLevel.Debug, `Update for "${stateName}" to value: ${state.val}`);
                 if (newValue) {
-                    this.log(models_1.LogLevel.Info, `Person Detected`);
+                    this.log(models_1.LogLevel.Info, 'Person Detected');
                     this.resetPersonDetectFallbackTimer();
                 }
                 this._personDetected = newValue;
@@ -173,7 +173,7 @@ class CameraDevice {
                 const newDogDetectionVal = state.val === 1;
                 this.log(models_1.LogLevel.Debug, `Update for "${stateName}" to value: ${state.val}`);
                 if (newDogDetectionVal) {
-                    this.log(models_1.LogLevel.Info, `Dog Detected`);
+                    this.log(models_1.LogLevel.Info, 'Dog Detected');
                     this.resetDogDetectFallbackTimer();
                 }
                 this._dogDetected = newDogDetectionVal;
@@ -185,36 +185,12 @@ class CameraDevice {
                 this._lastImage = state.val;
                 services_1.Utils.guardedTimeout(() => {
                     // Give Person Detected Update some time, as otherwise personDetected might still be false
-                    if (this.settings.alertPersonOnTelegram && this._personDetected && !this.alarmBlockedByGriff) {
+                    if (this.settings.alertPersonOnTelegram && this._personDetected && !this.alarmBlockedByDevices) {
                         services_1.TelegramService.sendImage(`${this.name} detected Person`, new models_1.Base64Image(this._lastImage, 'person_alert'));
                     }
                 }, 1000);
         }
     }
-    updateMovement(newState) {
-        if (!this._initialized && newState) {
-            this.log(models_1.LogLevel.Trace, `Movement recognized, but database initialization has not finished yet --> delay.`);
-            services_1.Utils.guardedTimeout(() => {
-                this.updateMovement(newState);
-            }, 1000, this);
-            return;
-        }
-        if (newState === this.movementDetected) {
-            this.log(models_1.LogLevel.Debug, `Skip movement because state is already ${newState}`, services_1.LogDebugType.SkipUnchangedMovementState);
-            return;
-        }
-        this._lastMotion = services_1.Utils.nowMS();
-        this._movementDetected = newState;
-        this.persistMotionSensor();
-        this.log(models_1.LogLevel.Debug, `New movement state: ${newState}`, services_1.LogDebugType.NewMovementState);
-        if (newState) {
-            this.detectionsToday++;
-            this.log(models_1.LogLevel.Trace, `This is movement no. ${this.detectionsToday}`);
-        }
-        for (const c of this._movementDetectedCallback) {
-            c(newState);
-        }
-    }
     log(level, message, debugType = services_1.LogDebugType.None) {
         var _a, _b;
         services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
@@ -240,6 +216,30 @@ class CameraDevice {
         var _a;
         (_a = this.settings) === null || _a === void 0 ? void 0 : _a.initializeFromDb(this);
     }
+    updateMovement(newState) {
+        if (!this._initialized && newState) {
+            this.log(models_1.LogLevel.Trace, 'Movement recognized, but database initialization has not finished yet --> delay.');
+            services_1.Utils.guardedTimeout(() => {
+                this.updateMovement(newState);
+            }, 1000, this);
+            return;
+        }
+        if (newState === this.movementDetected) {
+            this.log(models_1.LogLevel.Debug, `Skip movement because state is already ${newState}`, services_1.LogDebugType.SkipUnchangedMovementState);
+            return;
+        }
+        this._lastMotion = services_1.Utils.nowMS();
+        this._movementDetected = newState;
+        this.persistMotionSensor();
+        this.log(models_1.LogLevel.Debug, `New movement state: ${newState}`, services_1.LogDebugType.NewMovementState);
+        if (newState) {
+            this.detectionsToday++;
+            this.log(models_1.LogLevel.Trace, `This is movement no. ${this.detectionsToday}`);
+        }
+        for (const c of this._movementDetectedCallback) {
+            c(new models_1.MotionSensorAction(this));
+        }
+    }
     resetPersonDetectFallbackTimer() {
         if (this._personDetectFallbackTimeout !== null) {
             clearTimeout(this._personDetectFallbackTimeout);

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

@@ -7,7 +7,6 @@ export declare class Button {
     private _callbacksMap;
     private _timeouts;
     constructor(name: string, buttonCapabilities: ButtonCapabilities);
-    getState(type: ButtonPressType): boolean;
     addCb(buttonType: ButtonPressType, pCallback: (pValue: boolean) => void, description?: string): void;
     isPressActive(type: ButtonPressType): boolean | undefined;
     getDescription(): string;

package/lib/server/devices/button/button.js

@@ -32,10 +32,6 @@ class Button {
             this._statesMap.set(buttonPressType_1.ButtonPressType.triple, false);
         }
     }
-    getState(type) {
-        var _a;
-        return (_a = this._statesMap.get(type)) !== null && _a !== void 0 ? _a : false;
-    }
     addCb(buttonType, pCallback, description = 'Not described') {
         const cbArr = this._callbacksMap.get(buttonType);
         if (cbArr === undefined) {

package/lib/server/devices/button/buttonCallback.d.ts

@@ -0,0 +1,5 @@
+export declare class ButtonCallback {
+    readonly cb: (pValue: boolean) => void;
+    readonly description: string;
+    constructor(cb: (pValue: boolean) => void, description: string);
+}

package/lib/server/devices/button/buttonCallback.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ButtonCallback = void 0;
+class ButtonCallback {
+    constructor(cb, description) {
+        this.cb = cb;
+        this.description = description;
+    }
+}
+exports.ButtonCallback = ButtonCallback;

package/lib/server/devices/button/buttonCapabilities.d.ts

@@ -1,6 +1,18 @@
 export declare class ButtonCapabilities {
+    /**
+     * Whether the button supports short press
+     */
     shortPress: boolean;
+    /**
+     * Whether the button supports double press
+     */
     doublePress: boolean;
+    /**
+     * Whether the button supports triple press
+     */
     triplePress: boolean;
+    /**
+     * Whether the button supports long press
+     */
     longPress: boolean;
 }

package/lib/server/devices/button/buttonCapabilities.js

@@ -3,9 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ButtonCapabilities = void 0;
 class ButtonCapabilities {
     constructor() {
+        /**
+         * Whether the button supports short press
+         */
         this.shortPress = true;
+        /**
+         * Whether the button supports double press
+         */
         this.doublePress = true;
+        /**
+         * Whether the button supports triple press
+         */
         this.triplePress = true;
+        /**
+         * Whether the button supports long press
+         */
         this.longPress = true;
     }
 }

package/lib/server/devices/button/index.d.ts

@@ -2,3 +2,4 @@ export * from './button';
 export * from './buttonCapabilities';
 export * from './buttonPressType';
 export * from './buttonPosition';
+export { ButtonCallback } from './buttonCallback';

package/lib/server/devices/button/index.js

@@ -14,7 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ButtonCallback = void 0;
 __exportStar(require("./button"), exports);
 __exportStar(require("./buttonCapabilities"), exports);
 __exportStar(require("./buttonPressType"), exports);
 __exportStar(require("./buttonPosition"), exports);
+var buttonCallback_1 = require("./buttonCallback");
+Object.defineProperty(exports, "ButtonCallback", { enumerable: true, get: function () { return buttonCallback_1.ButtonCallback; } });