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

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

@@ -10,8 +10,11 @@ const sharedFunctions_1 = require("../../sharedFunctions");
 class ZigbeeDimmer extends index_1.ZigbeeDevice {
     constructor(pInfo, deviceType) {
         super(pInfo, deviceType);
+        /** @inheritDoc */
         this.queuedValue = null;
+        /** @inheritDoc */
         this.settings = new models_1.DimmerSettings();
+        /** @inheritDoc */
         this.targetAutomaticState = false;
         this._lastPersist = 0;
         this._brightness = 0;
@@ -22,21 +25,23 @@ class ZigbeeDimmer extends index_1.ZigbeeDevice {
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.blockAutomatic);
         this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this));
     }
+    /** @inheritDoc */
     get brightness() {
         return this._brightness;
     }
+    /** @inheritDoc */
     get lightOn() {
         return this._lightOn;
     }
-    get transitionTime() {
-        return this._transitionTime;
-    }
+    /** @inheritDoc */
     get actuatorOn() {
         return this.lightOn;
     }
+    /** @inheritDoc */
     restoreTargetAutomaticValue(c) {
         this.setActuator(new models_1.ActuatorSetStateCommand(c, this.targetAutomaticState));
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.queuedValue = null;
         this.log(models_1.LogLevel.DeepTrace, `Dimmer Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
@@ -58,28 +63,29 @@ class ZigbeeDimmer extends index_1.ZigbeeDevice {
                 break;
         }
     }
+    /** @inheritDoc */
     setTimeBased(c) {
         this.setLight(models_1.DimmerSetLightCommand.byTimeBased(this.settings, c));
     }
+    /** @inheritDoc */
     setActuator(c) {
-        this.setLight(new models_1.DimmerSetLightCommand(c, c.on, '', c.timeout));
+        this.setLight(new models_1.DimmerSetLightCommand(c, c.on, '', c.disableAutomaticCommand));
     }
+    /** @inheritDoc */
     toggleActuator(c) {
         const setActuatorCommand = models_1.ActuatorSetStateCommand.byActuatorAndToggleCommand(this, c);
         this.setActuator(setActuatorCommand);
         return setActuatorCommand.on;
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setLight(c) {
-        var _a;
+        var _a, _b;
         if (this._stateIdState === '') {
-            this.log(models_1.LogLevel.Error, `Keine State ID bekannt.`);
+            this.log(models_1.LogLevel.Error, 'Keine State ID bekannt.');
             return;
         }
         if (!this.ioConn) {
-            this.log(models_1.LogLevel.Error, `Keine Connection bekannt.`);
+            this.log(models_1.LogLevel.Error, 'Keine Connection bekannt.');
             return;
         }
         const dontBlock = sharedFunctions_1.LampUtils.checkUnBlock(this, c);
@@ -92,10 +98,13 @@ class ZigbeeDimmer extends index_1.ZigbeeDevice {
         if (c.on && c.brightness <= 0 && this.brightness < 10) {
             c.brightness = 10;
         }
-        if (c.timeout > -1 && !dontBlock) {
-            this.blockAutomationHandler.disableAutomatic(new models_1.BlockAutomaticCommand(c, c.timeout));
+        if (!dontBlock && c.disableAutomaticCommand !== null) {
+            (_a = c.disableAutomaticCommand) !== null && _a !== void 0 ? _a : (c.disableAutomaticCommand = models_1.BlockAutomaticCommand.fromDeviceSettings(c, this.settings));
+            if (c.disableAutomaticCommand !== null) {
+                this.blockAutomationHandler.disableAutomatic(c.disableAutomaticCommand);
+            }
         }
-        if (((_a = services_1.SettingsService.settings.ioBroker) === null || _a === void 0 ? void 0 : _a.useZigbee2mqtt) && !c.on) {
+        if (((_b = services_1.SettingsService.settings.ioBroker) === null || _b === void 0 ? void 0 : _b.useZigbee2mqtt) && !c.on) {
             // With zigbee2mqtt to turn on only setting brighness>0 is needed, so we need state only for turning off
             this.writeActuatorStateToDevice(new models_1.ActuatorWriteStateToDeviceCommand(c, c.on));
             this.queuedValue = c.on;
@@ -113,6 +122,7 @@ class ZigbeeDimmer extends index_1.ZigbeeDevice {
             }, 1000, this);
         });
     }
+    /** @inheritDoc */
     persist() {
         var _a;
         const now = services_1.Utils.nowMS();
@@ -122,9 +132,11 @@ class ZigbeeDimmer extends index_1.ZigbeeDevice {
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistActuator(this);
         this._lastPersist = now;
     }
+    /** @inheritDoc */
     toggleLight(c) {
         return sharedFunctions_1.LampUtils.toggleLight(this, c);
     }
+    /** @inheritDoc */
     writeActuatorStateToDevice(c) {
         this.log(models_1.LogLevel.Debug, c.logMessage, services_1.LogDebugType.SetActuator);
         this.setState(this._stateIdState, c.stateValue);

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

@@ -8,9 +8,13 @@ import { PIDController } from '../../../../liquid-pid';
 export declare class ZigbeeHeater extends ZigbeeDevice implements iHeater, iBatteryDevice {
     protected _battery: number;
     private _lastBatteryPersist;
+    /** @inheritDoc */
     get lastBatteryPersist(): number;
+    /** @inheritDoc */
     readonly persistHeaterInterval: NodeJS.Timeout;
+    /** @inheritDoc */
     settings: HeaterSettings;
+    /** @inheritDoc */
     get battery(): number;
     protected _iAutomaticInterval: NodeJS.Timeout | undefined;
     protected _initialSeasonCheckDone: boolean;
@@ -21,26 +25,35 @@ export declare class ZigbeeHeater extends ZigbeeDevice implements iHeater, iBatt
     protected _pidController: PIDController;
     constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
     protected _seasonTurnOff: boolean;
+    /** @inheritDoc */
     get seasonTurnOff(): boolean;
+    /** @inheritDoc */
     set seasonTurnOff(value: boolean);
+    /** @inheritDoc */
     get desiredTemperature(): number;
+    /** @inheritDoc */
     set desiredTemperature(val: number);
-    protected _humidity: number;
-    get humidity(): number;
     get sLevel(): string;
+    /** @inheritDoc */
     get iLevel(): number;
     get sTemperatur(): string;
+    /** @inheritDoc */
     get iTemperature(): number;
     protected _roomTemperature: number;
+    /** @inheritDoc */
     get roomTemperature(): number;
-    set roomTemperatur(val: number);
+    protected set roomTemperatur(val: number);
+    /** @inheritDoc */
     checkAutomaticChange(): void;
-    stopAutomaticCheck(): void;
+    /** @inheritDoc */
     onTemperaturChange(newTemperatur: number): void;
     persistHeater(): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverride?: boolean): void;
     protected getNextPidLevel(): number;
     private checkSeasonTurnOff;
+    /** @inheritDoc */
     persistBatteryDevice(): void;
+    /** @inheritDoc */
     dispose(): void;
 }

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

@@ -8,9 +8,11 @@ const services_1 = require("../../../services");
 const DeviceCapability_1 = require("../../DeviceCapability");
 const liquid_pid_1 = require("../../../../liquid-pid");
 class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
+    /** @inheritDoc */
     get lastBatteryPersist() {
         return this._lastBatteryPersist;
     }
+    /** @inheritDoc */
     get battery() {
         return this._battery;
     }
@@ -18,9 +20,11 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
         super(pInfo, pType);
         this._battery = -99;
         this._lastBatteryPersist = 0;
+        /** @inheritDoc */
         this.persistHeaterInterval = services_1.Utils.guardedInterval(() => {
             this.persistHeater();
         }, 5 * 60 * 1000, this, false);
+        /** @inheritDoc */
         this.settings = new models_1.HeaterSettings();
         this._initialSeasonCheckDone = false;
         this._level = 0;
@@ -38,7 +42,6 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
             Kd: 9, // PID: Kd in 1/1000
         });
         this._seasonTurnOff = false;
-        this._humidity = 0;
         this._roomTemperature = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.heater);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.batteryDriven);
@@ -47,15 +50,19 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
             this.checkSeasonTurnOff();
         }, 0, 2, 0));
     }
+    /** @inheritDoc */
     get seasonTurnOff() {
         return this._seasonTurnOff;
     }
+    /** @inheritDoc */
     set seasonTurnOff(value) {
         this._seasonTurnOff = value;
     }
+    /** @inheritDoc */
     get desiredTemperature() {
         return this._desiredTemperatur;
     }
+    /** @inheritDoc */
     set desiredTemperature(val) {
         this._desiredTemperatur = val;
         this.setState(this._setPointTemperaturID, val, () => {
@@ -64,18 +71,17 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
             this.log(models_1.LogLevel.Error, `Temperaturänderung ergab Fehler ${err}.`);
         });
     }
-    get humidity() {
-        return this._humidity;
-    }
     get sLevel() {
         return `${this._level * 100}%`;
     }
+    /** @inheritDoc */
     get iLevel() {
         return this._level;
     }
     get sTemperatur() {
         return `${this.iTemperature}°C`;
     }
+    /** @inheritDoc */
     get iTemperature() {
         if (this.settings.useOwnTemperatur) {
             return this._temperatur;
@@ -84,12 +90,14 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
             return this._roomTemperature;
         }
     }
+    /** @inheritDoc */
     get roomTemperature() {
         return this._roomTemperature;
     }
     set roomTemperatur(val) {
         this._roomTemperature = val;
     }
+    /** @inheritDoc */
     checkAutomaticChange() {
         var _a;
         if (!this._initialSeasonCheckDone) {
@@ -113,12 +121,7 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
             this.desiredTemperature = targetTemperature;
         }
     }
-    stopAutomaticCheck() {
-        if (this._iAutomaticInterval !== undefined) {
-            clearInterval(this._iAutomaticInterval);
-            this._iAutomaticInterval = undefined;
-        }
-    }
+    /** @inheritDoc */
     onTemperaturChange(newTemperatur) {
         this.roomTemperatur = newTemperatur;
     }
@@ -126,13 +129,14 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
         var _a;
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistHeater(this);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false, pOverride = false) {
         switch (idSplit[3]) {
             case 'battery':
                 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;
         }
@@ -155,6 +159,7 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
         }
         this._initialSeasonCheckDone = true;
     }
+    /** @inheritDoc */
     persistBatteryDevice() {
         var _a;
         const now = services_1.Utils.nowMS();
@@ -164,6 +169,7 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
         (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistBatteryDevice(this);
         this._lastBatteryPersist = now;
     }
+    /** @inheritDoc */
     dispose() {
         if (this.persistHeaterInterval) {
             clearInterval(this.persistHeaterInterval);

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

@@ -4,7 +4,7 @@ import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
 import { iLedRgbCct } from '../../baseDeviceInterfaces/iLedRgbCct';
 import { ZigbeeDimmer } from './zigbeeDimmer';
 export declare abstract class ZigbeeLedRGBCCT extends ZigbeeDimmer implements iLedRgbCct {
-    static DEFAULT_COLOR_WARM: string;
+    /** @inheritDoc */
     settings: LedSettings;
     protected abstract readonly _stateIdColor: string;
     protected abstract readonly _stateIdColorTemp: string;
@@ -12,17 +12,17 @@ export declare abstract class ZigbeeLedRGBCCT extends ZigbeeDimmer implements iL
     protected abstract readonly _stateNameColorTemp: string;
     protected constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
     protected _color: string;
+    /** @inheritDoc */
     get color(): string;
     protected _colortemp: number;
+    /** @inheritDoc */
     get colortemp(): number;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setTimeBased(c: LampSetTimeBasedCommand): void;
+    /** @inheritDoc */
     setActuator(c: ActuatorSetStateCommand): void;
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setLight(c: LedSetLightCommand): void;
 }

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

@@ -8,19 +8,23 @@ const services_1 = require("../../../services");
 class ZigbeeLedRGBCCT extends zigbeeDimmer_1.ZigbeeDimmer {
     constructor(pInfo, deviceType) {
         super(pInfo, deviceType);
+        /** @inheritDoc */
         this.settings = new models_1.LedSettings();
         this._color = '#fcba32';
         this._colortemp = 500;
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.ledLamp);
         // this.effectID = `${this.info.fullID}.effect`;
     }
+    /** @inheritDoc */
     get color() {
         return this._color;
     }
+    /** @inheritDoc */
     get colortemp() {
         return this._colortemp;
     }
     // private effectID: string = '';
+    /** @inheritDoc */
     update(idSplit, state, initial = false) {
         this.log(models_1.LogLevel.DeepTrace, `LED Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
         super.update(idSplit, state, initial);
@@ -35,25 +39,22 @@ class ZigbeeLedRGBCCT extends zigbeeDimmer_1.ZigbeeDimmer {
                 break;
         }
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setTimeBased(c) {
         this.setLight(models_1.LedSetLightCommand.byTimeBased(this.settings, c));
     }
+    /** @inheritDoc */
     setActuator(c) {
-        this.setLight(new models_1.LedSetLightCommand(c, c.on, '', c.timeout));
+        this.setLight(new models_1.LedSetLightCommand(c, c.on, '', c.disableAutomaticCommand));
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setLight(c) {
         if (this._stateIdState === '') {
-            this.log(models_1.LogLevel.Error, `Keine State ID bekannt.`);
+            this.log(models_1.LogLevel.Error, 'Keine State ID bekannt.');
             return;
         }
         if (!this.ioConn) {
-            this.log(models_1.LogLevel.Error, `Keine Connection bekannt.`);
+            this.log(models_1.LogLevel.Error, 'Keine Connection bekannt.');
             return;
         }
         if (c.on && c.brightness === -1 && this.brightness < 10) {
@@ -70,4 +71,3 @@ class ZigbeeLedRGBCCT extends zigbeeDimmer_1.ZigbeeDimmer {
     }
 }
 exports.ZigbeeLedRGBCCT = ZigbeeLedRGBCCT;
-ZigbeeLedRGBCCT.DEFAULT_COLOR_WARM = '#f2b200';

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

@@ -2,24 +2,34 @@ import { DeviceType } from '../../deviceType';
 import { ZigbeeDevice } from './zigbeeDevice';
 import { MagnetPosition } from '../../models';
 import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
-import { iBatteryDevice } from '../../baseDeviceInterfaces';
-export declare class ZigbeeMagnetContact extends ZigbeeDevice implements iBatteryDevice {
+import { iBatteryDevice, iMagnetSensor } from '../../baseDeviceInterfaces';
+export declare class ZigbeeMagnetContact extends ZigbeeDevice implements iBatteryDevice, iMagnetSensor {
     protected _battery: number;
     private _lastBatteryPersist;
+    /** @inheritDoc */
     get lastBatteryPersist(): number;
+    /** @inheritDoc */
     get battery(): number;
+    /** @inheritDoc */
     position: MagnetPosition;
+    /** @inheritDoc */
     telegramOnOpen: boolean;
+    /** @inheritDoc */
     speakOnOpen: boolean;
     private _closedCallback;
     private _openCallback;
     private _iOpenTimeout;
     private minutesOpen;
     constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
+    /** @inheritDoc */
     addOpenCallback(pCallback: (pValue: boolean) => void): void;
+    /** @inheritDoc */
     addClosedCallback(pCallback: (pValue: boolean) => void): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverrride?: boolean): void;
     protected updatePosition(pValue: MagnetPosition): void;
+    /** @inheritDoc */
     dispose(): void;
+    /** @inheritDoc */
     persistBatteryDevice(): void;
 }

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

@@ -6,9 +6,11 @@ const models_1 = require("../../../../models");
 const zigbeeDevice_1 = require("./zigbeeDevice");
 const models_2 = require("../../models");
 class ZigbeeMagnetContact extends zigbeeDevice_1.ZigbeeDevice {
+    /** @inheritDoc */
     get lastBatteryPersist() {
         return this._lastBatteryPersist;
     }
+    /** @inheritDoc */
     get battery() {
         return this._battery;
     }
@@ -16,19 +18,25 @@ class ZigbeeMagnetContact extends zigbeeDevice_1.ZigbeeDevice {
         super(pInfo, deviceType);
         this._battery = -99;
         this._lastBatteryPersist = 0;
+        /** @inheritDoc */
         this.position = models_2.MagnetPosition.closed;
+        /** @inheritDoc */
         this.telegramOnOpen = false;
+        /** @inheritDoc */
         this.speakOnOpen = false;
         this._closedCallback = [];
         this._openCallback = [];
         this.minutesOpen = 0;
     }
+    /** @inheritDoc */
     addOpenCallback(pCallback) {
         this._openCallback.push(pCallback);
     }
+    /** @inheritDoc */
     addClosedCallback(pCallback) {
         this._closedCallback.push(pCallback);
     }
+    /** @inheritDoc */
     update(idSplit, state, initial = false, pOverrride = false) {
         super.update(idSplit, state, initial, pOverrride);
         switch (idSplit[3]) {
@@ -36,7 +44,7 @@ class ZigbeeMagnetContact extends zigbeeDevice_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;
         }
@@ -98,6 +106,7 @@ class ZigbeeMagnetContact extends zigbeeDevice_1.ZigbeeDevice {
             }, 60000, this);
         }
     }
+    /** @inheritDoc */
     dispose() {
         if (this._iOpenTimeout) {
             clearInterval(this._iOpenTimeout);
@@ -105,6 +114,7 @@ class ZigbeeMagnetContact extends zigbeeDevice_1.ZigbeeDevice {
         }
         super.dispose();
     }
+    /** @inheritDoc */
     persistBatteryDevice() {
         var _a;
         const now = services_1.Utils.nowMS();

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

@@ -5,32 +5,40 @@ import { MotionSensorSettings } from '../../../../models';
 import { iBatteryDevice, iMotionSensor } from '../../baseDeviceInterfaces';
 import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
 export declare class ZigbeeMotionSensor extends ZigbeeDevice implements iMotionSensor, iBatteryDevice {
-    private _movementDetected;
-    private _battery;
-    private _lastBatteryPersist;
-    get lastBatteryPersist(): number;
+    /** @inheritDoc */
     settings: MotionSensorSettings;
-    get movementDetected(): boolean;
-    get battery(): number;
+    /** @inheritDoc */
+    detectionsToday: number;
     protected _initialized: boolean;
     protected _movementDetectedCallback: Array<(pValue: boolean) => void>;
     protected _needsMovementResetFallback: boolean;
     protected _fallBackTimeout: NodeJS.Timeout | undefined;
-    constructor(pInfo: IoBrokerDeviceInfo, type: DeviceType);
     protected _timeSinceLastMotion: number;
+    private _movementDetected;
+    private _battery;
+    private _lastBatteryPersist;
+    constructor(pInfo: IoBrokerDeviceInfo, type: DeviceType);
+    /** @inheritDoc */
+    get lastBatteryPersist(): number;
+    /** @inheritDoc */
+    get movementDetected(): boolean;
+    /** @inheritDoc */
+    get battery(): number;
+    /** @inheritDoc */
     get timeSinceLastMotion(): number;
-    protected _detectionsToday: number;
-    get detectionsToday(): number;
-    set detectionsToday(pVal: number);
     /**
      * Adds a callback for when a motion state has changed.
      * @param pCallback - Function that accepts the new state as parameter
      */
+    /** @inheritDoc */
     addMovementCallback(pCallback: (newState: boolean) => void): void;
+    /** @inheritDoc */
     persistMotionSensor(): void;
     updateMovement(newState: boolean): void;
+    /** @inheritDoc */
     update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverride?: boolean): void;
+    /** @inheritDoc */
+    persistBatteryDevice(): void;
     private resetFallbackTimeout;
     private startFallbackTimeout;
-    persistBatteryDevice(): void;
 }