hoffmation-base 3.0.3 → 3.1.0

package/lib/interfaces/iDeviceInfo.d.ts

@@ -0,0 +1,25 @@
+/**
+ *
+ */
+export interface iDeviceInfo {
+    /**
+     *
+     */
+    fullName: string;
+    /**
+     *
+     */
+    room: string;
+    /**
+     *
+     */
+    allDevicesKey?: string;
+    /**
+     *
+     */
+    customName: string;
+    /**
+     *
+     */
+    toJSON(): Partial<iDeviceInfo>;
+}

package/lib/interfaces/iDeviceList.d.ts

@@ -0,0 +1,14 @@
+import { iBaseDevice } from './index';
+/**
+ *
+ */
+export interface iDeviceList {
+    /**
+     *
+     */
+    readonly ids: string[];
+    /**
+     *
+     */
+    getDevices(): Array<iBaseDevice>;
+}

package/lib/interfaces/iDeviceUpdater.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Service to update the state of any device
+ */
+export interface IDeviceUpdater {
+    /**
+     * Updates the state of a device
+     * @param id - The id of the device
+     * @param state - The new state
+     * @param initial - Whether this is an initial state update
+     */
+    updateState(id: string, state: ioBroker.State, initial?: boolean): void;
+    /**
+     * Updates the given object
+     * @param pId - The id of the object
+     * @param pObj - The new object
+     */
+    updateObject(pId: string, pObj: ioBroker.Object): void;
+    /**
+     *
+     */
+    onConnChanged(): void;
+}

package/lib/interfaces/iDevicecluster.d.ts

@@ -0,0 +1,40 @@
+import { DeviceClusterType } from '../enums';
+import { iDeviceList } from './iDeviceList';
+import { iIoBrokerBaseDevice } from './iIoBrokerBaseDevice';
+import { iBaseDevice } from './baseDevices';
+/**
+ *
+ */
+export interface iDeviceCluster {
+    /**
+     *
+     */
+    deviceMap: Map<DeviceClusterType, iDeviceList>;
+    /**
+     *
+     */
+    getIoBrokerDevicesByType(type: DeviceClusterType): iIoBrokerBaseDevice[];
+    /**
+     *
+     */
+    getDevicesByType(type: DeviceClusterType): Array<iBaseDevice>;
+    /**
+     *
+     */
+    addByDeviceType(device?: iBaseDevice): void;
+    /**
+     *
+     */
+    addToList(type: DeviceClusterType, device: iBaseDevice): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iDeviceCluster & {
+        /**
+         * Dictionary representation of the normal device map
+         */
+        deviceDict?: {
+            [p: string]: iDeviceList;
+        };
+    }>;
+}

package/lib/interfaces/iEnergyCalculation.d.ts

@@ -0,0 +1,45 @@
+/**
+ *
+ */
+export interface iEnergyCalculation {
+    /**
+     *
+     */
+    drawnKwH: number;
+    /**
+     *
+     */
+    injectedKwH: number;
+    /**
+     *
+     */
+    selfConsumedKwH: number;
+    /**
+     *
+     */
+    costDrawn: number;
+    /**
+     *
+     */
+    earnedInjected: number;
+    /**
+     *
+     */
+    savedSelfConsume: number;
+    /**
+     *
+     */
+    endMs: number;
+    /**
+     *
+     */
+    batteryStoredKwH: number;
+    /**
+     *
+     */
+    batteryLevel: number;
+    /**
+     *
+     */
+    startMs: number;
+}

package/lib/interfaces/iIOBrokerConnection.d.ts

@@ -0,0 +1,10 @@
+import { iDisposable } from './iDisposeable';
+/**
+ *
+ */
+export interface iIOBrokerConnection extends iDisposable {
+    /**
+     *
+     */
+    setState(pointId: string, state: string | number | boolean | ioBroker.State | ioBroker.SettableState | null, callback?: ioBroker.SetStateCallback): void;
+}

package/lib/interfaces/iIdHolder.d.ts

@@ -0,0 +1,24 @@
+import { LogDebugType, LogLevel } from '../enums';
+/**
+ * Interface for objects that have an unique id and a custom name
+ * The id can be used for API interaction, storing settings to the database, etc.
+ */
+export interface iIdHolder {
+    /**
+     * The id of the object.
+     * @warning This should be unique across all objects
+     */
+    readonly id: string;
+    /**
+     * The custom name of the object --> This can be a duplicate to other objects
+     * This should be the human-readable name of the object.
+     */
+    readonly customName: string;
+    /**
+     * Logs a message for this idHolder
+     * @param level - The log level
+     * @param message - The message to log
+     * @param logDebugType - If provided, this message will only be logged if the debug type is enabled in the settings
+     */
+    log(level: LogLevel, message: string, logDebugType?: LogDebugType): void;
+}

