Canned Messages via InkHUD menu (#7096)

* Allow observers to respond to AdminMessage requests
Ground work for CannedMessage getters and setters

* Enable CannedMessage config in apps for InkHUD devices

* Migrate the InkHUD::Events AdminModule observer
Use the new AdminModule_ObserverData struct

* Bare-bones NicheGraphics util to access canned messages
Handles loading and parsing. Handle admin messages for setting and getting.

* Send canned messages via on-screen menu

* Change ThreadedMessageApplet from Observer to Module API
Allows us to intercept locally generated packets ('loopbackOK = true'), to handle outgoing canned messages.

* Fix: crash getting empty canned message string via Client API

* Move file into Utils subdir

* Move an include statement from .cpp to .h

* Limit strncpy size of dest, not source
Wasn't critical in ths specific case, but definitely a mistake.

src/graphics/niche/InkHUD/Applets/System/Menu/MenuAction.h

@@ -19,6 +19,8 @@ namespace NicheGraphics::InkHUD
 enum MenuAction {
     NO_ACTION,
     SEND_PING,
+    STORE_CANNEDMESSAGE_SELECTION,
+    SEND_CANNEDMESSAGE,
     SHUTDOWN,
     NEXT_TILE,
     TOGGLE_BACKLIGHT,

src/graphics/niche/InkHUD/Applets/System/Menu/MenuApplet.cpp

@@ -5,6 +5,7 @@
 #include "RTC.h"
 
 #include "MeshService.h"
+#include "Router.h"
 #include "airtime.h"
 #include "main.h"
 #include "power.h"
@@ -31,6 +32,12 @@ InkHUD::MenuApplet::MenuApplet() : concurrency::OSThread("MenuApplet")
     if (settings->optionalMenuItems.backlight) {
         backlight = Drivers::LatchingBacklight::getInstance();
     }
+
+    // Initialize the Canned Message store
+    // This is a shared nicheGraphics component
+    // - handles loading & parsing the canned messages
+    // - handles setting / getting of canned messages via apps (Client API Admin Messages)
+    cm.store = CannedMessageStore::getInstance();
 }
 
 void InkHUD::MenuApplet::onForeground()
@@ -65,6 +72,10 @@ void InkHUD::MenuApplet::onForeground()
 
 void InkHUD::MenuApplet::onBackground()
 {
+    // Discard any data we generated while selecting a canned message
+    // Frees heap mem
+    freeCannedMessageResources();
+
     // If device has a backlight which isn't controlled by aux button:
     // Item in options submenu allows keeping backlight on after menu is closed
     // If this item is deselected we will turn backlight off again, now that menu is closing
@@ -153,6 +164,16 @@ void InkHUD::MenuApplet::execute(MenuItem item)
         inkhud->forceUpdate(Drivers::EInk::UpdateTypes::FULL);
         break;
 
+    case STORE_CANNEDMESSAGE_SELECTION:
+        cm.selectedMessageItem = &cm.messageItems.at(cursor - 1); // Minus one: offset for the initial "Send Ping" entry
+        break;
+
+    case SEND_CANNEDMESSAGE:
+        cm.selectedRecipientItem = &cm.recipientItems.at(cursor);
+        sendText(cm.selectedRecipientItem->dest, cm.selectedRecipientItem->channelIndex, cm.selectedMessageItem->rawText.c_str());
+        inkhud->forceUpdate(Drivers::EInk::UpdateTypes::FULL); // Next refresh should be FULL. Lots of button pressing to get here
+        break;
+
     case ROTATE:
         inkhud->rotate();
         break;
@@ -260,9 +281,11 @@ void InkHUD::MenuApplet::showPage(MenuPage page)
         break;
 
     case SEND:
-        items.push_back(MenuItem("Ping", MenuAction::SEND_PING, MenuPage::EXIT));
-        // Todo: canned messages
-        items.push_back(MenuItem("Exit", MenuPage::EXIT));
+        populateSendPage();
+        break;
+
+    case CANNEDMESSAGE_RECIPIENT:
+        populateRecipientPage();
         break;
 
     case OPTIONS:
@@ -497,6 +520,8 @@ void InkHUD::MenuApplet::populateAutoshowPage()
     }
 }
 
