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

package/lib/server/services/utils/utils.d.ts

@@ -1,14 +1,16 @@
-/// <reference types="node" />
 import { iPersist } from '../dbo';
+import { CatchEmResult } from './catchEmResult';
+import { iTimePair } from '../../config';
+import { RGB } from './RGB';
 export declare const DAYMS: number;
 export declare class Utils {
+    /**
+     * The persitence layer object
+     */
     static dbo: iPersist | undefined;
     static get anyDboActive(): boolean;
     static get timeTilMidnight(): number;
-    static catchEm<T>(promise: Promise<T>): Promise<{
-        reason: Error | null;
-        data: T | null;
-    }>;
+    static catchEm<T>(promise: Promise<T>): Promise<CatchEmResult<T>>;
     static guardedFunction(func: (...args: unknown[]) => void, thisContext: unknown | undefined): void;
     static nowMS(): number;
     static delay(ms: number): Promise<void>;
@@ -23,10 +25,7 @@ export declare class Utils {
     static round(number: number, digits: number): number;
     static roundDot5(number: number): number;
     static beetweenDays(date: Date, startDay: number, endDay: number): boolean;
-    static nowTime(): {
-        hours: number;
-        minutes: number;
-    };
+    static nowTime(): iTimePair;
     static dateByTimeSpan(hours: number, minutes: number, now?: Date): Date;
     static positiveMod(number: number, mod: number): number;
     static degreeInBetween(minDegree: number, maxDegree: number, degreeToCheck: number): boolean;
@@ -34,9 +33,5 @@ export declare class Utils {
     static nextMatchingDate(hours?: number, minutes?: number, now?: Date): Date;
     static timeWithinBorders(minimumHours: number, minimumMinutes: number, maxHours: number, maxMinutes: number, now?: Date): boolean;
     static formatHex(hex: string): string | null;
-    static hexToRgb(color: string): {
-        r: number;
-        g: number;
-        b: number;
-    } | null;
+    static hexToRgb(color: string): RGB | null;
 }

package/lib/server/services/utils/utils.js

@@ -85,9 +85,11 @@ class Utils {
             'interval',
             'timeouts',
             'callback',
+            'callbacks',
             'otaInfo',
             'precalculatedDistancesMap',
             'stateMap',
+            'jsonOmitKeys',
         ];
         keysToOmit.push(...additionalOmitKeys);
         const loweredOmitKeys = keysToOmit.map((key) => key.toLowerCase());
@@ -175,9 +177,11 @@ class Utils {
         return modMin < modMax ? modToCheck <= modMax && modToCheck >= modMin : modToCheck > modMin || modToCheck < modMax;
     }
     static deepOmit(obj, keysToOmit, topLevelOmitKeys, level = 1, currentKey = '') {
+        var _a;
         if (level > 10 && level < 20) {
             log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `DeepOmit Loop Level ${level} reached for ${currentKey}`);
         }
+        const combinedOmmitKeys = [...keysToOmit, ...((_a = obj === null || obj === void 0 ? void 0 : obj.jsonOmitKeys) !== null && _a !== void 0 ? _a : [])];
         // the inner function which will be called recursivley
         return lodash_1.default.transform(obj, (result, value, key) => {
             if (value === undefined || value === null) {
@@ -185,7 +189,7 @@ class Utils {
             }
             if (typeof key == 'string') {
                 const lowerKey = key.toLowerCase();
-                for (const checkKey of keysToOmit) {
+                for (const checkKey of combinedOmmitKeys) {
                     // if the key is in the index skip it
                     if (lowerKey.includes(checkKey)) {
                         return;

package/lib/server/services/victron/victron-device.d.ts

@@ -1,13 +1,20 @@
-import { DeviceInfo, DeviceType, iEnergyManager, iExcessEnergyConsumer } from '../../devices';
-import { LogLevel, VictronDeviceSettings } from '../../../models';
-import { DeviceCapability } from '../../devices/DeviceCapability';
+import { Battery, DeviceCapability, DeviceInfo, DeviceType, iBatteryDevice, iEnergyManager, iExcessEnergyConsumer } from '../../devices';
+import { iJsonOmitKeys, LogLevel, VictronDeviceSettings } from '../../../models';
 import { LogDebugType } from '../log-service';
 import { VictronDeviceData, VictronMqttConnectionOptions, VictronMqttConsumer } from 'victron-mqtt-consumer';
-export declare class VictronDevice implements iEnergyManager {
-    private readonly _victronConsumer;
+export declare class VictronDevice implements iEnergyManager, iBatteryDevice, iJsonOmitKeys {
+    /** @inheritDoc */
+    readonly jsonOmitKeys: string[];
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
     deviceType: DeviceType;
+    /** @inheritDoc */
     readonly settings: VictronDeviceSettings;
+    /** @inheritDoc */
+    readonly battery: Battery;
+    protected _info: DeviceInfo;
+    private readonly _victronConsumer;
     private _excessEnergyConsumer;
     private blockDeviceChangeTime;
     private _lastDeviceChange;
@@ -15,21 +22,25 @@ export declare class VictronDevice implements iEnergyManager {
     private _iDatabaseLoggerInterval;
     private _lastPersistenceCalculation;
     private _nextPersistEntry;
+    private _excessEnergy;
     constructor(opts: VictronMqttConnectionOptions);
-    protected _info: DeviceInfo;
+    /** @inheritDoc */
+    get acBlocked(): boolean;
     get info(): DeviceInfo;
+    /** @inheritDoc */
+    get batteryLevel(): number;
     get victronConsumer(): VictronMqttConsumer;
     get data(): VictronDeviceData;
-    private _excessEnergy;
     get excessEnergy(): number;
     get name(): string;
     get customName(): string;
     get id(): string;
-    addExcessConsumer(device: iExcessEnergyConsumer): void;
     get injectingWattage(): number;
     get drawingWattage(): number;
     get selfConsumingWattage(): number;
-    cleanup(): void;
+    addExcessConsumer(device: iExcessEnergyConsumer): void;
+    /** @inheritDoc */
+    dispose(): void;
     getReport(): string;
     recalculatePowerSharing(): void;
     loadDeviceSettings(): void;
@@ -38,7 +49,7 @@ export declare class VictronDevice implements iEnergyManager {
     toJSON(): Partial<VictronDevice>;
     /**
      * Changes the grid set point of the Victron device, to the desired value.
-     * @param {number} setPoint
+     * @param setPoint - The desired watt point the system should aim for.
      */
     setGridSetPoint(setPoint: number): void;
     private calculateExcessEnergy;

package/lib/server/services/victron/victron-device.js

@@ -4,14 +4,22 @@ exports.VictronDevice = void 0;
 const devices_1 = require("../../devices");
 const utils_1 = require("../utils");
 const models_1 = require("../../../models");
-const DeviceCapability_1 = require("../../devices/DeviceCapability");
 const log_service_1 = require("../log-service");
 const victron_mqtt_consumer_1 = require("victron-mqtt-consumer");
 const time_callback_service_1 = require("../time-callback-service");
 class VictronDevice {
     constructor(opts) {
-        this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.energyManager];
+        /** @inheritDoc */
+        this.jsonOmitKeys = ['_victronConsumer', '_excessEnergyConsumer'];
+        /** @inheritDoc */
+        this.deviceCapabilities = [
+            devices_1.DeviceCapability.energyManager,
+            devices_1.DeviceCapability.batteryDriven,
+        ];
+        /** @inheritDoc */
         this.deviceType = devices_1.DeviceType.Victron;
+        /** @inheritDoc */
+        this.battery = new devices_1.Battery(this);
         this._excessEnergyConsumer = [];
         this.blockDeviceChangeTime = -1;
         this._iCalculationInterval = null;
@@ -20,15 +28,18 @@ class VictronDevice {
         this._excessEnergy = 0;
         this.settings = new models_1.VictronDeviceSettings();
         this._info = new devices_1.DeviceInfo();
-        this._info.fullName = `Victron Device`;
-        this._info.customName = `Victron`;
-        this._info.allDevicesKey = `victron`;
-        devices_1.Devices.alLDevices[`victron`] = this;
+        this._info.fullName = 'Victron Device';
+        this._info.customName = 'Victron';
+        this._info.allDevicesKey = 'victron';
+        devices_1.Devices.alLDevices['victron'] = this;
         devices_1.Devices.energymanager = this;
         this.persistDeviceInfo();
         this.loadDeviceSettings();
         this._victronConsumer = new victron_mqtt_consumer_1.VictronMqttConsumer(opts);
         this._iCalculationInterval = utils_1.Utils.guardedInterval(() => {
+            if (this.data.battery.soc) {
+                this.battery.level = this.data.battery.soc;
+            }
             this.calculateExcessEnergy();
         }, 5 * 1000, this);
         this._iDatabaseLoggerInterval = utils_1.Utils.guardedInterval(() => {
@@ -36,9 +47,32 @@ class VictronDevice {
         }, 15 * 60 * 1000, this);
         this._nextPersistEntry = new models_1.EnergyCalculation(utils_1.Utils.nowMS());
     }
+    /** @inheritDoc */
+    get acBlocked() {
+        if (this.settings.hasBattery) {
+            const hours = new Date().getHours();
+            if (hours < 6 || hours > 18) {
+                return this.batteryLevel < this.settings.minimumNightTimeAcBatteryLevel;
+            }
+            if (hours < 10 || hours > 16) {
+                return this.batteryLevel < this.settings.minimumTransientTimeAcBatteryLevel;
+            }
+            return this.batteryLevel < this.settings.minimumDayTimeAcBatteryLevel;
+        }
+        return false;
+    }
     get info() {
         return this._info;
     }
+    /** @inheritDoc */
+    get batteryLevel() {
+        const level = this.data.battery.soc;
+        if (level == null) {
+            this.log(models_1.LogLevel.Debug, 'No battery data available from Victron device.');
+            return -1;
+        }
+        return level;
+    }
     get victronConsumer() {
         return this._victronConsumer;
     }
@@ -58,9 +92,6 @@ class VictronDevice {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `victron-${this.info.room}-${this.info.customName}`;
     }
-    addExcessConsumer(device) {
-        this._excessEnergyConsumer.push(device);
-    }
     get injectingWattage() {
         var _a;
         return Math.min((_a = this.victronConsumer.data.grid.power) !== null && _a !== void 0 ? _a : 0, 0) * -1;
@@ -73,7 +104,11 @@ class VictronDevice {
         var _a;
         return Math.max((_a = this.victronConsumer.data.system.power) !== null && _a !== void 0 ? _a : 0, 0) - this.drawingWattage;
     }
-    cleanup() {
+    addExcessConsumer(device) {
+        this._excessEnergyConsumer.push(device);
+    }
+    /** @inheritDoc */
+    dispose() {
         this._victronConsumer.disconnect();
         if (this._iDatabaseLoggerInterval !== null) {
             clearInterval(this._iDatabaseLoggerInterval);
@@ -118,11 +153,21 @@ class VictronDevice {
         }, 5000, this);
     }
     toJSON() {
-        return utils_1.Utils.jsonFilter(this, ['_victronConsumer']);
+        return {
+            ...{
+                batteryLevel: this.batteryLevel,
+                acBlocked: this.acBlocked,
+                excessEnergy: this.excessEnergy,
+                drawingWattage: this.drawingWattage,
+                injectingWattage: this.injectingWattage,
+                selfConsumingWattage: this.selfConsumingWattage,
+            },
+            ...utils_1.Utils.jsonFilter(this, this.jsonOmitKeys),
+        };
     }
     /**
      * Changes the grid set point of the Victron device, to the desired value.
-     * @param {number} setPoint
+     * @param setPoint - The desired watt point the system should aim for.
      */
     setGridSetPoint(setPoint) {
         this._victronConsumer.setGridSetPoint(setPoint);
@@ -131,7 +176,7 @@ class VictronDevice {
         var _a;
         this._excessEnergy = 0;
         if (this.data == undefined) {
-            this.log(models_1.LogLevel.Debug, `No data available from Victron device.`);
+            this.log(models_1.LogLevel.Debug, 'No data available from Victron device.');
             return;
         }
         // Step 1: Calculate battery need
@@ -139,11 +184,11 @@ class VictronDevice {
         let neededBatteryWattage = 0;
         const timeOfDay = time_callback_service_1.TimeCallbackService.dayType(new time_callback_service_1.SunTimeOffsets());
         if (this.settings.hasBattery && timeOfDay !== models_1.TimeOfDay.AfterSunset && timeOfDay !== models_1.TimeOfDay.Night) {
-            if (this.data.battery.soc == null) {
-                this.log(models_1.LogLevel.Debug, `No battery data available from Victron device.`);
+            if (this.batteryLevel < 0) {
+                this.log(models_1.LogLevel.Debug, 'No battery data available from Victron device.');
                 return;
             }
-            neededBatteryWattage = ((1 - this.data.battery.soc) * this.settings.batteryCapacityWattage) / hoursTilSunset;
+            neededBatteryWattage = ((1 - this.batteryLevel / 100.0) * this.settings.batteryCapacityWattage) / hoursTilSunset;
             // Step 2: Calculate expected solar output
             const solarOutput = (_a = this.data.pvInverter.power) !== null && _a !== void 0 ? _a : 0;
             // Step 3: Calculate expected base consumption
@@ -152,22 +197,22 @@ class VictronDevice {
             this._excessEnergy = solarOutput - neededBatteryWattage - baseConsumption;
         }
         let isSocTooLow = false;
-        if (this.data.battery.dcPower !== null && this.data.battery.soc !== null) {
+        if (this.data.battery.dcPower !== null && this.batteryLevel > -1) {
             if (timeOfDay === models_1.TimeOfDay.Night) {
-                isSocTooLow = this.data.battery.soc < 0.5;
+                isSocTooLow = this.batteryLevel < 50;
             }
             else if (timeOfDay === models_1.TimeOfDay.AfterSunset) {
-                isSocTooLow = this.data.battery.soc < 0.75;
+                isSocTooLow = this.batteryLevel < 75;
             }
             else if (hoursTilSunset > 4) {
-                isSocTooLow = this.data.battery.soc < 0.7;
+                isSocTooLow = this.batteryLevel < 70;
             }
             else {
-                isSocTooLow = this.data.battery.soc < 0.8;
+                isSocTooLow = this.batteryLevel < 80;
             }
         }
         // Whilst calculated spare energy is more precise, we don't mind using the battery as a buffer, if it is full enough.
-        if (this.data.battery.dcPower !== null && this.data.battery.soc !== null && !isSocTooLow) {
+        if (this.data.battery.dcPower !== null && this.batteryLevel > -1 && !isSocTooLow) {
             this._excessEnergy = this.settings.maximumBatteryDischargeWattage - Math.max(this.data.battery.dcPower, 0);
         }
         this.calculatePersistenceValues();
@@ -193,14 +238,13 @@ class VictronDevice {
         }
         if (!result.newState) {
             this.blockDeviceChangeTime = utils_1.Utils.nowMS() + result.device.energySettings.powerReactionTime;
-            result.device.log(models_1.LogLevel.Info, `Turning off, as we don't have energy to spare...`);
+            result.device.log(models_1.LogLevel.Info, "Turning off, as we don't have energy to spare...");
             result.device.turnOffDueToMissingEnergy();
             this._lastDeviceChange = result;
         }
     }
     persist() {
-        var _a;
-        this._nextPersistEntry.batteryLevel = ((_a = this.data.battery.soc) !== null && _a !== void 0 ? _a : 0) / 100;
+        this._nextPersistEntry.batteryLevel = this.batteryLevel / 100;
         this._nextPersistEntry.batteryStoredKwH =
             (this._nextPersistEntry.batteryLevel * this.settings.batteryCapacityWattage) / 1000;
         const obj = JSON.parse(JSON.stringify(this._nextPersistEntry));

package/lib/server/services/weather/index.d.ts

@@ -7,3 +7,5 @@ export * from './weather-item';
 export * from './weather-minutes';
 export * from './weather-service';
 export * from './weather-temp';
+export { WeatherResponse } from './weather-response';
+export { RainNextMinutesInfo } from './rain-next-minutes-info';

package/lib/server/services/weather/index.js

@@ -14,6 +14,7 @@ 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.RainNextMinutesInfo = void 0;
 __exportStar(require("./weather-alert"), exports);
 __exportStar(require("./weather-current"), exports);
 __exportStar(require("./weather-daily"), exports);
@@ -23,3 +24,5 @@ __exportStar(require("./weather-item"), exports);
 __exportStar(require("./weather-minutes"), exports);
 __exportStar(require("./weather-service"), exports);
 __exportStar(require("./weather-temp"), exports);
+var rain_next_minutes_info_1 = require("./rain-next-minutes-info");
+Object.defineProperty(exports, "RainNextMinutesInfo", { enumerable: true, get: function () { return rain_next_minutes_info_1.RainNextMinutesInfo; } });

package/lib/server/services/weather/rain-next-minutes-info.d.ts

@@ -0,0 +1,5 @@
+export declare class RainNextMinutesInfo {
+    minutes: number;
+    precipitation: number;
+    constructor(minutes: number, precipitation: number);
+}

package/lib/server/services/weather/rain-next-minutes-info.js

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

package/lib/server/services/weather/weather-current.d.ts

@@ -2,8 +2,6 @@ import { WeatherItem } from './weather-item';
 export interface WeatherCurrent {
     /**
      * Zeit der Anfrage
-     * @type {number}
-     * @memberof WeatherCurrent
      */
     dt: number;
     sunrise: number;

package/lib/server/services/weather/weather-feelsLike.d.ts

@@ -1,6 +1,21 @@
+/**
+ * Temperature data how its recognized by a human for the different times of the day.
+ */
 export interface WeatherFeelsLike {
+    /**
+     * Day temperature in Celsius
+     */
     day: number;
+    /**
+     * Night temperature in Celsius
+     */
     night: number;
+    /**
+     * Evening temperature in Celsius
+     */
     eve: number;
+    /**
+     * Morning temperature in Celsius
+     */
     morn: number;
 }

package/lib/server/services/weather/weather-response.d.ts

@@ -0,0 +1,16 @@
+import { WeatherCurrent } from './weather-current';
+import { WeatherMinutes } from './weather-minutes';
+import { WeatherHourly } from './weather-hourly';
+import { WeatherDaily } from './weather-daily';
+import { WeatherAlert } from './weather-alert';
+export interface WeatherResponse {
+    lat: number;
+    lon: number;
+    timezone: string;
+    timezone_offset: number;
+    current: WeatherCurrent;
+    minutely: WeatherMinutes[];
+    hourly: WeatherHourly[];
+    daily: WeatherDaily[];
+    alerts?: WeatherAlert[];
+}

package/lib/server/services/weather/weather-response.js

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

package/lib/server/services/weather/weather-service.d.ts

@@ -1,30 +1,23 @@
-import { WeatherHourly } from './weather-hourly';
-import { WeatherCurrent } from './weather-current';
-import { WeatherMinutes } from './weather-minutes';
-import { WeatherAlert } from './weather-alert';
 import { iWeatherSettings } from '../../config';
 import { LogLevel, ShutterSettings } from '../../../models';
 import { LogDebugType } from '../log-service';
-import { WeatherDaily } from './weather-daily';
 import { iSpeaker } from '../../devices';
-export interface WeatherResponse {
-    lat: number;
-    lon: number;
-    timezone: string;
-    timezone_offset: number;
-    current: WeatherCurrent;
-    minutely: WeatherMinutes[];
-    hourly: WeatherHourly[];
-    daily: WeatherDaily[];
-    alerts?: WeatherAlert[];
-}
+import { WeatherResponse } from './weather-response';
 export declare class WeatherService {
+    /**
+     * Whether the service is active or not
+     */
     static active: boolean;
-    static oneDay: number;
+    /**
+     * The milliseconds of one day
+     */
+    static readonly oneDay: number;
+    /**
+     * The last weather response
+     */
     static lastResponse: WeatherResponse;
     /**
      * The sun horizontal degree (0 is North)
-     * @type {number}
      */
     static sunDirection: number;
     private static _dataUpdateCbs;
@@ -33,6 +26,7 @@ export declare class WeatherService {
     private static longitude;
     private static appID?;
     static addWeatherUpdateCb(name: string, cb: () => void): void;
+    static get todayMaxTemp(): number;
     static initialize(config: iWeatherSettings): void;
     static update(): void;
     static stopInterval(): void;
@@ -46,5 +40,9 @@ export declare class WeatherService {
     private static getActiveAlerts;
     private static getWeatherData;
     private static recalcAzimuth;
+    /**
+     * Method to calculate the hours until sunset based on the current location
+     * @returns - The hours until sunset
+     */
     private static hoursTilSunset;
 }