package/lib/interfaces/iIoBrokerBaseDevice.d.ts

@@ -0,0 +1,53 @@
+import { iRoomDevice } from './baseDevices';
+import { DeviceType } from '../enums';
+import { iIoBrokerDeviceInfo } from './IIoBrokerDeviceInfo';
+import { iIOBrokerConnection } from './iIOBrokerConnection';
+/**
+ *
+ */
+export interface iIoBrokerBaseDevice extends iRoomDevice {
+    /**
+     *
+     */
+    deviceType: DeviceType;
+    /**
+     *
+     */
+    readonly id: string;
+    /**
+     *
+     */
+    readonly info: iIoBrokerDeviceInfo;
+    /**
+     *
+     */
+    readonly ioConn: iIOBrokerConnection | undefined;
+    /**
+     *
+     */
+    update(idSplit: string[], state: ioBroker.State, initial: boolean, pOverride: boolean): void;
+    /**
+     * Allows to react on the state change of a given state with the passed cb
+     * @param stateName - Last part of the id e.g. "available" not "zigbee.0.00158d00053d3e4b.available"
+     * @param cb - Desired Callback Action, with passed ioBroker.StateValue
+     */
+    addIndividualStateCallback(stateName: string, cb: (val: ioBroker.StateValue) => void): void;
+    /**
+     * Returns whether a connection to ioBroker is established or not
+     * @param showError - If true, an error message will be written to the log if the connection is not established
+     * @returns Whether a connection exists
+     */
+    checkIoConnection(showError: boolean): boolean;
+    /**
+     *
+     */
+    addToCorrectRoom(): void;
+    /**
+     * Sets the state of a given data point and returns true if that was successful.
+     * @param pointId - Data point to write to
+     * @param state - Data to write
+     * @param onSuccess - Callback to run on successfully written data
+     * @param onError - Callback to run if an error has occurred during writing the data
+     */
+    setState(pointId: string, state: string | number | boolean | ioBroker.State | ioBroker.SettableState | null, onSuccess: (() => void) | undefined, onError: ((error: Error) => void) | undefined): void;
+}

package/lib/interfaces/iLogSettings.d.ts

