hoffmation-base 1.0.58 → 1.0.61-alpha.0

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import { Devices, iConfig, ioBrokerMain, iSpeaker } from './server';
 export * from './models/index';
 export * from './server/index';
+export * from './liquid-pid';
 export declare class HoffmationInitializationObject {
     config: iConfig;
     constructor(config: iConfig);

package/lib/index.js

@@ -19,6 +19,7 @@ const server_1 = require("./server");
 const models_1 = require("./models");
 __exportStar(require("./models/index"), exports);
 __exportStar(require("./server/index"), exports);
+__exportStar(require("./liquid-pid"), exports);
 class HoffmationInitializationObject {
     constructor(config) {
         this.config = config;

package/lib/server/config/iConfig.d.ts

@@ -20,9 +20,19 @@ export interface iRestSettings {
     active: boolean;
     port?: number;
 }
+export interface iEspresenseSettings {
+    mqttInstance: number;
+    roomMapping: {
+        [devName: string]: string;
+    };
+    deviceNaming: {
+        [folderId: string]: string;
+    };
+}
 export interface iConfig {
     asusConfig?: iAsusConfig;
     daikin?: iDaikinSettings;
+    espresense?: iEspresenseSettings;
     wattagePrice?: number;
     injectWattagePrice?: number;
     ioBrokerUrl: string;

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

@@ -15,5 +15,6 @@ export declare enum DeviceCapability {
     vibrationSensor = 13,
     speaker = 14,
     handleSensor = 15,
-    batteryDriven = 16
+    batteryDriven = 16,
+    bluetoothDetector = 17
 }

package/lib/server/devices/DeviceCapability.js

@@ -20,4 +20,5 @@ var DeviceCapability;
     DeviceCapability[DeviceCapability["speaker"] = 14] = "speaker";
     DeviceCapability[DeviceCapability["handleSensor"] = 15] = "handleSensor";
     DeviceCapability[DeviceCapability["batteryDriven"] = 16] = "batteryDriven";
+    DeviceCapability[DeviceCapability["bluetoothDetector"] = 17] = "bluetoothDetector";
 })(DeviceCapability = exports.DeviceCapability || (exports.DeviceCapability = {}));

package/lib/server/devices/baseDeviceInterfaces/iBluetoothDetector.d.ts

@@ -0,0 +1,11 @@
+import { iBaseDevice } from './iBaseDevice';
+import { ProximityCallback } from '../espresense';
+export interface iBluetoothDetector extends iBaseDevice {
+    /**
+     * Add callback to react on a specified device entering/leaving a given zone
+     * @param cb
+     */
+    addProximityCallback(cb: ProximityCallback): void;
+    distanceOfDevice(deviceName: string): number | undefined;
+    isDevicePresent(deviceName: string, maxDistance: number): boolean;
+}

package/lib/server/devices/baseDeviceInterfaces/iBluetoothDetector.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -35,5 +35,6 @@ export declare enum DeviceType {
     JsEnergyManager = 301,
     WledDevice = 1001,
     Daikin = 2001,
-    Sonos = 3001
+    Sonos = 3001,
+    Espresense = 4001
 }

package/lib/server/devices/deviceType.js

@@ -40,4 +40,5 @@ var DeviceType;
     DeviceType[DeviceType["WledDevice"] = 1001] = "WledDevice";
     DeviceType[DeviceType["Daikin"] = 2001] = "Daikin";
     DeviceType[DeviceType["Sonos"] = 3001] = "Sonos";
+    DeviceType[DeviceType["Espresense"] = 4001] = "Espresense";
 })(DeviceType = exports.DeviceType || (exports.DeviceType = {}));

package/lib/server/devices/deviceUpdater.js

@@ -4,6 +4,7 @@ exports.DeviceUpdater = void 0;
 const services_1 = require("../services");
 const models_1 = require("../../models");
 const devices_1 = require("./devices");
