hoffmation-base 2.8.9 → 2.9.0

package/lib/models/deviceSettings/handleSettings.d.ts

@@ -0,0 +1,8 @@
+import { DeviceSettings } from './deviceSettings';
+export declare class HandleSettings extends DeviceSettings {
+    informOnOpen: boolean;
+    informNotHelping: boolean;
+    informIsHelping: boolean;
+    fromPartialObject(data: Partial<HandleSettings>): void;
+    protected toJSON(): Partial<HandleSettings>;
+}

package/lib/models/deviceSettings/handleSettings.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HandleSettings = void 0;
+const server_1 = require("../../server");
+const deviceSettings_1 = require("./deviceSettings");
+class HandleSettings extends deviceSettings_1.DeviceSettings {
+    constructor() {
+        super(...arguments);
+        this.informOnOpen = true;
+        this.informNotHelping = true;
+        this.informIsHelping = true;
+    }
+    fromPartialObject(data) {
+        var _a, _b, _c;
+        this.informOnOpen = (_a = data.informOnOpen) !== null && _a !== void 0 ? _a : this.informOnOpen;
+        this.informNotHelping = (_b = data.informNotHelping) !== null && _b !== void 0 ? _b : this.informNotHelping;
+        this.informIsHelping = (_c = data.informIsHelping) !== null && _c !== void 0 ? _c : this.informIsHelping;
+        super.fromPartialObject(data);
+    }
+    toJSON() {
+        return server_1.Utils.jsonFilter(this);
+    }
+}
+exports.HandleSettings = HandleSettings;

package/lib/models/deviceSettings/victronDeviceSettings.d.ts

@@ -5,6 +5,10 @@ export declare class VictronDeviceSettings extends DeviceSettings {
     hasGrid: boolean;
     hasSolar: boolean;
     batteryCapacityWattage: number;
+    normalBaseConsumptionWattage: number;
+    maximumBatteryDischargeWattage: number;
+    excessEnergyTurnOnThreshold: number;
+    excessEnergyTurnOffThreshold: number;
     fromPartialObject(data: Partial<VictronDeviceSettings>): void;
     protected toJSON(): Partial<VictronDeviceSettings>;
 }

package/lib/models/deviceSettings/victronDeviceSettings.js

@@ -11,14 +11,22 @@ class VictronDeviceSettings extends deviceSettings_1.DeviceSettings {
         this.hasGrid = true;
         this.hasSolar = true;
         this.batteryCapacityWattage = 10000;
+        this.normalBaseConsumptionWattage = 600;
+        this.maximumBatteryDischargeWattage = 3000;
+        this.excessEnergyTurnOnThreshold = 500;
+        this.excessEnergyTurnOffThreshold = 50;
     }
     fromPartialObject(data) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         this.maxBatteryLoadWattage = (_a = data.maxBatteryLoadWattage) !== null && _a !== void 0 ? _a : this.maxBatteryLoadWattage;
         this.hasBattery = (_b = data.hasBattery) !== null && _b !== void 0 ? _b : this.hasBattery;
         this.hasGrid = (_c = data.hasGrid) !== null && _c !== void 0 ? _c : this.hasGrid;
         this.hasSolar = (_d = data.hasSolar) !== null && _d !== void 0 ? _d : this.hasSolar;
         this.batteryCapacityWattage = (_e = data.batteryCapacityWattage) !== null && _e !== void 0 ? _e : this.batteryCapacityWattage;
