hoffmation-base 0.1.1 → 0.1.5

package/models/temperaturSettings.ts

@@ -1,22 +1,22 @@
-import { Daytime } from './daytime';
-
-export class TemperaturSettings {
-  public constructor(
-    public start: Daytime,
-    public end: Daytime,
-    public temperatur: number,
-    public active: boolean = true,
-  ) {}
-
-  public isNowInRange(): boolean {
-    const now: number = new Date().getTime();
-    const todayStart: number = new Date().setHours(this.start.hour, this.start.minute);
-    if (now < todayStart) {
-      return false;
-    }
-
-    const todayEnd: number = new Date().setHours(this.end.hour, this.end.minute);
-
-    return now < todayEnd;
-  }
-}
+import { Daytime } from './daytime';
+
+export class TemperaturSettings {
+  public constructor(
+    public start: Daytime,
+    public end: Daytime,
+    public temperatur: number,
+    public active: boolean = true,
+  ) {}
+
+  public isNowInRange(): boolean {
+    const now: number = new Date().getTime();
+    const todayStart: number = new Date().setHours(this.start.hour, this.start.minute);
+    if (now < todayStart) {
+      return false;
+    }
+
+    const todayEnd: number = new Date().setHours(this.end.hour, this.end.minute);
+
+    return now < todayEnd;
+  }
+}

package/models/timeCallback.ts

