hoffmation-base 3.6.0 → 3.7.0

package/lib/services/blockAutomaticHandler.d.ts

@@ -9,11 +9,22 @@ export declare class BlockAutomaticHandler implements iBlockAutomaticHandler {
     private readonly _logger;
     private readonly _restoreAutomatic;
     private _automaticBlockedUntil;
+    private _blockSetByUser;
     private _restoreAutomaticStateTimeout;
     constructor(restoreAutomaticCb: (c: RestoreTargetAutomaticValueCommand) => void, _logger: (level: LogLevel, message: string, logDebugType?: LogDebugType) => void);
     get automaticBlockedUntil(): Date;
     private set automaticBlockedUntil(value);
     get automaticBlockActive(): boolean;
+    /**
+     * Whether the active block was set by a person rather than by another rule.
+     *
+     * The expiry date alone cannot answer that, and a rule that has to decide whether it may overrule
+     * the current state needs to: at the end of the day the user's choice outranks a configured
+     * automatism. Manual, API and Force all count - they are the same decision reaching the house
+     * through different doors.
+     * @returns True while a block set by a person is still running.
+     */
+    get automaticBlockedByUser(): boolean;
     disableAutomatic(c: BlockAutomaticCommand): void;
     disableAutomaticUntil(c: BlockAutomaticUntilCommand): void;
     liftAutomaticBlock(c: BlockAutomaticLiftBlockCommand): void;

package/lib/services/blockAutomaticHandler.js

@@ -16,6 +16,7 @@ class BlockAutomaticHandler {
     constructor(restoreAutomaticCb, _logger) {
         this._logger = _logger;
         this._automaticBlockedUntil = new Date(0);
+        this._blockSetByUser = false;
         this._restoreAutomaticStateTimeout = null;
         this._restoreAutomatic = restoreAutomaticCb;
     }
@@ -28,6 +29,18 @@ class BlockAutomaticHandler {
     get automaticBlockActive() {
         return this._automaticBlockedUntil > new Date();
     }
+    /**
+     * Whether the active block was set by a person rather than by another rule.
+     *
+     * The expiry date alone cannot answer that, and a rule that has to decide whether it may overrule
+     * the current state needs to: at the end of the day the user's choice outranks a configured
+     * automatism. Manual, API and Force all count - they are the same decision reaching the house
+     * through different doors.
+     * @returns True while a block set by a person is still running.
+     */
+    get automaticBlockedByUser() {
+        return this.automaticBlockActive && this._blockSetByUser;
+    }
     disableAutomatic(c) {
         this.disableAutomaticUntil(new command_1.BlockAutomaticUntilCommand(c, new Date(utils_1.Utils.nowMS() + c.durationMS), '', c.onCollideAction, c.revertToAutomaticAtBlockLift));
     }
@@ -41,6 +54,9 @@ class BlockAutomaticHandler {
         }
         this._logger(enums_1.LogLevel.Info, c.logMessage);
         this.automaticBlockedUntil = c.targetDate;
+        // Recorded here rather than derived later: the command is gone once this returns, and the level
+        // that pinned the device is exactly what a rule needs to know before overruling it.
+        this._blockSetByUser = c.isForceAction;
         if (c.revertToAutomaticAtBlockLift) {
             const revertCommand = new command_1.RestoreTargetAutomaticValueCommand(c, 'Restore to automatic state after block.');
             revertCommand.overrideCommandSource = enums_1.CommandSource.Automatic;
@@ -53,6 +69,7 @@ class BlockAutomaticHandler {
     liftAutomaticBlock(c) {
         this.removeRestoreTimeout();
         this.automaticBlockedUntil = new Date(0);
+        this._blockSetByUser = false;
         if (c.revertToAutomatic) {
             this._restoreAutomatic(new command_1.RestoreTargetAutomaticValueCommand(c));
         }

package/lib/services/dbo/postgreSqlPersist.d.ts

@@ -1,5 +1,5 @@
 import { PoolConfig } from 'pg';
-import { iAcDevice, iActuator, iBaseDevice, iBatteryDevice, iButtonSwitch, iDesiredShutterPosition, iHandle, iHeater, iHumidityCollector, iIlluminationSensor, iMotionSensor, iPersist, iRoomBase, iShutter, iShutterCalibration, iTemperatureCollector, iTemperatureMeasurement, iZigbeeDevice } from '../../interfaces';
+import { iAcDevice, iActuator, iBaseDevice, iBatteryDevice, iButtonSwitch, iDesiredShutterPosition, iHandle, iHeater, iAirQualityCollector, iHumidityCollector, iIlluminationSensor, iMotionSensor, iPersist, iRoomBase, iShutter, iShutterCalibration, iTemperatureCollector, iTemperatureMeasurement, iZigbeeDevice } from '../../interfaces';
 import { CountToday, EnergyCalculation } from '../../models';
 import { ButtonPressType } from '../../enums';
 export declare class PostgreSqlPersist implements iPersist {
@@ -42,6 +42,8 @@ export declare class PostgreSqlPersist implements iPersist {
     /** @inheritDoc */
     persistHumiditySensor(device: iHumidityCollector): void;
     /** @inheritDoc */
+    persistAirQualitySensor(device: iAirQualityCollector): void;
+    /** @inheritDoc */
     persistBatteryDevice(device: iBatteryDevice): void;
     /** @inheritDoc */
     persistZigbeeDevice(device: iZigbeeDevice): void;

package/lib/services/dbo/postgreSqlPersist.js

@@ -292,7 +292,31 @@ BEGIN
         constraint humiditysensordevicedata_pk
             primary key ("deviceID", date)
     );
-    
+
+  END IF;
+
+  IF (SELECT to_regclass('hoffmation_schema."AirQualitySensorDeviceData"') IS NULL) Then
+    create table if not exists hoffmation_schema."AirQualitySensorDeviceData"
+    (
+        "deviceID"        varchar(60) not null
+            constraint "AirQualitySensorDeviceData_DeviceInfo_null_fk"
+                references hoffmation_schema."DeviceInfo"
+                on delete set null,
+        aqi               double precision,
+        co2               double precision,
+        nox               double precision,
+        "pm1p0"           double precision,
+        "pm2p5"           double precision,
+        "pm4p0"           double precision,
+        "pm10p0"          double precision,
+        tvoc              double precision,
+        vape              double precision,
+        voc               double precision,
+        date              timestamp   not null,
+        constraint airqualitysensordevicedata_pk
+            primary key ("deviceID", date)
+    );
+
   END IF;
 
   IF (SELECT to_regclass('hoffmation_schema."BatteryDeviceData"') IS NULL) Then  
@@ -478,6 +502,15 @@ $$;`);
     `);
     }
     /** @inheritDoc */
+    persistAirQualitySensor(device) {
+        const readings = device.airQuality;
+        const value = (metric) => (metric === interfaces_1.UNDEFINED_AIR_QUALITY_VALUE ? 'null' : `${metric}`);
+        this.query(`
+      insert into hoffmation_schema."AirQualitySensorDeviceData" ("deviceID", "aqi", "co2", "nox", "pm1p0", "pm2p5", "pm4p0", "pm10p0", "tvoc", "vape", "voc", "date")
+      values ('${device.id}', ${value(readings.aqi)}, ${value(readings.co2)}, ${value(readings.nox)}, ${value(readings.pm1p0)}, ${value(readings.pm2p5)}, ${value(readings.pm4p0)}, ${value(readings.pm10p0)}, ${value(readings.tvoc)}, ${value(readings.vape)}, ${value(readings.voc)}, '${new Date().toISOString()}');
+    `);
+    }
+    /** @inheritDoc */
     persistBatteryDevice(device) {
         this.query(`
       insert into hoffmation_schema."BatteryDeviceData" ("deviceID", "battery", "date")