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

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

@@ -1,13 +1,26 @@
 import { LogLevel } from '../../../models';
 import { DeviceType } from '../../devices';
 import { iLogSettings } from '../../config';
-import { ringStorage } from '../utils';
+import { RingStorage } from '../utils';
 import { LogObject } from './log-object';
 import { LogFilterData } from './log-filter-data';
 export declare class ServerLogService {
+    /**
+     * The level at which messages are sent to telegram
+     * @remarks defined at {@link iConfig.telegram.logLevel}
+     */
     static telegramLevel: number;
+    /**
+     * The threshold above which messages are stored in the ring-storage to be retrieved e.g. using {@link API.getLog}
+     */
     static storageLevel: number;
-    static storage: ringStorage<LogObject>;
+    /**
+     * The storage for the log messages
+     */
+    static storage: RingStorage<LogObject>;
+    /**
+     * The settings for the logging system.
+     */
     static settings: iLogSettings;
     static getLog(amount?: number): LogObject[];
     static initialize(logSettings: iLogSettings): void;
@@ -17,8 +30,8 @@ export declare class ServerLogService {
     static missingRoomIndexHandling(pRoomName: string, pIndex: number, pDeviceType: DeviceType): void;
     /**
      * Checks if this message is of a debugtype which should be skipped according to settings
-     * @param {LogDebugType} debugType
-     * @returns {boolean} If the Message should be skipped
+     * @param debugType - {LogDebugType}
+     * @returns If the Message should be skipped
      */
     private static checkDebugLogSkip;
 }

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

@@ -6,9 +6,9 @@ const models_1 = require("../../../models");
 const devices_1 = require("../../devices");
 const utils_1 = require("../utils");
 const log_object_1 = require("./log-object");
-const log_filter_data_1 = require("./log-filter-data");
 const logSource_1 = require("../../../models/logSource");
 const settings_service_1 = require("../settings-service");
+const log_debug_type_1 = require("./log-debug-type");
 class ServerLogService {
     static getLog(amount = 5000) {
         return this.storage.readAmount(amount);
@@ -44,7 +44,7 @@ class ServerLogService {
             console.log(message);
             if (pLevel <= ServerLogService.telegramLevel) {
                 const title = models_1.LogLevel[pLevel];
-                Telegram_1.TelegramService.sendMessage(Telegram_1.TelegramService.subscribedIDs, `${title}: ${message}`);
+                Telegram_1.TelegramService.sendMessageToSubscriber(`${title}: ${message}`);
             }
         }
     }
@@ -60,55 +60,55 @@ class ServerLogService {
     }
     /**
      * Checks if this message is of a debugtype which should be skipped according to settings
-     * @param {LogDebugType} debugType
-     * @returns {boolean} If the Message should be skipped
+     * @param debugType - {LogDebugType}
+     * @returns If the Message should be skipped
      */
     static checkDebugLogSkip(debugType) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         switch (debugType) {
-            case log_filter_data_1.LogDebugType.None:
+            case log_debug_type_1.LogDebugType.None:
                 return false;
-            case log_filter_data_1.LogDebugType.SkipUnchangedActuatorCommand:
+            case log_debug_type_1.LogDebugType.SkipUnchangedActuatorCommand:
                 if (((_a = settings_service_1.SettingsService.settings.logSettings) === null || _a === void 0 ? void 0 : _a.debugUnchangedActuator) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.SkipUnchangedRolloPosition:
+            case log_debug_type_1.LogDebugType.SkipUnchangedRolloPosition:
                 if (((_b = settings_service_1.SettingsService.settings.logSettings) === null || _b === void 0 ? void 0 : _b.debugUchangedShutterPosition) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.SetActuator:
+            case log_debug_type_1.LogDebugType.SetActuator:
                 if (((_c = settings_service_1.SettingsService.settings.logSettings) === null || _c === void 0 ? void 0 : _c.debugActuatorChange) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.ShutterPositionChange:
+            case log_debug_type_1.LogDebugType.ShutterPositionChange:
                 if (((_d = settings_service_1.SettingsService.settings.logSettings) === null || _d === void 0 ? void 0 : _d.debugShutterPositionChange) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.NewMovementState:
+            case log_debug_type_1.LogDebugType.NewMovementState:
                 if (((_e = settings_service_1.SettingsService.settings.logSettings) === null || _e === void 0 ? void 0 : _e.debugNewMovementState) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.SkipUnchangedMovementState:
+            case log_debug_type_1.LogDebugType.SkipUnchangedMovementState:
                 if (((_f = settings_service_1.SettingsService.settings.logSettings) === null || _f === void 0 ? void 0 : _f.debugNewMovementState) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.DaikinSuccessfullControlInfo:
+            case log_debug_type_1.LogDebugType.DaikinSuccessfullControlInfo:
                 if (((_g = settings_service_1.SettingsService.settings.logSettings) === null || _g === void 0 ? void 0 : _g.debugDaikinSuccessfullControlInfo) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.EuroHeaterValveLogging:
+            case log_debug_type_1.LogDebugType.EuroHeaterValveLogging:
                 if (((_h = settings_service_1.SettingsService.settings.logSettings) === null || _h === void 0 ? void 0 : _h.debugEuroHeaterValve) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.Trilateration:
+            case log_debug_type_1.LogDebugType.Trilateration:
                 if (((_j = settings_service_1.SettingsService.settings.logSettings) === null || _j === void 0 ? void 0 : _j.debugTrilateration) === true) {
                     return false;
                 }
@@ -118,10 +118,23 @@ class ServerLogService {
     }
 }
 exports.ServerLogService = ServerLogService;
+/**
+ * The level at which messages are sent to telegram
+ * @remarks defined at {@link iConfig.telegram.logLevel}
+ */
 ServerLogService.telegramLevel = -1; // Controlled from within Config File
-ServerLogService.storageLevel = 5; // Controlled from within Config File
-ServerLogService.storage = new utils_1.ringStorage(10000);
+/**
+ * The threshold above which messages are stored in the ring-storage to be retrieved e.g. using {@link API.getLog}
+ */
+ServerLogService.storageLevel = models_1.LogLevel.Trace; // Controlled from within Config File
+/**
+ * The storage for the log messages
+ */
+ServerLogService.storage = new utils_1.RingStorage(10000);
+/**
+ * The settings for the logging system.
+ */
 ServerLogService.settings = {
-    logLevel: 4,
+    logLevel: models_1.LogLevel.Debug,
     useTimestamp: false,
 };

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

@@ -1,6 +1,9 @@
 import { iNewsSettings } from '../config';
 import { iSpeaker } from '../devices';
 export declare class NewsService {
+    /**
+     * Path to the most recently downloaded news audio file
+     */
     static lastNewsAudioFile: string;
     private static readonly newsFilePrefix;
     private static interval;
@@ -11,7 +14,7 @@ export declare class NewsService {
     static initialize(config?: Partial<iNewsSettings>): void;
     /**
      * Stops the regular check for new news feed items.
-     * @deprecated Use stopInterval instead
+     * @deprecated Use {@link stopInterval} instead
      */
     static stopHourlyInterval(): void;
     static startInterval(): void;
@@ -25,17 +28,16 @@ export declare class NewsService {
     static getLatestNews(): void;
     /**
      * Plays the latest news on a sonos device
-     * @param speaker Sonos device to play from
-     * @param volume volume to play at
-     * @param retries Number of times playing should be tried if there is currently no audio file available
+     * @param speaker - Sonos device to play from
+     * @param volume - volume to play at
+     * @param retries - Number of times playing should be tried if there is currently no audio file available
      */
     static playLastNews(speaker: iSpeaker, volume?: number, retries?: number): void;
     private static downloadLatestFileFromFeed;
     /**
      * Deletes all files in the given directory that are older than the given age.
-     * @param rootDir Directory to search in
-     * @param keepMaxAge Maximum age in minutes until a file gets deleted
-     * @private
+     * @param rootDir - Directory to search in
+     * @param keepMaxAge - Maximum age in minutes until a file gets deleted
      */
     private static cleanOldFiles;
 }

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

@@ -41,7 +41,7 @@ class NewsService {
     static initialize(config) {
         var _a, _b;
         if (config === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `Service disabled.`, { source: logSource_1.LogSource.News });
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, 'Service disabled.', { source: logSource_1.LogSource.News });
             return;
         }
         NewsService.keepMaxAge = (_a = config.keepMaxAge) !== null && _a !== void 0 ? _a : 120;
@@ -51,7 +51,7 @@ class NewsService {
     }
     /**
      * Stops the regular check for new news feed items.
-     * @deprecated Use stopInterval instead
+     * @deprecated Use {@link stopInterval} instead
      */
     static stopHourlyInterval() {
         NewsService.stopInterval();
@@ -80,14 +80,14 @@ class NewsService {
      */
     static getLatestNews() {
         if (settings_service_1.SettingsService.settings.mp3Server === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `Not checking for newest news file, no download directory defined.`, {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, 'Not checking for newest news file, no download directory defined.', {
                 source: logSource_1.LogSource.News,
             });
             return;
         }
         NewsService.cleanOldFiles(settings_service_1.SettingsService.settings.mp3Server.path, NewsService.keepMaxAge);
         if (NewsService.rssUrl === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `No rss feed set, not searching for new news.`, {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, 'No rss feed set, not searching for new news.', {
                 source: logSource_1.LogSource.News,
             });
             return;
@@ -96,9 +96,9 @@ class NewsService {
     }
     /**
      * Plays the latest news on a sonos device
-     * @param speaker Sonos device to play from
-     * @param volume volume to play at
-     * @param retries Number of times playing should be tried if there is currently no audio file available
+     * @param speaker - Sonos device to play from
+     * @param volume - volume to play at
+     * @param retries - Number of times playing should be tried if there is currently no audio file available
      */
     static playLastNews(speaker, volume = 30, retries = 5) {
         if (!NewsService.lastNewsAudioFile) {
@@ -111,7 +111,7 @@ class NewsService {
                 }, 1000);
             }
             else {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `Service not ready despite waiting --> Abort.`, {
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, 'Service not ready despite waiting --> Abort.', {
                     source: logSource_1.LogSource.News,
                 });
             }
@@ -128,7 +128,7 @@ class NewsService {
                 const currentFeedItem = feed.items[0];
                 log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Most recent news on ${feed.title} is "${currentFeedItem.title}"`);
                 if (currentFeedItem.enclosure === undefined) {
-                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `Couldn't find audio in last item of the rss feed.`, {
+                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, "Couldn't find audio in last item of the rss feed.", {
                         source: logSource_1.LogSource.News,
                     });
                     return;
@@ -137,14 +137,14 @@ class NewsService {
                 // check for both path and pubdate in case the file name is always the same one
                 if (fs.existsSync(filePath) && NewsService.lastFetchedPubDate == currentFeedItem.pubDate) {
                     NewsService.lastNewsAudioFile = path_1.default.basename(filePath);
-                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Newest file already downloaded.`, { source: logSource_1.LogSource.News });
+                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'Newest file already downloaded.', { source: logSource_1.LogSource.News });
                     return;
                 }
                 log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Current news download Link: "${currentFeedItem.enclosure.url}"`);
                 https_service_1.HTTPSService.downloadFile(currentFeedItem.enclosure.url, filePath)
                     .then((success) => {
                     if (!success) {
-                        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Error while downloading audio file.`, {
+                        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'Error while downloading audio file.', {
                             source: logSource_1.LogSource.News,
                         });
                         return;
@@ -167,9 +167,8 @@ class NewsService {
     }
     /**
      * Deletes all files in the given directory that are older than the given age.
-     * @param rootDir Directory to search in
-     * @param keepMaxAge Maximum age in minutes until a file gets deleted
-     * @private
+     * @param rootDir - Directory to search in
+     * @param keepMaxAge - Maximum age in minutes until a file gets deleted
      */
     static cleanOldFiles(rootDir, keepMaxAge) {
         let deleteCount = 0;
@@ -205,4 +204,4 @@ class NewsService {
 }
 exports.NewsService = NewsService;
 // prefix for all downloaded files of the news service
-NewsService.newsFilePrefix = `news$`;
+NewsService.newsFilePrefix = 'news$';

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

@@ -1,12 +1,27 @@
-import { ringStorage } from '../utils';
+import { RingStorage } from '../utils';
 import { ActuatorSetStateCommand, FloorSetAllShuttersCommand, iRoomBase, RoomBase } from '../../../models';
 import { BaseGroup, iRoomDevice } from '../../devices';
 export declare class RoomService {
+    /**
+     * A Map containing all rooms in the house identified by their name
+     */
     static Rooms: Map<string, RoomBase>;
+    /**
+     * A Map containing all groups in the house identified by {@link BaseGroup.id}
+     */
     static Groups: Map<string, BaseGroup>;
+    /**
+     * A boolean indicating if the away mode is active, which triggers certain alarms on movement
+     */
     static awayModeActive: boolean;
+    /**
+     * A boolean indicating if the night mode is active, which triggers certain alarms on movement in rooms included in night alarm
+     */
     static nightAlarmActive: boolean;
-    static movementHistory: ringStorage<string>;
+    /**
+     * A ring storage containing the last 15 detected movements in the house
+     */
+    static movementHistory: RingStorage<string>;
     private static _awayModeTimeout;
     private static _nightModeTimeout;
     private static _intrusionAlarmActive;
@@ -16,13 +31,14 @@ export declare class RoomService {
     static getAllRoomsOfFloor(floor: number): IterableIterator<[string, RoomBase]>;
     /**
      * Moves all shutters of the desired floor(s) to the desired position
+     * @param c - the command to be executed on all windows of the desired floor(s)
      */
     static setAllShutterOfFloor(c: FloorSetAllShuttersCommand): void;
     /**
      * Set ALl Lamps of a specific floor
      * !!floor -1 sets all lamps in house instead!!
-     * @param floor the level on which all lamps shall be changed -1 equals all rooms
-     * @param command the command to be executed
+     * @param floor - {number} the level on which all lamps shall be changed -1 equals all rooms
+     * @param command - {ActuatorSetStateCommand} the command to be executed
      */
     static setAllLampsOfFloor(floor: number, command: ActuatorSetStateCommand): void;
     static clearAllAlarms(): void;

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

@@ -16,6 +16,7 @@ class RoomService {
     }
     /**
      * Moves all shutters of the desired floor(s) to the desired position
+     * @param c - the command to be executed on all windows of the desired floor(s)
      */
     static setAllShutterOfFloor(c) {
         var _a;
@@ -27,8 +28,8 @@ class RoomService {
     /**
      * Set ALl Lamps of a specific floor
      * !!floor -1 sets all lamps in house instead!!
-     * @param floor the level on which all lamps shall be changed -1 equals all rooms
-     * @param command the command to be executed
+     * @param floor - {number} the level on which all lamps shall be changed -1 equals all rooms
+     * @param command - {ActuatorSetStateCommand} the command to be executed
      */
     static setAllLampsOfFloor(floor, command) {
         var _a, _b, _c, _d;
@@ -60,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() {
@@ -71,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) {
@@ -92,11 +93,11 @@ class RoomService {
     }
     static endAlarmModes() {
         if (this.awayModeActive) {
-            Telegram_1.TelegramService.sendMessage(Telegram_1.TelegramService.subscribedIDs, `Alarmanalage entschärft`);
+            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) {
@@ -113,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);
         }
@@ -122,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'));
     }
@@ -175,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) {
@@ -185,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;
@@ -8,8 +11,9 @@ export declare class SettingsService {
     static get latitude(): number;
     static get longitude(): number;
     /**
-     * @deprecated Only use in unit tests
-     * @returns {iConfig}
+     * Generates a fresh Test configuration.
+     * @returns The test configuration.
+     * @deprecated Only use in unit tests.
      */
     static get testConfig(): iConfig;
 }

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

@@ -37,8 +37,9 @@ class SettingsService {
         return 7.097266042276687;
     }
     /**
-     * @deprecated Only use in unit tests
-     * @returns {iConfig}
+     * Generates a fresh Test configuration.
+     * @returns The test configuration.
+     * @deprecated Only use in unit tests.
      */
     static get testConfig() {
         return {

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,9 @@
+/**
+ * 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.
+     */
     dispose(): void;
 }

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;