SX126x: Try next Interface when chip not found (#2363)

* If chip was not found, return false for init()

* SX1268: Only overwrite frequency when out of bounds
Happens when region is still UNSET

.github/ISSUE_TEMPLATE/Bug Report.yml

@@ -32,6 +32,7 @@ body:
       options:
         - Not Applicable
         - T-Beam
+        - T-Beam S3
         - T-Beam 0.7
         - T-Lora v1
         - T-Lora v1.3
@@ -42,6 +43,7 @@ body:
         - Heltec v1
         - Heltec v2
         - Heltec v2.1
+        - Heltec V3
         - Relay v1
         - Relay v2
         - DIY

src/ButtonThread.h

@@ -123,9 +123,6 @@ class ButtonThread : public concurrency::OSThread
     static void userButtonPressedLong()
     {
         // LOG_DEBUG("Long press!\n");
-#ifdef ARCH_ESP32
-        screen->adjustBrightness();
-#endif
         // If user button is held down for 5 seconds, shutdown the device.
         if ((millis() - longPressTime > 5 * 1000) && (longPressTime > 0)) {
 #ifdef HAS_PMU
@@ -133,7 +130,7 @@ class ButtonThread : public concurrency::OSThread
                 setLed(false);
                 power->shutdown();
             }
-#elif defined(ARCH_NRF52)
+#elif defined(ARCH_NRF52) || defined(ARCH_ESP32)
             // Do actual shutdown when button released, otherwise the button release
             // may wake the board immediatedly.
             if ((!shutdown_on_long_stop) && (millis() > 30 * 1000)) {

src/Power.cpp

@@ -13,6 +13,10 @@
 #include <WiFi.h>
 #endif
 
+#ifndef DELAY_FOREVER
+#define DELAY_FOREVER portMAX_DELAY
+#endif
+
 #ifdef HAS_PMU
 #include "XPowersAXP192.tpp"
 #include "XPowersAXP2101.tpp"
@@ -256,16 +260,24 @@ void Power::shutdown()
     digitalWrite(PIN_EINK_EN, LOW); // power off backlight first
 #endif
 
-#ifdef HAS_PMU
     LOG_INFO("Shutting down\n");
+
+#ifdef HAS_PMU
     if (PMU) {
         PMU->setChargingLedMode(XPOWERS_CHG_LED_OFF);
-        PMU->shutdown();
     }
-#elif defined(ARCH_NRF52)
-    playBeep();
+#endif
+
+#if defined(ARCH_NRF52) || defined(ARCH_ESP32)
+#ifdef PIN_LED1
     ledOff(PIN_LED1);
+#endif
+#ifdef PIN_LED2
     ledOff(PIN_LED2);
+#endif
+#ifdef PIN_LED3
+    ledOff(PIN_LED2);
+#endif
     doDeepSleep(DELAY_FOREVER);
 #endif
 }

src/graphics/Screen.h

@@ -25,6 +25,7 @@ class Screen
     void startBluetoothPinScreen(uint32_t pin) {}
     void stopBluetoothPinScreen() {}
     void startRebootScreen() {}
+    void startShutdownScreen() {}
     void startFirmwareUpdateScreen() {}
 };
 } // namespace graphics

src/input/RotaryEncoderInterruptBase.h

@@ -1,7 +1,8 @@
 #pragma once
 
 #include "InputBroker.h"
-#include "SinglePortModule.h" // TODO: what header file to include?
+#include "concurrency/OSThread.h"
+#include "mesh/NodeDB.h"
 
 enum RotaryEncoderInterruptBaseStateType { ROTARY_EVENT_OCCURRED, ROTARY_EVENT_CLEARED };
 

src/input/UpDownInterruptBase.h

@@ -1,7 +1,7 @@
 #pragma once
 
 #include "InputBroker.h"
