Fix #8899 [Bug]: [TloraPager] RotaryEncoder crash (#8933)

* Fix #8899 [Bug]: [TloraPager] RotaryEncoder crash

* Apply Copilot review

---------

Co-authored-by: Ben Meadors <benmmeadors@gmail.com>

.github/actions/build-variant/action.yml

@@ -76,7 +76,7 @@ runs:
         done
 
     - name: PlatformIO ${{ inputs.arch }} download cache
-      uses: actions/cache@v4
+      uses: actions/cache@v5
       with:
         path: ~/.platformio/.cache
         key: pio-cache-${{ inputs.arch }}-${{ hashFiles('.github/actions/**', '**.ini') }}

.github/workflows/build_firmware.yml

@@ -56,18 +56,16 @@ jobs:
           ota_firmware_source: ${{ steps.ota_dir.outputs.src || '' }}
           ota_firmware_target: ${{ steps.ota_dir.outputs.tgt || '' }}
 
-      - name: Job summary
+      - name: Echo manifest from release/firmware-*.mt.json to job summary
+        if: ${{ always() }}
         env:
           PIO_ENV: ${{ inputs.pio_env }}
         run: |
-          echo "## $PIO_ENV" >> $GITHUB_STEP_SUMMARY
-          echo "<details><summary><strong>Manifest</strong></summary>" >> $GITHUB_STEP_SUMMARY
-          echo '' >> $GITHUB_STEP_SUMMARY
+          echo "## Manifest: \`$PIO_ENV\`" >> $GITHUB_STEP_SUMMARY
           echo '```json' >> $GITHUB_STEP_SUMMARY
           cat release/firmware-*.mt.json >> $GITHUB_STEP_SUMMARY
           echo '' >> $GITHUB_STEP_SUMMARY
           echo '```' >> $GITHUB_STEP_SUMMARY
-          echo "</details>" >> $GITHUB_STEP_SUMMARY
 
       - name: Store binaries as an artifact
         uses: actions/upload-artifact@v5

.trunk/trunk.yaml

@@ -9,16 +9,16 @@ plugins:
 lint:
   enabled:
     - checkov@3.2.495
-    - renovate@42.42.2
+    - renovate@42.44.0
     - prettier@3.7.4
-    - trufflehog@3.92.1
+    - trufflehog@3.92.2
     - yamllint@1.37.1
     - bandit@1.9.2
     - trivy@0.68.1
     - taplo@0.10.0
     - ruff@0.14.8
     - isort@7.0.0
-    - markdownlint@0.46.0
+    - markdownlint@0.47.0
     - oxipng@10.0.0
     - svgo@4.0.0
     - actionlint@1.7.9

platformio.ini

@@ -123,7 +123,7 @@ lib_deps =
 [device-ui_base]
 lib_deps =
 	# renovate: datasource=git-refs depName=meshtastic/device-ui packageName=https://github.com/meshtastic/device-ui gitBranch=master
-	https://github.com/meshtastic/device-ui/archive/4fb5f24787caa841b58dbf623a52c4c5861d6722.zip
+	https://github.com/meshtastic/device-ui/archive/2746a1ce3804998460a2cb319b8ea8a238dfd8c9.zip
 
 ; Common libs for environmental measurements in telemetry module
 [environmental_base]

src/gps/GPS.cpp

@@ -1133,10 +1133,13 @@ int32_t GPS::runOnce()
         // if gps_update_interval is <=10s, GPS never goes off, so we treat that differently
         uint32_t updateInterval = Default::getConfiguredOrDefaultMs(config.position.gps_update_interval);
 
-        // Got a time for the first time
+        // 1. Got a time for the first time
         bool gotTime = (getRTCQuality() >= RTCQualityGPS);
+        if (!gotTime && lookForTime()) { // Note: we count on this && short-circuiting and not resetting the RTC time
+            gotTime = true;
+        }
 
-        // Got a lock for the first time, or Got a lock after turning back on
+        // 2. Got a lock for the first time, or 3. Got a lock after turning back on
         bool gotLoc = lookForLocation();
         if (gotLoc) {
 #ifdef GPS_DEBUG
@@ -1144,10 +1147,6 @@ int32_t GPS::runOnce()
                 LOG_DEBUG("hasValidLocation RISING EDGE");
             }
 #endif
