hoffmation-base 3.0.0-alpha.7 → 3.0.0-alpha.71

package/lib/server/devices/hmIPDevices/hmIpTaster.js

@@ -8,18 +8,22 @@ const models_1 = require("../../../models");
 const DeviceCapability_1 = require("../DeviceCapability");
 const services_1 = require("../../services");
 class HmIpTaster extends hmIpDevice_1.HmIPDevice {
-    get lastBatteryPersist() {
-        return this._lastBatteryPersist;
-    }
-    get battery() {
-        return this._battery;
-    }
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.HmIpTaster);
-        this._battery = -99;
-        this._lastBatteryPersist = 0;
+        /**
+         * Not present for HM-IP-Taster
+         * @inheritDoc
+         */
         this.buttonBot = undefined;
+        /**
+         * Not present for HM-IP-Taster
+         * @inheritDoc
+         */
         this.buttonTop = undefined;
+        this._battery = -99;
+        this._lastBatteryPersist = 0;
+        this._lastBatteryLevel = -1;
+        this._batteryLevelCallbacks = [];
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.buttonSwitch);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
         this.buttonTopLeft = new button_1.Button('TopLeft', HmIpTaster.BUTTON_CAPABILLITIES);
@@ -29,10 +33,21 @@ class HmIpTaster extends hmIpDevice_1.HmIPDevice {
         this.buttonMidRight = new button_1.Button('MidRight', HmIpTaster.BUTTON_CAPABILLITIES);
         this.buttonBotRight = new button_1.Button('BotRight', HmIpTaster.BUTTON_CAPABILLITIES);
     }