@@ -0,0 +1,51 @@
+import { LogLevel } from '../enums';
+/**
+ * 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 {
+    /**
+     * 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/interfaces/iLogSettings.js

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

package/lib/interfaces/iPersist.d.ts

@@ -0,0 +1,135 @@
+import { iAcDevice, iActuator, iBaseDevice, iBatteryDevice, iButtonSwitch, iHandle, iHeater, iHumidityCollector, iIlluminationSensor, iMotionSensor, iShutter, iTemperatureCollector, iZigbeeDevice } from './baseDevices';
+import { iRoomBase } from './iRoomBase';
+import { ButtonPressType } from '../enums';
+import { iDesiredShutterPosition } from './IDesiredShutterPosition';
+import { iCountToday } from './iCountToday';
+import { iEnergyCalculation } from './iEnergyCalculation';
+import { iShutterCalibration } from './iShutterCalibration';
+/**
+ * The interface to interact with the persistence layer.
+ * In the past there was a mongo-db implementation, but this is now replaced by currently only postgresSql.
+ */
+export interface iPersist {
+    /**
+     * Whether persistence is properly initialized
+     */
+    initialized: boolean;
+    /**
+     * Adds a room to the database
+     * @param room - The room to add
+     */
+    addRoom(room: iRoomBase): void;
+    /**
+     * Adds a device to the database
+     * @param device - The device to add
+     */
+    addDevice(device: iBaseDevice): void;
+    /**
+     * Gets the count of the motion sensor today
+     * @param device - The device to get the count for
+     * @returns - The count of the motion sensor today
+     */
+    motionSensorTodayCount(device: iMotionSensor): Promise<iCountToday>;
+    /**
+     * Gets the last desired position of the shutter
+     * @param device - The device to get the last desired position for
+     * @returns - The last desired position of the shutter
+     */
+    getLastDesiredPosition(device: iShutter): Promise<iDesiredShutterPosition>;
+    /**
+     * Gets the shutter calibration
+     * @param device - The device to get the shutter calibration for
+     * @returns - The shutter calibration
+     */
+    getShutterCalibration(device: iShutter): Promise<iShutterCalibration>;
+    /**
+     * Initializes the database-connection and prepares the database
+     * @returns - The promise that resolves when the database is initialized
+     */
+    initialize(): Promise<void>;
+    /**
+     * Persists the shutter calibration
+     * @param data - The shutter calibration data to persist
+     */
+    persistShutterCalibration(data: iShutterCalibration): void;
+    /**
+     * Persists data for an illumination sensor
+     * @param device - The device to persist data for
+     */
+    persistIlluminationSensor(device: iIlluminationSensor): void;
+    /**
+     * Persists data for an energy manager
+     * @param energyData - The energy data to persist
+     */
+    persistEnergyManager(energyData: iEnergyCalculation): void;
+    /**
+     * Persists data of an AC device
+     * @param device - The device to persist data for
+     */
+    persistAC(device: iAcDevice): void;
+    /**
+     * Persists data of an actuator
+     * @param device - The device to persist data for
+     */
+    persistActuator(device: iActuator): void;
+    /**
+     * Persists data of a heater
+     * @param device - The device to persist data for
+     */
+    persistHeater(device: iHeater): void;
+    /**
+     * Persists data of a motion sensor
+     * @param device - The device to persist data for
+     */
+    persistMotionSensor(device: iMotionSensor): void;
+    /**
+     * Persists data of a button switch action
+     * @param device - The device to persist data for
+     * @param pressType - The type of button press
+     * @param buttonName - The name of the button
+     */
+    persistSwitchInput(device: iButtonSwitch, pressType: ButtonPressType, buttonName: string): void;
+    /**
+     * Persists data of a shutter
+     * @param device - The device to persist data for
+     */
+    persistShutter(device: iShutter): void;
+    /**
+     * Persists data of a temperature sensor
+     * @param device - The device to persist data for
+     */
+    persistTemperatureSensor(device: iTemperatureCollector): void;
+    /**
+     * Persists data of a humidity sensor
+     * @param device - The device to persist data for
+     */
+    persistHumiditySensor(device: iHumidityCollector): void;
+    /**
+     * Persists data of a handle sensor
+     * @param device - The device to persist data for
+     */
+    persistHandleSensor(device: iHandle): void;
+    /**
+     * Persists data of a battery device
+     * @param device - The device to persist data for
+     */
+    persistBatteryDevice(device: iBatteryDevice): void;
+    /**
+     * Persists data of a Zigbee device
+     * @param device - The device to persist data for
+     */
+    persistZigbeeDevice(device: iZigbeeDevice): void;
+    /**
+     * Persists settings for the given id
+     * @param id - The id to persist settings for
+     * @param settings - The settings to persist (as JSON string)
+     * @param customname - The custom name of the device/object
+     */
+    persistSettings(id: string, settings: string, customname: string): void;
+    /**
+     * Loads settings for the given id
+     * @param id - The id of the object/device to load settings for
+     * @returns - The settings as JSON string or undefined if not found
+     */
+    loadSettings(id: string): Promise<string | undefined>;
+}

package/lib/interfaces/iPersist.js

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

package/lib/interfaces/iProximityCallback.d.ts

@@ -0,0 +1,17 @@
+/**
+ *
+ */
+export interface iProximityCallback {
+    /**
+     *
+     */
+    readonly deviceName: string;
+    /**
+     *
+     */
+    readonly distanceTrigger: number;
+    /**
+     *
+     */
+    readonly callback: (present: boolean, distance: number | undefined) => void;
+}

package/lib/interfaces/iProximityCallback.js

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

package/lib/interfaces/iRessources.d.ts

@@ -0,0 +1,22 @@
+import { iRessourceObject } from './IRessourceObject';
+export interface IRessources {
+    alarmArmed: iRessourceObject;
+    alarmNightModeArmed: iRessourceObject;
+    closedAfterMinutes: iRessourceObject;
+    fireAlarmEnd: iRessourceObject;
+    fireAlarmRepeat: iRessourceObject;
+    fireAlarmStart: iRessourceObject;
+    goodMorning: iRessourceObject;
+    intruderAlarm: iRessourceObject;
+    intruderAdditionalDefenseWarning: iRessourceObject;
+    intruderGreeting: iRessourceObject;
+    intruderLeaveAndOwnerInformed: iRessourceObject;
+    intruderShutterUpPleaseLeave: iRessourceObject;
+    justClosed: iRessourceObject;
+    vibrationAlarm: iRessourceObject;
+    waterAlarmEnd: iRessourceObject;
+    waterAlarmRepeat: iRessourceObject;
+    waterAlarmStart: iRessourceObject;
+    wasOpened: iRessourceObject;
+    welcomeHome: iRessourceObject;
+}

package/lib/interfaces/iRessources.js

@@ -0,0 +1,3 @@
+"use strict";
+/* eslint-disable jsdoc/require-jsdoc */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/iRoomAddDeviceItem.d.ts

