Files
firmware/src/MessageStore.h

127 lines
4.4 KiB
C
Raw Normal View History

#pragma once
2025-10-06 12:29:43 -04:00
#if HAS_SCREEN
2025-10-10 09:34:43 -05:00
// Disable debug logging entirely on release builds of HELTEC_MESH_SOLAR for space constraints
#if defined(HELTEC_MESH_SOLAR)
#define LOG_DEBUG(...)
#endif
2025-10-13 03:21:37 -04:00
// Enable or disable message persistence (flash storage)
// Define -DENABLE_MESSAGE_PERSISTENCE=0 in build_flags to disable it entirely
2025-10-06 12:29:43 -04:00
#ifndef ENABLE_MESSAGE_PERSISTENCE
#define ENABLE_MESSAGE_PERSISTENCE 1
#endif
#include "mesh/generated/meshtastic/mesh.pb.h"
#include <cstdint>
#include <deque>
#include <string>
2025-10-13 03:21:37 -04:00
// how many messages are stored (RAM + flash).
// Define -DMESSAGE_HISTORY_LIMIT=N in build_flags to control memory usage.
#ifndef MESSAGE_HISTORY_LIMIT
#define MESSAGE_HISTORY_LIMIT 20
2025-10-12 16:24:40 -04:00
#endif
2025-10-12 22:36:15 -04:00
2025-10-13 03:21:37 -04:00
// Internal alias used everywhere in code do NOT redefine elsewhere.
#define MAX_MESSAGES_SAVED MESSAGE_HISTORY_LIMIT
// Maximum text payload size per message in bytes (fixed).
2025-10-12 22:36:15 -04:00
#define MAX_MESSAGE_SIZE 220
// Explicit message classification
enum class MessageType : uint8_t { BROADCAST = 0, DM_TO_US = 1 };
2025-09-26 16:51:09 -04:00
// Delivery status for messages we sent
enum class AckStatus : uint8_t {
2025-09-28 00:58:48 -04:00
NONE = 0, // just sent, waiting (no symbol shown)
ACKED = 1, // got a valid ACK from destination
2025-09-26 16:51:09 -04:00
NACKED = 2, // explicitly failed
2025-09-28 00:58:48 -04:00
TIMEOUT = 3, // no ACK after retry window
RELAYED = 4 // got an ACK from relay, not destination
2025-09-26 16:51:09 -04:00
};
2025-10-13 03:21:37 -04:00
// A single stored message in RAM and/or flash
struct StoredMessage {
uint32_t timestamp; // When message was created (secs since boot/RTC)
uint32_t sender; // NodeNum of sender
uint8_t channelIndex; // Channel index used
char text[MAX_MESSAGE_SIZE]; // fixed buffer for message text
// Destination node.
uint32_t dest;
// Explicit classification (derived from dest when loading old messages)
MessageType type;
2025-09-23 01:05:22 -04:00
// Marks whether the timestamp was stored relative to boot time
// (true = millis()/1000 fallback, false = epoch/RTC absolute)
bool isBootRelative;
2025-09-26 16:51:09 -04:00
// Delivery status (only meaningful for our own sent messages)
AckStatus ackStatus;
2025-09-23 01:05:22 -04:00
// Default constructor to initialize all fields safely
StoredMessage()
: timestamp(0), sender(0), channelIndex(0), text(""), dest(0xffffffff), type(MessageType::BROADCAST),
2025-09-28 00:58:48 -04:00
isBootRelative(false), ackStatus(AckStatus::NONE) // start as NONE (waiting, no symbol)
2025-09-23 01:05:22 -04:00
{
}
};
class MessageStore
{
public:
explicit MessageStore(const std::string &label);
// Live RAM methods (always current, used by UI and runtime)
2025-10-12 16:24:40 -04:00
void addLiveMessage(StoredMessage &&msg);
2025-10-12 22:36:15 -04:00
void addLiveMessage(const StoredMessage &msg); // convenience overload
const std::deque<StoredMessage> &getLiveMessages() const { return liveMessages; }
// Persistence methods (used only on boot/shutdown)
2025-10-12 16:24:40 -04:00
void addMessage(StoredMessage &&msg);
2025-10-12 22:36:15 -04:00
void addMessage(const StoredMessage &msg); // convenience overload
const StoredMessage &addFromPacket(const meshtastic_MeshPacket &mp); // Incoming/outgoing → RAM only
void addFromString(uint32_t sender, uint8_t channelIndex, const std::string &text);
void saveToFlash();
void loadFromFlash();
// Clear all messages (RAM + persisted queue)
void clearAllMessages();
// Dismiss helpers
void dismissOldestMessage();
2025-09-28 01:31:32 -04:00
// New targeted dismiss helpers
void dismissOldestMessageInChannel(uint8_t channel);
void dismissOldestMessageWithPeer(uint32_t peer);
// Unified accessor (for UI code, defaults to RAM buffer)
const std::deque<StoredMessage> &getMessages() const { return liveMessages; }
// Optional: direct access to persisted copy (mainly for debugging/inspection)
const std::deque<StoredMessage> &getPersistedMessages() const { return messages; }
// Helper filters for future use
std::deque<StoredMessage> getChannelMessages(uint8_t channel) const;
std::deque<StoredMessage> getDirectMessages() const;
2025-09-23 01:05:22 -04:00
// Upgrade boot-relative timestamps once RTC is valid
void upgradeBootRelativeTimestamps();
2025-09-29 20:10:05 -04:00
// Debug helper to log serialized size of messages
void logMemoryUsage(const char *context) const;
private:
2025-10-13 03:21:37 -04:00
std::deque<StoredMessage> liveMessages; // current in-RAM messages
std::deque<StoredMessage> messages; // persisted copy on flash
std::string filename; // flash filename for persistence
};
// Global instance (defined in MessageStore.cpp)
2025-09-28 00:58:48 -04:00
extern MessageStore messageStore;
2025-10-06 12:29:43 -04:00
#endif