hoffmation-base 3.2.3-alpha.5 → 3.2.3-alpha.7

package/lib/action/motionSensorAction.d.ts

@@ -1,5 +1,5 @@
 import { BaseAction } from './baseAction';
-import { CommandType } from '../enums';
+import { CommandSource, CommandType } from '../enums';
 import { iMotionSensor } from '../interfaces';
 export declare class MotionSensorAction extends BaseAction {
     /** @inheritDoc */
@@ -12,5 +12,5 @@ export declare class MotionSensorAction extends BaseAction {
      * The motion sensor that triggered the action
      */
     readonly sensor: iMotionSensor;
-    constructor(sensor: iMotionSensor);
+    constructor(sensor: iMotionSensor, source?: CommandSource);
 }

package/lib/action/motionSensorAction.js

@@ -4,8 +4,8 @@ exports.MotionSensorAction = void 0;
 const baseAction_1 = require("./baseAction");
 const enums_1 = require("../enums");
 class MotionSensorAction extends baseAction_1.BaseAction {
-    constructor(sensor) {
-        super(enums_1.CommandSource.Automatic, `${sensor.customName} ${sensor.movementDetected ? 'detected' : 'cleared'} motion`);
+    constructor(sensor, source = enums_1.CommandSource.Automatic) {
+        super(source, `${sensor.customName} ${sensor.movementDetected ? 'detected' : 'cleared'} motion`);
         /** @inheritDoc */
         this.type = enums_1.CommandType.MotionSensorAction;
         this.motionDetected = sensor.movementDetected;

package/lib/api/api-service.d.ts

@@ -156,6 +156,7 @@ export declare class API {
      * @returns In case it failed the Error containing the reason
      */
     static setRoomSettings(roomName: string, settings: Partial<DeviceSettings>): Error | null;
+    static cameraInformPersonDetected(deviceId: string): Error | void;
     static getLastCameraImage(deviceId: string): Error | string;
     static persistAllDeviceSettings(): void;
     static loadAllDeviceSettingsFromDb(): void;

package/lib/api/api-service.js

@@ -370,6 +370,16 @@ class API {
         r.settings.settingsContainer.persist(r);
         return null;
     }
+    static cameraInformPersonDetected(deviceId) {
+        const d = this.getDevice(deviceId);
+        if (d === undefined) {
+            return new Error(`Device with ID ${deviceId} not found`);
+        }
+        if (!d.deviceCapabilities.includes(enums_1.DeviceCapability.camera)) {
+            return new Error(`Device with ID ${deviceId} is no camera`);
+        }
+        d.setPersonDetected();
+    }
     // TODO: Missing Comment
     static getLastCameraImage(deviceId) {
         const d = this.getDevice(deviceId);

package/lib/command/baseCommand.js

@@ -23,12 +23,13 @@ class BaseCommand {
     }
     get isAutomaticAction() {
         if (this.overrideCommandSource !== undefined) {
-            return this.overrideCommandSource === enums_1.CommandSource.Automatic;
+            return (this.overrideCommandSource === enums_1.CommandSource.Automatic ||
+                this.overrideCommandSource === enums_1.CommandSource.ApiAutomatic);
         }
         if (typeof this.source === 'object') {
             return this.source.isAutomaticAction;
         }
-        return this.source === enums_1.CommandSource.Automatic;
+        return this.source === enums_1.CommandSource.Automatic || this.source === enums_1.CommandSource.ApiAutomatic;
     }
     get isForceAction() {
         if (this.overrideCommandSource !== undefined) {

package/lib/devices/CameraDevice.d.ts

@@ -1,5 +1,5 @@
 import { iBaseDevice, iCameraDevice, iCameraSettings } from '../interfaces';
-import { LogDebugType, LogLevel } from '../enums';
+import { CommandSource, LogDebugType, LogLevel } from '../enums';
 import { MotionSensorAction } from '../action';
 import { DeviceInfo } from './DeviceInfo';
 import { RoomBaseDevice } from './RoomBaseDevice';
@@ -55,11 +55,13 @@ export declare abstract class CameraDevice extends RoomBaseDevice implements iCa
     /** @inheritDoc */
     blockForDevice(device: iBaseDevice, block: boolean): void;
     /** @inheritDoc */
+    setPersonDetected(): void;
+    /** @inheritDoc */
     persistMotionSensor(): void;
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
     private initializeMovementCounter;
     protected onNewMotionDetectedValue(newValue: boolean): void;
-    protected onNewPersonDetectedValue(newValue: boolean): void;
+    protected onNewPersonDetectedValue(newValue: boolean, source?: CommandSource): void;
     protected onNewImageSnapshot(image: string): void;
     protected onNewDogDetectionValue(newDogDetectionVal: boolean): void;
     protected abstract resetPersonDetectedState(): void;

package/lib/devices/CameraDevice.js

@@ -94,6 +94,10 @@ class CameraDevice extends RoomBaseDevice_1.RoomBaseDevice {
         this.log(enums_1.LogLevel.Debug, `Handle device ${block ? 'block' : 'unblock'}, new blocking amount: ${this._devicesBlockingAlarmMap.size}`);
     }
     /** @inheritDoc */
+    setPersonDetected() {
+        this.onNewPersonDetectedValue(true, enums_1.CommandSource.ApiAutomatic);
+    }
+    /** @inheritDoc */
     persistMotionSensor() {
         var _a;
         (_a = services_1.Persistence.dbo) === null || _a === void 0 ? void 0 : _a.persistMotionSensor(this);
@@ -133,7 +137,7 @@ class CameraDevice extends RoomBaseDevice_1.RoomBaseDevice {
             this.resetMovementFallbackTimer();
         }
     }
-    onNewPersonDetectedValue(newValue) {
+    onNewPersonDetectedValue(newValue, source = enums_1.CommandSource.Automatic) {
         this.log(enums_1.LogLevel.Debug, `Update for PersonDetected to value: ${newValue}`);
         if (newValue) {
             this.log(enums_1.LogLevel.Info, 'Person Detected');
@@ -141,7 +145,7 @@ class CameraDevice extends RoomBaseDevice_1.RoomBaseDevice {
         }
         this._personDetected = newValue;
         if (this.settings.movementDetectionOnPersonOnly) {
-            this.updateMovement(newValue);
+            this.updateMovement(newValue, source);
         }
     }
     onNewImageSnapshot(image) {
@@ -163,11 +167,11 @@ class CameraDevice extends RoomBaseDevice_1.RoomBaseDevice {
             this.updateMovement(newDogDetectionVal);
         }
     }
-    updateMovement(newState) {
+    updateMovement(newState, source = enums_1.CommandSource.Automatic) {
         if (!this._initialized && newState) {
             this.log(enums_1.LogLevel.Trace, 'Movement recognized, but database initialization has not finished yet --> delay.');
             utils_1.Utils.guardedTimeout(() => {
-                this.updateMovement(newState);
+                this.updateMovement(newState, source);
             }, 1000, this);
             return;
         }
@@ -184,7 +188,7 @@ class CameraDevice extends RoomBaseDevice_1.RoomBaseDevice {
             this.log(enums_1.LogLevel.Trace, `This is movement no. ${this.detectionsToday}`);
         }
         for (const c of this._movementDetectedCallback) {
-            c(new action_1.MotionSensorAction(this));
+            c(new action_1.MotionSensorAction(this, source));
         }
     }
     resetPersonDetectFallbackTimer() {

package/lib/enums/commandSource.d.ts

@@ -11,17 +11,22 @@ export declare enum CommandSource {
      * This should mark all commands that are executed as an automatic response to a certain action/change.
      */
     Automatic = 2,
+    /**
+     * This should mark all commands/sources which resulted of an automatic api call, e.g an external service webhook.
+     * @type {CommandSource.ApiAutomatic}
+     */
+    ApiAutomatic = 3,
     /**
      * This should mark all commands that are executed by a user thus having a higher priority than other automatic commands.
      */
-    Manual = 3,
+    Manual = 4,
     /**
      * This should mark all commands that are executed by an API call.
      * !WARNING! API could be an automatic call, but also a manual call e.g. using hoffmation-ios or homebridge-hoffmation --> So this is a higher priority than Automatic but still lower than manual/force.
      */
-    API = 4,
+    API = 5,
     /**
      * This should mark all commands that have highest priority, thus overruling/ignoring certain controls/safety mechanisms.
      */
-    Force = 5
+    Force = 6
 }

package/lib/enums/commandSource.js

@@ -16,17 +16,22 @@ var CommandSource;
      * This should mark all commands that are executed as an automatic response to a certain action/change.
      */
     CommandSource[CommandSource["Automatic"] = 2] = "Automatic";
+    /**
+     * This should mark all commands/sources which resulted of an automatic api call, e.g an external service webhook.
+     * @type {CommandSource.ApiAutomatic}
+     */
+    CommandSource[CommandSource["ApiAutomatic"] = 3] = "ApiAutomatic";
     /**
      * This should mark all commands that are executed by a user thus having a higher priority than other automatic commands.
      */
-    CommandSource[CommandSource["Manual"] = 3] = "Manual";
+    CommandSource[CommandSource["Manual"] = 4] = "Manual";
     /**
      * This should mark all commands that are executed by an API call.
      * !WARNING! API could be an automatic call, but also a manual call e.g. using hoffmation-ios or homebridge-hoffmation --> So this is a higher priority than Automatic but still lower than manual/force.
      */
-    CommandSource[CommandSource["API"] = 4] = "API";
+    CommandSource[CommandSource["API"] = 5] = "API";
     /**
      * This should mark all commands that have highest priority, thus overruling/ignoring certain controls/safety mechanisms.
      */
-    CommandSource[CommandSource["Force"] = 5] = "Force";
+    CommandSource[CommandSource["Force"] = 6] = "Force";
 })(CommandSource || (exports.CommandSource = CommandSource = {}));

package/lib/interfaces/baseDevices/iCameraDevice.d.ts

@@ -47,4 +47,8 @@ export interface iCameraDevice extends iMotionSensor {
      * @param block - Whether to block the alarm for the device or lift the block
      */
     blockForDevice(device: iBaseDevice, block: boolean): void;
+    /**
+     * Externally trigger/set Person detected
+     */
+    setPersonDetected(): void;
 }