hoffmation-base 3.0.3 → 3.1.0

package/lib/models/groupSettings/heatGroupSettings.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeatGroupSettings = void 0;
-const server_1 = require("../../server");
-const groupSettings_1 = require("./groupSettings");
-class HeatGroupSettings extends groupSettings_1.GroupSettings {
-    constructor() {
-        super(...arguments);
-        /**
-         * The automatic points to use for the temperature calculation in automatic mode
-         */
-        this.automaticPoints = [];
-        /**
-         * Whether the temperature should be calculated automatically, or the manualTemperature should be used
-         * @default true
-         */
-        this.automaticMode = true;
-        /**
-         * The temperature to fall back to when automaticMode is enabled and no automaticPoint is found
-         * @default 20 Degrees Celsius
-         */
-        this.automaticFallBackTemperatur = 20;
-        /**
-         * Target temperature when automaticMode is disabled
-         * @default 20
-         */
-        this.manualTemperature = 20;
-    }
-    fromPartialObject(data) {
-        var _a, _b, _c, _d;
-        this.automaticPoints = (_a = data.automaticPoints) !== null && _a !== void 0 ? _a : this.automaticPoints;
-        this.automaticMode = (_b = data.automaticMode) !== null && _b !== void 0 ? _b : this.automaticMode;
-        this.manualTemperature = (_c = data.manualTemperature) !== null && _c !== void 0 ? _c : this.manualTemperature;
-        this.automaticFallBackTemperatur = (_d = data.automaticFallBackTemperatur) !== null && _d !== void 0 ? _d : this.automaticFallBackTemperatur;
-        super.fromPartialObject(data);
-    }
-    toJSON() {
-        return server_1.Utils.jsonFilter(this);
-    }
-    deleteAutomaticPoint(name, device) {
-        const currentIndex = this.automaticPoints.findIndex((v) => v.name === name);
-        if (currentIndex === -1) {
-            return;
-        }
-        this.automaticPoints.splice(currentIndex, 1);
-        this.persist(device);
-    }
-    setAutomaticPoint(setting, device) {
-        const currentIndex = this.automaticPoints.findIndex((v) => v.name === setting.name);
-        if (currentIndex === -1) {
-            this.automaticPoints.push(setting);
-        }
-        else {
-            this.automaticPoints[currentIndex] = setting;
-        }
-        this.persist(device);
-    }
-}
-exports.HeatGroupSettings = HeatGroupSettings;

package/lib/models/iIdHolder.d.ts

@@ -1,25 +0,0 @@
-import { LogLevel } from './logLevel';
-import { LogDebugType } from '../server';
-/**
- * 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/models/logSource.d.ts

@@ -1,4 +0,0 @@
-export declare enum LogSource {
-    NotSpecified = 0,
-    News = 1
-}

package/lib/models/logSource.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogSource = void 0;
-var LogSource;
-(function (LogSource) {
-    LogSource[LogSource["NotSpecified"] = 0] = "NotSpecified";
-    LogSource[LogSource["News"] = 1] = "News";
-})(LogSource || (exports.LogSource = LogSource = {}));

package/lib/models/objectSettings.d.ts

@@ -1,16 +0,0 @@
-import { iIdHolder } from './iIdHolder';
-export declare abstract class ObjectSettings {
-    /**
-     * Callback to be fired when the settings change
-     */
-    onChangeCb?: () => void;
-    persist(holder: iIdHolder): void;
-    /**
-     * Loads the settings from the database
-     * @param holder - The holder of the settings (e.g. a device)
-     * @param loadDoneCb - Callback when loading is done
-     */
-    initializeFromDb(holder: iIdHolder, loadDoneCb?: () => void): void;
-    fromPartialObject(_obj: Partial<ObjectSettings>): void;
-    protected toJSON(): Partial<ObjectSettings>;
-}

package/lib/models/objectSettings.js