+    get lastBatteryPersist() {
+        return this._lastBatteryPersist;
+    }
+    get battery() {
+        return this._battery;
+    }
+    /** @inheritDoc */
+    addBatteryLevelCallback(pCallback) {
+        this._batteryLevelCallbacks.push(pCallback);
+    }
     persist(buttonName, pressType) {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistSwitchInput(this, pressType, buttonName);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Taster Update: JSON: ${JSON.stringify(state)}ID: ${idSplit.join('.')}`);
         super.update(idSplit, state, initial, true);
@@ -42,6 +57,7 @@ class HmIpTaster extends hmIpDevice_1.HmIPDevice {
                 switch (idSplit[4]) {
                     case 'OPERATING_VOLTAGE':
                         this._battery = 100 * ((state.val - 1.8) / 1.2);
+                        this.checkForBatteryChange();
                         this.persistBatteryDevice();
                         break;
                 }
@@ -161,6 +177,19 @@ class HmIpTaster extends hmIpDevice_1.HmIPDevice {
         }
         return result;
     }
+    /**
+     * Checks whether the battery level did change and if so fires the callbacks
+     */
+    checkForBatteryChange() {
+        const newLevel = this.battery;
+        if (newLevel == -1 || newLevel == this._lastBatteryLevel) {
+            return;
+        }
+        for (const cb of this._batteryLevelCallbacks) {
+            cb(new models_1.BatteryLevelChangeAction(this));
+        }
+        this._lastBatteryLevel = newLevel;
+    }
 }
 exports.HmIpTaster = HmIpTaster;
 HmIpTaster.BUTTON_CAPABILLITIES = {

package/lib/server/devices/hmIPDevices/hmIpTherm.d.ts

@@ -1,12 +1,22 @@
 import { HmIPDevice } from './hmIpDevice';
+import { BatteryLevelChangeAction } from '../../../models';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 import { iBatteryDevice } from '../baseDeviceInterfaces';
 export declare class HmIpTherm extends HmIPDevice implements iBatteryDevice {
     private _battery;
     private _lastBatteryPersist;
+    private _lastBatteryLevel;
+    private _batteryLevelCallbacks;
+    constructor(pInfo: IoBrokerDeviceInfo);
     get lastBatteryPersist(): number;
     get battery(): number;
-    constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
+    addBatteryLevelCallback(pCallback: (action: BatteryLevelChangeAction) => void): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     persistBatteryDevice(): void;
+    /**
+     * Checks whether the battery level did change and if so fires the callbacks
+     */
+    private checkForBatteryChange;
 }

package/lib/server/devices/hmIPDevices/hmIpTherm.js

@@ -7,18 +7,25 @@ const models_1 = require("../../../models");
 const DeviceCapability_1 = require("../DeviceCapability");
 const services_1 = require("../../services");
 class HmIpTherm extends hmIpDevice_1.HmIPDevice {
+    constructor(pInfo) {
+        super(pInfo, deviceType_1.DeviceType.HmIpTherm);
+        this._battery = -99;
+        this._lastBatteryPersist = 0;
+        this._lastBatteryLevel = -1;
+        this._batteryLevelCallbacks = [];
+        this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
+    }
     get lastBatteryPersist() {
         return this._lastBatteryPersist;
     }
     get battery() {
         return this._battery;
     }
-    constructor(pInfo) {
-        super(pInfo, deviceType_1.DeviceType.HmIpTherm);
-        this._battery = -99;
-        this._lastBatteryPersist = 0;
-        this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
+    /** @inheritDoc */
+    addBatteryLevelCallback(pCallback) {
+        this._batteryLevelCallbacks.push(pCallback);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Thermostat Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, true);
@@ -27,6 +34,7 @@ class HmIpTherm extends hmIpDevice_1.HmIPDevice {
                 switch (idSplit[4]) {
                     case 'OPERATING_VOLTAGE':
                         this._battery = 100 * ((state.val - 1.8) / 1.2);
+                        this.checkForBatteryChange();
                         this.persistBatteryDevice();
                         break;
                 }
@@ -42,5 +50,18 @@ class HmIpTherm extends hmIpDevice_1.HmIPDevice {
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
         this._lastBatteryPersist = now;
     }
+    /**
+     * Checks whether the battery level did change and if so fires the callbacks
+     */
+    checkForBatteryChange() {
+        const newLevel = this.battery;
+        if (newLevel == -1 || newLevel == this._lastBatteryLevel) {
+            return;
+        }
+        for (const cb of this._batteryLevelCallbacks) {
+            cb(new models_1.BatteryLevelChangeAction(this));
+        }
+        this._lastBatteryLevel = newLevel;
+    }
 }
 exports.HmIpTherm = HmIpTherm;

package/lib/server/devices/hmIPDevices/hmIpTuer.d.ts

@@ -2,8 +2,14 @@ import { HmIPDevice } from './hmIpDevice';
 import { iDisposable } from '../../services';
 import { MagnetPosition } from '../models';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
-export declare class HmIpTuer extends HmIPDevice implements iDisposable {
+import { iMagnetSensor } from '../baseDeviceInterfaces';
+export declare class HmIpTuer extends HmIPDevice implements iDisposable, iMagnetSensor {
+    /** @inheritDoc */
     position: MagnetPosition;
+    /** @inheritDoc */
+    telegramOnOpen: boolean;
+    /** @inheritDoc */
+    speakOnOpen: boolean;
     private _closedCallback;
     private _openCallback;
     private _iOpenTimeout;
@@ -11,7 +17,9 @@ export declare class HmIpTuer extends HmIPDevice implements iDisposable {
     constructor(pInfo: IoBrokerDeviceInfo);
     addOpenCallback(pCallback: (pValue: boolean) => void): void;
     addClosedCallback(pCallback: (pValue: boolean) => void): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     updatePosition(pValue: MagnetPosition): void;
+    /** @inheritDoc */
     dispose(): void;
 }

package/lib/server/devices/hmIPDevices/hmIpTuer.js

@@ -9,7 +9,12 @@ const models_2 = require("../../../models");
 class HmIpTuer extends hmIpDevice_1.HmIPDevice {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.HmIpTuer);
+        /** @inheritDoc */
         this.position = models_1.MagnetPosition.closed;
+        /** @inheritDoc */
+        this.telegramOnOpen = false;
+        /** @inheritDoc */
+        this.speakOnOpen = false;
         this._closedCallback = [];
         this._openCallback = [];
         this.minutesOpen = 0;
@@ -20,6 +25,7 @@ class HmIpTuer extends hmIpDevice_1.HmIPDevice {
     addClosedCallback(pCallback) {
         this._closedCallback.push(pCallback);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_2.LogLevel.DeepTrace, `Tuer Update: JSON: ${JSON.stringify(state)}ID: ${idSplit.join('.')}`);
         super.update(idSplit, state, initial, true);
@@ -52,10 +58,12 @@ class HmIpTuer extends hmIpDevice_1.HmIPDevice {
                 clearInterval(this._iOpenTimeout);
                 let message = `${this.info.customName} closed after ${this.minutesOpen} minutes!`;
                 if (this.minutesOpen === 0) {
-                    message = `just closed`;
+                    message = 'just closed';
                 }
                 this.log(models_2.LogLevel.Info, message);
-                services_1.TelegramService.inform(message);
+                if (this.telegramOnOpen) {
+                    services_1.TelegramService.inform(message);
+                }
                 this.minutesOpen = 0;
                 this._iOpenTimeout = undefined;
             }
@@ -64,8 +72,12 @@ class HmIpTuer extends hmIpDevice_1.HmIPDevice {
         else if (this._iOpenTimeout === undefined) {
             const message = services_1.Res.wasOpened(this.info.customName);
             //const message: string = `Die Tür mit dem Namen wurde geöfnet!`
-            services_1.TelegramService.inform(message);
-            services_1.SonosService.speakOnAll(message, 40);
+            if (this.telegramOnOpen) {
+                services_1.TelegramService.inform(message);
+            }
+            if (this.speakOnOpen) {
+                services_1.SonosService.speakOnAll(message, 40);
+            }
             this._iOpenTimeout = services_1.Utils.guardedInterval(() => {
                 this.minutesOpen++;
                 const message = `Contact is  ${models_1.MagnetPosition[this.position]} since ${this.minutesOpen} minutes`;
@@ -86,6 +98,7 @@ class HmIpTuer extends hmIpDevice_1.HmIPDevice {
             }, 60000, this);
         }
     }
+    /** @inheritDoc */
     dispose() {
         if (this._iOpenTimeout) {
             clearInterval(this._iOpenTimeout);

package/lib/server/devices/hmIPDevices/hmIpWippe.d.ts

@@ -4,15 +4,42 @@ import { iButtonSwitch } from '../baseDeviceInterfaces';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class HmIpWippe extends HmIPDevice implements iButtonSwitch {
     private static readonly BUTTON_CAPABILLITIES;
+    /**
+     * Not present for HM-IP-Wippe
+     * @inheritDoc
+     */
     buttonTopLeft: undefined;
+    /**
+     * Not present for HM-IP-Wippe
+     * @inheritDoc
+     */
     buttonMidLeft: undefined;
+    /**
+     * Not present for HM-IP-Wippe
+     * @inheritDoc
+     */
     buttonBotLeft: undefined;
+    /**
+     * Not present for HM-IP-Wippe
+     * @inheritDoc
+     */
     buttonTopRight: undefined;
+    /**
+     * Not present for HM-IP-Wippe
+     * @inheritDoc
+     */
     buttonMidRight: undefined;
+    /**
+     * Not present for HM-IP-Wippe
+     * @inheritDoc
+     */
     buttonBotRight: undefined;
+    /** @inheritDoc */
     buttonBot: Button;
+    /** @inheritDoc */
     buttonTop: Button;
     constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     persist(buttonName: string, pressType: ButtonPressType): void;
     getButtonAssignment(): string;

package/lib/server/devices/hmIPDevices/hmIpWippe.js

@@ -10,10 +10,13 @@ const services_1 = require("../../services");
 class HmIpWippe extends hmIpDevice_1.HmIPDevice {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.HmIpWippe);
+        /** @inheritDoc */
         this.buttonBot = new button_1.Button('Bottom', HmIpWippe.BUTTON_CAPABILLITIES);
+        /** @inheritDoc */
         this.buttonTop = new button_1.Button('Top', HmIpWippe.BUTTON_CAPABILLITIES);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.buttonSwitch);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Wippe Update: JSON: ${JSON.stringify(state)}ID: ${idSplit.join('.')}`);
         super.update(idSplit, state, initial, true);

