hoffmation-base 3.0.0-alpha.2 → 3.0.0-alpha.21

package/lib/server/devices/zigbee/BaseDevices/zigbeeLedRGBCCT.js

@@ -41,6 +41,9 @@ class ZigbeeLedRGBCCT extends zigbeeDimmer_1.ZigbeeDimmer {
     setTimeBased(c) {
         this.setLight(models_1.LedSetLightCommand.byTimeBased(this.settings, c));
     }
+    setActuator(c) {
+        this.setLight(new models_1.LedSetLightCommand(c, c.on, '', c.timeout));
+    }
     /**
      * @inheritDoc
      */
@@ -56,15 +59,14 @@ class ZigbeeLedRGBCCT extends zigbeeDimmer_1.ZigbeeDimmer {
         if (c.on && c.brightness === -1 && this.brightness < 10) {
             c.brightness = 10;
         }
-        this.log(models_1.LogLevel.Debug, `LED Schalten An: ${c.on}\tHelligkeit: ${c.brightness}%\tFarbe: "${c.color}"\tColorTemperatur: ${c.colorTemp}\tTransition Time: ${c.transitionTime}`);
+        super.setLight(c);
         const formattedColor = services_1.Utils.formatHex(c.color);
-        if (formattedColor !== null && c.on) {
+        if (formattedColor !== null && c.on && (c.color !== this.color || c.isForceAction)) {
             this.setState(this._stateIdColor, formattedColor);
         }
-        if (c.colorTemp > -1 && c.on) {
+        if (c.colorTemp > -1 && c.on && (c.colorTemp !== this.colortemp || c.isForceAction)) {
             this.setState(this._stateIdColorTemp, c.colorTemp);
         }
-        super.setLight(c);
     }
 }
 exports.ZigbeeLedRGBCCT = ZigbeeLedRGBCCT;

package/lib/server/devices/zigbee/BaseDevices/zigbeeMotionSensor.d.ts

@@ -24,7 +24,7 @@ export declare class ZigbeeMotionSensor extends ZigbeeDevice implements iMotionS
     set detectionsToday(pVal: number);
     /**
      * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
+     * @param pCallback - Function that accepts the new state as parameter
      */
     addMovementCallback(pCallback: (newState: boolean) => void): void;
     persistMotionSensor(): void;

package/lib/server/devices/zigbee/BaseDevices/zigbeeMotionSensor.js

@@ -64,7 +64,7 @@ class ZigbeeMotionSensor extends index_1.ZigbeeDevice {
     }
     /**
      * Adds a callback for when a motion state has changed.
-     * @param pCallback Function that accepts the new state as parameter
+     * @param pCallback - Function that accepts the new state as parameter
      */
     addMovementCallback(pCallback) {
         this._movementDetectedCallback.push(pCallback);

package/lib/server/devices/zigbee/BaseDevices/zigbeeShutter.js

@@ -75,19 +75,19 @@ class ZigbeeShutter extends zigbeeDevice_1.ZigbeeDevice {
         super.update(idSplit, state, initial, pOverride);
     }
     setLevel(c) {
-        this.log(models_1.LogLevel.Debug, c.logMessage);
         let pPosition = c.level;
         if (!this._firstCommandRecieved && !c.isInitial) {
             this._firstCommandRecieved = true;
         }
         else if (this._firstCommandRecieved && c.isInitial) {
-            this.log(models_1.LogLevel.Debug, `Skipped initial Rollo  to ${pPosition} as we recieved a command already`);
+            this.log(models_1.LogLevel.Debug, `Skipped initial Rollo to ${pPosition} as we recieved a command already`);
             return;
         }
         if (this.currentLevel === pPosition && !c.isForceAction) {
-            this.log(models_1.LogLevel.Debug, `Skip Rollo command to Position ${pPosition} as this is the current one`, services_1.LogDebugType.SkipUnchangedRolloPosition);
+            this.log(models_1.LogLevel.Debug, `Skip Rollo command to Position ${pPosition} as this is the current one, commandLog: ${c.logMessage}`, services_1.LogDebugType.SkipUnchangedRolloPosition);
             return;
         }
+        this.log(models_1.LogLevel.Debug, c.logMessage);
         if (this._window !== undefined) {
             if (this._window.griffeInPosition(models_2.WindowPosition.offen) > 0 && pPosition < 100) {
                 if (!c.skipOpenWarning) {

package/lib/server/devices/zigbee/BaseDevices/zigbeeSwitch.d.ts

@@ -13,7 +13,7 @@ export declare abstract class ZigbeeSwitch extends ZigbeeDevice implements iButt
     abstract buttonTop: Button | undefined;
     abstract buttonTopLeft: Button | undefined;
     abstract buttonTopRight: Button | undefined;
-    constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
+    protected constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
     persist(buttonName: string, pressType: ButtonPressType): void;
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverrride?: boolean): void;
     abstract getButtonAssignment(): string;

package/lib/server/devices/zigbee/zigbeeAquaraVibra.d.ts

@@ -28,6 +28,6 @@ export declare class ZigbeeAquaraVibra extends ZigbeeDevice implements iVibratio
     set vibrationBlockedByMotion(pVal: boolean);
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     setSensitivity(pVal: number): void;
-    alarmCheck(): void;
+    private alarmCheck;
     persistBatteryDevice(): void;
 }

package/lib/server/devices/zigbee/zigbeeEuroHeater.d.ts

@@ -27,9 +27,8 @@ export declare class ZigbeeEuroHeater extends ZigbeeHeater implements iDisposabl
     dispose(): void;
     private setValve;
     /**
-     * Sets the mode (1 = manual valve, 2 = automatic temp based)
-     * @param {1 | 2} targetMode
-     * @private
+     * Sets the mode
+     * @param targetMode - (1 = manual valve, 2 = automatic temp based)
      */
     private setMode;
 }

package/lib/server/devices/zigbee/zigbeeEuroHeater.js

@@ -169,9 +169,8 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
         }, 10000, this);
     }
     /**
-     * Sets the mode (1 = manual valve, 2 = automatic temp based)
-     * @param {1 | 2} targetMode
-     * @private
+     * Sets the mode
+     * @param targetMode - (1 = manual valve, 2 = automatic temp based)
      */
     setMode(targetMode) {
         this.setState(this._setModeId, targetMode);

package/lib/server/ioBroker/connection.d.ts

@@ -32,79 +32,79 @@ export declare class IOBrokerConnection implements iDisposable {
     private _isExecutedInBrowser;
     /**
      * Getter isExecutedInBrowser
-     * @return {boolean }
+     * @returns
      */
     get isExecutedInBrowser(): boolean;
     private _enums?;
     /**
      * Getter enums
-     * @return {unknown}
+     * @returns
      */
     get enums(): Record<string, ioBroker.EnumObject> | undefined;
     /**
      * Setter enums
-     * @param {unknown} value
+     * @param value
      */
     set enums(value: Record<string, ioBroker.EnumObject> | undefined);
     private _isAuthDone;
     /**
      * Getter isAuthDone
-     * @return {boolean }
+     * @returns
      */
     get isAuthDone(): boolean;
     private _namespace;
     /**
      * Getter namespace
-     * @return {string }
+     * @returns
      */
     get namespace(): string;
     /**
      * Setter namespace
-     * @param {string } value
+     * @param value
      */
     set namespace(value: string);
     private _objects?;
     /**
      * Getter objects
-     * @return {unknown}
+     * @returns
      */
     get objects(): Record<string, ioBroker.Object> | undefined;
     /**
      * Setter objects
-     * @param {unknown} value
+     * @param value
      */
     set objects(value: Record<string, ioBroker.Object> | undefined);
     private _type;
     /**
      * Getter type
-     * @return {string }
+     * @returns
      */
     get type(): string;
     /**
      * Setter type
-     * @param {string } value
+     * @param value
      */
     set type(value: string);
     private _timeout;
     /**
      * Getter timeout
-     * @return {number }
+     * @returns
      */
     get timeout(): number;
     /**
      * Setter timeout
-     * @param {number } value
+     * @param value
      */
     set timeout(value: number);
     private _user;
     /**
      * Getter user
-     * @return {unknown}
+     * @returns
      */
     get user(): string;
     /**
      * Setter user
-     * @param {unknown} value
+     * @param value
      */
     set user(value: string);
     reconnect(pConnOptions: unknown): void;
@@ -113,7 +113,7 @@ export declare class IOBrokerConnection implements iDisposable {
     readFile(filename: string, callback: ioBroker.ReadFileCallback, isRemote: boolean): void;
     getMimeType(ext: string): string;
     readFile64(filename: string, callback: unknown, isRemote: boolean): void;
-    writeFile(filename: string, data: unknown | string, mode: number, callback: ioBroker.ErrnoCallback, ...args: unknown[]): void;
+    writeFile(filename: string, data: unknown | string, mode: number, callback: ioBroker.ErrnoCallback, ..._args: unknown[]): void;
     writeFile64(filename: string, data: string, callback: ioBroker.ErrnoCallback): void;
     readDir(dirname: string, callback: ioBroker.ReadDirCallback): void;
     mkdir(dirname: string, callback: ioBroker.ErrnoCallback): void;
@@ -123,16 +123,16 @@ export declare class IOBrokerConnection implements iDisposable {
     sendTo(instance: string, command: string, payload: ioBroker.MessagePayload, callback: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo): void;
     getStates(idPattern: string | undefined, callback: ioBroker.GetStatesCallback): void;
     getObjects(useCache: boolean, callback: ioBroker.GetObjectsCallback): void;
-    getChildren(id: string, useCache: boolean, callback: (err?: Error | null, children?: string[]) => void, ...args: unknown[]): void;
+    getChildren(id: string, useCache: boolean, callback: (err?: Error | null, children?: string[]) => void, ..._args: unknown[]): void;
     getObject(id: string, useCache: boolean, callback: ioBroker.GetObjectCallback): void;
     getSyncTime(): Date;
-    addObject(objId: unknown, obj: unknown, callback: unknown): void;
+    addObject(_objId: unknown, _obj: unknown, _callback: unknown): void;
     delObject(objId: string): void;
     httpGet(url: string, callback: (res: IncomingMessage | Error) => void): void;
     logError(errorText: string): void;
     authenticate(user: string, password: string, salt: string): void;
-    getConfig(useCache: boolean, callback: (error: Error | null, conf?: Record<string, any>) => void, ...args: unknown[]): void;
-    sendCommand(instance: string, command: string, data: string | number | boolean | unknown[] | Record<string, any> | null, ack?: boolean): void;
+    getConfig(useCache: boolean, callback: (error: Error | null, conf?: Record<string, unknown>) => void, ..._args: unknown[]): void;
+    sendCommand(instance: string, command: string, data: string | number | boolean | unknown[] | Record<string, unknown> | null, ack?: boolean): void;
     readProjects(callback: (err?: NodeJS.ErrnoException | null, objects?: Array<{
         name: string;
         readOnly: undefined | boolean;
@@ -142,7 +142,7 @@ export declare class IOBrokerConnection implements iDisposable {
     clearCache(): void;
     getHistory(id: string, options: ioBroker.GetHistoryOptions & {
         timeout?: number;
-    }, callback: ioBroker.GetHistoryCallback, ...args: unknown[]): void;
+    }, callback: ioBroker.GetHistoryCallback, ..._args: unknown[]): void;
     private _checkConnection;
     private _monitor;
     private _onAuth;

package/lib/server/ioBroker/connection.js

@@ -26,6 +26,7 @@ var ConnectionState;
 })(ConnectionState || (ConnectionState = {}));
 class IOBrokerConnection {
     constructor(connOptions = {}, connCallbacks = new models_1.ConnectionCallbacks(), objectsRequired = false) {
+        var _a;
         this._authInfo = new ioBrokerAuthInfo_1.IoBrokerAuthInfo();
         this._authRunning = false;
         this._cmdQueue = new Array();
@@ -78,7 +79,7 @@ class IOBrokerConnection {
         this._connCallbacks = connCallbacks;
         let connLink = connOptions.connLink;
         if (!connOptions.connLink && this._isExecutedInBrowser) {
-            connLink = window.localStorage.getItem('connLink');
+            connLink = (_a = window.localStorage.getItem('connLink')) !== null && _a !== void 0 ? _a : undefined;
         }
         // Connection data from "/_socket/info.js"
         if (!connLink && typeof socketUrl !== 'undefined')
@@ -290,6 +291,7 @@ class IOBrokerConnection {
             }
             const err = reason;
             iobrokerConnectionLogging_1.iobrokerConnectionLogging.writeLog(iobrokerConnectionLogging_1.iobrokerConnectionLogLevel.Error, `Recieved socket error: ${err.message}\nStack:${err.stack}`);
+            // @ts-ignore
             const innerErr = reason.description;
             if (innerErr) {
                 iobrokerConnectionLogging_1.iobrokerConnectionLogging.writeLog(iobrokerConnectionLogging_1.iobrokerConnectionLogLevel.Error, `Inner socket error: ${innerErr.message}\nStack:${innerErr.stack}`);
@@ -298,91 +300,91 @@ class IOBrokerConnection {
     }
     /**
      * Getter isExecutedInBrowser
-     * @return {boolean }
+     * @returns
      */
     get isExecutedInBrowser() {
         return this._isExecutedInBrowser;
     }
     /**
      * Getter enums
-     * @return {unknown}
+     * @returns
      */
     get enums() {
         return this._enums;
     }
     /**
      * Setter enums
-     * @param {unknown} value
+     * @param value
      */
     set enums(value) {
         this._enums = value;
     }
     /**
      * Getter isAuthDone
-     * @return {boolean }
+     * @returns
      */
     get isAuthDone() {
         return this._isAuthDone;
     }
     /**
      * Getter namespace
-     * @return {string }
+     * @returns
      */
     get namespace() {
         return this._namespace;
     }
     /**
      * Setter namespace
-     * @param {string } value
+     * @param value
      */
     set namespace(value) {
         this._namespace = value;
     }
     /**
      * Getter objects
-     * @return {unknown}
+     * @returns
      */
     get objects() {
         return this._objects;
     }
     /**
      * Setter objects
-     * @param {unknown} value
+     * @param value
      */
     set objects(value) {
         this._objects = value;
     }
     /**
      * Getter type
-     * @return {string }
+     * @returns
      */
     get type() {
         return this._type;
     }
     /**
      * Setter type
-     * @param {string } value
+     * @param value
      */
     set type(value) {
         this._type = value;
     }
     /**
      * Getter timeout
-     * @return {number }
+     * @returns
      */
     get timeout() {
         return this._timeout;
     }
     /**
      * Setter timeout
-     * @param {number } value
+     * @param value
      */
     set timeout(value) {
         this._timeout = value;
     }
     /**
      * Getter user
-     * @return {unknown}
+     * @returns
      */
     get user() {
         return this._user;
@@ -390,7 +392,7 @@ class IOBrokerConnection {
     //#endregion
     /**
      * Setter user
-     * @param {unknown} value
+     * @param value
      */
     set user(value) {
         this._user = value;
@@ -478,7 +480,7 @@ class IOBrokerConnection {
             const regMatch = ext.toLowerCase().match(/\.[^.]+$/);
             ext = regMatch !== null && regMatch.length > 0 ? regMatch[0] : '';
         }
-        let _mimeType = '';
+        let _mimeType;
         if (ext === '.css') {
             _mimeType = 'text/css';
         }
@@ -588,7 +590,7 @@ class IOBrokerConnection {
     // @ts-ignore
     writeFile(filename, data, mode, callback, 
     // @ts-ignore
-    ...args) {
+    ..._args) {
         if (this._type === 'local') {
             // @ts-ignore
             storage.set(filename, JSON.stringify(data));
@@ -764,6 +766,7 @@ class IOBrokerConnection {
                     }
                     for (const row of res.rows) {
                         if (row.value !== null) {
+                            // @ts-ignore
                             data[row.id] = row.value;
                         }
                     }
@@ -781,6 +784,7 @@ class IOBrokerConnection {
                         }
                         for (const row of res.rows) {
                             if (row.value !== null) {
+                                // @ts-ignore
                                 data[row.id] = row.value;
                             }
                         }
@@ -792,6 +796,7 @@ class IOBrokerConnection {
                             }
                             for (const row of res.rows) {
                                 if (row.value !== null) {
+                                    // @ts-ignore
                                     data[row.id] = row.value;
                                 }
                             }
@@ -819,7 +824,7 @@ class IOBrokerConnection {
     // @ts-ignore
     getChildren(id, useCache, callback, 
     // @ts-ignore
-    ...args) {
+    ..._args) {
         if (this._checkConnection('getChildren', arguments) != ConnectionState.connected)
             return;
         if (!id)
@@ -849,6 +854,7 @@ class IOBrokerConnection {
             }
             for (const row of res.rows) {
                 if (row.value !== null) {
+                    // @ts-ignore
                     data[row.id] = row.value;
                 }
             }
@@ -859,6 +865,7 @@ class IOBrokerConnection {
                 }
                 for (const row of res.rows) {
                     if (row.value !== null) {
+                        // @ts-ignore
                         data[row.id] = row.value;
                     }
                 }
@@ -870,6 +877,7 @@ class IOBrokerConnection {
                     }
                     for (const row of res.rows) {
                         if (row.value !== null) {
+                            // @ts-ignore
                             data[row.id] = row.value;
                         }
                     }
@@ -960,7 +968,7 @@ class IOBrokerConnection {
         return new Date(0);
     }
     // @ts-ignore
-    addObject(objId, obj, callback) {
+    addObject(_objId, _obj, _callback) {
         if (!this._isConnected) {
             iobrokerConnectionLogging_1.iobrokerConnectionLogging.writeLog(iobrokerConnectionLogging_1.iobrokerConnectionLogLevel.Debug, 'No connection!');
             return;
@@ -1024,7 +1032,7 @@ class IOBrokerConnection {
     // FIXME finish implementation of this file
     getConfig(useCache, callback, 
     // @ts-ignore
-    ...args) {
+    ..._args) {
         if (this._checkConnection('getConfig', arguments) != ConnectionState.connected)
             return;
         if (typeof useCache === 'function') {
@@ -1112,7 +1120,7 @@ class IOBrokerConnection {
     }
     getHistory(id, options, callback, 
     // @ts-ignore
-    ...args) {
+    ..._args) {
         if (this._checkConnection('getHistory', arguments) != ConnectionState.connected)
             return;
         if (!options)

package/lib/server/ioBroker/socketIOConnectOptions.d.ts

@@ -1,6 +1,6 @@
 export declare class SocketIOConnectOpts {
     name?: string;
-    connLink?: any;
-    socketSession?: any;
+    connLink?: string;
+    socketSession?: unknown;
     socketForceWebSockets?: boolean;
 }

package/lib/server/ioBroker/socketIOVisCommand.d.ts

@@ -2,5 +2,9 @@ export declare class SocketIOVisCommand {
     command: string;
     data: string;
     instance: string;
-    constructor(pObject: any);
+    constructor(pObject: {
+        command: string;
+        data: string;
+        instance: string;
+    });
 }

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

@@ -54,8 +54,7 @@ class PollyService {
         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) {

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;