hoffmation-base 3.0.0-alpha.8 → 3.0.0-alpha.81

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

@@ -1,16 +1,64 @@
 import { DimmerSettings } from './dimmerSettings';
 export declare class WledSettings extends DimmerSettings {
+    /**
+     * @inheritDoc
+     * @default false
+     */
     dayOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 100
+     */
     dayBrightness: number;
+    /**
+     * @inheritDoc
+     * @default true
+     */
     dawnOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 50
+     */
     dawnBrightness: number;
+    /**
+     * @inheritDoc
+     * @default true
+     */
     duskOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 50
+     */
     duskBrightness: number;
+    /**
+     * @inheritDoc
+     * @default true
+     */
     nightOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 2
+     */
     nightBrightness: number;
+    /**
+     * The preset to use during the dawn
+     * @default undefined (no preset)
+     */
     dawnPreset?: number;
+    /**
+     * The preset to use during the day
+     * @default undefined (no preset)
+     */
     dayPreset?: number;
+    /**
+     * The preset to use during the dusk
+     * @default undefined (no preset)
+     */
     duskPreset?: number;
+    /**
+     * The preset to use during the night
+     * @default undefined (no preset)
+     */
     nightPreset?: number;
     fromPartialObject(data: Partial<WledSettings>): void;
     protected toJSON(): Partial<WledSettings>;

package/lib/models/deviceSettings/wledSettings.js

@@ -6,29 +6,53 @@ const server_1 = require("../../server");
 class WledSettings extends dimmerSettings_1.DimmerSettings {
     constructor() {
         super(...arguments);
+        /**
+         * @inheritDoc
+         * @default false
+         */
         this.dayOn = false;
+        /**
+         * @inheritDoc
+         * @default 100
+         */
         this.dayBrightness = 100;
+        /**
+         * @inheritDoc
+         * @default true
+         */
         this.dawnOn = true;
+        /**
+         * @inheritDoc
+         * @default 50
+         */
         this.dawnBrightness = 50;
+        /**
+         * @inheritDoc
+         * @default true
+         */
         this.duskOn = true;
+        /**
+         * @inheritDoc
+         * @default 50
+         */
         this.duskBrightness = 50;
+        /**
+         * @inheritDoc
+         * @default true
+         */
         this.nightOn = true;
+        /**
+         * @inheritDoc
+         * @default 2
+         */
         this.nightBrightness = 2;
     }
     fromPartialObject(data) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-        this.dayOn = (_a = data.dayOn) !== null && _a !== void 0 ? _a : this.dayOn;
-        this.dayBrightness = (_b = data.dayBrightness) !== null && _b !== void 0 ? _b : this.dayBrightness;
-        this.dawnOn = (_c = data.dawnOn) !== null && _c !== void 0 ? _c : this.dawnOn;
-        this.dawnBrightness = (_d = data.dawnBrightness) !== null && _d !== void 0 ? _d : this.dawnBrightness;
-        this.duskOn = (_e = data.duskOn) !== null && _e !== void 0 ? _e : this.duskOn;
-        this.duskBrightness = (_f = data.duskBrightness) !== null && _f !== void 0 ? _f : this.duskBrightness;
-        this.nightOn = (_g = data.nightOn) !== null && _g !== void 0 ? _g : this.nightOn;
-        this.nightBrightness = (_h = data.nightBrightness) !== null && _h !== void 0 ? _h : this.nightBrightness;
-        this.dawnPreset = (_j = data.dawnPreset) !== null && _j !== void 0 ? _j : this.dawnPreset;
-        this.dayPreset = (_k = data.dayPreset) !== null && _k !== void 0 ? _k : this.dayPreset;
-        this.duskPreset = (_l = data.duskPreset) !== null && _l !== void 0 ? _l : this.duskPreset;
-        this.nightPreset = (_m = data.nightPreset) !== null && _m !== void 0 ? _m : this.nightPreset;
+        var _a, _b, _c, _d;
+        this.dawnPreset = (_a = data.dawnPreset) !== null && _a !== void 0 ? _a : this.dawnPreset;
+        this.dayPreset = (_b = data.dayPreset) !== null && _b !== void 0 ? _b : this.dayPreset;
+        this.duskPreset = (_c = data.duskPreset) !== null && _c !== void 0 ? _c : this.duskPreset;
+        this.nightPreset = (_d = data.nightPreset) !== null && _d !== void 0 ? _d : this.nightPreset;
         super.fromPartialObject(data);
     }
     toJSON() {

package/lib/models/groupSettings/heatGroupSettings.d.ts

@@ -2,12 +2,23 @@ import { TemperatureSettings } from '../temperatureSettings';
 import { iIdHolder } from '../iIdHolder';
 import { GroupSettings } from './groupSettings';
 export declare class HeatGroupSettings extends GroupSettings {
+    /**
+     * The automatic points to use for the temperature calculation in automatic mode
+     */
     automaticPoints: TemperatureSettings[];
+    /**
+     * Whether the temperature should be calculated automatically, or the manualTemperature should be used
+     * @default true
+     */
     automaticMode: boolean;
+    /**
+     * The temperature to fall back to when automaticMode is enabled and no automaticPoint is found
+     * @default 20 Degrees Celsius
+     */
     automaticFallBackTemperatur: number;
     /**
      * Target temperature when automaticMode is disabled
-     * @type {number}
+     * @default 20
      */
     manualTemperature: number;
     fromPartialObject(data: Partial<HeatGroupSettings>): void;

package/lib/models/groupSettings/heatGroupSettings.js

@@ -6,12 +6,23 @@ 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
-         * @type {number}
+         * @default 20
          */
         this.manualTemperature = 20;
     }

package/lib/models/iIdHolder.d.ts

@@ -1,7 +1,25 @@
 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/index.d.ts

@@ -1,3 +1,4 @@
+export * from './action/index';
 export * from './rooms/index';
 export * from './deviceSettings/index';
 export * from './persistence/index';
@@ -8,8 +9,8 @@ export * from './command';
 export * from './daytime';
 export * from './deviceConfig';
 export * from './excessEnergyConsumerSettings';
-export * from './iTemperaturDataPoint';
 export * from './logLevel';
 export * from './objectSettings';
 export * from './temperatureSettings';
 export * from './timeCallback';
+export { BlockAutomaticSettings } from './blockAutomaticSettings';

package/lib/models/index.js

@@ -14,6 +14,8 @@ 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 });
+exports.BlockAutomaticSettings = void 0;
+__exportStar(require("./action/index"), exports);
 __exportStar(require("./rooms/index"), exports);
 __exportStar(require("./deviceSettings/index"), exports);
 __exportStar(require("./persistence/index"), exports);
