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

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

@@ -1,9 +1,29 @@
 import { ActuatorSettings } from './actuatorSettings';
 export declare class DimmerSettings extends ActuatorSettings {
+    /**
+     * The desired brightness of the light during the night.
+     * @default 50
+     */
     nightBrightness: number;
+    /**
+     * The desired brightness of the light during the dawn.
+     * @default 75
+     */
     dawnBrightness: number;
+    /**
+     * The desired brightness of the light during the dusk.
+     * @default 75
+     */
     duskBrightness: number;
+    /**
+     * The desired brightness of the light during the day.
+     * @default 100
+     */
     dayBrightness: number;
+    /**
+     * Some LED dimmers have a turn on threshold, which is the minimum brightness to turn on.
+     * Hoffmation afterwards dims down the light to the desired brightness.
+     */
     turnOnThreshhold: number;
     fromPartialObject(data: Partial<DimmerSettings>): void;
     protected toJSON(): Partial<DimmerSettings>;

package/lib/models/deviceSettings/dimmerSettings.js

@@ -6,10 +6,30 @@ const server_1 = require("../../server");
 class DimmerSettings extends actuatorSettings_1.ActuatorSettings {
     constructor() {
         super(...arguments);
+        /**
+         * The desired brightness of the light during the night.
+         * @default 50
+         */
         this.nightBrightness = 50;
+        /**
+         * The desired brightness of the light during the dawn.
+         * @default 75
+         */
         this.dawnBrightness = 75;
+        /**
+         * The desired brightness of the light during the dusk.
+         * @default 75
+         */
         this.duskBrightness = 75;
+        /**
+         * The desired brightness of the light during the day.
+         * @default 100
+         */
         this.dayBrightness = 100;
+        /**
+         * Some LED dimmers have a turn on threshold, which is the minimum brightness to turn on.
+         * Hoffmation afterwards dims down the light to the desired brightness.
+         */
         this.turnOnThreshhold = -1;
     }
     fromPartialObject(data) {

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

@@ -2,7 +2,6 @@ import { DeviceSettings } from './deviceSettings';
 export declare class GarageDoorOpenerSettings extends DeviceSettings {
     /**
      * In case the sensor detects open door instead of closed
-     * @type {boolean}
      */
     invertSensor: boolean;
     fromPartialObject(data: Partial<GarageDoorOpenerSettings>): void;

package/lib/models/deviceSettings/garageDoorOpenerSettings.js

@@ -8,7 +8,6 @@ class GarageDoorOpenerSettings extends deviceSettings_1.DeviceSettings {
         super(...arguments);
         /**
          * In case the sensor detects open door instead of closed
-         * @type {boolean}
          */
         this.invertSensor = false;
     }

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

@@ -1,7 +1,16 @@
 import { DeviceSettings } from './deviceSettings';
 export declare class HandleSettings extends DeviceSettings {
+    /**
+     * Whether to inform the user when the handle is opened.
+     */
     informOnOpen: boolean;
+    /**
+     * Whether to inform the user when the handle (and respectivly the window) is not helping in regards to the outside temperature being beneficial for the inside temperature.
+     */
     informNotHelping: boolean;
+    /**
+     * Whether to inform the user when the handle (and respectivly the window) is helping in regards to the outside temperature being beneficial for the inside temperature.
+     */
     informIsHelping: boolean;
     fromPartialObject(data: Partial<HandleSettings>): void;
     protected toJSON(): Partial<HandleSettings>;

package/lib/models/deviceSettings/handleSettings.js

@@ -6,8 +6,17 @@ const deviceSettings_1 = require("./deviceSettings");
 class HandleSettings extends deviceSettings_1.DeviceSettings {
     constructor() {
         super(...arguments);
+        /**
+         * Whether to inform the user when the handle is opened.
+         */
         this.informOnOpen = true;
+        /**
+         * Whether to inform the user when the handle (and respectivly the window) is not helping in regards to the outside temperature being beneficial for the inside temperature.
+         */
         this.informNotHelping = true;
+        /**
+         * Whether to inform the user when the handle (and respectivly the window) is helping in regards to the outside temperature being beneficial for the inside temperature.
+         */
         this.informIsHelping = true;
     }
     fromPartialObject(data) {

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

@@ -1,38 +1,50 @@
 import { DeviceSettings } from './deviceSettings';
 export declare class HeaterSettings extends DeviceSettings {
+    /**
+     * Whether this device should be in automatic mode
+     * @default true
+     */
     automaticMode: boolean;
+    /**
+     * Whether this device should use it's own temperature or just rely on the room temperature (e.g. for a floor heating system being in a different room)
+     * @default true
+     */
     useOwnTemperatur: boolean;
     /**
      * Whether this device should be controlled using only valve position
-     * !! Only certain devices allow direct controlling of valve Position !!
-     * @type {boolean}
+     * @default false
+     * @warning Only certain devices allow direct controlling of valve Position
      */
     controlByPid: boolean;
+    /**
+     * Whether this device should be controlled by offsetting the device temperature and it's target temperature.
+     * @default false
+     * @remark This is mainly needed for devices not allowing a separate control of valve position or temperature.
+     */
     controlByTempDiff: boolean;
     /**
      * Whether this device should turn off at Start of summer season and only heat in winter
-     * @type {boolean}
+     * @default true
      */
     seasonalTurnOffActive: boolean;
     /**
-     *
      * The day in a year after which SeasonalHeater should be turned off completly
-     * @type {number}
+     * @default 99 (Roughly in April)
      */
     seasonTurnOffDay: number;
     /**
      * The day in a year after which SeasonalHeater should be turned to automatic
-     * @type {number}
+     * @default 267 (Roughly in September)
      */
     seasonTurnOnDay: number;
     /**
      * In case of pid Control the forced minimum percentage for this heater valve
-     * @type {number}
+     * @default 1
      */
     pidForcedMinimum: number;
     /**
-     * Whether this AC should be turned off for some time manually
-     * @type {boolean}
+     * Whether this Heater should be turned off for some time manually
+     * @default false
      */
     manualDisabled: boolean;
     fromPartialObject(data: Partial<HeaterSettings>): void;

package/lib/models/deviceSettings/heaterSettings.js

@@ -6,39 +6,51 @@ const server_1 = require("../../server");
 class HeaterSettings extends deviceSettings_1.DeviceSettings {
     constructor() {
         super(...arguments);
+        /**
+         * Whether this device should be in automatic mode
+         * @default true
+         */
         this.automaticMode = true;
+        /**
+         * Whether this device should use it's own temperature or just rely on the room temperature (e.g. for a floor heating system being in a different room)
+         * @default true
+         */
         this.useOwnTemperatur = true;
         /**
          * Whether this device should be controlled using only valve position
-         * !! Only certain devices allow direct controlling of valve Position !!
-         * @type {boolean}
+         * @default false
+         * @warning Only certain devices allow direct controlling of valve Position
          */
         this.controlByPid = false;
+        /**
+         * Whether this device should be controlled by offsetting the device temperature and it's target temperature.
+         * @default false
+         * @remark This is mainly needed for devices not allowing a separate control of valve position or temperature.
+         */
         this.controlByTempDiff = false;
         /**
          * Whether this device should turn off at Start of summer season and only heat in winter
-         * @type {boolean}
+         * @default true
          */
         this.seasonalTurnOffActive = true;
         /**
-         *
          * The day in a year after which SeasonalHeater should be turned off completly
-         * @type {number}
+         * @default 99 (Roughly in April)
          */
         this.seasonTurnOffDay = 99;
         /**
          * The day in a year after which SeasonalHeater should be turned to automatic
-         * @type {number}
+         * @default 267 (Roughly in September)
          */
         this.seasonTurnOnDay = 267;
         /**
          * In case of pid Control the forced minimum percentage for this heater valve
-         * @type {number}
+         * @default 1
          */
         this.pidForcedMinimum = 1;
         /**
-         * Whether this AC should be turned off for some time manually
-         * @type {boolean}
+         * Whether this Heater should be turned off for some time manually
+         * @default false
          */
         this.manualDisabled = false;
     }

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

@@ -1,22 +1,88 @@
 import { DimmerSettings } from './dimmerSettings';
 export declare class LedSettings extends DimmerSettings {
+    /**
+     * The default color for the LED if none was given.
+     * @default '#fbbc32' (Warm yellow)
+     */
     static fallbackColor: string;
+    /**
+     * The default color for the LED if none was given.
+     */
     defaultColor: string;
+    /**
+     * @inheritDoc
+     * @default false
+     */
     dayOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 100
+     */
     dayBrightness: number;
+    /**
+     * The desired color of the light during the day.
+     */
     dayColor: string;
+    /**
+     * The desired color temperature of the light during the day.
+     * @default -1 (Not set)
+     */
     dayColorTemp: number;
+    /**
+     * @inheritDoc
+     * @default true
+     */
     dawnOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 50
+     */
     dawnBrightness: number;
+    /**
+     * The desired color of the light during the dawn.
+     */
     dawnColor: string;
+    /**
+     * The desired color temperature of the light during the dawn.
+     * @default -1 (Not set)
+     */
     dawnColorTemp: number;
+    /**
+     * @inheritDoc
+     * @default true
+     */
     duskOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 50
+     */
     duskBrightness: number;
+    /**
+     * The desired color of the light during the dusk.
+     */
     duskColor: string;
+    /**
+     * The desired color temperature of the light during the dusk.
+     * @default -1 (Not set)
+     */
     duskColorTemp: number;
+    /**
+     * @inheritDoc
+     * @default true
+     */
     nightOn: boolean;
+    /**
+     * @inheritDoc
+     * @default 2
+     */
     nightBrightness: number;
+    /**
+     * The desired color of the light during the night.
+     */
     nightColor: string;
+    /**
+     * The desired color temperature of the light during the night.
+     */
     nightColorTemp: number;
     fromPartialObject(data: Partial<LedSettings>): void;
     protected toJSON(): Partial<LedSettings>;

package/lib/models/deviceSettings/ledSettings.js

@@ -6,43 +6,97 @@ const server_1 = require("../../server");
 class LedSettings extends dimmerSettings_1.DimmerSettings {
     constructor() {
         super(...arguments);
+        /**
+         * The default color for the LED if none was given.
+         */
         this.defaultColor = LedSettings.fallbackColor;
+        /**
+         * @inheritDoc
+         * @default false
+         */
         this.dayOn = false;
+        /**
+         * @inheritDoc
+         * @default 100
+         */
         this.dayBrightness = 100;
+        /**
+         * The desired color of the light during the day.
+         */
         this.dayColor = this.defaultColor;
+        /**
+         * The desired color temperature of the light during the day.
+         * @default -1 (Not set)
+         */
         this.dayColorTemp = -1;
+        /**
+         * @inheritDoc
+         * @default true
+         */
         this.dawnOn = true;
+        /**
+         * @inheritDoc
+         * @default 50
+         */
         this.dawnBrightness = 50;
+        /**
+         * The desired color of the light during the dawn.
+         */
         this.dawnColor = this.defaultColor;
+        /**
+         * The desired color temperature of the light during the dawn.
+         * @default -1 (Not set)
+         */
         this.dawnColorTemp = -1;
+        /**
+         * @inheritDoc
+         * @default true
+         */
         this.duskOn = true;
+        /**
+         * @inheritDoc
+         * @default 50
+         */
         this.duskBrightness = 50;
+        /**
+         * The desired color of the light during the dusk.
+         */
         this.duskColor = this.defaultColor;
+        /**
+         * The desired color temperature of the light during the dusk.
+         * @default -1 (Not set)
+         */
         this.duskColorTemp = -1;
+        /**
+         * @inheritDoc
+         * @default true
+         */
         this.nightOn = true;
+        /**
+         * @inheritDoc
+         * @default 2
+         */
         this.nightBrightness = 2;
+        /**
+         * The desired color of the light during the night.
+         */
         this.nightColor = '#ff5500';
+        /**
+         * The desired color temperature of the light during the night.
+         */
         this.nightColorTemp = -1;
     }
     fromPartialObject(data) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
-        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.dayColorTemp = (_c = data.dayColorTemp) !== null && _c !== void 0 ? _c : this.dayColorTemp;
-        this.dawnOn = (_d = data.dawnOn) !== null && _d !== void 0 ? _d : this.dawnOn;
-        this.dawnBrightness = (_e = data.dawnBrightness) !== null && _e !== void 0 ? _e : this.dawnBrightness;
-        this.dawnColorTemp = (_f = data.dawnColorTemp) !== null && _f !== void 0 ? _f : this.dawnColorTemp;
-        this.duskOn = (_g = data.duskOn) !== null && _g !== void 0 ? _g : this.duskOn;
-        this.duskBrightness = (_h = data.duskBrightness) !== null && _h !== void 0 ? _h : this.duskBrightness;
-        this.duskColorTemp = (_j = data.duskColorTemp) !== null && _j !== void 0 ? _j : this.duskColorTemp;
-        this.nightOn = (_k = data.nightOn) !== null && _k !== void 0 ? _k : this.nightOn;
-        this.nightBrightness = (_l = data.nightBrightness) !== null && _l !== void 0 ? _l : this.nightBrightness;
-        this.nightColorTemp = (_m = data.nightColorTemp) !== null && _m !== void 0 ? _m : this.nightColorTemp;
-        this.defaultColor = (_p = server_1.Utils.formatHex((_o = data.defaultColor) !== null && _o !== void 0 ? _o : this.defaultColor)) !== null && _p !== void 0 ? _p : LedSettings.fallbackColor;
-        this.dayColor = (_r = server_1.Utils.formatHex((_q = data.dayColor) !== null && _q !== void 0 ? _q : this.dayColor)) !== null && _r !== void 0 ? _r : LedSettings.fallbackColor;
-        this.dawnColor = (_t = server_1.Utils.formatHex((_s = data.dawnColor) !== null && _s !== void 0 ? _s : this.dawnColor)) !== null && _t !== void 0 ? _t : LedSettings.fallbackColor;
-        this.duskColor = (_v = server_1.Utils.formatHex((_u = data.duskColor) !== null && _u !== void 0 ? _u : this.duskColor)) !== null && _v !== void 0 ? _v : LedSettings.fallbackColor;
-        this.nightColor = (_x = server_1.Utils.formatHex((_w = data.nightColor) !== null && _w !== void 0 ? _w : this.nightColor)) !== null && _x !== void 0 ? _x : LedSettings.fallbackColor;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+        this.dayColorTemp = (_a = data.dayColorTemp) !== null && _a !== void 0 ? _a : this.dayColorTemp;
+        this.dawnColorTemp = (_b = data.dawnColorTemp) !== null && _b !== void 0 ? _b : this.dawnColorTemp;
+        this.duskColorTemp = (_c = data.duskColorTemp) !== null && _c !== void 0 ? _c : this.duskColorTemp;
+        this.nightColorTemp = (_d = data.nightColorTemp) !== null && _d !== void 0 ? _d : this.nightColorTemp;
+        this.defaultColor = (_f = server_1.Utils.formatHex((_e = data.defaultColor) !== null && _e !== void 0 ? _e : this.defaultColor)) !== null && _f !== void 0 ? _f : LedSettings.fallbackColor;
+        this.dayColor = (_h = server_1.Utils.formatHex((_g = data.dayColor) !== null && _g !== void 0 ? _g : this.dayColor)) !== null && _h !== void 0 ? _h : LedSettings.fallbackColor;
+        this.dawnColor = (_k = server_1.Utils.formatHex((_j = data.dawnColor) !== null && _j !== void 0 ? _j : this.dawnColor)) !== null && _k !== void 0 ? _k : LedSettings.fallbackColor;
+        this.duskColor = (_m = server_1.Utils.formatHex((_l = data.duskColor) !== null && _l !== void 0 ? _l : this.duskColor)) !== null && _m !== void 0 ? _m : LedSettings.fallbackColor;
+        this.nightColor = (_p = server_1.Utils.formatHex((_o = data.nightColor) !== null && _o !== void 0 ? _o : this.nightColor)) !== null && _p !== void 0 ? _p : LedSettings.fallbackColor;
         super.fromPartialObject(data);
     }
     toJSON() {
@@ -50,4 +104,8 @@ class LedSettings extends dimmerSettings_1.DimmerSettings {
     }
 }
 exports.LedSettings = LedSettings;
+/**
+ * The default color for the LED if none was given.
+ * @default '#fbbc32' (Warm yellow)
+ */
 LedSettings.fallbackColor = '#fbbc32';

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

@@ -2,9 +2,13 @@ import { DeviceSettings } from './deviceSettings';
 export declare class MotionSensorSettings extends DeviceSettings {
     /**
      * If set to false, a detected movement on this sensor will block certain alarms on windows in this room
-     * @type {boolean}
+     * @default true
      */
     seesWindow: boolean;
+    /**
+     * If set to true, this sensor will not trigger the night alarm in case of detected movement
+     * @default false
+     */
     excludeFromNightAlarm: boolean;
     fromPartialObject(data: Partial<MotionSensorSettings>): void;
     protected toJSON(): Partial<MotionSensorSettings>;

package/lib/models/deviceSettings/motionSensorSettings.js

@@ -8,9 +8,13 @@ class MotionSensorSettings extends deviceSettings_1.DeviceSettings {
         super(...arguments);
         /**
          * If set to false, a detected movement on this sensor will block certain alarms on windows in this room
-         * @type {boolean}
+         * @default true
          */
         this.seesWindow = true;
+        /**
+         * If set to true, this sensor will not trigger the night alarm in case of detected movement
+         * @default false
+         */
         this.excludeFromNightAlarm = false;
     }
     fromPartialObject(data) {

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

@@ -1,5 +1,9 @@
 import { DeviceSettings } from './deviceSettings';
 export declare class SceneSettings extends DeviceSettings {
+    /**
+     * The default turn off timeout in ms for the scene or undefined if not desired.
+     * @default undefined (No timeout)
+     */
     defaultTurnOffTimeout?: number;
     fromPartialObject(data: Partial<SceneSettings>): void;
     protected toJSON(): Partial<SceneSettings>;

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

@@ -1,21 +1,29 @@
 import { DeviceSettings } from './deviceSettings';
 export declare class ShutterSettings extends DeviceSettings {
+    /**
+     * The time in ms it takes for the shutter to move to the top.
+     * @default -1 (Not set)
+     */
     msTilTop: number;
+    /**
+     * The time in ms it takes for the shutter to move to the bottom.
+     * @default -1 (Not set)
+     */
     msTilBot: number;
     /**
      * The direction this shutter is facing (0 = North, 180 = South)
-     * @type {number}
+     * @default 180 (Worst case scenario being south)
      */
     direction: number;
     /**
      * The desired position, when the shutter should perform a heat reduction.
-     * @type {number}
+     * @default 40
      */
     heatReductionPosition: number;
     /**
      * Some shutter give no position feedback on their own, so by knowing the durations in either direction,
      * we can programmatically trigger the callbacks.
-     * @type {boolean}
+     * @default false
      */
     triggerPositionUpdateByTime: boolean;
     fromPartialObject(data: Partial<ShutterSettings>): void;

package/lib/models/deviceSettings/shutterSettings.js

@@ -6,22 +6,30 @@ const server_1 = require("../../server");
 class ShutterSettings extends deviceSettings_1.DeviceSettings {
     constructor() {
         super(...arguments);
+        /**
+         * The time in ms it takes for the shutter to move to the top.
+         * @default -1 (Not set)
+         */
         this.msTilTop = -1;
+        /**
+         * The time in ms it takes for the shutter to move to the bottom.
+         * @default -1 (Not set)
+         */
         this.msTilBot = -1;
         /**
          * The direction this shutter is facing (0 = North, 180 = South)
-         * @type {number}
+         * @default 180 (Worst case scenario being south)
          */
         this.direction = 180;
         /**
          * The desired position, when the shutter should perform a heat reduction.
-         * @type {number}
+         * @default 40
          */
         this.heatReductionPosition = 40;
         /**
          * Some shutter give no position feedback on their own, so by knowing the durations in either direction,
          * we can programmatically trigger the callbacks.
-         * @type {boolean}
+         * @default false
          */
         this.triggerPositionUpdateByTime = false;
     }

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

@@ -1,5 +1,9 @@
 import { DeviceSettings } from './deviceSettings';
 export declare class SonosDeviceSettings extends DeviceSettings {
+    /**
+     * The maximum volume to use when there is a command to play something on all devices.
+     * @default 80
+     */
     maxPlayOnAllVolume: number;
     fromPartialObject(data: Partial<SonosDeviceSettings>): void;
     protected toJSON(): Partial<SonosDeviceSettings>;

package/lib/models/deviceSettings/sonosDeviceSettings.js

@@ -6,6 +6,10 @@ const server_1 = require("../../server");
 class SonosDeviceSettings extends deviceSettings_1.DeviceSettings {
     constructor() {
         super(...arguments);
+        /**
+         * The maximum volume to use when there is a command to play something on all devices.
+         * @default 80
+         */
         this.maxPlayOnAllVolume = 80;
     }
     fromPartialObject(data) {

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

@@ -1,6 +1,10 @@
 import { DeviceSettings } from './deviceSettings';
 import { Daytime } from '../daytime';
 export declare class TvSettings extends DeviceSettings {
+    /**
+     * The time at which the TV should automatically turn off.
+     * @default undefined (Not set)
+     */
     automaticTurnOff: Daytime | undefined;
     fromPartialObject(data: Partial<TvSettings>): void;
     protected toJSON(): Partial<TvSettings>;

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

@@ -1,13 +1,64 @@
 import { DeviceSettings } from './deviceSettings';
 export declare class VictronDeviceSettings extends DeviceSettings {
+    /**
+     * The default time interval in minutes for battery-change reporting regardless of battery level.
+     * -1 = disabled
+     */
+    batteryReportingInterval: number;
+    /**
+     * The maximum wattage that the battery can deliver to the house
+     * @default 1700
+     */
     maxBatteryLoadWattage: number;
+    /**
+     * If the system has a battery
+     * @default true
+     */
     hasBattery: boolean;
+    /**
+     * The minimum battery level for nighttime AC usage allowance
+     */
+    minimumNightTimeAcBatteryLevel: number;
+    /**
+     * The minimum battery level for early morning or evening hours AC usage allowance
+     */
+    minimumTransientTimeAcBatteryLevel: number;
+    /**
+     * The minimum battery level at which the system should be allowed to use AC
+     */
+    minimumDayTimeAcBatteryLevel: number;
+    /**
+     * If the system has a grid
+     * @default true
+     */
     hasGrid: boolean;
+    /**
+     * If the system has solar panels
+     * @default true
+     */
     hasSolar: boolean;
+    /**
+     * The capacity of the battery in watt-hours
+     * @default 10000
+     */
     batteryCapacityWattage: number;
+    /**
+     * The normal base consumption of the house in wattage
+     * @default 600
+     */
     normalBaseConsumptionWattage: number;
+    /**
+     * The maximum wattage that the battery can deliver to the house
+     * @default 3000
+     */
     maximumBatteryDischargeWattage: number;
+    /**
+     * The threshold (in Watts) at which the system should turn on excess energy consumers
+     */
     excessEnergyTurnOnThreshold: number;
+    /**
+     * The threshold (in Watts) at which the system should turn off excess energy consumers
+     */
     excessEnergyTurnOffThreshold: number;
     fromPartialObject(data: Partial<VictronDeviceSettings>): void;
     protected toJSON(): Partial<VictronDeviceSettings>;