hoffmation-base 2.10.5 → 2.11.1

package/lib/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HoffmationBase = exports.HoffmationInitializationObject = void 0;
 const server_1 = require("./server");
 const models_1 = require("./models");
+const dachs_1 = require("./server/devices/dachs");
 __exportStar(require("./models/index"), exports);
 __exportStar(require("./server/index"), exports);
 __exportStar(require("./liquid-pid"), exports);
@@ -77,6 +78,9 @@ class HoffmationBase {
             server_1.DaikinService.addOwnDevices(server_1.OwnAcDevices.ownDevices);
             server_1.DaikinService.initialize();
         }
+        if (server_1.SettingsService.settings.dachs !== undefined) {
+            server_1.Devices.dachs = new dachs_1.Dachs(server_1.SettingsService.settings.dachs);
+        }
         server_1.Utils.guardedNewThread(() => {
             if (server_1.SettingsService.settings.muell) {
                 server_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Muell settings detected --> initializing`);

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

@@ -0,0 +1,6 @@
+import { ActuatorSettings } from './actuatorSettings';
+export declare class DachsDeviceSettings extends ActuatorSettings {
+    refreshInterval: number;
+    fromPartialObject(data: Partial<DachsDeviceSettings>): void;
+    protected toJSON(): Partial<DachsDeviceSettings>;
+}

package/lib/models/deviceSettings/dachsSettings.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DachsDeviceSettings = void 0;
+const server_1 = require("../../server");
+const actuatorSettings_1 = require("./actuatorSettings");
+class DachsDeviceSettings extends actuatorSettings_1.ActuatorSettings {
+    constructor() {
+        super(...arguments);
+        this.refreshInterval = 30000;
+    }
+    fromPartialObject(data) {
+        var _a;
+        this.refreshInterval = (_a = data.refreshInterval) !== null && _a !== void 0 ? _a : this.refreshInterval;
+        super.fromPartialObject(data);
+    }
+    toJSON() {
+        return server_1.Utils.jsonFilter(this);
+    }
+}
+exports.DachsDeviceSettings = DachsDeviceSettings;

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

@@ -19,10 +19,12 @@ import { iRestSettings } from './iRestSettings';
 import { iEspresenseSettings } from './iEspresenseSettings';
 import { iTibberSettings } from './iTibberSettings';
 import { iVictronSettings } from './iVictronSettings';
+import { iDachsSettings } from './iDachsSettings';
 export interface iConfig {
     asusConfig?: iAsusConfig;
     blueIris?: iBlueIrisSettings;
     daikin?: iDaikinSettings;
+    dachs?: iDachsSettings;
     espresense?: iEspresenseSettings;
     injectWattagePrice?: number;
     ioBrokerUrl: string;

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

@@ -0,0 +1,7 @@
+import { DachsClientOptions, InfluxDbConnectionOptions } from '../devices/dachs';
+export interface iDachsSettings {
+    refreshInterval: number;
+    connectionOptions: DachsClientOptions;
+    influxDb?: InfluxDbConnectionOptions;
+    roomName: string;
+}

package/lib/server/config/iDachsSettings.js

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

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

@@ -0,0 +1,36 @@
+import { DeviceInfo, DeviceType, iActuator, iBaseDevice } from '../../devices';
+import { LogLevel, RoomBase } from '../../../models';
+import { DeviceCapability } from '../DeviceCapability';
+import { LogDebugType, OwnSonosDevice } from '../../services';
+import { iDachsSettings } from '../../config/iDachsSettings';
+import { DachsDeviceSettings } from '../../../models/deviceSettings/dachsSettings';
+import { iFlattenedCompleteResponse } from './interfaces';
+export declare class Dachs implements iBaseDevice, iActuator {
+    settings: DachsDeviceSettings;
+    readonly deviceType: DeviceType;
+    readonly deviceCapabilities: DeviceCapability[];
+    private readonly client;
+    private readonly config;
+    fetchedData: iFlattenedCompleteResponse | undefined;
+    private readonly _influxClient;
+    private _dachsOn;
+    private _tempWarmWater;
+    get customName(): string;
+    get actuatorOn(): boolean;
+    get tempWarmWater(): number;
+    constructor(options: iDachsSettings);
+    protected _info: DeviceInfo;
+    get info(): DeviceInfo;
+    set info(info: DeviceInfo);
+    get id(): string;
+    get name(): string;
+    get room(): RoomBase | undefined;
+    log(level: LogLevel, message: string, debugType?: LogDebugType): void;
+    toJSON(): Partial<OwnSonosDevice>;
+    persistDeviceInfo(): void;
+    loadDeviceSettings(): void;
+    private loadData;
+    persist(): void;
+    setActuator(pValue: boolean, _timeout?: number, _force?: boolean): void;
+    toggleActuator(_force: boolean): boolean;
+}

package/lib/server/devices/dachs/dachs.js

@@ -0,0 +1,145 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dachs = void 0;
+const devices_1 = require("../../devices");
+const models_1 = require("../../../models");
+const DeviceCapability_1 = require("../DeviceCapability");
+const services_1 = require("../../services");
+const lodash_1 = __importDefault(require("lodash"));
+const dachsSettings_1 = require("../../../models/deviceSettings/dachsSettings");
+const lib_1 = require("./lib");
+class Dachs {
+    get customName() {
+        return this.info.customName;
+    }
+    get actuatorOn() {
+        return this._dachsOn;
+    }
+    get tempWarmWater() {
+        return this._tempWarmWater;
+    }
+    constructor(options) {
+        this.settings = new dachsSettings_1.DachsDeviceSettings();
+        this.deviceType = devices_1.DeviceType.Dachs;
+        this.deviceCapabilities = [];
+        this._dachsOn = false;
+        this._tempWarmWater = 0;
+        this.deviceCapabilities.push(DeviceCapability_1.DeviceCapability.actuator);
+        this._info = new devices_1.DeviceInfo();
+        this._info.fullName = `Dachs`;
+        this._info.customName = `Dachs ${options.roomName}`;
+        this._info.allDevicesKey = `dachs-${options.roomName}`;
+        this._info.room = options.roomName;
+        devices_1.Devices.alLDevices[this._info.allDevicesKey] = this;
+        if (options.influxDb) {
+            this._influxClient = new lib_1.DachsInfluxClient(options.influxDb);
+        }
+        this.persistDeviceInfo();
+        this.loadDeviceSettings();
+        const modifiedOptions = lodash_1.default.cloneDeep(options);
+        modifiedOptions.connectionOptions.resultConfig = {
+            flatten: true,
+        };
+        this.config = modifiedOptions;
+        this.client = new lib_1.DachsHttpClient(this.config.connectionOptions);
+        services_1.Utils.guardedInterval(this.loadData, this.config.refreshInterval, 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 : `sonos-${this.info.room}-${this.info.customName}`;
+    }
+    get name() {
+        return this.info.customName;
+    }
+    get room() {
+        return services_1.API.getRoom(this.info.room);
+    }
+    log(level, message, debugType = services_1.LogDebugType.None) {
+        services_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
+            debugType: debugType,
+            deviceId: this.name,
+            room: this._info.room,
+            deviceName: this.name,
+        });
+    }
+    toJSON() {
+        return services_1.Utils.jsonFilter(lodash_1.default.omit(this, ['room', 'client', 'config', '_influxClient']));
+    }
+    persistDeviceInfo() {
+        services_1.Utils.guardedTimeout(() => {
+            var _a;
+            (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.addDevice(this);
+        }, 5000, this);
+    }
+    loadDeviceSettings() {
+        this.settings.initializeFromDb(this);
+    }
+    loadData() {
+        this.client.fetchAllKeys().then((data) => {
+            var _a;
+            this.fetchedData = data;
+            if (this._influxClient === undefined) {
+                return;
+            }
+            for (const key in data) {
+                const value = data[key];
+                if (typeof value === 'number') {
+                    this._influxClient.addMeasurementToQueue(key, value);
+                    continue;
+                }
+                this._influxClient.addMeasurementToQueue(key, value ? '1' : '0');
+            }
+            this._influxClient.flush();
+            this._dachsOn = this.fetchedData['Hka_Mw1.usDrehzahl'] >= 1;
+            this._tempWarmWater = (_a = this.fetchedData['Hka_Mw1.Temp.sbZS_Warmwasser']) !== null && _a !== void 0 ? _a : 0;
+            this.persist();
+        });
+    }
+    persist() {
+        var _a;
+        (_a = services_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistActuator(this);
+    }
+    setActuator(pValue, _timeout, _force) {
+        if (!pValue || this._dachsOn) {
+            // Dachs can only be turned on, not off
+            return;
+        }
+        this.client
+            .setKeys({
+            'Stromf_Ew.Anforderung_GLT.bAktiv': '1',
+            'Stromf_Ew.Anforderung_GLT.bAnzahlModule': '1',
+        })
+            .then(() => {
+            services_1.Utils.guardedTimeout(() => {
+                this.client
+                    .setKeys({
+                    'Stromf_Ew.Anforderung_GLT.bAktiv': '0',
+                    'Stromf_Ew.Anforderung_GLT.bAnzahlModule': '0',
+                })
+                    .catch((error) => {
+                    this.log(models_1.LogLevel.Error, `Error while turning off Dachs: ${error}`);
+                });
+            }, 30000, this);
+        })
+            .catch((error) => {
+            this.log(models_1.LogLevel.Error, `Error while turning on Dachs: ${error}`);
+        });
+    }
+    toggleActuator(_force) {
+        if (!this._dachsOn) {
+            this.setActuator(true);
+            return true;
+        }
+        return false;
+    }
+}
+exports.Dachs = Dachs;

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

@@ -0,0 +1,3 @@
+export * from './dachs';
+export * from './interfaces';
+export * from './lib';

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

@@ -0,0 +1,19 @@
+"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("./dachs"), exports);
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./lib"), exports);

package/lib/server/devices/dachs/interfaces/DachsClientOptions.d.ts

@@ -0,0 +1,12 @@
+export interface DachsClientOptions {
+    host: string;
+    protocol?: 'http' | 'https';
+    port?: number;
+    username?: string;
+    password?: string;
+    resultConfig?: {
+        addRawValue?: boolean;
+        addKeyObject?: boolean;
+        flatten?: boolean;
+    };
+}

package/lib/server/devices/dachs/interfaces/DachsClientOptions.js

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

package/lib/server/devices/dachs/interfaces/IReadKeyList.d.ts

@@ -0,0 +1,205 @@
+export interface IReadKeyList<T> {
+    Hka_Bd: {
+        Anforderung: {
+            ModulAnzahl: T;
+            UStromF_Anf: {
+                bFlagSF: T;
+            };
+        };
+        UStromF_Frei: {
+            bFreigabe: T;
+        };
+        bStoerung: T;
+        bWarnung: T;
+        UHka_Anf: {
+            Anforderung: {
+                fStrom: T;
+            };
+            usAnforderung: T;
+        };
+        UHka_Frei: {
+            usFreigabe: T;
+        };
+        ulArbeitElektr: T;
+        ulArbeitThermHka: T;
+        ulArbeitThermKon: T;
+        ulBetriebssekunden: T;
+        ulAnzahlStarts: T;
+    };
+    Hka_Bd_Stat: {
+        uchSeriennummer: T;
+        uchTeilenummer: T;
+        ulInbetriebnahmedatum: T;
+    };
+    BD3112: {
+        Hka_Bd: {
+            ulBetriebssekunden: T;
+            ulAnzahlStarts: T;
+            ulArbeitElektr: T;
+            ulArbeitThermHka: T;
+            ulArbeitThermKon: T;
+        };
+        Ww_Bd: {
+            ulWwMengepA: T;
+        };
+    };
+    Brenner_Bd: {
+        bIstStatus: T;
+        bWarnung: T;
+        UBrenner_Anf: {
+            usAnforderung: T;
+        };
+        UBrenner_Frei: {
+            bFreigabe: T;
+        };
+        ulAnzahlStarts: T;
+        ulBetriebssekunden: T;
+    };
+    Hka_Ew: {
+        HydraulikNr: {
+            bSpeicherArt: T;
+            bWW_Art: T;
+            b2_Waermeerzeuger: T;
+            bMehrmodul: T;
+        };
+    };
+    Hka_Mw1: {
+        Temp: {
+            sAbgasHKA: T;
+            sAbgasMotor: T;
+            sKapsel: T;
+            sbAussen: T;
+            sbFreigabeModul: T;
+            sbFuehler1: T;
+            sbFuehler2: T;
+            sbGen: T;
+            sbMotor: T;
+            sbRegler: T;
+            sbRuecklauf: T;
+            sbVorlauf: T;
+            sbZS_Fuehler3: T;
+            sbZS_Fuehler4: T;
+            sbZS_Vorlauf1: T;
+            sbZS_Vorlauf2: T;
+            sbZS_Warmwasser: T;
+        };
+        Solltemp: {
+            sbRuecklauf: T;
+            sbVorlauf: T;
+        };
+        Aktor: {
+            bWwPumpe: T;
+            fFreiAltWaerm: T;
+            fMischer1Auf: T;
+            fMischer1Zu: T;
+            fMischer2Auf: T;
+            fMischer2Zu: T;
+            fProgAus1: T;
+            fProgAus2: T;
+            fProgAus3: T;
+            fStoerung: T;
+            fUPHeizkreis1: T;
+            fUPHeizkreis2: T;
+            fUPKuehlung: T;
+            fUPVordruck: T;
+            fUPZirkulation: T;
+            fWartung: T;
+        };
+        sWirkleistung: T;
+        ulMotorlaufsekunden: T;
+        usDrehzahl: T;
+    };
+    Laufraster15Min_aktTag: {
+        bDoppelstunde: [T, T, T, T, T, T, T, T, T, T, T, T];
+    };
+    Mm: [
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        },
+        {
+            ModulSteuerung: {
+                fModulLaeuft: T;
+                fModulVerfuegbar: T;
+            };
+        }
+    ];
+    Mm_MinMax: {
+        bModulBhMaxWart: T;
+        bModulBhMinWart: T;
+        sBhMaxWart: T;
+        sBhMinWart: T;
+        ModulBhMax: {
+            bModulNr: T;
+            ulWert: T;
+        };
+        ModulBhMin: {
+            bModulNr: T;
+            ulWert: T;
+        };
+        ModulStartMax: {
+            bModulNr: T;
+            ulWert: T;
+        };
+        ModulStartMin: {
+            bModulNr: T;
+            ulWert: T;
+        };
+    };
+    Wartung_Cache: {
+        fStehtAn: T;
+        ulBetriebssekundenBei: T;
+        ulZeitstempel: T;
+        usIntervall: T;
+    };
+}

package/lib/server/devices/dachs/interfaces/IReadKeyList.js

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

package/lib/server/devices/dachs/interfaces/IWriteKeyList.d.ts

@@ -0,0 +1,9 @@
+import { KeyListEntity } from './KeyListEntity';
+export interface IWriteKeyList {
+    Stromf_Ew: {
+        Anforderung_GLT: {
+            bAktiv: KeyListEntity;
+            bAnzahlModule: KeyListEntity;
+        };
+    };
+}

package/lib/server/devices/dachs/interfaces/IWriteKeyList.js

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

package/lib/server/devices/dachs/interfaces/KeyListEntity.d.ts

@@ -0,0 +1,18 @@
+export interface KeyListEntity {
+    key: string;
+    doc: string;
+    unit: (x: string) => boolean | string | number;
+}
+export interface KeyListEntityResponse<V> {
+    key?: KeyListEntity;
+    rawValue?: string;
+    value: V;
+}
+/**
+
+ "key": "",
+ "doc": "",
+ "unit": Number
+
+
+ */

package/lib/server/devices/dachs/interfaces/KeyListEntity.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+
+ "key": "",
+ "doc": "",
+ "unit": Number
+
+
+ */

package/lib/server/devices/dachs/interfaces/dachsInfluxDataPoint.d.ts

@@ -0,0 +1,7 @@
+export interface DachsInfluxDataPoint {
+    timestamp: Date;
+    measurement: string;
+    fields: {
+        [key: string]: string | number | boolean;
+    };
+}

package/lib/server/devices/dachs/interfaces/dachsInfluxDataPoint.js

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