-#include "SinglePortModule.h" // TODO: what header file to include?
+#include "mesh/NodeDB.h"
 
 class UpDownInterruptBase : public Observable<const InputEvent *>
 {

src/input/kbI2cBase.h

@@ -1,8 +1,8 @@
 #pragma once
 
 #include "InputBroker.h"
-#include "SinglePortModule.h" // TODO: what header file to include?
 #include "Wire.h"
+#include "concurrency/OSThread.h"
 
 class KbI2cBase : public Observable<const InputEvent *>, public concurrency::OSThread
 {

src/mesh/MeshService.cpp

@@ -82,7 +82,7 @@ int MeshService::handleFromRadio(const meshtastic_MeshPacket *mp)
     }
 
     printPacket("Forwarding to phone", mp);
-    sendToPhone((meshtastic_MeshPacket *)mp);
+    sendToPhone(packetPool.allocCopy(*mp));
 
     return 0;
 }
@@ -231,7 +231,7 @@ void MeshService::sendToMesh(meshtastic_MeshPacket *p, RxSource src, bool ccToPh
     }
 
     if (ccToPhone) {
-        sendToPhone(p);
+        sendToPhone(packetPool.allocCopy(*p));
     }
 }
 
@@ -262,9 +262,8 @@ void MeshService::sendToPhone(meshtastic_MeshPacket *p)
             releaseToPool(d);
     }
 
-    meshtastic_MeshPacket *copied = packetPool.allocCopy(*p);
-    perhapsDecode(copied);
-    assert(toPhoneQueue.enqueue(copied, 0));
+    perhapsDecode(p);
+    assert(toPhoneQueue.enqueue(p, 0));
     fromNum++;
 }
 

src/mesh/RadioInterface.cpp

@@ -454,6 +454,7 @@ void RadioInterface::applyModemConfig()
 
     // If user has manually specified a channel num, then use that, otherwise generate one by hashing the name
     const char *channelName = channels.getName(channels.getPrimaryIndex());
+    // channel_num is actually (channel_num - 1), since modulus (%) returns values from 0 to (numChannels - 1)
     int channel_num = (loraConfig.channel_num ? loraConfig.channel_num - 1 : hash(channelName)) % numChannels;
 
     // Old frequency selection formula
@@ -471,13 +472,16 @@ void RadioInterface::applyModemConfig()
     saveChannelNum(channel_num);
     saveFreq(freq + loraConfig.frequency_offset);
 
+    preambleTimeMsec = getPacketTime((uint32_t)0);
+    maxPacketTimeMsec = getPacketTime(meshtastic_Constants_DATA_PAYLOAD_LEN + sizeof(PacketHeader));
+
     LOG_INFO("Radio freq=%.3f, config.lora.frequency_offset=%.3f\n", freq, loraConfig.frequency_offset);
     LOG_INFO("Set radio: region=%s, name=%s, config=%u, ch=%d, power=%d\n", myRegion->name, channelName, loraConfig.modem_preset,
              channel_num, power);
     LOG_INFO("Radio myRegion->freqStart -> myRegion->freqEnd: %f -> %f (%f mhz)\n", myRegion->freqStart, myRegion->freqEnd,
              myRegion->freqEnd - myRegion->freqStart);
     LOG_INFO("Radio myRegion->numChannels: %d x %.3fkHz\n", numChannels, bw);
-    LOG_INFO("Radio channel_num: %d\n", channel_num);
+    LOG_INFO("Radio channel_num: %d\n", channel_num + 1);
     LOG_INFO("Radio frequency: %f\n", getFreq());
     LOG_INFO("Slot time: %u msec\n", slotTimeMsec);
 }

src/mesh/RadioInterface.h

@@ -63,7 +63,9 @@ class RadioInterface
       - Tx/Rx turnaround time (maximum of SX126x and SX127x);
       - MAC processing time (measured on T-beam) */
     uint32_t slotTimeMsec = 8.5 * pow(2, sf) / bw + 0.2 + 0.4 + 7;
-    uint16_t preambleLength = 16; // 8 is default, but we use longer to increase the amount of sleep time when receiving
+    uint16_t preambleLength = 16;      // 8 is default, but we use longer to increase the amount of sleep time when receiving
+    uint32_t preambleTimeMsec = 165;   // calculated on startup, this is the default for LongFast
+    uint32_t maxPacketTimeMsec = 3246; // calculated on startup, this is the default for LongFast
     const uint32_t PROCESSING_TIME_MSEC =
         4500;                // time to construct, process and construct a packet again (empirically determined)
     const uint8_t CWmin = 2; // minimum CWsize