@@ -1,90 +1,90 @@
-import { LogLevel } from './logLevel';
-import { ServerLogService } from '../server/services/log-service';
-import { SunTimeOffsets, TimeCallbackService } from '../server/services/time-callback-service';
-
-export class TimeCallback {
-  public lastDone: Date = new Date(0);
-  public nextToDo?: Date;
-
-  constructor(
-    public name: string,
-    public type: TimeCallbackType,
-    public cFunction: () => void,
-    public minuteOffset: number,
-    public hours?: number,
-    public minutes?: number,
-    public sunTimeOffset?: SunTimeOffsets,
-  ) {}
-
-  public recalcNextToDo(now: Date): void {
-    const today: Date = new Date(now.getTime());
-    today.setHours(0, 0, 0, 0);
-    switch (this.type) {
-      case TimeCallbackType.TimeOfDay:
-        if (this.hours === undefined) {
-          this.hours = 0;
-        }
-
-        if (this.minutes === undefined) {
-          this.minutes = 0;
-        }
-
-        this.nextToDo = new Date(
-          today.getTime() + this.hours * 60 * 60 * 1000 + (this.minutes + this.minuteOffset) * 60 * 1000,
-        );
-
-        if (this.nextToDo < now) {
-          // Heute ist schon abgelaufen, also morgen festlegen
-          this.nextToDo = new Date(this.nextToDo.getTime() + 24 * 60 * 60 * 1000);
-        }
-
-        ServerLogService.writeLog(
-          LogLevel.Trace,
-          `Nächste Zeitevent für "${this.name}" um ${this.nextToDo.toLocaleTimeString('de-DE')}`,
-        );
-        break;
-      case TimeCallbackType.Sunrise:
-        let fixedSRDate: Date = new Date(TimeCallbackService.nextSunRise.getTime() + this.minuteOffset * 60 * 1000);
-        if (this.sunTimeOffset) {
-          const nextMinSR: Date = this.sunTimeOffset.getNextMinimumSunrise();
-          if (fixedSRDate.getDate() === nextMinSR.getDate()) {
-            fixedSRDate = nextMinSR;
-          }
-        }
-        if (now > fixedSRDate) {
-          return;
-        }
-
-        ServerLogService.writeLog(
-          LogLevel.Trace,
-          `Nächste Zeitevent für "${this.name}" um ${fixedSRDate.toLocaleTimeString('de-DE')}`,
-        );
-        this.nextToDo = fixedSRDate;
-        break;
-      case TimeCallbackType.SunSet:
-        let fixedSSDate: Date = new Date(TimeCallbackService.nextSunSet.getTime() + this.minuteOffset * 60 * 1000);
-        if (this.sunTimeOffset) {
-          const nextMaxSS: Date = this.sunTimeOffset.getNextMaximumSunset();
-          if (fixedSSDate.getDate() === nextMaxSS.getDate()) {
-            fixedSSDate = nextMaxSS;
-          }
-        }
-        if (now > fixedSSDate) {
-          return;
-        }
-
-        ServerLogService.writeLog(
-          LogLevel.Trace,
-          `Nächste Zeitevent für "${this.name}" um ${fixedSSDate.toLocaleTimeString('de-DE')}`,
-        );
-        this.nextToDo = fixedSSDate;
-        break;
-    }
-  }
-}
-
-export enum TimeCallbackType {
-  TimeOfDay = 1,
-  Sunrise = 2,
-  SunSet = 3,
-}
+import { LogLevel } from './logLevel';
+import { ServerLogService } from '../server/services/log-service';
+import { SunTimeOffsets, TimeCallbackService } from '../server/services/time-callback-service';
+
+export class TimeCallback {
+  public lastDone: Date = new Date(0);
+  public nextToDo?: Date;
+
+  constructor(
+    public name: string,
+    public type: TimeCallbackType,
+    public cFunction: () => void,
+    public minuteOffset: number,
+    public hours?: number,
+    public minutes?: number,
+    public sunTimeOffset?: SunTimeOffsets,
+  ) {}
+
+  public recalcNextToDo(now: Date): void {
+    const today: Date = new Date(now.getTime());
+    today.setHours(0, 0, 0, 0);
+    switch (this.type) {
+      case TimeCallbackType.TimeOfDay:
+        if (this.hours === undefined) {
+          this.hours = 0;
+        }
+
+        if (this.minutes === undefined) {
+          this.minutes = 0;
+        }
+
+        this.nextToDo = new Date(
+          today.getTime() + this.hours * 60 * 60 * 1000 + (this.minutes + this.minuteOffset) * 60 * 1000,
+        );
+
+        if (this.nextToDo < now) {
+          // Heute ist schon abgelaufen, also morgen festlegen
+          this.nextToDo = new Date(this.nextToDo.getTime() + 24 * 60 * 60 * 1000);
+        }
+
+        ServerLogService.writeLog(
+          LogLevel.Trace,
+          `Nächste Zeitevent für "${this.name}" um ${this.nextToDo.toLocaleTimeString('de-DE')}`,
+        );
+        break;
+      case TimeCallbackType.Sunrise:
+        let fixedSRDate: Date = new Date(TimeCallbackService.nextSunRise.getTime() + this.minuteOffset * 60 * 1000);
+        if (this.sunTimeOffset) {
+          const nextMinSR: Date = this.sunTimeOffset.getNextMinimumSunrise();
+          if (fixedSRDate.getDate() === nextMinSR.getDate()) {
+            fixedSRDate = nextMinSR;
+          }
+        }
+        if (now > fixedSRDate) {
+          return;
+        }
+
+        ServerLogService.writeLog(
+          LogLevel.Trace,
+          `Nächste Zeitevent für "${this.name}" um ${fixedSRDate.toLocaleTimeString('de-DE')}`,
+        );
+        this.nextToDo = fixedSRDate;
+        break;
+      case TimeCallbackType.SunSet:
+        let fixedSSDate: Date = new Date(TimeCallbackService.nextSunSet.getTime() + this.minuteOffset * 60 * 1000);
+        if (this.sunTimeOffset) {
+          const nextMaxSS: Date = this.sunTimeOffset.getNextMaximumSunset();
+          if (fixedSSDate.getDate() === nextMaxSS.getDate()) {
+            fixedSSDate = nextMaxSS;
+          }
+        }
+        if (now > fixedSSDate) {
+          return;
+        }
+
+        ServerLogService.writeLog(
+          LogLevel.Trace,
+          `Nächste Zeitevent für "${this.name}" um ${fixedSSDate.toLocaleTimeString('de-DE')}`,
+        );
+        this.nextToDo = fixedSSDate;
+        break;
+    }
+  }
+}
+
+export enum TimeCallbackType {
+  TimeOfDay = 1,
+  Sunrise = 2,
+  SunSet = 3,
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hoffmation-base",
   "description": "Base Libraries and functions for own Hoffmation projects",
-  "version": "0.1.1",
+  "version": "0.1.5",
   "main": "index.js",
   "repository": {
     "type": "git",

package/server/config/config-readme.md

@@ -1,19 +1,19 @@
-# Config
-This home automation system is configured using multiple files which are described below.
-
-## Device Config
-To highly decrease workload manually entering device data from ioBroker 
-you can simply download your whole object tree from within the ioBroker -> objects page.
-
-The resulting `.json` should be placed within `.\server\config\private` folder, renamed to `devices.json`
-
-## Main Config
-Please place a `mainConfig.json` in the `.\server\config\private` folder.
-
-The file should contain all the desired services, which definitions can be found within the `iConfig.ts` file.
-
-## RoomConfig
-Please use the `.\models\rooms\Raumdefinition.xlsm` excel sheet to
-generate a `RoomConfig.txt`. As this needs running a specific node script 
-afterwards you should follow the steps within `.\models\rooms\readme.md`
-
+# Config
+This home automation system is configured using multiple files which are described below.
+
+## Device Config
+To highly decrease workload manually entering device data from ioBroker 
+you can simply download your whole object tree from within the ioBroker -> objects page.
+
+The resulting `.json` should be placed within `.\server\config\private` folder, renamed to `devices.json`
+
+## Main Config
+Please place a `mainConfig.json` in the `.\server\config\private` folder.
+
+The file should contain all the desired services, which definitions can be found within the `iConfig.ts` file.
+
+## RoomConfig
+Please use the `.\models\rooms\Raumdefinition.xlsm` excel sheet to
+generate a `RoomConfig.txt`. As this needs running a specific node script 
+afterwards you should follow the steps within `.\models\rooms\readme.md`
+

package/server/config/iConfig.ts

@@ -1,53 +1,53 @@
-import { LogLevel } from '../../models/logLevel';
-import { iRoomDefaultSettings } from '../../models/rooms/RoomSettings/iRoomDefaultSettings';
-
-export interface iConfig {
-  roomDefault: iRoomDefaultSettings;
-  timeSettings: iTimeSettings;
-  ioBrokerUrl: string;
-  telegram?: iTelegramSettings;
-  polly?: iPollySettings;
-  mp3Server?: iMp3Settings;
-  weather?: iWeatherSettings;
-  muell?: iMuellSettings;
-}
-
-export interface iTimePair {
-  hours: number;
-  minutes: number;
-}
-
-export interface iTimeSettings {
-  nightStart: iTimePair;
-  nightEnd: iTimePair;
-}
-
-export interface iTelegramSettings {
-  logLevel: LogLevel;
-  telegramToken: string;
-  allowedIDs: number[];
-  subscribedIDs: number[];
-}
-
-export interface iPollySettings {
-  mp3Path: string;
-  region: string;
-  signatureVersion: string;
-  accessKeyId: string;
-  secretAccessKey: string;
-  voiceID: string;
-}
-
-export interface iMp3Settings {
-  path: string;
-}
-
-export interface iWeatherSettings {
-  lattitude: string;
-  longitude: string;
-  appid: string;
-}
-
-export interface iMuellSettings {
-  calendarURL: string;
-}
+import { LogLevel } from '../../models/logLevel';
+import { iRoomDefaultSettings } from '../../models/rooms/RoomSettings/iRoomDefaultSettings';
+
+export interface iConfig {
+  roomDefault: iRoomDefaultSettings;
+  timeSettings: iTimeSettings;
+  ioBrokerUrl: string;
+  telegram?: iTelegramSettings;
+  polly?: iPollySettings;
+  mp3Server?: iMp3Settings;
+  weather?: iWeatherSettings;
+  muell?: iMuellSettings;
+}
+
+export interface iTimePair {
+  hours: number;
+  minutes: number;
+}
+
+export interface iTimeSettings {
+  nightStart: iTimePair;
+  nightEnd: iTimePair;
+}
+
+export interface iTelegramSettings {
+  logLevel: LogLevel;
+  telegramToken: string;
+  allowedIDs: number[];
+  subscribedIDs: number[];
+}
+
+export interface iPollySettings {
+  mp3Path: string;
+  region: string;
+  signatureVersion: string;
+  accessKeyId: string;
+  secretAccessKey: string;
+  voiceID: string;
+}
+
+export interface iMp3Settings {
+  path: string;
+}
+
+export interface iWeatherSettings {
+  lattitude: string;
+  longitude: string;
+  appid: string;
+}
+
+export interface iMuellSettings {
+  calendarURL: string;
+}

package/server/config/private/mainConfig.json

@@ -1,64 +1,64 @@
-{
-  "ioBrokerUrl": "http://xxx.xxx.xxx.xxx:8xx4",
-  "timeSettings": {
-    "nightStart": {
-      "hours": 23,
-      "minutes": 45
-    },
-    "nightEnd": {
-      "hours": 6,
-      "minutes": 30
-    }
-  },
-  "roomDefault": {
-    "lampenBeiBewegung": true,
-    "lichtSonnenAufgangAus": true,
-    "sonnenUntergangRollos": true,
-    "sonnenAufgangRollos": true,
-    "movementResetTimer": 240,
-    "sonnenUntergangRolloDelay": 15,
-    "sonnenUntergangLampenDelay": 15,
-    "sonnenUntergangRolloMaxTime": {
-      "hours": 21,
-      "minutes": 30
-    },
-    "sonnenAufgangRolloMinTime": {
-      "hours": 7,
-      "minutes": 30
-    },
-    "sonnenAufgangRolloDelay": 35,
-    "sonnenAufgangLampenDelay": 15,
-    "lightIfNoWindows": false
-  },
-  "telegram": {
-    "logLevel": 1,
-    "telegramToken": "15xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxXU",
-    "allowedIDs": [
-      111111111,
-      111111111
-    ],
-    "subscribedIDs": [
-      111111111,
-      111111111
-    ]
-  },
-  "mp3Server": {
-    "path": "//XXXXXXXXXX/XXXXX/XXXXXX/XXX/ttsMP3/"
-  },
-  "muell": {
-    "calendarURL": "https://xxxxxxxxxxxxxxxxxxxxx.de/abfuhrkalender?format=ical&street=xxxxxxxx&number=xx"
-  },
-  "polly": {
-    "mp3Path": "//xxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxx/ttsMP3/",
-    "region": "eu-central-1",
-    "signatureVersion":  "v4",
-    "accessKeyId": "xxxxxxxxxxxxxxxxxxxx",
-    "secretAccessKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-    "voiceID": "Vicki"
-  },
-  "weather": {
-    "lattitude": "xx.xxxxxx",
-    "longitude": "xx.xxxxx",
-    "appid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-  }
-}
+{
+  "ioBrokerUrl": "http://xxx.xxx.xxx.xxx:8xx4",
+  "timeSettings": {
+    "nightStart": {
+      "hours": 23,
+      "minutes": 45
+    },
+    "nightEnd": {
+      "hours": 6,
+      "minutes": 30
+    }
+  },
+  "roomDefault": {
+    "lampenBeiBewegung": true,
+    "lichtSonnenAufgangAus": true,
+    "sonnenUntergangRollos": true,
+    "sonnenAufgangRollos": true,
+    "movementResetTimer": 240,
+    "sonnenUntergangRolloDelay": 15,
+    "sonnenUntergangLampenDelay": 15,
+    "sonnenUntergangRolloMaxTime": {
+      "hours": 21,
+      "minutes": 30
+    },
+    "sonnenAufgangRolloMinTime": {
+      "hours": 7,
+      "minutes": 30
+    },
+    "sonnenAufgangRolloDelay": 35,
+    "sonnenAufgangLampenDelay": 15,
+    "lightIfNoWindows": false
+  },
+  "telegram": {
+    "logLevel": 1,
+    "telegramToken": "15xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxXU",
+    "allowedIDs": [
+      111111111,
+      111111111
+    ],
+    "subscribedIDs": [
+      111111111,
+      111111111
+    ]
+  },
+  "mp3Server": {
+    "path": "//XXXXXXXXXX/XXXXX/XXXXXX/XXX/ttsMP3/"
+  },
+  "muell": {
+    "calendarURL": "https://xxxxxxxxxxxxxxxxxxxxx.de/abfuhrkalender?format=ical&street=xxxxxxxx&number=xx"
+  },
+  "polly": {
+    "mp3Path": "//xxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxx/ttsMP3/",
+    "region": "eu-central-1",
+    "signatureVersion":  "v4",
+    "accessKeyId": "xxxxxxxxxxxxxxxxxxxx",
+    "secretAccessKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+    "voiceID": "Vicki"
+  },
+  "weather": {
+    "lattitude": "xx.xxxxxx",
+    "longitude": "xx.xxxxx",
+    "appid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+  }
+}

package/server/devices/DeviceInfo.ts

@@ -1,66 +1,66 @@
-import { deviceConfig } from '../../models/deviceConfig';
-
-export class DeviceInfo {
-  public devID: string;
-  public room: string;
-  public deviceType: string;
-  public deviceRoomIndex: number;
-  public type: 'device' | 'channel' | 'state';
-  public fullName: string;
-  private _customName?: string;
-  public fullID: string;
-  public channel?: number;
-  public valueName?: string;
-  public devConf: deviceConfig;
-
-  public constructor(pDevConf: deviceConfig) {
-    this.devConf = pDevConf;
-    this.type = pDevConf.type as 'device' | 'channel' | 'state';
-
-    this.fullID = pDevConf._id;
-    /**
-     * 0: hm-rpc
-     * 1: rcpInstance
-     * 2: Device ID
-     * 3?: Channel
-     * 4?: ValueName
-     */
-    const idSplit: string[] = pDevConf._id.split('.');
-    this.devID = idSplit[2];
-
-    if (idSplit.length > 3) {
-      this.channel = Number(idSplit[3]);
-    }
-
-    if (idSplit.length > 4) {
-      this.valueName = idSplit[4];
-    }
-
-    this.fullName = pDevConf.common.name;
-    /**
-     * 0: Indikator own "00"
-     * 1: "HmIP"
-     * 2: Raum
-     * 3: Was für ein Gerät
-     * 4: Index dieses Gerätes im Raum (ggf. + :Channel)
-     * 5?: Name des Wertes
-     */
-    const nameSplit: string[] = pDevConf.common.name.split('-');
-
-    this.room = nameSplit[2];
-    this.deviceType = nameSplit[3];
-    this.deviceRoomIndex = Number(nameSplit[4].split(':')[0]);
-  }
-
-  public set customName(val: string) {
-    this._customName = val;
-  }
-
-  public get customName(): string {
-    if (this._customName !== undefined) {
-      return this._customName;
-    }
-
-    return this.fullName;
-  }
-}
+import { deviceConfig } from '../../models/deviceConfig';
+
+export class DeviceInfo {
+  public devID: string;
+  public room: string;
+  public deviceType: string;
+  public deviceRoomIndex: number;
+  public type: 'device' | 'channel' | 'state';
+  public fullName: string;
+  private _customName?: string;
+  public fullID: string;
+  public channel?: number;
+  public valueName?: string;
+  public devConf: deviceConfig;
+
+  public constructor(pDevConf: deviceConfig) {
+    this.devConf = pDevConf;
+    this.type = pDevConf.type as 'device' | 'channel' | 'state';
+
+    this.fullID = pDevConf._id;
+    /**
+     * 0: hm-rpc
+     * 1: rcpInstance
+     * 2: Device ID
+     * 3?: Channel
+     * 4?: ValueName
+     */
+    const idSplit: string[] = pDevConf._id.split('.');
+    this.devID = idSplit[2];
+
+    if (idSplit.length > 3) {
+      this.channel = Number(idSplit[3]);
+    }
+
+    if (idSplit.length > 4) {
+      this.valueName = idSplit[4];
+    }
+
+    this.fullName = pDevConf.common.name;
+    /**
+     * 0: Indikator own "00"
+     * 1: "HmIP"
+     * 2: Raum
+     * 3: Was für ein Gerät
+     * 4: Index dieses Gerätes im Raum (ggf. + :Channel)
+     * 5?: Name des Wertes
+     */
+    const nameSplit: string[] = pDevConf.common.name.split('-');
+
+    this.room = nameSplit[2];
+    this.deviceType = nameSplit[3];
+    this.deviceRoomIndex = Number(nameSplit[4].split(':')[0]);
+  }
+
+  public set customName(val: string) {
+    this._customName = val;
+  }
+
+  public get customName(): string {
+    if (this._customName !== undefined) {
+      return this._customName;
+    }
+
+    return this.fullName;
+  }
+}