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

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

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZigbeeAquaraVibra = void 0;
 const deviceType_1 = require("../deviceType");
@@ -6,30 +29,48 @@ const services_1 = require("../../services");
 const models_1 = require("../../../models");
 const BaseDevices_1 = require("./BaseDevices");
 const DeviceCapability_1 = require("../DeviceCapability");
+const console = __importStar(require("console"));
 class ZigbeeAquaraVibra extends BaseDevices_1.ZigbeeDevice {
-    get lastBatteryPersist() {
-        return this._lastBatteryPersist;
-    }
-    get battery() {
-        return this._battery;
-    }
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeAquaraVibra);
-        this._battery = -99;
-        this._lastBatteryPersist = 0;
+        /**
+         * The sensitivity of the vibration sensor
+         */
         this.sensitivity = '';
+        /**
+         * The detected tilt angle of the vibration sensor
+         */
         this.tiltAngle = 0;
+        /**
+         * The detected tilt angle on the x-axis of the vibration sensor
+         */
         this.tiltAngleX = 0;
+        /**
+         * The detected tilt angle on the x-axis of the vibration sensor
+         */
         this.tiltAngleXAbs = 0;
+        /**
+         * The detected tilt angle on the y-axis of the vibration sensor
+         */
         this.tiltAngleY = 0;
+        /**
+         * The detected tilt angle on the y-axis in absolute values of the vibration sensor
+         */
         this.tiltAngleYAbs = 0;
+        /**
+         * The detected tilt angle on the z-axis of the vibration sensor
+         */
         this.tiltAngleZ = 0;
+        /**
+         * Whether the vibration sensor is tilted
+         */
         this.tilt = false;
-        this.vibration = false;
-        this.vibrationBlockedByGriffTimeStamp = 0;
-        this.vibrationBlockedByMotionTimeStamp = 0;
+        this._battery = -99;
+        this._lastBatteryPersist = 0;
+        this._vibration = false;
+        this._vibrationBlockedByHandleTimeStamp = 0;
+        this._vibrationBlockedByMotionTimeStamp = 0;
         this._idSensitivity = '';
-        // TODO Set Sensitivity
         this._vibrationBlockedByGriff = false;
         this._vibrationBlockedByMotion = false;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
@@ -38,26 +79,52 @@ class ZigbeeAquaraVibra extends BaseDevices_1.ZigbeeDevice {
         services_1.PollyService.preloadTTS(this._alarmMessage);
         this._idSensitivity = `${this.info.fullID}.sensitivity`;
     }
