/* xdrv_09_timers.ino - timer support for Sonoff-Tasmota Copyright (C) 2018 Theo Arends This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ #ifdef USE_TIMERS /*********************************************************************************************\ * Timers * * Arm a timer using one or all of the following JSON values: * {"Arm":1,"Time":"09:23","Days":"--TW--S","Repeat":1,"Device":1,"Power":1} * * Arm 0 = Off, 1 = On * Time hours:minutes * Days 7 day character mask starting with Sunday (SMTWTFS). 0 or - = Off, any other value = On * Repeat 0 = Execute once, 1 = Execute again * Device 1..16 * Power 0 = Off, 1 = On, 2 = Toggle, 3 = Blink * \*********************************************************************************************/ enum TimerCommands { CMND_TIMER, CMND_TIMERS }; const char kTimerCommands[] PROGMEM = D_CMND_TIMER "|" D_CMND_TIMERS ; uint16_t fired = 0; void TimerEverySecond() { if (RtcTime.valid) { uint16_t time = (RtcTime.hour * 60) + RtcTime.minute; uint8_t days = 1 << (RtcTime.day_of_week -1); for (byte i = 0; i < MAX_TIMERS; i++) { if (Settings.timer[i].device >= devices_present) Settings.timer[i].data = 0; // Reset timer due to change in devices present if (Settings.timer[i].arm) { if (time == Settings.timer[i].time) { if (!bitRead(fired, i) && (Settings.timer[i].days & days)) { bitSet(fired, i); Settings.timer[i].arm = Settings.timer[i].repeat; ExecuteCommandPower(Settings.timer[i].device +1, Settings.timer[i].power); } } else { bitClear(fired, i); } } } } } void PrepShowTimer(uint8_t index) { char days[8] = { 0 }; index--; for (byte i = 0; i < 7; i++) { uint8_t mask = 1 << i; snprintf(days, sizeof(days), "%s%d", days, ((Settings.timer[index].days & mask) > 0)); } snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s\"" D_CMND_TIMER "%d\":{\"" D_JSON_TIMER_ARM "\":%d,\"" D_JSON_TIMER_TIME "\":\"%02d:%02d\",\"" D_JSON_TIMER_DAYS "\":\"%s\",\"" D_JSON_TIMER_REPEAT "\":%d,\"" D_JSON_TIMER_OUTPUT "\":%d,\"" D_JSON_TIMER_POWER "\":%d}"), mqtt_data, index +1, Settings.timer[index].arm, Settings.timer[index].time / 60, Settings.timer[index].time % 60, days, Settings.timer[index].repeat, Settings.timer[index].device +1, Settings.timer[index].power); } /*********************************************************************************************\ * Commands \*********************************************************************************************/ boolean TimerCommand() { char command [CMDSZ]; char dataBufUc[XdrvMailbox.data_len]; boolean serviced = true; uint8_t index = XdrvMailbox.index; UpperCase(dataBufUc, XdrvMailbox.data); int command_code = GetCommandCode(command, sizeof(command), XdrvMailbox.topic, kTimerCommands); if ((CMND_TIMER == command_code) && (index > 0) && (index <= MAX_TIMERS)) { uint8_t error = 0; if (XdrvMailbox.data_len) { if ((XdrvMailbox.payload >= 0) && (XdrvMailbox.payload <= MAX_TIMERS)) { if (XdrvMailbox.payload == 0) { Settings.timer[index -1].data = 0; // Clear timer } else { Settings.timer[index -1].data = Settings.timer[XdrvMailbox.payload -1].data; // Copy timer } } else { if (devices_present) { StaticJsonBuffer<128> jsonBuffer; JsonObject& root = jsonBuffer.parseObject(dataBufUc); if (!root.success()) { snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("{\"" D_CMND_TIMER "%d\":\"" D_JSON_INVALID_JSON "\"}"), index); // JSON decode failed error = 1; } else { char parm_uc[10]; index--; if (root[UpperCase_P(parm_uc, PSTR(D_JSON_TIMER_ARM))].success()) { Settings.timer[index].arm = (root[parm_uc] != 0); } if (root[UpperCase_P(parm_uc, PSTR(D_JSON_TIMER_TIME))].success()) { uint16_t itime = 0; uint8_t value = 0; char time_str[10]; snprintf(time_str, sizeof(time_str), root[parm_uc]); const char *substr = strtok(time_str, ":"); if (substr != NULL) { value = atoi(substr); if (value > 23) value = 23; itime = value * 60; substr = strtok(NULL, ":"); if (substr != NULL) { value = atoi(substr); if (value > 59) value = 59; itime += value; } } Settings.timer[index].time = itime; } if (root[UpperCase_P(parm_uc, PSTR(D_JSON_TIMER_DAYS))].success()) { // SMTWTFS = 1234567 = 0011001 = 00TW00S = --TW--S Settings.timer[index].days = 0; const char *tday = root[parm_uc]; char ch = '.'; uint8_t i = 0; while ((ch != '\0') && (i < 7)) { ch = *tday++; if (ch == '-') ch = '0'; uint8_t mask = 1 << i++; Settings.timer[index].days |= (ch == '0') ? 0 : mask; } } if (root[UpperCase_P(parm_uc, PSTR(D_JSON_TIMER_REPEAT))].success()) { Settings.timer[index].repeat = (root[parm_uc] != 0); } if (root[UpperCase_P(parm_uc, PSTR(D_JSON_TIMER_OUTPUT))].success()) { uint8_t device = ((uint8_t)root[parm_uc] -1) & 0x0F; Settings.timer[index].device = (device < devices_present) ? device : devices_present -1; } if (root[UpperCase_P(parm_uc, PSTR(D_JSON_TIMER_POWER))].success()) { Settings.timer[index].power = (uint8_t)root[parm_uc] & 0x03; } if (Settings.timer[index].arm) bitClear(fired, index); index++; } } else { snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("{\"" D_CMND_TIMER "%d\":\"" D_JSON_TIMER_NO_DEVICE "\"}"), index); // No outputs defined so nothing to control error = 1; } } } if (!error) { snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("{")); PrepShowTimer(index); snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s}"), mqtt_data); } } else if (CMND_TIMERS == command_code) { byte jsflg = 0; byte lines = 1; for (byte i = 0; i < MAX_TIMERS; i++) { if (!jsflg) { snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("{\"" D_CMND_TIMERS "%d\":{"), lines++); } else { snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s,"), mqtt_data); } jsflg = 1; PrepShowTimer(i +1); if ((strlen(mqtt_data) > (LOGSZ - TOPSZ)) || (i == MAX_TIMERS -1)) { snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s}}"), mqtt_data); MqttPublishPrefixTopic_P(RESULT_OR_STAT, PSTR(D_CMND_TIMERS)); jsflg = 0; } } mqtt_data[0] = '\0'; } else serviced = false; return serviced; } /*********************************************************************************************\ * Presentation \*********************************************************************************************/ #ifdef USE_WEBSERVER #ifdef USE_TIMERS_WEB const char HTTP_TIMER_SCRIPT[] PROGMEM = "var pt=[],ct=99;" "function qs(s){" // Alias to save code space "return document.querySelector(s);" "}" "function ce(i,q){" // Create select option "var o=document.createElement('option');" "o.textContent=i;" "q.appendChild(o);" "}" "function st(){" // Save parameters to hidden area "var i,n,p,s;" "s=0;" "n=1<<30;if(eb('a0').checked){s|=n;}" // Get arm "n=1<<29;if(eb('r0').checked){s|=n;}" // Get repeat "for(i=0;i<7;i++){n=1<<(16+i);if(eb('w'+i).checked){s|=n;}}" // Get weekdays "s|=(eb('p1').value<<27);" // Get power "s|=(qs('#d1').selectedIndex<<23);" // Get device "s|=((qs('#ho').selectedIndex*60)+qs('#mi').selectedIndex)&0x7FF;" // Get time "pt[ct]=s;" "eb('t0').value=pt.join();" // Save parameters from array to hidden area "}" "function ot(t,e){" // Select tab and update elements "var i,n,o,p,q,s;" "if(ct<99){" "st();" // Save changes "}" "o=document.getElementsByClassName('tl');" // Restore style to all tabs/buttons "for(i=0;i>(16+i))&1;eb('w'+i).checked=p;}" // Set weekdays "p=(s>>23)&0xF;qs('#d1').value=p+1;" // Set device "p=(s>>27)&3;eb('p1').value=p;" // Set power "p=(s>>29)&1;eb('r0').checked=p;" // Set repeat "p=(s>>30)&1;eb('a0').checked=p;" // Set arm "ct=t;" "}" "function it(){" // Initialize elements and select first tab "var b,i,o,s;" "pt=eb('t0').value.split(',').map(Number);" // Get parameters from hidden area to array "s='';for(i=0;i<" STR(MAX_TIMERS) ";i++){b='';if(0==i){b=\" id='dP'\";}s+=\"\"}" "eb('bt').innerHTML=s;" // Create tabs "o=qs('#ho');for(i=0;i<=23;i++){ce((i<10)?('0'+i):i,o);}" // Create hours select options "o=qs('#mi');for(i=0;i<=59;i++){ce((i<10)?('0'+i):i,o);}" // Create minutes select options "o=qs('#d1');for(i=0;i<}1;i++){ce(i+1,o);}" // Create devices "var a='" D_DAY3LIST "';" "s='';for(i=0;i<7;i++){s+=\"\"+a.substring(i*3,(i*3)+3)+\"\"}" "eb('ds').innerHTML=s;" // Create weekdays "eb('dP').click();" // Get the element with id='dP' and click on it "}"; const char HTTP_TIMER_STYLE[] PROGMEM = ".tl{float:left;border-radius:0;border:1px solid #fff;padding:1px;width:6.25%;}" ""; const char HTTP_FORM_TIMER[] PROGMEM = "
 " D_TIMER_PARAMETERS " 
" "



" "
" "" D_TIMER_OUTPUT "  " "" D_TIMER_POWER " " "

" "
" // "Time  " "" D_TIMER_TIME "  " D_HOUR_MINUTE_SEPARATOR "  " "" D_TIMER_ARM " " "" D_TIMER_REPEAT "" "

" "
"; const char HTTP_FORM_TIMER2[] PROGMEM = "type='submit' onclick='st();this.form.submit();'"; const char S_CONFIGURE_TIMER[] PROGMEM = D_CONFIGURE_TIMER; void HandleTimerConfiguration() { if (HTTP_USER == webserver_state) { HandleRoot(); return; } AddLog_P(LOG_LEVEL_DEBUG, S_LOG_HTTP, S_CONFIGURE_TIMER); String page = FPSTR(HTTP_HEAD); page.replace(F("{v}"), FPSTR(S_CONFIGURE_TIMER)); page += FPSTR(HTTP_TIMER_SCRIPT); page += FPSTR(HTTP_HEAD_STYLE); page.replace(F(""), FPSTR(HTTP_TIMER_STYLE)); page += FPSTR(HTTP_FORM_TIMER); for (byte i = 0; i < MAX_TIMERS; i++) { if (i > 0) page += F(","); page += String(Settings.timer[i].data); } page += FPSTR(HTTP_FORM_TIMER1); page.replace(F("}1"), String(devices_present)); page += FPSTR(HTTP_FORM_END); page.replace(F("type='submit'"), FPSTR(HTTP_FORM_TIMER2)); page += F(""); // Init elements and select first tab/button page += FPSTR(HTTP_BTN_CONF); ShowPage(page); } void TimerSaveSettings() { char tmp[MAX_TIMERS *12]; // Need space for MAX_TIMERS x 10 digit numbers separated by a comma WebGetArg("t0", tmp, sizeof(tmp)); char *p = tmp; snprintf_P(log_data, sizeof(log_data), PSTR(D_LOG_MQTT D_CMND_TIMERS " ")); for (byte i = 0; i < MAX_TIMERS; i++) { uint32_t data = strtol(p, &p, 10); p++; // Skip comma if ((data & 0x7FF) < 1440) Settings.timer[i].data = data; snprintf_P(log_data, sizeof(log_data), PSTR("%s%s0x%08X"), log_data, (i > 0)?",":"", Settings.timer[i].data); } AddLog(LOG_LEVEL_DEBUG); } #endif // USE_TIMERS_WEB #endif // USE_WEBSERVER /*********************************************************************************************\ * Interface \*********************************************************************************************/ #define XDRV_09 boolean Xdrv09(byte function) { boolean result = false; switch (function) { case FUNC_EVERY_SECOND: TimerEverySecond(); break; case FUNC_COMMAND: result = TimerCommand(); break; } return result; } #endif // USE_TIMERS