package/lib/server/devices/iDeviceUpdater.d.ts

@@ -1,4 +1,18 @@
+/**
+ * Service to update the state of any device
+ */
 export interface IDeviceUpdater {
+    /**
+     * Updates the state of a device
+     * @param id - The id of the device
+     * @param state - The new state
+     * @param initial - Whether this is an initial state update
+     */
     updateState(id: string, state: ioBroker.State, initial?: boolean): void;
+    /**
+     * Updates the given object
+     * @param pId - The id of the object
+     * @param pObj - The new object
+     */
     updateObject(pId: string, pObj: ioBroker.Object): void;
 }

package/lib/server/devices/index.d.ts

@@ -1,6 +1,7 @@
 export * from './baseDeviceInterfaces/index';
 export * from './blueIris/index';
 export * from './button/index';
+export * from './dachs/index';
 export * from './espresense/index';
 export * from './groups/index';
 export * from './hmIPDevices/index';
@@ -9,19 +10,23 @@ export * from './models/index';
 export * from './scene/index';
 export * from './sharedFunctions/index';
 export * from './shelly/index';
+export * from './smartGarden/index';
 export * from './tuya/index';
+export * from './tv/index';
 export * from './zigbee/index';
 export * from './device-cluster';
 export * from './device-cluster-type';
 export * from './device-list';
