hoffmation-base 3.0.3 → 3.1.0

package/lib/devices/sharedFunctions/lampUtils.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LampUtils = void 0;
+const command_1 = require("../../command");
+const utils_1 = require("../../utils");
+const enums_1 = require("../../enums");
+const services_1 = require("../../services");
+class LampUtils {
+    static stromStossOn(actuator) {
+        if (!LampUtils.stromStossContinueTimeouts.has(actuator.id)) {
+            LampUtils.stromStossContinueTimeouts.set(actuator.id, utils_1.Utils.guardedTimeout(() => {
+                var _a, _b;
+                LampUtils.stromStossContinueTimeouts.delete(actuator.id);
+                if ((_b = (_a = actuator.room) === null || _a === void 0 ? void 0 : _a.PraesenzGroup) === null || _b === void 0 ? void 0 : _b.anyPresent(true)) {
+                    actuator.setActuator(new command_1.ActuatorSetStateCommand(enums_1.CommandSource.Automatic, true, 'StromStoss On due to Presence', null));
+                }
+            }, actuator.settings.stromStossResendTime * 1000, this));
+        }
+        utils_1.Utils.guardedTimeout(() => {
+            actuator.setActuator(new command_1.ActuatorSetStateCommand(enums_1.CommandSource.Force, false, 'StromStoss Off', null));
+        }, 3000, this);
+    }
+    static setTimeBased(device, c) {
+        if (c.isManual ||
+            (c.time === enums_1.TimeOfDay.Daylight && device.settings.dayOn) ||
+            (c.time === enums_1.TimeOfDay.Night && device.settings.nightOn) ||
+            (c.time === enums_1.TimeOfDay.BeforeSunrise && device.settings.dawnOn) ||
+            (c.time === enums_1.TimeOfDay.AfterSunset && device.settings.duskOn)) {
+            device.setLight(new command_1.LampSetLightCommand(c, true, `SetLight due to TimeBased ${enums_1.TimeOfDay[c.time]}`, c.disableAutomaticCommand));
+        }
+    }
+    static checkUnBlock(device, command) {
+        let dontBlock = false;
+        if (command.containsType(enums_1.CommandType.ActuatorRestoreTargetAutomaticValueCommand)) {
+            // We are restoring the automatic value, so we don't want to block the device
+            return true;
+        }
+        if (command.isForceAction &&
+            device.settings.resetToAutomaticOnForceOffAfterForceOn &&
+            !command.on &&
+            device.blockAutomationHandler.automaticBlockActive) {
+            dontBlock = true;
+            const liftCommand = new command_1.BlockAutomaticLiftBlockCommand(command, 'Reset Automatic Block as we are turning off manually after a force on');
+            liftCommand.overrideCommandSource = enums_1.CommandSource.Automatic;
+            device.blockAutomationHandler.liftAutomaticBlock(liftCommand);
+        }
+        return dontBlock;
+    }
+    static toggleLight(device, c) {
+        var _a;
+        const newVal = device.queuedValue !== null ? !device.queuedValue : !device.actuatorOn;
+        if (newVal && c.time === undefined && c.calculateTime && device.room !== undefined) {
+            c.time = services_1.TimeCallbackService.dayType((_a = device.room) === null || _a === void 0 ? void 0 : _a.settings.lampOffset);
+        }
+        if (newVal && c.time !== undefined) {
+            device.setTimeBased(new command_1.LampSetTimeBasedCommand(c, c.time, '', c.isForceAction ? undefined : null));
+            return true;
+        }
+        device.setLight(new command_1.LampSetLightCommand(c, newVal, '', c.isForceAction ? undefined : null));
+        return newVal;
+    }
+    static checkBlockActive(device, c) {
+        if (!c.isForceAction && device.blockAutomationHandler.automaticBlockActive) {
+            device.log(enums_1.LogLevel.Debug, `Skip command to ${c.on} as it is locked until ${new Date(device.blockAutomationHandler.automaticBlockedUntil).toLocaleTimeString('de-DE')}; command Log: ${c.logMessage}`);
+            device.targetAutomaticState = c.on;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Check if the dimmer is already in the desired state thus allowing to skip this command
+     * @param {iDimmableLamp} device - The device to check
+     * @param {DimmerSetLightCommand} c - The command to check
+     * @returns {boolean} - True if the command can be skipped
+     */
+    static canDimmerChangeBeSkipped(device, c) {
+        if (c.isForceAction) {
+            return false;
+        }
+        if (!this.canActuatorChangeBeSkipped(device, c, true)) {
+            return false;
+        }
+        if (c.brightness !== device.brightness) {
+            return false;
+        }
+        device.log(enums_1.LogLevel.DeepTrace, `Light command can be skipped as the device is already in desired state: ${c.logMessage}`, enums_1.LogDebugType.SkipUnchangedActuatorCommand);
+        return true;
+    }
+    static canActuatorChangeBeSkipped(device, c, noLog = false) {
+        if (c.isForceAction) {
+            return false;
+        }
+        if ((device.queuedValue === null && device.actuatorOn !== c.on) ||
+            (device.queuedValue !== null && c.on === device.queuedValue)) {
+            return false;
+        }
+        if (!noLog) {
+            device.log(enums_1.LogLevel.DeepTrace, `Light command can be skipped as device is already in desired state; command: ${c.logMessage}`, enums_1.LogDebugType.SkipUnchangedActuatorCommand);
+        }
+        return true;
+    }
+    static setActuator(device, c) {
+        if (device.settings.isStromStoss &&
+            c.on &&
+            c.containsType(enums_1.CommandType.ActuatorRestoreTargetAutomaticValueCommand)) {
+            // Don't restore automatic state on Strommstoss-Relais as this might result in a loop.
+            return;
+        }
+        const dontBlock = LampUtils.checkUnBlock(device, c);
+        if (LampUtils.checkBlockActive(device, c)) {
+            return;
+        }
+        if (c.isAutomaticAction) {
+            // Preserve the target state for the automatic handler, as
+            device.targetAutomaticState = c.on;
+        }
+        if (LampUtils.canActuatorChangeBeSkipped(device, c)) {
+            return;
+        }
+        device.queuedValue = c.on;
+        device.writeActuatorStateToDevice(new command_1.ActuatorWriteStateToDeviceCommand(c, c.on));
+        if (device.settings.isStromStoss && c.on) {
+            c.disableAutomaticCommand = new command_1.BlockAutomaticCommand(c, 3000, 'StromStoss Off');
+            LampUtils.stromStossOn(device);
+        }
+        if (dontBlock || c.disableAutomaticCommand === null) {
+            return;
+        }
+        if (dontBlock) {
+            return;
+        }
+        if (c.disableAutomaticCommand === undefined && c.isForceAction) {
+            c.disableAutomaticCommand = device.settings.buildBlockAutomaticCommand(c);
+        }
+        if (c.disableAutomaticCommand) {
+            device.blockAutomationHandler.disableAutomatic(c.disableAutomaticCommand);
+        }
+    }
+}
+exports.LampUtils = LampUtils;
+LampUtils.stromStossContinueTimeouts = new Map();

package/lib/devices/sharedFunctions/temperatureSensor.d.ts

@@ -0,0 +1,41 @@
+import { TemperatureSensorChangeAction } from '../../action';
+import { iTemperatureCollector, iTemperatureSensor } from '../../interfaces';
+export declare class TemperatureSensor implements iTemperatureSensor {
+    private readonly _device;
+    /** @inheritDoc */
+    readonly jsonOmitKeys: string[];
+    /**
+     * The current room temperature as a number in Celsius
+     */
+    roomTemperature: number;
+    /**
+     * Temperature correction coefficient to mitigate outdoor temperature, e.g. if this is closely placed to a window.
+     * @remarks Default: 0 and difference to 21°C
+     * @example With outdoor temp of 10°C and a coefficient of 0.5, the temperature correction will be +5.5°C
+     */
+    outdoorTemperatureCorrectionCoefficient: number;
+    /**
+     * The interval to persist the temperature sensor information
+     */
+    private readonly _persistTemperatureSensorInterval;
+    private _temperature;
+    private _temperaturCallbacks;
+    /**
+     * The last time the temperature sensor was seen.
+     */
+    lastSeen: number;
+    constructor(_device: iTemperatureCollector);
+    get temperature(): number;
+    set temperature(val: number);
+    /**
+     * Persists the current temperature sensor information to the database
+     */
+    persist(): void;
+    /**
+     * Adds a callback to be called when the temperature changes
+     * @param pCallback - The callback to be called
+     */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    dispose(): void;
+    toJSON(): Partial<TemperatureSensor>;
+}

package/lib/devices/sharedFunctions/temperatureSensor.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemperatureSensor = void 0;
+const action_1 = require("../../action");
+const interfaces_1 = require("../../interfaces");
+const utils_1 = require("../../utils");
+const weather_1 = require("../../services/weather");
+const services_1 = require("../../services");
+class TemperatureSensor {
+    constructor(_device) {
+        this._device = _device;
+        /** @inheritDoc */
+        this.jsonOmitKeys = ['_device'];
+        /**
+         * The current room temperature as a number in Celsius
+         */
+        this.roomTemperature = interfaces_1.UNDEFINED_TEMP_VALUE;
+        /**
+         * Temperature correction coefficient to mitigate outdoor temperature, e.g. if this is closely placed to a window.
+         * @remarks Default: 0 and difference to 21°C
+         * @example With outdoor temp of 10°C and a coefficient of 0.5, the temperature correction will be +5.5°C
+         */
+        this.outdoorTemperatureCorrectionCoefficient = 0;
+        /**
+         * The interval to persist the temperature sensor information
+         */
+        this._persistTemperatureSensorInterval = utils_1.Utils.guardedInterval(() => {
+            this.persist();
+        }, 5 * 60 * 1000, this, false);
+        this._temperature = interfaces_1.UNDEFINED_TEMP_VALUE;
+        this._temperaturCallbacks = [];
+        /**
+         * The last time the temperature sensor was seen.
+         */
+        this.lastSeen = 0;
+    }
+    get temperature() {
+        if (utils_1.Utils.nowMS() - this.lastSeen > 60 * 60 * 1000) {
+            // Temperature sensor hasn't been seen in an hour --> Don't to trust it
+            return interfaces_1.UNDEFINED_TEMP_VALUE;
+        }
+        return this._temperature;
+    }
+    set temperature(val) {
+        this.lastSeen = utils_1.Utils.nowMS();
+        let correctedValue = val;
+        if (this.outdoorTemperatureCorrectionCoefficient !== 0 && weather_1.WeatherService.currentTemp !== interfaces_1.UNDEFINED_TEMP_VALUE) {
+            correctedValue = val + this.outdoorTemperatureCorrectionCoefficient * (21 - weather_1.WeatherService.currentTemp);
+        }
+        this._temperature = correctedValue;
+        for (const cb of this._temperaturCallbacks) {
+            cb(new action_1.TemperatureSensorChangeAction(this._device, correctedValue));
+        }
+    }
+    /**
+     * Persists the current temperature sensor information to the database
+     */
+    persist() {
+        var _a;
+        (_a = services_1.Persistence.dbo) === null || _a === void 0 ? void 0 : _a.persistTemperatureSensor(this._device);
+    }
+    /**
+     * Adds a callback to be called when the temperature changes
+     * @param pCallback - The callback to be called
+     */
+    addTempChangeCallback(pCallback) {
+        this._temperaturCallbacks.push(pCallback);
+        if (this._temperature > interfaces_1.UNDEFINED_TEMP_VALUE) {
+            pCallback(new action_1.TemperatureSensorChangeAction(this._device, this._temperature));
+        }
+    }
+    dispose() {
+        if (this._persistTemperatureSensorInterval) {
+            clearInterval(this._persistTemperatureSensorInterval);
+        }
+    }
+    toJSON() {
+        return utils_1.Utils.jsonFilter(this, this.jsonOmitKeys);
+    }
+}
+exports.TemperatureSensor = TemperatureSensor;

package/lib/devices/shelly/shellyActuator.d.ts

@@ -0,0 +1,34 @@
+import { ActuatorSetStateCommand, ActuatorToggleCommand, ActuatorWriteStateToDeviceCommand, RestoreTargetAutomaticValueCommand } from '../../command';
+import { ShellyDevice } from './shellyDevice';
+import { iActuator } from '../../interfaces';
+import { BlockAutomaticHandler } from '../../services';
+import { ActuatorSettings } from '../../settingsObjects';
+import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
+export declare class ShellyActuator extends ShellyDevice implements iActuator {
+    /** @inheritDoc */
+    readonly blockAutomationHandler: BlockAutomaticHandler;
+    /** @inheritDoc */
+    targetAutomaticState: boolean;
+    /** @inheritDoc */
+    settings: ActuatorSettings;
+    /** @inheritDoc */
+    queuedValue: boolean | null;
+    private _lastPersist;
+    private readonly _actuatorOnStateId;
+    private _actuatorOn;
+    constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
+    get actuatorOn(): boolean;
+    /** @inheritDoc */
+    restoreTargetAutomaticValue(c: RestoreTargetAutomaticValueCommand): void;
+    /** @inheritDoc */
+    update(idSplit: string[], state: ioBroker.State, initial?: boolean, handledByChildObject?: boolean): void;
+    /** @inheritDoc */
+    setActuator(command: ActuatorSetStateCommand): void;
+    /** @inheritDoc */
+    persist(): void;
+    /** @inheritDoc */
+    toggleActuator(command: ActuatorToggleCommand): boolean;
+    /** @inheritDoc */
+    writeActuatorStateToDevice(c: ActuatorWriteStateToDeviceCommand): void;
+}

package/lib/devices/shelly/shellyActuator.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShellyActuator = void 0;
+const command_1 = require("../../command");
+const shellyDevice_1 = require("./shellyDevice");
+const services_1 = require("../../services");
+const settingsObjects_1 = require("../../settingsObjects");
+const enums_1 = require("../../enums");
+const sharedFunctions_1 = require("../sharedFunctions");
+const utils_1 = require("../../utils");
+class ShellyActuator extends shellyDevice_1.ShellyDevice {
+    constructor(pInfo) {
+        super(pInfo, enums_1.DeviceType.ShellyActuator);
+        /** @inheritDoc */
+        this.targetAutomaticState = false;
+        /** @inheritDoc */
+        this.settings = new settingsObjects_1.ActuatorSettings();
+        /** @inheritDoc */
+        this.queuedValue = null;
+        this._lastPersist = 0;
+        this._actuatorOn = false;
+        this.deviceCapabilities.push(enums_1.DeviceCapability.actuator);
+        this.deviceCapabilities.push(enums_1.DeviceCapability.blockAutomatic);
+        this._actuatorOnStateId = `${this.info.fullID}.Relay0.Switch`;
+        this.blockAutomationHandler = new services_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this), this.log.bind(this));
+    }
+    /** @inheritDoc */
+    get actuatorOn() {
+        return this._actuatorOn;
+    }
+    /** @inheritDoc */
+    restoreTargetAutomaticValue(c) {
+        this.setActuator(new command_1.ActuatorSetStateCommand(c, this.targetAutomaticState));
+    }
+    /** @inheritDoc */
+    update(idSplit, state, initial = false, handledByChildObject = false) {
+        if (!handledByChildObject) {
+            this.log(enums_1.LogLevel.DeepTrace, `Aktuator Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
+        }
+        this.queuedValue = null;
+        super.update(idSplit, state, initial, true);
+        if (idSplit[3] === 'Relay0') {
+            if (idSplit[4] === 'Switch') {
+                this._actuatorOn = state.val;
+                if (!initial) {
+                    this.persist();
+                }
+            }
+        }
+    }
+    /** @inheritDoc */
+    setActuator(command) {
+        if (this._actuatorOnStateId === '') {
+            this.log(enums_1.LogLevel.Error, 'Keine Switch ID bekannt.');
+            return;
+        }
+        sharedFunctions_1.LampUtils.setActuator(this, command);
+    }
+    /** @inheritDoc */
+    persist() {
+        var _a;
+        const now = utils_1.Utils.nowMS();
+        if (this._lastPersist + 1000 > now) {
+            return;
+        }
+        (_a = this.dbo) === null || _a === void 0 ? void 0 : _a.persistActuator(this);
+        this._lastPersist = now;
+    }
+    /** @inheritDoc */
+    toggleActuator(command) {
+        const newVal = this.queuedValue !== null ? !this.queuedValue : !this._actuatorOn;
+        const setStateCommand = new command_1.ActuatorSetStateCommand(command, this.queuedValue !== null ? !this.queuedValue : !this.actuatorOn, 'Due to ActuatorToggle', command.isForceAction ? undefined : null);
+        this.setActuator(setStateCommand);
+        return newVal;
+    }
+    /** @inheritDoc */
+    writeActuatorStateToDevice(c) {
+        this.log(enums_1.LogLevel.Debug, c.logMessage, enums_1.LogDebugType.SetActuator);
+        this.setState(this._actuatorOnStateId, c.stateValue, undefined, (err) => {
+            this.log(enums_1.LogLevel.Error, `Lampe schalten ergab Fehler: ${err}`);
+        });
+    }
+}
+exports.ShellyActuator = ShellyActuator;

package/lib/devices/shelly/shellyDevice.d.ts

@@ -0,0 +1,13 @@
+import { IoBrokerBaseDevice } from '../IoBrokerBaseDevice';
+import { iDisposable } from '../../interfaces';
+import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
+import { DeviceType } from '../../enums';
+export declare class ShellyDevice extends IoBrokerBaseDevice implements iDisposable {
+    private _lastUpdate;
+    get lastUpdate(): Date;
+    constructor(pInfo: IoBrokerDeviceInfo, pType: DeviceType);
+    /** @inheritDoc */
+    update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverride?: boolean): void;
+    /** @inheritDoc */
+    dispose(): void;
+}

package/lib/devices/shelly/shellyDevice.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShellyDevice = void 0;
+const IoBrokerBaseDevice_1 = require("../IoBrokerBaseDevice");
+const enums_1 = require("../../enums");
+class ShellyDevice extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
+    get lastUpdate() {
+        return this._lastUpdate;
+    }
+    constructor(pInfo, pType) {
+        super(pInfo, pType);
+        this._lastUpdate = new Date(0);
+    }
+    /** @inheritDoc */
+    update(idSplit, state, initial = false, pOverride = false) {
+        this.log(enums_1.LogLevel.DeepTrace, `Shelly: ${initial ? 'Initiales ' : ''}Update: ID: ${idSplit.join('.')} JSON: ${JSON.stringify(state)}`);
+        if (!pOverride) {
+            this.log(enums_1.LogLevel.Warn, `Keine Update Überschreibung:\n\tID: ${idSplit.join('.')}\n\tData: ${JSON.stringify(state)}`);
+        }
+        const stateLastUpdate = new Date(state.ts);
+        if (stateLastUpdate > this._lastUpdate) {
+            this._lastUpdate = stateLastUpdate;
+        }
+        this.stateMap.set(idSplit[3], state);
+        const individualCallbacks = this.individualStateCallbacks.get(idSplit[3]);
+        if (individualCallbacks !== undefined) {
+            for (const cb of individualCallbacks) {
+                cb(state.val);
+            }
+        }
+    }
+    /** @inheritDoc */
+    dispose() {
+        // Nothing yet
+    }
+}
+exports.ShellyDevice = ShellyDevice;

package/lib/devices/shelly/shellyTrv.d.ts

@@ -0,0 +1,81 @@
+import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
+import { ShellyDevice } from './shellyDevice';
+import { iBatteryDevice, iHeater, iHeaterSettings, iTemperatureCollector } from '../../interfaces';
+import { Battery, TemperatureSensor } from '../sharedFunctions';
+import { HandleChangeAction, TemperatureSensorChangeAction } from '../../action';
+export declare class ShellyTrv extends ShellyDevice implements iHeater, iTemperatureCollector, iBatteryDevice {
+    /** @inheritDoc */
+    readonly battery: Battery;
+    /** @inheritDoc */
+    settings: iHeaterSettings;
+    /** @inheritDoc */
+    temperatureSensor: TemperatureSensor;
+    /** @inheritDoc */
+    readonly persistHeaterInterval: NodeJS.Timeout;
+    protected _seasonTurnOff: boolean;
+    protected _roomTemperature: number;
+    private _automaticMode;
+    private _iAutomaticInterval;
+    private _initialSeasonCheckDone;
+    private _lastRecalc;
+    private _level;
+    private _minimumValveLevel;
+    private _recalcTimeout;
+    private _targetTempVal;
+    private _desiredTemperatur;
+    private _useExternalTemperatureEnabled;
+    private _pidController;
+    private readonly _minumumLevelId;
+    private readonly _setAutomaticModeId;
+    private readonly _setExternalTempId;
+    private readonly _setEnableExternalTempId;
+    private readonly _setPointTemperaturID;
+    private readonly _setWindowOpenID;
+    private readonly _valvePosId;
+    private _windowOpen;
+    constructor(pInfo: IoBrokerDeviceInfo);
+    /** @inheritDoc */
+    get batteryLevel(): number;
+    get minimumLevel(): number;
+    /** @inheritDoc */
+    get seasonTurnOff(): boolean;
+    /** @inheritDoc */
+    set seasonTurnOff(value: boolean);
+    /** @inheritDoc */
+    get desiredTemperature(): number;
+    /** @inheritDoc */
+    set desiredTemperature(val: number);
+    /** @inheritDoc */
+    get iLevel(): number;
+    /** @inheritDoc */
+    get iTemperature(): number;
+    /** @inheritDoc */
+    get sTemperature(): string;
+    /** @inheritDoc */
+    get roomTemperature(): number;
+    /** @inheritDoc */
+    get windowOpen(): boolean;
+    private set roomTemperatur(value);
+    /** @inheritDoc */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    /** @inheritDoc */
+    checkAutomaticChange(): void;
+    /** @inheritDoc */
+    onTemperaturChange(newTemperatur: number): void;
+    /** @inheritDoc */
+    persistHeater(): void;
+    /** @inheritDoc */
+    update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
+    /** @inheritDoc */
+    dispose(): void;
+    protected getNextPidLevel(): number;
+    private checkSeasonTurnOff;
+    onHandleChange(_action: HandleChangeAction): void;
+    private onWindowOpenChange;
+    private recalcLevel;
+    private setMode;
+    private setExternalTemperature;
+    private setExternalTemperatureEnabled;
+    private setValve;
+    private setMinimumLevel;
+}