hoffmation-base 3.0.0-alpha.8 → 3.0.0-alpha.81

package/lib/server/devices/deviceType.js

@@ -45,7 +45,12 @@ var DeviceType;
     DeviceType[DeviceType["JsEnergyManager"] = 301] = "JsEnergyManager";
     DeviceType[DeviceType["RoomScene"] = 401] = "RoomScene";
     DeviceType[DeviceType["ShellyTrv"] = 402] = "ShellyTrv";
+    DeviceType[DeviceType["ShellyActuator"] = 403] = "ShellyActuator";
     DeviceType[DeviceType["TuyaGarageDoorOpener"] = 501] = "TuyaGarageDoorOpener";
+    DeviceType[DeviceType["SmartGardenValve"] = 601] = "SmartGardenValve";
+    DeviceType[DeviceType["SmartGardenMower"] = 602] = "SmartGardenMower";
+    DeviceType[DeviceType["SmartGardenSensor"] = 603] = "SmartGardenSensor";
+    DeviceType[DeviceType["VeluxShutter"] = 701] = "VeluxShutter";
     DeviceType[DeviceType["WledDevice"] = 1001] = "WledDevice";
     DeviceType[DeviceType["GoveeLed"] = 1002] = "GoveeLed";
     DeviceType[DeviceType["Daikin"] = 2001] = "Daikin";

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

@@ -1,8 +1,5 @@
 import { IDeviceUpdater } from './iDeviceUpdater';
-import { Devices } from './devices';
 export declare class DeviceUpdater implements IDeviceUpdater {
-    devices: Devices;
-    constructor(pDevices: Devices);
     updateObject(pId: string, pObj: ioBroker.Object): void;
     updateState(id: string, state: ioBroker.State, initial?: boolean): void;
 }

package/lib/server/devices/deviceUpdater.js