+export { DeviceCapability } from './DeviceCapability';
 export * from './DeviceInfo';
 export * from './devices';
 export * from './deviceType';
 export * from './deviceUpdater';
 export * from './Griffe';
 export * from './Heizgruppen';
-export * from './mqtt';
 export * from './iDeviceUpdater';
+export * from './mqtt';
 export * from './IoBrokerBaseDevice';
-export * from './tv';
+export * from './IoBrokerDeviceInfo';
+export { NameAmountValuePair } from './nameAmountValuePair';
 export * from './wledDevice';

package/lib/server/devices/index.js

@@ -14,9 +14,11 @@ 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.NameAmountValuePair = exports.DeviceCapability = void 0;
 __exportStar(require("./baseDeviceInterfaces/index"), exports);
 __exportStar(require("./blueIris/index"), exports);
 __exportStar(require("./button/index"), exports);
+__exportStar(require("./dachs/index"), exports);
 __exportStar(require("./espresense/index"), exports);
 __exportStar(require("./groups/index"), exports);
 __exportStar(require("./hmIPDevices/index"), exports);
@@ -25,19 +27,25 @@ __exportStar(require("./models/index"), exports);
 __exportStar(require("./scene/index"), exports);
 __exportStar(require("./sharedFunctions/index"), exports);
 __exportStar(require("./shelly/index"), exports);
+__exportStar(require("./smartGarden/index"), exports);
 __exportStar(require("./tuya/index"), exports);
+__exportStar(require("./tv/index"), exports);
 __exportStar(require("./zigbee/index"), exports);
 __exportStar(require("./device-cluster"), exports);
 __exportStar(require("./device-cluster-type"), exports);
 __exportStar(require("./device-list"), exports);
+var DeviceCapability_1 = require("./DeviceCapability");
+Object.defineProperty(exports, "DeviceCapability", { enumerable: true, get: function () { return DeviceCapability_1.DeviceCapability; } });
 __exportStar(require("./DeviceInfo"), exports);
 __exportStar(require("./devices"), exports);
 __exportStar(require("./deviceType"), exports);
 __exportStar(require("./deviceUpdater"), exports);
 __exportStar(require("./Griffe"), exports);
 __exportStar(require("./Heizgruppen"), exports);
-__exportStar(require("./mqtt"), exports);
 __exportStar(require("./iDeviceUpdater"), exports);
+__exportStar(require("./mqtt"), exports);
 __exportStar(require("./IoBrokerBaseDevice"), exports);
-__exportStar(require("./tv"), exports);
+__exportStar(require("./IoBrokerDeviceInfo"), exports);
+var nameAmountValuePair_1 = require("./nameAmountValuePair");
+Object.defineProperty(exports, "NameAmountValuePair", { enumerable: true, get: function () { return nameAmountValuePair_1.NameAmountValuePair; } });
 __exportStar(require("./wledDevice"), exports);

package/lib/server/devices/jsObject/jsObjectEnergyManager.d.ts

@@ -23,6 +23,8 @@ export declare class JsObjectEnergyManager extends IoBrokerBaseDevice implements
     get drawingWattage(): number;
     get selfConsumingWattage(): number;
     get excessEnergy(): number;