@@ -24,8 +26,9 @@ __exportStar(require("./command"), exports);
 __exportStar(require("./daytime"), exports);
 __exportStar(require("./deviceConfig"), exports);
 __exportStar(require("./excessEnergyConsumerSettings"), exports);
-__exportStar(require("./iTemperaturDataPoint"), exports);
 __exportStar(require("./logLevel"), exports);
 __exportStar(require("./objectSettings"), exports);
 __exportStar(require("./temperatureSettings"), exports);
 __exportStar(require("./timeCallback"), exports);
+var blockAutomaticSettings_1 = require("./blockAutomaticSettings");
+Object.defineProperty(exports, "BlockAutomaticSettings", { enumerable: true, get: function () { return blockAutomaticSettings_1.BlockAutomaticSettings; } });

package/lib/models/objectSettings.d.ts

@@ -1,11 +1,14 @@
 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 {iIdHolder} holder The holder of the settings (e.g. a device)
-     * @param {() => void} loadDoneCb Callback when loading is done
+     * @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;

package/lib/models/objectSettings.js

@@ -14,8 +14,8 @@ class ObjectSettings {
     }
     /**
      * Loads the settings from the database
-     * @param {iIdHolder} holder The holder of the settings (e.g. a device)
-     * @param {() => void} loadDoneCb Callback when loading is done
+     * @param holder - The holder of the settings (e.g. a device)
+     * @param loadDoneCb - Callback when loading is done
      */
     initializeFromDb(holder, loadDoneCb) {
         var _a;

package/lib/models/persistence/EnergyCalculation.d.ts

@@ -2,14 +2,41 @@ import { LogLevel } from '../logLevel';
 import { LogDebugType } from '../../server';
 export declare class EnergyCalculation {
     startMs: number;
+    /**
+     * The amount of energy drawn from the grid in kWh since the last calculation
+     */
     drawnKwH: number;
+    /**
+     * The amount of energy injected into the grid in kWh since the last calculation
+     */
     injectedKwH: number;
+    /**
+     * The amount of energy self consumed in kWh since the last calculation
+     */
     selfConsumedKwH: number;
+    /**
+     * The cost of the energy drawn from the grid since the last calculation
+     */
     costDrawn: number;
+    /**
+     * The money earned by injecting energy into the grid since the last calculation
+     */
     earnedInjected: number;
+    /**
+     * The amount of money saved by self consuming energy since the last calculation
+     */
     savedSelfConsume: number;
+    /**
+     * The timestamp of the end of this calculation
+     */
     endMs: number;
+    /**
+     * The amount of energy stored in the battery in kWh since the last calculation
+     */
     batteryStoredKwH: number;
+    /**
+     * Current battery level in %
+     */
     batteryLevel: number;
     constructor(startMs: number);
     static persist(obj: EnergyCalculation, endMs: number, logger: (level: LogLevel, message: string, logDebugType?: LogDebugType) => void): boolean;

package/lib/models/persistence/EnergyCalculation.js

@@ -6,25 +6,51 @@ const server_1 = require("../../server");
 class EnergyCalculation {
     constructor(startMs) {
         this.startMs = startMs;
+        /**
+         * The amount of energy drawn from the grid in kWh since the last calculation
+         */
         this.drawnKwH = 0;
+        /**
+         * The amount of energy injected into the grid in kWh since the last calculation
+         */
         this.injectedKwH = 0;
+        /**
+         * The amount of energy self consumed in kWh since the last calculation
+         */
         this.selfConsumedKwH = 0;
+        /**
+         * The cost of the energy drawn from the grid since the last calculation
+         */
         this.costDrawn = 0;
+        /**
+         * The money earned by injecting energy into the grid since the last calculation
+         */
         this.earnedInjected = 0;
+        /**
+         * The amount of money saved by self consuming energy since the last calculation
+         */
         this.savedSelfConsume = 0;
+        /**
+         * The timestamp of the end of this calculation
+         */
         this.endMs = 0;
+        /**
+         * The amount of energy stored in the battery in kWh since the last calculation
+         */
         this.batteryStoredKwH = 0;
-        // Battery Level in %
+        /**
+         * Current battery level in %
+         */
         this.batteryLevel = 0.0;
     }
     static persist(obj, endMs, logger) {
         var _a, _b, _c, _d, _e, _f, _g, _h;
         if (obj.drawnKwH === 0 && obj.injectedKwH === 0 && obj.selfConsumedKwH === 0) {
-            logger(logLevel_1.LogLevel.Warn, `Not persisting energy Data, as all values are 0.`);
+            logger(logLevel_1.LogLevel.Warn, 'Not persisting energy Data, as all values are 0.');
             return false;
         }
         if (!((_a = server_1.SettingsService.settings.energyManager) === null || _a === void 0 ? void 0 : _a.wattagePrice)) {
-            logger(logLevel_1.LogLevel.Warn, `Wattage price not set, assuming average of 34ct.`);
+            logger(logLevel_1.LogLevel.Warn, 'Wattage price not set, assuming average of 34ct.');
         }
         obj.endMs = endMs;
         obj.earnedInjected = server_1.Utils.round(obj.injectedKwH * ((_c = (_b = server_1.SettingsService.settings.energyManager) === null || _b === void 0 ? void 0 : _b.injectWattagePrice) !== null && _c !== void 0 ? _c : 0.06), 4);
@@ -36,7 +62,7 @@ class EnergyCalculation {
         obj.batteryStoredKwH = server_1.Utils.round(obj.batteryStoredKwH, 3);
         obj.batteryLevel = server_1.Utils.round(obj.batteryLevel, 3);
         (_h = server_1.Utils.dbo) === null || _h === void 0 ? void 0 : _h.persistEnergyManager(obj);
-        logger(logLevel_1.LogLevel.Info, `Persisting energy Manager Data.`);
+        logger(logLevel_1.LogLevel.Info, 'Persisting energy Manager Data.');
         return true;
     }
 }

package/lib/models/persistence/index.d.ts

@@ -2,7 +2,5 @@ export * from './BasicRoomInfo';
 export * from './DesiredShutterPosition';
 export * from './EnergyCalculation';
 export * from './idSettings';
-export * from './RoomDetailInfo';
 export * from './ShutterCalibration';
-export * from './temperaturDataPoint';
 export * from './todaysCount';

package/lib/models/persistence/index.js

@@ -18,7 +18,5 @@ __exportStar(require("./BasicRoomInfo"), exports);
 __exportStar(require("./DesiredShutterPosition"), exports);
 __exportStar(require("./EnergyCalculation"), exports);
 __exportStar(require("./idSettings"), exports);
-__exportStar(require("./RoomDetailInfo"), exports);
 __exportStar(require("./ShutterCalibration"), exports);
-__exportStar(require("./temperaturDataPoint"), exports);
 __exportStar(require("./todaysCount"), exports);

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

@@ -8,8 +8,15 @@ 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;
@@ -18,7 +25,7 @@ export declare class RoomBase implements iRoomBase, iIdHolder {
     get sunsetShutterCallback(): TimeCallback | undefined;
     /**
      * For Rooms the id is itss name
-     * @returns {string} The Roomname
+     * @returns The Roomname
      */
     get id(): string;
     get customName(): string;
@@ -39,10 +46,14 @@ export declare class RoomBase implements iRoomBase, iIdHolder {
     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;
         };

package/lib/models/rooms/RoomBase.js

@@ -14,6 +14,7 @@ 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);
@@ -41,7 +42,7 @@ class RoomBase {
     }
     /**
      * For Rooms the id is itss name
-     * @returns {string} The Roomname
+     * @returns The Roomname
      */
     get id() {
         return this.roomName;
@@ -106,17 +107,25 @@ class RoomBase {
     }
     /**
      * Sets the light based on the current time, rollo Position and room Settings
+     * @param c - The command to execute
      */
     setLightTimeBased(c) {
-        var _a, _b;
+        var _a;
         if (!this.LightGroup) {
             this.log(logLevel_1.LogLevel.Trace, 'Ignore "setLightTimeBased" as we have no lamps');
             return;
         }
-        if (c.movementDependant && this.PraesenzGroup && !((_a = this.PraesenzGroup) === null || _a === void 0 ? void 0 : _a.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 (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`);
@@ -127,12 +136,12 @@ class RoomBase {
             : server_1.TimeCallbackService.dayType(this.settings.lampOffset);
         if (timeOfDay === timeCallback_1.TimeOfDay.Daylight &&
             ((this.settings.lightIfNoWindows && (!this.WindowGroup || this.WindowGroup.windows.length === 0)) ||
-                ((_b = this.WindowGroup) === null || _b === void 0 ? void 0 : _b.windows.some((f) => {
+                ((_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));
+        this.LightGroup.switchTimeConditional(new command_1.LightGroupSwitchTimeConditionalCommand(c, timeOfDay, `time: ${timeCallback_1.TimeOfDay[timeOfDay]}`));
     }
     isNowLightTime() {
         var _a;

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

@@ -2,7 +2,8 @@ import { iRoomInitializationSettings } from './iRoomInitializationSettings';
 import { RoomDeviceAddingSettings } from './roomDeviceAddingSettings';
 export declare class RoomInitializationSettings implements iRoomInitializationSettings {
     shortName: string;
-    deviceAddidngSettings?: RoomDeviceAddingSettings;
+    /** @inheritDoc */
+    deviceAddingSettings?: RoomDeviceAddingSettings;
     constructor(shortName: string);
     static registerRoomForDevices(roomInitializationSettings: RoomInitializationSettings): void;
 }

package/lib/models/rooms/RoomSettings/RoomInitializationSettings.js

@@ -7,8 +7,8 @@ class RoomInitializationSettings {
         this.shortName = shortName;
     }
     static registerRoomForDevices(roomInitializationSettings) {
-        if (roomInitializationSettings.deviceAddidngSettings !== undefined) {
-            server_1.IoBrokerBaseDevice.addRoom(roomInitializationSettings.shortName, roomInitializationSettings.deviceAddidngSettings);
+        if (roomInitializationSettings.deviceAddingSettings !== undefined) {
+            server_1.IoBrokerBaseDevice.addRoom(roomInitializationSettings.shortName, roomInitializationSettings.deviceAddingSettings);
         }
     }
 }

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

@@ -3,11 +3,20 @@ import { iRoomDefaultSettings } from './iRoomDefaultSettings';
 import { iTimePair, SunTimeOffsets } from '../../../server';
 import { RoomSettings } from './roomSettings';
 export declare class RoomSettingsController implements iRoomDefaultSettings {
-    constructor(room: RoomBase);
+    /**
+     * The name of the room this settings are for
+     */
     roomName: string;
+    /**
+     * The offset used for shutter sunrise/sunset actions
+     */
     rolloOffset: SunTimeOffsets;
+    /**
+     * The offset used for lamp sunrise/sunset actions
+     */
     lampOffset: SunTimeOffsets;
     private _settingsContainer;
+    constructor(room: RoomBase);
     get settingsContainer(): RoomSettings;
     get lichtSonnenAufgangAus(): boolean;
     get ambientLightAfterSunset(): boolean;

package/lib/models/rooms/RoomSettings/RoomSettingsController.js

@@ -16,7 +16,7 @@ class RoomSettingsController {
         this.lampOffset = new server_1.SunTimeOffsets(this.sonnenAufgangLampenDelay, this.sonnenUntergangLampenDelay);
         this._settingsContainer.onChangeCb = this.onSettingChange.bind(this);
         this._settingsContainer.initializeFromDb(room);
-        server_1.WeatherService.addWeatherUpdateCb(`RolloWeatherUpdate${this.roomName}`, () => {
+        server_1.WeatherService.addWeatherUpdateCb(`ShutterWeatherUpdate${this.roomName}`, () => {
             var _a;
             if (this.sonnenUntergangRolloAdditionalOffsetPerCloudiness > 0) {
                 (_a = this.room) === null || _a === void 0 ? void 0 : _a.recalcTimeCallbacks();
@@ -88,7 +88,7 @@ class RoomSettingsController {
     }
     toJSON() {
         const result = server_1.Utils.jsonFilter(this);
-        return lodash_1.default.omit(result, [`defaultSettings`, 'deviceAddidngSettings']);
+        return lodash_1.default.omit(result, ['defaultSettings', 'deviceAddidngSettings']);
     }
     onSettingChange() {
         server_1.ServerLogService.writeLog(logLevel_1.LogLevel.Info, `${this.roomName} RoomSettingsController.onSettingChange`);

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

@@ -1,28 +1,78 @@
 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 {
     /**
-     * The default radio URL to use with speaker
+     * @see RoomSettings.radioUrl
      */
     readonly radioUrl?: string;
+    /**
+     * @see RoomSettings.rolloHeatReduction
+     */
     readonly rolloHeatReduction: boolean;
     /**
-     * Indicates rooms, which are time independent always dark (like basement).
-     * This results in lamps beeing turned on on motion regardless of windows and time.
+     * @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;
 }