-    get vibrationBlockedByGriff() {
+    /** @inheritDoc */
+    get vibration() {
+        return this._vibration;
+    }
+    /** @inheritDoc */
+    get vibrationBlockedByMotionTimeStamp() {
+        return this._vibrationBlockedByMotionTimeStamp;
+    }
+    /** @inheritDoc */
+    get vibrationBlockedByHandleTimeStamp() {
+        return this._vibrationBlockedByHandleTimeStamp;
+    }
+    // TODO Set Sensitivity
+    /** @inheritDoc */
+    get lastBatteryPersist() {
+        return this._lastBatteryPersist;
+    }
+    /** @inheritDoc */
+    get battery() {
+        return this._battery;
+    }
+    /** @inheritDoc */
+    get vibrationBlockedByHandle() {
         return this._vibrationBlockedByGriff;
     }
-    set vibrationBlockedByGriff(pVal) {
+    /** @inheritDoc */
+    set vibrationBlockedByHandle(pVal) {
         this.log(models_1.LogLevel.Debug, `${pVal ? 'disa' : 'a'}rming vibration alarm for ${this.info.customName} due to handle`);
         if (pVal) {
-            this.vibrationBlockedByGriffTimeStamp = new Date().getTime();
+            this._vibrationBlockedByHandleTimeStamp = new Date().getTime();
         }
         this._vibrationBlockedByGriff = pVal;
     }
+    /** @inheritDoc */
     get vibrationBlockedByMotion() {
         return this._vibrationBlockedByMotion;
     }
+    /** @inheritDoc */
     set vibrationBlockedByMotion(pVal) {
         this.log(models_1.LogLevel.Debug, `${pVal ? 'Dea' : 'A'}ktiviere Vibrationsalarm für ${this.info.customName} in Bezug auf Bewegung`);
         if (pVal) {
-            this.vibrationBlockedByMotionTimeStamp = services_1.Utils.nowMS();
+            this._vibrationBlockedByMotionTimeStamp = services_1.Utils.nowMS();
         }
         this._vibrationBlockedByMotion = pVal;
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Stecker Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, true);
@@ -66,7 +133,7 @@ class ZigbeeAquaraVibra extends BaseDevices_1.ZigbeeDevice {
                 this._battery = state.val;
                 this.persistBatteryDevice();
                 if (this._battery < 20) {
-                    this.log(models_1.LogLevel.Warn, `Das Zigbee Gerät hat unter 20% Batterie.`);
+                    this.log(models_1.LogLevel.Warn, 'Das Zigbee Gerät hat unter 20% Batterie.');
                 }
                 break;
             case 'sensitivity':
@@ -87,8 +154,8 @@ class ZigbeeAquaraVibra extends BaseDevices_1.ZigbeeDevice {
                 break;
             case 'vibration':
                 this.log(initial ? models_1.LogLevel.DeepTrace : models_1.LogLevel.Trace, `Vibrationssensor Update für ${this.info.customName} auf Vibration erkannt: ${state.val}`);
-                this.vibration = state.val;
-                if (this.vibration) {
+                this._vibration = state.val;
+                if (this._vibration) {
                     services_1.Utils.guardedTimeout(() => {
                         this.alarmCheck();
                     }, 8500, this);
@@ -123,7 +190,7 @@ class ZigbeeAquaraVibra extends BaseDevices_1.ZigbeeDevice {
                 break;
         }
         if (this._idSensitivity === '') {
-            this.log(models_1.LogLevel.Error, `Keine Switch ID bekannt.`);
+            this.log(models_1.LogLevel.Error, 'Keine Switch ID bekannt.');
             return;
         }
         this.log(models_1.LogLevel.Debug, `Vibration Sensitivität schalten Wert: ${result}`);
@@ -131,10 +198,20 @@ class ZigbeeAquaraVibra extends BaseDevices_1.ZigbeeDevice {
             console.log(`Stecker schalten ergab Fehler: ${err}`);
         });
     }
+    /** @inheritDoc */
+    persistBatteryDevice() {
+        var _a;
+        const now = services_1.Utils.nowMS();
+        if (this._lastBatteryPersist + 60000 > now) {
+            return;
+        }
+        (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
+        this._lastBatteryPersist = now;
+    }
     alarmCheck() {
         this.log(models_1.LogLevel.Debug, `Alarmcheck für ${this.info.customName} Alarmblock Wert: ${this._vibrationBlockedByGriff}`);
         if (this._vibrationBlockedByGriff) {
-            this.log(models_1.LogLevel.Debug, `Window is open; ignoring vibration alarm.`);
+            this.log(models_1.LogLevel.Debug, 'Window is open; ignoring vibration alarm.');
             return;
         }
         if (this._vibrationBlockedByMotion) {
@@ -145,14 +222,5 @@ class ZigbeeAquaraVibra extends BaseDevices_1.ZigbeeDevice {
         services_1.SonosService.speakOnAll(message);
         this.log(models_1.LogLevel.Alert, message);
     }
-    persistBatteryDevice() {
-        var _a;
-        const now = services_1.Utils.nowMS();
-        if (this._lastBatteryPersist + 60000 > now) {
-            return;
-        }
-        (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
-        this._lastBatteryPersist = now;
-    }
 }
 exports.ZigbeeAquaraVibra = ZigbeeAquaraVibra;

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

@@ -5,9 +5,18 @@ import { iBatteryDevice } from '../baseDeviceInterfaces';
 export declare class ZigbeeAquaraWater extends ZigbeeDevice implements iBatteryDevice {
     private _battery;
     private _lastBatteryPersist;
+    /** @inheritDoc */
     get lastBatteryPersist(): number;
+    /** @inheritDoc */
     get battery(): number;
+    /**
+     * Whether water is detected
+     */
     water: boolean;
+    /**
+     * The timeout for the alarm
+     * @default undefined (no alarm active)
+     */
     iAlarmTimeout: NodeJS.Timeout | undefined;
     private _messageAlarmFirst;
     private _messageAlarm;
@@ -15,11 +24,13 @@ export declare class ZigbeeAquaraWater extends ZigbeeDevice implements iBatteryD
     private _supressAlarmTimeStamp;
     constructor(pInfo: IoBrokerDeviceInfo);
     private _roomName;
-    set roomName(val: string);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     stopAlarm(quiet?: boolean, timeout?: number): void;
     private startAlarm;
     private alarm;
+    /** @inheritDoc */
     persistBatteryDevice(): void;
+    /** @inheritDoc */
     dispose(): void;
 }

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

@@ -6,10 +6,13 @@ const services_1 = require("../../services");
 const BaseDevices_1 = require("./BaseDevices");
 const models_1 = require("../../../models");
 const DeviceCapability_1 = require("../DeviceCapability");
+// TODO: Add iWaterSensor
 class ZigbeeAquaraWater extends BaseDevices_1.ZigbeeDevice {
+    /** @inheritDoc */
     get lastBatteryPersist() {
         return this._lastBatteryPersist;
     }
+    /** @inheritDoc */
     get battery() {
         return this._battery;
     }
@@ -17,7 +20,14 @@ class ZigbeeAquaraWater extends BaseDevices_1.ZigbeeDevice {
         super(pInfo, deviceType_1.DeviceType.ZigbeeAquaraWater);
         this._battery = -99;
         this._lastBatteryPersist = 0;
+        /**
+         * Whether water is detected
+         */
         this.water = false;
+        /**
+         * The timeout for the alarm
+         * @default undefined (no alarm active)
+         */
         this.iAlarmTimeout = undefined;
         this._messageAlarmFirst = '';
         this._messageAlarm = '';
@@ -29,15 +39,7 @@ class ZigbeeAquaraWater extends BaseDevices_1.ZigbeeDevice {
         this._messageAlarm = services_1.Res.waterAlarmRepeat(this.info.customName, this._roomName);
         this._messageAlarmEnd = services_1.Res.waterAlarmEnd(this._roomName);
     }
-    set roomName(val) {
-        this._roomName = val;
-        this._messageAlarmFirst = services_1.Res.waterAlarmStart(this.info.customName, this._roomName);
-        this._messageAlarm = services_1.Res.waterAlarmRepeat(this.info.customName, this._roomName);
-        this._messageAlarmEnd = services_1.Res.waterAlarmEnd(this._roomName);
-        services_1.PollyService.preloadTTS(this._messageAlarmFirst);
-        services_1.PollyService.preloadTTS(this._messageAlarm);
-        services_1.PollyService.preloadTTS(this._messageAlarmEnd);
-    }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Water Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, true);
@@ -46,7 +48,7 @@ class ZigbeeAquaraWater extends BaseDevices_1.ZigbeeDevice {
                 this._battery = state.val;
                 this.persistBatteryDevice();
                 if (this._battery < 20) {
-                    this.log(models_1.LogLevel.Warn, `Das Zigbee Gerät hat unter 20% Batterie.`);
+                    this.log(models_1.LogLevel.Warn, 'Das Zigbee Gerät hat unter 20% Batterie.');
                 }
                 break;
             case 'detected':
@@ -82,7 +84,7 @@ class ZigbeeAquaraWater extends BaseDevices_1.ZigbeeDevice {
     }
     startAlarm() {
         if (services_1.Utils.nowMS() < this._supressAlarmTimeStamp) {
-            this.log(models_1.LogLevel.Warn, `Would start alarm, but we are supressed.`);
+            this.log(models_1.LogLevel.Warn, 'Would start alarm, but we are supressed.');
             return;
         }
         if (this.iAlarmTimeout !== undefined) {
@@ -102,6 +104,7 @@ class ZigbeeAquaraWater extends BaseDevices_1.ZigbeeDevice {
             services_1.SonosService.speakOnAll(message, 80);
         });
     }
+    /** @inheritDoc */
     persistBatteryDevice() {
         var _a;
         const now = services_1.Utils.nowMS();
@@ -111,6 +114,7 @@ class ZigbeeAquaraWater extends BaseDevices_1.ZigbeeDevice {
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
         this._lastBatteryPersist = now;
     }
+    /** @inheritDoc */
     dispose() {
         if (this.iAlarmTimeout) {
             clearInterval(this.iAlarmTimeout);

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

@@ -4,24 +4,33 @@ import { iExcessEnergyConsumer } from '../baseDeviceInterfaces';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 import { iLoadMeter } from '../baseDeviceInterfaces/iLoadMeter';
 export declare class ZigbeeBlitzShp extends ZigbeeActuator implements iExcessEnergyConsumer, iLoadMeter {
+    /** @inheritDoc */
+    settings: ActuatorSettings;
     private _steckerOn;
-    get steckerOn(): boolean;
     private _current;
-    get current(): number;
     private _energy;
-    get energy(): number;
     private _loadPower;
-    get loadPower(): number;
-    settings: ActuatorSettings;
     private readonly _availableForExcessEnergy;
     private _activatedByExcessEnergy;
     constructor(pInfo: IoBrokerDeviceInfo);
+    get current(): number;
+    get energy(): number;
+    /** @inheritDoc */
+    get loadPower(): number;
+    /** @inheritDoc */
     get energySettings(): ExcessEnergyConsumerSettings;
+    /** @inheritDoc */
     get currentConsumption(): number;
+    /** @inheritDoc */
     get on(): boolean;
+    /** @inheritDoc */
     isAvailableForExcessEnergy(): boolean;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
+    /** @inheritDoc */
     turnOnForExcessEnergy(): void;
+    /** @inheritDoc */
     turnOffDueToMissingEnergy(): void;
+    /** @inheritDoc */
     wasActivatedByExcessEnergy(): boolean;
 }

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

@@ -6,43 +6,47 @@ const models_1 = require("../../../models");
 const BaseDevices_1 = require("./BaseDevices");
 const DeviceCapability_1 = require("../DeviceCapability");
 class ZigbeeBlitzShp extends BaseDevices_1.ZigbeeActuator {
-    get steckerOn() {
-        return this._steckerOn;
-    }
-    get current() {
-        return this._current;
-    }
-    get energy() {
-        return this._energy;
-    }
-    get loadPower() {
-        return this._loadPower;
-    }
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeBlitzShp, `${pInfo.fullID}.state`);
+        /** @inheritDoc */
+        this.settings = new models_1.ActuatorSettings();
         this._steckerOn = false;
         this._current = 0;
         this._energy = 0;
         this._loadPower = 0;
-        this.settings = new models_1.ActuatorSettings();
         this._availableForExcessEnergy = true;
         this._activatedByExcessEnergy = false;
         this.settings.energySettings = new models_1.ExcessEnergyConsumerSettings();
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.excessEnergyConsumer);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.loadMetering);
     }
+    get current() {
+        return this._current;
+    }
+    get energy() {
+        return this._energy;
+    }
+    /** @inheritDoc */
+    get loadPower() {
+        return this._loadPower;
+    }
+    /** @inheritDoc */
     get energySettings() {
         return this.settings.energySettings;
     }
+    /** @inheritDoc */
     get currentConsumption() {
         return this._loadPower;
     }
+    /** @inheritDoc */
     get on() {
         return this._steckerOn;
     }
+    /** @inheritDoc */
     isAvailableForExcessEnergy() {
         return this._availableForExcessEnergy;
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Stecker Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, true);
@@ -69,13 +73,16 @@ class ZigbeeBlitzShp extends BaseDevices_1.ZigbeeActuator {
                 break;
         }
     }
+    /** @inheritDoc */
     turnOnForExcessEnergy() {
         this._activatedByExcessEnergy = true;
         this.setActuator(new models_1.ActuatorSetStateCommand(models_1.CommandSource.Automatic, true, 'Turn on for excess energy'));
     }
+    /** @inheritDoc */
     turnOffDueToMissingEnergy() {
         this.setActuator(new models_1.ActuatorSetStateCommand(models_1.CommandSource.Automatic, false, 'Turn off due to missing energy'));
     }
+    /** @inheritDoc */
     wasActivatedByExcessEnergy() {
         return this._activatedByExcessEnergy;
     }

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

@@ -12,18 +12,25 @@ export declare class ZigbeeEuroHeater extends ZigbeeHeater implements iDisposabl
     private _recalcTimeout;
     private _forcedRefreshInterval;
     constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
     get seasonTurnOff(): boolean;
+    /** @inheritDoc */
     set seasonTurnOff(value: boolean);
-    set roomTemperatur(value: number);
+    /** @inheritDoc */
     get roomTemperature(): number;
+    /** @inheritDoc */
     get desiredTemperature(): number;
+    /** @inheritDoc */
     set desiredTemperature(val: number);
+    protected set roomTemperatur(value: number);
     private get tempDiff();
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     recalcLevel(): void;
     private checkTempDiff;
     private setLocalDiff;
     private setTargetTemperatur;
+    /** @inheritDoc */
     dispose(): void;
     private setValve;
     /**

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

@@ -23,9 +23,11 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
             this.setMode(this.settings.controlByPid || this.seasonTurnOff ? 1 : 2);
         }, 6 * 60 * 60 * 1000, this);
     }
+    /** @inheritDoc */
     get seasonTurnOff() {
         return this._seasonTurnOff;
     }
+    /** @inheritDoc */
     set seasonTurnOff(value) {
         this._seasonTurnOff = value;
         if (value) {
@@ -35,23 +37,26 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
         }
         this.setMode(this.settings.controlByPid ? 1 : 2);
     }
-    set roomTemperatur(value) {
-        this._roomTemperature = value;
-        if (this.settings.useOwnTemperatur) {
-            return;
-        }
-        this.recalcLevel();
-    }
+    /** @inheritDoc */
     get roomTemperature() {
         return this._roomTemperature;
     }
+    /** @inheritDoc */
     get desiredTemperature() {
         return this._desiredTemperatur;
     }
+    /** @inheritDoc */
     set desiredTemperature(val) {
         this._desiredTemperatur = val;
         this.recalcLevel();
     }
+    set roomTemperatur(value) {
+        this._roomTemperature = value;
+        if (this.settings.useOwnTemperatur) {
+            return;
+        }
+        this.recalcLevel();
+    }
     get tempDiff() {
         var _a, _b, _c, _d;
         const tempChangeMs = (_b = (_a = this.stateMap.get('local_temp')) === null || _a === void 0 ? void 0 : _a.lc) !== null && _b !== void 0 ? _b : 0;
@@ -63,6 +68,7 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
             return this._targetTempVal - this._temperatur;
         }
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         switch (idSplit[3]) {
             case 'valve_position':
@@ -154,6 +160,7 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
         this.log(models_1.LogLevel.Debug, `Setting new Target Temp (${targetTemp}) for Euro Valve`);
         this.setState(this._setPointTemperaturID, targetTemp);
     }
+    /** @inheritDoc */
     dispose() {
         clearInterval(this._forcedRefreshInterval);
     }

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

@@ -5,21 +5,39 @@ import { iBatteryDevice, iSmokeDetectorDevice } from '../baseDeviceInterfaces';
 export declare class ZigbeeHeimanSmoke extends ZigbeeDevice implements iBatteryDevice, iSmokeDetectorDevice {
     private _battery;
     private _lastBatteryPersist;
+    /**
+     * Creates an instance of {@link DeviceType.ZigbeeHeimanSmoke}.
+     * @param pInfo - Device creation information
+     */
+    constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
     get lastBatteryPersist(): number;
+    /** @inheritDoc */
     get battery(): number;
-    constructor(pInfo: IoBrokerDeviceInfo);
     private _smoke;
+    /**
+     * The timeout for the alarm to fire again
+     * @default undefined (no alarm active)
+     */
     iAlarmTimeout: NodeJS.Timeout | undefined;
     private _messageAlarmFirst;
     private _messageAlarm;
     private _messageAlarmEnd;
+    /** @inheritDoc */
     get smoke(): boolean;
     private _roomName;
+    /**
+     * The name of the room the device is in (Set during initialization)
+     */
     set roomName(val: string);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
+    /** @inheritDoc */
     stopAlarm(quiet?: boolean): void;
     private startAlarm;
     private alarm;
+    /** @inheritdoc */
     persistBatteryDevice(): void;
+    /** @inheritDoc */
     dispose(): void;
 }

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

@@ -7,17 +7,19 @@ const BaseDevices_1 = require("./BaseDevices");
 const models_1 = require("../../../models");
 const DeviceCapability_1 = require("../DeviceCapability");
 class ZigbeeHeimanSmoke extends BaseDevices_1.ZigbeeDevice {
-    get lastBatteryPersist() {
-        return this._lastBatteryPersist;
-    }
-    get battery() {
-        return this._battery;
-    }
+    /**
+     * Creates an instance of {@link DeviceType.ZigbeeHeimanSmoke}.
+     * @param pInfo - Device creation information
+     */
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeHeimanSmoke);
         this._battery = -99;
         this._lastBatteryPersist = 0;
         this._smoke = false;
+        /**
+         * The timeout for the alarm to fire again
+         * @default undefined (no alarm active)
+         */
         this.iAlarmTimeout = undefined;
         this._messageAlarmFirst = '';
         this._messageAlarm = '';
@@ -29,9 +31,21 @@ class ZigbeeHeimanSmoke extends BaseDevices_1.ZigbeeDevice {
         this._messageAlarm = services_1.Res.fireAlarmRepeat(this._roomName, this.info.customName);
         this._messageAlarmEnd = services_1.Res.fireAlarmEnd(this._roomName);
     }
+    /** @inheritDoc */
+    get lastBatteryPersist() {
+        return this._lastBatteryPersist;
+    }
+    /** @inheritDoc */
+    get battery() {
+        return this._battery;
+    }
+    /** @inheritDoc */
     get smoke() {
         return this._smoke;
     }
+    /**
+     * The name of the room the device is in (Set during initialization)
+     */
     set roomName(val) {
         this._roomName = val;
         this._messageAlarmFirst = services_1.Res.fireAlarmStart(this._roomName, this.info.customName);
@@ -41,6 +55,7 @@ class ZigbeeHeimanSmoke extends BaseDevices_1.ZigbeeDevice {
         services_1.PollyService.preloadTTS(this._messageAlarm);
         services_1.PollyService.preloadTTS(this._messageAlarmEnd);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `Smoke Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial, true);
@@ -49,7 +64,7 @@ class ZigbeeHeimanSmoke extends BaseDevices_1.ZigbeeDevice {
                 this._battery = state.val;
                 this.persistBatteryDevice();
                 if (this._battery < 20) {
-                    this.log(models_1.LogLevel.Warn, `Das Zigbee Gerät hat unter 20% Batterie.`);
+                    this.log(models_1.LogLevel.Warn, 'Das Zigbee Gerät hat unter 20% Batterie.');
                 }
                 break;
             case 'smoke':
@@ -65,6 +80,7 @@ class ZigbeeHeimanSmoke extends BaseDevices_1.ZigbeeDevice {
                 break;
         }
     }
+    /** @inheritDoc */
     stopAlarm(quiet = false) {
         if (this.iAlarmTimeout) {
             clearInterval(this.iAlarmTimeout);
@@ -102,6 +118,7 @@ class ZigbeeHeimanSmoke extends BaseDevices_1.ZigbeeDevice {
             services_1.RoomService.setAllShutterOfFloor(new models_1.FloorSetAllShuttersCommand(models_1.CommandSource.Force, 100, undefined, 'Fire alarm'));
         });
     }
+    /** @inheritdoc */
     persistBatteryDevice() {
         var _a;
         const now = services_1.Utils.nowMS();
@@ -111,6 +128,7 @@ class ZigbeeHeimanSmoke extends BaseDevices_1.ZigbeeDevice {
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
         this._lastBatteryPersist = now;
     }
+    /** @inheritDoc */
     dispose() {
         if (this.iAlarmTimeout) {
             clearInterval(this.iAlarmTimeout);

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

@@ -3,6 +3,7 @@ import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class ZigbeeIkeaShutter extends ZigbeeShutter {
     private readonly _positionStateId;
     constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
     protected moveToPosition(pPosition: number): void;
 }

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

@@ -10,6 +10,7 @@ class ZigbeeIkeaShutter extends BaseDevices_1.ZigbeeShutter {
         this._positionStateId = `${this.info.fullID}.position`;
         // this.presenceStateID = `${this.info.fullID}.1.${HmIpPraezenz.PRESENCE_DETECTION}`;
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         switch (idSplit[3]) {
             case 'position':