+// Create MenuItem entries to select our definition of "Recent"
+// Controls how long data will remain in any "Recents" flavored applets
 void InkHUD::MenuApplet::populateRecentsPage()
 {
     // How many values are shown for use to choose from
@@ -510,6 +535,112 @@ void InkHUD::MenuApplet::populateRecentsPage()
     }
 }
 
+// MenuItem entries for the "send" page
+// Dynamically creates menu items based on available canned messages
+void InkHUD::MenuApplet::populateSendPage()
+{
+    // Position / NodeInfo packet
+    items.push_back(MenuItem("Ping", MenuAction::SEND_PING, MenuPage::EXIT));
+
+    // One menu item for each canned message
+    uint8_t count = cm.store->size();
+    for (uint8_t i = 0; i < count; i++) {
+        // Gather the information for this item
+        CannedMessages::MessageItem messageItem;
+        messageItem.rawText = cm.store->at(i);
+        messageItem.label = parse(messageItem.rawText);
+
+        // Store the item (until the menu closes)
+        cm.messageItems.push_back(messageItem);
+
+        // Create a menu item
+        const char *itemText = cm.messageItems.back().label.c_str();
+        items.push_back(MenuItem(itemText, MenuAction::STORE_CANNEDMESSAGE_SELECTION, MenuPage::CANNEDMESSAGE_RECIPIENT));
+    }
+
+    items.push_back(MenuItem("Exit", MenuPage::EXIT));
+}
+
+// Dynamically create MenuItem entries for possible canned message destinations
+// All available channels are shown
+// Favorite nodes are shown, provided we don't have an *excessive* amount
+void InkHUD::MenuApplet::populateRecipientPage()
+{
+    // Create recipient data (and menu items) for any channels
+    // --------------------------------------------------------
+
+    for (uint8_t i = 0; i < MAX_NUM_CHANNELS; i++) {
+        // Get the channel, and check if it's enabled
+        meshtastic_Channel &channel = channels.getByIndex(i);
+        if (!channel.has_settings || channel.role == meshtastic_Channel_Role_DISABLED)
+            continue;
+
+        CannedMessages::RecipientItem r;
+
+        // Set index
+        r.channelIndex = channel.index;
+
+        // Set a label for the menu item
+        r.label = "Ch " + to_string(i) + ": ";
+        if (channel.role == meshtastic_Channel_Role_PRIMARY)
+            r.label += "Primary";
+        else
+            r.label += parse(channel.settings.name);
+
+        // Add to the list of recipients
+        cm.recipientItems.push_back(r);
+
+        // Add a menu item for this recipient
+        const char *itemText = cm.recipientItems.back().label.c_str();
+        items.push_back(MenuItem(itemText, SEND_CANNEDMESSAGE, MenuPage::EXIT));
+    }
+
+    // Create recipient data (and menu items) for favorite nodes
+    // ---------------------------------------------------------
+
+    uint32_t nodeCount = nodeDB->getNumMeshNodes();
+    uint32_t favoriteCount = 0;
+
+    // Count favorites
+    for (uint32_t i = 0; i < nodeCount; i++) {
+        if (nodeDB->getMeshNodeByIndex(i)->is_favorite)
+            favoriteCount++;
+    }
+
+    // Only add favorites if the number is reasonable
+    // Don't want some monstrous list that takes 100 clicks to reach exit
+    if (favoriteCount < 20) {
+        for (uint32_t i = 0; i < nodeCount; i++) {
+            meshtastic_NodeInfoLite *node = nodeDB->getMeshNodeByIndex(i);
+
+            // Skip node if not a favorite
+            if (!node->is_favorite)
+                continue;
+
+            CannedMessages::RecipientItem r;
+
+            r.dest = node->num;
+            r.channelIndex = nodeDB->getMeshNodeChannel(node->num); // Channel index only relevant if encrypted DM not possible(?)
+
+            // Set a label for the menu item
+            r.label = "DM: ";
+            if (node->has_user)
+                r.label += parse(node->user.long_name);
+            else
+                r.label += hexifyNodeNum(node->num); // Unsure if it's possible to favorite a node without NodeInfo?
+
+            // Add to the list of recipients
+            cm.recipientItems.push_back(r);
+
+            // Add a menu item for this recipient
+            const char *itemText = cm.recipientItems.back().label.c_str();
+            items.push_back(MenuItem(itemText, SEND_CANNEDMESSAGE, MenuPage::EXIT));
+        }
+    }
+
+    items.push_back(MenuItem("Exit", MenuPage::EXIT));
+}
+
 // Renders the panel shown at the top of the root menu.
 // Displays the clock, and several other pieces of instantaneous system info,
 // which we'd prefer not to have displayed in a normal applet, as they update too frequently.