-            if (!gotTime && lookForTime()) { // Note: we count on this && short-circuiting and not resetting the RTC time
-                gotTime = true;
-            }
-
             if (updateInterval <= GPS_UPDATE_ALWAYS_ON_THRESHOLD_MS) {
                 hasValidLocation = true;
                 shouldPublish = true;

src/input/InputBroker.h

@@ -53,6 +53,7 @@ typedef struct _InputEvent {
 class InputPollable
 {
   public:
+    virtual ~InputPollable() = default;
     virtual void pollOnce() = 0;
 };
 

src/input/RotaryEncoderImpl.cpp

@@ -3,6 +3,9 @@
 #include "RotaryEncoderImpl.h"
 #include "InputBroker.h"
 #include "RotaryEncoder.h"
+#ifdef ARCH_ESP32
+#include "sleep.h"
+#endif
 
 #define ORIGIN_NAME "RotaryEncoder"
 
@@ -11,6 +14,20 @@ RotaryEncoderImpl *rotaryEncoderImpl;
 RotaryEncoderImpl::RotaryEncoderImpl()
 {
     rotary = nullptr;
+#ifdef ARCH_ESP32
+    isFirstInit = true;
+#endif
+}
+
+RotaryEncoderImpl::~RotaryEncoderImpl()
+{
+    LOG_DEBUG("RotaryEncoderImpl destructor");
+    detachRotaryEncoderInterrupts();
+
+    if (rotary != nullptr) {
+        delete rotary;
+        rotary = nullptr;
+    }
 }
 
 bool RotaryEncoderImpl::init()
@@ -25,15 +42,22 @@ bool RotaryEncoderImpl::init()
     eventCcw = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_ccw);
     eventPressed = static_cast<input_broker_event>(moduleConfig.canned_message.inputbroker_event_press);
 
-    rotary = new RotaryEncoder(moduleConfig.canned_message.inputbroker_pin_a, moduleConfig.canned_message.inputbroker_pin_b,
-                               moduleConfig.canned_message.inputbroker_pin_press);
-    rotary->resetButton();
+    if (rotary == nullptr) {
+        rotary = new RotaryEncoder(moduleConfig.canned_message.inputbroker_pin_a, moduleConfig.canned_message.inputbroker_pin_b,
+                                   moduleConfig.canned_message.inputbroker_pin_press);
+    }
 
-    interruptInstance = this;
-    auto interruptHandler = []() { inputBroker->requestPollSoon(interruptInstance); };
-    attachInterrupt(moduleConfig.canned_message.inputbroker_pin_a, interruptHandler, CHANGE);
-    attachInterrupt(moduleConfig.canned_message.inputbroker_pin_b, interruptHandler, CHANGE);
-    attachInterrupt(moduleConfig.canned_message.inputbroker_pin_press, interruptHandler, CHANGE);
+    attachRotaryEncoderInterrupts();
+
+#ifdef ARCH_ESP32
+    // Register callbacks for before and after lightsleep
+    // Used to detach and reattach interrupts
+    if (isFirstInit) {
+        lsObserver.observe(&notifyLightSleep);
+        lsEndObserver.observe(&notifyLightSleepEnd);
+        isFirstInit = false;
+    }
+#endif
 
     LOG_INFO("RotaryEncoder initialized pins(%d, %d, %d), events(%d, %d, %d)", moduleConfig.canned_message.inputbroker_pin_a,
              moduleConfig.canned_message.inputbroker_pin_b, moduleConfig.canned_message.inputbroker_pin_press, eventCw, eventCcw,
@@ -71,6 +95,50 @@ void RotaryEncoderImpl::pollOnce()
     }
 }
 
+void RotaryEncoderImpl::detachRotaryEncoderInterrupts()
+{
+    LOG_DEBUG("RotaryEncoderImpl detach button interrupts");
+    if (interruptInstance == this) {
+        detachInterrupt(moduleConfig.canned_message.inputbroker_pin_a);
+        detachInterrupt(moduleConfig.canned_message.inputbroker_pin_b);
+        detachInterrupt(moduleConfig.canned_message.inputbroker_pin_press);
+        interruptInstance = nullptr;
+    } else {
+        LOG_WARN("RotaryEncoderImpl: interrupts already detached");
+    }
+}
+
+void RotaryEncoderImpl::attachRotaryEncoderInterrupts()
+{
+    LOG_DEBUG("RotaryEncoderImpl attach button interrupts");
+    if (rotary != nullptr && interruptInstance == nullptr) {
+        rotary->resetButton();
+
+        interruptInstance = this;
+        auto interruptHandler = []() { inputBroker->requestPollSoon(interruptInstance); };
+        attachInterrupt(moduleConfig.canned_message.inputbroker_pin_a, interruptHandler, CHANGE);
+        attachInterrupt(moduleConfig.canned_message.inputbroker_pin_b, interruptHandler, CHANGE);
+        attachInterrupt(moduleConfig.canned_message.inputbroker_pin_press, interruptHandler, CHANGE);
+    } else {
+        LOG_WARN("RotaryEncoderImpl: interrupts already attached");
+    }
+}
+
+#ifdef ARCH_ESP32
+
+int RotaryEncoderImpl::beforeLightSleep(void *unused)
+{
+    detachRotaryEncoderInterrupts();
+    return 0; // Indicates success;
+}
+
+int RotaryEncoderImpl::afterLightSleep(esp_sleep_wakeup_cause_t cause)
+{
+    attachRotaryEncoderInterrupts();
+    return 0; // Indicates success;
+}
+#endif
+
 RotaryEncoderImpl *RotaryEncoderImpl::interruptInstance;
 
 #endif