+const espresense_1 = require("./espresense");
 class DeviceUpdater {
     constructor(pDevices) {
         this.devices = pDevices;
@@ -25,6 +26,9 @@ class DeviceUpdater {
         const idSplit = id.split('.');
         if (idSplit.length < 2)
             return;
+        if (idSplit[0] == 'mqtt' && idSplit[2] == 'espresense') {
+            espresense_1.EspresenseCoordinator.update(idSplit, state);
+        }
         const device = devices_1.Devices.alLDevices[`${idSplit[0]}-${idSplit[2]}`];
         if (typeof device === 'undefined' || device.update === undefined) {
             return;

package/lib/server/devices/espresense/detectedBluetoothDevice.d.ts

@@ -0,0 +1,8 @@
+export declare class DetectedBluetoothDevice {
+    id: string;
+    name: string;
+    distance: number | undefined;
+    lastUpdate: number;
+    previousDistance: number | undefined;
+    constructor(id: string, name: string);
+}

package/lib/server/devices/espresense/detectedBluetoothDevice.js

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

package/lib/server/devices/espresense/espresenseCoordinator.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="iobroker" />
+import { iEspresenseSettings } from '../../config';
+export declare class EspresenseCoordinator {
+    static baseId: string;
+    private static espDeviceMap;
+    static initialize(settings: iEspresenseSettings): void;
+    static update(idSplit: string[], state: ioBroker.State): void;
+}

package/lib/server/devices/espresense/espresenseCoordinator.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EspresenseCoordinator = void 0;
+const models_1 = require("../../../models");
+const services_1 = require("../../services");
+const espresenseDevice_1 = require("./espresenseDevice");
+class EspresenseCoordinator {
+    static initialize(settings) {
+        this.baseId = `mqtt.${settings.mqttInstance}.espresense`;
+        for (const espDevName of Object.keys(settings.roomMapping)) {
+            const roomName = settings.roomMapping[espDevName];
+            const room = services_1.API.getRoom(roomName);
+            if (room === undefined) {
+                services_1.ServerLogService.writeLog(models_1.LogLevel.Error, `Declared Espresense Room "${roomName}" for Espresense "${espDevName}" not found`);
+                continue;
+            }
+            const espDev = new espresenseDevice_1.EspresenseDevice(espDevName, room);
+            this.espDeviceMap.set(espDevName, espDev);
+        }
+    }
+    static update(idSplit, state) {
+        if (idSplit.length < 6 || idSplit[3] !== 'devices') {
+            return;
+        }
+        const devName = idSplit[5];
+        const dev = this.espDeviceMap.get(devName !== null && devName !== void 0 ? devName : '');
+        if (dev === undefined) {
+            return;
+        }
+        dev.update(idSplit[4], state);
+    }
+}
+exports.EspresenseCoordinator = EspresenseCoordinator;
+EspresenseCoordinator.espDeviceMap = new Map();

package/lib/server/devices/espresense/espresenseDevice.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="iobroker" />
+import { iBaseDevice } from '../baseDeviceInterfaces';
+import { iBluetoothDetector } from '../baseDeviceInterfaces/iBluetoothDetector';
+import { DeviceCapability } from '../DeviceCapability';
+import { LogLevel, RoomBase } from '../../../models';
+import { DeviceInfo } from '../DeviceInfo';
+import { DeviceType } from '../deviceType';
+import { LogDebugType } from '../../services';
+import { ProximityCallback } from './proximityCallback';
+export declare class EspresenseDevice implements iBaseDevice, iBluetoothDetector {
+    readonly deviceCapabilities: DeviceCapability[];
+    deviceType: DeviceType;
+    readonly name: string;
+    room: RoomBase | undefined;
+    private deviceMap;
+    private proximityCallback;
+    constructor(name: string, room: RoomBase);
+    protected _info: DeviceInfo;
+    get info(): DeviceInfo;
+    set info(info: DeviceInfo);
+    get id(): string;
+    distanceOfDevice(deviceName: string): number | undefined;
+    isDevicePresent(deviceName: string, maxDistance: number): boolean;
+    update(devName: string, state: ioBroker.State): void;
+    log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    toJSON(): Partial<iBaseDevice>;
+    addProximityCallback(cb: ProximityCallback): void;
+    private addDeviceTracking;
+    private checkCbs;
+}

package/lib/server/devices/espresense/espresenseDevice.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EspresenseDevice = void 0;
+const DeviceCapability_1 = require("../DeviceCapability");
+const models_1 = require("../../../models");
+const DeviceInfo_1 = require("../DeviceInfo");
+const deviceType_1 = require("../deviceType");
+const services_1 = require("../../services");
+const devices_1 = require("../devices");
+const detectedBluetoothDevice_1 = require("./detectedBluetoothDevice");
+class EspresenseDevice {
+    constructor(name, room) {
+        this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.bluetoothDetector];
+        this.deviceType = deviceType_1.DeviceType.Espresense;
+        this.deviceMap = new Map();
+        this.proximityCallback = new Map();
+        this.name = name;
+        this._info = new DeviceInfo_1.DeviceInfo();
+        this._info.fullName = `Espresense ${room.roomName} ${name}`;
+        this._info.customName = `Espresense ${name}`;
+        this._info.room = room.roomName;
+        this._info.allDevicesKey = `espresense-${room.roomName}-${name}`;
+        devices_1.Devices.alLDevices[this._info.allDevicesKey] = this;
+    }
+    get info() {
+        return this._info;
+    }
+    set info(info) {
+        this._info = info;
+    }
+    get id() {
+        var _a;
+        return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `espresense-${this.info.room}-${this.info.customName}`;
+    }
+    distanceOfDevice(deviceName) {
+        for (const dev of this.deviceMap.values()) {
+            if (dev.name == deviceName) {
+                return dev.distance;
+            }
+        }
+        return undefined;
+    }
+    isDevicePresent(deviceName, maxDistance) {
+        var _a;
+        return ((_a = this.distanceOfDevice(deviceName)) !== null && _a !== void 0 ? _a : 99) < maxDistance;
+    }
+    update(devName, state) {
+        let data = null;
+        try {
+            data = JSON.parse(state.val);
+        }
+        catch (e) {
+            this.log(models_1.LogLevel.Error, `Recieved malformed update data: ${state.val}`);
+            return;
+        }
+        let dev = this.deviceMap.get(devName);
+        if (dev === undefined) {
+            dev = this.addDeviceTracking(devName, 'Unknown');
+        }
+        dev.lastUpdate = services_1.Utils.nowMS();
+        dev.previousDistance = dev.distance;
+        dev.distance = data.distance;
+        this.checkCbs(dev);
+    }
+    log(level, message, debugType = services_1.LogDebugType.None) {
+        var _a, _b;
+        services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
+            debugType: debugType,
+            room: (_b = (_a = this.room) === null || _a === void 0 ? void 0 : _a.roomName) !== null && _b !== void 0 ? _b : '',
+            deviceId: this.name,
+            deviceName: this.name,
+        });
+    }
+    toJSON() {
+        return services_1.Utils.jsonFilter(this);
+    }
+    addProximityCallback(cb) {
+        let currentValue = this.proximityCallback.get(cb.deviceName);
+        if (currentValue == undefined) {
+            currentValue = [];
+        }
+        currentValue.push(cb);
+        this.proximityCallback.set(cb.deviceName, currentValue);
+    }
+    addDeviceTracking(devName, translatedName = 'Unknown') {
+        const dev = new detectedBluetoothDevice_1.DetectedBluetoothDevice(devName, translatedName);
+        this.deviceMap.set(devName, dev);
+        return dev;
+    }
+    checkCbs(dev) {
+        var _a, _b;
+        const cbs = this.proximityCallback.get(dev.name);
+        if (cbs === undefined) {
+            return;
+        }
+        const distance = dev.distance;
+        const hasPreviousDstance = dev.previousDistance !== undefined;
+        for (const cb of cbs) {
+            if (distance === undefined) {
+                if (hasPreviousDstance) {
+                    cb.callback(false, undefined);
+                }
+                continue;
+            }
+            if (distance > cb.distanceTrigger && ((_a = dev.previousDistance) !== null && _a !== void 0 ? _a : 99) < cb.distanceTrigger) {
+                cb.callback(false, distance);
+            }
+            else if (distance < cb.distanceTrigger && ((_b = dev.previousDistance) !== null && _b !== void 0 ? _b : 0) > cb.distanceTrigger) {
+                cb.callback(true, distance);
+            }
+        }
+    }
+}
+exports.EspresenseDevice = EspresenseDevice;

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

@@ -0,0 +1,4 @@
+export * from './detectedBluetoothDevice';
+export * from './espresenseCoordinator';
+export * from './espresenseDevice';
+export * from './proximityCallback';

package/lib/server/devices/espresense/index.js

@@ -0,0 +1,20 @@
+"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 __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 });
+__exportStar(require("./detectedBluetoothDevice"), exports);
+__exportStar(require("./espresenseCoordinator"), exports);
+__exportStar(require("./espresenseDevice"), exports);
+__exportStar(require("./proximityCallback"), exports);

package/lib/server/devices/espresense/proximityCallback.d.ts

@@ -0,0 +1,6 @@
+export declare class ProximityCallback {
+    readonly deviceName: string;
+    readonly distanceTrigger: number;
+    readonly callback: (present: boolean, distance: number | undefined) => void;
+    constructor(deviceName: string, distanceTrigger: number, callback: (present: boolean, distance: number | undefined) => void);
+}

package/lib/server/devices/espresense/proximityCallback.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProximityCallback = void 0;
+class ProximityCallback {
+    constructor(deviceName, distanceTrigger, callback) {
+        this.deviceName = deviceName;
+        this.distanceTrigger = distanceTrigger;
+        this.callback = callback;
+    }
+}
+exports.ProximityCallback = ProximityCallback;

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

@@ -1,5 +1,6 @@
 export * from './baseDeviceInterfaces/index';
 export * from './button/index';
+export * from './espresense/index';
 export * from './groups/index';
 export * from './hmIPDevices/index';
 export * from './jsObject/index';

package/lib/server/devices/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./baseDeviceInterfaces/index"), exports);
 __exportStar(require("./button/index"), exports);
+__exportStar(require("./espresense/index"), exports);
 __exportStar(require("./groups/index"), exports);
 __exportStar(require("./hmIPDevices/index"), exports);
 __exportStar(require("./jsObject/index"), exports);

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

@@ -5,7 +5,7 @@ import { iBatteryDevice, iHeater } from '../../baseDeviceInterfaces';
 import { HeaterSettings, TemperatureSettings } from '../../../../models';
 import { DeviceType } from '../../deviceType';
 import { IoBrokerDeviceInfo } from '../../IoBrokerDeviceInfo';
-import { PIDController } from 'liquid-pid';
+import { PIDController } from '../../../../liquid-pid';
 export declare class ZigbeeHeater extends ZigbeeDevice implements iHeater, iBatteryDevice {
     settings: HeaterSettings;
     battery: number;

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

@@ -6,7 +6,7 @@ const baseDeviceInterfaces_1 = require("../../baseDeviceInterfaces");
 const models_1 = require("../../../../models");
 const services_1 = require("../../../services");
 const DeviceCapability_1 = require("../../DeviceCapability");
-const liquid_pid_1 = require("liquid-pid");
+const liquid_pid_1 = require("../../../../liquid-pid");
 class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
     constructor(pInfo, pType) {
         super(pInfo, pType);
@@ -16,7 +16,7 @@ class ZigbeeHeater extends zigbeeDevice_1.ZigbeeDevice {
         this._initialSeasonCheckDone = false;
         this._level = 0;
         this._setPointTemperaturID = '';
-        this._temperatur = 0;
+        this._temperatur = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this._desiredTemperatur = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this._pidController = new liquid_pid_1.PIDController({
             temp: {

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

@@ -4,7 +4,6 @@ import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 export declare class ZigbeeEuroHeater extends ZigbeeHeater {
     private _setLocalTempCalibrationId;
     private _targetTempVal;
-    private _localTempVal;
     private _localDiffTempVal;
     private _setModeId;
     private _valvePosId;

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

@@ -10,7 +10,6 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.ZigbeeEuroHeater);
         this._targetTempVal = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
-        this._localTempVal = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
         this._localDiffTempVal = 0;
         this._lastRecalc = 0;
         this._mode = 1;
@@ -55,10 +54,10 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
         const tempChangeMs = (_b = (_a = this.stateMap.get('local_temp')) === null || _a === void 0 ? void 0 : _a.lc) !== null && _b !== void 0 ? _b : 0;
         const calibChangeMs = (_d = (_c = this.stateMap.get('local_temp_calibration')) === null || _c === void 0 ? void 0 : _c.lc) !== null && _d !== void 0 ? _d : 0;
         if (tempChangeMs < calibChangeMs) {
-            return this._targetTempVal - (this._localTempVal + this._localDiffTempVal);
+            return this._targetTempVal - (this._temperatur + this._localDiffTempVal);
         }
         else {
-            return this._targetTempVal - this._localTempVal;
+            return this._targetTempVal - this._temperatur;
         }
     }
     update(idSplit, state, initial = false) {
@@ -69,7 +68,7 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
                 break;
             case 'local_temp':
                 this.log(models_1.LogLevel.Trace, `Euro Valve Local_Temp Update for ${this.info.customName} to "${state.val}"`);
-                this._localTempVal = state.val;
+                this._temperatur = state.val;
                 if (!initial)
                     this.checkTempDiff();
                 break;
@@ -78,6 +77,9 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
                 this._localDiffTempVal = state.val;
                 if (!initial)
                     this.checkTempDiff();
+                if (initial && state.val !== 0) {
+                    this.setLocalDiff(0);
+                }
                 break;
             case 'spz_trv_mode':
                 this.log(models_1.LogLevel.Trace, `Euro Valve mode Update for ${this.info.customName} to "${state.val}"`);
@@ -138,7 +140,7 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
         }
         const newLocalDiff = Math.sign(desiredDiff) * -9;
         this.setLocalDiff(newLocalDiff);
-        this.setTargetTemperatur(this._localTempVal + this._roomTemperatur + newLocalDiff + this.desiredTemperature);
+        this.setTargetTemperatur(this._temperatur + this._roomTemperatur + newLocalDiff + this.desiredTemperature);
     }
     setLocalDiff(newLocalDiff) {
         this.log(models_1.LogLevel.Debug, `Setting new Local Calibration Diff (${newLocalDiff}) for Euro Valve`);