Files
firmware/src/MessageStore.h

114 lines
3.8 KiB
C
Raw Normal View History

#pragma once
2025-10-06 12:29:43 -04:00
#if HAS_SCREEN
// Disable message persistence to flash if youre short on space
#ifndef ENABLE_MESSAGE_PERSISTENCE
#define ENABLE_MESSAGE_PERSISTENCE 1
#endif
#include "mesh/generated/meshtastic/mesh.pb.h"
#include <cstdint>
#include <deque>
#include <string>
// Max number of messages well keep in history
constexpr size_t MAX_MESSAGES_SAVED = 20;
constexpr size_t MAX_MESSAGE_SIZE = 220; // safe bound for text payload
// 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
};
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
std::string text; // UTF-8 text payload
// Destination node.
// 0xffffffff (NODENUM_BROADCAST) means broadcast,
// otherwise this is the NodeNum of the DM recipient.
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)
void addLiveMessage(const StoredMessage &msg);
const std::deque<StoredMessage> &getLiveMessages() const { return liveMessages; }
// Persistence methods (used only on boot/shutdown)
void addMessage(const StoredMessage &msg);
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();
void dismissNewestMessage();
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;
std::deque<StoredMessage> getConversationWith(uint32_t peer) 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:
std::deque<StoredMessage> liveMessages;
std::deque<StoredMessage> messages; // persisted copy
std::string filename;
};
// 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