agessaman
80355f32ab
Implemented a new fault alert system that broadcasts notifications over LoRa when WiFi or MQTT connections are down for a specified duration. The alerts are configurable via CLI commands, allowing operators to set private PSKs or hashtags for alert channels. Default settings for alert thresholds and intervals are established, and the system ensures that alerts do not spam the public channel. Updated relevant files to integrate this feature into the MyMesh implementations and CLI handling.
90 lines
2.9 KiB
C++
90 lines
2.9 KiB
C++
#pragma once
|
|
|
|
#include <Arduino.h>
|
|
#include <Mesh.h>
|
|
#include "CommonCLI.h"
|
|
|
|
#ifdef WITH_MQTT_BRIDGE
|
|
#include "bridges/MQTTBridge.h"
|
|
#endif
|
|
|
|
/**
|
|
* \brief Send-only group-channel "fault alert" reporter for repeater/observer
|
|
* builds.
|
|
*
|
|
* Polls WiFi and per-MQTT-slot outage timers from MQTTBridge. When any timer
|
|
* exceeds its configured threshold, floods a single PAYLOAD_TYPE_GRP_TXT
|
|
* message on the configured alert channel ("WiFi down 47m — MyObserver"),
|
|
* then arms a "recovered" message for the next state transition.
|
|
*
|
|
* The alert channel must be explicitly configured to either a private base64
|
|
* PSK (`set alert.psk`) or a hashtag name (`set alert.hashtag`); the
|
|
* well-known PUBLIC group key is rejected on purpose, since fault alerts
|
|
* would otherwise spam every node subscribed to the default Public channel.
|
|
*
|
|
* Edge-triggered + rate-limited via NodePrefs::alert_min_interval_min so a
|
|
* flapping link cannot spam the channel.
|
|
*
|
|
* Designed to compile and run on any repeater build:
|
|
* - The channel-send path uses only mesh::Mesh primitives that already
|
|
* exist in the Dispatcher hierarchy (createGroupDatagram + sendFlood).
|
|
* - WiFi/MQTT polling is #ifdef WITH_MQTT_BRIDGE-gated; without it, the
|
|
* reporter still supports manual `alert test` sends.
|
|
*/
|
|
class AlertReporter {
|
|
public:
|
|
AlertReporter();
|
|
|
|
/**
|
|
* Wire up the reporter. Must be called from MyMesh::begin() after prefs
|
|
* are loaded. \a node_name is captured by reference so subsequent rename
|
|
* (set name) is reflected automatically.
|
|
*/
|
|
void begin(NodePrefs* prefs, mesh::Mesh* mesh);
|
|
|
|
#ifdef WITH_MQTT_BRIDGE
|
|
/** Bridge can be (re)created lazily; pass nullptr to detach. */
|
|
void setBridge(MQTTBridge* bridge);
|
|
#endif
|
|
|
|
/**
|
|
* Re-derive the cached GroupChannel from \a alert_psk_b64. Call from the
|
|
* CLI hot-reload hook after `set alert.psk` / `set alert.hashtag` / `set alert on|off`.
|
|
*/
|
|
void onConfigChanged();
|
|
|
|
/**
|
|
* Cooperative tick. Fast: returns immediately if disabled, throttled
|
|
* internally to ~5 s checks. Safe to call every loop().
|
|
*/
|
|
void onLoop(unsigned long now_ms);
|
|
|
|
/**
|
|
* Send an arbitrary text immediately (used by `alert test` CLI). Returns
|
|
* false when disabled, PSK invalid, or the underlying flood-send fails.
|
|
* Bypasses the rate limiter and edge logic.
|
|
*/
|
|
bool sendText(const char* text);
|
|
|
|
private:
|
|
bool resolveChannel(mesh::GroupChannel& out) const;
|
|
bool sendChannel(const char* text);
|
|
void formatAge(unsigned long age_ms, char* out, size_t out_size) const;
|
|
|
|
enum FaultState { OK, FIRING };
|
|
struct Fault {
|
|
FaultState state;
|
|
unsigned long fired_at_ms; // millis() when we last sent a "down" alert
|
|
unsigned long last_outage_started_ms; // remembered so the recovered msg can quote duration
|
|
};
|
|
|
|
NodePrefs* _prefs;
|
|
mesh::Mesh* _mesh;
|
|
#ifdef WITH_MQTT_BRIDGE
|
|
MQTTBridge* _bridge;
|
|
Fault _wifi;
|
|
Fault _mqtt[RUNTIME_MQTT_SLOTS];
|
|
#endif
|
|
unsigned long _next_check_ms;
|
|
};
|