@@ -0,0 +1,22 @@
+import { iRoomBase } from './iRoomBase';
+/**
+ *
+ */
+export interface iRoomAddDeviceItem {
+    /**
+     *
+     */
+    setID: (value: string) => iRoomBase | undefined;
+    /**
+     *
+     */
+    index: number;
+    /**
+     *
+     */
+    customName: string;
+    /**
+     *
+     */
+    added: boolean;
+}

package/lib/interfaces/iRoomAddDeviceItem.js

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

package/lib/interfaces/iRoomBase.d.ts

@@ -0,0 +1,107 @@
+import { RoomSetLightTimeBasedCommand } from '../command';
+import { iHeatGroup, iLightGroup, iPresenceGroup, iSmokeGroup, iSpeakerGroup, iWaterGroup, iWindowGroup } from './groups';
+import { LogLevel } from '../enums';
+import { iRoomSettingsController } from './iRoomSettingsController';
+import { iIdHolder } from './iIdHolder';
+import { iDeviceCluster } from './iDevicecluster';
+import { ITimeCallback } from './ITimeCallback';
+/**
+ * This interface represents a room with it's base functionality.
+ * Whilst accessing the custom rooms can be beneficial for direct device interaction, this provides interactions to e.g. device groups.
+ */
+export interface iRoomBase extends iIdHolder {
+    /**
+     *
+     */
+    WindowGroup?: iWindowGroup;
+    /**
+     *
+     */
+    LightGroup?: iLightGroup;
+    /**
+     *
+     */
+    WaterGroup?: iWaterGroup;
+    /**
+     *
+     */
+    SmokeGroup?: iSmokeGroup;
+    /**
+     *
+     */
+    SonosGroup?: iSpeakerGroup;
+    /**
+     *
+     */
+    deviceCluster: iDeviceCluster;
+    /**
+     *
+     */
+    etage?: number;
+    /**
+     *
+     */
+    settings: iRoomSettingsController;
+    /**
+     *
+     */
+    PraesenzGroup: iPresenceGroup | undefined;
+    /**
+     *
+     */
+    HeatGroup: iHeatGroup | undefined;
+    /**
+     * The time-callback for controlling shutters at sunrise
+     */
+    sunriseShutterCallback: ITimeCallback | undefined;
+    /**
+     * The time-callback for controlling shutters at sunset
+     */
+    sunsetShutterCallback: ITimeCallback | undefined;
+    /**
+     * The time-callback for controlling light at sunrise
+     */
+    sonnenAufgangLichtCallback: ITimeCallback | undefined;
+    /**
+     * The time-callback for controlling light at sunset
+     */
+    sonnenUntergangLichtCallback: ITimeCallback | undefined;
+    /**
+     *
+     */
+    log(level: LogLevel, message: string): unknown;
+    /**
+     * Whether the next sunset shutter-up should be skipped (afterwards this resets to false)
+     */
+    skipNextRolloUp: boolean;
+    /**
+     * The name of the room
+     */
+    roomName: string;
+    /**
+     * The custom name of the room
+     */
+    customName: string;
+    /**
+     * This function initializes the roomBase object of this room
+     */
+    initializeBase(): void;
+    /**
+     * This function stores the roominformation to the database
+     */
+    persist(): void;
+    /**
+     * This function recalculates the ITimeCallbacks (e.g. sunset, sunrise handling)
+     */
+    recalcTimeCallbacks(): void;
+    /**
+     * This function sets the light in the room based on the command
+     * @param c - The command to execute
+     */
+    setLightTimeBased(c: RoomSetLightTimeBasedCommand): void;
+    /**
+     * This function checks if it is now light time respecting the room settings, the current time and the daylight hours for this location.
+     * @returns
+     */
+    isNowLightTime(): boolean;
+}

package/lib/interfaces/iRoomBase.js

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

package/lib/interfaces/iRoomDeviceAddingSettings.d.ts

@@ -0,0 +1,24 @@
+import { iRoomAddDeviceItem } from './iRoomAddDeviceItem';
+import { DeviceType } from '../enums';
+import { iRoomBase } from './iRoomBase';
+/**
+ *
+ */
+export interface iRoomDeviceAddingSettings {
+    /**
+     *
+     */
+    devices: iRoomAddDeviceItem[][];
+    /**
+     *
+     */
+    RoomName: string;
+    /**
+     *
+     */
+    addDevice(deviceType: DeviceType, setID: (value: string) => iRoomBase, index: number, customName: string | undefined): void;
+    /**
+     *
+     */
+    checkMissing(): void;
+}

package/lib/interfaces/iRoomDeviceAddingSettings.js

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

package/lib/interfaces/iRoomImportEnforcer.js

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