@@ -619,4 +750,37 @@ uint16_t InkHUD::MenuApplet::getSystemInfoPanelHeight()
     return height;
 }
 
+// Send a text message to the mesh
+// Used to send our canned messages
+void InkHUD::MenuApplet::sendText(NodeNum dest, ChannelIndex channel, const char *message)
+{
+    meshtastic_MeshPacket *p = router->allocForSending();
+    p->decoded.portnum = meshtastic_PortNum_TEXT_MESSAGE_APP;
+    p->to = dest;
+    p->channel = channel;
+    p->want_ack = true;
+    p->decoded.payload.size = strlen(message);
+    memcpy(p->decoded.payload.bytes, message, p->decoded.payload.size);
+
+    // Tack on a bell character if requested
+    if (moduleConfig.canned_message.send_bell && p->decoded.payload.size < meshtastic_Constants_DATA_PAYLOAD_LEN) {
+        p->decoded.payload.bytes[p->decoded.payload.size] = 7;        // Bell character
+        p->decoded.payload.bytes[p->decoded.payload.size + 1] = '\0'; // Append Null Terminator
+        p->decoded.payload.size++;
+    }
+
+    LOG_INFO("Send message id=%d, dest=%x, msg=%.*s", p->id, p->to, p->decoded.payload.size, p->decoded.payload.bytes);
+
+    service->sendToMesh(p, RX_SRC_LOCAL, true); // Send to mesh, cc to phone
+}
+
+// Free up any heap mmemory we'd used while selecting / sending canned messages
+void InkHUD::MenuApplet::freeCannedMessageResources()
+{
+    cm.selectedMessageItem = nullptr;
+    cm.selectedRecipientItem = nullptr;
+    cm.messageItems.clear();
+    cm.recipientItems.clear();
+}
+
 #endif

src/graphics/niche/InkHUD/Applets/System/Menu/MenuApplet.h

@@ -6,10 +6,12 @@
 #include "graphics/niche/InkHUD/InkHUD.h"
 #include "graphics/niche/InkHUD/Persistence.h"
 #include "graphics/niche/InkHUD/SystemApplet.h"
+#include "graphics/niche/Utils/CannedMessageStore.h"
 
 #include "./MenuItem.h"
 #include "./MenuPage.h"
 
+#include "Channels.h"
 #include "concurrency/OSThread.h"
 
 namespace NicheGraphics::InkHUD
@@ -36,12 +38,18 @@ class MenuApplet : public SystemApplet, public concurrency::OSThread
 
     void execute(MenuItem item);  // Perform the MenuAction associated with a MenuItem, if any
     void showPage(MenuPage page); // Load and display a MenuPage
+
+    void populateSendPage();      // Dynamically create MenuItems including canned messages
+    void populateRecipientPage(); // Dynamically create a page of possible destinations for a canned message
     void populateAppletPage();    // Dynamically create MenuItems for toggling loaded applets
     void populateAutoshowPage();  // Dynamically create MenuItems for selecting which applets can autoshow
     void populateRecentsPage();   // Create menu items: a choice of values for settings.recentlyActiveSeconds
+
     uint16_t getSystemInfoPanelHeight();
     void drawSystemInfoPanel(int16_t left, int16_t top, uint16_t width,
-                             uint16_t *height = nullptr); // Info panel at top of root menu
+                             uint16_t *height = nullptr);                   // Info panel at top of root menu
+    void sendText(NodeNum dest, ChannelIndex channel, const char *message); // Send a text message to mesh
+    void freeCannedMessageResources();                                      // Clear MenuApplet's canned message processing data
 
     MenuPage currentPage = MenuPage::ROOT;
     uint8_t cursor = 0;       // Which menu item is currently highlighted
