iobroker.sprinklecontrol 1.0.0 → 1.0.2

package/main.js

@@ -15,9 +15,8 @@ const controlVoltage = require('./lib/valveControl.js').controlVoltage; // state
 const currentPumpUse = require('./lib/valveControl.js').currentPumpUse; // state der Pumpen
 const threadList = require('./lib/valveControl.js').threadList;         // Auflistung aller aktiver Sprenger-Kreise
 const myConfig = require('./lib/myConfig.js');                          // myConfig → Speichern und abrufen von Konfigurationsdaten der Ventile
-const evaporation = require('./lib/evaporation.js');
-const addTime = require('./lib/tools.js').addTime;
-const formatTime = require('./lib/tools.js').formatTime;
+const evaporation = require('./lib/evaporation.js');                    // Berechnung der Verdunstung, Ermittlung der täglichen Höchsttemperatur, Speicherung der aktuellen Werte von Temperatur, Luftfeuchtigkeit, Helligkeit, Windgeschwindigkeit und Regenmenge
+const tools = require('./lib/tools.js').tools;                          // tools => laden von Hilfsfunktionen
 
 /**
  * The adapter instance
@@ -30,6 +29,7 @@ let weatherForecastTodayPfadStr;    // Pfad zur Regenvorhersage in mm (Regenvorh
 let weatherForecastTodayNum = 0;    // heutige Regenvorhersage in mm
 let weatherForecastTomorrowNum = 0; // morgige Regenvorhersage in mm
 let addStartTimeSwitch = false;     // Externer Schalter für Zusatzbewässerung
+let irrigationRestriction = false;  // Schalter für Bewässerungseinschränkung
 
 let startTimeStr;
 let sunriseStr;
@@ -68,6 +68,8 @@ function startAdapter(options) {
                 /*Startzeiten der Timer löschen*/
                 schedule.cancelJob('calcPosTimer');
                 schedule.cancelJob('sprinkleStartTime');
+                schedule.cancelJob('irrigationRestrictionOn');
+                schedule.cancelJob('irrigationRestrictionOff');
                 schedule.cancelJob('sprinkleAddStartTime');
                 /* alle Ventile und Aktoren deaktivieren */
                 valveControl.clearEntireList();
@@ -137,7 +139,7 @@ function startAdapter(options) {
                     }
                 }
                 // Wettervorhersage
