iobroker.sprinklecontrol 0.2.7 → 0.2.8

package/lib/sendMessageText.js

@@ -12,11 +12,11 @@ let adapter;
  * @type {{}}
  */
 let ObjMessage = {};
+
 /**
- * Modul zum versenden von Nachrichten mittels Telegram, E-Mail, Pushover oder WhatsApp
- * Der passende Adapter muss installiert sein!
- * @param {any} adapter
- * @param {object} ObjMessage
+ * Modul zum Versenden von Nachrichten mittels Telegram, E-Mail, Pushover oder WhatsApp
+ * der passende Adapter muss installiert sein!
+ * @type {{onlySendError(): boolean, sendMessage(string): void, initConfigMessage(ioBroker.Adapter): void}}
  */
 const sendMessageText = {
 
@@ -24,7 +24,7 @@ const sendMessageText = {
      *
      * @param {ioBroker.Adapter} myAdapter - Kopie von Adapter main.js
      */
-    initConfigMessage: (myAdapter) => {
+    initConfigMessage (myAdapter) {
         adapter = myAdapter;
         switch (adapter.config.notificationsType) {
             case 'Telegram':
@@ -87,7 +87,7 @@ const sendMessageText = {
      * send Message ist für Telegram formatiert und muss für andere Empfänger umformatiert werden
      *@param {string} message - Botschaft
      */
-    sendMessage: (message) => {
+    sendMessage (message) {
 
         let sendMessage = message;
 
@@ -98,9 +98,7 @@ const sendMessageText = {
                         ObjMessage.instance !== '' &&
                         ObjMessage.instance !== null &&
                         ObjMessage.instance !== undefined) {
-                        if (adapter.config.debug) {
-                            adapter.log.debug('start sendMessageText per Telegram');
-                        }
+                        adapter.log.debug('start sendMessageText per Telegram');
                         sendMessage = '<b><u>SprinkleControl:</u></b>\n' + sendMessage;
                         // send Telegram Message
                         if ((ObjMessage.User) && (ObjMessage.User !== 'allTelegramUsers')) {
@@ -128,9 +126,7 @@ const sendMessageText = {
                         ObjMessage.instance !== undefined) {
                         sendMessage = '<b><u>SprinkleControl:</u></b>\n' + sendMessage;
                         sendMessage = sendMessage.replace(/\n/g, '<br />');
-                        if (adapter.config.debug) {
-                            adapter.log.debug('start sendMessageText per E-Mail on used E-Mail-Instance: ${adapter.ObjMessage.instance}');
-                        }
+                        adapter.log.debug(`start sendMessageText per E-Mail on used E-Mail-Instance: ${ObjMessage.instance}`);
                         // Send E-Mail Message
                         adapter.sendTo(ObjMessage.instance, 'send', {
                             html: sendMessage,
@@ -147,9 +143,7 @@ const sendMessageText = {
                         ObjMessage.instance !== '' &&
                         ObjMessage.instance !== null &&
                         ObjMessage.instance !== undefined) {
-                        if (adapter.config.debug) {
-                            adapter.log.debug('start sendMessageText per E-Mail on used E-Mail-Instance: ${adapter.ObjMessage.instance}');
-                        }
+                        adapter.log.debug(`start sendMessageText per E-Mail on used E-Mail-Instance: ${ObjMessage.instance}`);
                         // Send pushover Message
                         if (ObjMessage.SilentNotice === 'true' || ObjMessage.SilentNotice === true) {
                             adapter.sendTo(ObjMessage.instance, 'send', {
@@ -181,9 +175,7 @@ const sendMessageText = {
                         sendMessage = sendMessage.replace(/<b>|<\/b>/g, '*');   // Fett Bold
                         sendMessage = sendMessage.replace(/<i>|<\/i>/g, '_');   // kursive Italic
                         sendMessage = sendMessage.replace(/<u>|<\/u>/g, '');     // unterstrichen
-                        if (adapter.config.debug) {
-                            adapter.log.debug(`start sendMessageText per WhatsApp on used WhatsApp-Instance: ${ObjMessage.instance}`);
-                        }
+                        adapter.log.debug(`start sendMessageText per WhatsApp on used WhatsApp-Instance: ${ObjMessage.instance}`);
                         // Send WhatsApp Message
                         adapter.sendTo(ObjMessage.instance, 'send', {
                             text: sendMessage
@@ -198,7 +190,7 @@ const sendMessageText = {
      * Nachrichtenversandabfrage => true (Ja)
      * @returns {boolean}
      */
-    onlySendError: () => {
+    onlySendError () {
         return (adapter.config.notificationEnabled && adapter.config.notificationsType && ObjMessage.onlyError);
     }
 

package/lib/valveControl.js

@@ -16,7 +16,7 @@ let adapter;
 
 /**
  * Thread-list
- * => Auflistung aller aktiver Sprenger-Kreise
+ * → Auflistung aller aktiver Sprenger-Kreise
  * @type {array}
  */
 const threadList = [];
@@ -62,7 +62,7 @@ const currentPumpUse = {
 
 /**
  * Sprinkle (sprinkleName) delete
- * => Ventil (sprinkleName) löschen
+ * → Ventil (sprinkleName) löschen
  * @param {array.<{sprinkleName: string}>} killList
  */
 function delList (killList) {
@@ -81,9 +81,7 @@ function delList (killList) {
         /* If a valve is found, delete the last array (entry). Wenn Ventil gefunden letzten Array (Auftrag) löschen */
         if (bValveFound) {
             threadList.pop();
-            if (adapter.config.debug) {
-                adapter.log.info('#2.10 order deleted ID: ' + sprinkleName + ' ( rest orders: ' + threadList.length + ')');
-            }
+            adapter.log.debug(`delList=> order deleted ID: ${sprinkleName} ( rest orders: ${threadList.length} )`);
         }
     }
 
@@ -152,7 +150,7 @@ function boostList (sprinkleID) {
 
 /**
  * If boostOn is ended by entering "runningTime = 0", normal operation should be restored. (Delete timer)
- * => Wenn boostOn über die Eingabe "runningTime = 0" beendet wird, so soll zum Normalen ablauf wieder zurückgekehrt werden. (Löschen der Timer)
+ * → Wenn boostOn über die Eingabe "runningTime = 0" beendet wird, so soll zum Normalen ablauf wieder zurückgekehrt werden. (Löschen der Timer)
  * @param {number} sprinkleID
  */
 function boostKill (sprinkleID) {
@@ -170,9 +168,7 @@ function boostKill (sprinkleID) {
                 if (entry.times.boostTime1) {
                     clearTimeout(entry.times.boostTime1);
                     entry.times.boostTime1 = null;
-                    if (adapter.config.debug) {
-                        adapter.log.info('#2.11 ID: ' + entry.sprinkleName + ' => boostTime2 (Ende) gelöscht)');
-                    }
+                    adapter.log.debug(`boostKill => ID: ${entry.sprinkleName} => boostTime2 (Ende) gelöscht)`);
                 }
                 if (entry.times.boostTime2) {
                     clearTimeout(entry.times.boostTime2);
@@ -207,14 +203,14 @@ const valveDelay = () => {
  * @returns {Promise<void>}
  */
 const switchTheValvesOffOn = async (threadList, parallel) => {
-    /**Sammlung von .sprinkleName die am Ende von updateList gelöscht werden
+    /**Sammlung von.sprinkleName die am Ende von updateList gelöscht werden
      *  @type {array} - */
     const killList = [];
     for (const entry of threadList) {               // ausschalten der Ventile
-        if ((!entry.enabled                             // ( Ventile ausgeschaltet z.B. Intervall-Beregnung
+        if ((!entry.enabled                             //   Ventile ausgeschaltet z.B. Intervall-Beregnung
             || entry.enabled && entry.myBreak           //      || in Pause z.B. Boost
-            || entry.killSprinkle)                      //      || Bewässerung erledigt )
-            && entry.enabled !== entry.enabledState     // && Ventil nicht aktuell
+            || entry.killSprinkle)                      //      || Bewässerung erledigt
+            && entry.enabled !== entry.enabledState     //   && Ventil nicht aktuell
         ) {
             adapter.setForeignState(entry.idState, {
                 val: false,
@@ -223,11 +219,11 @@ const switchTheValvesOffOn = async (threadList, parallel) => {
                 if (err) {
                     return err;
                 } else {
-                    adapter.log.info('#2.06 Set (' + myConfig.config[entry.sprinkleID].methodControlSM + ') ID: ' + entry.sprinkleName + ', value: ' + entry.enabled);
+                    adapter.log.info(`Set (${myConfig.config[entry.sprinkleID].methodControlSM}) ID: ${entry.sprinkleName}, value: ${entry.enabled}`);
                 }
             });
             entry.enabledState = entry.enabled;
-            /* Ventil aus threadList löschen => Aufgabe beendet und sind nicht in der Pause */
+            /* Ventil aus threadList löschen → Aufgabe beendet und sind nicht in der Pause */
             if (entry.killSprinkle) {
                 killList.push(entry.sprinkleName);
             }
@@ -257,7 +253,7 @@ const switchTheValvesOffOn = async (threadList, parallel) => {
                 if (err) {
                     return err;
                 } else {
-                    adapter.log.info('#2.05 Set (' + myConfig.config[entry.sprinkleID].methodControlSM + ') ID: ' + entry.sprinkleName + ', value: ' + entry.enabled + ', duration: '+ addTime(entry.wateringTime,''));
+                    adapter.log.info(`Valve => Set (${myConfig.config[entry.sprinkleID].methodControlSM}) ID: ${entry.sprinkleName}, value: ${entry.enabled}, duration: ${addTime(entry.wateringTime,'')}`);
                 }
             });
             entry.enabledState = entry.enabled;
@@ -326,7 +322,7 @@ function updateList () {
             && (!entry.calcOn       // Vergleich nur bei Berechnung der Verdunstung
                 || !entry.autoOn	// Vergleich nur bei Automatik
                 || (myConfig.config[entry.sprinkleID].soilMoisture.val < myConfig.config[entry.sprinkleID].soilMoisture.maxIrrigation))		// Bodenfeuchte noch nicht erreicht? (z.B. beim Regen)
-        ) {     /* zeit läuft */
+        ) {     /* Zeit läuft */
             adapter.setState('sprinkle.' + entry.sprinkleName + '.countdown', {
                 val: addTime(entry.wateringTime - entry.count, ''),
                 ack: true
@@ -374,7 +370,7 @@ function updateList () {
                 ack: true
             });
 
-            /* Wenn in der Konfiguration Bodenfeuchte = 100% gesetzt ist und Auto-Bewässerung aktive, dann Bodenfeuchte = 100% setzen*/
+            /* Wenn in der Konfiguration Bodenfeuchte = 100 % gesetzt ist und Auto-Bewässerung aktive, dann Bodenfeuchte = 100 % setzen*/
             if (entry.autoOn && entry.calcOn && myConfig.config[entry.sprinkleID].endIrrigation) {
                 myConfig.setSoilMoistPct100(entry.sprinkleID);
             }
@@ -384,15 +380,13 @@ function updateList () {
             if (myConfig.config[entry.sprinkleID].booster) {
                 if (boostOn) {boostKill(entry.sprinkleID);}
                 boostReady = true;
-                if (adapter.config.debug) {
-                    adapter.log.info('#2.12 ID: ' + entry.sprinkleName + 'UpdateList Sprinkle Off: boostReady = ' + boostReady);
-                }
+                adapter.log.debug(`ID: ${entry.sprinkleName}UpdateList Sprinkle Off: boostReady = ${boostReady}`);
             }
             /* Zeiten löschen */
             clearInterval(entry.countdown);
             /*clearTimeout(entry.onOffTimeoutOn);*/
             clearTimeout(entry.onOffTimeoutOff);
-            /* Ventil aus threadList löschen => Aufgabe beendet */
+            /* Ventil aus threadList löschen → Aufgabe beendet */
             //delList(entry.sprinkleName);
             entry.killSprinkle = true;
             updateList();
@@ -408,7 +402,7 @@ function updateList () {
     }
 
     if (curFlow < 0) {
-        /* - wenn beim Umschalten der Pumpen die Förderleistung zu gering => Ventile deaktivieren - */
+        /* - wenn beim Umschalten der Pumpen die Förderleistung zu gering → Ventile deaktivieren - */
         // aufsteigend sortieren nach der Verbrauchsmenge
         threadList.sort(mySortAscending);
 
@@ -427,7 +421,7 @@ function updateList () {
                     ack: true
                 });
                 // valveOnOff(entry, false, '#2.6 Set: wait, ID: ');
-                adapter.log.info('#2.07 Set ID: ' + entry.sprinkleName + ' Pump delivery rate too low, wait!  curFlow ' + curFlow + ' parallel: ' + parallel);
+                adapter.log.info(`Set ID: ${entry.sprinkleName} Pump delivery rate too low, wait!  curFlow ${curFlow} parallel: ${parallel}`);
             }
         }
     }
@@ -447,9 +441,7 @@ function updateList () {
             entry.enabled = true;	// einschalten merken
             if (myConfig.config[entry.sprinkleID].booster) {
                 boostReady = false;
-                if (adapter.config.debug) {
-                    adapter.log.info('#2.13 ID: ' + entry.sprinkleName + 'UpdateList sprinkle On: boostReady = ' + boostReady);
-                }
+                adapter.log.debug(`ID: ${entry.sprinkleName}UpdateList sprinkle On: boostReady = ${boostReady}`);
                 setTimeout(() => {
                     boostList(entry.sprinkleID);
                 }, 50);
@@ -484,7 +476,7 @@ function updateList () {
 
     switchTheValvesOffOn(threadList, parallel).then(err => {
         if (err) {
-            adapter.log.error('#Error - Set (false) err: ' + err);
+            adapter.log.error('Error - Set (false) err: ' + err);
             sendMessageText.sendMessage('Error - Set (fase) err: ' + err);
         }
     });
@@ -494,11 +486,11 @@ function updateList () {
 
 /**
  * +++++  Set the current pump for irrigation  +++++
- * => Festlegen der aktuellen Pumpe zur Bewässerung
+ * → Festlegen der aktuellen Pumpe zur Bewässerung
  */
 function setActualPump () {
     if (adapter.config.cisternSettings === true) {
-        /* Zisternen-Bewässerung Einstellung in der config (2.Pumpe) aktiviert */
+        /* Zisternen-Bewässerung Einstellung in der config (2. Pumpe) aktiviert */
         if (currentPumpUse.enable === true) {
             /* Bewässerungspumpen aktiv */
             if ((fillLevelCistern < parseFloat(adapter.config.triggerMinCisternLevel)) && (currentPumpUse.pumpCistern === true)) {
@@ -514,7 +506,7 @@ function setActualPump () {
                     val: true,
                     ack: false
                 }); // Hauptpumpe Ein
-                adapter.log.info('#2.08 Pump change (cistern empty) Cistern pump off => main pump on');
+                adapter.log.info('Pump change (cistern empty) Cistern pump off => main pump on');
                 updateList();   // Wasserverbrauch an Pumpenleistung anpassen
             }
             if (fillLevelCistern < parseFloat(adapter.config.triggerMinCisternLevel)) {
@@ -584,7 +576,7 @@ function setPumpOnOff(pumpOnOff) {
                             ack: false
                         });
                         currentPumpUse.enable = true;
-                        adapter.log.info('#2.01 Set pump on');
+                        adapter.log.info('Set pump on');
                     }
                 } else {
                     if (state.val !== false) {
@@ -593,11 +585,11 @@ function setPumpOnOff(pumpOnOff) {
                             ack: false
                         });
                         currentPumpUse.enable = false;
-                        adapter.log.info('#2.02 Set pump off');
+                        adapter.log.info('Set pump off');
                     }
                 }
             } else if (err) {
-                adapter.log.error('#2.17 triggerMainPump ' + currentPumpUse.pumpName + ' is not available (ist nicht erreichbar): ' + err);
+                adapter.log.error(`triggerMainPump ${currentPumpUse.pumpName} is not available (ist nicht erreichbar): ${err}`);
             }
         });
     }
@@ -618,7 +610,7 @@ function setVoltageOnOff(voltageOnOff) {
                             val: true,
                             ack: false
                         });
-                        adapter.log.info('#2.03 Set voltage on');
+                        adapter.log.info('Set voltage on');
                     }
                 } else {
                     if (state.val !== false) {
@@ -626,11 +618,11 @@ function setVoltageOnOff(voltageOnOff) {
                             val: false ,
                             ack: false
                         });
-                        adapter.log.info('#2.04 Set voltage off');
+                        adapter.log.info('Set voltage off');
                     }
                 }
             } else if (err) {
-                adapter.log.error('#2.13 triggerControlVoltage is not available (ist nicht erreichbar): ' + err);
+                adapter.log.error('triggerControlVoltage is not available (ist nicht erreichbar): ' + err);
             }
         });
     }
@@ -678,8 +670,8 @@ function addConsumedAndTime(entry) {
 /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
 
 /**
- *
- * @type {{clearEntireList: valveControl.clearEntireList, initValveControl: valveControl.initValveControl, setFillLevelCistern: valveControl.setFillLevelCistern, addList: valveControl.addList}}
+ * -- externe Funktionen -> initValveControl - addList - clearEntireList - setFillLevelCistern --
+ * @type {{clearEntireList(): void, initValveControl(ioBroker.Adapter): void, setFillLevelCistern(number): void, addList(Array<{auto: Boolean, sprinkleID: Number, wateringTime: Number}>): void}}
  */
 const valveControl = {
     /**
@@ -687,7 +679,7 @@ const valveControl = {
      * => Initialisieren Sie die Startkonfiguration von ventilControl
      * @param {ioBroker.Adapter} myAdapter
      */
-    initValveControl: (myAdapter) => {
+    initValveControl (myAdapter) {
         adapter = adapter || myAdapter;
         currentPumpUse.pumpCistern = false;
         currentPumpUse.pumpName = adapter.config.triggerMainPump || '';
@@ -703,7 +695,7 @@ const valveControl = {
             val: 0 + ' : ' + adapter.config.maximumParallelValves,
             ack: true
         });
-        /* Pumpe ausschalter wenn vorhanden */
+        /* Pumpe ausschalter, wenn vorhanden */
         if (adapter.config.triggerMainPump !== '') {
             adapter.getState('adapter.config.triggerMainPump', (err, state) => {
                 if (state) {
@@ -714,7 +706,7 @@ const valveControl = {
                 }
             });
         }
-        /* Pumpe (Zisterne) ausschalter wenn vorhanden */
+        /* Pumpe (Zisterne) ausschalter, wenn vorhanden */
         if (adapter.config.triggerCisternPump !== '') {
             adapter.getState('adapter.config.triggerCisternPump', (err, state) => {
                 if (state) {
@@ -728,7 +720,7 @@ const valveControl = {
         /* alle Ventile (.name = "hm-rpc.0.MEQ1234567.3.STATE") in einem definierten Zustand (false) versetzen*/
         const result = adapter.config.events;
         if (result) {
-            for(const res of result) {
+            for (const res of result) {
                 adapter.getState(res.name, (err, state) => {
                     if (state) {
                         adapter.setState(res.name, {
@@ -743,19 +735,19 @@ const valveControl = {
 
     /**
      *  Add Sprinkle
-     * => Sprinkle hinzufügen
-     * - auto => Automatik == (true), Handbetrieb == (false)
-     * - sprinkleID => zugriff auf myConfig.config[sprinkleID].???
-     * - wateringTime => Bewässerungszeit in min
+     * → Sprinkle hinzufügen
+     * - auto → Automatik == (true), Handbetrieb == (false)
+     * - sprinkleID → zugriff auf myConfig.config[sprinkleID]. xyz
+     * - wateringTime → Bewässerungszeit in min
      * @param {Array.<{auto: Boolean, sprinkleID: Number, wateringTime: Number}>} sprinkleList
      */
-    addList: (sprinkleList) => {
+    addList (sprinkleList) {
         //
         for (const res of sprinkleList) {
             const sprinkleName = myConfig.config[res.sprinkleID].objectName;
             /**
              * add done
-             * => hinzufügen erledigt (Sprenger bereits aktive)
+             * → hinzufügen erledigt (Sprenger bereits aktive)
              * @type {boolean}
              */
             let addDone = false;
@@ -774,9 +766,7 @@ const valveControl = {
                             ack: false
                         });
                         addDone = true;		// Sprinkle found
-                        if (adapter.config.debug) {
-                            adapter.log.info('#2.14 update ID: ' + entry.sprinkleName + ' new time: ' + addTime(res.wateringTime, ''));
-                        }
+                        adapter.log.debug(`update ID: ${entry.sprinkleName} new time: ${addTime(res.wateringTime, '')}`);
                         break;
                     }
                 }
@@ -821,9 +811,7 @@ const valveControl = {
                     val: addTime(res.wateringTime, ''),
                     ack: false
                 });
-                if (adapter.config.debug) {
-                    adapter.log.info('#2.15 ID: ' + sprinkleName + 'new order created: ' + JSON.stringify(threadList[newThread.id]));
-                }
+                adapter.log.debug(`ID: ${sprinkleName} new order created: ${JSON.stringify(threadList[newThread.id])}`);
             }
         }
         updateList();
@@ -833,7 +821,7 @@ const valveControl = {
      * switch off all devices, when close the adapter
      * => Beim Beenden des adapters alles ausschalten
      */
-    clearEntireList: () => {
+    clearEntireList () {
         if (boostListTimer) {
             clearTimeout(boostListTimer);
         }
@@ -873,9 +861,7 @@ const valveControl = {
                 entry.times.boostTime2 = null;
             }
             threadList.pop();
-            if (adapter.config.debug) {
-                adapter.log.info('#2.16 order deleted Stop all ID: ' + entry.sprinkleName + ' ( rest orders: ' + threadList.length + ')');
-            }
+            adapter.log.debug(`order deleted Stop all ID: ${entry.sprinkleName} ( rest orders: ${threadList.length} )`);
         }
         updateList();
     }, // End clearEntireList
@@ -884,11 +870,11 @@ const valveControl = {
      * Änderungen des Füllstands setzen + Vorrang der Pumpe setzen
      * @param {number} levelCistern
      */
-    setFillLevelCistern: (levelCistern) => {
+    setFillLevelCistern (levelCistern) {
         fillLevelCistern = (typeof levelCistern === 'number') ? levelCistern : 0 ;
         setActualPump();
     }   // End setFillLevelCistern
-};  // End valveControl
+}  // End valveControl
 
 /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/