@@ -51,6 +59,37 @@ class MenuApplet : public SystemApplet, public concurrency::OSThread
 
     std::vector<MenuItem> items; // MenuItems for the current page. Filled by ShowPage
 
+    // Data for selecting and sending canned messages via the menu
+    // Placed into a sub-class for organization only
+    class CannedMessages
+    {
+      public:
+        // Share NicheGraphics component
+        // Handles loading, getting, setting
+        CannedMessageStore *store;
+
+        // One canned message
+        // Links the menu item to the true message text
+        struct MessageItem {
+            std::string label;   // Shown in menu. Prefixed, and UTF-8 chars parsed
+            std::string rawText; // The message which will be sent, if this item is selected
+        } *selectedMessageItem;
+
+        // One possible destination for a canned message
+        // Links the menu item to the intended recipient
+        // May represent either broadcast or DM
+        struct RecipientItem {
+            std::string label; // Shown in menu
+            NodeNum dest = NODENUM_BROADCAST;
+            uint8_t channelIndex = 0;
+        } *selectedRecipientItem;
+
+        // These lists are generated when the menu page is populated
+        // Cleared onBackground (when MenuApplet closes)
+        std::vector<MessageItem> messageItems;
+        std::vector<RecipientItem> recipientItems;
+    } cm;
+
     Applet *borrowedTileOwner = nullptr; // Which applet we have temporarily replaced while displaying menu
 };
 

src/graphics/niche/InkHUD/Applets/System/Menu/MenuPage.h