@@ -7,9 +7,6 @@ const devices_1 = require("./devices");
 const mqtt_1 = require("./mqtt");
 const IoBrokerDeviceInfo_1 = require("./IoBrokerDeviceInfo");
 class DeviceUpdater {
-    constructor(pDevices) {
-        this.devices = pDevices;
-    }
     updateObject(pId, pObj) {
         const idSplit = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.idSplitter(pId);
         if (idSplit.length < 2)
@@ -40,8 +37,33 @@ class DeviceUpdater {
             classifier = devices_1.Devices.IDENTIFIER_ZIGBEE;
             devId = idSplit[2].substring(2);
         }
-        const device = devices_1.Devices.alLDevices[`${classifier}-${devId}`];
+        else if (idSplit[0] == devices_1.Devices.IDENTIFIER_SMART_GARDEN) {
+            if (idSplit[1] === 'admin' ||
+                idSplit.length < 4 ||
+                idSplit[2].indexOf('LOCATION') !== 0 ||
+                idSplit[3].indexOf('DEVICE') !== 0) {
+                // This is no update for a smartgarden device
+                return;
+            }
+            classifier = devices_1.Devices.IDENTIFIER_SMART_GARDEN;
+            devId = idSplit[3].replace(/-2D/g, '-');
+        }
+        else if (idSplit[0] == devices_1.Devices.IDENTIFIER_VELUX) {
+            if (idSplit[1] === 'admin' || idSplit[2].indexOf('products') !== 0) {
+                // This is no update for a velux device
+                return;
+            }
+            classifier = devices_1.Devices.IDENTIFIER_VELUX;
+            devId = idSplit[3];
+        }
+        const allDevicesKey = `${classifier}-${devId}`;
+        const device = services_1.API.getDevice(allDevicesKey, false);
         if (typeof device === 'undefined' || device.update === undefined) {
+            // classifier == Devices.IDENTIFIER_SMART_GARDEN &&
+            //   ServerLogService.writeLog(
+            //     LogLevel.Warn,
+            //     `deviceUpdater.updateState('${id}', ${JSON.stringify(state)}'): Device ${allDevicesKey} type is "${typeof device}"`,
+            //   );
             return;
         }
         try {

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

@@ -3,18 +3,62 @@ import { iBaseDevice, iEnergyManager, iTemperatureSensor } from './baseDeviceInt
 import { Dachs } from './dachs';
 import { iConfig } from '../config';
 export declare class Devices {
-    static IDENTIFIER_HOMEMATIC: string;
-    static IDENTIFIER_JS: string;
-    static IDENTIFIER_Shelly: string;
-    static IDENTIFIER_TUYA: string;
-    static IDENTIFIER_ZIGBEE: string;
-    static IDENTIFIER_ZIGBEE2MQTT: string;
-    static IDENTIFIER_WLED: string;
+    /**
+     * A constant for the identifier of HM-IP Adapter devices
+     */
+    static readonly IDENTIFIER_HOMEMATIC: string;
+    /**
+     * A constant for the identifier of JavaScript Adapter devices
+     */
+    static readonly IDENTIFIER_JS: string;
+    /**
+     * A constant for the identifier of Shelly Adapter devices
+     */
+    static readonly IDENTIFIER_Shelly: string;
+    /**
+     * A constant for the identifier of Tuya Adapter devices
+     */
+    static readonly IDENTIFIER_TUYA: string;
+    /**
+     * A constant for the identifier of Zigbee Adapter devices
+     */
+    static readonly IDENTIFIER_ZIGBEE: string;
+    /**
+     * A constant for the identifier of Zigbee2Mqtt Adapter devices
+     */
+    static readonly IDENTIFIER_ZIGBEE2MQTT: string;
+    /**
+     * A constant for the identifier of WLED Adapter devices
+     */
+    static readonly IDENTIFIER_WLED: string;
+    /**
+     * A constant for the identifier of SmartGarden devices.
+     */
+    static readonly IDENTIFIER_SMART_GARDEN: string;
+    /**
+     * A constant for the identifier of Velux Adapter devices.
+     */
+    static readonly IDENTIFIER_VELUX: string;
+    /**
+     * A Map containing all devices
+     */
     static alLDevices: {
         [id: string]: iBaseDevice;
     };
+    /**
+     * A reference to globally active energy manager
+     * @default undefined (no Energy-Manager)
+     */
     static energymanager?: iEnergyManager;
+    /**
+     * A reference to the Dachs device
+     * @default undefined (no Dachs CHP)
+     */
     static dachs?: Dachs;
+    /**
+     * A reference to the temperature sensor measuring the warm water temperature
+     * @default undefined (no warm water temperature sensor)
+     */
     static temperatureWarmWater?: iTemperatureSensor;
     constructor(pDeviceData: {
         [id: string]: deviceConfig;
@@ -25,6 +69,8 @@ export declare class Devices {
     private static processShellyDevice;
     private static processTuyaDevice;
     private static processZigbeeDevice;
+    private static processVeluxDevice;
+    private static processSmartGardenDevice;
     private static processWledDevice;
     private static processHMIPDevice;
     private static createEnergyManager;

package/lib/server/devices/devices.js

@@ -12,22 +12,27 @@ const wledDevice_1 = require("./wledDevice");
 const DeviceCapability_1 = require("./DeviceCapability");
 const shelly_1 = require("./shelly");
 const tuya_1 = require("./tuya");
+const smartGarden_1 = require("./smartGarden");
+const velux_1 = require("./velux");
 class Devices {
     constructor(pDeviceData, pRoomImportEnforcer, config) {
         var _a;
         // This forces import of rooms at correct timing, to allow devices to land in proper rooms.
         pRoomImportEnforcer === null || pRoomImportEnforcer === void 0 ? void 0 : pRoomImportEnforcer.addRoomConstructor();
-        services_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Constructing devices now`);
+        services_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'Constructing devices now');
         for (const cID in pDeviceData) {
             const cDevConf = pDeviceData[cID];
-            if (!cDevConf.common ||
-                !cDevConf.common.name ||
-                typeof cDevConf.common.name === 'object' ||
-                !cDevConf.type ||
-                cDevConf.type === 'channel') {
+            if (!cDevConf.common || !cDevConf.common.name || typeof cDevConf.common.name === 'object' || !cDevConf.type) {
                 continue;
             }
             const cName = cDevConf.common.name;
+            if (cDevConf.type === 'channel') {
+                // Velux has the name in the root channel of a device
+                if (cName.indexOf('00-Velux') === 0) {
+                    Devices.processVeluxDevice(cDevConf);
+                }
+                continue;
+            }
             if (cName.indexOf('00-HmIP') === 0) {
                 Devices.processHMIPDevice(cDevConf);
             }
@@ -43,10 +48,13 @@ class Devices {
             else if (cName.indexOf('00-Tuya') === 0) {
                 Devices.processTuyaDevice(cDevConf);
             }
+            else if (cDevConf.type === 'device' && cName.indexOf('DEVICE_') === 0 && cID.indexOf('smartgarden') === 0) {
+                Devices.processSmartGardenDevice(cDevConf);
+            }
             else if (cName.indexOf('00-EnergyManager') === 0 &&
                 cDevConf.type !== 'folder' &&
                 !((_a = config === null || config === void 0 ? void 0 : config.energyManager) === null || _a === void 0 ? void 0 : _a.disableJsEnergyManager)) {
-                services_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Found Energy-Manager in Device json.`);
+                services_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'Found Energy-Manager in Device json.');
                 Devices.createEnergyManager(cDevConf);
             }
         }
@@ -59,20 +67,20 @@ class Devices {
         // Nothing yet
     }
     static resetDetectionsToday() {
-        services_1.ServerLogService.writeLog(models_1.LogLevel.Info, `3 o'clock reset of motion sensors`);
+        services_1.ServerLogService.writeLog(models_1.LogLevel.Info, "3 o'clock reset of motion sensors");
         for (const dID in Devices.alLDevices) {
             const d = Devices.alLDevices[dID];
             if (d.deviceCapabilities.includes(DeviceCapability_1.DeviceCapability.motionSensor)) {
-                d.log(models_1.LogLevel.Debug, `3 o'clock reset of detections`);
+                d.log(models_1.LogLevel.Debug, "3 o'clock reset of detections");
                 d.detectionsToday = 0;
             }
         }
     }
     static getBatteryInfo() {
-        services_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Getting Battery Info`);
+        services_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'Getting Battery Info');
         let data = [];
         const result = [
-            `These are the battery values for each device. Device dependandt some are in volts, some in %`,
+            'These are the battery values for each device. Device dependandt some are in volts, some in %',
         ];
         for (const key in this.alLDevices) {
             const d = this.alLDevices[key];
@@ -92,7 +100,7 @@ class Devices {
         return result.join('\n');
     }
     static processShellyDevice(cDevConf) {
-        const shellyInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf);
+        const shellyInfo = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.byDeviceConfig(cDevConf);
         const fullName = `${Devices.IDENTIFIER_Shelly}-${shellyInfo.devID}`;
         shellyInfo.allDevicesKey = fullName;
         if (typeof Devices.alLDevices[fullName] !== 'undefined') {
@@ -104,6 +112,9 @@ class Devices {
             case 'Trv':
                 d = new shelly_1.ShellyTrv(shellyInfo);
                 break;
+            case 'Actuator':
+                d = new shelly_1.ShellyActuator(shellyInfo);
+                break;
             default:
                 services_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `No shelly Device Type for ${shellyInfo.deviceType} defined`);
                 d = new shelly_1.ShellyDevice(shellyInfo, deviceType_1.DeviceType.unknown);
@@ -111,7 +122,7 @@ class Devices {
         Devices.alLDevices[fullName] = d;
     }
     static processTuyaDevice(cDevConf) {
-        const tuyaInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf);
+        const tuyaInfo = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.byDeviceConfig(cDevConf);
         const fullName = `${Devices.IDENTIFIER_TUYA}-${tuyaInfo.devID}`;
         tuyaInfo.allDevicesKey = fullName;
         if (typeof Devices.alLDevices[fullName] !== 'undefined') {
@@ -130,7 +141,7 @@ class Devices {
         Devices.alLDevices[fullName] = d;
     }
     static processZigbeeDevice(cDevConf) {
-        const zigbeeInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf);
+        const zigbeeInfo = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.byDeviceConfig(cDevConf);
         const apiDevId = zigbeeInfo.devID.startsWith('0x') ? zigbeeInfo.devID.substring(2) : zigbeeInfo.devID;
         const fullName = `zigbee-${apiDevId}`;
         zigbeeInfo.allDevicesKey = fullName;
@@ -221,8 +232,14 @@ class Devices {
         }
         Devices.alLDevices[fullName] = d;
     }
+    static processVeluxDevice(cDevConf) {
+        velux_1.VeluxService.processVeluxDevice(cDevConf);
+    }
+    static processSmartGardenDevice(cDevConf) {
+        smartGarden_1.SmartGardenService.processSmartGardenDevice(cDevConf);
+    }
     static processWledDevice(cDevConf) {
-        const wledIoBrokerDeviceInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf);
+        const wledIoBrokerDeviceInfo = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.byDeviceConfig(cDevConf);
         const fullName = `${Devices.IDENTIFIER_WLED}-${wledIoBrokerDeviceInfo.devID}`;
         wledIoBrokerDeviceInfo.allDevicesKey = fullName;
         if (typeof Devices.alLDevices[fullName] !== 'undefined') {
@@ -232,7 +249,7 @@ class Devices {
         Devices.alLDevices[fullName] = new wledDevice_1.WledDevice(wledIoBrokerDeviceInfo);
     }
     static processHMIPDevice(cDevConf) {
-        const hmIPInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf);
+        const hmIPInfo = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.byDeviceConfig(cDevConf);
         const fullName = `${Devices.IDENTIFIER_HOMEMATIC}-${hmIPInfo.devID}`;
         hmIPInfo.allDevicesKey = fullName;
         if (typeof Devices.alLDevices[fullName] !== 'undefined') {
@@ -288,7 +305,7 @@ class Devices {
         if (Devices.energymanager !== undefined) {
             return;
         }
-        const devInfo = new IoBrokerDeviceInfo_1.IoBrokerDeviceInfo(cDevConf, true);
+        const devInfo = IoBrokerDeviceInfo_1.IoBrokerDeviceInfo.byStateJsSplit(cDevConf);
         const fullName = `${Devices.IDENTIFIER_JS}-${devInfo.devID}`;
         devInfo.allDevicesKey = fullName;
         Devices.energymanager = new jsObject_1.JsObjectEnergyManager(devInfo);
@@ -296,14 +313,58 @@ class Devices {
     }
 }
 exports.Devices = Devices;
+/**
+ * A constant for the identifier of HM-IP Adapter devices
+ */
 Devices.IDENTIFIER_HOMEMATIC = 'hm-rpc';
+/**
+ * A constant for the identifier of JavaScript Adapter devices
+ */
 Devices.IDENTIFIER_JS = 'javascript';
+/**
+ * A constant for the identifier of Shelly Adapter devices
+ */
 Devices.IDENTIFIER_Shelly = 'shelly';
+/**
+ * A constant for the identifier of Tuya Adapter devices
+ */
 Devices.IDENTIFIER_TUYA = 'tuya';
+/**
+ * A constant for the identifier of Zigbee Adapter devices
+ */
 Devices.IDENTIFIER_ZIGBEE = 'zigbee';
+/**
+ * A constant for the identifier of Zigbee2Mqtt Adapter devices
+ */
 Devices.IDENTIFIER_ZIGBEE2MQTT = 'zigbee2mqtt';
+/**
+ * A constant for the identifier of WLED Adapter devices
+ */
 Devices.IDENTIFIER_WLED = 'wled';
+/**
+ * A constant for the identifier of SmartGarden devices.
+ */
+Devices.IDENTIFIER_SMART_GARDEN = 'smartgarden';
+/**
+ * A constant for the identifier of Velux Adapter devices.
+ */
+Devices.IDENTIFIER_VELUX = 'klf200';
+/**
+ * A Map containing all devices
+ */
 Devices.alLDevices = {};
+/**
+ * A reference to globally active energy manager
+ * @default undefined (no Energy-Manager)
+ */
 Devices.energymanager = undefined;
+/**
+ * A reference to the Dachs device
+ * @default undefined (no Dachs CHP)
+ */
 Devices.dachs = undefined;
+/**
+ * A reference to the temperature sensor measuring the warm water temperature
+ * @default undefined (no warm water temperature sensor)
+ */
 Devices.temperatureWarmWater = undefined;

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

@@ -9,12 +9,25 @@ import { TrackedDistanceData } from './trackedDistanceData';
 import { iBluetoothDetector } from '../baseDeviceInterfaces/iBluetoothDetector';
 export declare class DetectedBluetoothDevice implements iBaseDevice {
     id: string;
+    /** @inheritDoc */
     settings: undefined;
+    /**
+     * A Map matching the distances to the trackers identified by {@link iBluetoothDetector.id}
+     */
     distanceMap: Map<string, TrackedDistanceData>;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
     deviceType: DeviceType;
+    /** @inheritDoc */
     info: DeviceInfo;
+    /**
+     * The last room the device was guessed to be in {@link iRoomBase.roomName}
+     */
     lastRoom: string | undefined;
+    /**
+     * If the device is currently present
+     */
     present: boolean;
     constructor(id: string, settings?: iBluetoothTrackingSettings);
     get customName(): string;

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

@@ -13,12 +13,25 @@ const trilaterationPointDistance_1 = require("./trilaterationPointDistance");
 class DetectedBluetoothDevice {
     constructor(id, settings) {
         this.id = id;
+        /** @inheritDoc */
         this.settings = undefined;
+        /**
+         * A Map matching the distances to the trackers identified by {@link iBluetoothDetector.id}
+         */
         this.distanceMap = new Map();
+        /** @inheritDoc */
         this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.trackableDevice];
+        /** @inheritDoc */
         this.deviceType = deviceType_1.DeviceType.TrackableDevice;
+        /** @inheritDoc */
         this.info = new DeviceInfo_1.DeviceInfo();
+        /**
+         * The last room the device was guessed to be in {@link iRoomBase.roomName}
+         */
         this.lastRoom = undefined;
+        /**
+         * If the device is currently present
+         */
         this.present = false;
         if (settings === undefined) {
             return;
@@ -77,7 +90,7 @@ class DetectedBluetoothDevice {
         const dataPoints = this.getDistances(maxAge);
         const result = [`Distances for ${this.info.customName}`];
         for (const data of dataPoints) {
-            result.push(`${data.trackerName}: ${services_1.Utils.round((_a = data.distance) !== null && _a !== void 0 ? _a : -99, 2)}m updated ${new Date(data.lastUpdate).toLocaleTimeString()}`);
+            result.push(`${data.trackerName}: ${services_1.Utils.round((_a = data.distance) !== null && _a !== void 0 ? _a : -99, 2)}m updated ${new Date(data.lastUpdate).toLocaleTimeString('de-DE')}`);
             services_1.Utils.nowTime();
         }
         return result.join('\n');

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

@@ -8,27 +8,57 @@ import { LogDebugType } from '../../services';
 import { ProximityCallback } from './proximityCallback';
 import { TrilaterationBasePoint } from './trilaterationBasePoint';
 export declare class EspresenseDevice implements iRoomDevice, iBluetoothDetector {
+    /** @inheritDoc */
     readonly position: TrilaterationBasePoint;
+    /** @inheritDoc */
     settings: undefined;
+    /** @inheritDoc */
     readonly deviceCapabilities: DeviceCapability[];
+    /** @inheritDoc */
     deviceType: DeviceType;
+    /**
+     * The name of this device
+     */
     readonly name: string;
     private deviceMap;
     private proximityCallbackMap;
+    /**
+     * Creates a new instance of the EspresenseDevice class
+     * @param name - The desired name of the device
+     * @param roomName - The name of the room this device is in {@link iRoomBase.roomName}
+     * @param x - The x coordinate of the device in the house
+     * @param y - The y coordinate of the device in the house
+     * @param z - The z coordinate of the device in the house
+     */
     constructor(name: string, roomName: string, x: number, y: number, z: number);
+    /** @inheritDoc */
     get customName(): string;
     protected _info: DeviceInfo;
+    /** @inheritDoc */
     get info(): DeviceInfo;
-    set info(info: DeviceInfo);
+    /** @inheritDoc */
     get id(): string;
+    /** @inheritDoc */
     get room(): RoomBase | undefined;
+    /** @inheritDoc */
     distanceOfDevice(deviceName: string, maxAge?: number): number | undefined;
+    /** @inheritDoc */
     isDevicePresent(deviceName: string, maxDistance: number, maxAge?: number): boolean;
+    /**
+     * Updates the device with the given state
+     * @param devName - The name of the bluetooth device
+     * @param state - The state containing the json-formatted distance data
+     */
     update(devName: string, state: ioBroker.State): void;
+    /** @inheritDoc */
     log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    /** @inheritDoc */
     toJSON(): Partial<iRoomDevice>;
+    /** @inheritDoc */
     persistDeviceInfo(): void;
+    /** @inheritDoc */
     loadDeviceSettings(): void;
+    /** @inheritDoc */
     addProximityCallback(cb: ProximityCallback): void;
     private addDeviceTracking;
 }

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

@@ -12,9 +12,20 @@ const espresenseCoordinator_1 = require("./espresenseCoordinator");
 const trilaterationBasePoint_1 = require("./trilaterationBasePoint");
 const trilateration_1 = require("./trilateration");
 class EspresenseDevice {
+    /**
+     * Creates a new instance of the EspresenseDevice class
+     * @param name - The desired name of the device
+     * @param roomName - The name of the room this device is in {@link iRoomBase.roomName}
+     * @param x - The x coordinate of the device in the house
+     * @param y - The y coordinate of the device in the house
+     * @param z - The z coordinate of the device in the house
+     */
     constructor(name, roomName, x, y, z) {
+        /** @inheritDoc */
         this.settings = undefined;
+        /** @inheritDoc */
         this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.bluetoothDetector];
+        /** @inheritDoc */
         this.deviceType = deviceType_1.DeviceType.Espresense;
         this.deviceMap = new Map();
         this.proximityCallbackMap = new Map();
@@ -31,22 +42,24 @@ class EspresenseDevice {
         this.loadDeviceSettings();
         trilateration_1.Trilateration.basePoints.push(this.position);
     }
+    /** @inheritDoc */
     get customName() {
         return this.info.customName;
     }
+    /** @inheritDoc */
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
+    /** @inheritDoc */
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `espresense-${this.info.room}-${this.info.customName}`;
     }
+    /** @inheritDoc */
     get room() {
         return services_1.API.getRoom(this.info.room);
     }
+    /** @inheritDoc */
     distanceOfDevice(deviceName, maxAge = 60) {
         var _a;
         for (const dev of this.deviceMap.values()) {
@@ -57,10 +70,16 @@ class EspresenseDevice {
         }
         return undefined;
     }
+    /** @inheritDoc */
     isDevicePresent(deviceName, maxDistance, maxAge = 60) {
         var _a;
         return ((_a = this.distanceOfDevice(deviceName, maxAge)) !== null && _a !== void 0 ? _a : 99) < maxDistance;
     }
+    /**
+     * Updates the device with the given state
+     * @param devName - The name of the bluetooth device
+     * @param state - The state containing the json-formatted distance data
+     */
     update(devName, state) {
         var _a, _b;
         let data = null;
@@ -83,7 +102,7 @@ class EspresenseDevice {
         }
         const trackedDistance = dev.getDistance(this.id);
         if (trackedDistance === undefined) {
-            this.log(models_1.LogLevel.Error, `TrackedDistance Undefined directly after update`);
+            this.log(models_1.LogLevel.Error, 'TrackedDistance Undefined directly after update');
             return;
         }
         const distance = trackedDistance.distance;
@@ -103,6 +122,7 @@ class EspresenseDevice {
             }
         }
     }
+    /** @inheritDoc */
     log(level, message, debugType = services_1.LogDebugType.None) {
         var _a, _b;
         services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
@@ -112,18 +132,22 @@ class EspresenseDevice {
             deviceName: this.name,
         });
     }
+    /** @inheritDoc */
     toJSON() {
         return services_1.Utils.jsonFilter(this);
     }
+    /** @inheritDoc */
     persistDeviceInfo() {
         services_1.Utils.guardedTimeout(() => {
             var _a;
             (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
         }, 5000, this);
     }
+    /** @inheritDoc */
     loadDeviceSettings() {
         // Nothing
     }
+    /** @inheritDoc */
     addProximityCallback(cb) {
         let currentValue = this.proximityCallbackMap.get(cb.deviceName);
         if (currentValue == undefined) {

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

@@ -1,8 +1,20 @@
 import { iBluetoothDetector } from '../baseDeviceInterfaces/iBluetoothDetector';
 export declare class TrackedDistanceData {
+    /**
+     * The name of the tracker who detected this device
+     */
     trackerName: string;
+    /**
+     * The distance to the tracker
+     */
     distance: number | undefined;
+    /**
+     * The time of the last update
+     */
     lastUpdate: number;
+    /**
+     * The distance to the tracker before the last update (if available) can be used to calculate certain movements
+     */
     previousDistance: number | undefined;
     constructor(tracker: iBluetoothDetector);
     update(distance: number): void;

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

@@ -4,6 +4,9 @@ exports.TrackedDistanceData = void 0;
 const services_1 = require("../../services");
 class TrackedDistanceData {
     constructor(tracker) {
+        /**
+         * The time of the last update
+         */
         this.lastUpdate = 0;
         this.trackerName = tracker.info.customName;
     }

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

@@ -3,7 +3,14 @@ import { TrilaterationPoint } from './trilaterationPoint';
 import { TrilaterationPointDistance } from './trilaterationPointDistance';
 import { RoomBase } from '../../../models';
 export declare class Trilateration {
+    /**
+     * A list of all reference points for trilateration (e.g. Rooms, {@link iBluetoothDetector}s)
+     */
     static readonly basePoints: TrilaterationBasePoint[];
+    /**
+     * A list of all possible points for trilateration in this home, used for increased calculation speed
+     * This list is filled mostly by {@link Trilateration.addRoom} thus resulting in the air outside the house not being included
+     */
     static possiblePoints: TrilaterationPoint[];
     static addRoom(room: RoomBase, startPoint: TrilaterationPoint, endPoint: TrilaterationPoint): void;
     static initialize(): void;

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

@@ -104,5 +104,12 @@ class Trilateration {
     }
 }
 exports.Trilateration = Trilateration;
+/**
+ * A list of all reference points for trilateration (e.g. Rooms, {@link iBluetoothDetector}s)
+ */
 Trilateration.basePoints = [];
+/**
+ * A list of all possible points for trilateration in this home, used for increased calculation speed
+ * This list is filled mostly by {@link Trilateration.addRoom} thus resulting in the air outside the house not being included
+ */
 Trilateration.possiblePoints = [];

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

@@ -6,7 +6,13 @@ export declare class TrilaterationBasePoint {
     readonly z: number;
     readonly roomName: string;
     private readonly _maximumDistance;
+    /**
+     * The coordinates of this point in Space
+     */
     readonly ownPoint: TrilaterationPoint;
+    /**
+     * A precalculated map of distances to all existing points in the home (@see {@link Trilateration.possiblePoints})
+     */
     readonly precalculatedDistancesMap: Map<number, string[]>;
     constructor(x: number, y: number, z: number, roomName: string, _maximumDistance?: number);
     getRatedCoordinates(distance: number): TrilaterationRatedCoordinate[];

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

@@ -12,6 +12,9 @@ class TrilaterationBasePoint {
         this.z = z;
         this.roomName = roomName;
         this._maximumDistance = _maximumDistance;
+        /**
+         * A precalculated map of distances to all existing points in the home (@see {@link Trilateration.possiblePoints})
+         */
         this.precalculatedDistancesMap = new Map();
         this.ownPoint = new trilaterationPoint_1.TrilaterationPoint(x, y, z, roomName);
     }