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

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

@@ -48,14 +48,13 @@ 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);
         try {
             if (fs.existsSync(fPath)) {
-                const duration = (0, get_mp3_duration_1.default)(fs.readFileSync(fPath));
-                return duration;
+                return (0, get_mp3_duration_1.default)(fs.readFileSync(fPath));
             }
         }
         catch (err) {
@@ -77,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)) {
@@ -93,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) {
@@ -101,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;
             });
@@ -119,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,15 +1,11 @@
-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;
     private static checkTimeCallback;
     private static reinitializationDevice;
+    private static get config();
     static addOwnDevices(snDevices: {
         [name: string]: OwnSonosDevice;
     }, reinitializationDevice?: OwnSonosDevice): void;

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

@@ -9,16 +9,19 @@ const Telegram_1 = require("../Telegram");
 const time_callback_service_1 = require("../time-callback-service");
 const settings_service_1 = require("../settings-service");
 class SonosService {
+    static get config() {
+        return settings_service_1.SettingsService.settings.sonos;
+    }
     static addOwnDevices(snDevices, reinitializationDevice) {
         this.ownDevices = snDevices;
         this.reinitializationDevice = reinitializationDevice;
     }
     static initialize(reinitialize = false) {
-        var _a;
+        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, `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,25 +34,26 @@ 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)
+        this.sonosManager.OnNewDevice((d) => {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `SonosDevice ${d.Name} joined`);
+            SonosService.initializeDevice(d);
+        });
+        const initialHost = (_b = this.config) === null || _b === void 0 ? void 0 : _b.initialHost;
+        (initialHost === undefined
+            ? this.sonosManager.InitializeWithDiscovery(10)
+            : this.sonosManager.InitializeFromDevice(initialHost))
             .then(() => {
             var _a;
-            this.sonosManager.OnNewDevice((d) => {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `SonosDevice ${d.Name} joined`);
-                SonosService.initializeDevice(d);
-            });
             log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `${this.sonosManager.Devices.length} Sonos Geräte gefunden.`);
             this.sonosManager.Devices.forEach((d) => {
                 SonosService.initializeDevice(d);
             });
             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);
@@ -70,15 +74,15 @@ class SonosService {
                 log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Alle Geräte okay --> Last checked ${currentDevice.name}`);
             }
         }
