#pragma once #include "wled.h" #ifndef MULTI_RELAY_MAX_RELAYS #define MULTI_RELAY_MAX_RELAYS 4 #endif #define WLED_DEBOUNCE_THRESHOLD 50 //only consider button input of at least 50ms as valid (debouncing) #define ON true #define OFF false /* * This usermod handles multiple relay outputs. * These outputs complement built-in relay output in a way that the activation can be delayed. * They can also activate/deactivate in reverse logic independently. */ typedef struct relay_t { int8_t pin; bool active; bool mode; bool state; bool external; uint16_t delay; int8_t button; } Relay; class MultiRelay : public Usermod { private: // array of relays Relay _relay[MULTI_RELAY_MAX_RELAYS]; // switch timer start time uint32_t _switchTimerStart = 0; // old brightness bool _oldMode; // usermod enabled bool enabled = false; // needs to be configured (no default config) // status of initialisation bool initDone = false; uint16_t periodicBroadcastSec = 60; unsigned long lastBroadcast = 0; // strings to reduce flash memory usage (used more than twice) static const char _name[]; static const char _enabled[]; static const char _relay_str[]; static const char _delay_str[]; static const char _activeHigh[]; static const char _external[]; static const char _button[]; static const char _broadcast[]; void publishMqtt(int relay) { //Check if MQTT Connected, otherwise it will crash the 8266 if (WLED_MQTT_CONNECTED){ char subuf[64]; sprintf_P(subuf, PSTR("%s/relay/%d"), mqttDeviceTopic, relay); mqtt->publish(subuf, 0, false, _relay[relay].state ? "on" : "off"); } } /** * switch off the strip if the delay has elapsed */ void handleOffTimer() { unsigned long now = millis(); bool activeRelays = false; for (uint8_t i=0; i 0 && now - _switchTimerStart > (_relay[i].delay*1000)) { if (!_relay[i].external) toggleRelay(i); _relay[i].active = false; } else if (periodicBroadcastSec && now - lastBroadcast > (periodicBroadcastSec*1000)) { if (_relay[i].pin>=0) publishMqtt(i); } activeRelays = activeRelays || _relay[i].active; } if (!activeRelays) _switchTimerStart = 0; if (periodicBroadcastSec && now - lastBroadcast > (periodicBroadcastSec*1000)) lastBroadcast = now; } /** * HTTP API handler * borrowed from: * https://github.com/gsieben/WLED/blob/master/usermods/GeoGab-Relays/usermod_GeoGab.h */ #define GEOGABVERSION "0.1.3" void InitHtmlAPIHandle() { // https://github.com/me-no-dev/ESPAsyncWebServer DEBUG_PRINTLN(F("Relays: Initialize HTML API")); server.on("/relays", HTTP_GET, [this](AsyncWebServerRequest *request) { DEBUG_PRINTLN("Relays: HTML API"); String janswer; String error = ""; //int params = request->params(); janswer = F("{\"NoOfRelays\":"); janswer += String(MULTI_RELAY_MAX_RELAYS) + ","; if (getActiveRelayCount()) { // Commands if(request->hasParam("switch")) { /**** Switch ****/ AsyncWebParameter* p = request->getParam("switch"); // Get Values for (int i=0; ivalue(), ',', i); if (value==-1) { error = F("There must be as many arguments as relays"); } else { // Switch if (_relay[i].external) switchRelay(i, (bool)value); } } } else if(request->hasParam("toggle")) { /**** Toggle ****/ AsyncWebParameter* p = request->getParam("toggle"); // Get Values for (int i=0;ivalue(), ',', i); if (value==-1) { error = F("There must be as many arguments as relays"); } else { // Toggle if (value && _relay[i].external) toggleRelay(i); } } } else { error = F("No valid command found"); } } else { error = F("No active relays"); } // Status response char sbuf[16]; for (int i=0; isend(200, "application/json", janswer); }); } int getValue(String data, char separator, int index) { int found = 0; int strIndex[] = {0, -1}; int maxIndex = data.length()-1; for(int i=0; i<=maxIndex && found<=index; i++){ if(data.charAt(i)==separator || i==maxIndex){ found++; strIndex[0] = strIndex[1]+1; strIndex[1] = (i == maxIndex) ? i+1 : i; } } return found>index ? data.substring(strIndex[0], strIndex[1]).toInt() : -1; } public: /** * constructor */ MultiRelay() { for (uint8_t i=0; i=MULTI_RELAY_MAX_RELAYS || _relay[relay].pin<0) return; _relay[relay].state = mode; pinMode(_relay[relay].pin, OUTPUT); digitalWrite(_relay[relay].pin, mode ? !_relay[relay].mode : _relay[relay].mode); publishMqtt(relay); } /** * toggle relay */ inline void toggleRelay(uint8_t relay) { switchRelay(relay, !_relay[relay].state); } uint8_t getActiveRelayCount() { uint8_t count = 0; for (uint8_t i=0; i=0) count++; return count; } //Functions called by WLED /** * handling of MQTT message * topic only contains stripped topic (part after /wled/MAC) * topic should look like: /relay/X/command; where X is relay number, 0 based */ bool onMqttMessage(char* topic, char* payload) { if (strlen(topic) > 8 && strncmp_P(topic, PSTR("/relay/"), 7) == 0 && strncmp_P(topic+8, PSTR("/command"), 8) == 0) { uint8_t relay = strtoul(topic+7, NULL, 10); if (relaysubscribe(subuf, 0); publishHomeAssistantAutodiscovery(); for (uint8_t i=0; i= 0 && _relay[i].external) { StaticJsonDocument<1024> json; sprintf_P(buf, PSTR("%s Switch %d"), serverDescription, i); //max length: 33 + 8 + 3 = 44 json[F("name")] = buf; sprintf_P(buf, PSTR("%s/relay/%d"), mqttDeviceTopic, i); //max length: 33 + 7 + 3 = 43 json["~"] = buf; strcat_P(buf, PSTR("/command")); mqtt->subscribe(buf, 0); json[F("stat_t")] = "~"; json[F("cmd_t")] = F("~/command"); json[F("pl_off")] = F("off"); json[F("pl_on")] = F("on"); json[F("uniq_id")] = uid; strcpy(buf, mqttDeviceTopic); //max length: 33 + 7 = 40 strcat_P(buf, PSTR("/status")); json[F("avty_t")] = buf; json[F("pl_avail")] = F("online"); json[F("pl_not_avail")] = F("offline"); //TODO: dev payload_size = serializeJson(json, json_str); } else { //Unpublish disabled or internal relays json_str[0] = 0; payload_size = 0; } sprintf_P(buf, PSTR("homeassistant/switch/%s/config"), uid); mqtt->publish(buf, 0, true, json_str, payload_size); } } /** * setup() is called once at boot. WiFi is not yet connected at this point. * You can use it to initialize variables, sensors or similar. */ void setup() { // pins retrieved from cfg.json (readFromConfig()) prior to running setup() for (uint8_t i=0; i=0 && !_relay[i].external) _relay[i].active = true; } } handleOffTimer(); } /** * handleButton() can be used to override default button behaviour. Returning true * will prevent button working in a default way. * Replicating button.cpp */ bool handleButton(uint8_t b) { yield(); if (!enabled || buttonType[b] == BTN_TYPE_NONE || buttonType[b] == BTN_TYPE_RESERVED || buttonType[b] == BTN_TYPE_PIR_SENSOR || buttonType[b] == BTN_TYPE_ANALOG || buttonType[b] == BTN_TYPE_ANALOG_INVERTED) { return false; } bool handled = false; for (uint8_t i=0; i WLED_DEBOUNCE_THRESHOLD) { //fire edge event only after 50ms without change (debounce) for (uint8_t i=0; i=0 && _relay[i].button == b) { switchRelay(i, buttonPressedBefore[b]); buttonLongPressed[b] = buttonPressedBefore[b]; //save the last "long term" switch state } } } return handled; } //momentary button logic if (isButtonPressed(b)) { //pressed if (!buttonPressedBefore[b]) buttonPressedTime[b] = now; buttonPressedBefore[b] = true; if (now - buttonPressedTime[b] > 600) { //long press //longPressAction(b); //not exposed //handled = false; //use if you want to pass to default behaviour buttonLongPressed[b] = true; } } else if (!isButtonPressed(b) && buttonPressedBefore[b]) { //released long dur = now - buttonPressedTime[b]; if (dur < WLED_DEBOUNCE_THRESHOLD) { buttonPressedBefore[b] = false; return handled; } //too short "press", debounce bool doublePress = buttonWaitTime[b]; //did we have short press before? buttonWaitTime[b] = 0; if (!buttonLongPressed[b]) { //short press // if this is second release within 350ms it is a double press (buttonWaitTime!=0) if (doublePress) { //doublePressAction(b); //not exposed //handled = false; //use if you want to pass to default behaviour } else { buttonWaitTime[b] = now; } } buttonPressedBefore[b] = false; buttonLongPressed[b] = false; } // if 350ms elapsed since last press/release it is a short press if (buttonWaitTime[b] && now - buttonWaitTime[b] > 350 && !buttonPressedBefore[b]) { buttonWaitTime[b] = 0; //shortPressAction(b); //not exposed for (uint8_t i=0; i=0 && _relay[i].button == b) { toggleRelay(i); } } } return handled; } /** * addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API. */ void addToJsonInfo(JsonObject &root) { if (enabled) { JsonObject user = root["u"]; if (user.isNull()) user = root.createNestedObject("u"); JsonArray infoArr = user.createNestedArray(F("Number of relays")); //name infoArr.add(String(getActiveRelayCount())); String uiDomString; for (uint8_t i=0; i"); uiDomString += F("Relay "); uiDomString += i; uiDomString += F(" "); JsonArray infoArr = user.createNestedArray(uiDomString); // timer value infoArr.add(_relay[i].state ? "on" : "off"); } } } /** * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object). * Values in the state object may be modified by connected clients */ void addToJsonState(JsonObject &root) { if (!initDone || !enabled) return; // prevent crash on boot applyPreset() JsonObject multiRelay = root[FPSTR(_name)]; if (multiRelay.isNull()) { multiRelay = root.createNestedObject(FPSTR(_name)); } #if MULTI_RELAY_MAX_RELAYS > 1 JsonArray rel_arr = multiRelay.createNestedArray(F("relays")); for (uint8_t i=0; i() && usermod[FPSTR(_relay_str)].is() && usermod[FPSTR(_relay_str)].as()>=0) { switchRelay(usermod[FPSTR(_relay_str)].as(), usermod["on"].as()); } } else if (root[FPSTR(_name)].is()) { JsonArray relays = root[FPSTR(_name)].as(); for (JsonVariant r : relays) { if (r["on"].is() && r[FPSTR(_relay_str)].is() && r[FPSTR(_relay_str)].as()>=0) { switchRelay(r[FPSTR(_relay_str)].as(), r["on"].as()); } } } } /** * provide the changeable values */ void addToConfig(JsonObject &root) { JsonObject top = root.createNestedObject(FPSTR(_name)); top[FPSTR(_enabled)] = enabled; top[FPSTR(_broadcast)] = periodicBroadcastSec; for (uint8_t i=0; i=0) { pinManager.deallocatePin(oldPin[i], PinOwner::UM_MultiRelay); } // allocate new pins for (uint8_t i=0; i=0 && pinManager.allocatePin(_relay[i].pin, true, PinOwner::UM_MultiRelay)) { if (!_relay[i].external) { _relay[i].state = !offMode; switchRelay(i, _relay[i].state); _oldMode = offMode; } } else { _relay[i].pin = -1; } _relay[i].active = false; } DEBUG_PRINTLN(F(" config (re)loaded.")); } // use "return !top["newestParameter"].isNull();" when updating Usermod with new features return !top[FPSTR(_broadcast)].isNull(); } /** * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!). * This could be used in the future for the system to determine whether your usermod is installed. */ uint16_t getId() { return USERMOD_ID_MULTI_RELAY; } }; // strings to reduce flash memory usage (used more than twice) const char MultiRelay::_name[] PROGMEM = "MultiRelay"; const char MultiRelay::_enabled[] PROGMEM = "enabled"; const char MultiRelay::_relay_str[] PROGMEM = "relay"; const char MultiRelay::_delay_str[] PROGMEM = "delay-s"; const char MultiRelay::_activeHigh[] PROGMEM = "active-high"; const char MultiRelay::_external[] PROGMEM = "external"; const char MultiRelay::_button[] PROGMEM = "button"; const char MultiRelay::_broadcast[] PROGMEM = "broadcast-sec";