src/mesh/ReliableRouter.cpp

@@ -164,13 +164,13 @@ bool ReliableRouter::stopRetransmission(GlobalPacketId key)
 {
     auto old = findPendingPacket(key);
     if (old) {
+        auto p = old->packet;
         auto numErased = pending.erase(key);
         assert(numErased == 1);
         // remove the 'original' (identified by originator and packet->id) from the txqueue and free it
-        cancelSending(getFrom(old->packet), old->packet->id);
-        // now free the pooled copy for retransmission too. tryfix for #2228
-        if (old->packet)
-            packetPool.release(old->packet);
+        cancelSending(getFrom(p), p->id);
+        // now free the pooled copy for retransmission too
+        packetPool.release(p);
         return true;
     } else
         return false;

src/mesh/SX1268Interface.cpp

@@ -6,4 +6,13 @@ SX1268Interface::SX1268Interface(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RA
                                  SPIClass &spi)
     : SX126xInterface(cs, irq, rst, busy, spi)
 {
+}
+
+float SX1268Interface::getFreq()
+{
+    // Set frequency to default of EU_433 if outside of allowed range (e.g. when region is UNSET)
+    if (savedFreq < 410 || savedFreq > 810)
+        return 433.125f;
+    else
+        return savedFreq;
 }

src/mesh/SX1268Interface.h

@@ -8,8 +8,7 @@
 class SX1268Interface : public SX126xInterface<SX1268>
 {
   public:
-    /// override frequency of the SX1268 module regardless of the region (use EU433 value)
-    virtual float getFreq() override { return 433.175f; }
+    virtual float getFreq() override;
 
     SX1268Interface(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE busy, SPIClass &spi);
 };

src/mesh/SX126xInterface.cpp

@@ -47,6 +47,8 @@ template <typename T> bool SX126xInterface<T>::init()
     int res = lora.begin(getFreq(), bw, sf, cr, syncWord, power, preambleLength, tcxoVoltage, useRegulatorLDO);
     // \todo Display actual typename of the adapter, not just `SX126x`
     LOG_INFO("SX126x init result %d\n", res);
+    if (res == RADIOLIB_ERR_CHIP_NOT_FOUND)
+        return false;
 
     LOG_INFO("Frequency set to %f\n", getFreq());
     LOG_INFO("Bandwidth set to %f\n", bw);
@@ -180,6 +182,7 @@ template <typename T> void SX126xInterface<T>::setStandby()
     assert(err == RADIOLIB_ERR_NONE);
 
     isReceiving = false; // If we were receiving, not any more
+    activeReceiveStart = 0;
     disableInterrupt();
     completeSending(); // If we were sending, not anymore
 }
@@ -213,9 +216,10 @@ template <typename T> void SX126xInterface<T>::startReceive()
     setStandby();
 
     // We use a 16 bit preamble so this should save some power by letting radio sit in standby mostly.
-    // Furthermore, we need the HEADER_VALID IRQ flag to detect whether we are actively receiving
-    int err =
-        lora.startReceiveDutyCycleAuto(preambleLength, 8, RADIOLIB_SX126X_IRQ_RX_DEFAULT | RADIOLIB_SX126X_IRQ_HEADER_VALID);
+    // Furthermore, we need the PREAMBLE_DETECTED and HEADER_VALID IRQ flag to detect whether we are actively receiving
+    int err = lora.startReceiveDutyCycleAuto(preambleLength, 8,
+                                             RADIOLIB_SX126X_IRQ_RX_DEFAULT | RADIOLIB_SX126X_IRQ_RADIOLIB_PREAMBLE_DETECTED |
+                                                 RADIOLIB_SX126X_IRQ_HEADER_VALID);
     assert(err == RADIOLIB_ERR_NONE);
 
     isReceiving = true;