-        catch (e) {
+        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 +100,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 +109,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/Translation/res.d.ts

@@ -4,79 +4,94 @@ export declare class Res {
     private static selectedLanguage;
     static initialize(config: iTranslationSettings): void;
     /**
-     * Retrieves a string like `Alarm system arming."`
+     * @returns Retrieves a string like `Alarm system arming."`
      */
     static alarmArmed(): string;
     /**
-     * Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
+     * @returns Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
      */
     static alarmNightModeArmed(): string;
     /**
-     * Retrieves a string like `"@P0" closed after @P1 minutes`
+     * @param deviceCustomName - The custom name of the device
+     * @param minutes - The minutes the device was closed after
+     * @returns Retrieves a string like `"@P0" closed after @P1 minutes`
      */
     static closedAfterMinutes(deviceCustomName: string, minutes: string): string;
     /**
-     * Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
      */
     static fireAlarmEnd(roomName: string): string;
     /**
-     * Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
+     * @param roomName - The name of the room
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
      */
     static fireAlarmRepeat(roomName: string, deviceCustomName: string): string;
     /**
-     * Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
+     * @param roomName - The name of the room
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
      */
     static fireAlarmStart(roomName: string, deviceCustomName: string): string;
     /**
-     * Retrieves a string like `Good Morning`
+     * @returns Retrieves a string like `Good Morning`
      */
     static goodMorning(): string;
     /**
-     * Retrieves a string like "Alarm. Intruder detected"
+     * @returns Retrieves a string like "Alarm. Intruder detected"
      */
     static intruderAlarm(): string;
     /**
-     * Retrieves a string like "Additional defense protocol initiated."
+     * @returns Retrieves a string like "Additional defense protocol initiated."
      */
     static intruderAdditionalDefenseWarning(): string;
     /**
-     * Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
+     * @returns Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
      */
     static intruderGreeting(): string;
     /**
-     * Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
+     * @returns Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
      */
     static intruderLeaveAndOwnerInformed(): string;
     /**
-     * Retrieves a string like "All shutter are opening, please leave immediatly."
+     * @returns Retrieves a string like "All shutter are opening, please leave immediatly."
      */
     static intruderShutterUpPleaseLeave(): string;
     /**
-     * Retrieves a string like `"@P0" just closed`
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `"@P0" just closed`
      */
     static justClosed(deviceCustomName: string): string;
     /**
-     * Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
      */
     static vibrationAlarm(deviceCustomName: string): string;
     /**
-     * Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
      */
     static waterAlarmEnd(roomName: string): string;
     /**
-     * Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
+     * @param deviceCustomName - The custom name of the device
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
      */
     static waterAlarmRepeat(deviceCustomName: string, roomName: string): string;
     /**
-     * Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
+     * @param deviceCustomName - The custom name of the device
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
      */
     static waterAlarmStart(deviceCustomName: string, roomName: string): string;
     /**
-     * Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
+     * @returns Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
      */
     static welcomeHome(): string;
     /**
-     * Retrieves a string like `"@P0" was opened`
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `"@P0" was opened`
      */
     static wasOpened(deviceCustomName: string): string;
     private static fill;

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

@@ -11,115 +11,130 @@ class Res {
         this.translations = resources_json_1.default;
     }
     /**
-     * Retrieves a string like `Alarm system arming."`
+     * @returns Retrieves a string like `Alarm system arming."`
      */
     static alarmArmed() {
         return this.fill(this.translations.alarmArmed);
     }
     /**
-     * Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
+     * @returns Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
      */
     static alarmNightModeArmed() {
         return this.fill(this.translations.alarmNightModeArmed);
     }
     /**
-     * Retrieves a string like `"@P0" closed after @P1 minutes`
+     * @param deviceCustomName - The custom name of the device
+     * @param minutes - The minutes the device was closed after
+     * @returns Retrieves a string like `"@P0" closed after @P1 minutes`
      */
     static closedAfterMinutes(deviceCustomName, minutes) {
         return this.fill(this.translations.closedAfterMinutes, [deviceCustomName, minutes]);
     }
     /**
-     * Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
      */
     static fireAlarmEnd(roomName) {
         return this.fill(this.translations.fireAlarmEnd, [roomName]);
     }
     /**
-     * Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
+     * @param roomName - The name of the room
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
      */
     static fireAlarmRepeat(roomName, deviceCustomName) {
         return this.fill(this.translations.fireAlarmRepeat, [roomName, deviceCustomName]);
     }
     /**
-     * Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
+     * @param roomName - The name of the room
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
      */
     static fireAlarmStart(roomName, deviceCustomName) {
         return this.fill(this.translations.fireAlarmStart, [roomName, deviceCustomName]);
     }
     /**
-     * Retrieves a string like `Good Morning`
+     * @returns Retrieves a string like `Good Morning`
      */
     static goodMorning() {
         return this.fill(this.translations.goodMorning);
     }
     /**
-     * Retrieves a string like "Alarm. Intruder detected"
+     * @returns Retrieves a string like "Alarm. Intruder detected"
      */
     static intruderAlarm() {
         return this.fill(this.translations.intruderAlarm);
     }
     /**
-     * Retrieves a string like "Additional defense protocol initiated."
+     * @returns Retrieves a string like "Additional defense protocol initiated."
      */
     static intruderAdditionalDefenseWarning() {
         return this.fill(this.translations.intruderAdditionalDefenseWarning);
     }
     /**
-     * Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
+     * @returns Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
      */
     static intruderGreeting() {
         return this.fill(this.translations.intruderGreeting);
     }
     /**
-     * Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
+     * @returns Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
      */
     static intruderLeaveAndOwnerInformed() {
         return this.fill(this.translations.intruderLeaveAndOwnerInformed);
     }
     /**
-     * Retrieves a string like "All shutter are opening, please leave immediatly."
+     * @returns Retrieves a string like "All shutter are opening, please leave immediatly."
      */
     static intruderShutterUpPleaseLeave() {
         return this.fill(this.translations.intruderShutterUpPleaseLeave);
     }
     /**
-     * Retrieves a string like `"@P0" just closed`
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `"@P0" just closed`
      */
     static justClosed(deviceCustomName) {
         return this.fill(this.translations.justClosed, [deviceCustomName]);
     }
     /**
-     * Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
      */
     static vibrationAlarm(deviceCustomName) {
         return this.fill(this.translations.vibrationAlarm, [deviceCustomName]);
     }
     /**
-     * Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
      */
     static waterAlarmEnd(roomName) {
         return this.fill(this.translations.waterAlarmEnd, [roomName]);
     }
     /**
-     * Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
+     * @param deviceCustomName - The custom name of the device
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
      */
     static waterAlarmRepeat(deviceCustomName, roomName) {
         return this.fill(this.translations.waterAlarmRepeat, [deviceCustomName, roomName]);
     }
     /**
-     * Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
+     * @param deviceCustomName - The custom name of the device
+     * @param roomName - The name of the room
+     * @returns Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
      */
     static waterAlarmStart(deviceCustomName, roomName) {
         return this.fill(this.translations.waterAlarmStart, [deviceCustomName, roomName]);
     }
     /**
-     * Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
+     * @returns Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
      */
     static welcomeHome() {
         return this.fill(this.translations.welcomeHome);
     }
     /**
-     * Retrieves a string like `"@P0" was opened`
+     * @param deviceCustomName - The custom name of the device
+     * @returns Retrieves a string like `"@P0" was opened`
      */
     static wasOpened(deviceCustomName) {
         return this.fill(this.translations.wasOpened, [deviceCustomName]);