src/input/RotaryEncoderImpl.h

@@ -8,12 +8,18 @@
 
 class RotaryEncoder;
 
-class RotaryEncoderImpl : public InputPollable
+class RotaryEncoderImpl final : public InputPollable
 {
   public:
     RotaryEncoderImpl();
-    bool init(void);
+    ~RotaryEncoderImpl() override;
+    bool init();
     virtual void pollOnce() override;
+    // Disconnect and reconnect interrupts for light sleep
+#ifdef ARCH_ESP32
+    int beforeLightSleep(void *unused);
+    int afterLightSleep(esp_sleep_wakeup_cause_t cause);
+#endif
 
   protected:
     static RotaryEncoderImpl *interruptInstance;
@@ -23,6 +29,21 @@ class RotaryEncoderImpl : public InputPollable
     input_broker_event eventPressed = INPUT_BROKER_NONE;
 
     RotaryEncoder *rotary;
+
+  private:
+#ifdef ARCH_ESP32
+    bool isFirstInit;
+#endif
+    void detachRotaryEncoderInterrupts();
+    void attachRotaryEncoderInterrupts();
+
+#ifdef ARCH_ESP32
+    // Get notified when lightsleep begins and ends
+    CallbackObserver<RotaryEncoderImpl, void *> lsObserver =
+        CallbackObserver<RotaryEncoderImpl, void *>(this, &RotaryEncoderImpl::beforeLightSleep);
+    CallbackObserver<RotaryEncoderImpl, esp_sleep_wakeup_cause_t> lsEndObserver =
+        CallbackObserver<RotaryEncoderImpl, esp_sleep_wakeup_cause_t>(this, &RotaryEncoderImpl::afterLightSleep);
+#endif
 };
 
 extern RotaryEncoderImpl *rotaryEncoderImpl;

src/mesh/MeshModule.h

@@ -225,4 +225,4 @@ class MeshModule
 /** set the destination and packet parameters of packet p intended as a reply to a particular "to" packet
  * This ensures that if the request packet was sent reliably, the reply is sent that way as well.
  */
-void setReplyTo(meshtastic_MeshPacket *p, const meshtastic_MeshPacket &to);
+void setReplyTo(meshtastic_MeshPacket *p, const meshtastic_MeshPacket &to);

src/mesh/ReliableRouter.cpp

