922 lines
31 KiB
C++
922 lines
31 KiB
C++
///////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// BresserWeatherSensorMQTTWifiMgr.ino
|
|
//
|
|
// Example for BresserWeatherSensorReceiver -
|
|
// this is finally a useful application.
|
|
//
|
|
// At startup, first a WiFi connection and then a connection to the MQTT broker is established.
|
|
// (Edit secrets.h accordingly!)
|
|
//
|
|
// Then receiving data of all sensors (as defined in NUM_SENSORS, see WeatherSensorCfg.h)
|
|
// is tried periodically.
|
|
// If successful, sensor data is published as MQTT messages, one message per sensor.
|
|
// If the sensor ID can be mapped to a name (edit sensor_map[]), this name is used as the
|
|
// MQTT topic, otherwise the ID is used.
|
|
// From the sensor data, some additional data is calculated and published with the 'extra' topic.
|
|
//
|
|
// Furthermore, Home Assistant auto-discovery messages are published at an interval of
|
|
// DISCOVERY_INTERVAL.
|
|
//
|
|
// The data topics are published at an interval of >DATA_INTERVAL.
|
|
// The 'status' and the 'radio' topics are published at an interval of STATUS_INTERVAL.
|
|
//
|
|
// If sleep mode is enabled (SLEEP_EN), the device goes into deep sleep mode after data has
|
|
// been published. If AWAKE_TIMEOUT is reached before data has been published, deep sleep is
|
|
// entered, too. After SLEEP_INTERVAL, the controller is restarted.
|
|
//
|
|
//
|
|
// https://github.com/matthias-bs/BresserWeatherSensorReceiver
|
|
//
|
|
// Based on:
|
|
// arduino-mqtt by Joël Gähwiler (256dpi) (https://github.com/256dpi/arduino-mqtt)
|
|
// ArduinoJson by Benoit Blanchon (https://arduinojson.org)
|
|
// WiFiManager by tzapu (https://github.com/tzapu/WiFiManager)
|
|
// ESP_DoubleResetDetector by Khoi Hoang (https://github.com/khoih-prog/ESP_DoubleResetDetector)
|
|
//
|
|
// MQTT publications:
|
|
// <base_topic>/<ID|Name>/data sensor data as JSON string - see publishWeatherdata()
|
|
// <base_topic>/<ID|Name>/rssi sensor specific RSSI
|
|
// <base_topic>/extra calculated data
|
|
// <base_topic>/radio radio transceiver info as JSON string - see publishRadio()
|
|
// <base_topic>/status "online"|"offline"|"dead"$
|
|
// <base_topic>/sensors_inc sensors include list as JSON string;
|
|
// triggered by 'get_sensors_inc' MQTT topic
|
|
// <base_topic>/sensors_exc sensors exclude list as JSON string;
|
|
// triggered by 'get_sensors_exc' MQTT topic
|
|
// homeassistant/sensor/<sensor_id>_<json_ele>/config Home Assistand auto discovery for sensor data
|
|
// homeassistant/sensor/<hostname>_<json_ele>/config Home Assistand auto discovery for receiver control/status
|
|
//
|
|
// MQTT subscriptions:
|
|
// <base_topic>/reset <flags> reset rain counters (see RainGauge.h for <flags>)
|
|
// reset lightning post-processing (flags & 0x10)
|
|
// <base_topic>/get_sensors_inc get sensors include list
|
|
// <base_topic>/get_sensors_exc get sensors exclude list
|
|
// <base_topic>/set_sensors_inc {"ids": [<id0>, ... ]} set sensors include list, e.g. {"ids": ["0x89ABCDEF"]}
|
|
// <base_topic>/set_sensors_exc {"ids": [<id0>, ... ]} set sensors exclude list, e.g. {"ids": ["0x89ABCDEF"]}
|
|
//
|
|
// $ via LWT
|
|
//
|
|
//
|
|
// created: 06/2023
|
|
//
|
|
//
|
|
// MIT License
|
|
//
|
|
// Copyright (c) 2023 Matthias Prinke
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in all
|
|
// copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
// SOFTWARE.
|
|
//
|
|
// History:
|
|
//
|
|
// 20230619 Created from BresserWeatherSensorMQTT
|
|
// 20230708 Changed MQTT payload and topic from char[] to String
|
|
// 20230709 Added lightning sensor
|
|
// 20230710 Added optional JSON output of floating point values as strings
|
|
// Modified MQTT topics
|
|
// 20230711 Changed remaining MQTT topics from char[] to String
|
|
// Fixed secure WiFi with CHECK_CA_ROOT for ESP32
|
|
// Added define RX_STRATEGY
|
|
// 20230717 Added startup handling to rain gauge
|
|
// 20230817 Added rain gauge reset via MQTT
|
|
// 20230826 Added hourly (past 60 minutes) rainfall as 'rain_h'
|
|
// 20231030 Fixed and improved mapping of sensor IDs to names
|
|
// Refactored struct Sensor
|
|
// 20231103 Improved handling of time and date
|
|
// 20231110 Fixed false double reset detection on wake-up from deep sleep
|
|
// 20240113 Added lightning data post-processing
|
|
// 20240122 Added lightning post-processing reset
|
|
// 20240129 Replaced SPIFFS by LittleFS
|
|
// Added formatting of LittleFS partition if mounting failed
|
|
// 20240209 Added Leakage, Air Quality (HCHO/VOC) and CO2 Sensors
|
|
// 20240213 Added PM1.0 to Air Quality (Particulate Matter) Sensor decoder
|
|
// 20240503 Fixed setting of RTC via SNTP in case on non-secure WiFi config
|
|
// 20240504 Added board initialization
|
|
// 20240507 Added configuration of maximum number of sensors at run time
|
|
// 20240603 Modified for arduino-esp32 v3.0.0
|
|
// 20241113 Added getting/setting of sensor include/exclude lists via MQTT
|
|
// 20250127 Added Globe Thermometer Temperature (8-in-1 Weather Sensor)
|
|
// 20250129 Added calculated WBGT (Wet Bulb Globe Temperature)
|
|
// 20250220 Added Home Assistant auto discovery
|
|
// 20250223 Moved MQTT functions to src/mqtt_comm.h/.cpp
|
|
//
|
|
// ToDo:
|
|
//
|
|
// -
|
|
//
|
|
// Notes:
|
|
//
|
|
// - To enable wakeup from deep sleep on ESP8266, GPIO16 (D0) must be connected to RST!
|
|
// Add a jumper to remove this connection for programming!
|
|
// - MQTT code based on https://github.com/256dpi/arduino-mqtt
|
|
// - For secure MQTT (TLS server verifycation, check the following examples:
|
|
// - ESP32:
|
|
// https://github.com/espressif/arduino-esp32/blob/master/libraries/WiFiClientSecure/examples/WiFiClientSecure/WiFiClientSecure.ino
|
|
// - ESP8266:
|
|
// https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266WiFi/examples/BearSSL_Validation/BearSSL_Validation.ino
|
|
// - WiFiManager code based on example AutoConnectwithFSParameters
|
|
// - Using ESP_DoubleResetDetector (https://github.com/khoih-prog/ESP_DoubleResetDetector)
|
|
// to force WiFiManager reconfiguration
|
|
//
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#include <Arduino.h>
|
|
|
|
#if CONFIG_IDF_TARGET_ESP32 // ESP32/PICO-D4
|
|
#include "esp32/rom/rtc.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32S2
|
|
#include "esp32s2/rom/rtc.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32C3
|
|
#include "esp32c3/rom/rtc.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32S3
|
|
#include "esp32s3/rom/rtc.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32C6
|
|
#include "esp32c6/rom/rtc.h"
|
|
#elif CONFIG_IDF_TARGET_ESP32H2
|
|
#include "esp32h2/rom/rtc.h"
|
|
#else
|
|
#if !defined(ESP8266)
|
|
#error Target CONFIG_IDF_TARGET is not supported
|
|
#endif
|
|
#endif
|
|
|
|
|
|
// Library Defines - Need to be defined before library import
|
|
#define FORMAT_LITTLEFS_IF_FAILED true
|
|
#define ESP_DRD_USE_LITTLEFS true
|
|
#define DOUBLERESETDETECTOR_DEBUG true
|
|
|
|
// BEGIN User specific options
|
|
// #define LED_EN // Enable LED indicating successful data reception
|
|
#define LED_GPIO LED_BUILTIN // LED pin
|
|
#define TIMEZONE 1 // UTC + TIMEZONE
|
|
#define PAYLOAD_SIZE 300 // maximum MQTT message size
|
|
#define TOPIC_SIZE 60 // maximum MQTT topic size (debug output only)
|
|
#define HOSTNAME_SIZE 30 // maximum hostname size
|
|
#define RX_TIMEOUT 90000 // sensor receive timeout [ms]
|
|
#define STATUS_INTERVAL 30000 // MQTT status message interval [ms]
|
|
#define DATA_INTERVAL 15000 // MQTT data message interval [ms]
|
|
#define DISCOVERY_INTERVAL 30 // Home Assistant auto discovery interval [min]
|
|
#define AWAKE_TIMEOUT 300000 // maximum time until sketch is forced to sleep [ms]
|
|
#define SLEEP_INTERVAL 30 // sleep interval [ms] Módosítva(300000)
|
|
#define WIFI_RETRIES 10 // WiFi connection retries
|
|
#define WIFI_DELAY 1000 // Delay between connection attempts [ms]
|
|
#define SLEEP_EN false // enable sleep mode (see notes above!) Módosítva(true)
|
|
#define AUTO_DISCOVERY // enable Home Assistant auto discovery
|
|
// #define USE_SECUREWIFI // use secure WIFI
|
|
#define USE_WIFI // use non-secure WIFI
|
|
// Enter your time zone (https://remotemonitoringsystems.ca/time-zone-abbreviations.php)
|
|
const char* TZ_INFO = "CET-1CEST-2,M3.5.0/02:00:00,M10.5.0/03:00:00";
|
|
|
|
// Stop reception when data of at least one sensor is complete
|
|
#define RX_FLAGS DATA_COMPLETE
|
|
|
|
// Stop reception when data of all (max_sensors) is complete
|
|
// #define RX_FLAGS (DATA_COMPLETE | DATA_ALL_SLOTS)
|
|
|
|
#define JSON_CONFIG_FILE "/wifimanager_config.json"
|
|
|
|
// Number of seconds after reset during which a
|
|
// subseqent reset will be considered a double reset.
|
|
#define DRD_TIMEOUT 5
|
|
|
|
// RTC Memory Address for the DoubleResetDetector to use
|
|
#define DRD_ADDRESS 0
|
|
|
|
// See
|
|
// https://stackoverflow.com/questions/19554972/json-standard-floating-point-numbers
|
|
// and
|
|
// https://stackoverflow.com/questions/35709595/why-would-you-use-a-string-in-json-to-represent-a-decimal-number
|
|
//
|
|
// Summary:
|
|
// A string representation of a float (e.g. "temp_c":"21.5") is recommended if the value shall displayed with the specified number of decimals.
|
|
// Otherwise the float value can be output as a numerical value (e.g. "temp_c":21.5).
|
|
//
|
|
// #define JSON_FLOAT_AS_STRING
|
|
|
|
// Enable to debug MQTT connection; will generate synthetic sensor data.
|
|
// #define _DEBUG_MQTT_
|
|
|
|
// Generate sensor data to test collecting data from multiple sources
|
|
// #define GEN_SENSOR_DATA
|
|
|
|
// END User specific configuration
|
|
|
|
#if (defined(USE_SECUREWIFI) && defined(USE_WIFI)) || (!defined(USE_SECUREWIFI) && !defined(USE_WIFI))
|
|
#error "Either USE_SECUREWIFI OR USE_WIFI must be defined!"
|
|
#endif
|
|
|
|
#if defined(ESP32)
|
|
#include <WiFi.h>
|
|
#if defined(USE_WIFI)
|
|
#elif defined(USE_SECUREWIFI)
|
|
#include <NetworkClientSecure.h>
|
|
#endif
|
|
#elif defined(ESP8266)
|
|
#include <ESP8266WiFi.h>
|
|
#endif
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
#include <MQTT.h>
|
|
#include <FS.h>
|
|
#include <LittleFS.h>
|
|
#include <WiFiManager.h>
|
|
#include <ESP_DoubleResetDetector.h>
|
|
#include <ArduinoJson.h>
|
|
#include <time.h>
|
|
#include "WeatherSensorCfg.h"
|
|
#include "WeatherSensor.h"
|
|
#include "WeatherUtils.h"
|
|
#include "RainGauge.h"
|
|
#include "Lightning.h"
|
|
#include "InitBoard.h"
|
|
#include "src/mqtt_comm.h"
|
|
|
|
|
|
const char sketch_id[] = "BresserWeatherSensorMQTTWifiMgr 20250228";
|
|
|
|
// Map sensor IDs to Names - replace by your own IDs!
|
|
std::vector<SensorMap> sensor_map = {
|
|
{0x39582376, "WeatherSensor"},
|
|
{0x21103427, "WeatherSensor"},
|
|
{0x67566300, "SoilSensor"},
|
|
{0x5680, "AirQualitySensor"},
|
|
{0x28966796, "LeakageSensor"},
|
|
{0xeefb, "LightningSensor"},
|
|
{0x22400873, "PoolThermometer"}
|
|
//{0x83750871, "SoilMoisture-1"}
|
|
};
|
|
|
|
|
|
// enable only one of these below, disabling both is fine too.
|
|
// #define CHECK_CA_ROOT
|
|
// #define CHECK_PUB_KEY
|
|
// Arduino 1.8.19 ESP32 WiFiClientSecure.h: "SHA1 fingerprint is broken now!"
|
|
// #define CHECK_FINGERPRINT
|
|
////--------------------------////
|
|
|
|
#ifndef SECRETS
|
|
const char ssid[] = " IOT_72";
|
|
const char pass[] = "J0.Jelsz0_Ez";
|
|
|
|
#define HOSTNAME "ESPWeather"
|
|
#define APPEND_CHIP_ID
|
|
|
|
// define your default values here, if there are different values in config.json, they are overwritten.
|
|
char mqtt_host[40];
|
|
char mqtt_port[6] = "1883";
|
|
char mqtt_user[21] = "";
|
|
char mqtt_pass[21] = "";
|
|
|
|
#ifdef CHECK_CA_ROOT
|
|
static const char digicert[] PROGMEM = R"EOF(
|
|
-----BEGIN CERTIFICATE-----
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
-----END CERTIFICATE-----
|
|
)EOF";
|
|
#endif
|
|
|
|
#ifdef CHECK_PUB_KEY
|
|
// Extracted by: openssl x509 -pubkey -noout -in fullchain.pem
|
|
static const char pubkey[] PROGMEM = R"KEY(
|
|
-----BEGIN PUBLIC KEY-----
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
xxxxxxxx
|
|
-----END PUBLIC KEY-----
|
|
)KEY";
|
|
#endif
|
|
|
|
#ifdef CHECK_FINGERPRINT
|
|
// Extracted by: openssl x509 -fingerprint -in fillchain.pem
|
|
static const char fp[] PROGMEM = "AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD";
|
|
#endif
|
|
#endif
|
|
|
|
DoubleResetDetector *drd;
|
|
|
|
// flag for saving data
|
|
bool shouldSaveConfig = false;
|
|
|
|
// flag for forcing WiFiManager re-config
|
|
bool forceConfig = false;
|
|
|
|
WeatherSensor weatherSensor;
|
|
RainGauge rainGauge;
|
|
Lightning lightning;
|
|
|
|
// MQTT topics - change if needed
|
|
String Hostname = String(HOSTNAME);
|
|
String mqttPubStatus = "status";
|
|
String mqttPubRadio = "radio";
|
|
String mqttPubData = "data";
|
|
String mqttPubRssi = "rssi";
|
|
String mqttPubExtra = "extra";
|
|
String mqttPubInc = "sensors_inc";
|
|
String mqttPubExc = "sensors_exc";
|
|
String mqttSubReset = "reset";
|
|
String mqttSubGetInc = "get_sensors_inc";
|
|
String mqttSubGetExc = "get_sensors_exc";
|
|
String mqttSubSetInc = "set_sensors_inc";
|
|
String mqttSubSetExc = "set_sensors_exc";
|
|
|
|
//////////////////////////////////////////////////////
|
|
|
|
#if (defined(CHECK_PUB_KEY) and defined(CHECK_CA_ROOT)) or (defined(CHECK_PUB_KEY) and defined(CHECK_FINGERPRINT)) or (defined(CHECK_FINGERPRINT) and defined(CHECK_CA_ROOT)) or (defined(CHECK_PUB_KEY) and defined(CHECK_CA_ROOT) and defined(CHECK_FINGERPRINT))
|
|
#error "Can't have both CHECK_CA_ROOT and CHECK_PUB_KEY enabled"
|
|
#endif
|
|
|
|
// Generate WiFi network instance
|
|
#if defined(ESP32)
|
|
#if defined(USE_WIFI)
|
|
WiFiClient net;
|
|
#elif defined(USE_SECUREWIFI)
|
|
NetworkClientSecure net;
|
|
#endif
|
|
#elif defined(ESP8266)
|
|
#if defined(USE_WIFI)
|
|
WiFiClient net;
|
|
#elif defined(USE_SECUREWIFI)
|
|
BearSSL::WiFiClientSecure net;
|
|
#endif
|
|
#endif
|
|
|
|
//
|
|
// Generate MQTT client instance
|
|
// N.B.: Default message buffer size is too small!
|
|
//
|
|
MQTTClient client(PAYLOAD_SIZE);
|
|
|
|
uint32_t lastMillis = 0;
|
|
uint32_t statusPublishPreviousMillis = 0;
|
|
#if defined(AUTO_DISCOVERY)
|
|
uint32_t discoveryPublishPreviousMillis = 0;
|
|
#endif
|
|
|
|
//void publishWeatherdata(bool complete = false);
|
|
//void mqtt_connect(void);
|
|
|
|
/*!
|
|
* \brief Set RTC
|
|
*
|
|
* \param epoch Time since epoch
|
|
* \param ms unused
|
|
*/
|
|
void setTime(unsigned long epoch, int ms) {
|
|
struct timeval tv;
|
|
|
|
if (epoch > 2082758399){
|
|
tv.tv_sec = epoch - 2082758399; // epoch time (seconds)
|
|
} else {
|
|
tv.tv_sec = epoch; // epoch time (seconds)
|
|
}
|
|
tv.tv_usec = ms; // microseconds
|
|
settimeofday(&tv, NULL);
|
|
}
|
|
|
|
/// Print date and time (i.e. local time)
|
|
void printDateTime(void) {
|
|
struct tm timeinfo;
|
|
char tbuf[25];
|
|
|
|
time_t tnow;
|
|
time(&tnow);
|
|
localtime_r(&tnow, &timeinfo);
|
|
strftime(tbuf, 25, "%Y-%m-%d %H:%M:%S", &timeinfo);
|
|
log_i("%s", tbuf);
|
|
}
|
|
/*!
|
|
* \brief Callback notifying us of the need to save config
|
|
*/
|
|
void saveConfigCallback()
|
|
{
|
|
Serial.println("Should save config");
|
|
shouldSaveConfig = true;
|
|
}
|
|
|
|
/*!
|
|
* \brief Wait for WiFi connection
|
|
*
|
|
* \param wifi_retries max. no. of retries
|
|
* \param wifi_delay delay in ms before each attemüt
|
|
*/
|
|
void wifi_wait(int wifi_retries, int wifi_delay)
|
|
{
|
|
int count = 0;
|
|
while (WiFi.status() != WL_CONNECTED)
|
|
{
|
|
Serial.print(".");
|
|
delay(wifi_delay);
|
|
if (++count == wifi_retries)
|
|
{
|
|
log_e("\nWiFi connection timed out, will restart after %d s", SLEEP_INTERVAL / 1000);
|
|
ESP.deepSleep(SLEEP_INTERVAL * 1000);
|
|
}
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief WiFiManager Setup
|
|
*
|
|
* Configures WiFi access point and MQTT connection parameters
|
|
*/
|
|
void wifimgr_setup(void)
|
|
{
|
|
|
|
// clean FS, for testing
|
|
//LittleFS.format();
|
|
|
|
// read configuration from FS json
|
|
Serial.println("mounting FS...");
|
|
|
|
#if defined(ESP8266)
|
|
// No parameter - FS is always formatted if mounting failed
|
|
if (LittleFS.begin())
|
|
#else
|
|
if (LittleFS.begin(FORMAT_LITTLEFS_IF_FAILED))
|
|
#endif
|
|
{
|
|
log_i("mounted file system");
|
|
if (LittleFS.exists("/config.json"))
|
|
{
|
|
// file exists, reading and loading
|
|
log_i("reading config file");
|
|
File configFile = LittleFS.open("/config.json", "r");
|
|
if (configFile)
|
|
{
|
|
log_i("opened config file");
|
|
size_t size = configFile.size();
|
|
// Allocate a buffer to store contents of the file.
|
|
std::unique_ptr<char[]> buf(new char[size]);
|
|
|
|
configFile.readBytes(buf.get(), size);
|
|
|
|
JsonDocument json;
|
|
auto deserializeError = deserializeJson(json, buf.get());
|
|
serializeJson(json, Serial);
|
|
|
|
if (!deserializeError)
|
|
{
|
|
Serial.println("\nparsed json");
|
|
strcpy(mqtt_host, json["mqtt_server"]);
|
|
strcpy(mqtt_port, json["mqtt_port"]);
|
|
strcpy(mqtt_user, json["mqtt_user"]);
|
|
strcpy(mqtt_pass, json["mqtt_pass"]);
|
|
}
|
|
else
|
|
{
|
|
Serial.println("failed to load json config");
|
|
}
|
|
configFile.close();
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
log_e("failed to mount FS");
|
|
}
|
|
// end read
|
|
|
|
// WiFi.disconnect();
|
|
WiFi.hostname(Hostname.c_str());
|
|
WiFi.mode(WIFI_STA); // explicitly set mode, esp defaults to STA+AP
|
|
delay(10);
|
|
|
|
// wm.resetSettings(); // wipe settings
|
|
|
|
// The extra parameters to be configured (can be either global or just in the setup)
|
|
// After connecting, parameter.getValue() will get you the configured value
|
|
// id/name placeholder/prompt default length
|
|
WiFiManagerParameter custom_mqtt_server("server", "MQTT Server (Broker)", mqtt_host, 40);
|
|
WiFiManagerParameter custom_mqtt_port("port", "MQTT Port", mqtt_port, 6);
|
|
WiFiManagerParameter custom_mqtt_user("user", "MQTT Username", mqtt_user, 20);
|
|
WiFiManagerParameter custom_mqtt_pass("pass", "MQTT Password", mqtt_pass, 20);
|
|
|
|
WiFiManager wifiManager;
|
|
|
|
if (forceConfig)
|
|
{
|
|
wifiManager.resetSettings();
|
|
}
|
|
|
|
// set config save notify callback
|
|
wifiManager.setSaveConfigCallback(saveConfigCallback);
|
|
|
|
// set static ip
|
|
// wifiManager.setSTAStaticIPConfig(IPAddress(10, 0, 1, 99), IPAddress(10, 0, 1, 1), IPAddress(255, 255, 255, 0));
|
|
|
|
// add all your parameters here
|
|
wifiManager.addParameter(&custom_mqtt_server);
|
|
wifiManager.addParameter(&custom_mqtt_port);
|
|
wifiManager.addParameter(&custom_mqtt_user);
|
|
wifiManager.addParameter(&custom_mqtt_pass);
|
|
|
|
// Options
|
|
// reset settings - for testing
|
|
// wifiManager.resetSettings();
|
|
|
|
// set minimum quality of signal so it ignores AP's under that quality
|
|
// defaults to 8%
|
|
// wifiManager.setMinimumSignalQuality();
|
|
|
|
// sets timeout until configuration portal gets turned off
|
|
// useful to make it all retry or go to sleep
|
|
// in seconds
|
|
wifiManager.setTimeout(120);
|
|
|
|
// fetches ssid and pass and tries to connect
|
|
// if it does not connect it starts an access point with the specified name
|
|
// and goes into a blocking loop awaiting configuration
|
|
if (!wifiManager.autoConnect(Hostname.c_str(), "password"))
|
|
{
|
|
Serial.println("failed to connect and hit timeout");
|
|
delay(3000);
|
|
// reset and try again, or maybe put it to deep sleep
|
|
ESP.restart();
|
|
delay(5000);
|
|
}
|
|
|
|
// if you get here you have connected to the WiFi
|
|
log_i("connected...yeey :)");
|
|
|
|
// read updated parameters
|
|
strcpy(mqtt_host, custom_mqtt_server.getValue());
|
|
strcpy(mqtt_port, custom_mqtt_port.getValue());
|
|
strcpy(mqtt_user, custom_mqtt_user.getValue());
|
|
strcpy(mqtt_pass, custom_mqtt_pass.getValue());
|
|
log_i("The values in the file are: ");
|
|
log_i("\tmqtt_server : %s", mqtt_host);
|
|
log_i("\tmqtt_port : %s", mqtt_port);
|
|
log_i("\tmqtt_user : %s", mqtt_user);
|
|
log_i("\tmqtt_pass : ***");
|
|
|
|
// save the custom parameters to FS
|
|
if (shouldSaveConfig)
|
|
{
|
|
log_i("saving config");
|
|
|
|
JsonDocument json;
|
|
json["mqtt_server"] = mqtt_host;
|
|
json["mqtt_port"] = mqtt_port;
|
|
json["mqtt_user"] = mqtt_user;
|
|
json["mqtt_pass"] = mqtt_pass;
|
|
|
|
File configFile = LittleFS.open("/config.json", "w");
|
|
if (!configFile)
|
|
{
|
|
log_e("failed to open config file for writing");
|
|
}
|
|
|
|
serializeJson(json, Serial);
|
|
serializeJson(json, configFile);
|
|
|
|
configFile.close();
|
|
// end save
|
|
}
|
|
|
|
log_i("local ip: %s", WiFi.localIP().toString().c_str());
|
|
}
|
|
|
|
/*!
|
|
* \brief Setup secure WiFi (if enabled) and MQTT client
|
|
*/
|
|
void mqtt_setup(void)
|
|
{
|
|
// Note: TLS security, raingauge and lightning need correct time
|
|
log_i("Setting time using SNTP");
|
|
configTime(TIMEZONE * 3600, 0, "pool.ntp.org", "time.nist.gov");
|
|
time_t now = time(nullptr);
|
|
int retries = 10;
|
|
while (now < 1510592825)
|
|
{
|
|
if (--retries == 0)
|
|
break;
|
|
delay(500);
|
|
Serial.print(".");
|
|
now = time(nullptr);
|
|
}
|
|
if (retries == 0) {
|
|
log_w("\nSetting time using SNTP failed!");
|
|
} else {
|
|
log_i("\ndone!");
|
|
setTime(time(nullptr), 0);
|
|
}
|
|
struct tm timeinfo;
|
|
gmtime_r(&now, &timeinfo);
|
|
log_i("Current time (GMT): %s", asctime(&timeinfo));
|
|
|
|
#ifdef USE_SECUREWIFI
|
|
#if defined(ESP8266)
|
|
#ifdef CHECK_CA_ROOT
|
|
BearSSL::X509List cert(digicert);
|
|
net.setTrustAnchors(&cert);
|
|
#endif
|
|
#ifdef CHECK_PUB_KEY
|
|
BearSSL::PublicKey key(pubkey);
|
|
net.setKnownKey(&key);
|
|
#endif
|
|
#ifdef CHECK_FINGERPRINT
|
|
net.setFingerprint(fp);
|
|
#endif
|
|
#elif defined(ESP32)
|
|
#ifdef CHECK_CA_ROOT
|
|
net.setCACert(digicert);
|
|
#endif
|
|
#ifdef CHECK_PUB_KEY
|
|
error "CHECK_PUB_KEY: not implemented"
|
|
#endif
|
|
#ifdef CHECK_FINGERPRINT
|
|
net.setFingerprint(fp);
|
|
#endif
|
|
#endif
|
|
#if (!defined(CHECK_PUB_KEY) and !defined(CHECK_CA_ROOT) and !defined(CHECK_FINGERPRINT))
|
|
// do not verify tls certificate
|
|
net.setInsecure();
|
|
#endif
|
|
#endif
|
|
client.begin(mqtt_host, atoi(mqtt_port), net);
|
|
|
|
// set up MQTT receive callback
|
|
client.onMessage(messageReceived);
|
|
client.setWill(mqttPubStatus.c_str(), "dead", true /* retained */, 1 /* qos */);
|
|
mqtt_connect();
|
|
}
|
|
|
|
/*!
|
|
* \brief (Re-)Connect to WLAN and connect MQTT broker
|
|
*/
|
|
void mqtt_connect(void)
|
|
{
|
|
Serial.print(F("Checking wifi..."));
|
|
wifi_wait(WIFI_RETRIES, WIFI_DELAY);
|
|
|
|
Serial.print(F("\nMQTT connecting... "));
|
|
while (!client.connect(Hostname.c_str(), mqtt_user, mqtt_pass))
|
|
{
|
|
Serial.print(".");
|
|
delay(1000);
|
|
}
|
|
|
|
log_i("\nconnected!");
|
|
client.subscribe(mqttSubReset);
|
|
log_i("%s: %s\n", mqttPubStatus.c_str(), "online");
|
|
client.publish(mqttPubStatus, "online");
|
|
}
|
|
|
|
|
|
//
|
|
// Setup
|
|
//
|
|
void setup()
|
|
{
|
|
Serial.begin(115200);
|
|
Serial.setDebugOutput(true);
|
|
initBoard();
|
|
log_i("\n\n%s\n", sketch_id);
|
|
|
|
#if defined(ESP32)
|
|
// Detect reset reason:
|
|
// see
|
|
// https://github.com/espressif/arduino-esp32/blob/master/libraries/ESP32/examples/ResetReason/ResetReason.ino
|
|
log_d("CPU0 reset reason: %d", rtc_get_reset_reason(0));
|
|
log_d("CPU1 reset reason: %d", rtc_get_reset_reason(1));
|
|
#endif
|
|
|
|
// Set time zone
|
|
setenv("TZ", TZ_INFO, 1);
|
|
printDateTime();
|
|
|
|
#ifdef LED_EN
|
|
// Configure LED output pins
|
|
pinMode(LED_GPIO, OUTPUT);
|
|
digitalWrite(LED_GPIO, HIGH);
|
|
#endif
|
|
|
|
char ChipID[8] = "";
|
|
|
|
#if defined(APPEND_CHIP_ID) && defined(ESP32)
|
|
uint32_t chip_id = 0;
|
|
for (int i = 0; i < 17; i = i + 8)
|
|
{
|
|
chip_id |= ((ESP.getEfuseMac() >> (40 - i)) & 0xff) << i;
|
|
}
|
|
sprintf(ChipID, "-%06X", chip_id);
|
|
#elif defined(APPEND_CHIP_ID) && defined(ESP8266)
|
|
sprintf(ChipID, "-%06X", ESP.getChipId() & 0xFFFFFF);
|
|
#endif
|
|
Hostname = Hostname + ChipID;
|
|
// Prepend Hostname to MQTT topics
|
|
mqttPubStatus = Hostname + "/" + mqttPubStatus;
|
|
mqttPubRadio = Hostname + "/" + mqttPubRadio;
|
|
mqttPubInc = Hostname + "/" + mqttPubInc;
|
|
mqttPubExc = Hostname + "/" + mqttPubExc;
|
|
mqttSubReset = Hostname + "/" + mqttSubReset;
|
|
mqttSubGetInc = Hostname + "/" + mqttSubGetInc;
|
|
mqttSubGetExc = Hostname + "/" + mqttSubGetExc;
|
|
mqttSubSetInc = Hostname + "/" + mqttSubSetInc;
|
|
mqttSubSetExc = Hostname + "/" + mqttSubSetExc;
|
|
|
|
drd = new DoubleResetDetector(DRD_TIMEOUT, DRD_ADDRESS);
|
|
|
|
#if defined(ESP32)
|
|
bool hw_reset = (rtc_get_reset_reason(0) == 1);
|
|
#elif defined(ESP8266)
|
|
rst_info *resetInfo;
|
|
resetInfo = ESP.getResetInfoPtr();
|
|
log_d("Reset Reason: %d", resetInfo->reason);
|
|
bool hw_reset = (resetInfo->reason == REASON_EXT_SYS_RST);
|
|
#endif
|
|
|
|
// HW power-on/HW reset AND DoubleReset
|
|
if (hw_reset && drd->detectDoubleReset())
|
|
{
|
|
Serial.println(F("Forcing config mode as there was a Double reset detected"));
|
|
forceConfig = true;
|
|
}
|
|
/*
|
|
bool fsSetup = loadConfigFile();
|
|
if (!fsSetup)
|
|
{
|
|
Serial.println(F("Forcing config mode as there is no saved config"));
|
|
forceConfig = true;
|
|
}
|
|
*/
|
|
wifimgr_setup();
|
|
mqtt_setup();
|
|
weatherSensor.begin();
|
|
}
|
|
|
|
/*!
|
|
\brief Wrapper which allows passing of member function as parameter
|
|
*/
|
|
void clientLoopWrapper(void)
|
|
{
|
|
client.loop();
|
|
drd->loop();
|
|
}
|
|
|
|
//
|
|
// Main execution loop
|
|
//
|
|
void loop()
|
|
{
|
|
drd->loop();
|
|
if (WiFi.status() != WL_CONNECTED)
|
|
{
|
|
Serial.print(F("Checking wifi"));
|
|
while (WiFi.waitForConnectResult() != WL_CONNECTED)
|
|
{
|
|
WiFi.begin(ssid, pass);
|
|
Serial.print(".");
|
|
delay(10);
|
|
}
|
|
Serial.println(F("connected"));
|
|
}
|
|
else
|
|
{
|
|
if (!client.connected())
|
|
{
|
|
mqtt_connect();
|
|
}
|
|
else
|
|
{
|
|
client.loop();
|
|
}
|
|
}
|
|
|
|
const uint32_t currentMillis = millis();
|
|
if (currentMillis - statusPublishPreviousMillis >= STATUS_INTERVAL)
|
|
{
|
|
// publish a status message @STATUS_INTERVAL
|
|
statusPublishPreviousMillis = currentMillis;
|
|
log_i("%s: %s\n", mqttPubStatus.c_str(), "online");
|
|
client.publish(mqttPubStatus, "online");
|
|
publishRadio();
|
|
}
|
|
|
|
bool decode_ok = false;
|
|
#ifdef _DEBUG_MQTT_
|
|
decode_ok = weatherSensor.genMessage(0 /* slot */, 0x01234567 /* ID */, 1 /* type */, 0 /* channel */);
|
|
#else
|
|
// Clear sensor data buffer
|
|
weatherSensor.clearSlots();
|
|
|
|
#ifdef GEN_SENSOR_DATA
|
|
weatherSensor.genMessage(1 /* slot */, 0xdeadbeef /* ID */, 1 /* type */, 7 /* channel */);
|
|
#endif
|
|
|
|
// Attempt to receive data set with timeout of <xx> s
|
|
decode_ok = weatherSensor.getData(RX_TIMEOUT, RX_FLAGS, 0, &clientLoopWrapper);
|
|
#endif
|
|
|
|
#ifdef LED_EN
|
|
if (decode_ok)
|
|
{
|
|
digitalWrite(LED_GPIO, LOW);
|
|
}
|
|
else
|
|
{
|
|
digitalWrite(LED_GPIO, HIGH);
|
|
}
|
|
#endif
|
|
|
|
// publish a data message @DATA_INTERVAL
|
|
if (millis() - lastMillis > DATA_INTERVAL)
|
|
{
|
|
lastMillis = millis();
|
|
if (decode_ok)
|
|
publishWeatherdata(false);
|
|
}
|
|
|
|
#if defined(AUTO_DISCOVERY)
|
|
// publish a discovery message @DISCOVERY_INTERVAL
|
|
if (millis() - discoveryPublishPreviousMillis > DISCOVERY_INTERVAL * 60000)
|
|
{
|
|
discoveryPublishPreviousMillis = millis();
|
|
haAutoDiscovery();
|
|
}
|
|
#endif
|
|
|
|
bool force_sleep = millis() > AWAKE_TIMEOUT;
|
|
|
|
// Go to sleep only after complete set of data has been sent
|
|
if (SLEEP_EN && (decode_ok || force_sleep))
|
|
{
|
|
if (force_sleep)
|
|
{
|
|
log_d("Awake time-out!");
|
|
}
|
|
else
|
|
{
|
|
log_d("Data forwarding completed.");
|
|
}
|
|
|
|
log_i("Sleeping for %d ms\n", SLEEP_INTERVAL);
|
|
log_i("%s: %s\n", mqttPubStatus.c_str(), "offline");
|
|
Serial.flush();
|
|
client.publish(mqttPubStatus, "offline", true /* retained */, 0 /* qos */);
|
|
client.loop();
|
|
client.disconnect();
|
|
net.stop();
|
|
#ifdef LED_EN
|
|
pinMode(LED_GPIO, INPUT);
|
|
#endif
|
|
// Note:
|
|
// Further reduction of sleep current might be possible by
|
|
// controlling the GPIO pins (including SPI CS) appropriately.
|
|
// This depends on the actual board/radio chip used.
|
|
// See
|
|
// https://github.com/jgromes/RadioLib/discussions/1375#discussioncomment-11763846
|
|
weatherSensor.sleep();
|
|
ESP.deepSleep(SLEEP_INTERVAL * 10); //Módosítva (1000)
|
|
}
|
|
} // loop()
|