hoffmation-base 3.0.0-alpha.4 → 3.0.0-alpha.40

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

@@ -36,17 +36,17 @@ class WeatherService {
         const wData = WeatherService.lastResponse;
         if (wData === undefined) {
             if (retries > 0) {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `WeatherService.playWeatherInfo(): Der Wetterbericht ist noch nicht bereit --> warten`);
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, 'WeatherService.playWeatherInfo(): Der Wetterbericht ist noch nicht bereit --> warten');
                 setTimeout(() => {
                     WeatherService.playWeatherInfo(speaker, volume, short, retries - 1);
                 }, 1000);
             }
             else {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `WeatherService.playWeatherInfo(): Der Wetterbericht ist vorhanden --> Abbruch`);
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, 'WeatherService.playWeatherInfo(): Der Wetterbericht ist vorhanden --> Abbruch');
             }
             return;
         }
-        speaker.speakOnDevice(short ? `Kurze Wetterinfo:` : `HoffMation Wetter-Bericht:`, volume, false);
+        speaker.speakOnDevice(short ? 'Kurze Wetterinfo:' : 'HoffMation Wetter-Bericht:', volume, false);
         speaker.speakOnDevice(`Wetterbeschreibung für heute:  ${wData.daily[0].weather[0].description}`, volume, false);
         speaker.speakOnDevice(`Aktuell sind es ${Math.round(wData.current.temp)} Grad.`, volume, false);
         if (!short) {
@@ -62,25 +62,25 @@ class WeatherService {
         }
         const { minutes, precipitation } = WeatherService.getRainNextMinutes();
         const ratio = minutes <= 0 ? 0 : (precipitation / minutes) * 60;
-        let message = `In der nächsten Zeit `;
+        let message = 'In der nächsten Zeit ';
         switch (true) {
             case ratio > 12:
-                message += `wird es kräftig regnen`;
+                message += 'wird es kräftig regnen';
                 break;
             case ratio > 4:
-                message += `wird es ordentlich regnen`;
+                message += 'wird es ordentlich regnen';
                 break;
             case ratio > 1:
-                message += `wird es regnen`;
+                message += 'wird es regnen';
                 break;
             case ratio > 0.5:
-                message += `wird es mäßig regnen`;
+                message += 'wird es mäßig regnen';
                 break;
             case ratio > 0.1:
-                message += `wird es nieseln regnen`;
+                message += 'wird es nieseln regnen';
                 break;
             default:
-                message += `bleibt es trocken.`;
+                message += 'bleibt es trocken.';
                 break;
         }
         speaker.speakOnDevice(message, volume, false);
@@ -89,7 +89,7 @@ class WeatherService {
             speaker.speakOnDevice(`Es werden etwa ${precipitation} Millimeter Niederschlag in den nächsten ${minutes} Minuten fallen`, volume, false);
         const alerts = WeatherService.getActiveAlerts();
         if (alerts.length > 0) {
-            const alertMessage = [`Achtung, vorliegende Wetterwarnungen:`];
+            const alertMessage = ['Achtung, vorliegende Wetterwarnungen:'];
             alerts.forEach((element) => {
                 alertMessage.push(`${element.event} von ${new Date(element.start * 1000).toLocaleString('de-DE')} bis ${new Date(element.end * 1000).toLocaleString('de-DE')}`);
                 // } bis ${new Date(element.end * 1000).toLocaleString("de-DE")}; Beschreibung: ${element.description} Herausgeber: ${element.sender_name}`)
@@ -97,13 +97,13 @@ class WeatherService {
             speaker.speakOnDevice(alertMessage.join('\n'), volume, false);
         }
         else if (!short) {
-            speaker.speakOnDevice(`Für heute liegt keine Unwetterwarnungen vor`, volume, false);
+            speaker.speakOnDevice('Für heute liegt keine Unwetterwarnungen vor', volume, false);
         }
     }
     static processHourlyWeather() {
         log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `Es sind gerade ${this.lastResponse.current.temp} Grad (gefühlt ${this.lastResponse.current.feels_like}).`);
         if (this.lastResponse.alerts !== undefined && this.lastResponse.alerts.length > 0) {
-            const message = [`Es gibt folgende Wetterwarnungen:`];
+            const message = ['Es gibt folgende Wetterwarnungen:'];
             this.lastResponse.alerts.forEach((element) => {
                 message.push(`${element.event} von ${new Date(element.start * 1000)} bis ${new Date(element.end * 1000)}; Beschreibung: ${element.description} Herausgeber: ${element.sender_name}`);
             });
@@ -113,7 +113,7 @@ class WeatherService {
     static getCurrentTemp() {
         const wData = WeatherService.lastResponse;
         if (wData === undefined || wData.current === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `WeatherService.isOutsideWarmer(): There are no data yet`);
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'WeatherService.isOutsideWarmer(): There are no data yet');
             return -99;
         }
         return wData.current.temp;
@@ -121,7 +121,7 @@ class WeatherService {
     static willOutsideBeWarmer(referenceTemperature, logger) {
         const wData = WeatherService.lastResponse;
         if (wData === undefined || wData.current === undefined) {
-            logger(models_1.LogLevel.Info, `WeatherService.isOutsideWarmer(): There are no data yet`);
+            logger(models_1.LogLevel.Info, 'WeatherService.isOutsideWarmer(): There are no data yet');
             return false;
         }
         logger(models_1.LogLevel.Info, `willOutsideBeWarmer(${referenceTemperature}) --> Today Max Temperature: ${wData.daily[0].temp.max}`);
@@ -130,24 +130,24 @@ class WeatherService {
     static weatherRolloPosition(normalPos, desiredTemperatur, currentTemperatur, logger, shutterSettings) {
         let result = normalPos;
         if (currentTemperatur < desiredTemperatur) {
-            logger(models_1.LogLevel.Trace, `RolloWeatherPosition: Room needs to heat up anyways.`);
+            logger(models_1.LogLevel.Trace, 'RolloWeatherPosition: Room needs to heat up anyways.');
             return result;
         }
         else if (normalPos < 30) {
-            logger(models_1.LogLevel.Trace, `RolloWeatherPosition: Shutter should be down anyways.`);
+            logger(models_1.LogLevel.Trace, 'RolloWeatherPosition: Shutter should be down anyways.');
             return result;
         }
         else if (this.hoursTilSunset() < 1) {
-            logger(models_1.LogLevel.Trace, `RolloWeatherPosition: It's close to or after todays sunset`);
+            logger(models_1.LogLevel.Trace, "RolloWeatherPosition: It's close to or after todays sunset");
             return result;
         }
         else if (shutterSettings.direction !== undefined &&
             !utils_1.Utils.degreeInBetween(shutterSettings.direction - 50, shutterSettings.direction + 50, this.sunDirection)) {
-            logger(models_1.LogLevel.Trace, `RolloWeatherPosition: Sun is facing a different direction`);
+            logger(models_1.LogLevel.Trace, 'RolloWeatherPosition: Sun is facing a different direction');
             return result;
         }
         else if (this.getCurrentCloudiness() > 40) {
-            logger(models_1.LogLevel.Trace, `RolloWeatherPosition: It´s cloudy now.`);
+            logger(models_1.LogLevel.Trace, 'RolloWeatherPosition: It´s cloudy now.');
         }
         else if (this.willOutsideBeWarmer(26, logger)) {
             result = shutterSettings.heatReductionPosition;
@@ -160,7 +160,7 @@ class WeatherService {
     static getCurrentCloudiness() {
         const wData = WeatherService.lastResponse;
         if (wData === undefined || wData.current === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, `WeatherService.getCurrentCloudiness(): There are no data yet`);
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Info, 'WeatherService.getCurrentCloudiness(): There are no data yet');
             return 0;
         }
         return wData.current.clouds;
@@ -202,7 +202,7 @@ class WeatherService {
             return;
         }
         https_service_1.HTTPSService.request(new HTTPSOptions_1.HTTPSOptions('api.openweathermap.org', `/data/2.5/onecall?lat=${WeatherService.latitude}&lon=${WeatherService.longitude}&appid=${WeatherService.appID}&units=metric&lang=de`, {}, 'GET', 443), '', 5, (response) => {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `WeatherAPi Response erhalten`);
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'WeatherAPi Response erhalten');
             log_service_1.ServerLogService.writeLog(models_1.LogLevel.DeepTrace, `WeatherAPi Response: ${response}`);
             utils_1.Utils.guardedFunction(() => {
                 WeatherService.lastResponse = JSON.parse(response);
@@ -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));
@@ -225,6 +229,12 @@ class WeatherService {
     }
 }
 exports.WeatherService = WeatherService;
+/**
+ * Whether the service is active or not
+ */
 WeatherService.active = false;
+/**
+ * The milliseconds of one day
+ */
 WeatherService.oneDay = 1000 * 60 * 60 * 24;
 WeatherService._dataUpdateCbs = {};

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

@@ -1,8 +1,29 @@
+/**
+ * Weather temperature data provided by OpenWeatherMap.
+ */
 export interface WeatherTemp {
+    /**
+     * Average daily temperature in Celsius.
+     */
     day: number;
+    /**
+     * Minimum daily temperature in Celsius.
+     */
     min: number;
+    /**
+     * Maximum daily temperature in Celsius.
+     */
     max: number;
+    /**
+     * Night temperature in Celsius.
+     */
     night: number;
+    /**
+     * Evening temperature in Celsius.
+     */
     eve: number;
+    /**
+     * Morning temperature in Celsius.
+     */
     morn: number;
 }