@@ -150,9 +150,7 @@ void ReliableRouter::sniffReceived(const meshtastic_MeshPacket *p, const meshtas
         PacketId nakId = (c && c->error_reason != meshtastic_Routing_Error_NONE) ? p->decoded.request_id : 0;
 
         // We intentionally don't check wasSeenRecently, because it is harmless to delete non existent retransmission records
-        if ((ackId || nakId) &&
-            // Implicit ACKs from MQTT should not stop retransmissions
-            !(isFromUs(p) && p->transport_mechanism == meshtastic_MeshPacket_TransportMechanism_TRANSPORT_MQTT)) {
+        if (ackId || nakId) {
             LOG_DEBUG("Received a %s for 0x%x, stopping retransmissions", ackId ? "ACK" : "NAK", ackId);
             if (ackId) {
                 stopRetransmission(p->to, ackId);

src/modules/RoutingModule.cpp

@@ -75,12 +75,6 @@ uint8_t RoutingModule::getHopLimitForResponse(uint8_t hopStart, uint8_t hopLimit
     return Default::getConfiguredOrDefaultHopLimit(config.lora.hop_limit); // Use the default hop limit
 }
 
-meshtastic_MeshPacket *RoutingModule::allocAckNak(meshtastic_Routing_Error err, NodeNum to, PacketId idFrom, ChannelIndex chIndex,
-                                                  uint8_t hopLimit)
-{
-    return MeshModule::allocAckNak(err, to, idFrom, chIndex, hopLimit);
-}
-
 RoutingModule::RoutingModule() : ProtobufModule("routing", meshtastic_PortNum_ROUTING_APP, &meshtastic_Routing_msg)
 {
     isPromiscuous = true;

src/modules/RoutingModule.h

@@ -16,9 +16,6 @@ class RoutingModule : public ProtobufModule<meshtastic_Routing>
     virtual void sendAckNak(meshtastic_Routing_Error err, NodeNum to, PacketId idFrom, ChannelIndex chIndex, uint8_t hopLimit = 0,
                             bool ackWantsAck = false);
 
-    meshtastic_MeshPacket *allocAckNak(meshtastic_Routing_Error err, NodeNum to, PacketId idFrom, ChannelIndex chIndex,
-                                       uint8_t hopLimit = 0);
-
     // Given the hopStart and hopLimit upon reception of a request, return the hop limit to use for the response
     uint8_t getHopLimitForResponse(uint8_t hopStart, uint8_t hopLimit);
 

src/mqtt/MQTT.cpp

@@ -87,13 +87,10 @@ inline void onReceiveProto(char *topic, byte *payload, size_t length)
         // Generate an implicit ACK towards ourselves (handled and processed only locally!) for this message.
         // We do this because packets are not rebroadcasted back into MQTT anymore and we assume that at least one node
         // receives it when we get our own packet back. Then we'll stop our retransmissions.
-        if (isFromUs(e.packet)) {
-            auto pAck = routingModule->allocAckNak(meshtastic_Routing_Error_NONE, getFrom(e.packet), e.packet->id, ch.index);
-            pAck->transport_mechanism = meshtastic_MeshPacket_TransportMechanism_TRANSPORT_MQTT;
-            router->sendLocal(pAck);
-        } else {
+        if (isFromUs(e.packet))
+            routingModule->sendAckNak(meshtastic_Routing_Error_NONE, getFrom(e.packet), e.packet->id, ch.index);
+        else
             LOG_INFO("Ignore downlink message we originally sent");
-        }
         return;
     }
     if (isFromUs(e.packet)) {

src/platform/nrf52/main-nrf52.cpp

@@ -337,7 +337,7 @@ void cpuDeepSleep(uint32_t msecToWake)
 #endif
 
 #ifdef TTGO_T_ECHO
-    // To power off the T-Echo, the display must be set
+    // To power off the T-Echo, the display must be set 
     // as an input pin; otherwise, there will be leakage current.
     pinMode(PIN_EINK_CS, INPUT);
     pinMode(PIN_EINK_DC, INPUT);

variants/esp32/diy/dr-dev/platformio.ini

@@ -2,6 +2,7 @@
 [env:meshtastic-dr-dev]
 extends = esp32_base
 board = esp32doit-devkit-v1
+board_level = extra
 board_upload.maximum_size = 4194304
 board_upload.maximum_ram_size = 532480
 build_flags =

variants/esp32/tbeam/platformio.ini

@@ -2,7 +2,7 @@
 [env:tbeam]
 extends = esp32_base
 board = ttgo-t-beam
-board_level = pr
+board_level = extra
 board_check = true
 lib_deps = ${esp32_base.lib_deps}
 build_flags = ${esp32_base.build_flags}

variants/esp32s3/link32_s3_v1/platformio.ini

@@ -1,6 +1,7 @@
 [env:link32-s3-v1]
 extends = esp32s3_base
 board = esp32-s3-devkitc-1
+board_level = extra
 build_flags = 
   ${esp32_base.build_flags}
   -D LINK_32

variants/nrf52840/ELECROW-ThinkNode-M3/variant.cpp

@@ -63,9 +63,20 @@ void initVariant()
 // called from main-nrf52.cpp during the cpuDeepSleep() function
 void variant_shutdown()
 {
+    digitalWrite(red_LED_PIN, HIGH);
+    digitalWrite(green_LED_PIN, HIGH);
+    digitalWrite(LED_BLUE, HIGH);
+
+    digitalWrite(PIN_EN1, LOW);
+    digitalWrite(PIN_EN2, LOW);
     digitalWrite(EEPROM_POWER, LOW);
     digitalWrite(KEY_POWER, LOW);
+    digitalWrite(DHT_POWER, LOW);
+    digitalWrite(ACC_POWER, LOW);
+    digitalWrite(Battery_POWER, LOW);
+    digitalWrite(GPS_POWER, LOW);
 
+    // This sets the pin to OUTPUT and LOW for the pins *not* in the if block.
     for (int pin = 0; pin < 48; pin++) {
         if (pin == PIN_POWER_USB || pin == BUTTON_PIN || pin == PIN_EN1 || pin == PIN_EN2 || pin == DHT_POWER ||
             pin == ACC_POWER || pin == Battery_POWER || pin == GPS_POWER || pin == LR1110_SPI_MISO_PIN ||

variants/rp2040/feather_rp2040_rfm95/platformio.ini

@@ -1,6 +1,7 @@
 [env:feather_rp2040_rfm95]
 extends = rp2040_base
 board = adafruit_feather
+board_level = extra
 upload_protocol = picotool
 # add our variants files to the include and src paths
 build_flags =