hoffmation-base 3.0.0-alpha.20 → 3.0.0-alpha.21

package/lib/server/services/dbo/iPersist.d.ts

@@ -2,26 +2,122 @@ import { ButtonPressType, iAcDevice, iActuator, iBaseDevice, iBatteryDevice, iBu
 import { CountToday, DesiredShutterPosition, EnergyCalculation, RoomBase, ShutterCalibration } from '../../../models';
 export interface iPersist {
     initialized: boolean;
+    /**
+     * Adds a room to the database
+     * @param {RoomBase} room - The room to add
+     */
     addRoom(room: RoomBase): void;
+    /**
+     * Adds a device to the database
+     * @param {iBaseDevice} device - The device to add
+     */
     addDevice(device: iBaseDevice): void;
+    /**
+     * Gets the count of the motion sensor today
+     * @param {iMotionSensor} device - The device to get the count for
+     * @returns {Promise<CountToday>} - The count of the motion sensor today
+     */
     motionSensorTodayCount(device: iMotionSensor): Promise<CountToday>;
+    /**
+     * Gets the last desired position of the shutter
+     * @param {iShutter} device - The device to get the last desired position for
+     * @returns {Promise<DesiredShutterPosition>} - The last desired position of the shutter
+     */
     getLastDesiredPosition(device: iShutter): Promise<DesiredShutterPosition>;
+    /**
+     * Gets the shutter calibration
+     * @param {iShutter} device - The device to get the shutter calibration for
+     * @returns {Promise<ShutterCalibration>} - The shutter calibration
+     */
     getShutterCalibration(device: iShutter): Promise<ShutterCalibration>;
+    /**
+     * Initializes the database-connection and prepares the database
+     * @returns {Promise<void>} - The promise that resolves when the database is initialized
+     */
     initialize(): Promise<void>;
+    /**
+     * Persists the shutter calibration
+     * @param {ShutterCalibration} data - The shutter calibration data to persist
+     */
     persistShutterCalibration(data: ShutterCalibration): void;
+    /**
+     * Persists data for an illumination sensor
+     * @param {iIlluminationSensor} device - The device to persist data for
+     */
     persistIlluminationSensor(device: iIlluminationSensor): void;
+    /**
+     * Persists data for an energy manager
+     * @param {EnergyCalculation} energyData - The energy data to persist
+     */
     persistEnergyManager(energyData: EnergyCalculation): void;
+    /**
+     * Persists data of an AC device
+     * @param {iAcDevice} device - The device to persist data for
+     */
     persistAC(device: iAcDevice): void;
+    /**
+     * Persists data of an actuator
+     * @param {iActuator} device - The device to persist data for
+     */
     persistActuator(device: iActuator): void;
+    /**
+     * Persists data of a heater
+     * @param {iHeater} device - The device to persist data for
+     */
     persistHeater(device: iHeater): void;
+    /**
+     * Persists data of a motion sensor
+     * @param {iMotionSensor} device - The device to persist data for
+     */
     persistMotionSensor(device: iMotionSensor): void;
+    /**
+     * Persists data of a button switch action
+     * @param {iButtonSwitch} device - The device to persist data for
+     * @param {ButtonPressType} pressType - The type of button press
+     * @param {string} buttonName - The name of the button
+     */
     persistSwitchInput(device: iButtonSwitch, pressType: ButtonPressType, buttonName: string): void;
+    /**
+     * Persists data of a shutter
+     * @param {iShutter} device - The device to persist data for
+     */
     persistShutter(device: iShutter): void;
+    /**
+     * Persists data of a temperature sensor
+     * @param {iTemperatureSensor} device - The device to persist data for
+     */
     persistTemperatureSensor(device: iTemperatureSensor): void;
+    /**
+     * Persists data of a humidity sensor
+     * @param {iHumiditySensor} device - The device to persist data for
+     */
     persistHumiditySensor(device: iHumiditySensor): void;
+    /**
+     * Persists data of a handle sensor
+     * @param {iHandleSensor} device - The device to persist data for
+     */
     persistHandleSensor(device: iHandleSensor): void;
+    /**
+     * Persists data of a battery device
+     * @param {iBatteryDevice} device - The device to persist data for
+     */
     persistBatteryDevice(device: iBatteryDevice): void;
+    /**
+     * Persists data of a Zigbee device
+     * @param {ZigbeeDevice} device - The device to persist data for
+     */
     persistZigbeeDevice(device: ZigbeeDevice): void;
+    /**
+     * Persists settings for the given id
+     * @param {string} id - The id to persist settings for
+     * @param {string} settings - The settings to persist (as JSON string)
+     * @param {string} customname - The custom name of the device/object
+     */
     persistSettings(id: string, settings: string, customname: string): void;
+    /**
+     * Loads settings for the given id
+     * @param {string} id - The id of the object/device to load settings for
+     * @returns {Promise<string | undefined>} - The settings as JSON string or undefined if not found
+     */
     loadSettings(id: string): Promise<string | undefined>;
 }

package/lib/server/services/https-service.d.ts

@@ -4,8 +4,9 @@ export declare class HTTPSService {
     /**
      * Downloads a file from a given url to the given location.
      * If the location doesn't exist, it will be created quietly.
-     * @param url URL to download file from
-     * @param filePath Path to save file to
+     * @param url - URL to download file from
+     * @param filePath - Path to save file to
+     * @returns A promise that resolves to true if the file was downloaded successfully, false otherwise
      */
     static downloadFile(url: string, filePath: string): Promise<boolean>;
     private static defaultCallback;

package/lib/server/services/https-service.js

@@ -65,8 +65,9 @@ class HTTPSService {
     /**
      * Downloads a file from a given url to the given location.
      * If the location doesn't exist, it will be created quietly.
-     * @param url URL to download file from
-     * @param filePath Path to save file to
+     * @param url - URL to download file from
+     * @param filePath - Path to save file to
+     * @returns A promise that resolves to true if the file was downloaded successfully, false otherwise
      */
     static async downloadFile(url, filePath) {
         return new Promise((resolve, reject) => {

package/lib/server/services/log-service/log-service.d.ts

@@ -17,8 +17,8 @@ export declare class ServerLogService {
     static missingRoomIndexHandling(pRoomName: string, pIndex: number, pDeviceType: DeviceType): void;
     /**
      * Checks if this message is of a debugtype which should be skipped according to settings
-     * @param {LogDebugType} debugType
-     * @returns {boolean} If the Message should be skipped
+     * @param debugType - {LogDebugType}
+     * @returns If the Message should be skipped
      */
     private static checkDebugLogSkip;
 }

package/lib/server/services/log-service/log-service.js

@@ -60,8 +60,8 @@ class ServerLogService {
     }
     /**
      * Checks if this message is of a debugtype which should be skipped according to settings
-     * @param {LogDebugType} debugType
-     * @returns {boolean} If the Message should be skipped
+     * @param debugType - {LogDebugType}
+     * @returns If the Message should be skipped
      */
     static checkDebugLogSkip(debugType) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;

package/lib/server/services/news-service.d.ts

@@ -25,17 +25,16 @@ export declare class NewsService {
     static getLatestNews(): void;
     /**
      * Plays the latest news on a sonos device
-     * @param speaker Sonos device to play from
-     * @param volume volume to play at
-     * @param retries Number of times playing should be tried if there is currently no audio file available
+     * @param speaker - Sonos device to play from
+     * @param volume - volume to play at
+     * @param retries - Number of times playing should be tried if there is currently no audio file available
      */
     static playLastNews(speaker: iSpeaker, volume?: number, retries?: number): void;
     private static downloadLatestFileFromFeed;
     /**
      * Deletes all files in the given directory that are older than the given age.
-     * @param rootDir Directory to search in
-     * @param keepMaxAge Maximum age in minutes until a file gets deleted
-     * @private
+     * @param rootDir - Directory to search in
+     * @param keepMaxAge - Maximum age in minutes until a file gets deleted
      */
     private static cleanOldFiles;
 }

package/lib/server/services/news-service.js

@@ -96,9 +96,9 @@ class NewsService {
     }
     /**
      * Plays the latest news on a sonos device
-     * @param speaker Sonos device to play from
-     * @param volume volume to play at
-     * @param retries Number of times playing should be tried if there is currently no audio file available
+     * @param speaker - Sonos device to play from
+     * @param volume - volume to play at
+     * @param retries - Number of times playing should be tried if there is currently no audio file available
      */
     static playLastNews(speaker, volume = 30, retries = 5) {
         if (!NewsService.lastNewsAudioFile) {
@@ -167,9 +167,8 @@ class NewsService {
     }
     /**
      * Deletes all files in the given directory that are older than the given age.
-     * @param rootDir Directory to search in
-     * @param keepMaxAge Maximum age in minutes until a file gets deleted
-     * @private
+     * @param rootDir - Directory to search in
+     * @param keepMaxAge - Maximum age in minutes until a file gets deleted
      */
     static cleanOldFiles(rootDir, keepMaxAge) {
         let deleteCount = 0;

package/lib/server/services/room-service/room-service.d.ts

@@ -16,13 +16,14 @@ export declare class RoomService {
     static getAllRoomsOfFloor(floor: number): IterableIterator<[string, RoomBase]>;
     /**
      * Moves all shutters of the desired floor(s) to the desired position
+     * @param c - the command to be executed on all windows of the desired floor(s)
      */
     static setAllShutterOfFloor(c: FloorSetAllShuttersCommand): void;
     /**
      * Set ALl Lamps of a specific floor
      * !!floor -1 sets all lamps in house instead!!
-     * @param floor the level on which all lamps shall be changed -1 equals all rooms
-     * @param command the command to be executed
+     * @param floor - {number} the level on which all lamps shall be changed -1 equals all rooms
+     * @param command - {ActuatorSetStateCommand} the command to be executed
      */
     static setAllLampsOfFloor(floor: number, command: ActuatorSetStateCommand): void;
     static clearAllAlarms(): void;

package/lib/server/services/room-service/room-service.js

@@ -16,6 +16,7 @@ class RoomService {
     }
     /**
      * Moves all shutters of the desired floor(s) to the desired position
+     * @param c - the command to be executed on all windows of the desired floor(s)
      */
     static setAllShutterOfFloor(c) {
         var _a;
@@ -27,8 +28,8 @@ class RoomService {
     /**
      * Set ALl Lamps of a specific floor
      * !!floor -1 sets all lamps in house instead!!
-     * @param floor the level on which all lamps shall be changed -1 equals all rooms
-     * @param command the command to be executed
+     * @param floor - {number} the level on which all lamps shall be changed -1 equals all rooms
+     * @param command - {ActuatorSetStateCommand} the command to be executed
      */
     static setAllLampsOfFloor(floor, command) {
         var _a, _b, _c, _d;
@@ -92,7 +93,7 @@ class RoomService {
     }
     static endAlarmModes() {
         if (this.awayModeActive) {
-            Telegram_1.TelegramService.sendMessage(Telegram_1.TelegramService.subscribedIDs, `Alarmanalage entschärft`);
+            Telegram_1.TelegramService.sendMessage(Telegram_1.TelegramService.subscribedIDs, `Alarm Mode disarmed`);
             Sonos_1.SonosService.speakOnAll(Translation_1.Res.welcomeHome(), 35);
         }
         if (this.nightAlarmActive) {

package/lib/server/services/settings-service.d.ts

@@ -8,8 +8,9 @@ export declare class SettingsService {
     static get latitude(): number;
     static get longitude(): number;
     /**
-     * @deprecated Only use in unit tests
-     * @returns {iConfig}
+     * Generates a fresh Test configuration.
+     * @returns The test configuration.
+     * @deprecated Only use in unit tests.
      */
     static get testConfig(): iConfig;
 }

package/lib/server/services/settings-service.js

@@ -37,8 +37,9 @@ class SettingsService {
         return 7.097266042276687;
     }
     /**
-     * @deprecated Only use in unit tests
-     * @returns {iConfig}
+     * Generates a fresh Test configuration.
+     * @returns The test configuration.
+     * @deprecated Only use in unit tests.
      */
     static get testConfig() {
         return {

package/lib/server/services/utils/iDisposeable.d.ts

@@ -1,3 +1,6 @@
 export interface iDisposable {
+    /**
+     * Dispose of the object --> free up resources, disable timeouts/intervals, etc.
+     */
     dispose(): void;
 }

package/lib/server/services/victron/victron-device.d.ts

@@ -29,7 +29,7 @@ export declare class VictronDevice implements iEnergyManager {
     get injectingWattage(): number;
     get drawingWattage(): number;
     get selfConsumingWattage(): number;
-    cleanup(): void;
+    dispose(): void;
     getReport(): string;
     recalculatePowerSharing(): void;
     loadDeviceSettings(): void;
@@ -38,7 +38,7 @@ export declare class VictronDevice implements iEnergyManager {
     toJSON(): Partial<VictronDevice>;
     /**
      * Changes the grid set point of the Victron device, to the desired value.
-     * @param {number} setPoint
+     * @param setPoint - The desired watt point the system should aim for.
      */
     setGridSetPoint(setPoint: number): void;
     private calculateExcessEnergy;

package/lib/server/services/victron/victron-device.js

@@ -73,7 +73,7 @@ class VictronDevice {
         var _a;
         return Math.max((_a = this.victronConsumer.data.system.power) !== null && _a !== void 0 ? _a : 0, 0) - this.drawingWattage;
     }
-    cleanup() {
+    dispose() {
         this._victronConsumer.disconnect();
         if (this._iDatabaseLoggerInterval !== null) {
             clearInterval(this._iDatabaseLoggerInterval);
@@ -122,7 +122,7 @@ class VictronDevice {
     }
     /**
      * Changes the grid set point of the Victron device, to the desired value.
-     * @param {number} setPoint
+     * @param setPoint - The desired watt point the system should aim for.
      */
     setGridSetPoint(setPoint) {
         this._victronConsumer.setGridSetPoint(setPoint);

package/lib/server/services/weather/weather-current.d.ts

@@ -2,8 +2,6 @@ import { WeatherItem } from './weather-item';
 export interface WeatherCurrent {
     /**
      * Zeit der Anfrage
-     * @type {number}
-     * @memberof WeatherCurrent
      */
     dt: number;
     sunrise: number;

package/lib/server/services/weather/weather-service.d.ts

@@ -24,7 +24,6 @@ export declare class WeatherService {
     static lastResponse: WeatherResponse;
     /**
      * The sun horizontal degree (0 is North)
-     * @type {number}
      */
     static sunDirection: number;
     private static _dataUpdateCbs;
@@ -46,5 +45,9 @@ export declare class WeatherService {
     private static getActiveAlerts;
     private static getWeatherData;
     private static recalcAzimuth;
+    /**
+     * Method to calculate the hours until sunset based on the current location
+     * @returns - The hours until sunset
+     */
     private static hoursTilSunset;
 }

package/lib/server/services/weather/weather-service.js

@@ -218,6 +218,10 @@ class WeatherService {
             180 +
                 (180 / Math.PI) * suncalc_1.default.getPosition(new Date(), parseFloat(this.latitude), parseFloat(this.longitude)).azimuth;
     }
+    /**
+     * Method to calculate the hours until sunset based on the current location
+     * @returns - The hours until sunset
+     */
     static hoursTilSunset() {
         const now = new Date();
         const sunset = time_callback_service_1.TimeCallbackService.getSunsetForDate(now, parseFloat(this.latitude), parseFloat(this.longitude));