/* THINGSPEAK MODULE Copyright (C) 2019 by Xose PĂ©rez */ #if THINGSPEAK_SUPPORT #include #include "broker.h" #include "thingspeak.h" #include "libs/URL.h" #include "libs/SecureClientHelpers.h" #include "libs/AsyncClientHelpers.h" #if SECURE_CLIENT != SECURE_CLIENT_NONE #if THINGSPEAK_SECURE_CLIENT_INCLUDE_CA #include "static/thingspeak_client_trusted_root_ca.h" #else #include "static/digicert_high_assurance_pem.h" #define _tspk_client_trusted_root_ca _ssl_digicert_high_assurance_ev_root_ca #endif #endif // SECURE_CLIENT != SECURE_CLIENT_NONE const char THINGSPEAK_REQUEST_TEMPLATE[] PROGMEM = "POST %s HTTP/1.1\r\n" "Host: %s\r\n" "User-Agent: ESPurna\r\n" "Connection: close\r\n" "Content-Type: application/x-www-form-urlencoded\r\n" "Content-Length: %d\r\n\r\n"; bool _tspk_enabled = false; bool _tspk_clear = false; char * _tspk_queue[THINGSPEAK_FIELDS] = {NULL}; String _tspk_data; bool _tspk_flush = false; unsigned long _tspk_last_flush = 0; unsigned char _tspk_tries = THINGSPEAK_TRIES; #if THINGSPEAK_USE_ASYNC class AsyncThingspeak : public AsyncClient { public: URL address; AsyncThingspeak(const String& _url) : address(_url) { }; bool connect() { #if ASYNC_TCP_SSL_ENABLED && THINGSPEAK_USE_SSL return AsyncClient::connect(address.host.c_str(), address.port, true); #else return AsyncClient::connect(address.host.c_str(), address.port); #endif } bool connect(const String& url) { address = url; return connect(); } }; AsyncThingspeak* _tspk_client = nullptr; AsyncClientState _tspk_state = AsyncClientState::Disconnected; #endif // THINGSPEAK_USE_ASYNC == 1 // ----------------------------------------------------------------------------- #if BROKER_SUPPORT void _tspkBrokerCallback(const String& topic, unsigned char id, unsigned int value) { // Only process status messages for switches if (!topic.equals(MQTT_TOPIC_RELAY)) { return; } tspkEnqueueRelay(id, value > 0); tspkFlush(); } #endif // BROKER_SUPPORT #if WEB_SUPPORT bool _tspkWebSocketOnKeyCheck(const char * key, JsonVariant& value) { return (strncmp(key, "tspk", 4) == 0); } void _tspkWebSocketOnVisible(JsonObject& root) { root["tspkVisible"] = static_cast(haveRelaysOrSensors()); } void _tspkWebSocketOnConnected(JsonObject& root) { root["tspkEnabled"] = getSetting("tspkEnabled", 1 == THINGSPEAK_ENABLED); root["tspkKey"] = getSetting("tspkKey", THINGSPEAK_APIKEY); root["tspkClear"] = getSetting("tspkClear", 1 == THINGSPEAK_CLEAR_CACHE); root["tspkAddress"] = getSetting("tspkAddress", THINGSPEAK_ADDRESS); JsonArray& relays = root.createNestedArray("tspkRelays"); for (byte i=0; ionDisconnect([](void * s, AsyncClient * client) { DEBUG_MSG_P(PSTR("[THINGSPEAK] Disconnected\n")); _tspk_data = ""; _tspk_client_ts = 0; _tspk_last_flush = millis(); _tspk_state = AsyncClientState::Disconnected; _tspk_client_state = tspk_state_t::NONE; }, nullptr); _tspk_client->onTimeout([](void * s, AsyncClient * client, uint32_t time) { DEBUG_MSG_P(PSTR("[THINGSPEAK] Network timeout after %ums\n"), time); client->close(true); }, nullptr); _tspk_client->onPoll([](void * s, AsyncClient * client) { uint32_t ts = millis() - _tspk_client_ts; if (ts > THINGSPEAK_CLIENT_TIMEOUT) { DEBUG_MSG_P(PSTR("[THINGSPEAK] No response after %ums\n"), ts); client->close(true); } }, nullptr); _tspk_client->onData([](void * arg, AsyncClient * client, void * response, size_t len) { char * p = nullptr; do { p = nullptr; switch (_tspk_client_state) { case tspk_state_t::NONE: { p = strnstr(reinterpret_cast(response), "HTTP/1.1 200 OK", len); if (!p) { client->close(true); return; } _tspk_client_state = tspk_state_t::HEADERS; continue; } case tspk_state_t::HEADERS: { p = strnstr(reinterpret_cast(response), "\r\n\r\n", len); if (!p) return; _tspk_client_state = tspk_state_t::BODY; } case tspk_state_t::BODY: { if (!p) { p = strnstr(reinterpret_cast(response), "\r\n\r\n", len); if (!p) return; } unsigned int code = (p) ? atoi(&p[4]) : 0; DEBUG_MSG_P(PSTR("[THINGSPEAK] Response value: %u\n"), code); if ((0 == code) && _tspk_tries) { _tspk_flush = true; DEBUG_MSG_P(PSTR("[THINGSPEAK] Re-enqueuing %u more time(s)\n"), _tspk_tries); } else { _tspkClearQueue(); } client->close(true); _tspk_client_state = tspk_state_t::NONE; } } } while (_tspk_client_state != tspk_state_t::NONE); }, nullptr); _tspk_client->onConnect([](void * arg, AsyncClient * client) { _tspk_state = AsyncClientState::Disconnected; AsyncThingspeak* tspk_client = reinterpret_cast(client); DEBUG_MSG_P(PSTR("[THINGSPEAK] Connected to %s:%u\n"), tspk_client->address.host.c_str(), tspk_client->address.port); #if THINGSPEAK_USE_SSL uint8_t fp[20] = {0}; sslFingerPrintArray(THINGSPEAK_FINGERPRINT, fp); SSL * ssl = tspk_client->getSSL(); if (ssl_match_fingerprint(ssl, fp) != SSL_OK) { DEBUG_MSG_P(PSTR("[THINGSPEAK] Warning: certificate doesn't match\n")); } #endif DEBUG_MSG_P(PSTR("[THINGSPEAK] POST %s?%s\n"), tspk_client->address.path.c_str(), _tspk_data.c_str()); char headers[strlen_P(THINGSPEAK_REQUEST_TEMPLATE) + tspk_client->address.path.length() + tspk_client->address.host.length() + 1]; snprintf_P(headers, sizeof(headers), THINGSPEAK_REQUEST_TEMPLATE, tspk_client->address.path.c_str(), tspk_client->address.host.c_str(), _tspk_data.length() ); client->write(headers); client->write(_tspk_data.c_str()); }, nullptr); } void _tspkPost(const String& address) { if (_tspk_state != AsyncClientState::Disconnected) return; _tspk_client_ts = millis(); _tspk_state = _tspk_client->connect(address) ? AsyncClientState::Connecting : AsyncClientState::Disconnected; if (_tspk_state == AsyncClientState::Disconnected) { DEBUG_MSG_P(PSTR("[THINGSPEAK] Connection failed\n")); _tspk_client->close(true); } } #else // THINGSPEAK_USE_ASYNC #if THINGSPEAK_USE_SSL && (SECURE_CLIENT == SECURE_CLIENT_BEARSSL) SecureClientConfig _tspk_sc_config { "THINGSPEAK", []() -> int { return getSetting("tspkScCheck", THINGSPEAK_SECURE_CLIENT_CHECK); }, []() -> PGM_P { return _tspk_client_trusted_root_ca; }, []() -> String { return getSetting("tspkFP", THINGSPEAK_FINGERPRINT); }, []() -> uint16_t { return getSetting("tspkScMFLN", THINGSPEAK_SECURE_CLIENT_MFLN); }, true }; #endif // THINGSPEAK_USE_SSL && SECURE_CLIENT_BEARSSL void _tspkPost(WiFiClient* client, const URL& url) { if (!client->connect(url.host.c_str(), url.port)) { DEBUG_MSG_P(PSTR("[THINGSPEAK] Connection failed\n")); return; } DEBUG_MSG_P(PSTR("[THINGSPEAK] Connected to %s:%u\n"), url.host.c_str(), url.port); DEBUG_MSG_P(PSTR("[THINGSPEAK] POST %s?%s\n"), url.path.c_str(), _tspk_data.c_str()); char headers[strlen_P(THINGSPEAK_REQUEST_TEMPLATE) + url.path.length() + url.host.length() + 1]; snprintf_P(headers, sizeof(headers), THINGSPEAK_REQUEST_TEMPLATE, url.path.c_str(), url.host.c_str(), _tspk_data.length() ); client->print(headers); client->print(_tspk_data); nice_delay(100); const auto response = client->readString(); int pos = response.indexOf("\r\n\r\n"); unsigned int code = (pos > 0) ? response.substring(pos + 4).toInt() : 0; DEBUG_MSG_P(PSTR("[THINGSPEAK] Response value: %u\n"), code); client->stop(); _tspk_last_flush = millis(); if ((0 == code) && _tspk_tries) { _tspk_flush = true; DEBUG_MSG_P(PSTR("[THINGSPEAK] Re-enqueuing %u more time(s)\n"), _tspk_tries); } else { _tspkClearQueue(); } } void _tspkPost(const String& address) { const URL url(address); #if SECURE_CLIENT == SECURE_CLIENT_BEARSSL if (url.protocol == "https") { const int check = _ota_sc_config.on_check(); if (!ntpSynced() && (check == SECURE_CLIENT_CHECK_CA)) { DEBUG_MSG_P(PSTR("[THINGSPEAK] Time not synced! Cannot use CA validation\n")); return; } auto client = std::make_unique(_tspk_sc_config); if (!client->beforeConnected()) { return; } _tspkPost(&client->get(), url); return; } #endif if (url.protocol == "http") { auto client = std::make_unique(); _tspkPost(client.get(), url); return; } } #endif // THINGSPEAK_USE_ASYNC void _tspkEnqueue(unsigned char index, const char * payload) { DEBUG_MSG_P(PSTR("[THINGSPEAK] Enqueuing field #%u with value %s\n"), index, payload); --index; if (_tspk_queue[index] != NULL) free(_tspk_queue[index]); _tspk_queue[index] = strdup(payload); } void _tspkClearQueue() { _tspk_tries = THINGSPEAK_TRIES; if (_tspk_clear) { for (unsigned char id=0; id 0) _tspk_data.concat("&"); char buf[32] = {0}; snprintf_P(buf, sizeof(buf), PSTR("field%u=%s"), (id + 1), _tspk_queue[id]); _tspk_data.concat(buf); } } // POST data if any if (_tspk_data.length()) { _tspk_data.concat("&api_key="); _tspk_data.concat(getSetting("tspkKey", THINGSPEAK_APIKEY)); --_tspk_tries; _tspkPost(getSetting("tspkAddress", THINGSPEAK_ADDRESS)); } } // ----------------------------------------------------------------------------- bool tspkEnqueueRelay(unsigned char index, bool status) { if (!_tspk_enabled) return true; unsigned char id = getSetting({"tspkRelay", index}, 0); if (id > 0) { _tspkEnqueue(id, status ? "1" : "0"); return true; } return false; } bool tspkEnqueueMeasurement(unsigned char index, const char * payload) { if (!_tspk_enabled) return true; const auto id = getSetting({"tspkMagnitude", index}, 0); if (id > 0) { _tspkEnqueue(id, payload); return true; } return false; } void tspkFlush() { _tspk_flush = true; } bool tspkEnabled() { return _tspk_enabled; } void tspkSetup() { _tspkConfigure(); #if WEB_SUPPORT wsRegister() .onVisible(_tspkWebSocketOnVisible) .onConnected(_tspkWebSocketOnConnected) .onKeyCheck(_tspkWebSocketOnKeyCheck); #endif #if BROKER_SUPPORT StatusBroker::Register(_tspkBrokerCallback); #endif DEBUG_MSG_P(PSTR("[THINGSPEAK] Async %s, SSL %s\n"), THINGSPEAK_USE_ASYNC ? "ENABLED" : "DISABLED", THINGSPEAK_USE_SSL ? "ENABLED" : "DISABLED" ); // Main callbacks espurnaRegisterLoop(tspkLoop); espurnaRegisterReload(_tspkConfigure); } void tspkLoop() { if (!_tspk_enabled) return; if (!wifiConnected() || (WiFi.getMode() != WIFI_STA)) return; _tspkFlush(); } #endif