2018-04-13 16:42:11 +01:00
|
|
|
/*
|
|
|
|
xdrv_10_rules.ino - rule support for Sonoff-Tasmota
|
|
|
|
|
|
|
|
Copyright (C) 2018 ESP Easy Group and 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 <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef USE_RULES
|
|
|
|
/*********************************************************************************************\
|
|
|
|
* Rules based heavily on ESP Easy implementation
|
|
|
|
*
|
|
|
|
* Inspiration: https://github.com/letscontrolit/ESPEasy
|
|
|
|
*
|
|
|
|
* Add rules using the following, case insensitive, format:
|
|
|
|
* on <trigger1> do <commands> endon on <trigger2> do <commands> endon ..
|
|
|
|
*
|
|
|
|
* Examples:
|
|
|
|
* on System#Boot do Color 001000 endon
|
|
|
|
* on INA219#Current>0.100 do Dimmer 10 endon
|
|
|
|
* on INA219#Current>0.100 do Backlog Dimmer 10;Color 10,0,0 endon
|
|
|
|
* on INA219#Current>0.100 do Backlog Dimmer 10;Color 100000 endon on System#Boot do color 001000 endon
|
|
|
|
* on ds18b20#temperature>23 do power off endon on ds18b20#temperature<22 do power on endon
|
|
|
|
* on mqtt#connected do color 000010 endon
|
|
|
|
* on mqtt#disconnected do color 00100C endon
|
|
|
|
* on time#initialized do color 001000 endon
|
2018-06-26 15:22:53 +01:00
|
|
|
* on time#initialized>120 do color 001000 endon
|
2018-04-13 16:42:11 +01:00
|
|
|
* on time#set do color 001008 endon
|
|
|
|
* on clock#timer=3 do color 080800 endon
|
|
|
|
* on rules#timer=1 do color 080800 endon
|
|
|
|
* on mqtt#connected do color 000010 endon on mqtt#disconnected do color 001010 endon on time#initialized do color 001000 endon on time#set do backlog color 000810;ruletimer1 10 endon on rules#timer=1 do color 080800 endon
|
|
|
|
* on event#anyname do color 100000 endon
|
2018-04-14 13:39:16 +01:00
|
|
|
* on event#anyname do color %value% endon
|
2018-04-13 16:42:11 +01:00
|
|
|
* on power1#state=1 do color 001000 endon
|
2018-04-14 13:39:16 +01:00
|
|
|
* on button1#state do publish cmnd/ring2/power %value% endon on button2#state do publish cmnd/strip1/power %value% endon
|
|
|
|
* on switch1#state do power2 %value% endon
|
2018-05-06 15:07:42 +01:00
|
|
|
* on analog#a0div10 do publish cmnd/ring2/dimmer %value% endon
|
2018-04-13 16:42:11 +01:00
|
|
|
*
|
|
|
|
* Notes:
|
|
|
|
* Spaces after <on>, around <do> and before <endon> are mandatory
|
|
|
|
* System#Boot is initiated after MQTT is connected due to command handling preparation
|
|
|
|
* Control rule triggering with command:
|
|
|
|
* Rule 0 = Rules disabled (Off)
|
|
|
|
* Rule 1 = Rules enabled (On)
|
|
|
|
* Rule 2 = Toggle rules state
|
|
|
|
* Rule 4 = Perform commands as long as trigger is met (Once OFF)
|
|
|
|
* Rule 5 = Perform commands once until trigger is not met (Once ON)
|
|
|
|
* Rule 6 = Toggle Once state
|
|
|
|
* Execute an event like:
|
|
|
|
* Event anyname=001000
|
|
|
|
* Set a RuleTimer to 100 seconds like:
|
|
|
|
* RuleTimer2 100
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
|
|
|
#define MAX_RULE_TIMERS 8
|
2018-04-27 17:06:19 +01:00
|
|
|
#define RULES_MAX_VARS 5
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-04-25 11:06:53 +01:00
|
|
|
#ifndef ULONG_MAX
|
2018-04-13 16:42:11 +01:00
|
|
|
#define ULONG_MAX 0xffffffffUL
|
2018-04-25 11:06:53 +01:00
|
|
|
#endif
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
#define D_CMND_RULE "Rule"
|
|
|
|
#define D_CMND_RULETIMER "RuleTimer"
|
|
|
|
#define D_CMND_EVENT "Event"
|
2018-05-20 16:46:00 +01:00
|
|
|
#define D_CMND_VAR "Var"
|
|
|
|
#define D_CMND_MEM "Mem"
|
2018-06-10 06:09:11 +01:00
|
|
|
#define D_CMND_ADD "Add"
|
|
|
|
#define D_CMND_SUB "Sub"
|
|
|
|
#define D_CMND_MULT "Mult"
|
|
|
|
#define D_CMND_SCALE "Scale"
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
#define D_JSON_INITIATED "Initiated"
|
|
|
|
|
2018-06-10 06:09:11 +01:00
|
|
|
enum RulesCommands { CMND_RULE, CMND_RULETIMER, CMND_EVENT, CMND_VAR, CMND_MEM, CMND_ADD, CMND_SUB, CMND_MULT, CMND_SCALE };
|
|
|
|
const char kRulesCommands[] PROGMEM = D_CMND_RULE "|" D_CMND_RULETIMER "|" D_CMND_EVENT "|" D_CMND_VAR "|" D_CMND_MEM "|" D_CMND_ADD "|" D_CMND_SUB "|" D_CMND_MULT "|" D_CMND_SCALE ;
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
String rules_event_value;
|
|
|
|
unsigned long rules_timer[MAX_RULE_TIMERS] = { 0 };
|
|
|
|
uint8_t rules_quota = 0;
|
2018-05-06 15:07:42 +01:00
|
|
|
long rules_new_power = -1;
|
|
|
|
long rules_old_power = -1;
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
uint32_t rules_triggers[MAX_RULE_SETS] = { 0 };
|
2018-06-26 15:22:53 +01:00
|
|
|
uint16_t rules_last_minute = 60;
|
2018-05-24 13:25:52 +01:00
|
|
|
uint8_t rules_trigger_count[MAX_RULE_SETS] = { 0 };
|
2018-04-27 17:06:19 +01:00
|
|
|
uint8_t rules_teleperiod = 0;
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-29 16:24:42 +01:00
|
|
|
char event_data[100];
|
2018-05-19 07:00:48 +01:00
|
|
|
char vars[RULES_MAX_VARS][10] = { 0 };
|
|
|
|
|
2018-04-13 16:42:11 +01:00
|
|
|
/*******************************************************************************************/
|
|
|
|
|
|
|
|
long TimeDifference(unsigned long prev, unsigned long next)
|
|
|
|
{
|
|
|
|
// Return the time difference as a signed value, taking into account the timers may overflow.
|
|
|
|
// Returned timediff is between -24.9 days and +24.9 days.
|
|
|
|
// Returned value is positive when "next" is after "prev"
|
|
|
|
long signed_diff = 0;
|
|
|
|
// To cast a value to a signed long, the difference may not exceed half the ULONG_MAX
|
|
|
|
const unsigned long half_max_unsigned_long = 2147483647u; // = 2^31 -1
|
|
|
|
if (next >= prev) {
|
|
|
|
const unsigned long diff = next - prev;
|
|
|
|
if (diff <= half_max_unsigned_long) { // Normal situation, just return the difference.
|
|
|
|
signed_diff = static_cast<long>(diff); // Difference is a positive value.
|
|
|
|
} else {
|
|
|
|
// prev has overflow, return a negative difference value
|
|
|
|
signed_diff = static_cast<long>((ULONG_MAX - next) + prev + 1u);
|
|
|
|
signed_diff = -1 * signed_diff;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
// next < prev
|
|
|
|
const unsigned long diff = prev - next;
|
|
|
|
if (diff <= half_max_unsigned_long) { // Normal situation, return a negative difference value
|
|
|
|
signed_diff = static_cast<long>(diff);
|
|
|
|
signed_diff = -1 * signed_diff;
|
|
|
|
} else {
|
|
|
|
// next has overflow, return a positive difference value
|
|
|
|
signed_diff = static_cast<long>((ULONG_MAX - prev) + next + 1u);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return signed_diff;
|
|
|
|
}
|
|
|
|
|
|
|
|
long TimePassedSince(unsigned long timestamp)
|
|
|
|
{
|
|
|
|
// Compute the number of milliSeconds passed since timestamp given.
|
|
|
|
// Note: value can be negative if the timestamp has not yet been reached.
|
|
|
|
return TimeDifference(timestamp, millis());
|
|
|
|
}
|
|
|
|
|
|
|
|
bool TimeReached(unsigned long timer)
|
|
|
|
{
|
|
|
|
// Check if a certain timeout has been reached.
|
|
|
|
const long passed = TimePassedSince(timer);
|
|
|
|
return (passed >= 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*******************************************************************************************/
|
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
bool RulesRuleMatch(byte rule_set, String &event, String &rule)
|
2018-04-13 16:42:11 +01:00
|
|
|
{
|
|
|
|
// event = {"INA219":{"Voltage":4.494,"Current":0.020,"Power":0.089}}
|
|
|
|
// event = {"System":{"Boot":1}}
|
|
|
|
// rule = "INA219#CURRENT>0.100"
|
|
|
|
|
|
|
|
bool match = false;
|
2018-05-20 16:46:00 +01:00
|
|
|
char stemp[10];
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
// Step1: Analyse rule
|
|
|
|
int pos = rule.indexOf('#');
|
2018-04-17 14:34:18 +01:00
|
|
|
if (pos == -1) { return false; } // No # sign in rule
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
String rule_task = rule.substring(0, pos); // "INA219" or "SYSTEM"
|
2018-04-27 17:06:19 +01:00
|
|
|
if (rules_teleperiod) {
|
|
|
|
int ppos = rule_task.indexOf("TELE-"); // "TELE-INA219" or "INA219"
|
|
|
|
if (ppos == -1) { return false; } // No pre-amble in rule
|
|
|
|
rule_task = rule.substring(5, pos); // "INA219" or "SYSTEM"
|
|
|
|
}
|
|
|
|
|
2018-06-26 15:22:53 +01:00
|
|
|
String rule_name = rule.substring(pos +1); // "CURRENT>0.100" or "BOOT" or "%var1%"
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
char compare = ' ';
|
|
|
|
pos = rule_name.indexOf(">");
|
|
|
|
if (pos > 0) {
|
|
|
|
compare = '>';
|
|
|
|
} else {
|
|
|
|
pos = rule_name.indexOf("<");
|
|
|
|
if (pos > 0) {
|
|
|
|
compare = '<';
|
|
|
|
} else {
|
|
|
|
pos = rule_name.indexOf("=");
|
|
|
|
if (pos > 0) {
|
|
|
|
compare = '=';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-05-24 16:08:14 +01:00
|
|
|
char rule_svalue[CMDSZ] = { 0 };
|
2018-04-13 16:42:11 +01:00
|
|
|
double rule_value = 0;
|
|
|
|
if (pos > 0) {
|
2018-05-20 16:46:00 +01:00
|
|
|
String rule_param = rule_name.substring(pos + 1);
|
|
|
|
for (byte i = 0; i < RULES_MAX_VARS; i++) {
|
|
|
|
snprintf_P(stemp, sizeof(stemp), PSTR("%%VAR%d%%"), i +1);
|
|
|
|
if (rule_param.startsWith(stemp)) {
|
|
|
|
rule_param = vars[i];
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
for (byte i = 0; i < RULES_MAX_MEMS; i++) {
|
|
|
|
snprintf_P(stemp, sizeof(stemp), PSTR("%%MEM%d%%"), i +1);
|
|
|
|
if (rule_param.startsWith(stemp)) {
|
|
|
|
rule_param = Settings.mems[i];
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
rule_param.toUpperCase();
|
2018-05-24 16:08:14 +01:00
|
|
|
snprintf(rule_svalue, sizeof(rule_svalue), rule_param.c_str());
|
2018-05-20 16:46:00 +01:00
|
|
|
|
2018-05-24 16:08:14 +01:00
|
|
|
int temp_value = GetStateNumber(rule_svalue);
|
2018-05-06 15:07:42 +01:00
|
|
|
if (temp_value > -1) {
|
|
|
|
rule_value = temp_value;
|
|
|
|
} else {
|
2018-05-24 16:08:14 +01:00
|
|
|
rule_value = CharToDouble((char*)rule_svalue); // 0.1 - This saves 9k code over toFLoat()!
|
2018-05-06 15:07:42 +01:00
|
|
|
}
|
2018-04-13 16:42:11 +01:00
|
|
|
rule_name = rule_name.substring(0, pos); // "CURRENT"
|
|
|
|
}
|
|
|
|
|
|
|
|
// Step2: Search rule_task and rule_name
|
2018-05-01 10:28:36 +01:00
|
|
|
StaticJsonBuffer<1024> jsonBuf;
|
2018-04-13 16:42:11 +01:00
|
|
|
JsonObject &root = jsonBuf.parseObject(event);
|
2018-04-17 14:34:18 +01:00
|
|
|
if (!root.success()) { return false; } // No valid JSON data
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
double value = 0;
|
|
|
|
const char* str_value = root[rule_task][rule_name];
|
|
|
|
|
2018-05-06 15:07:42 +01:00
|
|
|
//snprintf_P(log_data, sizeof(log_data), PSTR("RUL: Task %s, Name %s, Value |%s|, TrigCnt %d, TrigSt %d, Source %s, Json %s"),
|
2018-05-24 16:08:14 +01:00
|
|
|
// rule_task.c_str(), rule_name.c_str(), rule_svalue, rules_trigger_count[rule_set], bitRead(rules_triggers[rule_set], rules_trigger_count[rule_set]), event.c_str(), (str_value) ? str_value : "none");
|
2018-05-06 15:07:42 +01:00
|
|
|
//AddLog(LOG_LEVEL_DEBUG);
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-04-17 14:34:18 +01:00
|
|
|
if (!root[rule_task][rule_name].success()) { return false; }
|
2018-04-13 16:42:11 +01:00
|
|
|
// No value but rule_name is ok
|
|
|
|
|
2018-04-14 13:39:16 +01:00
|
|
|
rules_event_value = str_value; // Prepare %value%
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
// Step 3: Compare rule (value)
|
|
|
|
if (str_value) {
|
|
|
|
value = CharToDouble((char*)str_value);
|
|
|
|
switch (compare) {
|
|
|
|
case '>':
|
2018-05-24 16:08:14 +01:00
|
|
|
if (value > rule_value) { match = true; }
|
2018-04-13 16:42:11 +01:00
|
|
|
break;
|
|
|
|
case '<':
|
2018-05-24 16:08:14 +01:00
|
|
|
if (value < rule_value) { match = true; }
|
2018-04-13 16:42:11 +01:00
|
|
|
break;
|
|
|
|
case '=':
|
2018-05-24 16:08:14 +01:00
|
|
|
// if (value == rule_value) { match = true; } // Compare values - only decimals or partly hexadecimals
|
|
|
|
if (!strcasecmp(str_value, rule_svalue)) { match = true; } // Compare strings - this also works for hexadecimals
|
2018-04-13 16:42:11 +01:00
|
|
|
break;
|
|
|
|
case ' ':
|
|
|
|
match = true; // Json value but not needed
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
} else match = true;
|
|
|
|
|
2018-07-16 10:34:44 +01:00
|
|
|
if (bitRead(Settings.rule_once, rule_set)) {
|
2018-04-13 16:42:11 +01:00
|
|
|
if (match) { // Only allow match state changes
|
2018-05-24 13:25:52 +01:00
|
|
|
if (!bitRead(rules_triggers[rule_set], rules_trigger_count[rule_set])) {
|
|
|
|
bitSet(rules_triggers[rule_set], rules_trigger_count[rule_set]);
|
2018-04-13 16:42:11 +01:00
|
|
|
} else {
|
|
|
|
match = false;
|
|
|
|
}
|
|
|
|
} else {
|
2018-05-24 13:25:52 +01:00
|
|
|
bitClear(rules_triggers[rule_set], rules_trigger_count[rule_set]);
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return match;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*******************************************************************************************/
|
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
bool RuleSetProcess(byte rule_set, String &event_saved)
|
2018-04-13 16:42:11 +01:00
|
|
|
{
|
|
|
|
bool serviced = false;
|
2018-04-27 17:06:19 +01:00
|
|
|
char stemp[10];
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-06 15:07:42 +01:00
|
|
|
delay(0); // Prohibit possible loop software watchdog
|
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
//snprintf_P(log_data, sizeof(log_data), PSTR("RUL: Event = %s, Rule = %s"), event_saved.c_str(), Settings.rules[rule_set]);
|
2018-05-13 16:38:44 +01:00
|
|
|
//AddLog(LOG_LEVEL_DEBUG);
|
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
String rules = Settings.rules[rule_set];
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
rules_trigger_count[rule_set] = 0;
|
2018-04-13 16:42:11 +01:00
|
|
|
int plen = 0;
|
|
|
|
while (true) {
|
2018-04-17 14:34:18 +01:00
|
|
|
rules = rules.substring(plen); // Select relative to last rule
|
2018-04-13 16:42:11 +01:00
|
|
|
rules.trim();
|
2018-04-17 14:34:18 +01:00
|
|
|
if (!rules.length()) { return serviced; } // No more rules
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
String rule = rules;
|
2018-04-17 14:34:18 +01:00
|
|
|
rule.toUpperCase(); // "ON INA219#CURRENT>0.100 DO BACKLOG DIMMER 10;COLOR 100000 ENDON"
|
|
|
|
if (!rule.startsWith("ON ")) { return serviced; } // Bad syntax - Nothing to start on
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
int pevt = rule.indexOf(" DO ");
|
2018-04-17 14:34:18 +01:00
|
|
|
if (pevt == -1) { return serviced; } // Bad syntax - Nothing to do
|
|
|
|
String event_trigger = rule.substring(3, pevt); // "INA219#CURRENT>0.100"
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
plen = rule.indexOf(" ENDON");
|
2018-04-17 14:34:18 +01:00
|
|
|
if (plen == -1) { return serviced; } // Bad syntax - No endon
|
|
|
|
String commands = rules.substring(pevt +4, plen); // "Backlog Dimmer 10;Color 100000"
|
2018-04-13 16:42:11 +01:00
|
|
|
plen += 6;
|
2018-05-13 16:38:44 +01:00
|
|
|
rules_event_value = "";
|
|
|
|
String event = event_saved;
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-13 16:38:44 +01:00
|
|
|
//snprintf_P(log_data, sizeof(log_data), PSTR("RUL: Event |%s|, Rule |%s|, Command(s) |%s|"), event.c_str(), event_trigger.c_str(), commands.c_str());
|
2018-05-06 15:07:42 +01:00
|
|
|
//AddLog(LOG_LEVEL_DEBUG);
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
if (RulesRuleMatch(rule_set, event, event_trigger)) {
|
2018-04-27 17:06:19 +01:00
|
|
|
commands.trim();
|
|
|
|
String ucommand = commands;
|
|
|
|
ucommand.toUpperCase();
|
2018-05-20 16:46:00 +01:00
|
|
|
// if (!ucommand.startsWith("BACKLOG")) { commands = "backlog " + commands; } // Always use Backlog to prevent power race exception
|
|
|
|
if (ucommand.indexOf("EVENT ") != -1) { commands = "backlog " + commands; } // Always use Backlog with event to prevent rule event loop exception
|
|
|
|
commands.replace(F("%value%"), rules_event_value);
|
|
|
|
for (byte i = 0; i < RULES_MAX_VARS; i++) {
|
|
|
|
snprintf_P(stemp, sizeof(stemp), PSTR("%%var%d%%"), i +1);
|
|
|
|
commands.replace(stemp, vars[i]);
|
|
|
|
}
|
|
|
|
for (byte i = 0; i < RULES_MAX_MEMS; i++) {
|
|
|
|
snprintf_P(stemp, sizeof(stemp), PSTR("%%mem%d%%"), i +1);
|
|
|
|
commands.replace(stemp, Settings.mems[i]);
|
|
|
|
}
|
2018-06-26 15:22:53 +01:00
|
|
|
commands.replace(F("%time%"), String(GetMinutesPastMidnight()));
|
|
|
|
commands.replace(F("%uptime%"), String(GetMinutesUptime()));
|
|
|
|
#if defined(USE_TIMERS) && defined(USE_SUNRISE)
|
|
|
|
commands.replace(F("%sunrise%"), String(GetSunMinutes(0)));
|
|
|
|
commands.replace(F("%sunset%"), String(GetSunMinutes(1)));
|
|
|
|
#endif // USE_TIMERS and USE_SUNRISE
|
|
|
|
|
2018-05-20 16:46:00 +01:00
|
|
|
char command[commands.length() +1];
|
|
|
|
snprintf(command, sizeof(command), commands.c_str());
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-20 16:46:00 +01:00
|
|
|
snprintf_P(log_data, sizeof(log_data), PSTR("RUL: %s performs \"%s\""), event_trigger.c_str(), command);
|
|
|
|
AddLog(LOG_LEVEL_INFO);
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-20 16:46:00 +01:00
|
|
|
// snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_SVALUE, D_CMND_RULE, D_JSON_INITIATED);
|
|
|
|
// MqttPublishPrefixTopic_P(RESULT_OR_STAT, PSTR(D_CMND_RULE));
|
2018-04-13 16:42:11 +01:00
|
|
|
|
2018-05-28 14:52:42 +01:00
|
|
|
ExecuteCommand(command, SRC_RULE);
|
2018-04-13 16:42:11 +01:00
|
|
|
serviced = true;
|
|
|
|
}
|
2018-05-24 13:25:52 +01:00
|
|
|
rules_trigger_count[rule_set]++;
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
return serviced;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*******************************************************************************************/
|
|
|
|
|
2018-06-25 17:00:20 +01:00
|
|
|
bool RulesProcessEvent(char *json_event)
|
2018-05-24 13:25:52 +01:00
|
|
|
{
|
|
|
|
bool serviced = false;
|
|
|
|
|
2018-06-26 10:48:09 +01:00
|
|
|
ShowFreeMem(PSTR("RulesProcessEvent"));
|
|
|
|
|
2018-06-25 17:00:20 +01:00
|
|
|
String event_saved = json_event;
|
2018-05-24 13:25:52 +01:00
|
|
|
event_saved.toUpperCase();
|
|
|
|
|
2018-06-28 11:25:50 +01:00
|
|
|
//snprintf_P(log_data, sizeof(log_data), PSTR("RUL: Event %s"), event_saved.c_str());
|
|
|
|
//AddLog(LOG_LEVEL_DEBUG);
|
|
|
|
|
2018-05-24 13:25:52 +01:00
|
|
|
for (byte i = 0; i < MAX_RULE_SETS; i++) {
|
|
|
|
if (strlen(Settings.rules[i]) && bitRead(Settings.rule_enabled, i)) {
|
|
|
|
if (RuleSetProcess(i, event_saved)) { serviced = true; }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return serviced;
|
|
|
|
}
|
|
|
|
|
2018-06-25 17:00:20 +01:00
|
|
|
bool RulesProcess()
|
|
|
|
{
|
|
|
|
return RulesProcessEvent(mqtt_data);
|
|
|
|
}
|
|
|
|
|
2018-04-13 16:42:11 +01:00
|
|
|
void RulesInit()
|
|
|
|
{
|
2018-06-25 17:00:20 +01:00
|
|
|
rules_flag.data = 0;
|
2018-05-24 13:25:52 +01:00
|
|
|
for (byte i = 0; i < MAX_RULE_SETS; i++) {
|
|
|
|
if (Settings.rules[i][0] == '\0') {
|
|
|
|
bitWrite(Settings.rule_enabled, i, 0);
|
|
|
|
bitWrite(Settings.rule_once, i, 0);
|
|
|
|
}
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
2018-04-27 17:06:19 +01:00
|
|
|
rules_teleperiod = 0;
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
void RulesEvery50ms()
|
|
|
|
{
|
2018-05-24 13:25:52 +01:00
|
|
|
if (Settings.rule_enabled) { // Any rule enabled
|
2018-06-25 17:00:20 +01:00
|
|
|
char json_event[120];
|
|
|
|
|
2018-05-06 15:07:42 +01:00
|
|
|
if (rules_new_power != rules_old_power) {
|
|
|
|
if (rules_old_power != -1) {
|
|
|
|
for (byte i = 0; i < devices_present; i++) {
|
|
|
|
uint8_t new_state = (rules_new_power >> i) &1;
|
|
|
|
if (new_state != ((rules_old_power >> i) &1)) {
|
2018-06-25 17:00:20 +01:00
|
|
|
snprintf_P(json_event, sizeof(json_event), PSTR("{\"Power%d\":{\"State\":%d}}"), i +1, new_state);
|
|
|
|
RulesProcessEvent(json_event);
|
2018-05-06 15:07:42 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
rules_old_power = rules_new_power;
|
2018-05-29 16:24:42 +01:00
|
|
|
}
|
2018-06-25 17:00:20 +01:00
|
|
|
else if (event_data[0]) {
|
2018-05-29 16:24:42 +01:00
|
|
|
char *event;
|
|
|
|
char *parameter;
|
|
|
|
event = strtok_r(event_data, "=", ¶meter); // event_data = fanspeed=10
|
|
|
|
if (event) {
|
|
|
|
event = Trim(event);
|
|
|
|
if (parameter) {
|
|
|
|
parameter = Trim(parameter);
|
|
|
|
} else {
|
|
|
|
parameter = event + strlen(event); // '\0'
|
|
|
|
}
|
2018-06-25 17:00:20 +01:00
|
|
|
snprintf_P(json_event, sizeof(json_event), PSTR("{\"Event\":{\"%s\":\"%s\"}}"), event, parameter);
|
2018-05-29 16:24:42 +01:00
|
|
|
event_data[0] ='\0';
|
2018-06-25 17:00:20 +01:00
|
|
|
RulesProcessEvent(json_event);
|
2018-05-29 16:24:42 +01:00
|
|
|
} else {
|
|
|
|
event_data[0] ='\0';
|
|
|
|
}
|
|
|
|
}
|
2018-06-25 17:00:20 +01:00
|
|
|
else if (rules_flag.data) {
|
|
|
|
uint16_t mask = 1;
|
|
|
|
for (byte i = 0; i < MAX_RULES_FLAG; i++) {
|
|
|
|
if (rules_flag.data & mask) {
|
|
|
|
rules_flag.data ^= mask;
|
|
|
|
json_event[0] = '\0';
|
|
|
|
switch (i) {
|
|
|
|
case 0: strncpy_P(json_event, PSTR("{\"System\":{\"Boot\":1}}"), sizeof(json_event)); break;
|
2018-06-26 15:22:53 +01:00
|
|
|
case 1: snprintf_P(json_event, sizeof(json_event), PSTR("{\"Time\":{\"Initialized\":%d}}"), GetMinutesPastMidnight()); break;
|
|
|
|
case 2: snprintf_P(json_event, sizeof(json_event), PSTR("{\"Time\":{\"Set\":%d}}"), GetMinutesPastMidnight()); break;
|
2018-06-25 17:00:20 +01:00
|
|
|
case 3: strncpy_P(json_event, PSTR("{\"MQTT\":{\"Connected\":1}}"), sizeof(json_event)); break;
|
|
|
|
case 4: strncpy_P(json_event, PSTR("{\"MQTT\":{\"Disconnected\":1}}"), sizeof(json_event)); break;
|
2018-07-28 14:06:31 +01:00
|
|
|
case 5: strncpy_P(json_event, PSTR("{\"WIFI\":{\"Connected\":1}}"), sizeof(json_event)); break;
|
|
|
|
case 6: strncpy_P(json_event, PSTR("{\"WIFI\":{\"Disconnected\":1}}"), sizeof(json_event)); break;
|
2018-06-25 17:00:20 +01:00
|
|
|
}
|
|
|
|
if (json_event[0]) {
|
|
|
|
RulesProcessEvent(json_event);
|
|
|
|
break; // Only service one event within 50mS
|
|
|
|
}
|
|
|
|
}
|
|
|
|
mask <<= 1;
|
|
|
|
}
|
|
|
|
}
|
2018-05-29 16:24:42 +01:00
|
|
|
else {
|
2018-05-06 15:07:42 +01:00
|
|
|
rules_quota++;
|
|
|
|
if (rules_quota &1) { // Every 100 ms
|
|
|
|
mqtt_data[0] = '\0';
|
|
|
|
uint16_t tele_period_save = tele_period;
|
|
|
|
tele_period = 2; // Do not allow HA updates during next function call
|
|
|
|
XsnsNextCall(FUNC_JSON_APPEND); // ,"INA219":{"Voltage":4.494,"Current":0.020,"Power":0.089}
|
|
|
|
tele_period = tele_period_save;
|
|
|
|
if (strlen(mqtt_data)) {
|
|
|
|
mqtt_data[0] = '{'; // {"INA219":{"Voltage":4.494,"Current":0.020,"Power":0.089}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s}"), mqtt_data);
|
|
|
|
RulesProcess();
|
|
|
|
}
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void RulesEverySecond()
|
|
|
|
{
|
2018-05-24 13:25:52 +01:00
|
|
|
if (Settings.rule_enabled) { // Any rule enabled
|
2018-06-25 17:00:20 +01:00
|
|
|
char json_event[120];
|
|
|
|
|
2018-06-26 15:22:53 +01:00
|
|
|
if (RtcTime.valid) {
|
|
|
|
if ((uptime > 60) && (RtcTime.minute != rules_last_minute)) { // Execute from one minute after restart every minute only once
|
|
|
|
rules_last_minute = RtcTime.minute;
|
|
|
|
snprintf_P(json_event, sizeof(json_event), PSTR("{\"Time\":{\"Minute\":%d}}"), GetMinutesPastMidnight());
|
|
|
|
RulesProcessEvent(json_event);
|
|
|
|
}
|
|
|
|
}
|
2018-04-13 16:42:11 +01:00
|
|
|
for (byte i = 0; i < MAX_RULE_TIMERS; i++) {
|
|
|
|
if (rules_timer[i] != 0L) { // Timer active?
|
|
|
|
if (TimeReached(rules_timer[i])) { // Timer finished?
|
|
|
|
rules_timer[i] = 0L; // Turn off this timer
|
2018-06-25 17:00:20 +01:00
|
|
|
snprintf_P(json_event, sizeof(json_event), PSTR("{\"Rules\":{\"Timer\":%d}}"), i +1);
|
|
|
|
RulesProcessEvent(json_event);
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-05-06 15:07:42 +01:00
|
|
|
void RulesSetPower()
|
|
|
|
{
|
|
|
|
rules_new_power = XdrvMailbox.index;
|
|
|
|
}
|
|
|
|
|
2018-04-27 17:06:19 +01:00
|
|
|
void RulesTeleperiod()
|
|
|
|
{
|
|
|
|
rules_teleperiod = 1;
|
|
|
|
RulesProcess();
|
|
|
|
rules_teleperiod = 0;
|
|
|
|
}
|
|
|
|
|
2018-04-13 16:42:11 +01:00
|
|
|
boolean RulesCommand()
|
|
|
|
{
|
|
|
|
char command[CMDSZ];
|
|
|
|
boolean serviced = true;
|
|
|
|
uint8_t index = XdrvMailbox.index;
|
|
|
|
|
|
|
|
int command_code = GetCommandCode(command, sizeof(command), XdrvMailbox.topic, kRulesCommands);
|
2018-05-09 09:49:43 +01:00
|
|
|
if (-1 == command_code) {
|
|
|
|
serviced = false; // Unknown command
|
|
|
|
}
|
2018-05-24 13:25:52 +01:00
|
|
|
else if ((CMND_RULE == command_code) && (index > 0) && (index <= MAX_RULE_SETS)) {
|
|
|
|
if ((XdrvMailbox.data_len > 0) && (XdrvMailbox.data_len < sizeof(Settings.rules[index -1]))) {
|
2018-04-13 16:42:11 +01:00
|
|
|
if ((XdrvMailbox.payload >= 0) && (XdrvMailbox.payload <= 6)) {
|
|
|
|
switch (XdrvMailbox.payload) {
|
|
|
|
case 0: // Off
|
|
|
|
case 1: // On
|
2018-05-24 13:25:52 +01:00
|
|
|
bitWrite(Settings.rule_enabled, index -1, XdrvMailbox.payload);
|
2018-04-13 16:42:11 +01:00
|
|
|
break;
|
|
|
|
case 2: // Toggle
|
2018-05-24 13:25:52 +01:00
|
|
|
bitWrite(Settings.rule_enabled, index -1, bitRead(Settings.rule_enabled, index -1) ^1);
|
2018-04-13 16:42:11 +01:00
|
|
|
break;
|
|
|
|
case 4: // Off
|
|
|
|
case 5: // On
|
2018-05-24 13:25:52 +01:00
|
|
|
bitWrite(Settings.rule_once, index -1, XdrvMailbox.payload &1);
|
2018-04-13 16:42:11 +01:00
|
|
|
break;
|
|
|
|
case 6: // Toggle
|
2018-05-24 13:25:52 +01:00
|
|
|
bitWrite(Settings.rule_once, index -1, bitRead(Settings.rule_once, index -1) ^1);
|
2018-04-13 16:42:11 +01:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
} else {
|
2018-07-29 13:45:42 +01:00
|
|
|
int offset = 0;
|
|
|
|
if ('+' == XdrvMailbox.data[0]) {
|
|
|
|
offset = strlen(Settings.rules[index -1]);
|
|
|
|
if (XdrvMailbox.data_len < (sizeof(Settings.rules[index -1]) - offset -1)) { // Check free space
|
|
|
|
XdrvMailbox.data[0] = ' '; // Remove + and make sure at least one space is inserted
|
|
|
|
} else {
|
|
|
|
offset = -1; // Not enough space so skip it
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (offset != -1) {
|
|
|
|
strlcpy(Settings.rules[index -1] + offset, ('"' == XdrvMailbox.data[0]) ? "" : XdrvMailbox.data, sizeof(Settings.rules[index -1]));
|
|
|
|
}
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
2018-05-24 13:25:52 +01:00
|
|
|
rules_triggers[index -1] = 0; // Reset once flag
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
2018-05-24 13:25:52 +01:00
|
|
|
snprintf_P (mqtt_data, sizeof(mqtt_data), PSTR("{\"%s%d\":\"%s\",\"Once\":\"%s\",\"Free\":%d,\"Rules\":\"%s\"}"),
|
|
|
|
command, index, GetStateText(bitRead(Settings.rule_enabled, index -1)), GetStateText(bitRead(Settings.rule_once, index -1)), sizeof(Settings.rules[index -1]) - strlen(Settings.rules[index -1]) -1, Settings.rules[index -1]);
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
else if ((CMND_RULETIMER == command_code) && (index > 0) && (index <= MAX_RULE_TIMERS)) {
|
|
|
|
if (XdrvMailbox.data_len > 0) {
|
|
|
|
rules_timer[index -1] = (XdrvMailbox.payload > 0) ? millis() + (1000 * XdrvMailbox.payload) : 0;
|
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_INDEX_LVALUE, command, index, (rules_timer[index -1]) ? (rules_timer[index -1] - millis()) / 1000 : 0);
|
|
|
|
}
|
|
|
|
else if (CMND_EVENT == command_code) {
|
|
|
|
if (XdrvMailbox.data_len > 0) {
|
2018-05-29 16:24:42 +01:00
|
|
|
strlcpy(event_data, XdrvMailbox.data, sizeof(event_data));
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_SVALUE, command, D_JSON_DONE);
|
|
|
|
}
|
2018-05-20 16:46:00 +01:00
|
|
|
else if ((CMND_VAR == command_code) && (index > 0) && (index <= RULES_MAX_VARS)) {
|
|
|
|
if (XdrvMailbox.data_len > 0) {
|
|
|
|
strlcpy(vars[index -1], ('"' == XdrvMailbox.data[0]) ? "" : XdrvMailbox.data, sizeof(vars[index -1]));
|
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_INDEX_SVALUE, command, index, vars[index -1]);
|
|
|
|
}
|
|
|
|
else if ((CMND_MEM == command_code) && (index > 0) && (index <= RULES_MAX_MEMS)) {
|
|
|
|
if (XdrvMailbox.data_len > 0) {
|
|
|
|
strlcpy(Settings.mems[index -1], ('"' == XdrvMailbox.data[0]) ? "" : XdrvMailbox.data, sizeof(Settings.mems[index -1]));
|
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_INDEX_SVALUE, command, index, Settings.mems[index -1]);
|
|
|
|
}
|
2018-06-10 06:09:11 +01:00
|
|
|
else if ((CMND_ADD == command_code) && (index > 0) && (index <= RULES_MAX_VARS)) {
|
2018-07-16 11:37:49 +01:00
|
|
|
if (XdrvMailbox.data_len > 0) {
|
2018-06-28 17:06:21 +01:00
|
|
|
double tempvar = CharToDouble(vars[index -1]) + CharToDouble(XdrvMailbox.data);
|
2018-07-16 11:37:49 +01:00
|
|
|
dtostrfd(tempvar, 2, vars[index -1]);
|
2018-06-10 06:09:11 +01:00
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_INDEX_SVALUE, command, index, vars[index -1]);
|
|
|
|
}
|
|
|
|
else if ((CMND_SUB == command_code) && (index > 0) && (index <= RULES_MAX_VARS)) {
|
2018-07-16 11:37:49 +01:00
|
|
|
if (XdrvMailbox.data_len > 0) {
|
2018-06-28 17:06:21 +01:00
|
|
|
double tempvar = CharToDouble(vars[index -1]) - CharToDouble(XdrvMailbox.data);
|
2018-07-16 11:37:49 +01:00
|
|
|
dtostrfd(tempvar, 2, vars[index -1]);
|
2018-06-10 06:09:11 +01:00
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_INDEX_SVALUE, command, index, vars[index -1]);
|
|
|
|
}
|
|
|
|
else if ((CMND_MULT == command_code) && (index > 0) && (index <= RULES_MAX_VARS)) {
|
2018-07-16 11:37:49 +01:00
|
|
|
if (XdrvMailbox.data_len > 0) {
|
2018-06-28 17:06:21 +01:00
|
|
|
double tempvar = CharToDouble(vars[index -1]) * CharToDouble(XdrvMailbox.data);
|
2018-07-16 11:37:49 +01:00
|
|
|
dtostrfd(tempvar, 2, vars[index -1]);
|
2018-06-10 06:09:11 +01:00
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_INDEX_SVALUE, command, index, vars[index -1]);
|
|
|
|
}
|
|
|
|
else if ((CMND_SCALE == command_code) && (index > 0) && (index <= RULES_MAX_VARS)) {
|
2018-07-16 11:37:49 +01:00
|
|
|
if (XdrvMailbox.data_len > 0) {
|
2018-06-10 06:09:11 +01:00
|
|
|
if (strstr(XdrvMailbox.data, ",")) { // Process parameter entry
|
2018-07-16 11:37:49 +01:00
|
|
|
char sub_string[XdrvMailbox.data_len +1];
|
|
|
|
|
|
|
|
double valueIN = CharToDouble(subStr(sub_string, XdrvMailbox.data, ",", 1));
|
|
|
|
double fromLow = CharToDouble(subStr(sub_string, XdrvMailbox.data, ",", 2));
|
|
|
|
double fromHigh = CharToDouble(subStr(sub_string, XdrvMailbox.data, ",", 3));
|
|
|
|
double toLow = CharToDouble(subStr(sub_string, XdrvMailbox.data, ",", 4));
|
|
|
|
double toHigh = CharToDouble(subStr(sub_string, XdrvMailbox.data, ",", 5));
|
|
|
|
double value = map_double(valueIN, fromLow, fromHigh, toLow, toHigh);
|
|
|
|
dtostrfd(value, 2, vars[index -1]);
|
2018-06-10 06:09:11 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
snprintf_P(mqtt_data, sizeof(mqtt_data), S_JSON_COMMAND_INDEX_SVALUE, command, index, vars[index -1]);
|
|
|
|
}
|
2018-05-09 09:49:43 +01:00
|
|
|
else serviced = false; // Unknown command
|
2018-04-13 16:42:11 +01:00
|
|
|
|
|
|
|
return serviced;
|
|
|
|
}
|
|
|
|
|
2018-06-28 17:06:21 +01:00
|
|
|
double map_double(double x, double in_min, double in_max, double out_min, double out_max)
|
|
|
|
{
|
|
|
|
return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
|
|
|
|
}
|
|
|
|
|
2018-04-13 16:42:11 +01:00
|
|
|
/*********************************************************************************************\
|
|
|
|
* Interface
|
|
|
|
\*********************************************************************************************/
|
|
|
|
|
|
|
|
#define XDRV_10
|
|
|
|
|
|
|
|
boolean Xdrv10(byte function)
|
|
|
|
{
|
|
|
|
boolean result = false;
|
|
|
|
|
|
|
|
switch (function) {
|
2018-06-04 17:10:38 +01:00
|
|
|
case FUNC_PRE_INIT:
|
2018-04-13 16:42:11 +01:00
|
|
|
RulesInit();
|
|
|
|
break;
|
|
|
|
case FUNC_EVERY_50_MSECOND:
|
|
|
|
RulesEvery50ms();
|
|
|
|
break;
|
|
|
|
case FUNC_EVERY_SECOND:
|
|
|
|
RulesEverySecond();
|
|
|
|
break;
|
2018-05-06 15:07:42 +01:00
|
|
|
case FUNC_SET_POWER:
|
|
|
|
RulesSetPower();
|
|
|
|
break;
|
2018-04-13 16:42:11 +01:00
|
|
|
case FUNC_COMMAND:
|
|
|
|
result = RulesCommand();
|
|
|
|
break;
|
2018-05-24 15:23:20 +01:00
|
|
|
case FUNC_RULES_PROCESS:
|
|
|
|
result = RulesProcess();
|
|
|
|
break;
|
2018-04-13 16:42:11 +01:00
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
2018-05-19 07:00:48 +01:00
|
|
|
#endif // USE_RULES
|