@@ -1,53 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectSettings = void 0;
-const server_1 = require("../server");
-const logLevel_1 = require("./logLevel");
-const lodash_1 = __importDefault(require("lodash"));
-class ObjectSettings {
-    persist(holder) {
-        var _a;
-        (_a = server_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.persistSettings(holder.id, JSON.stringify(this), holder.customName);
-    }
-    /**
-     * Loads the settings from the database
-     * @param holder - The holder of the settings (e.g. a device)
-     * @param loadDoneCb - Callback when loading is done
-     */
-    initializeFromDb(holder, loadDoneCb) {
-        var _a;
-        (_a = server_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.loadSettings(holder.id).then((data) => {
-            if (!data) {
-                // Nothing in db yet
-                return;
-            }
-            let obj = null;
-            try {
-                obj = JSON.parse(data);
-            }
-            catch (e) {
-                holder.log(logLevel_1.LogLevel.Error, `Failed to parse Device Setting JSON (${e})`);
-            }
-            if (!obj) {
-                return;
-            }
-            this.fromPartialObject(obj);
-            if (JSON.stringify(this) !== data) {
-                this.persist(holder);
-            }
-            loadDoneCb === null || loadDoneCb === void 0 ? void 0 : loadDoneCb();
-        });
-    }
-    fromPartialObject(_obj) {
-        if (this.onChangeCb) {
-            this.onChangeCb();
-        }
-    }
-    toJSON() {
-        return server_1.Utils.jsonFilter(lodash_1.default.omit(this, ['onChangeCb']));
-    }
-}
-exports.ObjectSettings = ObjectSettings;

package/lib/models/rooms/RoomBase.d.ts

@@ -1,62 +0,0 @@
-import { TimeCallback } from '../timeCallback';
-import { BaseGroup, DeviceCluster, GroupType, HeatGroup, LightGroup, PresenceGroup, SmokeGroup, SpeakerGroup, TasterGroup, TrilaterationPoint, WaterGroup, WindowGroup } from '../../server';
-import { LogLevel } from '../logLevel';
-import { RoomSettingsController } from './RoomSettings';
-import { iRoomBase } from './iRoomBase';
-import { RoomInfo } from './roomInfo';
-import { iIdHolder } from '../iIdHolder';
-import { RoomSetLightTimeBasedCommand } from '../command';
-export declare class RoomBase implements iRoomBase, iIdHolder {
-    groupMap: Map<GroupType, BaseGroup>;
-    /**
-     * @see RoomInfo
-     */
-    info: RoomInfo;
-    /** @inheritDoc */
-    skipNextRolloUp: boolean;
-    /**
-     * The settings for this room
-     */
-    settings: RoomSettingsController;
-    constructor(groupMap: Map<GroupType, BaseGroup>, roomName: string, etage?: number, startPoint?: TrilaterationPoint, endPoint?: TrilaterationPoint);
-    get sonnenUntergangLichtCallback(): TimeCallback | undefined;
-    get sonnenAufgangLichtCallback(): TimeCallback | undefined;
-    get sunriseShutterCallback(): TimeCallback | undefined;
-    get sunsetShutterCallback(): TimeCallback | undefined;
-    /**
-     * For Rooms the id is itss name
-     * @returns The Roomname
-     */
-    get id(): string;
-    get customName(): string;
-    protected _deviceCluster: DeviceCluster;
-    get deviceCluster(): DeviceCluster;
-    get WindowGroup(): WindowGroup | undefined;
-    get PraesenzGroup(): PresenceGroup | undefined;
-    get LightGroup(): LightGroup | undefined;
-    get TasterGroup(): TasterGroup | undefined;
-    get SonosGroup(): SpeakerGroup | undefined;
-    get SmokeGroup(): SmokeGroup | undefined;
-    get WaterGroup(): WaterGroup | undefined;
-    get HeatGroup(): HeatGroup | undefined;
-    get roomName(): string;
-    get etage(): number | undefined;
-    initializeBase(): void;
-    persist(): void;
-    recalcTimeCallbacks(): void;
-    /**
-     * Sets the light based on the current time, rollo Position and room Settings
-     * @param c - The command to execute
-     */
-    setLightTimeBased(c: RoomSetLightTimeBasedCommand): void;
-    isNowLightTime(): boolean;
-    toJSON(): Partial<RoomBase & {
-        /**
-         * The dictionary representation of the group map
-         */
-        groupDict?: {
-            [p: string]: BaseGroup;
-        };
-    }>;
-    log(level: LogLevel, message: string): void;
-}

package/lib/models/rooms/RoomBase.js

@@ -1,172 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RoomBase = void 0;
-const timeCallback_1 = require("../timeCallback");
-const server_1 = require("../../server");
-const logLevel_1 = require("../logLevel");
-const RoomSettings_1 = require("./RoomSettings");
-const roomInfo_1 = require("./roomInfo");
-const lodash_1 = __importDefault(require("lodash"));
-const command_1 = require("../command");
-class RoomBase {
-    constructor(groupMap, roomName, etage = 99, startPoint, endPoint) {
-        this.groupMap = groupMap;
-        /** @inheritDoc */
-        this.skipNextRolloUp = false;
-        this._deviceCluster = new server_1.DeviceCluster();
-        this.info = new roomInfo_1.RoomInfo(roomName, etage);
-        this.settings = new RoomSettings_1.RoomSettingsController(this);
-        server_1.RoomService.addToRoomList(this);
-        if (startPoint !== undefined && endPoint !== undefined) {
-            server_1.Trilateration.addRoom(this, startPoint, endPoint);
-        }
-    }
-    get sonnenUntergangLichtCallback() {
-        var _a;
-        return (_a = this.LightGroup) === null || _a === void 0 ? void 0 : _a.sonnenUntergangLichtCallback;
-    }
-    get sonnenAufgangLichtCallback() {
-        var _a;
-        return (_a = this.LightGroup) === null || _a === void 0 ? void 0 : _a.sonnenAufgangLichtCallback;
-    }
-    get sunriseShutterCallback() {
-        var _a;
-        return (_a = this.WindowGroup) === null || _a === void 0 ? void 0 : _a.sunriseShutterCallback;
-    }
-    get sunsetShutterCallback() {
-        var _a;
-        return (_a = this.WindowGroup) === null || _a === void 0 ? void 0 : _a.sunsetShutterCallback;
-    }
-    /**
-     * For Rooms the id is itss name
-     * @returns The Roomname
-     */
-    get id() {
-        return this.roomName;
-    }
-    get customName() {
-        return this.roomName;
-    }
-    get deviceCluster() {
-        return this._deviceCluster;
-    }
-    get WindowGroup() {
-        return this.groupMap.get(server_1.GroupType.Window);
-    }
-    get PraesenzGroup() {
-        return this.groupMap.get(server_1.GroupType.Presence);
-    }
-    get LightGroup() {
-        return this.groupMap.get(server_1.GroupType.Light);
-    }
-    get TasterGroup() {
-        return this.groupMap.get(server_1.GroupType.Buttons);
-    }
-    get SonosGroup() {
-        return this.groupMap.get(server_1.GroupType.Speaker);
-    }
-    get SmokeGroup() {
-        return this.groupMap.get(server_1.GroupType.Smoke);
-    }
-    get WaterGroup() {
-        return this.groupMap.get(server_1.GroupType.Water);
-    }
-    get HeatGroup() {
-        return this.groupMap.get(server_1.GroupType.Heating);
-    }
-    get roomName() {
-        return this.info.roomName;
-    }
-    get etage() {
-        return this.info.etage;
-    }
-    initializeBase() {
-        var _a, _b, _c, _d, _e;
-        this.log(logLevel_1.LogLevel.Debug, `RoomBase Init für ${this.roomName}`);
-        this.recalcTimeCallbacks();
-        (_a = this.PraesenzGroup) === null || _a === void 0 ? void 0 : _a.initCallbacks();
-        (_b = this.WindowGroup) === null || _b === void 0 ? void 0 : _b.initialize();
-        (_c = this.LightGroup) === null || _c === void 0 ? void 0 : _c.initialize();
-        (_d = this.TasterGroup) === null || _d === void 0 ? void 0 : _d.initCallbacks();
-        (_e = this.HeatGroup) === null || _e === void 0 ? void 0 : _e.initialize();
-        for (const group of this.groupMap.values()) {
-            server_1.RoomService.Groups.set(group.id, group);
-        }
-    }
-    persist() {
-        var _a;
-        (_a = server_1.Utils.dbo) === null || _a === void 0 ? void 0 : _a.addRoom(this);
-    }
-    recalcTimeCallbacks() {
-        var _a, _b;
-        (_a = this.WindowGroup) === null || _a === void 0 ? void 0 : _a.recalcTimeCallbacks();
-        (_b = this.LightGroup) === null || _b === void 0 ? void 0 : _b.recalculateTimeCallbacks();
-    }
-    /**
-     * Sets the light based on the current time, rollo Position and room Settings
-     * @param c - The command to execute
-     */
-    setLightTimeBased(c) {
-        var _a;
-        if (!this.LightGroup) {
-            this.log(logLevel_1.LogLevel.Trace, 'Ignore "setLightTimeBased" as we have no lamps');
-            return;
-        }
-        if (c.movementDependant) {
-            if (!this.PraesenzGroup ||
-                this.PraesenzGroup.deviceCluster.getDevicesByType(server_1.DeviceClusterType.MotionDetection).length === 0) {
-                this.log(logLevel_1.LogLevel.Trace, 'Ignore movement dependant "setLightTimeBased" as we have no Presence Group or no sensors');
-                return;
-            }
-            if (!this.PraesenzGroup.anyPresent()) {
-                this.log(logLevel_1.LogLevel.Trace, 'Turn off lights as no-one is present.');
-                this.LightGroup.switchAll(new command_1.ActuatorSetStateCommand(c, false, 'No one is present --> Turn off lights.'));
-                return;
-            }
-        }
-        if (!this.settings.lampOffset && !this.settings.roomIsAlwaysDark) {
-            this.log(logLevel_1.LogLevel.Alert, `Beim Aufruf von "setLightTimeBased" im Raum ${this.roomName} liegt kein Lampen Offset vor`);
-            return;
-        }
-        let timeOfDay = this.settings.roomIsAlwaysDark
-            ? timeCallback_1.TimeOfDay.Night
-            : server_1.TimeCallbackService.dayType(this.settings.lampOffset);
-        if (timeOfDay === timeCallback_1.TimeOfDay.Daylight &&
-            ((this.settings.lightIfNoWindows && (!this.WindowGroup || this.WindowGroup.windows.length === 0)) ||
-                ((_a = this.WindowGroup) === null || _a === void 0 ? void 0 : _a.windows.some((f) => {
-                    return server_1.ShutterService.anyRolloDown(f.getShutter());
-                })))) {
-            timeOfDay = server_1.Utils.nowTime().hours > 16 ? timeCallback_1.TimeOfDay.AfterSunset : timeCallback_1.TimeOfDay.BeforeSunrise;
-        }
-        this.LightGroup.switchTimeConditional(new command_1.LightGroupSwitchTimeConditionalCommand(c, timeOfDay, `time: ${timeCallback_1.TimeOfDay[timeOfDay]}`));
-    }
-    isNowLightTime() {
-        var _a;
-        if (!this.settings.lampOffset && !this.settings.roomIsAlwaysDark) {
-            this.log(logLevel_1.LogLevel.Alert, `Beim Aufruf von "setLightTimeBased" im Raum ${this.roomName} liegt kein Lampen Offset vor`);
-            return false;
-        }
-        let timeOfDay = this.settings.roomIsAlwaysDark
-            ? timeCallback_1.TimeOfDay.Night
-            : server_1.TimeCallbackService.dayType(this.settings.lampOffset);
-        if (timeOfDay === timeCallback_1.TimeOfDay.Daylight &&
-            ((_a = this.WindowGroup) === null || _a === void 0 ? void 0 : _a.windows.some((f) => {
-                return server_1.ShutterService.anyRolloDown(f.getShutter());
-            }))) {
-            timeOfDay = timeCallback_1.TimeOfDay.AfterSunset;
-        }
-        return server_1.TimeCallbackService.darkOutsideOrNight(timeOfDay);
-    }
-    toJSON() {
-        return server_1.Utils.jsonFilter(lodash_1.default.omit(this, ['_deviceCluster']));
-    }
-    log(level, message) {
-        server_1.ServerLogService.writeLog(level, message, {
-            room: this.roomName,
-        });
-    }
-}
-exports.RoomBase = RoomBase;

package/lib/models/rooms/RoomSettings/iRoomDefaultSettings.d.ts

@@ -1,78 +0,0 @@
-import { iTimePair } from '../../../server';
-/**
- * Default settings for a room, which can then be overwritten by the room settings for each specific room
- */
-export interface iRoomDefaultSettings {
-    /**
-     * @see RoomSettings.radioUrl
-     */
-    readonly radioUrl?: string;
-    /**
-     * @see RoomSettings.rolloHeatReduction
-     */
-    readonly rolloHeatReduction: boolean;
-    /**
-     * @see RoomSettings.roomIsAlwaysDark
-     */
-    readonly roomIsAlwaysDark: boolean;
-    /**
-     * @see RoomSettings.lampenBeiBewegung
-     */
-    readonly lampenBeiBewegung: boolean;
-    /**
-     * @see RoomSettings.lichtSonnenAufgangAus
-     */
-    readonly lichtSonnenAufgangAus: boolean;
-    /**
-     * @see RoomSettings.sonnenUntergangRollos
-     */
-    readonly sonnenUntergangRollos: boolean;
-    /**
-     * @see RoomSettings.sonnenUntergangRolloDelay
-     */
-    readonly sonnenUntergangRolloDelay: number;
-    /**
-     * @see RoomSettings.sonnenUntergangRolloMaxTime
-     */
-    readonly sonnenUntergangRolloMaxTime: iTimePair;
-    /**
-     * @see RoomSettings.sonnenUntergangLampenDelay
-     */
-    readonly sonnenUntergangLampenDelay: number;
-    /**
-     * @see RoomSettings.sonnenUntergangRolloAdditionalOffsetPerCloudiness
-     */
-    readonly sonnenUntergangRolloAdditionalOffsetPerCloudiness: number;
-    /**
-     * @see RoomSettings.sonnenUntergangRollos
-     */
-    readonly sonnenAufgangRollos: boolean;
-    /**
-     * @see RoomSettings.sonnenAufgangRolloDelay
-     */
-    readonly sonnenAufgangRolloDelay: number;
-    /**
-     * @see RoomSettings.sonnenAufgangRolloMinTime
-     */
-    readonly sonnenAufgangRolloMinTime: iTimePair;
-    /**
-     * @see RoomSettings.sonnenAufgangLampenDelay
-     */
-    readonly sonnenAufgangLampenDelay: number;
-    /**
-     * @see RoomSettings.movementResetTimer
-     */
-    readonly movementResetTimer: number;
-    /**
-     * @see RoomSettings.lightIfNoWindows
-     */
-    readonly lightIfNoWindows: boolean;
-    /**
-     * @see RoomSettings.ambientLightAfterSunset
-     */
-    readonly ambientLightAfterSunset: boolean;
-    /**
-     * @see RoomSettings.includeLampsInNormalMovementLightning
-     */
-    readonly includeLampsInNormalMovementLightning: boolean;
-}

package/lib/models/rooms/RoomSettings/iRoomInitializationSettings.d.ts

@@ -1,14 +0,0 @@
-import { RoomDeviceAddingSettings } from './roomDeviceAddingSettings';
-/**
- * The settings for initializing a room (after Devices are generated) to add devices to the room
- */
-export interface iRoomInitializationSettings {
-    /**
-     * The settings for adding a device to the room
-     */
-    deviceAddingSettings?: RoomDeviceAddingSettings;
-    /**
-     * The short name of the room
-     */
-    shortName: string;
-}

package/lib/models/rooms/iRoomBase.d.ts

@@ -1,54 +0,0 @@
-import { TimeCallback } from '../timeCallback';
-import { RoomSetLightTimeBasedCommand } from '../command';
-/**
- * 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 {
-    /**
-     * The time-callback for controlling shutters at sunrise
-     */
-    sunriseShutterCallback: TimeCallback | undefined;
-    /**
-     * The time-callback for controlling shutters at sunset
-     */
-    sunsetShutterCallback: TimeCallback | undefined;
-    /**
-     * The time-callback for controlling light at sunrise
-     */
-    sonnenAufgangLichtCallback: TimeCallback | undefined;
-    /**
-     * The time-callback for controlling light at sunset
-     */
-    sonnenUntergangLichtCallback: TimeCallback | undefined;
-    /**
-     * Whether the next sunset shutter-up should be skipped (afterwards this resets to false)
-     */
-    skipNextRolloUp: boolean;
-    /**
-     * The name of the room
-     */
-    roomName: 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 timecallbacks (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/models/temperatureSettings.d.ts

@@ -1,11 +0,0 @@
-import { Daytime } from './daytime';
-export declare class TemperatureSettings {
-    start: Daytime;
-    end: Daytime;
-    temperature: number;
-    name: string;
-    active: boolean;
-    constructor(start: Daytime, end: Daytime, temperature: number, name: string, active?: boolean);
-    static getActiveSetting(settings: TemperatureSettings[], date: Date): TemperatureSettings | undefined;
-    static isNowInRange(setting: TemperatureSettings, date: Date): boolean;
-}

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

@@ -1,23 +0,0 @@
-import { CollisionSolving } from '../../models';
-/**
- * These settings control the desired behaviour of {@link BlockAutomaticHandler}.
- * Unless decided within a command this will determine the default behaviour.
- *
- * So this will e.g. be used when a Homebridge-Hoffmation instance
- * e.g. issues a command to turn a light on as with this command no block
- * duration or behaviour is specified.
- */
-export interface iBlockAutomaticHandlerDefaults {
-    /**
-     * Whether at Block-Lift the desired automatic state should be restored.
-     */
-    revertToAutomaticAtBlockLift?: boolean;
-    /**
-     * The default duration in milliseconds for a block to be on any force action.
-     */
-    blockAutomaticDurationMS?: number;
-    /**
-     * The default collision solving strategy to use.
-     */
-    defaultCollisionSolving?: CollisionSolving;
-}