+    /** @inheritDoc */
+    get acBlocked(): boolean;
     private _excessEnergyConsumerConsumption;
     /**
      * Example:
@@ -38,7 +40,7 @@ export declare class JsObjectEnergyManager extends IoBrokerBaseDevice implements
      * | drawing       |    0W |  100W | 1000W |
      * | selfConsume   |  900W | 1000W |    0W |
      * ________________________________________
-     **/
+     */
     get excessEnergyConsumerConsumption(): number;
     private _phaseAState;
     get phaseAState(): PhaseState;
@@ -49,12 +51,14 @@ export declare class JsObjectEnergyManager extends IoBrokerBaseDevice implements
     cleanup(): void;
     addExcessConsumer(device: iExcessEnergyConsumer): void;
     recalculatePowerSharing(): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial: boolean, pOverride?: boolean): void;
     private calculateExcessEnergy;
     private calculatePersistenceValues;
     private persist;
     private turnOnAdditionalConsumer;
     private turnOffAdditionalConsumer;
+    /** @inheritDoc */
     dispose(): void;
     getReport(): string;
 }

package/lib/server/devices/jsObject/jsObjectEnergyManager.js

@@ -24,7 +24,7 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
         this._phaseBState = new models_2.PhaseState(0, 0);
         this._phaseCState = new models_2.PhaseState(0, 0);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.energyManager);
-        this.log(models_1.LogLevel.Info, `Creating Energy Manager Device`);
+        this.log(models_1.LogLevel.Info, 'Creating Energy Manager Device');
         this._iCalculationInterval = services_1.Utils.guardedInterval(() => {
             this.calculateExcessEnergy();
         }, 5 * 1000, this);
@@ -58,6 +58,10 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
     get excessEnergy() {
         return this._powerValuePhaseA + this._powerValuePhaseB + this._powerValuePhaseC;
     }
+    /** @inheritDoc */
+    get acBlocked() {
+        return this.excessEnergy < 200;
+    }
     /**
      * Example:
      * ________________________________________
@@ -72,7 +76,7 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
      * | drawing       |    0W |  100W | 1000W |
      * | selfConsume   |  900W | 1000W |    0W |
      * ________________________________________
-     **/
+     */
     get excessEnergyConsumerConsumption() {
         return this._excessEnergyConsumerConsumption;
     }
@@ -110,6 +114,7 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
             this.turnOffAdditionalConsumer();
         }
     }
+    /** @inheritDoc */
     update(idSplit, state, initial, pOverride = false) {
         this.log(models_1.LogLevel.DeepTrace, `EnergyManager: ${initial ? 'Initial ' : ''} update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}, override: ${pOverride}`);
         switch (idSplit[3]) {
@@ -175,11 +180,12 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
         }
         if (!result.newState) {
             this.blockDeviceChangeTime = services_1.Utils.nowMS() + result.device.energySettings.powerReactionTime;
-            result.device.log(models_1.LogLevel.Info, `Turning off, as we don't have energy to spare...`);
+            result.device.log(models_1.LogLevel.Info, "Turning off, as we don't have energy to spare...");
             result.device.turnOffDueToMissingEnergy();
             this._lastDeviceChange = result;
         }
     }
