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

package/lib/server/services/ShutterService.js

@@ -17,12 +17,12 @@ class ShutterService {
         rollos.sort((a, b) => {
             return b.currentLevel - a.currentLevel;
         });
-        const response = [`Dies sind die aktuellen Rollo Positionen:`];
+        const response = ['Dies sind die aktuellen Rollo Positionen:'];
         for (const r of rollos) {
             response.push(`${r.currentLevel}% Rollo: "${r.info.customName}" Gewünschte Position: ${r.desiredWindowShutterLevel}`);
         }
-        response.push(`\nDie nächsten Zeiten zum Hochfahren:`);
-        const down = [`\nDie nächsten Zeiten zum Runterfahren:`];
+        response.push('\nDie nächsten Zeiten zum Hochfahren:');
+        const down = ['\nDie nächsten Zeiten zum Runterfahren:'];
         for (const r of api_1.API.getRooms().values()) {
             if (!r.WindowGroup) {
                 continue;

package/lib/server/services/Sonos/OwnSonosDevices.d.ts

@@ -1,5 +1,8 @@
 import { OwnSonosDevice } from './own-sonos-device';
 export declare class OwnSonosDevices {
+    /**
+     * A Map containing all Sonos devices in the house identified by {@link OwnSonosDevice.discoveryName}
+     */
     static ownDevices: {
         [name: string]: OwnSonosDevice;
     };

package/lib/server/services/Sonos/OwnSonosDevices.js

@@ -10,4 +10,7 @@ class OwnSonosDevices {
     }
 }
 exports.OwnSonosDevices = OwnSonosDevices;
+/**
+ * A Map containing all Sonos devices in the house identified by {@link OwnSonosDevice.discoveryName}
+ */
 OwnSonosDevices.ownDevices = {};

package/lib/server/services/Sonos/mp3-server.d.ts

@@ -1,7 +1,9 @@
 import { iMp3Settings } from '../../config';
 export declare class MP3Server {
+    /**
+     * Whether this service is active
+     */
     static active: boolean;
-    count: number;
     private mp3Path;
     constructor(settings: iMp3Settings);
 }

package/lib/server/services/Sonos/mp3-server.js

@@ -31,7 +31,6 @@ const log_service_1 = require("../log-service");
 const models_1 = require("../../../models");
 class MP3Server {
     constructor(settings) {
-        this.count = 0;
         this.mp3Path = '';
         if (!settings) {
             return;
@@ -91,4 +90,7 @@ class MP3Server {
     }
 }
 exports.MP3Server = MP3Server;
+/**
+ * Whether this service is active
+ */
 MP3Server.active = false;

package/lib/server/services/Sonos/own-sonos-device.d.ts

@@ -5,15 +5,18 @@ import { LogDebugType } from '../log-service';
 import { DeviceCapability } from '../../devices/DeviceCapability';
 export declare class OwnSonosDevice implements iSpeaker {
     device: SonosDevice | undefined;
+    /** @inheritDoc */
     settings: SonosDeviceSettings;
+    /** @inheritDoc */
     readonly deviceType: DeviceType;
+    /** @inheritDoc */
     readonly discoveryName: string;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
     get customName(): string;
     constructor(discoveryName: string, roomName: string, device: SonosDevice | undefined);
     protected _info: DeviceInfo;
     get info(): DeviceInfo;
-    set info(info: DeviceInfo);
     get room(): RoomBase | undefined;
     get id(): string;
     get name(): string;

package/lib/server/services/Sonos/own-sonos-device.js

@@ -20,8 +20,11 @@ class OwnSonosDevice {
     }
     constructor(discoveryName, roomName, device) {
         this.device = device;
+        /** @inheritDoc */
         this.settings = new models_1.SonosDeviceSettings();
+        /** @inheritDoc */
         this.deviceType = devices_1.DeviceType.Sonos;
+        /** @inheritDoc */
         this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.speaker];
         this.discoveryName = discoveryName;
         this._info = new devices_1.DeviceInfo();
@@ -36,9 +39,6 @@ class OwnSonosDevice {
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
     get room() {
         return api_1.API.getRoom(this.info.room);
     }
@@ -52,7 +52,7 @@ class OwnSonosDevice {
     playOnDevice(mp3Name, duration, volume = undefined, onlyWhenPlaying = undefined, resolveAfterRevert = false) {
         var _a, _b;
         if (((_a = settings_service_1.SettingsService.settings.mp3Server) === null || _a === void 0 ? void 0 : _a.serverAddress) === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `Sonos: Can't speak as we have no mp3Server`);
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, "Sonos: Can't speak as we have no mp3Server");
             return;
         }
         const specificTimeout = Math.ceil(duration / 1000) + 5;

package/lib/server/services/Sonos/polly-service.d.ts

@@ -1,9 +1,15 @@
 import AWS from 'aws-sdk';
 import { iPollySettings } from '../../config';
 export declare class PollyService {
+    /**
+     * Whether Polly-Service is active
+     */
     static active: boolean;
+    /**
+     * The API Instance
+     */
     static polly: AWS.Polly;
-    static voice: string;
+    private static _voice;
     private static _mp3Path;
     static initialize(config: iPollySettings): void;
     static getDuration(filename: string): number;

package/lib/server/services/Sonos/polly-service.js

@@ -48,7 +48,7 @@ class PollyService {
                 secretAccessKey: config.secretAccessKey,
             },
         });
-        this.voice = config.voiceID;
+        this._voice = config.voiceID;
     }
     static getDuration(filename) {
         const fPath = path_1.default.join(this._mp3Path, filename);
@@ -76,7 +76,7 @@ class PollyService {
         });
     }
     static tts(text, cb) {
-        const hash = `${this.voice}_${crypto_1.default.createHash('md5').update(text).digest('hex')}`;
+        const hash = `${this._voice}_${crypto_1.default.createHash('md5').update(text).digest('hex')}`;
         const fPath = `${this._mp3Path}${hash}.mp3`;
         try {
             if (fs.existsSync(fPath)) {
@@ -92,7 +92,7 @@ class PollyService {
         const params = {
             Text: text,
             OutputFormat: 'mp3',
-            VoiceId: this.voice,
+            VoiceId: this._voice,
         };
         this.polly.synthesizeSpeech(params, (err, data) => {
             if (err) {
@@ -100,17 +100,17 @@ class PollyService {
                 return;
             }
             if (!data || data.AudioStream === undefined) {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `AWS Polly didn't send any data`);
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, "AWS Polly didn't send any data");
                 return;
             }
             log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `AWS Antwort für (${hash}) erhalten Text: "${text}"`);
             fs.writeFile(fPath, data.AudioStream, (err) => {
                 const duration = (0, get_mp3_duration_1.default)(data.AudioStream);
                 if (err) {
-                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `AWS Polly: Saving failed`);
+                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, 'AWS Polly: Saving failed');
                     return;
                 }
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Trace, `AWS Polly: Saving sucessfully`);
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Trace, 'AWS Polly: Saving sucessfully');
                 cb(hash, duration);
                 return;
             });
@@ -118,4 +118,7 @@ class PollyService {
     }
 }
 exports.PollyService = PollyService;
+/**
+ * Whether Polly-Service is active
+ */
 PollyService.active = false;

package/lib/server/services/Sonos/sonos-service.d.ts

@@ -1,10 +1,5 @@
-import { SonosDevice } from '@svrooij/sonos/lib';
 import { OwnSonosDevice } from './own-sonos-device';
 export declare class SonosService {
-    static all: SonosDevice[];
-    static devicesDict: {
-        [name: string]: SonosDevice;
-    };
     private static sonosManager;
     private static ownDevices;
     private static isInitialized;

package/lib/server/services/Sonos/sonos-service.js

@@ -16,9 +16,9 @@ class SonosService {
     static initialize(reinitialize = false) {
         var _a;
         if (((_a = settings_service_1.SettingsService.settings.mp3Server) === null || _a === void 0 ? void 0 : _a.serverAddress) === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `SonosService needs properly configured mp3Server.`);
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, 'SonosService needs properly configured mp3Server.');
         }
-        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Initialisiere Sonos Service`);
+        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'Initialisiere Sonos Service');
         if (!reinitialize) {
             this.checkTimeCallback = new models_1.TimeCallback('SonosFunctionallityChecker', models_1.TimeCallbackType.TimeOfDay, () => {
                 void this.checkAll();
@@ -31,9 +31,8 @@ class SonosService {
                 Telegram_1.TelegramService.sendMessage([m.chat.id], 'Testnachricht gesprochen --> Führe weiteren Test durch');
                 await SonosService.checkAll();
                 return true;
-            }, `Spiele eine kurze Nachricht auf allen Sonos Geräten um diese zu identifizieren`));
+            }, 'Spiele eine kurze Nachricht auf allen Sonos Geräten um diese zu identifizieren'));
         }
-        this.all = [];
         this.sonosManager = new lib_1.SonosManager();
         this.sonosManager
             .InitializeWithDiscovery(10)
@@ -49,7 +48,7 @@ class SonosService {
             });
             this.isInitialized = true;
             if (!reinitialize) {
-                (_a = this.reinitializationDevice) === null || _a === void 0 ? void 0 : _a.speakOnDevice(`Sonos System initialisiert und bereit für Sprachausgaben.`, 30);
+                (_a = this.reinitializationDevice) === null || _a === void 0 ? void 0 : _a.speakOnDevice('Sonos System initialisiert und bereit für Sprachausgaben.', 30);
             }
         })
             .catch(console.error);
@@ -72,13 +71,13 @@ class SonosService {
         }
         catch (e) {
             log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `Atleast one device failed --> Last checked ${(_a = currentDevice === null || currentDevice === void 0 ? void 0 : currentDevice.name) !== null && _a !== void 0 ? _a : 'undefined'}`);
-            Telegram_1.TelegramService.inform(`Sonos device is failing --> Reinitialize whole system`);
+            Telegram_1.TelegramService.inform('Sonos device is failing --> Reinitialize whole system');
             this.initialize(true);
         }
     }
     static speakOnAll(pMessage, volumeOverride = -1) {
         if (!this.isInitialized) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `SonosService noch nicht initialisiert.`);
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, 'SonosService noch nicht initialisiert.');
         }
         polly_service_1.PollyService.tts(pMessage, (networkPath, duration) => {
             const hours = new Date().getHours();
@@ -96,7 +95,6 @@ class SonosService {
         }
     }
     static initializeDevice(d) {
-        this.devicesDict[d.Name] = d;
         if (this.ownDevices[d.Name] === undefined) {
             log_service_1.ServerLogService.writeLog(models_1.LogLevel.Alert, `Unbekanntes Sonos Gerät "${d.Name}"`);
             return;
@@ -106,6 +104,4 @@ class SonosService {
     }
 }
 exports.SonosService = SonosService;
-SonosService.all = [];
-SonosService.devicesDict = {};
 SonosService.ownDevices = {};

package/lib/server/services/Telegram/telegram-Commands.js

@@ -83,9 +83,9 @@ class TelegramCommands {
             if (m.from === undefined)
                 return false;
             room_service_1.RoomService.setAllShutterOfFloor(new models_1.FloorSetAllShuttersCommand(models_1.CommandSource.Manual, 0, undefined, 'Telegram command AllRolloDown'));
-            telegram_service_1.TelegramService.sendMessage([m.chat.id], `Es werden alle Rollos heruntergefahren`);
+            telegram_service_1.TelegramService.sendMessage([m.chat.id], 'Es werden alle Rollos heruntergefahren');
             return true;
-        }, `Fährt alle rollos runter`));
+        }, 'Fährt alle rollos runter'));
         telegram_service_1.TelegramService.addMessageCallback(new telegramMessageCalback_1.TelegramMessageCallback('VibrationSensitivity', /\/set_vibration_sensitivity/, async (m) => {
             if (m.from === undefined)
                 return false;
@@ -97,7 +97,7 @@ class TelegramCommands {
             }
             telegram_service_1.TelegramService.sendMessage([m.chat.id], 'Abgeschlossen');
             return true;
-        }, `Setzt alle Vibrationsensoren auf High`));
+        }, 'Setzt alle Vibrationsensoren auf High'));
         telegram_service_1.TelegramService.addMessageCallback(new telegramMessageCalback_1.TelegramMessageCallback('AllButtonAssignments', /\/get_all_button_assignments/, async (m) => {
             if (m.from === undefined)
                 return false;
@@ -110,7 +110,7 @@ class TelegramCommands {
             }
             telegram_service_1.TelegramService.sendMessage([m.chat.id], response.join('\n'));
             return true;
-        }, `Retrieves the button assignments for all buttons in home`));
+        }, 'Retrieves the button assignments for all buttons in home'));
         if (devices_1.Devices.energymanager !== undefined) {
             telegram_service_1.TelegramService.addMessageCallback(new telegramMessageCalback_1.TelegramMessageCallback('EnergyManager', /\/get_energy_values/, async (m) => {
                 var _a, _b;
@@ -120,7 +120,7 @@ class TelegramCommands {
                 response.push((_b = (_a = devices_1.Devices.energymanager) === null || _a === void 0 ? void 0 : _a.getReport()) !== null && _b !== void 0 ? _b : 'No Energy Manager found');
                 telegram_service_1.TelegramService.sendMessage([m.chat.id], response.join('\n'));
                 return true;
-            }, `Retrieves the current energy manager values`));
+            }, 'Retrieves the current energy manager values'));
         }
     }
 }

package/lib/server/services/Telegram/telegram-service.d.ts

@@ -3,7 +3,7 @@ import { TelegramMessageCallback } from './telegramMessageCalback';
 import { iTelegramSettings } from '../../config';
 import { Base64Image } from '../../../models';
 export declare class TelegramService {
-    static subscribedIDs: number[];
+    private static subscribedIDs;
     private static token;
     private static active;
     private static bot;
@@ -15,6 +15,7 @@ export declare class TelegramService {
     static publishCommands(): void;
     static inform(message: string): void;
     static sendImage(message: string, image: Base64Image): void;
+    static sendMessageToSubscriber(message: string): void;
     static sendMessage(ids: number[], message: string): void;
     static checkAuthorized(msg: TelegramBot.Message): boolean;
     static resetMessageCallbacks(): void;

package/lib/server/services/Telegram/telegram-service.js

@@ -56,8 +56,8 @@ class TelegramService {
             }
             TelegramService.sendMessage([m.chat.id], message.join('\n'));
             return true;
-        }, `Gibt eine Liste mit sämtlichen Kommandos aus`));
-        TelegramService.inform(`(Re-)Initialisierung abgeschlossen`);
+        }, 'Gibt eine Liste mit sämtlichen Kommandos aus'));
+        TelegramService.inform('(Re-)Initialisierung abgeschlossen');
     }
     static publishCommands() {
         const commands = [];
@@ -87,9 +87,14 @@ class TelegramService {
             }, 0, this);
         }
     }
+    static sendMessageToSubscriber(message) {
+        if (this.subscribedIDs.length > 0) {
+            this.sendMessage(this.subscribedIDs, message);
+        }
+    }
     static sendMessage(ids, message) {
         if (!this.active) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Would have send telegram message, but telegram is not active`);
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'Would have send telegram message, but telegram is not active');
             return;
         }
         const chunksNeeded = Math.ceil(message.length / 4095);

package/lib/server/services/Translation/IRessourceObject.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface to allow for translation of strings to the different languages thus, allowing the ressources to be outsourced to a json file.
+ */
+export interface IRessourceObject {
+    /**
+     * German translation
+     */
+    de?: string;
+    /**
+     * English translation
+     */
+    en: string;
+}

package/lib/server/services/Translation/IRessourceObject.js

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

package/lib/server/services/Translation/iRessources.d.ts

@@ -1,7 +1,4 @@
-export interface IRessourceObject {
-    de?: string;
-    en: string;
-}
+import { IRessourceObject } from './IRessourceObject';
 export interface IRessources {
     alarmArmed: IRessourceObject;
     alarmNightModeArmed: IRessourceObject;

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

@@ -1,2 +1,3 @@
 export * from './iRessources';
 export * from './res';
+export { IRessourceObject } from './IRessourceObject';

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

@@ -8,9 +8,13 @@ import { BlockAutomaticHandler } from '../blockAutomaticHandler';
 export declare abstract class AcDevice implements iExcessEnergyConsumer, iRoomDevice, iAcDevice, iTemporaryDisableAutomatic {
     ip: string;
     acDeviceType: AcDeviceType;
+    /** @inheritDoc */
     currentConsumption: number;
+    /** @inheritDoc */
     settings: AcSettings;
+    /** @inheritDoc */
     deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
     readonly blockAutomationHandler: BlockAutomaticHandler;
     protected _activatedByExcessEnergy: boolean;
     protected _desiredTemperatur: number;
@@ -18,39 +22,72 @@ export declare abstract class AcDevice implements iExcessEnergyConsumer, iRoomDe
     protected _room: RoomBase | undefined;
     protected _mode: AcMode;
     private _movementCallbackAdded;
+    /** @inheritDoc */
     get temperature(): number;
+    /** @inheritDoc */
     get customName(): string;
+    /** @inheritDoc */
     get room(): RoomBase | undefined;
+    /** @inheritDoc */
     set room(room: RoomBase | undefined);
+    /** @inheritDoc */
     get mode(): AcMode;
     protected constructor(name: string, roomName: string, ip: string, acDeviceType: AcDeviceType);
+    /** @inheritDoc */
     get energySettings(): ExcessEnergyConsumerSettings;
     private _roomTemperature;
+    /** @inheritDoc */
     get roomTemperature(): number;
+    /** @inheritDoc */
     get info(): DeviceInfo;
     protected set roomTemperatur(val: number);
-    set info(info: DeviceInfo);
     abstract get deviceType(): DeviceType;
+    /**
+     * The name of this device
+     * @returns The human readable name of this device
+     */
     get name(): string;
+    /** @inheritDoc */
     get id(): string;
     abstract get on(): boolean;
+    /** @inheritDoc */
     restoreTargetAutomaticValue(): void;
+    /** @inheritDoc */
     isAvailableForExcessEnergy(): boolean;
+    /** @inheritDoc */
     calculateDesiredMode(): AcMode;
     abstract setDesiredMode(mode: AcMode, writeToDevice: boolean, temp?: number): void;
     abstract turnOn(): void;
+    /** @inheritDoc */
     onTemperaturChange(newTemperatur: number): void;
+    /**
+     * Persists the current AC-Information to the database
+     */
     persist(): void;
+    /** @inheritDoc */
     turnOnForExcessEnergy(): void;
     abstract turnOff(): void;
+    /** @inheritDoc */
     turnOffDueToMissingEnergy(): void;
+    /**
+     * Sets the state of the AC
+     * TODO: Migrate to new command system
+     * @param mode - The desired mode
+     * @param desiredTemp - The desired temperature (if unset it will be calculated)
+     * @param forceTime - The time in ms to force the AC to stay in this state (default 1h)
+     */
     setState(mode: AcMode, desiredTemp?: number, forceTime?: number): void;
+    /** @inheritDoc */
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    /** @inheritDoc */
     wasActivatedByExcessEnergy(): boolean;
+    /** @inheritDoc */
     loadDeviceSettings(): void;
+    /** @inheritDoc */
     persistDeviceInfo(): void;
     protected automaticCheck(): void;
     private onRoomFirstEnter;
     private onRoomLastLeave;
+    /** @inheritDoc */
     toJSON(): Partial<AcDevice>;
 }