@@ -248,10 +252,27 @@ template <typename T> bool SX126xInterface<T>::isActivelyReceiving()
     // received and handled the interrupt for reading the packet/handling errors.
 
     uint16_t irq = lora.getIrqStatus();
-    bool headerValid = (irq & RADIOLIB_SX126X_IRQ_HEADER_VALID);
+    bool detected = (irq & (RADIOLIB_SX126X_IRQ_HEADER_VALID | RADIOLIB_SX126X_IRQ_RADIOLIB_PREAMBLE_DETECTED));
+    // Handle false detections
+    if (detected) {
+        uint32_t now = millis();
+        if (!activeReceiveStart) {
+            activeReceiveStart = now;
+        } else if ((now - activeReceiveStart > 2 * preambleTimeMsec) && !(irq & RADIOLIB_SX126X_IRQ_HEADER_VALID)) {
+            // The HEADER_VALID flag should be set by now if it was really a packet, so ignore PREAMBLE_DETECTED flag
+            activeReceiveStart = 0;
+            LOG_DEBUG("Ignore false preamble detection.\n");
+            return false;
+        } else if (now - activeReceiveStart > maxPacketTimeMsec) {
+            // We should have gotten an RX_DONE IRQ by now if it was really a packet, so ignore HEADER_VALID flag
+            activeReceiveStart = 0;
+            LOG_DEBUG("Ignore false header detection.\n");
+            return false;
+        }
+    }
 
-    // if (headerValid) LOG_DEBUG("rx headerValid\n");
-    return headerValid;
+    // if (detected) LOG_DEBUG("rx detected\n");
+    return detected;
 }
 
 template <typename T> bool SX126xInterface<T>::sleep()

src/mesh/SX126xInterface.h

@@ -68,4 +68,5 @@ template <class T> class SX126xInterface : public RadioLibInterface
     virtual void setStandby() override;
 
   private:
+    uint32_t activeReceiveStart = 0;
 };

src/mesh/SX128xInterface.cpp

@@ -157,6 +157,7 @@ template <typename T> void SX128xInterface<T>::setStandby()
 #endif
 
     isReceiving = false; // If we were receiving, not any more
+    activeReceiveStart = 0;
     disableInterrupt();
     completeSending(); // If we were sending, not anymore
 }
@@ -203,9 +204,10 @@ template <typename T> void SX128xInterface<T>::startReceive()
     digitalWrite(SX128X_TXEN, LOW);
 #endif
 
-    // We use the HEADER_VALID IRQ flag to detect whether we are actively receiving
-    int err =
-        lora.startReceive(RADIOLIB_SX128X_RX_TIMEOUT_INF, RADIOLIB_SX128X_IRQ_RX_DEFAULT | RADIOLIB_SX128X_IRQ_HEADER_VALID);
+    // We use the PREAMBLE_DETECTED and HEADER_VALID IRQ flag to detect whether we are actively receiving
+    int err = lora.startReceive(RADIOLIB_SX128X_RX_TIMEOUT_INF, RADIOLIB_SX128X_IRQ_RX_DEFAULT |
+                                                                    RADIOLIB_SX128X_IRQ_RADIOLIB_PREAMBLE_DETECTED |
+                                                                    RADIOLIB_SX128X_IRQ_HEADER_VALID);
 
     assert(err == RADIOLIB_ERR_NONE);
 