+    /** @inheritDoc */
     dispose() {
         if (this._iCalculationInterval) {
             clearInterval(this._iCalculationInterval);

package/lib/server/devices/nameAmountValuePair.d.ts

@@ -0,0 +1,5 @@
+export declare class NameAmountValuePair {
+    name: string;
+    amount: number;
+    constructor(name: string, amount: number);
+}

package/lib/server/devices/nameAmountValuePair.js

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

package/lib/server/devices/scene/room-scene.d.ts

@@ -7,32 +7,49 @@ import { DeviceInfo } from '../DeviceInfo';
 import { DeviceCapability } from '../DeviceCapability';
 import { DeviceType } from '../deviceType';
 export declare class RoomScene implements iScene {
+    /** @inheritDoc */
     description: string;
+    /** @inheritDoc */
     room: RoomBase | undefined;
+    /** @inheritDoc */
     settings: SceneSettings;
+    protected _deviceType: DeviceType;
+    protected _info: DeviceInfo;
     private readonly _onSceneStart;
     private readonly _onSceneEnd;
+    private _automaticEndTimeout;
+    private _deviceCapabilities;
+    private _on;
     constructor(name: string, room: RoomBase, onSceneStart: () => void, onSceneEnd: () => void, turnOffTimeout?: number);
+    /** @inheritDoc */
     get customName(): string;
-    protected _deviceType: DeviceType;
+    /** @inheritDoc */
     get deviceType(): DeviceType;
-    protected _info: DeviceInfo;
+    /** @inheritDoc */
     get info(): DeviceInfo;
-    set info(info: DeviceInfo);
-    private _automaticEndTimeout;
+    /** @inheritDoc */
     get automaticEndTimeout(): NodeJS.Timeout | null;
-    private _deviceCapabilities;
+    /** @inheritDoc */
     get deviceCapabilities(): DeviceCapability[];
-    private _on;
+    /** @inheritDoc */
     get on(): boolean;
     get name(): string;
+    /** @inheritDoc */
     get id(): string;
+    /** @inheritDoc */
     get onSceneEnd(): () => void;
+    /** @inheritDoc */
     get onSceneStart(): () => void;
+    /** @inheritDoc */
     startScene(timeout?: number | undefined): void;
+    /** @inheritDoc */
     endScene(): void;
+    /** @inheritDoc */
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    /** @inheritDoc */
     persistDeviceInfo(): void;
+    /** @inheritDoc */
     loadDeviceSettings(): void;
+    /** @inheritDoc */
     toJSON(): Partial<TvDevice>;
 }

package/lib/server/devices/scene/room-scene.js

@@ -13,7 +13,9 @@ const devices_1 = require("../devices");
 const lodash_1 = __importDefault(require("lodash"));
 class RoomScene {
     constructor(name, room, onSceneStart, onSceneEnd, turnOffTimeout) {
+        /** @inheritDoc */
         this.description = '';
+        /** @inheritDoc */
         this.settings = new models_1.SceneSettings();
         this._automaticEndTimeout = null;
         this._deviceCapabilities = [DeviceCapability_1.DeviceCapability.scene];
@@ -32,40 +34,47 @@ class RoomScene {
         this.persistDeviceInfo();
         this.loadDeviceSettings();
     }
+    /** @inheritDoc */
     get customName() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get deviceType() {
         return this._deviceType;
     }
+    /** @inheritDoc */
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
+    /** @inheritDoc */
     get automaticEndTimeout() {
         return this._automaticEndTimeout;
     }
+    /** @inheritDoc */
     get deviceCapabilities() {
         return this._deviceCapabilities;
     }
+    /** @inheritDoc */
     get on() {
         return this._on;
     }
     get name() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `ac-${this.info.room}-${this.info.customName}`;
     }
+    /** @inheritDoc */
     get onSceneEnd() {
         return this._onSceneEnd;
     }
+    /** @inheritDoc */
     get onSceneStart() {
         return this._onSceneStart;
     }
+    /** @inheritDoc */
     startScene(timeout) {
         if (this._automaticEndTimeout != null) {
             clearTimeout(this._automaticEndTimeout);
@@ -82,6 +91,7 @@ class RoomScene {
             }, turnOffTimeout, this);
         }
     }
+    /** @inheritDoc */
     endScene() {
         if (this._automaticEndTimeout != null) {
             clearTimeout(this._automaticEndTimeout);
@@ -90,10 +100,11 @@ class RoomScene {
         if (!this._on) {
             return;
         }
-        this.log(models_1.LogLevel.Info, `Ending scene`);
+        this.log(models_1.LogLevel.Info, 'Ending scene');
         this._on = false;
         this._onSceneEnd();
     }
+    /** @inheritDoc */
     log(level, message, debugType = services_1.LogDebugType.None) {
         var _a, _b;
         services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
@@ -103,15 +114,18 @@ class RoomScene {
             deviceName: this.name,
         });
     }
+    /** @inheritDoc */
     persistDeviceInfo() {
         services_1.Utils.guardedTimeout(() => {
             var _a;
             (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
         }, 5000, this);
     }
+    /** @inheritDoc */
     loadDeviceSettings() {
         this.settings.initializeFromDb(this);
     }
+    /** @inheritDoc */
     toJSON() {
         // eslint-disable-next-line
         const result = lodash_1.default.omit(this, ['room', '_onSceneStart', '_onSceneEnd']);