hoffmation-base 3.0.0-alpha.9 → 3.0.0-alpha.90

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

@@ -1,7 +1,23 @@
 import { DachsClientOptions, InfluxDbConnectionOptions } from '../devices/dachs';
+/**
+ * The configuration for the Dachs CHP (if present)
+ * CHP = Combined Heat and Power (in german Block-Heiz-Kraftwerk)
+ */
 export interface iDachsSettings {
+    /**
+     * The interval in milli-seconds in which the Dachs client should refresh its data.
+     */
     refreshInterval: number;
+    /**
+     * The connection options for the Dachs client.
+     */
     connectionOptions: DachsClientOptions;
+    /**
+     * If provided, the Dachs client will write data to this InfluxDB.
+     */
     influxDb?: InfluxDbConnectionOptions;
+    /**
+     * The room name the Dachs device is located in.
+     */
     roomName: string;
 }

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

@@ -1,6 +1,23 @@
+/**
+ * The configuration for Daikin Air-Conditioning devices (if present)
+ */
 export interface iDaikinSettings {
+    /**
+     * Whether the Daikin service should be active.
+     */
     active: boolean;
+    /**
+     * Enables further Logging for Daikin-device in case of akward issues.
+     * TODO: Move to Logservice Debugging Type
+     */
     activateTracingLogger?: boolean;
+    /**
+     * Whether all requests to the Daikin devices should be made using GET requests.
+     */
     useGetToPost?: boolean;
+    /**
+     * Whether Room Default Callbacks should be added to start ac on Bottom Right short and stop on long button press.
+     * @warning This can collide with Sonos-Control (@see {@link iSonosSettings.buttonBotRightForRadio})
+     */
     buttonBotRightForAc?: boolean;
 }

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

@@ -1,5 +1,18 @@
+/**
+ * The configuration for an Energy-Manager (if present).
+ * This can be used to make proper use of excess energy (e.g. from solar panels)
+ */
 export interface iEnergyManagerSettings {
+    /**
+     * Disable ioBroker JS-EnergyManager
+     */
     disableJsEnergyManager?: boolean;
+    /**
+     * The price per kWh injecting into the grid
+     */
     injectWattagePrice?: number;
+    /**
+     * The price per kWh from the grid
+     */
     wattagePrice?: number;
 }

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

@@ -1,6 +1,16 @@
 import { iBluetoothTrackingSettings } from './iBluetoothTrackingSettings';