+        this.normalBaseConsumptionWattage = (_f = data.normalBaseConsumptionWattage) !== null && _f !== void 0 ? _f : this.normalBaseConsumptionWattage;
+        this.maximumBatteryDischargeWattage = (_g = data.maximumBatteryDischargeWattage) !== null && _g !== void 0 ? _g : this.maximumBatteryDischargeWattage;
+        this.excessEnergyTurnOnThreshold = (_h = data.excessEnergyTurnOnThreshold) !== null && _h !== void 0 ? _h : this.excessEnergyTurnOnThreshold;
+        this.excessEnergyTurnOffThreshold = (_j = data.excessEnergyTurnOffThreshold) !== null && _j !== void 0 ? _j : this.excessEnergyTurnOffThreshold;
         super.fromPartialObject(data);
     }
     toJSON() {

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

@@ -1,18 +1,5 @@
 import { iExcessEnergyConsumer } from './iExcessEnergyConsumer';
 import { iBaseDevice } from './iBaseDevice';
-export declare class PhaseState {
-    private readonly _meterValue;
-    private readonly _production;
-    private readonly _injectingWattage;
-    private readonly _drawingWattage;
-    private readonly _selfConsumingWattage;
-    private readonly _totalConsumption;
-    constructor(_meterValue: number, _production: number);
-    get selfConsumingWattage(): number;
-    get drawingWattage(): number;
-    get injectingWattage(): number;
-    get totalConsumptionWattage(): number;
-}
 export interface iEnergyManager extends iBaseDevice {
     excessEnergy: number;
     addExcessConsumer(device: iExcessEnergyConsumer): void;

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

@@ -1,30 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PhaseState = void 0;
-class PhaseState {
-    constructor(_meterValue, _production) {
-        this._meterValue = _meterValue;
-        this._production = _production;
-        this._injectingWattage = 0;
-        this._drawingWattage = 0;
-        this._selfConsumingWattage = 0;
-        this._totalConsumption = 0;
-        this._injectingWattage = Math.max(0, this._meterValue);
-        this._selfConsumingWattage = this._production - Math.max(0, this._meterValue);
-        this._drawingWattage = Math.min(0, this._meterValue) * -1;
-        this._totalConsumption = this._production - this._meterValue;
-    }
-    get selfConsumingWattage() {
-        return this._selfConsumingWattage;
-    }
-    get drawingWattage() {
-        return this._drawingWattage;
-    }
-    get injectingWattage() {
-        return this._injectingWattage;
-    }
-    get totalConsumptionWattage() {
-        return this._totalConsumption;
-    }
-}
-exports.PhaseState = PhaseState;

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

@@ -5,6 +5,10 @@ import { iShutter, iVibrationSensor } from '../baseDeviceInterfaces';
 import { BaseGroup } from './base-group';
 import { ZigbeeMagnetContact } from '../zigbee';
 export declare class Window extends BaseGroup {
+    readonly handleIds: string[];
+    readonly vibrationIds: string[];
+    readonly shutterIds: string[];
+    readonly magnetIds: string[];
     noRolloOnSunrise: boolean;
     desiredPosition: number;
     settings: WindowSettings;

package/lib/server/devices/groups/Window.js

@@ -11,6 +11,10 @@ const device_list_1 = require("../device-list");
 class Window extends base_group_1.BaseGroup {
     constructor(roomName, handleIds = [], vibrationIds = [], shutterIds = [], magnetIds = [], noRolloOnSunrise = false) {
         super(roomName, group_type_1.GroupType.Window);
+        this.handleIds = handleIds;
+        this.vibrationIds = vibrationIds;
+        this.shutterIds = shutterIds;
+        this.magnetIds = magnetIds;
         this.noRolloOnSunrise = noRolloOnSunrise;
         this.desiredPosition = 0;
         this.settings = new models_2.WindowSettings();

package/lib/server/devices/groups/windowGroup.js

@@ -6,10 +6,26 @@ const services_1 = require("../../services");
 const models_2 = require("../models");
 const base_group_1 = require("./base-group");
 const group_type_1 = require("./group-type");
+const device_list_1 = require("../device-list");
+const device_cluster_type_1 = require("../device-cluster-type");
 class WindowGroup extends base_group_1.BaseGroup {
     constructor(roomName, windows) {
         super(roomName, group_type_1.GroupType.WindowGroup);
         this.windows = windows;
+        const shutterIds = [];
+        const handleIds = [];
+        const vibrationIds = [];
+        const magnetIds = [];
+        windows.forEach((window) => {
+            shutterIds.push(...window.shutterIds);
+            handleIds.push(...window.handleIds);
+            vibrationIds.push(...window.vibrationIds);
+            magnetIds.push(...window.magnetIds);
+        });
+        this.deviceCluster.deviceMap.set(device_cluster_type_1.DeviceClusterType.Handle, new device_list_1.DeviceList(handleIds));
+        this.deviceCluster.deviceMap.set(device_cluster_type_1.DeviceClusterType.Vibration, new device_list_1.DeviceList(vibrationIds));
+        this.deviceCluster.deviceMap.set(device_cluster_type_1.DeviceClusterType.Shutter, new device_list_1.DeviceList(shutterIds));
+        this.deviceCluster.deviceMap.set(device_cluster_type_1.DeviceClusterType.MagnetContact, new device_list_1.DeviceList(magnetIds));
     }
     allRolloDown(initial = false, savePosition = false) {
         this.windows.forEach((f) => {

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

@@ -6,7 +6,9 @@ import { IoBrokerBaseDevice } from '../IoBrokerBaseDevice';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
 import { HmIPDevice } from './hmIpDevice';
 import { iBatteryDevice, iHandleSensor } from '../baseDeviceInterfaces';
+import { HandleSettings } from '../../../models/deviceSettings/handleSettings';
 export declare class HmIpGriff extends HmIPDevice implements iHandleSensor, iBatteryDevice, iDisposable {
+    settings: HandleSettings;
     private _battery;
     private _lastBatteryPersist;
     private _lastHandlePersist;

package/lib/server/devices/hmIPDevices/hmIpGriff.js

@@ -11,6 +11,7 @@ const models_2 = require("../../../models");
 const lodash_1 = __importDefault(require("lodash"));
 const hmIpDevice_1 = require("./hmIpDevice");
 const DeviceCapability_1 = require("../DeviceCapability");
+const handleSettings_1 = require("../../../models/deviceSettings/handleSettings");
 class HmIpGriff extends hmIpDevice_1.HmIPDevice {
     get lastBatteryPersist() {
         return this._lastBatteryPersist;
@@ -20,6 +21,7 @@ class HmIpGriff extends hmIpDevice_1.HmIPDevice {
     }
     constructor(pInfo) {
         super(pInfo, deviceType_1.DeviceType.HmIpGriff);
+        this.settings = new handleSettings_1.HandleSettings();
         this._battery = -99;
         this._lastBatteryPersist = 0;
         this._lastHandlePersist = 0;
@@ -116,14 +118,18 @@ class HmIpGriff extends hmIpDevice_1.HmIPDevice {
                     if (!wouldHelp && this._helpingRoomTemp) {
                         const info = `Window should be closed, as it doesn't help reaching target temperature.`;
                         this.log(models_2.LogLevel.Info, info);
-                        services_1.TelegramService.inform(info);
+                        if (this.settings.informNotHelping) {
+                            services_1.TelegramService.inform(info);
+                        }
                         this._helpingRoomTemp = false;
                     }
                     else if (wouldHelp && !this._helpingRoomTemp) {
                         this._helpingRoomTemp = true;
                         const info = `Das Fenster hilft der Innentemperatur ihr Ziel von ${desiredTemp} zu erreichen. Draußen sind es ${outSideTemp}. Du wirst informiert wenn es nicht mehr hilft.`;
                         this.log(models_2.LogLevel.Info, info);
-                        services_1.TelegramService.inform(info);
+                        if (this.settings.informIsHelping) {
+                            services_1.TelegramService.inform(info);
+                        }
                         return;
                     }
                     else if (wouldHelp && this._helpingRoomTemp) {
@@ -139,7 +145,9 @@ class HmIpGriff extends hmIpDevice_1.HmIPDevice {
                 case 120:
                 case 240:
                     this.log(models_2.LogLevel.Info, message);
-                    services_1.TelegramService.inform(`${this.info.room}: ${message}`);
+                    if (this.settings.informOnOpen) {
+                        services_1.TelegramService.inform(`${this.info.room}: ${message}`);
+                    }
                     break;
                 default:
                     this.log(models_2.LogLevel.Trace, message);

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

@@ -1,8 +1,9 @@
 /// <reference types="iobroker" />
 import { IoBrokerBaseDevice } from '../IoBrokerBaseDevice';
-import { iEnergyManager, iExcessEnergyConsumer, PhaseState } from '../baseDeviceInterfaces';
+import { iEnergyManager, iExcessEnergyConsumer } from '../baseDeviceInterfaces';
 import { iDisposable } from '../../services';
 import { IoBrokerDeviceInfo } from '../IoBrokerDeviceInfo';
+import { PhaseState } from '../models';
 export declare class JsObjectEnergyManager extends IoBrokerBaseDevice implements iEnergyManager, iDisposable {
     private _excessEnergyConsumer;
     private _iCalculationInterval;

package/lib/server/devices/jsObject/jsObjectEnergyManager.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsObjectEnergyManager = void 0;
 const IoBrokerBaseDevice_1 = require("../IoBrokerBaseDevice");
-const baseDeviceInterfaces_1 = require("../baseDeviceInterfaces");
 const deviceType_1 = require("../deviceType");
 const models_1 = require("../../../models");
 const services_1 = require("../../services");
 const DeviceCapability_1 = require("../DeviceCapability");
+const models_2 = require("../models");
 class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
     constructor(info) {
         super(info, deviceType_1.DeviceType.JsEnergyManager);
@@ -20,9 +20,9 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
         this.blockDeviceChangeTime = -1;
         this._currentProduction = -1;
         this._excessEnergyConsumerConsumption = 0;
-        this._phaseAState = new baseDeviceInterfaces_1.PhaseState(0, 0);
-        this._phaseBState = new baseDeviceInterfaces_1.PhaseState(0, 0);
-        this._phaseCState = new baseDeviceInterfaces_1.PhaseState(0, 0);
+        this._phaseAState = new models_2.PhaseState(0, 0);
+        this._phaseBState = new models_2.PhaseState(0, 0);
+        this._phaseCState = new models_2.PhaseState(0, 0);
         this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.energyManager);
         this.log(models_1.LogLevel.Info, `Creating Energy Manager Device`);
         this._iCalculationInterval = services_1.Utils.guardedInterval(() => {
@@ -133,9 +133,9 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
     }
     calculateExcessEnergy() {
         const phaseProduction = this._currentProduction / 3.0;
-        this._phaseAState = new baseDeviceInterfaces_1.PhaseState(this._powerValuePhaseA, phaseProduction);
-        this._phaseBState = new baseDeviceInterfaces_1.PhaseState(this._powerValuePhaseB, phaseProduction);
-        this._phaseCState = new baseDeviceInterfaces_1.PhaseState(this._powerValuePhaseC, phaseProduction);
+        this._phaseAState = new models_2.PhaseState(this._powerValuePhaseA, phaseProduction);
+        this._phaseBState = new models_2.PhaseState(this._powerValuePhaseB, phaseProduction);
+        this._phaseCState = new models_2.PhaseState(this._powerValuePhaseC, phaseProduction);
         this.calculatePersistenceValues();
         this.recalculatePowerSharing();
     }

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

@@ -1,2 +1,3 @@
 export * from './WindowPosition';
 export * from './MagnetPosition';
+export * from './phaseState';

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

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./WindowPosition"), exports);
 __exportStar(require("./MagnetPosition"), exports);
+__exportStar(require("./phaseState"), exports);

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

@@ -0,0 +1,13 @@
+export declare class PhaseState {
+    private readonly _meterValue;
+    private readonly _production;
+    private readonly _injectingWattage;
+    private readonly _drawingWattage;
+    private readonly _selfConsumingWattage;
+    private readonly _totalConsumption;
+    constructor(_meterValue: number, _production: number);
+    get selfConsumingWattage(): number;
+    get drawingWattage(): number;
+    get injectingWattage(): number;
+    get totalConsumptionWattage(): number;
+}

package/lib/server/devices/models/phaseState.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhaseState = void 0;
+class PhaseState {
+    constructor(_meterValue, _production) {
+        this._meterValue = _meterValue;
+        this._production = _production;
+        this._injectingWattage = 0;
+        this._drawingWattage = 0;
+        this._selfConsumingWattage = 0;
+        this._totalConsumption = 0;
+        this._injectingWattage = Math.max(0, this._meterValue);
+        this._selfConsumingWattage = this._production - Math.max(0, this._meterValue);
+        this._drawingWattage = Math.min(0, this._meterValue) * -1;
+        this._totalConsumption = this._production - this._meterValue;
+    }
+    get selfConsumingWattage() {
+        return this._selfConsumingWattage;
+    }
+    get drawingWattage() {
+        return this._drawingWattage;
+    }
+    get injectingWattage() {
+        return this._injectingWattage;
+    }
+    get totalConsumptionWattage() {
+        return this._totalConsumption;
+    }
+}
+exports.PhaseState = PhaseState;

package/lib/server/services/time-callback-service.d.ts

@@ -33,4 +33,5 @@ export declare class TimeCallbackService {
     static updateSunRise(pDay?: Date, lat?: number, long?: number): void;
     static updateSunSet(pDay?: Date, lat?: number, long?: number): void;
     static getSunsetForDate(pDay?: Date, lat?: number, long?: number): Date;
+    static hoursTilSunset(): number;
 }

package/lib/server/services/time-callback-service.js

@@ -177,6 +177,9 @@ Next Sunset: ${TimeCallbackService._nextSunSet.toLocaleString('de-DE')}`);
     static getSunsetForDate(pDay = new Date(), lat, long) {
         return (0, sunrise_sunset_js_1.getSunset)(lat !== null && lat !== void 0 ? lat : settings_service_1.SettingsService.latitude, long !== null && long !== void 0 ? long : settings_service_1.SettingsService.longitude, pDay);
     }
+    static hoursTilSunset() {
+        return (this.nextSunSet.getTime() - utils_1.Utils.nowMS()) / 1000 / 60;
+    }
 }
 TimeCallbackService._callbacks = new Map();
 TimeCallbackService._lastCheck = new Date(0);

package/lib/server/services/victron/victron-device.js

@@ -7,6 +7,7 @@ const models_1 = require("../../../models");
 const DeviceCapability_1 = require("../../devices/DeviceCapability");
 const log_service_1 = require("../log-service");
 const victron_mqtt_consumer_1 = require("victron-mqtt-consumer");
+const time_callback_service_1 = require("../time-callback-service");
 class VictronDevice {
     constructor(opts) {
         this.deviceCapabilities = [DeviceCapability_1.DeviceCapability.energyManager];
@@ -62,10 +63,10 @@ class VictronDevice {
         if (utils_1.Utils.nowMS() < this.blockDeviceChangeTime) {
             return;
         }
-        if (this.excessEnergy > 400) {
+        if (this.excessEnergy > this.settings.excessEnergyTurnOnThreshold) {
             this.turnOnAdditionalConsumer();
         }
-        else if (this.excessEnergy < 200) {
+        else if (this.excessEnergy < this.settings.excessEnergyTurnOffThreshold) {
             this.turnOffAdditionalConsumer();
         }
     }
@@ -104,20 +105,27 @@ class VictronDevice {
             return;
         }
         // Step 1: Calculate battery need
+        const hoursTilSunset = time_callback_service_1.TimeCallbackService.hoursTilSunset();
         let neededBatteryWattage = 0;
         if (this.settings.hasBattery) {
             if (this.data.battery.soc == null) {
                 this.log(models_1.LogLevel.Debug, `No battery data available from Victron device.`);
                 return;
             }
-            neededBatteryWattage = (1 - this.data.battery.soc) * this.settings.batteryCapacityWattage;
+            neededBatteryWattage = ((1 - this.data.battery.soc) * this.settings.batteryCapacityWattage) / hoursTilSunset;
         }
         // Step 2: Calculate expected solar output
         const solarOutput = (_a = this.data.pvInverter.power) !== null && _a !== void 0 ? _a : 0;
         // Step 3: Calculate expected base consumption
-        const baseConsumption = 0;
+        const baseConsumption = this.settings.normalBaseConsumptionWattage;
         // Step 4: Combine to get currently excess energy
         this._excessEnergy = solarOutput - neededBatteryWattage - baseConsumption;
+        // Whilst calculated spare energy is more precise, we don't mind using the battery as a buffer, if it is full enough.
+        if (this.data.battery.dcPower !== null &&
+            this.data.battery.soc !== null &&
+            this.data.battery.soc > (hoursTilSunset > 4 ? 0.7 : 0.8)) {
+            this._excessEnergy = this.settings.maximumBatteryDischargeWattage - Math.max(this.data.battery.dcPower, 0);
+        }
     }
     turnOnAdditionalConsumer() {
         const result = utils_1.EnergyManagerUtils.turnOnAdditionalConsumer(this._excessEnergyConsumer, this._lastDeviceChange);

package/lib/server/services/weather/weather-service.js

@@ -152,7 +152,9 @@ class WeatherService {
         else if (this.willOutsideBeWarmer(26, logger)) {
             result = 30;
         }
-        logger(models_1.LogLevel.Info, `weatherRolloPosition(${normalPos}, ${desiredTemperatur}, ${currentTemperatur}) --> Target: ${result}`);
+        if (result !== normalPos) {
+            logger(models_1.LogLevel.Info, `weatherRolloPosition(${normalPos}, ${desiredTemperatur}, ${currentTemperatur}) --> Target: ${result}`);
+        }
         return result;
     }
     static getCurrentCloudiness() {