Canned message usability improvements

src/graphics/Screen.cpp

@@ -45,6 +45,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "mesh/generated/meshtastic/deviceonly.pb.h"
 #include "meshUtils.h"
 #include "modules/AdminModule.h"
+#include "modules/CannedMessageModule.h"
 #include "modules/ExternalNotificationModule.h"
 #include "modules/TextMessageModule.h"
 #include "sleep.h"
@@ -2314,9 +2315,17 @@ void Screen::handleOnPress()
 {
     // If Canned Messages is using the "Scan and Select" input, dismiss the canned message frame when user button is pressed
     // Minimize impact as a courtesy, as "scan and select" may be used as default config for some boards
-    if (scanAndSelectInput != nullptr && scanAndSelectInput->dismissCannedMessageFrame())
+    // (Fall-through if using auto carousel, to prevent unexpected closing of canned message frame)
+    if (scanAndSelectInput != nullptr && !config.display.auto_screen_carousel_secs &&
+        scanAndSelectInput->dismissCannedMessageFrame())
         return;
 
+    // Don't transition away from canned messages if it is active
+    if (cannedMessageModule->shouldDraw()) {
+        lastScreenTransition = millis();
+        return;
+    }
+
     // If screen was off, just wake it, otherwise advance to next frame
     // If we are in a transition, the press must have bounced, drop it.
     if (ui->getUiState()->frameState == FIXED) {

src/modules/CannedMessageModule.cpp

@@ -360,12 +360,9 @@ int CannedMessageModule::handleInputEvent(const InputEvent *event)
     if (validEvent) {
         requestFocus(); // Tell Screen::setFrames to move to our module's frame, next time it runs
 
-        // Let runOnce to be called immediately.
-        if (this->runState == CANNED_MESSAGE_RUN_STATE_ACTION_SELECT) {
-            setIntervalFromNow(0); // on fast keypresses, this isn't fast enough.
-        } else {
-            runOnce();
-        }
+        // Run CannedMessageModule thread now from callee thread context,
+        // and also schedule it to run later in its own context with the requested delay.
+        setIntervalFromNow(runOnce());
     }
 
     return 0;
@@ -409,25 +406,18 @@ int32_t CannedMessageModule::runOnce()
     if ((this->runState == CANNED_MESSAGE_RUN_STATE_SENDING_ACTIVE) ||
         (this->runState == CANNED_MESSAGE_RUN_STATE_ACK_NACK_RECEIVED) || (this->runState == CANNED_MESSAGE_RUN_STATE_MESSAGE)) {
         // TODO: might have some feedback of sending state
-        this->runState = CANNED_MESSAGE_RUN_STATE_INACTIVE;
+        if (this->runState == CANNED_MESSAGE_RUN_STATE_SENDING_ACTIVE) {
+            this->restoreOldState = CANNED_MESSAGE_RUN_STATE_INACTIVE;
+        }
+        this->runState = this->restoreOldState;
         temporaryMessage = "";
         e.action = UIFrameEvent::Action::REGENERATE_FRAMESET; // We want to change the list of frames shown on-screen
-        this->currentMessageIndex = -1;
-        this->freetext = ""; // clear freetext
-        this->cursor = 0;
-
-#if !defined(T_WATCH_S3) && !defined(RAK14014)
-        this->destSelect = CANNED_MESSAGE_DESTINATION_TYPE_NONE;
-#endif
-
         this->notifyObservers(&e);
     } else if (((this->runState == CANNED_MESSAGE_RUN_STATE_ACTIVE) || (this->runState == CANNED_MESSAGE_RUN_STATE_FREETEXT)) &&
-               ((millis() - this->lastTouchMillis) > INACTIVATE_AFTER_MS)) {
-        // Reset module
+               ((millis() - this->lastTouchMillis) >= INACTIVATE_AFTER_MS)) {
+        // Don't reset module, just hide the frame
         e.action = UIFrameEvent::Action::REGENERATE_FRAMESET; // We want to change the list of frames shown on-screen
         this->currentMessageIndex = -1;
-        this->freetext = ""; // clear freetext
-        this->cursor = 0;
 
 #if !defined(T_WATCH_S3) && !defined(RAK14014)
         this->destSelect = CANNED_MESSAGE_DESTINATION_TYPE_NONE;
@@ -480,8 +470,6 @@ int32_t CannedMessageModule::runOnce()
     } else if (this->runState == CANNED_MESSAGE_RUN_STATE_ACTION_UP) {
         if (this->messagesCount > 0) {
             this->currentMessageIndex = getPrevIndex();
-            this->freetext = ""; // clear freetext
-            this->cursor = 0;
 
 #if !defined(T_WATCH_S3) && !defined(RAK14014)
             this->destSelect = CANNED_MESSAGE_DESTINATION_TYPE_NONE;
@@ -493,8 +481,6 @@ int32_t CannedMessageModule::runOnce()
     } else if (this->runState == CANNED_MESSAGE_RUN_STATE_ACTION_DOWN) {
         if (this->messagesCount > 0) {
             this->currentMessageIndex = this->getNextIndex();
-            this->freetext = ""; // clear freetext
-            this->cursor = 0;
 
 #if !defined(T_WATCH_S3) && !defined(RAK14014)
             this->destSelect = CANNED_MESSAGE_DESTINATION_TYPE_NONE;
@@ -644,13 +630,9 @@ int32_t CannedMessageModule::runOnce()
             if (screen)
                 screen->removeFunctionSymbal("Fn");
         }
-
-        this->lastTouchMillis = millis();
-        this->notifyObservers(&e);
-        return INACTIVATE_AFTER_MS;
     }
 
-    if (this->runState == CANNED_MESSAGE_RUN_STATE_ACTIVE) {
+    if (this->runState == CANNED_MESSAGE_RUN_STATE_FREETEXT || this->runState == CANNED_MESSAGE_RUN_STATE_ACTIVE) {
         this->lastTouchMillis = millis();
         this->notifyObservers(&e);
         return INACTIVATE_AFTER_MS;
@@ -734,6 +716,7 @@ void CannedMessageModule::showTemporaryMessage(const String &message)
     UIFrameEvent e;
     e.action = UIFrameEvent::Action::REGENERATE_FRAMESET; // We want to change the list of frames shown on-screen
     notifyObservers(&e);
+    this->restoreOldState = this->runState;
     runState = CANNED_MESSAGE_RUN_STATE_MESSAGE;
     // run this loop again in 2 seconds, next iteration will clear the display
     setIntervalFromNow(2000);
@@ -1101,6 +1084,7 @@ ProcessMessage CannedMessageModule::handleReceived(const meshtastic_MeshPacket &
             UIFrameEvent e;
             e.action = UIFrameEvent::Action::REGENERATE_FRAMESET; // We want to change the list of frames shown on-screen
             requestFocus(); // Tell Screen::setFrames that our module's frame should be shown, even if not "first" in the frameset
+            this->restoreOldState = this->runState;
             this->runState = CANNED_MESSAGE_RUN_STATE_ACK_NACK_RECEIVED;
             this->incoming = service->getNodenumFromRequestId(mp.decoded.request_id);
             meshtastic_Routing decoded = meshtastic_Routing_init_default;

src/modules/CannedMessageModule.h

@@ -131,6 +131,7 @@ class CannedMessageModule : public SinglePortModule, public Observable<const UIF
 
     int currentMessageIndex = -1;
     cannedMessageModuleRunState runState = CANNED_MESSAGE_RUN_STATE_INACTIVE;
+    cannedMessageModuleRunState restoreOldState = CANNED_MESSAGE_RUN_STATE_INACTIVE;
     char payload = 0x00;
     unsigned int cursor = 0;
     String freetext = ""; // Text Buffer for Freetext Editor