+/**
+ * The configuration for Espresense devices (if present)
+ * This can be used to monitor/tack/locate the position of certain bluetooth devices within the house.
+ */
 export interface iEspresenseSettings {
+    /**
+     * The instance of the mqtt adapter providing the data for espresense devices within ioBroker.
+     */
     mqttInstance: number;
+    /**
+     * An map providing settings for some devices to be tracked.
+     */
     deviceMap: {
         [folderId: string]: iBluetoothTrackingSettings;
     };

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

@@ -0,0 +1,9 @@
+/**
+ * Settings to connect to an external GoveeApi
+ */
+export interface iGoveeSettings {
+    /**
+     * The url of the {@link https://github.com/theimo1221/govee-express-api GoveeApi}
+     */
+    url: string;
+}

package/lib/server/config/iGoveeSettings.js

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

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

@@ -1,9 +1,17 @@
 import { HeatingMode } from './heatingMode';
+/**
+ * Additional settings for the heating system (if present)
+ */
 export interface iHeaterSettings {
     /**
      * Whether heating with ac is allowed
      * This normally depends on the cost difference between ac heating and conventional heating
      */
     allowAcHeating?: boolean;
+    /**
+     * The desired Heating mode of the house.
+     * As of today you have to manually switch between summer and winter.
+     * TODO: Add heating Mode change to persisted settings and allow controlling it via the app
+     */
     mode?: HeatingMode;
 }

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

@@ -1,3 +1,7 @@
+/**
+ * The settings for the ioBroker instance
+ * Currently Hoffmation needs an ioBroker instance, but we might make it independent of it in the future.
+ */
 export interface iIobrokerSettigns {
     /**
      * Whether states should be initialized by processing each key on its own.
@@ -8,4 +12,8 @@ export interface iIobrokerSettigns {
      * Whether the new/advanced zigbee2mqtt adapter is used
      */
     useZigbee2mqtt?: boolean;
+    /**
+     * The URL to the ioBroker instance (or the IP-Address)
+     */
+    ioBrokerUrl: string;
 }

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

@@ -1,12 +1,51 @@
+import { LogLevel } from '../../models';
+/**
+ * The settings for the logging system.
+ * There are different log-levels which can be set and debug-logging can be granular enabled
+ */
 export interface iLogSettings {
-    logLevel: number;
+    /**
+     * The threshold level for logging (-1 = off)
+     */
+    logLevel: LogLevel | -1;
+    /**
+     * Whether to inlude the timestamp in the log messages
+     */
     useTimestamp: boolean;
+    /**
+     * Whether to log debug messages for movement state changes
+     */
     debugNewMovementState?: boolean;
+    /**
+     * Whether to log debug messages for shutter position changes
+     */
     debugShutterPositionChange?: boolean;
+    /**
+     * Whether to log debug messages for actuator change commands
+     */
     debugActuatorChange?: boolean;
+    /**
+     * Whether to log debug messages for shutter commands being blocked as it is already in the desired position
+     */
     debugUchangedShutterPosition?: boolean;
+    /**
+     * Whether to log debug messages for actuator commands being blocked as it is already in the desired state
+     */
     debugUnchangedActuator?: boolean;
+    /**
+     * Whether to log debug messages for daikin control commands
+     */
     debugDaikinSuccessfullControlInfo?: boolean;
+    /**
+     * Whether to log debug messages for euro heater valve position changes
+     */
     debugEuroHeaterValve?: boolean;
+    /**
+     * Whether to log debug messages for trilateration calculations
+     */
     debugTrilateration?: boolean;
+    /**
+     * Whether to send telegram messages on "HOST Unreach" of Dachs
+     */
+    alertDachsUnreachable?: boolean;
 }

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

@@ -1,4 +1,14 @@
+/**
+ * The settings for the mp3-server (if needed).
+ * A mp3-server is mainly needed for playing text-to-speech messages on speakers (e.g. Sonos)
+ */
 export interface iMp3Settings {
+    /**
+     * local path for the mp3 files to store/load
+     */
     path: string;
+    /**
+     * external reachable adress to access those mp3 files
+     */
     serverAddress: string;
 }

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

@@ -1,3 +1,10 @@
+/**
+ * The settings for the Müll-Service (if needed).
+ * Müll-Service is a service to remind you of the different waste collections.
+ */
 export interface iMuellSettings {
+    /**
+     * URL to the calendar to fetch the events from
+     */
     calendarURL: string;
 }

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

@@ -1,5 +1,18 @@
+/**
+ * The settings for the news-service (if needed).
+ * The news-service is used to download news-podcasts and play them on speakers (e.g. Sonos)
+ */
 export interface iNewsSettings {
+    /**
+     * rss feed url that contains the news information and audio file
+     */
     rssUrl?: string;
+    /**
+     * request interval in minutes
+     */
     requestInterval?: number;
+    /**
+     * maximum age in minutes of files cached for playback before they get deleted
+     */
     keepMaxAge?: number;
 }

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

@@ -1,4 +1,14 @@
 import { PoolConfig } from 'pg';
+/**
+ * The settings for the persistence system.
+ * The persistence system is used mainly for following things:
+ * 1. To persists settings/configuration
+ * 2. To persists the state of devices (e.g. to remember the last state of a light)
+ * 3. To persists device data for Statistics
+ */
 export interface iPersistenceSettings {
+    /**
+     * PostgreSql configuration
+     */
     postgreSql?: PoolConfig;
 }

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

@@ -1,8 +1,30 @@
+/**
+ * The settings for the polly-service (if needed).
+ * This service is used to convert text to speech.
+ */
 export interface iPollySettings {
+    /**
+     * The path to store the mp3 files
+     */
     mp3Path: string;
+    /**
+     * The region to use for the Polly service
+     */
     region: string;
+    /**
+     * The signature version to use for the Polly service
+     */
     signatureVersion: string;
+    /**
+     * Your AWS access key id
+     */
     accessKeyId: string;
+    /**
+     * Your AWS secret access key
+     */
     secretAccessKey: string;
+    /**
+     * The voice id to use for the Polly service
+     */
     voiceID: string;
 }

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

@@ -1,4 +1,14 @@
+/**
+ * Interface for the REST settings.
+ * This is primarily used to configure the REST service within Hoffmation-Express.
+ */
 export interface iRestSettings {
+    /**
+     * Whether the REST service should be active.
+     */
     active: boolean;
+    /**
+     * The port the REST service should listen on.
+     */
     port?: number;
 }

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

@@ -1,4 +1,18 @@
+/**
+ * The settings for the Sonos-Service (if present).
+ */
 export interface iSonosSettings {
+    /**
+     * Whether the Sonos service should be active.
+     */
     active: boolean;
+    /**
+     * Whether Room Default Callbacks should be added to start Radio on Bottom Right long button press.
+     * @warning This can collide with AC-Control (@see {@link iDaikinSettings.buttonBotRightForAc})
+     */
     buttonBotRightForRadio?: boolean;
+    /**
+     * The hostname to use for initialization (needed in some VLAN situation where discovery is not possible).
+     */
+    initialHost?: string;
 }

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

@@ -1,7 +1,24 @@
 import { LogLevel } from '../../models';
+/**
+ * The settings for the telegram-service (if needed).
+ * Telegram can be used to have a communication channel to the house and to receive notifications.
+ */
 export interface iTelegramSettings {
+    /**
+     * The threshold for the log level to trigger a message to telegram
+     * TODO: Maybe migrate to {@link iLogSettings}
+     */
     logLevel: LogLevel;
+    /**
+     * The token for the telegram bot
+     */
     telegramToken: string;
+    /**
+     * The allowed IDs for clients interacting with the bot
+     */
     allowedIDs: number[];
+    /**
+     * The IDs that are subscribed to updates from us (e.g. for notifications)
+     */
     subscribedIDs: number[];
 }

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

@@ -1,4 +1,14 @@
+/**
+ * The settings for the Tibber-Service (if needed).
+ * Tibber is an energy provider which can be used to have hourly energy prices.
+ */
 export interface iTibberSettings {
+    /**
+     * The API key for Tibber-API-Authorization
+     */
     apiKey: string;
+    /**
+     * The home ID for this home within the Tibber Account
+     */
     homeId: string;
 }

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

@@ -1,4 +1,13 @@
+/**
+ * Interface representing a specific time of day defined by hours and minutes
+ */
 export interface iTimePair {
+    /**
+     * The hours of the time pair
+     */
     hours: number;
+    /**
+     * The minutes of the time pair
+     */
     minutes: number;
 }

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

@@ -1,5 +1,14 @@
 import { iTimePair } from './iTimePair';
+/**
+ * The settings for the time-service.
+ */
 export interface iTimeSettings {
+    /**
+     * The time which should be considered as the start of the night
+     */
     nightStart: iTimePair;
+    /**
+     * The time which should be considered as the end of the night
+     */
     nightEnd: iTimePair;
 }

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

@@ -1,3 +1,13 @@
+/**
+ * The settings for the translation-service.
+ * The translation-service is used to provide certain messages in the desired language.
+ * Currently only german and english are supported.
+ * @warning The translation-service is not yet fully implemented and only used in some cases.
+ */
 export interface iTranslationSettings {
+    /**
+     * The desired language for the translations
+     * @default 'en'
+     */
     language: string;
 }

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

@@ -1,11 +1,42 @@
+/**
+ * The options neded to connect to a Unifi controller
+ */
 export interface iUnifiConnectionOptions {
+    /**
+     * The host address of the Unifi controller (or its IP address)
+     */
     host?: string;
+    /**
+     * The port of the Unifi controller
+     */
     port?: number;
+    /**
+     * The username used to log in to the Unifi controller (if needed)
+     */
     username?: string;
+    /**
+     * The password used to log in to the Unifi controller (if needed)
+     */
     password?: string;
+    /**
+     * The 2FA token used to log in to the Unifi controller (if needed)
+     * @warning This is not recommended to be used, as after a reboot you would need a new token
+     */
     token2FA?: string;
+    /**
+     * The site of this house (if needed)
+     */
     site?: string;
+    /**
+     * Whether to verify the SSL certificate of the Unifi controller or connect anyway
+     */
     sslverify?: boolean;
+    /**
+     * The timeout for the connection to the Unifi controller
+     */
     timeout?: number;
+    /**
+     * Whether to stay logged in or to reauthenticate on each request
+     */
     rememberMe?: boolean;
 }

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

@@ -1,4 +1,12 @@
 import { iUnifiConnectionOptions } from './iUnifiConnectionOptions';
+/**
+ * The settings for the Unifi-Service (if needed).
+ * Unifi is a network management system which can be used to monitor and control the network and devices.
+ * Within Hoffmation it is mainly used to reconnect devices if they are not reachable.
+ */
 export interface iUnifiSettings {
+    /**
+     * The options for connecting to the Unifi controller
+     */
     loginOptions: iUnifiConnectionOptions;
 }

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

@@ -1,6 +1,20 @@
 import { InfluxDbConnectionOptions } from 'victron-mqtt-consumer/build/models/InfluxDbConnectionOptions';
+/**
+ * The settings for the Victron-Service (if present).
+ * Victron is a energy management system which provides solar or battery power.
+ */
 export interface iVictronSettings {
+    /**
+     * The address of the Victron GX device
+     */
     host: string;
+    /**
+     * The information to connect to the InfluxDB for storing the data
+     */
     influxDb: InfluxDbConnectionOptions;
+    /**
+     * Whether further information should be logged
+     * TODO: Move this to a respective {@link LogDebugType}
+     */
     debug: boolean;
 }

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

@@ -1,5 +1,18 @@
+/**
+ * The settings for the weather-service (if needed).
+ * The weather-service is used to get weather data for the house location.
+ */
 export interface iWeatherSettings {
+    /**
+     * The lattitude of the location
+     */
     lattitude: string;
+    /**
+     * The longitude of the location
+     */
     longitude: string;
+    /**
+     * App-ID from OpenWeatherMap
+     */
     appid?: string;
 }

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

@@ -25,3 +25,5 @@ export * from './iTimePair';
 export * from './iUnifiSettings';
 export * from './iUnifiConnectionOptions';
 export * from './iVictronSettings';
+export { iBlockAutomaticHandlerDefaults } from './iBlockAutomaticHandlerDefaults';
+export { iGoveeSettings } from './iGoveeSettings';

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

@@ -21,6 +21,7 @@ export declare enum DeviceCapability {
     smokeSensor = 19,
     loadMetering = 20,
     garageDoorOpener = 21,
+    magnetSensor = 22,
     bluetoothDetector = 101,
     trackableDevice = 102,
     scene = 103,

package/lib/server/devices/DeviceCapability.js

@@ -25,6 +25,7 @@ var DeviceCapability;
     DeviceCapability[DeviceCapability["smokeSensor"] = 19] = "smokeSensor";
     DeviceCapability[DeviceCapability["loadMetering"] = 20] = "loadMetering";
     DeviceCapability[DeviceCapability["garageDoorOpener"] = 21] = "garageDoorOpener";
+    DeviceCapability[DeviceCapability["magnetSensor"] = 22] = "magnetSensor";
     DeviceCapability[DeviceCapability["bluetoothDetector"] = 101] = "bluetoothDetector";
     DeviceCapability[DeviceCapability["trackableDevice"] = 102] = "trackableDevice";
     DeviceCapability[DeviceCapability["scene"] = 103] = "scene";

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

@@ -1,6 +1,15 @@
 export declare class DeviceInfo {
+    /**
+     * The complete name of the device in a human readable format
+     */
     fullName: string;
+    /**
+     * The roomname matching {@link iRoomBase.roomName}
+     */
     room: string;
+    /**
+     * If present the key to access this device in {@link Devices.alLDevices}
+     */
     allDevicesKey?: string;
     private _customName?;
     get customName(): string;

package/lib/server/devices/DeviceInfo.js

@@ -3,7 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeviceInfo = void 0;
 class DeviceInfo {
     constructor() {
+        /**
+         * The complete name of the device in a human readable format
+         */
         this.fullName = '';
+        /**
+         * The roomname matching {@link iRoomBase.roomName}
+         */
         this.room = '';
     }
     get customName() {

package/lib/server/devices/Griffe.js

@@ -8,10 +8,9 @@ class Griffe {
     static getGriffPosition() {
         const griffe = Griffe.getAllGriffe();
         griffe.sort((a, b) => {
-            a.position;
             return b.position - a.position;
         });
-        const response = [`These are the current handle positions:`];
+        const response = ['These are the current handle positions:'];
         for (const g of griffe) {
             response.push(`${models_1.WindowPosition[g.position]} Window: "${g.info.customName}"`);
         }

package/lib/server/devices/Heizgruppen.js

@@ -6,8 +6,8 @@ const devices_1 = require("./devices");
 class Heizgruppen {
     static getProblems() {
         const groups = this.getAllGruppen();
-        const response = [`Dies sind die bestehenden Differenzen:`];
-        response.push(`Raumname\t\tIst-Temperatur\t\tGerät`);
+        const response = ['Dies sind die bestehenden Differenzen:'];
+        response.push('Raumname\t\tIst-Temperatur\t\tGerät');
         for (const g of groups) {
             const heizungen = g.getBelongingHeizungen();
             const tempProblem = [`${g.info.room}\t\t${g.iTemperature}°C\t\t${g.info.customName}`];