test/testgit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

harmadik_feltoltes

Browse Source
This commit is contained in:
Lehotai Zoltán
2026-04-21 20:45:01 +02:00
parent 66f8048e06
commit 63111b316c
3 changed files with 1716 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

921
BresserWeatherSensorMQTTWifiMgr1/BresserWeatherSensorMQTTWifiMgr1.ino Normal file
View File

@@ -0,0 +1,921 @@
///////////////////////////////////////////////////////////////////////////////////////////////////
// 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()

637
BresserWeatherSensorMQTTWifiMgr1/src/mqtt_comm.cpp Normal file
View File

@@ -0,0 +1,637 @@
///////////////////////////////////////////////////////////////////////////////////////////////////
// mqtt_comm.h
//
// MQTT communication
// Code shared between BresserWeaterSensor<MQTT|MQTTCustom|MQTTWifiMgr>.ino
//
//
// https://github.com/matthias-bs/BresserWeatherSensorReceiver
//
//
// created: 02/2025
//
//
// MIT License
//
// Copyright (c) 2025 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:
//
// 20250221 Created from BresserWeatherSensorMQTT.ino
// 20250227 Added publishControlDiscovery()
// 20250228 Added publishStatusDiscovery(), fixed sensorName()
//
// ToDo:
// -
//
///////////////////////////////////////////////////////////////////////////////////////////////////
#include "mqtt_comm.h"
extern String Hostname;
extern String mqttPubData;
extern String mqttPubRssi;
extern String mqttPubStatus;
extern String mqttPubRadio;
extern String mqttPubExtra;
extern String mqttPubInc;
extern String mqttPubExc;
extern String mqttSubReset;
extern String mqttSubGetInc;
extern String mqttSubGetExc;
extern String mqttSubSetInc;
extern String mqttSubSetExc;
extern MQTTClient client;
extern WeatherSensor weatherSensor;
extern RainGauge rainGauge;
extern Lightning lightning;
extern std::vector<SensorMap> sensor_map;
String sensorName(uint32_t sensor_id)
{
String sensor_str = String(sensor_id, HEX);
for (size_t n = 0; n < sensor_map.size(); n++)
{
if (sensor_map[n].id == sensor_id)
{
sensor_str = sensor_map[n].name;
break;
}
}
return sensor_str;
}
// MQTT message received callback
void messageReceived(String &topic, String &payload)
{
if (topic == mqttSubReset)
{
uint8_t flags = payload.toInt() & 0xFF;
log_d("MQTT msg received: reset(0x%X)", flags);
rainGauge.reset(flags);
if (flags & 0x10)
{
lightning.reset();
}
}
else if (topic == mqttSubGetInc)
{
log_d("MQTT msg received: get_sensors_inc");
client.publish(mqttPubInc, weatherSensor.getSensorsIncJson());
}
else if (topic == mqttSubGetExc)
{
log_d("MQTT msg received: get_sensors_exc");
client.publish(mqttPubExc, weatherSensor.getSensorsExcJson());
}
else if (topic == mqttSubSetInc)
{
log_d("MQTT msg received: set_sensors_inc");
weatherSensor.setSensorsIncJson(payload);
}
else if (topic == mqttSubSetExc)
{
log_d("MQTT msg received: set_sensors_exc");
weatherSensor.setSensorsExcJson(payload);
}
else
{
log_d("MQTT msg received: %s", topic.c_str());
}
}
// Publish weather data as MQTT message
void publishWeatherdata(bool complete, bool retain)
{
String mqtt_payload; // sensor data
String mqtt_payload2; // calculated extra data
String mqtt_topic; // MQTT topic including ID/name
// ArduinoJson does not allow to set number of decimals for floating point data -
// neither does MQTT Dashboard...
// Therefore the JSON string is created manually.
for (size_t i = 0; i < weatherSensor.sensor.size(); i++)
{
// Reset string buffers
mqtt_payload = "";
mqtt_payload2 = "";
if (!weatherSensor.sensor[i].valid)
continue;
if (weatherSensor.sensor[i].w.rain_ok)
{
struct tm timeinfo;
time_t now = time(nullptr);
localtime_r(&now, &timeinfo);
rainGauge.update(now, weatherSensor.sensor[i].w.rain_mm, weatherSensor.sensor[i].startup);
}
// Example:
// {"ch":0,"battery_ok":1,"humidity":44,"wind_gust":1.2,"wind_avg":1.2,"wind_dir":150,"rain":146}
mqtt_payload = "{";
mqtt_payload2 = "{";
mqtt_payload += String("\"id\":") + String(weatherSensor.sensor[i].sensor_id);
mqtt_payload += String(",\"ch\":") + String(weatherSensor.sensor[i].chan);
mqtt_payload += String(",\"battery_ok\":") + (weatherSensor.sensor[i].battery_ok ? String("1") : String("0"));
if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_SOIL)
{
mqtt_payload += String(",\"temp_c\":") + String(weatherSensor.sensor[i].soil.temp_c);
mqtt_payload += String(",\"moisture\":") + String(weatherSensor.sensor[i].soil.moisture);
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_LIGHTNING)
{
mqtt_payload += String(",\"lightning_count\":") + String(weatherSensor.sensor[i].lgt.strike_count);
mqtt_payload += String(",\"lightning_distance_km\":") + String(weatherSensor.sensor[i].lgt.distance_km);
mqtt_payload += String(",\"lightning_unknown1\":\"0x") + String(weatherSensor.sensor[i].lgt.unknown1, HEX) + String("\"");
mqtt_payload += String(",\"lightning_unknown2\":\"0x") + String(weatherSensor.sensor[i].lgt.unknown2, HEX) + String("\"");
struct tm timeinfo;
time_t now = time(nullptr);
localtime_r(&now, &timeinfo);
lightning.update(
now,
weatherSensor.sensor[i].lgt.strike_count,
weatherSensor.sensor[i].lgt.distance_km,
weatherSensor.sensor[i].startup);
mqtt_payload += String(",\"lightning_hr\":") + String(lightning.pastHour());
int events;
time_t timestamp;
uint8_t distance;
if (lightning.lastEvent(timestamp, events, distance))
{
char tbuf[25];
struct tm timeinfo;
gmtime_r(&timestamp, &timeinfo);
strftime(tbuf, 25, "%Y-%m-%dT%H:%M:%SZ", &timeinfo);
mqtt_payload += String(",\"lightning_event_time\":\"") + String(tbuf) + String("\"");
mqtt_payload += String(",\"lightning_event_count\":") + String(events);
mqtt_payload += String(",\"lightning_event_distance_km\":") + String(distance);
}
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_LEAKAGE)
{
// Water Leakage Sensor
mqtt_payload += String(",\"leakage\":") + String(weatherSensor.sensor[i].leak.alarm);
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_AIR_PM)
{
// Air Quality (Particular Matter) Sensor
if (!weatherSensor.sensor[i].pm.pm_1_0_init)
{
mqtt_payload += String(",\"pm1_0_ug_m3\":") + String(weatherSensor.sensor[i].pm.pm_1_0);
}
if (!weatherSensor.sensor[i].pm.pm_2_5_init)
{
mqtt_payload += String(",\"pm2_5_ug_m3\":") + String(weatherSensor.sensor[i].pm.pm_2_5);
}
if (!weatherSensor.sensor[i].pm.pm_10_init)
{
mqtt_payload += String(",\"pm10_ug_m3\":") + String(weatherSensor.sensor[i].pm.pm_10);
}
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_CO2)
{
// CO2 Sensor
if (!weatherSensor.sensor[i].co2.co2_init)
{
mqtt_payload += String(",\"co2_ppm\":") + String(weatherSensor.sensor[i].co2.co2_ppm);
}
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_HCHO_VOC)
{
// HCHO / VOC Sensor
if (!weatherSensor.sensor[i].voc.hcho_init)
{
mqtt_payload += String(",\"hcho_ppb\":") + String(weatherSensor.sensor[i].voc.hcho_ppb);
}
if (!weatherSensor.sensor[i].voc.voc_init)
{
mqtt_payload += String(",\"voc\":") + String(weatherSensor.sensor[i].voc.voc_level);
}
}
else if ((weatherSensor.sensor[i].s_type == SENSOR_TYPE_WEATHER0) ||
(weatherSensor.sensor[i].s_type == SENSOR_TYPE_WEATHER1) ||
(weatherSensor.sensor[i].s_type == SENSOR_TYPE_WEATHER2) ||
(weatherSensor.sensor[i].s_type == SENSOR_TYPE_THERMO_HYGRO) ||
(weatherSensor.sensor[i].s_type == SENSOR_TYPE_POOL_THERMO))
{
if (weatherSensor.sensor[i].w.temp_ok || complete)
{
mqtt_payload += String(",\"temp_c\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.temp_c, 1));
}
if (weatherSensor.sensor[i].w.humidity_ok || complete)
{
mqtt_payload += String(",\"humidity\":") + String(weatherSensor.sensor[i].w.humidity);
}
if (weatherSensor.sensor[i].w.wind_ok || complete)
{
mqtt_payload += String(",\"wind_gust\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.wind_gust_meter_sec, 1));
mqtt_payload += String(",\"wind_avg\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.wind_avg_meter_sec, 1));
mqtt_payload += String(",\"wind_dir\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.wind_direction_deg, 1));
}
if (weatherSensor.sensor[i].w.wind_ok)
{
char buf[4];
mqtt_payload2 += String("\"wind_dir_txt\":\"") + String(winddir_flt_to_str(weatherSensor.sensor[i].w.wind_direction_deg, buf)) + "\"";
mqtt_payload2 += String(",\"wind_gust_bft\":") + String(windspeed_ms_to_bft(weatherSensor.sensor[i].w.wind_gust_meter_sec));
mqtt_payload2 += String(",\"wind_avg_bft\":") + String(windspeed_ms_to_bft(weatherSensor.sensor[i].w.wind_avg_meter_sec));
}
if ((weatherSensor.sensor[i].w.temp_ok) && (weatherSensor.sensor[i].w.humidity_ok))
{
mqtt_payload2 += String(",\"dewpoint_c\":") + JSON_FLOAT(String(calcdewpoint(weatherSensor.sensor[i].w.temp_c, weatherSensor.sensor[i].w.humidity), 1));
if (weatherSensor.sensor[i].w.wind_ok)
{
mqtt_payload2 += String(",\"perceived_temp_c\":") + JSON_FLOAT(String(perceived_temperature(weatherSensor.sensor[i].w.temp_c, weatherSensor.sensor[i].w.wind_avg_meter_sec, weatherSensor.sensor[i].w.humidity), 1));
}
if (weatherSensor.sensor[i].w.tglobe_ok)
{
float t_wet = calcnaturalwetbulb(weatherSensor.sensor[i].w.temp_c, weatherSensor.sensor[i].w.humidity);
float wbgt = calcwbgt(t_wet, weatherSensor.sensor[i].w.tglobe_c, weatherSensor.sensor[i].w.temp_c);
mqtt_payload2 += String(",\"wgbt\":") + JSON_FLOAT(String(wbgt, 1));
}
}
if (weatherSensor.sensor[i].w.uv_ok || complete)
{
mqtt_payload += String(",\"uv\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.uv, 1));
}
if (weatherSensor.sensor[i].w.light_ok || complete)
{
mqtt_payload += String(",\"light_klx\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.light_klx, 1));
}
if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_WEATHER2)
{
if (weatherSensor.sensor[i].w.tglobe_ok || complete)
{
mqtt_payload += String(",\"t_globe_c\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.tglobe_c, 1));
}
}
if (weatherSensor.sensor[i].w.rain_ok || complete)
{
mqtt_payload += String(",\"rain\":") + JSON_FLOAT(String(weatherSensor.sensor[i].w.rain_mm, 1));
mqtt_payload += String(",\"rain_h\":") + JSON_FLOAT(String(rainGauge.pastHour(), 1));
mqtt_payload += String(",\"rain_d\":") + JSON_FLOAT(String(rainGauge.currentDay(), 1));
mqtt_payload += String(",\"rain_w\":") + JSON_FLOAT(String(rainGauge.currentWeek(), 1));
mqtt_payload += String(",\"rain_m\":") + JSON_FLOAT(String(rainGauge.currentMonth(), 1));
}
}
mqtt_payload += String("}");
mqtt_payload2 += String("}");
if (mqtt_payload.length() >= PAYLOAD_SIZE)
{
log_e("mqtt_payload (%d) > PAYLOAD_SIZE (%d). Payload will be truncated!", mqtt_payload.length(), PAYLOAD_SIZE);
}
if (mqtt_payload2.length() >= PAYLOAD_SIZE)
{
log_e("mqtt_payload2 (%d) > PAYLOAD_SIZE (%d). Payload will be truncated!", mqtt_payload2.length(), PAYLOAD_SIZE);
}
// Try to map sensor ID to name to make MQTT topic explanatory
String sensor_str = sensorName(weatherSensor.sensor[i].sensor_id);
String mqtt_topic_base = Hostname + '/' + sensor_str + '/';
String mqtt_topic;
// sensor data
mqtt_topic = mqtt_topic_base + mqttPubData;
log_i("%s: %s\n", mqtt_topic.c_str(), mqtt_payload.c_str());
client.publish(mqtt_topic, mqtt_payload.substring(0, PAYLOAD_SIZE - 1), retain, 0);
// sensor specific RSSI
mqtt_topic = mqtt_topic_base + mqttPubRssi;
client.publish(mqtt_topic, String(weatherSensor.sensor[i].rssi, 1), false, 0);
// extra data
mqtt_topic = mqttPubExtra;
if (mqtt_payload2.length() > 2)
{
log_i("%s: %s\n", mqtt_topic.c_str(), mqtt_payload2.c_str());
client.publish(mqtt_topic, mqtt_payload2.substring(0, PAYLOAD_SIZE - 1), retain, 0);
}
} // for (int i=0; i<weatherSensor.sensor.size(); i++)
}
// Publish radio receiver info as JSON string via MQTT
// - RSSI: Received Signal Strength Indication
void publishRadio(void)
{
JsonDocument payload;
String mqtt_payload;
payload["rssi"] = weatherSensor.rssi;
serializeJson(payload, mqtt_payload);
log_i("%s: %s\n", mqttPubRadio.c_str(), mqtt_payload.c_str());
client.publish(mqttPubRadio, mqtt_payload, false, 0);
payload.clear();
}
#if defined(AUTO_DISCOVERY)
// Home Assistant Auto-Discovery
void haAutoDiscovery(void)
{
String topic;
for (size_t i = 0; i < weatherSensor.sensor.size(); i++)
{
uint32_t sensor_id = weatherSensor.sensor[i].sensor_id;
if (!weatherSensor.sensor[i].valid)
continue;
String sensor_str = sensorName(weatherSensor.sensor[i].sensor_id);
String topic = Hostname + "/" + sensor_str + "/data";
String rssi = Hostname + "/" + sensor_str + "/rssi";
if ((weatherSensor.sensor[i].s_type == SENSOR_TYPE_WEATHER0) ||
(weatherSensor.sensor[i].s_type == SENSOR_TYPE_WEATHER1) ||
(weatherSensor.sensor[i].s_type == SENSOR_TYPE_WEATHER2))
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Weather Sensor",
.identifier = "weather_sensor_1"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "Outside Temperature", sensor_id, "temperature", "°C", topic.c_str(), "temp_c");
publishAutoDiscovery(info, "Outside Humidity", sensor_id, "humidity", "%", topic.c_str(), "humidity");
if (weatherSensor.sensor[i].w.tglobe_ok)
{
publishAutoDiscovery(info, "Globe Temperature", sensor_id, "temperature", "°C", topic.c_str(), "tglobe_c");
}
if (weatherSensor.sensor[i].w.uv_ok)
{
publishAutoDiscovery(info, "UV Index", sensor_id, NULL, "UV Index", topic.c_str(), "uv");
}
if (weatherSensor.sensor[i].w.light_ok)
{
publishAutoDiscovery(info, "Light Lux", sensor_id, "illuminance", "Lux", topic.c_str(), "light_lux");
}
if (weatherSensor.sensor[i].w.rain_ok)
{
publishAutoDiscovery(info, "Rainfall", sensor_id, "precipitation", "mm", topic.c_str(), "rain");
publishAutoDiscovery(info, "Rainfall Hourly", sensor_id, "precipitation", "mm", topic.c_str(), "rain_h");
publishAutoDiscovery(info, "Rainfall Daily", sensor_id, "precipitation", "mm", topic.c_str(), "rain_d");
publishAutoDiscovery(info, "Rainfall Weekly", sensor_id, "precipitation", "mm", topic.c_str(), "rain_w");
publishAutoDiscovery(info, "Rainfall Monthly", sensor_id, "precipitation", "mm", topic.c_str(), "rain_m");
}
if (weatherSensor.sensor[i].w.wind_ok)
{
publishAutoDiscovery(info, "Wind Direction", sensor_id, NULL, "°", topic.c_str(), "wind_dir");
publishAutoDiscovery(info, "Wind Gust Speed", sensor_id, "wind_speed", "m/s", topic.c_str(), "wind_gust");
publishAutoDiscovery(info, "Wind Average Speed", sensor_id, "wind_speed", "m/s", topic.c_str(), "wind_avg");
String topic = Hostname + "/extra";
publishAutoDiscovery(info, "Wind Gust Speed (Beaufort)", sensor_id, "wind_speed", "Beaufort", topic.c_str(), "wind_gust_bft");
publishAutoDiscovery(info, "Wind Average Speed (Beaufort)", sensor_id, "wind_speed", "Beaufort", topic.c_str(), "wind_avg_bft");
publishAutoDiscovery(info, "Wind Direction (Cardinal)", sensor_id, "enum", "", topic.c_str(), "wind_dir_txt");
}
if (weatherSensor.sensor[i].w.wind_ok &&
weatherSensor.sensor[i].w.temp_ok &&
weatherSensor.sensor[i].w.humidity_ok)
{
String topic = Hostname + "/extra";
publishAutoDiscovery(info, "Dewpoint", sensor_id, "temperature", "°C", topic.c_str(), "dewpoint_c");
publishAutoDiscovery(info, "Perceived Temperature", sensor_id, "temperature", "°C", topic.c_str(), "perceived_temp_c");
if (weatherSensor.sensor[i].w.tglobe_ok)
{
publishAutoDiscovery(info, "WGBT", sensor_id, "temperature", "°C", topic.c_str(), "wgbt");
}
}
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_SOIL)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Soil Sensor",
.identifier = "soil_sensor_1"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "Soil Temperature", sensor_id, "temperature", "°C", topic.c_str(), "temp_c");
publishAutoDiscovery(info, "Soil Moisture", sensor_id, "moisture", "%", topic.c_str(), "moisture");
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_THERMO_HYGRO)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Thermo-Hygrometer Sensor",
.identifier = "thermo_hygrometer_sensor_1"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "Temperature", sensor_id, "temperature", "°C", topic.c_str(), "temp_c");
publishAutoDiscovery(info, "Humidity", sensor_id, "humidity", "%", topic.c_str(), "humidity");
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_POOL_THERMO)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Pool Thermometer",
.identifier = "pool_thermometer_1"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "Pool Temperature", sensor_id, "temperature", "°C", topic.c_str(), "temp_c");
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_AIR_PM)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Air Quality (PM) Sensor",
.identifier = "air_quality_sensor_1"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "PM1.0", sensor_id, "pm1", "µg/m³", topic.c_str(), "pm1_0_ug_m3");
publishAutoDiscovery(info, "PM2.5", sensor_id, "pm25", "µg/m³", topic.c_str(), "pm2_5_ug_m3");
publishAutoDiscovery(info, "PM10", sensor_id, "pm10", "µg/m³", topic.c_str(), "pm10_ug_m3");
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_LIGHTNING)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Lightning Sensor",
.identifier = "lightning_sensor"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "Lightning Count", sensor_id, NULL, "", topic.c_str(), "lightning_count");
publishAutoDiscovery(info, "Lightning Distance", sensor_id, "distance", "km", topic.c_str(), "lightning_distance_km");
publishAutoDiscovery(info, "Lightning Hour", sensor_id, NULL, "", topic.c_str(), "lightning_hr");
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_LEAKAGE)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Leakage Sensor",
.identifier = "leakage_sensor_1"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "Leakage Alarm", sensor_id, "enum", "", topic.c_str(), "leakage");
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_CO2)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "CO2 Sensor",
.identifier = "co2_sensor_1"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "CO2", sensor_id, "co2", "ppm", topic.c_str(), "co2_ppm");
}
else if (weatherSensor.sensor[i].s_type == SENSOR_TYPE_HCHO_VOC)
{
struct sensor_info info = {
.manufacturer = "Bresser",
.model = "Air Quality (HCHO/VOC) Sensor",
.identifier = "air_quality_sensor_2"};
publishAutoDiscovery(info, "Battery", sensor_id, "battery", "%", topic.c_str(), "battery_ok");
publishAutoDiscovery(info, "RSSI", sensor_id, "signal_strength", "dBm", rssi.c_str(), "rssi");
publishAutoDiscovery(info, "HCHO", sensor_id, "hcho", "ppb", topic.c_str(), "hcho_ppb");
publishAutoDiscovery(info, "VOC", sensor_id, "voc", "", topic.c_str(), "voc");
}
} // for (int i=0; i<weatherSensor.sensor.size(); i++)
publishControlDiscovery("Sensor Exclude List", "sensors_exc");
publishControlDiscovery("Sensor Include List", "sensors_inc");
publishStatusDiscovery("Receiver Status", "status");
}
// Publish discovery message for MQTT node status
void publishStatusDiscovery(String name, String topic)
{
String discoveryTopic = "homeassistant/sensor/" + Hostname + "/" + topic + "/config";
String discoveryPayload = R"({
"name": ")" + name + R"(",
"unique_id":")" + Hostname +
"_" + topic + R"(",
"state_topic": ")" + Hostname +
R"(/)" + topic + R"(",
"value_template": "{{ value }}",
"icon": "mdi:wifi",
"device": {
"identifiers": ")" +
Hostname + R"(_1",
"name": "Weather Sensor Receiver"
}
})";
log_d("%s: %s", discoveryTopic.c_str(), discoveryPayload.c_str());
client.publish(discoveryTopic.c_str(), discoveryPayload.c_str(), false, 0);
}
// Publish discovery messages for receiver control
void publishControlDiscovery(String name, String topic)
{
String discoveryTopic = "homeassistant/sensor/" + Hostname + "/" + topic + "/config";
String discoveryPayload = R"({
"name": ")" + name + R"(",
"unique_id":")" + Hostname +
"_" + topic + R"(",
"state_topic": ")" + Hostname +
R"(/)" + topic + R"(",
"value_template": "{{ value_json.ids }}",
"icon": "mdi:code-array",
"device": {
"identifiers": ")" +
Hostname + R"(_1",
"name": "Weather Sensor Receiver"
}
})";
log_d("%s: %s", discoveryTopic.c_str(), discoveryPayload.c_str());
client.publish(discoveryTopic.c_str(), discoveryPayload.c_str(), true, 0);
discoveryTopic = "homeassistant/button/" + Hostname + "/get_" + topic + "/config";
discoveryPayload = R"({
"name": "Get )" +
name + R"(",
"platform": "button",
"unique_id": ")" +
Hostname + "_get_" + topic + R"(",
"command_topic": ")" +
Hostname + "/get_" + topic + R"(",
"icon": "mdi:information",
"retain": true,
"qos": 1,
"device": {
"identifiers": ")" +
Hostname + R"(_1",
"name": "Weather Sensor Receiver"
}
})";
log_d("%s: %s", discoveryTopic.c_str(), discoveryPayload.c_str());
client.publish(discoveryTopic.c_str(), discoveryPayload.c_str(), false, 0);
}
// Publish auto-discovery configuration for Home Assistant
void publishAutoDiscovery(const struct sensor_info info, const char *sensor_name, const uint32_t sensor_id, const char *device_class, const char *unit, const char *state_topic, const char *value_json)
{
JsonDocument doc;
doc["name"] = sensor_name;
if (device_class != NULL)
doc["device_class"] = device_class;
doc["unique_id"] = String(sensor_id, HEX) + String("_") + String(value_json);
doc["state_topic"] = state_topic;
doc["availability_topic"] = Hostname + "/status";
doc["payload_not_available"] = "dead"; // default: "offline"
doc["unit_of_measurement"] = unit;
if (device_class != NULL)
{
if (strcmp(device_class, "battery") == 0)
{
doc["value_template"] = String("{{ (value_json.") + value_json + " | float) * 100.0 }}";
}
else if (strcmp(device_class, "signal_strength") == 0)
{
doc["value_template"] = "{{ value }}";
}
else
{
doc["value_template"] = String("{{ value_json.") + value_json + " }}";
}
}
JsonObject device = doc["device"].to<JsonObject>();
device["identifiers"] = info.identifier;
device["name"] = info.manufacturer + " " + info.model;
if (info.model != "")
device["model"] = info.model;
if (info.manufacturer != "")
device["manufacturer"] = info.manufacturer;
char buffer[512];
serializeJson(doc, buffer);
String topic = String("homeassistant/sensor/") + String(sensor_id, HEX) + "_" + String(value_json) + "/config";
log_d("Publishing auto-discovery configuration: %s: %s", topic.c_str(), buffer);
client.publish(topic, buffer, true /* retained */, 0 /* qos */);
log_d("Published auto-discovery configuration for %s", sensor_name);
}
#endif // AUTO_DISCOVERY