@@ -18,6 +18,7 @@ namespace NicheGraphics::InkHUD
 enum MenuPage : uint8_t {
     ROOT, // Initial menu page
     SEND,
+    CANNEDMESSAGE_RECIPIENT, // Select destination for a canned message
     OPTIONS,
     APPLETS,
     AUTOSHOW,

src/graphics/niche/InkHUD/Applets/User/ThreadedMessage/ThreadedMessageApplet.cpp

@@ -13,7 +13,8 @@ using namespace NicheGraphics;
 constexpr uint8_t MAX_MESSAGES_SAVED = 10;
 constexpr uint32_t MAX_MESSAGE_SIZE = 250;
 
-InkHUD::ThreadedMessageApplet::ThreadedMessageApplet(uint8_t channelIndex) : channelIndex(channelIndex)
+InkHUD::ThreadedMessageApplet::ThreadedMessageApplet(uint8_t channelIndex)
+    : SinglePortModule("ThreadedMessageApplet", meshtastic_PortNum_TEXT_MESSAGE_APP), channelIndex(channelIndex)
 {
     // Create the message store
     // Will shortly attempt to load messages from RAM, if applet is active
@@ -69,9 +70,8 @@ void InkHUD::ThreadedMessageApplet::onRender()
 
         // Grab data for message
         MessageStore::Message &m = store->messages.at(i);
-        bool outgoing = (m.sender == 0);
-        meshtastic_NodeInfoLite *sender = nodeDB->getMeshNode(m.sender);
-        std::string bodyText = parse(m.text); // Parse any non-ascii chars in the message
+        bool outgoing = (m.sender == 0) || (m.sender == myNodeInfo.my_node_num); // Own NodeNum if canned message
+        std::string bodyText = parse(m.text);                                    // Parse any non-ascii chars in the message
 
         // Cache bottom Y of message text
         // - Used when drawing vertical line alongside
@@ -171,54 +171,54 @@ void InkHUD::ThreadedMessageApplet::onRender()
 void InkHUD::ThreadedMessageApplet::onActivate()
 {
     loadMessagesFromFlash();
-    textMessageObserver.observe(textMessageModule); // Begin handling any new text messages with onReceiveTextMessage
+    loopbackOk = true; // Allow us to handle messages generated on the node (canned messages)
 }
 
 // Code which runs when the applet stop running
-// This might be happen at shutdown, or if user disables the applet at run-time
+// This might be at shutdown, or if the user disables the applet at run-time, via the menu
 void InkHUD::ThreadedMessageApplet::onDeactivate()
 {
-    textMessageObserver.unobserve(textMessageModule); // Stop handling any new text messages with onReceiveTextMessage
+    loopbackOk = false; // Slightly reduce our impact if the applet is disabled
 }
 
 // Handle new text messages
 // These might be incoming, from the mesh, or outgoing from phone
 // Each instance of the ThreadMessageApplet will only listen on one specific channel
-// Method should return 0, to indicate general success to TextMessageModule
-int InkHUD::ThreadedMessageApplet::onReceiveTextMessage(const meshtastic_MeshPacket *p)
+ProcessMessage InkHUD::ThreadedMessageApplet::handleReceived(const meshtastic_MeshPacket &mp)
 {
     // Abort if applet fully deactivated
-    // Already handled by onActivate and onDeactivate, but good practice for all applets
     if (!isActive())
-        return 0;
+        return ProcessMessage::CONTINUE;
 
     // Abort if wrong channel
-    if (p->channel != this->channelIndex)
-        return 0;
+    if (mp.channel != this->channelIndex)
+        return ProcessMessage::CONTINUE;
 
     // Abort if message was a DM
-    if (p->to != NODENUM_BROADCAST)
-        return 0;
+    if (mp.to != NODENUM_BROADCAST)
+        return ProcessMessage::CONTINUE;
 
     // Extract info into our slimmed-down "StoredMessage" type
     MessageStore::Message newMessage;
     newMessage.timestamp = getValidTime(RTCQuality::RTCQualityDevice, true); // Current RTC time
-    newMessage.sender = p->from;
-    newMessage.channelIndex = p->channel;
-    newMessage.text = std::string(&p->decoded.payload.bytes[0], &p->decoded.payload.bytes[p->decoded.payload.size]);
+    newMessage.sender = mp.from;
+    newMessage.channelIndex = mp.channel;
+    newMessage.text = std::string((const char *)mp.decoded.payload.bytes, mp.decoded.payload.size);
 
     // Store newest message at front
     // These records are used when rendering, and also stored in flash at shutdown
     store->messages.push_front(newMessage);
 
     // If this was an incoming message, suggest that our applet becomes foreground, if permitted
-    if (getFrom(p) != nodeDB->getNodeNum())
+    if (getFrom(&mp) != nodeDB->getNodeNum())
         requestAutoshow();
 
     // Redraw the applet, perhaps.
     requestUpdate(); // Want to update display, if applet is foreground
 
-    return 0;
+    // Tell Module API to continue informing other firmware components about this message
+    // We're not the only component which is interested in new text messages
+    return ProcessMessage::CONTINUE;
 }
 
 // Don't show notifications for text messages broadcast to our channel, when the applet is displayed

src/graphics/niche/InkHUD/Applets/User/ThreadedMessage/ThreadedMessageApplet.h

@@ -30,7 +30,7 @@ namespace NicheGraphics::InkHUD
 
 class Applet;
 
-class ThreadedMessageApplet : public Applet
+class ThreadedMessageApplet : public Applet, public SinglePortModule
 {
   public:
     explicit ThreadedMessageApplet(uint8_t channelIndex);
@@ -41,16 +41,11 @@ class ThreadedMessageApplet : public Applet
     void onActivate() override;
     void onDeactivate() override;
     void onShutdown() override;
-    int onReceiveTextMessage(const meshtastic_MeshPacket *p);
+    ProcessMessage handleReceived(const meshtastic_MeshPacket &mp) override;
 
     bool approveNotification(Notification &n) override; // Which notifications to suppress
 
   protected:
-    // Used to register our text message callback
-    CallbackObserver<ThreadedMessageApplet, const meshtastic_MeshPacket *> textMessageObserver =
-        CallbackObserver<ThreadedMessageApplet, const meshtastic_MeshPacket *>(this,
-                                                                               &ThreadedMessageApplet::onReceiveTextMessage);
-
     void saveMessagesToFlash();
     void loadMessagesFromFlash();