@@ -236,8 +238,27 @@ template <typename T> bool SX128xInterface<T>::isChannelActive()
 template <typename T> bool SX128xInterface<T>::isActivelyReceiving()
 {
     uint16_t irq = lora.getIrqStatus();
-    bool hasHeader = (irq & RADIOLIB_SX128X_IRQ_HEADER_VALID);
-    return hasHeader;
+    bool detected = (irq & (RADIOLIB_SX128X_IRQ_HEADER_VALID | RADIOLIB_SX128X_IRQ_RADIOLIB_PREAMBLE_DETECTED));
+
+    // Handle false detections
+    if (detected) {
+        uint32_t now = millis();
+        if (!activeReceiveStart) {
+            activeReceiveStart = now;
+        } else if ((now - activeReceiveStart > 2 * preambleTimeMsec) && !(irq & RADIOLIB_SX128X_IRQ_HEADER_VALID)) {
+            // The HEADER_VALID flag should be set by now if it was really a packet, so ignore PREAMBLE_DETECTED flag
+            activeReceiveStart = 0;
+            LOG_DEBUG("Ignore false preamble detection.\n");
+            return false;
+        } else if (now - activeReceiveStart > maxPacketTimeMsec) {
+            // We should have gotten an RX_DONE IRQ by now if it was really a packet, so ignore HEADER_VALID flag
+            activeReceiveStart = 0;
+            LOG_DEBUG("Ignore false header detection.\n");
+            return false;
+        }
+    }
+
+    return detected;
 }
 
 template <typename T> bool SX128xInterface<T>::sleep()

src/mesh/SX128xInterface.h

@@ -68,4 +68,5 @@ template <class T> class SX128xInterface : public RadioLibInterface
     virtual void setStandby() override;
 
   private:
+    uint32_t activeReceiveStart = 0;
 };

src/platform/esp32/architecture.h

@@ -36,6 +36,9 @@
 #ifndef HAS_RTC
 #define HAS_RTC 1
 #endif
+#ifndef HAS_CPU_SHUTDOWN
+#define HAS_CPU_SHUTDOWN 1
+#endif
 
 #if defined(HAS_AXP192) || defined(HAS_AXP2101)
 #define HAS_PMU

src/platform/nrf52/architecture.h

@@ -29,7 +29,7 @@
 #ifndef HAS_RADIO
 #define HAS_RADIO 1
 #endif
-#ifdef HAS_CPU_SHUTDOWN
+#ifndef HAS_CPU_SHUTDOWN
 #define HAS_CPU_SHUTDOWN 1
 #endif
 

src/shutdown.h

@@ -18,31 +18,16 @@ void powerCommandsCheck()
 #endif
     }
 
-#if defined(ARCH_NRF52) || defined(HAS_PMU)
+#if defined(ARCH_ESP32) || defined(ARCH_NRF52)
     if (shutdownAtMsec) {
         screen->startShutdownScreen();
-        playBeep();
-#ifdef PIN_LED1
-        ledOff(PIN_LED1);
-#endif
-#ifdef PIN_LED2
-        ledOff(PIN_LED2);
-#endif
-#ifdef PIN_LED3
-        ledOff(PIN_LED3);
-#endif
     }
 #endif
 
     if (shutdownAtMsec && millis() > shutdownAtMsec) {
         LOG_INFO("Shutting down from admin command\n");
-#ifdef HAS_PMU
-        if (pmu_found == true) {
-            playShutdownMelody();
-            power->shutdown();
-        }
-#elif defined(ARCH_NRF52)
         playShutdownMelody();
+#if defined(ARCH_NRF52) || defined(ARCH_ESP32)
         power->shutdown();
 #else
         LOG_WARN("FIXME implement shutdown for this platform");

variants/rak4631/variant.h

@@ -126,7 +126,6 @@ static const uint8_t SCK = PIN_SPI_SCK;
  * eink display pins
  */
 
-#define PIN_EINK_EN (32 + 2) // (0 + 2) Note: this is really just backlight power
 #define PIN_EINK_CS (0 + 26)
 #define PIN_EINK_BUSY (0 + 4)
 #define PIN_EINK_DC (0 + 17)

variants/rak4631_epaper/variant.h

@@ -126,7 +126,6 @@ static const uint8_t SCK = PIN_SPI_SCK;
  * eink display pins
  */
 
-#define PIN_EINK_EN (32 + 2) // (0 + 2) Note: this is really just backlight power
 #define PIN_EINK_CS (0 + 26)
 #define PIN_EINK_BUSY (0 + 4)
 #define PIN_EINK_DC (0 + 17)

version.properties

@@ -1,4 +1,4 @@
 [VERSION]  
 major = 2
 minor = 1
-build = 1
+build = 3