158
BresserWeatherSensorMQTTWifiMgr1/src/mqtt_comm.h Normal file
View File

@@ -0,0 +1,158 @@
///////////////////////////////////////////////////////////////////////////////////////////////////
// mqtt_comm.h
//
// MQTT communication
// Code shared between BresserWeaterSensor<MQTT|MQTTCustom|MQTTWifiMgr>.ino
//
//
// https://github.com/matthias-bs/BresserWeatherSensorReceiver
//
//
// created: 02/2025
//
//
// MIT License
//
// Copyright (c) 2025 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:
//
// 20250221 Created from BresserWeatherSensorMQTT.ino
// 20250226 Added parameter 'retain' to publishWeatherdata()
// 20250227 Added publishControlDiscovery()
//
// ToDo:
// -
//
///////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef MQTT_COMM_H
#define MQTT_COMM_H
#define PAYLOAD_SIZE 300 // maximum MQTT message size
#define AUTO_DISCOVERY // enable Home Assistant auto discovery
#include <Arduino.h>
#include <string>
#include <vector>
#include <time.h>
#include <MQTT.h>
#include <ArduinoJson.h>
#include "WeatherSensorCfg.h"
#include "WeatherSensor.h"
#include "WeatherUtils.h"
#include "RainGauge.h"
#include "Lightning.h"
// 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
#if defined(JSON_FLOAT_AS_STRING)
#define JSON_FLOAT(x) String("\"") + x + String("\"")
#else
#define JSON_FLOAT(x) x
#endif
extern void mqtt_setup(void);
// Sensor information for Home Assistant auto discovery
struct sensor_info
{
String manufacturer;
String model;
String identifier;
};
/*!
* \brief (Re-)Connect to WLAN and connect MQTT broker
*/
//void mqtt_connect(void)
/*!
* \brief MQTT message received callback
*
* \param topic MQTT topic
* \param payload MQTT payload
*/
void messageReceived(String &topic, String &payload);
/*!
* \brief Publish weather data as MQTT message
*
* \param complete Indicate that entire data is complete, regardless of the flags temp_ok/wind_ok/rain_ok
* (which reflect only the state of the last message)
*/
void publishWeatherdata(bool complete = false, bool retain = false);
/*!
* \brief Publish radio receiver info as JSON string via MQTT
*
* Publish RSSI: Received Signal Strength Indication
*/
void publishRadio(void);
#if defined(AUTO_DISCOVERY)
/*!
* \brief Home Assistant Auto-Discovery
*
* Create and publish MQTT messages for Home Assistant auto-discovery.
*/
void haAutoDiscovery(void);
/*!
* \brief Publish auto-discovery configuration for Home Assistant
*
* \param info Sensor information (manufacturer, model, identifier)
* \param sensor_name Sensor name (e.g. "Outside Temperature")
* \param sensor_id Sensor ID (unique)
* \param device_class Device class (e.g. temperature, humidity, etc.)
* \param unit Unit of measurement
* \param state_topic State topic; MQTT topic where sensor data is published
* \param value_json Sensor value in MQTT message JSON string
*/
void publishAutoDiscovery(const struct sensor_info info, const char *sensor_name, const uint32_t sensor_id, const char *device_class, const char *unit, const char *state_topic, const char *value_json);
/*!
* \brief Publish Home Assistant auto discovery for MQTT node status
*
* \param name Control name
* \param topic MQTT topic
*/
void publishStatusDiscovery(String name, String topic);
/*!
* \brief Publish Home Assistant auto discovery for receiver control
*
* \param name Control name
* \param topic MQTT topic
*/
void publishControlDiscovery(String name, String topic);
#endif // AUTO_DISCOVERY
#endif // MQTT_COMM_H