-                if (adapter.config.weatherForecast === true) {
+                if (adapter.config.weatherForecastService !== 'noWeatherData') {
                     if (id === weatherForecastTodayPfadStr) {
                         if (typeof state.val == 'string') {
                             weatherForecastTodayNum = parseFloat(state.val);
@@ -288,7 +290,7 @@ function startAdapter(options) {
                             const _extBreak = await valveControl.extBreak(_found.sprinkleID, state.val).catch((e) => {
                                 adapter.log.warn(`main.extBreak: ${e}`);
                             });
-                            adapter.log.info(`_extBreake: ${_extBreak}, ${JSON.stringify(_extBreak)}`);
+                            if (_extBreak?.name) adapter.log.info(`_extBreak: ${_extBreak.name}, ${_extBreak.val ? 'on' : 'off'}`);
                             if (_extBreak?.val === false) {
                                 /* Zustand des Ventils im Thread < 0 > off, < 1 > wait, < 2 > on, < 3 > break, < 4 > Boost(on), < 5 > off(Boost), < 6 > Cistern empty, <<< 7 >>> extBreak */
                                 adapter.setState(`sprinkle.${_found.objectName}.sprinklerState`, {
@@ -317,24 +319,24 @@ function startAdapter(options) {
                     // Bestätigung für das Schalten der Ventile
                     if (myConfig.config) {
                         //adapter.log.info(`vor found: ${id} (${state.val}) => ack === ${state.ack}`);
-                        const found = myConfig.config.find((d) => d.idState === id);
+                        const found = myConfig.config.find((d) => d.control.idACK === id);
                         //adapter.log.info(`nach found: ${id} => ${JSON.stringify(found)}`);
-                        if (found && (id === myConfig.config[found.sprinkleID].idState)) {
+                        if (found && (id === myConfig.config[found.sprinkleID].control.idACK)) {
                             found.state = state;
                         }
                     }
                     if (threadList) {
-                        const found = threadList.find((d) => d.idState === id);
+                        const found = threadList.find((d) => d.control.idACK === id);
                         if (found !== undefined && typeof found.controller.ackTrue === 'function') {
                             found.controller.ackTrue(state);
                         }
                     }
                     // 24V Steuerspannung
-                    if (id === adapter.config.triggerControlVoltage && typeof controlVoltage.controller.ackTrue === 'function') {
+                    if (id === controlVoltage.control.idACK && typeof controlVoltage.controller.ackTrue === 'function') {
                         controlVoltage.controller.ackTrue(state);
                     }
                     // Pumpe (aktuell verwendete Pumpe)
-                    if (id === currentPumpUse.idState && typeof currentPumpUse.controller.ackTrue === 'function') {
+                    if (id === currentPumpUse.control.idACK && typeof currentPumpUse.controller.ackTrue === 'function') {
                         currentPumpUse.controller.ackTrue(state);
                     }
                     // The state was deleted
@@ -414,7 +416,7 @@ async function curNextFixDay (sprinkleID, returnOn) {
     const objPfad = `sprinkle.${myConfig.config[sprinkleID].objectName}`;
     const weekday = ['Sun','Mon','Tue','Wed','Thur','Fri','Sat'];
     let found = false;
-    let curDay = formatTime().day;
+    let curDay = tools.formatTime().day;
     const d = new Date();
     const curTime = `${zweiStellen(d.getHours())}:${zweiStellen(d.getMinutes())}`;
 
@@ -460,7 +462,7 @@ async function curNextFixDay (sprinkleID, returnOn) {
  *     false → Zweitage-modus (twoNd)
  */
 async function setNewDay (indexNr, threeRd) {
-    const today = formatTime().day;
+    const today = tools.formatTime().day;
     const nextStartDay = ((today + 1) > 6 ? 0 : (today + 1));
     const objectName = myConfig.config[indexNr].objectName;
     const _actualSoilMoisture = await adapter.getStateAsync(
@@ -494,7 +496,7 @@ async function setNewDay (indexNr, threeRd) {
  * @returns {number} - resultierende Regenmenge
  */
 function resRain (inGreenhouse) {
-    return +((adapter.config.weatherForecast && !inGreenhouse) ? (((+ weatherForecastTodayNum) - parseFloat(adapter.config.thresholdRain)).toFixed(1)) : 0);
+    return +((adapter.config.weatherForecastService !== 'noWeatherData' && !inGreenhouse) ? (((+ weatherForecastTodayNum) - parseFloat(adapter.config.thresholdRain)).toFixed(1)) : 0);
 }
 
 /**
@@ -567,7 +569,7 @@ async function checkStates() {
         }
 
         /*   akt. kW ermitteln für history last week   */
-        const _formatTime = formatTime();
+        const _formatTime = tools.formatTime();
         kw = _formatTime.kW;
         today = _formatTime.day;
     } catch (e) {
@@ -620,7 +622,7 @@ async function checkActualStates () {
             }
         }
 
-        if (adapter.config.weatherForecast === true && (weatherForecastTodayPfadStr !== undefined || weatherForecastTodayPfadStr !== '')) {
+        if (adapter.config.weatherForecastService !== 'noWeatherData' && (weatherForecastTodayPfadStr !== undefined || weatherForecastTodayPfadStr !== '')) {
             /*     Niederschlagsmenge HEUTE in mm     */
             const _weatherForInstanceToday = await adapter.getForeignStateAsync(
                 weatherForecastTodayPfadStr
@@ -712,7 +714,7 @@ async function checkActualStates () {
 const calcPos = schedule.scheduleJob('calcPosTimer', '5 0 * * *', function() {
     // Berechnungen mittels SunCalc
     sunPos();
-    const _curTime = formatTime();
+    const _curTime = tools.formatTime();
     today = _curTime.day;
 
     // History Daten aktualisieren, wenn eine neue Woche beginnt
@@ -751,6 +753,10 @@ const calcPos = schedule.scheduleJob('calcPosTimer', '5 0 * * *', function() {
     // Startzeit Festlegen → verzögert wegen Daten von SunCalc
     setTimeout(() => {
         startTimeSprinkle();
+        if (adapter.config.enableTimeBasedRestriction === true) {
+            irrigationRestrictionOn();
+            irrigationRestrictionOff();
+        }
         addStartTimeSprinkle();
     },1000);
 
@@ -780,6 +786,28 @@ function sunPos() {
     }
 }
 
+function irrigationRestrictionOn() {
+    schedule.cancelJob('irrigationRestrictionOn');
+    if (adapter.config.enableTimeBasedRestriction === true) {
+        const startOfInterruptionSplit = adapter.config.startOfInterruption.split(':');
+        const scheduleStartOfInterruption = schedule.scheduleJob('irrigationRestrictionOn', `${ startOfInterruptionSplit[1] } ${ startOfInterruptionSplit[0] } * * *`, function() {
+            irrigationRestriction = true;
+            valveControl.timeBasedRestriction(true);
+            adapter.log.info(`Time-based irrigation restriction is enabled! (${adapter.config.startOfInterruption} - ${adapter.config.endOfInterruption})`);
+        });
+    }
+}
+
+function irrigationRestrictionOff() {
+    schedule.cancelJob('irrigationRestrictionOff');
+    const endOfInterruptionSplit = adapter.config.endOfInterruption.split(':');
+    const scheduleEndOfInterruption = schedule.scheduleJob('irrigationRestrictionOff', `${ endOfInterruptionSplit[1] } ${ endOfInterruptionSplit[0] } * * *`, function() {
+        irrigationRestriction = false;
+        valveControl.timeBasedRestriction(false);
+        adapter.log.info('Time-based irrigation restrictions have been disabled!');
+    });
+}
+
 function addStartTimeSprinkle() {
     schedule.cancelJob('sprinkleAddStartTime');
     if (adapter.config.selectAddStartTime === 'greaterETpCurrent' 
@@ -827,7 +855,7 @@ function addStartTimeSprinkle() {
                                 case 'bistable': {
                                     if (res.bistable.bool) {
                                         messageText += `<b>${res.objectName}</b> (${res.bistable.bool})\n`
-                                                    +  `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(Math.round(60 * res.addWateringTime), '')}\n`;
+                                                    +  `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(Math.round(60 * res.addWateringTime), '')}\n`;
                                         memAddList.push({
                                             auto: false,
                                             sprinkleID: res.sprinkleID,
@@ -838,7 +866,7 @@ function addStartTimeSprinkle() {
                                 }
                                 case 'fixDay': {
                                     messageText += `<b>${res.objectName}</b>\n`
-                                                +  `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(Math.round(60 * res.addWateringTime), '')}\n`;
+                                                +  `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(Math.round(60 * res.addWateringTime), '')}\n`;
                                     memAddList.push({
                                         auto: false,
                                         sprinkleID: res.sprinkleID,
@@ -848,7 +876,7 @@ function addStartTimeSprinkle() {
                                 }
                                 case 'calculation': {
                                     messageText += `<b>${res.objectName}</b> ${res.calculation.pct}% (${res.calculation.pctTriggerIrrigation}%)\n`
-                                                    + `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(Math.round(60 * res.addWateringTime), '')}\n`;
+                                                    + `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(Math.round(60 * res.addWateringTime), '')}\n`;
                                     memAddList.push({
                                         auto: false,
                                         sprinkleID: res.sprinkleID,
@@ -859,7 +887,7 @@ function addStartTimeSprinkle() {
                                 case 'analog': {
                                     if (res.analog.pct < res.analog.pctAddTriggersIrrigation) {
                                         messageText += `<b>${res.objectName}</b> ${res.analog.pct} %(${res.analog.pctAddTriggersIrrigation}%)\n`
-                                                    +  `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(Math.round(60 * res.addWateringTime), '')}\n`;
+                                                    +  `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(Math.round(60 * res.addWateringTime), '')}\n`;
                                         memAddList.push({
                                             auto: false,
                                             sprinkleID: res.sprinkleID,
@@ -947,7 +975,7 @@ function startTimeSprinkle() {
                 case 'livingSunrise' :			/*Startauswahl = Sonnenaufgang*/
                     infoMessage = 'Start mit Sonnenaufgang ';
                     // format sunrise time from the Date object
-                    newStartTime = addTime(sunriseStr, parseInt(adapter.config.timeShift));
+                    newStartTime = tools.addTime(sunriseStr, parseInt(adapter.config.timeShift));
                     break;
                 case 'livingGoldenHourEnd' :	/*Startauswahl = Ende der Golden Hour*/
                     infoMessage = 'Start zum Ende der Golden Hour ';
@@ -957,7 +985,7 @@ function startTimeSprinkle() {
                 case 'livingSunset' :           /*Startauswahl = Sonnenuntergang*/
                     infoMessage = 'Start mit Sonnenuntergang ';
                     // format sunset time from the Date object
-                    newStartTime = addTime(sunsetStr, parseInt(adapter.config.timeShift));
+                    newStartTime = tools.addTime(sunsetStr, parseInt(adapter.config.timeShift));
                     break;
             }
             // Start am Wochenende →, wenn andere Zeiten verwendet werden soll
@@ -1061,8 +1089,8 @@ const startOfIrrigation = async () => {
                                         sprinkleID: res.sprinkleID,
                                         wateringTime: curWateringTime
                                     });
-                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(curWateringTime, '')}\n`;
-                                } else if (adapter.config.weatherForecast) {
+                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(curWateringTime, '')}\n`;
+                                } else if (adapter.config.weatherForecastService !== 'noWeatherData') {
                                 /* Bewässerung unterdrückt da ausreichende Regenvorhersage */
                                     messageText += `   <i>Start verschoben, da heute ${weatherForecastTodayNum}mm Niederschlag</i> \n`;
                                     adapter.log.info(`${res.objectName}: Start verschoben, da Regenvorhersage für Heute ${weatherForecastTodayNum} mm [ ${resRain(res.inGreenhouse)} > 0 ]`);
@@ -1085,8 +1113,8 @@ const startOfIrrigation = async () => {
                                         sprinkleID: res.sprinkleID,
                                         wateringTime: Math.round(60* countdown)
                                     });
-                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(Math.round(60*countdown), '')}\n}`;
-                                } else if (adapter.config.weatherForecast) {
+                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(Math.round(60*countdown), '')}\n}`;
+                                } else if (adapter.config.weatherForecastService !== 'noWeatherData') {
                                 /* Bewässerung unterdrückt da ausreichende Regenvorhersage */
                                     messageText += `   <i>Start verschoben, da heute ${weatherForecastTodayNum}mm Niederschlag</i> \n`;
                                     adapter.log.info(`${res.objectName}: Start verschoben, da Regenvorhersage für Heute ${weatherForecastTodayNum}mm [ ${resRain(res.inGreenhouse)} > 0 ]`);
@@ -1106,7 +1134,7 @@ const startOfIrrigation = async () => {
                                         sprinkleID: res.sprinkleID,
                                         wateringTime: curWateringTime
                                     });
-                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(curWateringTime, '')}\n`;
+                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(curWateringTime, '')}\n`;
                                     if (res.fixDay.startDay === 'threeRd'){          // Next Start in 3 Tagen
                                         res.fixDay.startFixDay[today] = false;
                                         res.fixDay.startFixDay[(+ today + 3 > 6) ? (+ today-4) : (+ today+3)] = true;
@@ -1115,7 +1143,7 @@ const startOfIrrigation = async () => {
                                         res.fixDay.startFixDay[(+ today + 2 > 6) ? (+ today-5) : (+ today+2)] = true;
                                     }
                                 }
-                            } else if (adapter.config.weatherForecast){
+                            } else if (adapter.config.weatherForecastService !== 'noWeatherData'){
                                 messageText += `   <i>Start verschoben, da heute ${weatherForecastTodayNum}mm Niederschlag</i> \n`;
                                 adapter.log.info(`${res.objectName}: Start verschoben, da Regenvorhersage für Heute ${weatherForecastTodayNum} mm [ ${resRain(res.inGreenhouse)} > 0 ]`);
                                 if ((res.fixDay.startDay === 'threeRd') || (res.fixDay.startDay === 'twoNd')) {
@@ -1140,7 +1168,7 @@ const startOfIrrigation = async () => {
                         case 'calculation':
                             if (res.calculation.val <= res.calculation.triggersIrrigation) {
                             /* Wenn in der Config Regenvorhersage aktiviert: Startvorgang abbrechen, wenn es heute ausreichend regnen sollte. */
-                                const resMoisture = (adapter.config.weatherForecast)?((+ res.calculation.val) + (+ weatherForecastTodayNum) - parseFloat(adapter.config.thresholdRain)):(res.calculation.val);   // aktualisierte Bodenfeuchte mit Regenvorhersage
+                                const resMoisture = (adapter.config.weatherForecastService !== 'noWeatherData')?((+ res.calculation.val) + (+ weatherForecastTodayNum) - parseFloat(adapter.config.thresholdRain)):(res.calculation.val);   // aktualisierte Bodenfeuchte mit Regenvorhersage
                                 if ((resMoisture <= res.calculation.triggersIrrigation) || res.inGreenhouse) {   // Kontrolle ob Regenvorhersage ausreicht || Bewässerung inGreenhouse
                                     let countdown = res.wateringTime * (res.calculation.maxIrrigation - res.calculation.val) / (res.calculation.maxIrrigation - res.calculation.triggersIrrigation); // in min
                                     // Begrenzung der Bewässerungszeit auf dem in der Config eingestellten Überschreitung (in Prozent)
@@ -1152,8 +1180,8 @@ const startOfIrrigation = async () => {
                                         sprinkleID: res.sprinkleID,
                                         wateringTime: Math.round(60*countdown)
                                     });
-                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${addTime(Math.round(60*countdown), '')}\n`;
-                                } else if (adapter.config.weatherForecast) {
+                                    messageText += `   ${res.extBreak ? 'extBreak ||' : 'START =>'} ${tools.addTime(Math.round(60*countdown), '')}\n`;
+                                } else if (adapter.config.weatherForecastService !== 'noWeatherData') {
                                 /* Bewässerung unterdrückt da ausreichende Regenvorhersage */
                                     messageText += `   <i>Start verschoben, da heute ${weatherForecastTodayNum}mm Niederschlag</i> \n`;
                                     adapter.log.info(`${res.objectName}: Start verschoben, da Regenvorhersage für Heute ${weatherForecastTodayNum} mm [ ${res.calculation.val.toFixed(1)} (${resMoisture.toFixed(1)}) <= ${res.calculation.triggersIrrigation} ]`);
@@ -2151,18 +2179,18 @@ async function main() {
     await adapter.subscribeStatesAsync('control.Holiday');
     //adapter.subscribeStates('info.Elevation');
     //adapter.subscribeStates('info.Azimut');
-    if (adapter.config.weatherForecast === true) {
-        if (adapter.config.weatherForecastService === 'ownDataPoint') {
-            weatherForecastTodayPfadStr = adapter.config.pathRainForecast;
-            adapter.subscribeForeignStates(weatherForecastTodayPfadStr);
-        } else if (adapter.config.weatherForecastService === 'dasWetter' && (adapter.config.weatherForInstance.length > 10)) {
-            weatherForecastTodayPfadStr = `${ adapter.config.weatherForInstance }.location_1.ForecastDaily.Day_1.Rain`;
-            adapter.subscribeForeignStates(weatherForecastTodayPfadStr);
-            adapter.subscribeForeignStates(`${ adapter.config.weatherForInstance }.location_1.ForecastDaily.Day_2.Rain`);
-        } else {
-            adapter.log.warn('There is no valid data record stored in the weather forecast, please correct it!');
-        }
+    
+    if (adapter.config.weatherForecastService === 'ownDataPoint') {
+        weatherForecastTodayPfadStr = adapter.config.pathRainForecast;
+        adapter.subscribeForeignStates(weatherForecastTodayPfadStr);
+    } else if (adapter.config.weatherForecastService === 'dasWetter' && (adapter.config.weatherForInstance.length > 10)) {
+        weatherForecastTodayPfadStr = `${ adapter.config.weatherForInstance }.location_1.ForecastDaily.Day_1.Rain`;
+        adapter.subscribeForeignStates(weatherForecastTodayPfadStr);
+        adapter.subscribeForeignStates(`${ adapter.config.weatherForInstance }.location_1.ForecastDaily.Day_2.Rain`);
+    } else {
+        adapter.log.warn('There is no valid data record stored in the weather forecast, please correct it!');
     }
+    
     // Request a notification from a third-party adapter => Fordern Sie eine Benachrichtigung von einem Drittanbieter-Adapter an
     if (adapter.config.publicHolidays === true && (`${ adapter.config.publicHolInstance }.heute.*`)) {
         adapter.subscribeForeignStates(`${ adapter.config.publicHolInstance }.heute.*`);
@@ -2203,6 +2231,20 @@ async function main() {
     timer = setTimeout(() => {
         startTimeSprinkle();
         addStartTimeSprinkle();
+        if (adapter.config.enableTimeBasedRestriction === true) {
+            if(tools.laterThanTime(adapter.config.startOfInterruption) === true){            // Bewässerungsverbot wird heute noch aktiviert
+                irrigationRestriction = false
+                irrigationRestrictionOn();
+                irrigationRestrictionOff();
+            } else if (tools.laterThanTime(adapter.config.endOfInterruption) === true){      // Bewässerungsverbot aktiv
+                irrigationRestriction = true;
+                irrigationRestrictionOff();
+                valveControl.timeBasedRestriction(true);
+                adapter.log.info(`Time-based irrigation restriction is enabled! (${adapter.config.startOfInterruption} - ${adapter.config.endOfInterruption})`);
+            } else {
+                irrigationRestriction = false;                                      // Bewässerungsverbot war schon aktiv, wird heute nicht mehr aktiviert
+            }
+        }
     }, 1000);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.sprinklecontrol",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Control of several sprinklers depending on weather conditions and pump performance.",
   "author": {
     "name": "Dirk Peter",