hoffmation-base 3.0.0-alpha.23 → 3.0.0-alpha.24

package/lib/server/services/room-service/room-service.js

@@ -61,7 +61,7 @@ class RoomService {
         this._awayModeTimeout = utils_1.Utils.guardedTimeout(() => {
             this.awayModeActive = true;
             this._awayModeTimeout = undefined;
-            Telegram_1.TelegramService.inform(`Alarm ist nun scharf. Gute Reise!`);
+            Telegram_1.TelegramService.inform('Alarm ist nun scharf. Gute Reise!');
         }, 60000, this);
     }
     static startNightAlarmMode() {
@@ -72,7 +72,7 @@ class RoomService {
         this._nightModeTimeout = utils_1.Utils.guardedTimeout(() => {
             this.nightAlarmActive = true;
             this._nightModeTimeout = undefined;
-            Telegram_1.TelegramService.inform(`Alarm ist nun scharf. Süße Träume!`);
+            Telegram_1.TelegramService.inform('Alarm ist nun scharf. Süße Träume!');
         }, 60000, this);
     }
     static startIntrusionAlarm(room, device) {
@@ -93,11 +93,11 @@ class RoomService {
     }
     static endAlarmModes() {
         if (this.awayModeActive) {
-            Telegram_1.TelegramService.sendMessage(Telegram_1.TelegramService.subscribedIDs, `Alarm Mode disarmed`);
+            Telegram_1.TelegramService.sendMessageToSubscriber('Alarm Mode disarmed');
             Sonos_1.SonosService.speakOnAll(Translation_1.Res.welcomeHome(), 35);
         }
         if (this.nightAlarmActive) {
-            Telegram_1.TelegramService.sendMessage(Telegram_1.TelegramService.subscribedIDs, `Nachtmodus der Alarmanlage entschärft`);
+            Telegram_1.TelegramService.sendMessageToSubscriber('Nachtmodus der Alarmanlage entschärft');
             Sonos_1.SonosService.speakOnAll(Translation_1.Res.goodMorning(), 30);
         }
         if (this._nightModeTimeout) {
@@ -114,7 +114,7 @@ class RoomService {
         return this.movementHistory.readAmount(15).join('\n');
     }
     static stopIntrusionAlarm() {
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Stoppe Intrusion Alarm`);
+        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'Stoppe Intrusion Alarm');
         if (this._intrusionAlarmTimeout) {
             clearTimeout(this._intrusionAlarmTimeout);
         }
@@ -123,7 +123,7 @@ class RoomService {
         }
         this._intrusionAlarmActive = false;
         this._intrusionAlarmLevel = 0;
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `Alarm wurde beendet --> Fahre Rollos in Ausgangsposition.`);
+        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, 'Alarm wurde beendet --> Fahre Rollos in Ausgangsposition.');
         this.restoreShutterPositions(new models_1.RoomRestoreShutterPositionCommand(models_1.CommandSource.Force, false, 'Resetting all shutter in all Rooms to last known position'));
         this.restoreLight(new models_1.RoomRestoreLightCommand(models_1.CommandSource.Force, 'roomService.clearAllAlarms'));
     }
@@ -176,7 +176,7 @@ class RoomService {
     static restoreShutterPositions(c) {
         var _a;
         for (const room of this.Rooms.values()) {
-            (_a = room.WindowGroup) === null || _a === void 0 ? void 0 : _a.restoreRolloPosition(c);
+            (_a = room.WindowGroup) === null || _a === void 0 ? void 0 : _a.restoreShutterPosition(c);
         }
     }
     static restoreLight(c) {
@@ -186,10 +186,25 @@ class RoomService {
     }
 }
 exports.RoomService = RoomService;
+/**
+ * A Map containing all rooms in the house identified by their name
+ */
 RoomService.Rooms = new Map();
+/**
+ * A Map containing all groups in the house identified by {@link BaseGroup.id}
+ */
 RoomService.Groups = new Map();
+/**
+ * A boolean indicating if the away mode is active, which triggers certain alarms on movement
+ */
 RoomService.awayModeActive = false;
+/**
+ * A boolean indicating if the night mode is active, which triggers certain alarms on movement in rooms included in night alarm
+ */
 RoomService.nightAlarmActive = false;
-RoomService.movementHistory = new utils_1.ringStorage(15);
+/**
+ * A ring storage containing the last 15 detected movements in the house
+ */
+RoomService.movementHistory = new utils_1.RingStorage(15);
 RoomService._intrusionAlarmActive = false;
 RoomService._intrusionAlarmLevel = 0;

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

@@ -1,5 +1,8 @@
 import { HeatingMode, iConfig } from '../config';
 export declare class SettingsService {
+    /**
+     * The active settings for the Hoffmation system.
+     */
     static settings: iConfig;
     static get TelegramActive(): boolean;
     static get Mp3Active(): boolean;

package/lib/server/services/time-callback-service.js

@@ -127,7 +127,7 @@ class TimeCallbackService {
         TimeCallbackService._callbacks.set(pCallback.name, pCallback);
     }
     static performCheck() {
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Trace, `Perform TimeCallBackCheck`);
+        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Trace, 'Perform TimeCallBackCheck');
         const now = new Date();
         for (const tc of TimeCallbackService._callbacks.values()) {
             if (tc.nextToDo === undefined || tc.nextToDo < tc.lastDone) {

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

@@ -0,0 +1,6 @@
+export declare class RGB {
+    r: number;
+    g: number;
+    b: number;
+    constructor(r: number, g: number, b: number);
+}

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RGB = void 0;
+class RGB {
+    constructor(r, g, b) {
+        this.r = r;
+        this.g = g;
+        this.b = b;
+    }
+}
+exports.RGB = RGB;

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

@@ -0,0 +1,5 @@
+export declare class CatchEmResult<T> {
+    reason: Error | null;
+    data: T | null;
+    constructor(reason: Error | null, data: T | null);
+}

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

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

package/lib/server/services/utils/energy-consumer-state-change.d.ts

@@ -0,0 +1,6 @@
+import { iExcessEnergyConsumer } from '../../devices';
+export declare class EnergyConsumerStateChange {
+    readonly newState: boolean;
+    readonly device: iExcessEnergyConsumer;
+    constructor(newState: boolean, device: iExcessEnergyConsumer);
+}

package/lib/server/services/utils/energy-consumer-state-change.js

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

package/lib/server/services/utils/energy-manager-utils.d.ts

@@ -1,17 +1,6 @@
 import { iExcessEnergyConsumer } from '../../devices';
+import { EnergyConsumerStateChange } from './energy-consumer-state-change';
 export declare class EnergyManagerUtils {
-    static turnOnAdditionalConsumer(excessEnergyConsumer: iExcessEnergyConsumer[], lastDeviceChange: {
-        newState: boolean;
-        device: iExcessEnergyConsumer;
-    } | undefined): void | undefined | {
-        newState: boolean;
-        device: iExcessEnergyConsumer;
-    };
-    static turnOffAdditionalConsumer(excessEnergyConsumer: iExcessEnergyConsumer[], lastDeviceChange: {
-        newState: boolean;
-        device: iExcessEnergyConsumer;
-    } | undefined): void | undefined | {
-        newState: boolean;
-        device: iExcessEnergyConsumer;
-    };
+    static turnOnAdditionalConsumer(excessEnergyConsumer: iExcessEnergyConsumer[], lastDeviceChange: EnergyConsumerStateChange | undefined): void | undefined | EnergyConsumerStateChange;
+    static turnOffAdditionalConsumer(excessEnergyConsumer: iExcessEnergyConsumer[], lastDeviceChange: EnergyConsumerStateChange | undefined): void | undefined | EnergyConsumerStateChange;
 }

package/lib/server/services/utils/energy-manager-utils.js

@@ -9,7 +9,7 @@ class EnergyManagerUtils {
                 return false;
             }
             if ((lastDeviceChange === null || lastDeviceChange === void 0 ? void 0 : lastDeviceChange.newState) && e === lastDeviceChange.device) {
-                e.log(models_1.LogLevel.Debug, `This woould have been a matching energy consumer, but apperantly last turn on failed...`);
+                e.log(models_1.LogLevel.Debug, 'This woould have been a matching energy consumer, but apperantly last turn on failed...');
                 return false;
             }
             return true;
@@ -35,7 +35,7 @@ class EnergyManagerUtils {
                 return false;
             }
             if ((lastDeviceChange === null || lastDeviceChange === void 0 ? void 0 : lastDeviceChange.newState) === false && e === lastDeviceChange.device) {
-                e.log(models_1.LogLevel.Debug, `This woould have been a matching turn off energy consumer, but apperantly last turn off failed...`);
+                e.log(models_1.LogLevel.Debug, 'This woould have been a matching turn off energy consumer, but apperantly last turn off failed...');
                 return false;
             }
             return true;

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

@@ -1,3 +1,6 @@
+/**
+ * Interface for objects that need to be disposed of (e.g. to free up resources or disable timeouts/intervals)
+ */
 export interface iDisposable {
     /**
      * Dispose of the object --> free up resources, disable timeouts/intervals, etc.

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

@@ -1,4 +1,7 @@
 export * from './energy-manager-utils';
-export * from './ringstorage';
+export * from './ringStorage';
 export * from './utils';
 export * from './iDisposeable';
+export { EnergyConsumerStateChange } from './energy-consumer-state-change';
+export { CatchEmResult } from './catchEmResult';
+export { RGB } from './RGB';

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

@@ -14,7 +14,14 @@ 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.RGB = exports.CatchEmResult = exports.EnergyConsumerStateChange = void 0;
 __exportStar(require("./energy-manager-utils"), exports);
-__exportStar(require("./ringstorage"), exports);
+__exportStar(require("./ringStorage"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./iDisposeable"), exports);
+var energy_consumer_state_change_1 = require("./energy-consumer-state-change");
+Object.defineProperty(exports, "EnergyConsumerStateChange", { enumerable: true, get: function () { return energy_consumer_state_change_1.EnergyConsumerStateChange; } });
+var catchEmResult_1 = require("./catchEmResult");
+Object.defineProperty(exports, "CatchEmResult", { enumerable: true, get: function () { return catchEmResult_1.CatchEmResult; } });
+var RGB_1 = require("./RGB");
+Object.defineProperty(exports, "RGB", { enumerable: true, get: function () { return RGB_1.RGB; } });

package/lib/server/services/utils/{ringstorage.d.ts → ringStorage.d.ts}

@@ -1,4 +1,4 @@
-export declare class ringStorage<T> {
+export declare class RingStorage<T> {
     private maxSize;
     private storage;
     private pointer;

package/lib/server/services/utils/{ringstorage.js → ringStorage.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ringStorage = void 0;
-class ringStorage {
+exports.RingStorage = void 0;
+class RingStorage {
     constructor(maxSize = 10) {
         this.maxSize = maxSize;
         this.storage = [];
@@ -24,4 +24,4 @@ class ringStorage {
         return result;
     }
 }
-exports.ringStorage = ringStorage;
+exports.RingStorage = RingStorage;

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

@@ -1,14 +1,17 @@
 /// <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 +26,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 +34,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/victron/victron-device.d.ts

@@ -5,8 +5,11 @@ import { LogDebugType } from '../log-service';
 import { VictronDeviceData, VictronMqttConnectionOptions, VictronMqttConsumer } from 'victron-mqtt-consumer';
 export declare class VictronDevice implements iEnergyManager {
     private readonly _victronConsumer;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
     deviceType: DeviceType;
+    /** @inheritDoc */
     readonly settings: VictronDeviceSettings;
     private _excessEnergyConsumer;
     private blockDeviceChangeTime;
@@ -29,6 +32,7 @@ export declare class VictronDevice implements iEnergyManager {
     get injectingWattage(): number;
     get drawingWattage(): number;
     get selfConsumingWattage(): number;
+    /** @inheritDoc */
     dispose(): void;
     getReport(): string;
     recalculatePowerSharing(): void;

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

@@ -10,7 +10,9 @@ const victron_mqtt_consumer_1 = require("victron-mqtt-consumer");
 const time_callback_service_1 = require("../time-callback-service");
 class VictronDevice {
     constructor(opts) {
+        /** @inheritDoc */
         this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.energyManager];
+        /** @inheritDoc */
         this.deviceType = devices_1.DeviceType.Victron;
         this._excessEnergyConsumer = [];
         this.blockDeviceChangeTime = -1;
@@ -20,10 +22,10 @@ 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();
@@ -73,6 +75,7 @@ class VictronDevice {
         var _a;
         return Math.max((_a = this.victronConsumer.data.system.power) !== null && _a !== void 0 ? _a : 0, 0) - this.drawingWattage;
     }
+    /** @inheritDoc */
     dispose() {
         this._victronConsumer.disconnect();
         if (this._iDatabaseLoggerInterval !== null) {
@@ -131,7 +134,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
@@ -140,7 +143,7 @@ class VictronDevice {
         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.`);
+                this.log(models_1.LogLevel.Debug, 'No battery data available from Victron device.');
                 return;
             }
             neededBatteryWattage = ((1 - this.data.battery.soc) * this.settings.batteryCapacityWattage) / hoursTilSunset;
@@ -193,7 +196,7 @@ 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;
         }

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-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,26 +1,20 @@
-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)