feat: implement StoreAndForward lastRequest map handling (2) (#3246)

* feat: implement StoreAndForward `lastRequest` map handling

* Correct type, check if NodeNum is in map

---------

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

.github/workflows/main_matrix.yml

@@ -112,6 +112,7 @@ jobs:
           - board: rak4631_eink
           - board: monteops_hw1
           - board: t-echo
+          - board: canaryone
           - board: pca10059_diy_eink
           - board: feather_diy
           - board: nano-g2-ultra
@@ -128,6 +129,7 @@ jobs:
           - board: picow
           - board: rak11310
           - board: senselora_rp2040
+          - board: rp2040-lora
     uses: ./.github/workflows/build_rpi2040.yml
     with:
       board: ${{ matrix.board }}

bin/check-all.sh

@@ -13,7 +13,7 @@ if [[ $# -gt 0 ]]; then
 	# can override which environment by passing arg
 	BOARDS="$@"
 else
-	BOARDS="tlora-v2 tlora-v1 tlora_v1_3 tlora-v2-1-1.6 tbeam heltec-v1 heltec-v2.0 heltec-v2.1 tbeam0.7 meshtastic-diy-v1 rak4631 rak4631_eink rak11200 t-echo pca10059_diy_eink"
+	BOARDS="tlora-v2 tlora-v1 tlora_v1_3 tlora-v2-1-1.6 tbeam heltec-v1 heltec-v2.0 heltec-v2.1 tbeam0.7 meshtastic-diy-v1 rak4631 rak4631_eink rak11200 t-echo canaryone pca10059_diy_eink"
 fi
 
 echo "BOARDS:${BOARDS}"

bin/check-dependencies.sh

@@ -5,17 +5,17 @@
 set -e
 
 if [[ $# -gt 0 ]]; then
-    # can override which environment by passing arg
-    BOARDS="$@"
+	# can override which environment by passing arg
+	BOARDS="$@"
 else
-    BOARDS="rak4631 rak4631_eink t-echo pca10059_diy_eink pico rak11200 tlora-v2 tlora-v1 tlora_v1_3 tlora-v2-1-1.6 tbeam heltec-v1 heltec-v2.0 heltec-v2.1 tbeam0.7 meshtastic-diy-v1 nano-g1 station-g1 m5stack-core m5stack-coreink tbeam-s3-core"
+	BOARDS="rak4631 rak4631_eink t-echo canaryone pca10059_diy_eink pico rak11200 tlora-v2 tlora-v1 tlora_v1_3 tlora-v2-1-1.6 tbeam heltec-v1 heltec-v2.0 heltec-v2.1 tbeam0.7 meshtastic-diy-v1 nano-g1 station-g1 m5stack-core m5stack-coreink tbeam-s3-core"
 fi
 
 echo "BOARDS:${BOARDS}"
 
 CHECK=""
 for BOARD in $BOARDS; do
-     CHECK="${CHECK} -e ${BOARD}"
+	CHECK="${CHECK} -e ${BOARD}"
 done
 
 echo $CHECK

boards/canaryone.json

@@ -0,0 +1,49 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52840_s140_v6.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DARDUINO_NRF52840_CANARY -DNRF52840_XXAA",
+    "f_cpu": "64000000L",
+    "hwids": [["0x239A", "0x4405"]],
+    "usb_product": "CanaryOne",
+    "mcu": "nrf52840",
+    "variant": "canaryone",
+    "variants_dir": "variants",
+    "bsp": {
+      "name": "adafruit"
+    },
+    "softdevice": {
+      "sd_flags": "-DS140",
+      "sd_name": "s140",
+      "sd_version": "6.1.1",
+      "sd_fwid": "0x00B6"
+    },
+    "bootloader": {
+      "settings_addr": "0xFF000"
+    }
+  },
+  "connectivity": ["bluetooth"],
+  "debug": {
+    "jlink_device": "nRF52840_xxAA",
+    "onboard_tools": ["jlink"],
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
+  },
+  "frameworks": ["arduino"],
+  "name": "Canary (Adafruit BSP)",
+  "upload": {
+    "maximum_ram_size": 248832,
+    "maximum_size": 815104,
+    "speed": 115200,
+    "protocol": "nrfutil",
+    "protocols": ["jlink", "nrfjprog", "nrfutil", "stlink"],
+    "use_1200bps_touch": true,
+    "require_upload_port": true,
+    "wait_for_upload_port": true
+  },
+  "url": "https://canaryradio.io/",
+  "vendor": "Canary Radio Company"
+}

boards/eink0.1.json

@@ -29,7 +29,8 @@
   "debug": {
     "jlink_device": "nRF52840_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "TTGO eink (Adafruit BSP)",

boards/lora-relay-v1.json

@@ -29,7 +29,8 @@
   "debug": {
     "jlink_device": "nRF52840_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "Meshtastic Lora Relay V1 (Adafruit BSP)",

boards/lora-relay-v2.json

@@ -29,7 +29,8 @@
   "debug": {
     "jlink_device": "nRF52840_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "Meshtastic Lora Relay V1 (Adafruit BSP)",

boards/lora_isp4520.json

@@ -22,7 +22,8 @@
   "connectivity": ["bluetooth"],
   "debug": {
     "jlink_device": "nRF52832_xxAA",
-    "svd_path": "nrf52.svd"
+    "svd_path": "nrf52.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "lora ISP4520",

boards/nordic_pca10059.json

@@ -32,7 +32,8 @@
   "connectivity": ["bluetooth"],
   "debug": {
     "jlink_device": "nRF52840_xxAA",
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "nRF52840 Dongle",

boards/nrf52840_dk.json

@@ -29,7 +29,8 @@
   "debug": {
     "jlink_device": "nRF52840_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "A modified NRF52840-DK devboard (Adafruit BSP)",

boards/nrf52840_dk_modified.json

@@ -29,7 +29,8 @@
   "debug": {
     "jlink_device": "nRF52840_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "A modified NRF52840-DK devboard (Adafruit BSP)",

boards/ppr.json

@@ -29,7 +29,8 @@
   "debug": {
     "jlink_device": "nRF52840_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "Meshtastic PPR (Adafruit BSP)",

boards/ppr1.json

@@ -29,7 +29,8 @@
   "debug": {
     "jlink_device": "nRF52833_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52833.svd"
+    "svd_path": "nrf52833.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "Meshtastic PPR1 (Adafruit BSP)",

boards/t-echo.json

@@ -33,7 +33,8 @@
   "debug": {
     "jlink_device": "nRF52840_xxAA",
     "onboard_tools": ["jlink"],
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "TTGO eink (Adafruit BSP)",

boards/wiscore_rak4600.json

@@ -32,7 +32,8 @@
   "connectivity": ["bluetooth"],
   "debug": {
     "jlink_device": "nRF52832_xxAA",
-    "svd_path": "nrf52.svd"
+    "svd_path": "nrf52.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino", "zephyr"],
   "name": "Adafruit Bluefruit nRF52832 Feather",

boards/wiscore_rak4631.json

@@ -32,7 +32,8 @@
   "connectivity": ["bluetooth"],
   "debug": {
     "jlink_device": "nRF52840_xxAA",
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "WisCore RAK4631 Board",

boards/xiao_ble_sense.json

@@ -31,7 +31,8 @@
   "connectivity": ["bluetooth"],
   "debug": {
     "jlink_device": "nRF52840_xxAA",
-    "svd_path": "nrf52840.svd"
+    "svd_path": "nrf52840.svd",
+    "openocd_target": "nrf52840-mdk-rs"
   },
   "frameworks": ["arduino"],
   "name": "Seeed Xiao BLE Sense",

platformio.ini

@@ -19,6 +19,7 @@ default_envs = tbeam
 ;default_envs = tlora-t3s3-v1
 ;default_envs = lora-relay-v1 # nrf board
 ;default_envs = t-echo
+;default_envs = canaryone
 ;default_envs = nrf52840dk-geeksville
 ;default_envs = native # lora-relay-v1 # nrf52840dk-geeksville # linux # or if you'd like to change the default to something like lora-relay-v1 put that here
 ;default_envs = nano-g1
@@ -57,6 +58,7 @@ build_flags = -Wno-missing-field-initializers
   -DRADIOLIB_EXCLUDE_SI443X
   -DRADIOLIB_EXCLUDE_RFM2X
   -DRADIOLIB_EXCLUDE_AFSK
+  -DRADIOLIB_EXCLUDE_BELL
   -DRADIOLIB_EXCLUDE_HELLSCHREIBER
   -DRADIOLIB_EXCLUDE_MORSE
   -DRADIOLIB_EXCLUDE_RTTY

src/ButtonThread.cpp

@@ -0,0 +1,219 @@
+#include "ButtonThread.h"
+#include "GPS.h"
+#include "MeshService.h"
+#include "PowerFSM.h"
+#include "RadioLibInterface.h"
+#include "buzz.h"
+#include "graphics/Screen.h"
+#include "main.h"
+#include "modules/ExternalNotificationModule.h"
+#include "power.h"
+#ifdef ARCH_PORTDUINO
+#include "platform/portduino/PortduinoGlue.h"
+#endif
+
+#define DEBUG_BUTTONS 0
+#if DEBUG_BUTTONS
+#define LOG_BUTTON(...) LOG_DEBUG(__VA_ARGS__)
+#else
+#define LOG_BUTTON(...)
+#endif
+
+using namespace concurrency;
+
+volatile ButtonThread::ButtonEventType ButtonThread::btnEvent = ButtonThread::BUTTON_EVENT_NONE;
+
+ButtonThread::ButtonThread() : OSThread("Button")
+{
+#if defined(ARCH_PORTDUINO) || defined(BUTTON_PIN)
+#if defined(ARCH_PORTDUINO)
+    if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC) {
+        userButton = OneButton(settingsMap[user], true, true);
+        LOG_DEBUG("Using GPIO%02d for button\n", settingsMap[user]);
+    }
+#elif defined(BUTTON_PIN)
+    int pin = config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN;
+    this->userButton = OneButton(pin, true, true);
+    LOG_DEBUG("Using GPIO%02d for button\n", pin);
+#endif
+
+#ifdef INPUT_PULLUP_SENSE
+    // Some platforms (nrf52) have a SENSE variant which allows wake from sleep - override what OneButton did
+    pinMode(pin, INPUT_PULLUP_SENSE);
+#endif
+    userButton.attachClick(userButtonPressed);
+    userButton.setClickMs(250);
+    userButton.setPressMs(c_longPressTime);
+    userButton.setDebounceMs(1);
+    userButton.attachDoubleClick(userButtonDoublePressed);
+    userButton.attachMultiClick(userButtonMultiPressed);
+#ifndef T_DECK // T-Deck immediately wakes up after shutdown, so disable this function
+    userButton.attachLongPressStart(userButtonPressedLongStart);
+    userButton.attachLongPressStop(userButtonPressedLongStop);
+#endif
+#if defined(ARCH_PORTDUINO)
+    if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC)
+        wakeOnIrq(settingsMap[user], FALLING);
+#else
+    static OneButton *pBtn = &userButton; // only one instance of ButtonThread is created, so static is safe
+    attachInterrupt(
+        pin,
+        []() {
+            BaseType_t higherWake = 0;
+            mainDelay.interruptFromISR(&higherWake);
+            pBtn->tick();
+        },
+        CHANGE);
+#endif
+#endif
+#ifdef BUTTON_PIN_ALT
+    userButtonAlt = OneButton(BUTTON_PIN_ALT, true, true);
+#ifdef INPUT_PULLUP_SENSE
+    // Some platforms (nrf52) have a SENSE variant which allows wake from sleep - override what OneButton did
+    pinMode(BUTTON_PIN_ALT, INPUT_PULLUP_SENSE);
+#endif
+    userButtonAlt.attachClick(userButtonPressed);
+    userButtonAlt.setClickMs(250);
+    userButtonAlt.setPressMs(c_longPressTime);
+    userButtonAlt.setDebounceMs(1);
+    userButtonAlt.attachDoubleClick(userButtonDoublePressed);
+    userButtonAlt.attachLongPressStart(userButtonPressedLongStart);
+    userButtonAlt.attachLongPressStop(userButtonPressedLongStop);
+    wakeOnIrq(BUTTON_PIN_ALT, FALLING);
+#endif
+
+#ifdef BUTTON_PIN_TOUCH
+    userButtonTouch = OneButton(BUTTON_PIN_TOUCH, true, true);
+    userButtonTouch.attachClick(touchPressed);
+    wakeOnIrq(BUTTON_PIN_TOUCH, FALLING);
+#endif
+}
+
+int32_t ButtonThread::runOnce()
+{
+    // If the button is pressed we suppress CPU sleep until release
+    canSleep = true; // Assume we should not keep the board awake
+
+#if defined(BUTTON_PIN)
+    userButton.tick();
+    canSleep &= userButton.isIdle();
+#elif defined(ARCH_PORTDUINO)
+    if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC) {
+        userButton.tick();
+        canSleep &= userButton.isIdle();
+    }
+#endif
+#ifdef BUTTON_PIN_ALT
+    userButtonAlt.tick();
+    canSleep &= userButtonAlt.isIdle();
+#endif
+#ifdef BUTTON_PIN_TOUCH
+    userButtonTouch.tick();
+    canSleep &= userButtonTouch.isIdle();
+#endif
+
+    if (btnEvent != BUTTON_EVENT_NONE) {
+        switch (btnEvent) {
+        case BUTTON_EVENT_PRESSED: {
+            LOG_BUTTON("press!\n");
+#ifdef BUTTON_PIN
+            if (((config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN) !=
+                 moduleConfig.canned_message.inputbroker_pin_press) ||
+                !(moduleConfig.canned_message.updown1_enabled || moduleConfig.canned_message.rotary1_enabled) ||
+                !moduleConfig.canned_message.enabled) {
+                powerFSM.trigger(EVENT_PRESS);
+            }
+#endif
+#if defined(ARCH_PORTDUINO)
+            if ((settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC) &&
+                    (settingsMap[user] != moduleConfig.canned_message.inputbroker_pin_press) ||
+                !moduleConfig.canned_message.enabled) {
+                powerFSM.trigger(EVENT_PRESS);
+            }
+#endif
+            break;
+        }
+
+        case BUTTON_EVENT_DOUBLE_PRESSED: {
+            LOG_BUTTON("Double press!\n");
+#if defined(USE_EINK) && defined(PIN_EINK_EN)
+            digitalWrite(PIN_EINK_EN, digitalRead(PIN_EINK_EN) == LOW);
+#endif
+            service.refreshLocalMeshNode();
+            service.sendNetworkPing(NODENUM_BROADCAST, true);
+            if (screen)
+                screen->print("Sent ad-hoc ping\n");
+            break;
+        }
+
+        case BUTTON_EVENT_MULTI_PRESSED: {
+            LOG_BUTTON("Multi press!\n");
+            if (!config.device.disable_triple_click && (gps != nullptr)) {
+                gps->toggleGpsMode();
+                if (screen)
+                    screen->forceDisplay();
+            }
+            break;
+        }
+
+        case BUTTON_EVENT_LONG_PRESSED: {
+            LOG_BUTTON("Long press!\n");
+            powerFSM.trigger(EVENT_PRESS);
+            if (screen)
+                screen->startShutdownScreen();
+            playBeep();
+            break;
+        }
+
+        // Do actual shutdown when button released, otherwise the button release
+        // may wake the board immediatedly.
+        case BUTTON_EVENT_LONG_RELEASED: {
+            LOG_INFO("Shutdown from long press\n");
+            playShutdownMelody();
+            delay(3000);
+            power->shutdown();
+            break;
+        }
+        case BUTTON_EVENT_TOUCH_PRESSED: {
+            LOG_BUTTON("Touch press!\n");
+            if (screen)
+                screen->forceDisplay();
+            break;
+        }
+        default:
+            break;
+        }
+        btnEvent = BUTTON_EVENT_NONE;
+    }
+
+    return 50;
+}
+
+/**
+ * Watch a GPIO and if we get an IRQ, wake the main thread.
+ * Use to add wake on button press
+ */
+void ButtonThread::wakeOnIrq(int irq, int mode)
+{
+    attachInterrupt(
+        irq,
+        [] {
+            BaseType_t higherWake = 0;
+            mainDelay.interruptFromISR(&higherWake);
+        },
+        FALLING);
+}
+
+void ButtonThread::userButtonPressedLongStart()
+{
+    if (millis() > c_holdOffTime) {
+        btnEvent = BUTTON_EVENT_LONG_PRESSED;
+    }
+}
+
+void ButtonThread::userButtonPressedLongStop()
+{
+    if (millis() > c_holdOffTime) {
+        btnEvent = BUTTON_EVENT_LONG_RELEASED;
+    }
+}

src/ButtonThread.h

@@ -1,34 +1,29 @@
-#include "PowerFSM.h"
-#include "RadioLibInterface.h"
-#include "buzz.h"
+#pragma once
+
+#include "OneButton.h"
 #include "concurrency/OSThread.h"
 #include "configuration.h"
-#include "graphics/Screen.h"
-#include "main.h"
-#include "modules/ExternalNotificationModule.h"
-#include "power.h"
-#include <OneButton.h>
-
-namespace concurrency
-{
-/**
- * Watch a GPIO and if we get an IRQ, wake the main thread.
- * Use to add wake on button press
- */
-void wakeOnIrq(int irq, int mode)
-{
-    attachInterrupt(
-        irq,
-        [] {
-            BaseType_t higherWake = 0;
-            mainDelay.interruptFromISR(&higherWake);
-        },
-        FALLING);
-}
 
 class ButtonThread : public concurrency::OSThread
 {
-// Prepare for button presses
+  public:
+    static const uint32_t c_longPressTime = 5000; // shutdown after 5s
+    static const uint32_t c_holdOffTime = 30000;  // hold off 30s after boot
+
+    enum ButtonEventType {
+        BUTTON_EVENT_NONE,
+        BUTTON_EVENT_PRESSED,
+        BUTTON_EVENT_DOUBLE_PRESSED,
+        BUTTON_EVENT_MULTI_PRESSED,
+        BUTTON_EVENT_LONG_PRESSED,
+        BUTTON_EVENT_LONG_RELEASED,
+        BUTTON_EVENT_TOUCH_PRESSED
+    };
+
+    ButtonThread();
+    int32_t runOnce() override;
+
+  private:
 #ifdef BUTTON_PIN
     OneButton userButton;
 #endif
@@ -41,200 +36,17 @@ class ButtonThread : public concurrency::OSThread
 #if defined(ARCH_PORTDUINO)
     OneButton userButton;
 #endif
-    static bool shutdown_on_long_stop;
 
-  public:
-    static uint32_t longPressTime;
+    // set during IRQ
+    static volatile ButtonEventType btnEvent;
 
-    // callback returns the period for the next callback invocation (or 0 if we should no longer be called)
-    ButtonThread() : OSThread("Button")
-    {
-#if defined(ARCH_PORTDUINO) || defined(BUTTON_PIN)
-#if defined(ARCH_PORTDUINO)
-        if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC)
-            userButton = OneButton(settingsMap[user], true, true);
-#elif defined(BUTTON_PIN)
-        int pin = config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN;
-        userButton = OneButton(pin, true, true);
-#endif
+    static void wakeOnIrq(int irq, int mode);
 
-#ifdef INPUT_PULLUP_SENSE
-        // Some platforms (nrf52) have a SENSE variant which allows wake from sleep - override what OneButton did
-        pinMode(pin, INPUT_PULLUP_SENSE);
-#endif
-        userButton.attachClick(userButtonPressed);
-        userButton.setClickMs(400);
-        userButton.setPressMs(1000);
-        userButton.setDebounceMs(10);
-        userButton.attachDuringLongPress(userButtonPressedLong);
-        userButton.attachDoubleClick(userButtonDoublePressed);
-        userButton.attachMultiClick(userButtonMultiPressed);
-        userButton.attachLongPressStart(userButtonPressedLongStart);
-        userButton.attachLongPressStop(userButtonPressedLongStop);
-#if defined(ARCH_PORTDUINO)
-        if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC)
-            wakeOnIrq(settingsMap[user], FALLING);
-#else
-        static OneButton *pBtn = &userButton; // only one instance of ButtonThread is created, so static is safe
-        attachInterrupt(
-            pin,
-            []() {
-                BaseType_t higherWake = 0;
-                mainDelay.interruptFromISR(&higherWake);
-                pBtn->tick();
-            },
-            CHANGE);
-#endif
-#endif
-#ifdef BUTTON_PIN_ALT
-        userButtonAlt = OneButton(BUTTON_PIN_ALT, true, true);
-#ifdef INPUT_PULLUP_SENSE
-        // Some platforms (nrf52) have a SENSE variant which allows wake from sleep - override what OneButton did
-        pinMode(BUTTON_PIN_ALT, INPUT_PULLUP_SENSE);
-#endif
-        userButtonAlt.attachClick(userButtonPressed);
-        userButtonAlt.attachDuringLongPress(userButtonPressedLong);
-        userButtonAlt.attachDoubleClick(userButtonDoublePressed);
-        userButtonAlt.attachLongPressStart(userButtonPressedLongStart);
-        userButtonAlt.attachLongPressStop(userButtonPressedLongStop);
-        wakeOnIrq(BUTTON_PIN_ALT, FALLING);
-#endif
-
-#ifdef BUTTON_PIN_TOUCH
-        userButtonTouch = OneButton(BUTTON_PIN_TOUCH, true, true);
-        userButtonTouch.attachClick(touchPressed);
-        wakeOnIrq(BUTTON_PIN_TOUCH, FALLING);
-#endif
-    }
-
-  protected:
-    /// If the button is pressed we suppress CPU sleep until release
-    int32_t runOnce() override
-    {
-        canSleep = true; // Assume we should not keep the board awake
-
-#if defined(BUTTON_PIN)
-        userButton.tick();
-        canSleep &= userButton.isIdle();
-#elif defined(ARCH_PORTDUINO)
-        if (settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC) {
-            userButton.tick();
-            canSleep &= userButton.isIdle();
-        }
-#endif
-#ifdef BUTTON_PIN_ALT
-        userButtonAlt.tick();
-        canSleep &= userButtonAlt.isIdle();
-#endif
-#ifdef BUTTON_PIN_TOUCH
-        userButtonTouch.tick();
-        canSleep &= userButtonTouch.isIdle();
-#endif
-        // if (!canSleep) LOG_DEBUG("Suppressing sleep!\n");
-        // else LOG_DEBUG("sleep ok\n");
-
-        return 50;
-    }
-
-  private:
-    static void touchPressed()
-    {
-        screen->forceDisplay();
-        LOG_DEBUG("touch press!\n");
-    }
-
-    static void userButtonPressed()
-    {
-        // LOG_DEBUG("press!\n");
-#ifdef BUTTON_PIN
-        if (((config.device.button_gpio ? config.device.button_gpio : BUTTON_PIN) !=
-             moduleConfig.canned_message.inputbroker_pin_press) ||
-            !(moduleConfig.canned_message.updown1_enabled || moduleConfig.canned_message.rotary1_enabled) ||
-            !moduleConfig.canned_message.enabled) {
-            powerFSM.trigger(EVENT_PRESS);
-        }
-#endif
-#if defined(ARCH_PORTDUINO)
-        if ((settingsMap.count(user) != 0 && settingsMap[user] != RADIOLIB_NC) &&
-                (settingsMap[user] != moduleConfig.canned_message.inputbroker_pin_press) ||
-            !moduleConfig.canned_message.enabled) {
-            powerFSM.trigger(EVENT_PRESS);
-        }
-#endif
-    }
-    static void userButtonPressedLong()
-    {
-        // LOG_DEBUG("Long press!\n");
-        // If user button is held down for 5 seconds, shutdown the device.
-        if ((millis() - longPressTime > 5000) && (longPressTime > 0)) {
-#if 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)) {
-                screen->startShutdownScreen();
-                LOG_INFO("Shutdown from long press");
-                playBeep();
-#ifdef PIN_LED1
-                ledOff(PIN_LED1);
-#endif
-#ifdef PIN_LED2
-                ledOff(PIN_LED2);
-#endif
-#ifdef PIN_LED3
-                ledOff(PIN_LED3);
-#endif
-                shutdown_on_long_stop = true;
-            }
-#endif
-        } else {
-            // LOG_DEBUG("Long press %u\n", (millis() - longPressTime));
-        }
-    }
-
-    static void userButtonDoublePressed()
-    {
-#if defined(USE_EINK) && defined(PIN_EINK_EN)
-        digitalWrite(PIN_EINK_EN, digitalRead(PIN_EINK_EN) == LOW);
-#endif
-        screen->print("Sent ad-hoc ping\n");
-        service.refreshLocalMeshNode();
-        service.sendNetworkPing(NODENUM_BROADCAST, true);
-    }
-
-    static void userButtonMultiPressed()
-    {
-        if (!config.device.disable_triple_click && (gps != nullptr)) {
-            gps->toggleGpsMode();
-            screen->forceDisplay();
-        }
-    }
-
-    static void userButtonPressedLongStart()
-    {
-#ifdef T_DECK
-        // False positive long-press triggered on T-Deck with i2s audio, so short circuit
-        if (moduleConfig.external_notification.enabled && (externalNotificationModule->nagCycleCutoff != UINT32_MAX)) {
-            return;
-        }
-#endif
-        if (millis() > 30 * 1000) {
-            LOG_DEBUG("Long press start!\n");
-            longPressTime = millis();
-        }
-    }
-
-    static void userButtonPressedLongStop()
-    {
-        if (millis() > 30 * 1000) {
-            LOG_DEBUG("Long press stop!\n");
-            longPressTime = 0;
-            if (shutdown_on_long_stop) {
-                playShutdownMelody();
-                delay(3000);
-                power->shutdown();
-            }
-        }
-    }
+    // IRQ callbacks
+    static void touchPressed() { btnEvent = BUTTON_EVENT_TOUCH_PRESSED; }
+    static void userButtonPressed() { btnEvent = BUTTON_EVENT_PRESSED; }
+    static void userButtonDoublePressed() { btnEvent = BUTTON_EVENT_DOUBLE_PRESSED; }
+    static void userButtonMultiPressed() { btnEvent = BUTTON_EVENT_MULTI_PRESSED; }
+    static void userButtonPressedLongStart();
+    static void userButtonPressedLongStop();
 };
-
-} // namespace concurrency

src/DebugConfiguration.h

@@ -28,7 +28,7 @@
 #define DEBUG_PORT (*console) // Serial debug port
 
 #ifdef USE_SEGGER
-#define DEBUG_PORT
+// #undef DEBUG_PORT
 #define LOG_DEBUG(...) SEGGER_RTT_printf(0, __VA_ARGS__)
 #define LOG_INFO(...) SEGGER_RTT_printf(0, __VA_ARGS__)
 #define LOG_WARN(...) SEGGER_RTT_printf(0, __VA_ARGS__)

src/Power.cpp

@@ -127,8 +127,6 @@ class AnalogBatteryLevel : public HasBatteryLevel
 {
     /**
      * Battery state of charge, from 0 to 100 or -1 for unknown
-     *
-     * FIXME - use a lipo lookup table, the current % full is super wrong
      */
     virtual int getBatteryPercent() override
     {
@@ -137,13 +135,32 @@ class AnalogBatteryLevel : public HasBatteryLevel
         if (v < noBatVolt)
             return -1; // If voltage is super low assume no battery installed
 
-#ifdef ARCH_ESP32
+#ifdef NO_BATTERY_LEVEL_ON_CHARGE
         // This does not work on a RAK4631 with battery connected
         if (v > chargingVolt)
             return 0; // While charging we can't report % full on the battery
 #endif
-
-        return clamp((int)(100 * (v - emptyVolt) / (fullVolt - emptyVolt)), 0, 100);
+        /**
+         * @brief   Battery voltage lookup table interpolation to obtain a more
+         * precise percentage rather than the old proportional one.
+         * @author  Gabriele Russo
+         * @date    06/02/2024
+         */
+        float battery_SOC = 0.0;
+        uint16_t voltage = v / NUM_CELLS; // single cell voltage (average)
+        for (int i = 0; i < NUM_OCV_POINTS; i++) {
+            if (OCV[i] <= voltage) {
+                if (i == 0) {
+                    battery_SOC = 100.0; // 100% full
+                } else {
+                    // interpolate between OCV[i] and OCV[i-1]
+                    battery_SOC = (float)100.0 / (NUM_OCV_POINTS - 1.0) *
+                                  (NUM_OCV_POINTS - 1.0 - i + ((float)voltage - OCV[i]) / (OCV[i - 1] - OCV[i]));
+                }
+                break;
+            }
+        }
+        return clamp((int)(battery_SOC), 0, 100);
     }
 
     /**
@@ -165,7 +182,7 @@ class AnalogBatteryLevel : public HasBatteryLevel
 
 #ifndef BATTERY_SENSE_SAMPLES
 #define BATTERY_SENSE_SAMPLES                                                                                                    \
-    30 // Set the number of samples, it has an effect of increasing sensitivity in complex electromagnetic environment.
+    15 // Set the number of samples, it has an effect of increasing sensitivity in complex electromagnetic environment.
 #endif
 
 #ifdef BATTERY_PIN
@@ -191,12 +208,11 @@ class AnalogBatteryLevel : public HasBatteryLevel
             raw = raw / BATTERY_SENSE_SAMPLES;
             scaled = operativeAdcMultiplier * ((1000 * AREF_VOLTAGE) / pow(2, BATTERY_SENSE_RESOLUTION_BITS)) * raw;
 #endif
-            // LOG_DEBUG("battery gpio %d raw val=%u scaled=%u\n", BATTERY_PIN, raw, (uint32_t)(scaled));
-            last_read_value = scaled;
-            return scaled;
-        } else {
-            return last_read_value;
+            last_read_value += (scaled - last_read_value) * 0.5; // Virtual LPF
+            // LOG_DEBUG("battery gpio %d raw val=%u scaled=%u filtered=%u\n", BATTERY_PIN, raw, (uint32_t)(scaled), (uint32_t)
+            // (last_read_value));
         }
+        return last_read_value;
 #endif // BATTERY_PIN
         return 0;
     }
@@ -209,24 +225,56 @@ class AnalogBatteryLevel : public HasBatteryLevel
     {
 
         uint32_t raw = 0;
+        uint8_t raw_c = 0; // raw reading counter
 
 #ifndef BAT_MEASURE_ADC_UNIT // ADC1
-#ifdef ADC_CTRL
-        if (heltec_version == 5) {
-            pinMode(ADC_CTRL, OUTPUT);
-            digitalWrite(ADC_CTRL, HIGH);
-            delay(10);
-        }
+#ifdef ADC_CTRL              // enable adc voltage divider when we need to read
+        pinMode(ADC_CTRL, OUTPUT);
+        digitalWrite(ADC_CTRL, ADC_CTRL_ENABLED);
+        delay(10);
 #endif
         for (int i = 0; i < BATTERY_SENSE_SAMPLES; i++) {
-            raw += adc1_get_raw(adc_channel);
-        }
-#ifdef ADC_CTRL
-        if (heltec_version == 5) {
-            digitalWrite(ADC_CTRL, LOW);
+            int val_ = adc1_get_raw(adc_channel);
+            if (val_ >= 0) { // save only valid readings
+                raw += val_;
+                raw_c++;
+            }
+            // delayMicroseconds(100);
         }
+#ifdef ADC_CTRL // disable adc voltage divider when we need to read
+        digitalWrite(ADC_CTRL, !ADC_CTRL_ENABLED);
 #endif
-#else  // ADC2
+#else // ADC2
+#ifdef ADC_CTRL
+#if defined(HELTEC_WIRELESS_PAPER) || defined(HELTEC_WIRELESS_PAPER_V1_0)
+        pinMode(ADC_CTRL, OUTPUT);
+        digitalWrite(ADC_CTRL, LOW); // ACTIVE LOW
+        delay(10);
+#endif
+#endif // End ADC_CTRL
+
+#ifdef CONFIG_IDF_TARGET_ESP32S3 // ESP32S3
+        // ADC2 wifi bug workaround not required, breaks compile
+        // On ESP32S3, ADC2 can take turns with Wifi (?)
+
+        int32_t adc_buf;
+        esp_err_t read_result;
+
+        // Multiple samples
+        for (int i = 0; i < BATTERY_SENSE_SAMPLES; i++) {
+            adc_buf = 0;
+            read_result = -1;
+
+            read_result = adc2_get_raw(adc_channel, ADC_WIDTH_BIT_12, &adc_buf);
+            if (read_result == ESP_OK) {
+                raw += adc_buf;
+                raw_c++; // Count valid samples
+            } else {
+                LOG_DEBUG("An attempt to sample ADC2 failed\n");
+            }
+        }
+
+#else  // Other ESP32
         int32_t adc_buf = 0;
         for (int i = 0; i < BATTERY_SENSE_SAMPLES; i++) {
             // ADC2 wifi bug workaround, see
@@ -235,10 +283,18 @@ class AnalogBatteryLevel : public HasBatteryLevel
             SET_PERI_REG_MASK(SENS_SAR_READ_CTRL2_REG, SENS_SAR2_DATA_INV);
             adc2_get_raw(adc_channel, ADC_WIDTH_BIT_12, &adc_buf);
             raw += adc_buf;
+            raw_c++;
         }
 #endif // BAT_MEASURE_ADC_UNIT
-        raw = raw / BATTERY_SENSE_SAMPLES;
-        return raw;
+
+#ifdef ADC_CTRL
+#if defined(HELTEC_WIRELESS_PAPER) || defined(HELTEC_WIRELESS_PAPER_V1_0)
+        digitalWrite(ADC_CTRL, HIGH);
+#endif
+#endif // End ADC_CTRL
+
+#endif // End BAT_MEASURE_ADC_UNIT
+        return (raw / (raw_c < 1 ? 1 : raw_c));
     }
 #endif
 
@@ -272,22 +328,14 @@ class AnalogBatteryLevel : public HasBatteryLevel
     /// If we see a battery voltage higher than physics allows - assume charger is pumping
     /// in power
 
-#ifndef BAT_FULLVOLT
-#define BAT_FULLVOLT 4200
-#endif
-#ifndef BAT_EMPTYVOLT
-#define BAT_EMPTYVOLT 3270
-#endif
-#ifndef BAT_CHARGINGVOLT
-#define BAT_CHARGINGVOLT 4210
-#endif
-#ifndef BAT_NOBATVOLT
-#define BAT_NOBATVOLT 2230
-#endif
-
-    /// For heltecs with no battery connected, the measured voltage is 2204, so raising to 2230 from 2100
-    const float fullVolt = BAT_FULLVOLT, emptyVolt = BAT_EMPTYVOLT, chargingVolt = BAT_CHARGINGVOLT, noBatVolt = BAT_NOBATVOLT;
-    float last_read_value = 0.0;
+    /// For heltecs with no battery connected, the measured voltage is 2204, so
+    // need to be higher than that, in this case is 2500mV (3000-500)
+    const uint16_t OCV[NUM_OCV_POINTS] = {OCV_ARRAY};
+    const float chargingVolt = (OCV[0] + 10) * NUM_CELLS;
+    const float noBatVolt = (OCV[NUM_OCV_POINTS - 1] - 500) * NUM_CELLS;
+    // Start value from minimum voltage for the filter to not start from 0
+    // that could trigger some events.
+    float last_read_value = (OCV[NUM_OCV_POINTS - 1] * NUM_CELLS);
     uint32_t last_read_time_ms = 0;
 
 #if defined(HAS_TELEMETRY) && !defined(ARCH_PORTDUINO)
@@ -364,8 +412,11 @@ bool Power::analogInit()
     adc1_config_channel_atten(adc_channel, atten);
 #else // ADC2
     adc2_config_channel_atten(adc_channel, atten);
+#ifndef CONFIG_IDF_TARGET_ESP32S3
     // ADC2 wifi bug workaround
+    // Not required with ESP32S3, breaks compile
     RTC_reg_b = READ_PERI_REG(SENS_SAR_READ_CTRL2_REG);
+#endif
 #endif
     // calibrate ADC
     esp_adc_cal_value_t val_type = esp_adc_cal_characterize(unit, atten, width, DEFAULT_VREF, adc_characs);
@@ -374,13 +425,16 @@ bool Power::analogInit()
         LOG_INFO("ADCmod: ADC characterization based on Two Point values stored in eFuse\n");
     } else if (val_type == ESP_ADC_CAL_VAL_EFUSE_VREF) {
         LOG_INFO("ADCmod: ADC characterization based on reference voltage stored in eFuse\n");
-    } else {
+    }
+#ifdef CONFIG_IDF_TARGET_ESP32S3
+    // ESP32S3
+    else if (val_type == ESP_ADC_CAL_VAL_EFUSE_TP_FIT) {
+        LOG_INFO("ADCmod: ADC Characterization based on Two Point values and fitting curve coefficients stored in eFuse\n");
+    }
+#endif
+    else {
         LOG_INFO("ADCmod: ADC characterization based on default reference voltage\n");
     }
-#if defined(HELTEC_V3) || defined(HELTEC_WSL_V3)
-    pinMode(37, OUTPUT); // needed for P channel mosfet to work
-    digitalWrite(37, LOW);
-#endif
 #endif // ARCH_ESP32
 
 #ifdef ARCH_NRF52
@@ -390,7 +444,10 @@ bool Power::analogInit()
     analogReference(AR_INTERNAL); // 3.6V
 #endif
 #endif // ARCH_NRF52
+
+#ifndef ARCH_ESP32
     analogReadResolution(BATTERY_SENSE_RESOLUTION_BITS);
+#endif
 
     batteryLevel = &analogLevel;
     return true;
@@ -458,11 +515,11 @@ void Power::readPowerStatus()
                 batteryChargePercent = batteryLevel->getBatteryPercent();
             } else {
                 // If the AXP192 returns a percentage less than 0, the feature is either not supported or there is an error
-                // In that case, we compute an estimate of the charge percent based on maximum and minimum voltages defined in
-                // power.h
-                batteryChargePercent =
-                    clamp((int)(((batteryVoltageMv - BAT_MILLIVOLTS_EMPTY) * 1e2) / (BAT_MILLIVOLTS_FULL - BAT_MILLIVOLTS_EMPTY)),
-                          0, 100);
+                // In that case, we compute an estimate of the charge percent based on open circuite voltage table defined
+                // in power.h
+                batteryChargePercent = clamp((int)(((batteryVoltageMv - (OCV[NUM_OCV_POINTS - 1] * NUM_CELLS)) * 1e2) /
+                                                   ((OCV[0] * NUM_CELLS) - (OCV[NUM_OCV_POINTS - 1] * NUM_CELLS))),
+                                             0, 100);
             }
         }
 
@@ -527,10 +584,11 @@ void Power::readPowerStatus()
 
 #endif
 
-        // If we have a battery at all and it is less than 10% full, force deep sleep if we have more than 10 low readings in
-        // a row
+        // If we have a battery at all and it is less than 0%, force deep sleep if we have more than 10 low readings in
+        // a row. NOTE: min LiIon/LiPo voltage is 2.0 to 2.5V, current OCV min is set to 3100 that is large enough.
+        //
         if (powerStatus2.getHasBattery() && !powerStatus2.getHasUSB()) {
-            if (batteryLevel->getBattVoltage() < MIN_BAT_MILLIVOLTS) {
+            if (batteryLevel->getBattVoltage() < OCV[NUM_OCV_POINTS - 1]) {
                 low_voltage_counter++;
                 LOG_DEBUG("Low voltage counter: %d/10\n", low_voltage_counter);
                 if (low_voltage_counter > 10) {

src/PowerFSM.cpp

@@ -246,6 +246,7 @@ void PowerFSM_setup()
 {
     bool isRouter = (config.device.role == meshtastic_Config_DeviceConfig_Role_ROUTER ? 1 : 0);
     bool isTrackerOrSensor = config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
+                             config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER ||
                              config.device.role == meshtastic_Config_DeviceConfig_Role_SENSOR;
     bool hasPower = isPowered();
 

src/configuration.h

@@ -142,8 +142,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // -----------------------------------------------------------------------------
 // GPS
 // -----------------------------------------------------------------------------
-
+#ifndef GPS_BAUDRATE
 #define GPS_BAUDRATE 9600
+#endif
 
 #ifndef GPS_THREAD_INTERVAL
 #define GPS_THREAD_INTERVAL 200
@@ -161,6 +162,17 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 /* Step #3: mop up with disabled values for HAS_ options not handled by the above two */
 
+// -----------------------------------------------------------------------------
+// GPS
+// -----------------------------------------------------------------------------
+
+#ifndef GPS_BAUDRATE
+#define GPS_BAUDRATE 9600
+#endif
+#ifndef GPS_THREAD_INTERVAL
+#define GPS_THREAD_INTERVAL 100
+#endif
+
 #ifndef HAS_WIFI
 #define HAS_WIFI 0
 #endif

src/gps/GPS.cpp

@@ -358,87 +358,98 @@ bool GPS::setup()
                         delay(1000);
                     }
                 }
+                // Disable Text Info messages
+                msglen = makeUBXPacket(0x06, 0x02, sizeof(_message_DISABLE_TXT_INFO), _message_DISABLE_TXT_INFO);
+                clearBuffer();
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x02, 500) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to disable text info messages.\n");
+                }
                 // ToDo add M10 tests for below
                 if (strncmp(info.hwVersion, "00080000", 8) == 0) {
                     msglen = makeUBXPacket(0x06, 0x39, sizeof(_message_JAM_8), _message_JAM_8);
+                    clearBuffer();
                     _serial_gps->write(UBXscratch, msglen);
-                    if (getACK(0x06, 0x39, 300) != GNSS_RESPONSE_OK) {
+                    if (getACK(0x06, 0x39, 500) != GNSS_RESPONSE_OK) {
                         LOG_WARN("Unable to enable interference resistance.\n");
                     }
-                    clearBuffer();
+
                     msglen = makeUBXPacket(0x06, 0x23, sizeof(_message_NAVX5_8), _message_NAVX5_8);
+                    clearBuffer();
                     _serial_gps->write(UBXscratch, msglen);
-                    if (getACK(0x06, 0x23, 300) != GNSS_RESPONSE_OK) {
-                        LOG_WARN("Unable to configure extra settings.\n");
+                    if (getACK(0x06, 0x23, 500) != GNSS_RESPONSE_OK) {
+                        LOG_WARN("Unable to configure NAVX5_8 settings.\n");
                     }
                 } else {
                     msglen = makeUBXPacket(0x06, 0x39, sizeof(_message_JAM_6_7), _message_JAM_6_7);
                     _serial_gps->write(UBXscratch, msglen);
-                    if (getACK(0x06, 0x39, 300) != GNSS_RESPONSE_OK) {
+                    if (getACK(0x06, 0x39, 500) != GNSS_RESPONSE_OK) {
                         LOG_WARN("Unable to enable interference resistance.\n");
                     }
 
                     msglen = makeUBXPacket(0x06, 0x23, sizeof(_message_NAVX5), _message_NAVX5);
                     _serial_gps->write(UBXscratch, msglen);
-                    if (getACK(0x06, 0x23, 300) != GNSS_RESPONSE_OK) {
-                        LOG_WARN("Unable to configure extra settings.\n");
+                    if (getACK(0x06, 0x23, 500) != GNSS_RESPONSE_OK) {
+                        LOG_WARN("Unable to configure NAVX5 settings.\n");
                     }
                 }
-                // ublox-M10S can be compatible with UBLOX traditional protocol, so the following sentence settings are also valid
+                // Turn off unwanted NMEA messages, set update rate
 
                 msglen = makeUBXPacket(0x06, 0x08, sizeof(_message_1HZ), _message_1HZ);
                 _serial_gps->write(UBXscratch, msglen);
-                if (getACK(0x06, 0x08, 400) != GNSS_RESPONSE_OK) {
+                if (getACK(0x06, 0x08, 500) != GNSS_RESPONSE_OK) {
                     LOG_WARN("Unable to set GPS update rate.\n");
                 }
 
                 msglen = makeUBXPacket(0x06, 0x01, sizeof(_message_GLL), _message_GLL);
                 _serial_gps->write(UBXscratch, msglen);
-                if (getACK(0x06, 0x01, 300) != GNSS_RESPONSE_OK) {
+                if (getACK(0x06, 0x01, 500) != GNSS_RESPONSE_OK) {
                     LOG_WARN("Unable to disable NMEA GLL.\n");
                 }
 
                 msglen = makeUBXPacket(0x06, 0x01, sizeof(_message_GSA), _message_GSA);
                 _serial_gps->write(UBXscratch, msglen);
-                if (getACK(0x06, 0x01, 300) != GNSS_RESPONSE_OK) {
+                if (getACK(0x06, 0x01, 500) != GNSS_RESPONSE_OK) {
                     LOG_WARN("Unable to Enable NMEA GSA.\n");
                 }
 
                 msglen = makeUBXPacket(0x06, 0x01, sizeof(_message_GSV), _message_GSV);
                 _serial_gps->write(UBXscratch, msglen);
-                if (getACK(0x06, 0x01, 300) != GNSS_RESPONSE_OK) {
+                if (getACK(0x06, 0x01, 500) != GNSS_RESPONSE_OK) {
                     LOG_WARN("Unable to disable NMEA GSV.\n");
                 }
 
                 msglen = makeUBXPacket(0x06, 0x01, sizeof(_message_VTG), _message_VTG);
                 _serial_gps->write(UBXscratch, msglen);
-                if (getACK(0x06, 0x01, 300) != GNSS_RESPONSE_OK) {
+                if (getACK(0x06, 0x01, 500) != GNSS_RESPONSE_OK) {
                     LOG_WARN("Unable to disable NMEA VTG.\n");
                 }
 
                 msglen = makeUBXPacket(0x06, 0x01, sizeof(_message_RMC), _message_RMC);
                 _serial_gps->write(UBXscratch, msglen);
-                if (getACK(0x06, 0x01, 300) != GNSS_RESPONSE_OK) {
+                if (getACK(0x06, 0x01, 500) != GNSS_RESPONSE_OK) {
                     LOG_WARN("Unable to enable NMEA RMC.\n");
                 }
 
                 msglen = makeUBXPacket(0x06, 0x01, sizeof(_message_GGA), _message_GGA);
                 _serial_gps->write(UBXscratch, msglen);
-                if (getACK(0x06, 0x01, 300) != GNSS_RESPONSE_OK) {
+                if (getACK(0x06, 0x01, 500) != GNSS_RESPONSE_OK) {
                     LOG_WARN("Unable to enable NMEA GGA.\n");
                 }
-                clearBuffer();
+
                 if (uBloxProtocolVersion >= 18) {
                     msglen = makeUBXPacket(0x06, 0x86, sizeof(_message_PMS), _message_PMS);
+                    clearBuffer();
                     _serial_gps->write(UBXscratch, msglen);
-                    if (getACK(0x06, 0x86, 300) != GNSS_RESPONSE_OK) {
+                    if (getACK(0x06, 0x86, 500) != GNSS_RESPONSE_OK) {
                         LOG_WARN("Unable to enable powersaving for GPS.\n");
                     }
                     // For M8 we want to enable NMEA vserion 4.10 so we can see the additional sats.
                     if (strncmp(info.hwVersion, "00080000", 8) == 0) {
                         msglen = makeUBXPacket(0x06, 0x17, sizeof(_message_NMEA), _message_NMEA);
+                        clearBuffer();
                         _serial_gps->write(UBXscratch, msglen);
-                        if (getACK(0x06, 0x17, 400) != GNSS_RESPONSE_OK) {
+                        if (getACK(0x06, 0x17, 500) != GNSS_RESPONSE_OK) {
                             LOG_WARN("Unable to enable NMEA 4.10.\n");
                         }
                     }
@@ -447,23 +458,23 @@ bool GPS::setup()
                     if (strncmp(info.hwVersion, "00040007", 8) == 0) { // This PSM mode is only for Neo-6
                         msglen = makeUBXPacket(0x06, 0x11, 0x2, _message_CFG_RXM_ECO);
                         _serial_gps->write(UBXscratch, msglen);
-                        if (getACK(0x06, 0x11, 300) != GNSS_RESPONSE_OK) {
+                        if (getACK(0x06, 0x11, 500) != GNSS_RESPONSE_OK) {
                             LOG_WARN("Unable to enable powersaving ECO mode for Neo-6.\n");
                         }
-                        msglen = makeUBXPacket(0x06, 0x3B, 44, _message_CFG_PM2);
+                        msglen = makeUBXPacket(0x06, 0x3B, sizeof(_message_CFG_PM2), _message_CFG_PM2);
                         _serial_gps->write(UBXscratch, msglen);
-                        if (getACK(0x06, 0x3B, 300) != GNSS_RESPONSE_OK) {
+                        if (getACK(0x06, 0x3B, 500) != GNSS_RESPONSE_OK) {
                             LOG_WARN("Unable to enable powersaving details for GPS.\n");
                         }
                         msglen = makeUBXPacket(0x06, 0x01, sizeof(_message_AID), _message_AID);
                         _serial_gps->write(UBXscratch, msglen);
-                        if (getACK(0x06, 0x01, 300) != GNSS_RESPONSE_OK) {
+                        if (getACK(0x06, 0x01, 500) != GNSS_RESPONSE_OK) {
                             LOG_WARN("Unable to disable UBX-AID.\n");
                         }
                     } else {
                         msglen = makeUBXPacket(0x06, 0x11, 0x2, _message_CFG_RXM_PSM);
                         _serial_gps->write(UBXscratch, msglen);
-                        if (getACK(0x06, 0x11, 300) != GNSS_RESPONSE_OK) {
+                        if (getACK(0x06, 0x11, 500) != GNSS_RESPONSE_OK) {
                             LOG_WARN("Unable to enable powersaving mode for GPS.\n");
                         }
                     }
@@ -477,7 +488,96 @@ bool GPS::setup()
                     LOG_INFO("GNSS module configuration saved!\n");
                 }
             } else {
-                LOG_INFO("u-blox M10 hardware found, using defaults for now\n");
+                // LOG_INFO("u-blox M10 hardware found.\n");
+                delay(1000);
+                // First disable all NMEA messages in RAM layer
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_DISABLE_NMEA_RAM), _message_VALSET_DISABLE_NMEA_RAM);
+                clearBuffer();
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to disable NMEA messages for M10 GPS RAM.\n");
+                }
+                delay(250);
+                // Next disable unwanted NMEA messages in BBR layer
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_DISABLE_NMEA_BBR), _message_VALSET_DISABLE_NMEA_BBR);
+                clearBuffer();
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to disable NMEA messages for M10 GPS BBR.\n");
+                }
+                delay(250);
+                // Disable Info txt messages in RAM layer
+                msglen =
+                    makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_DISABLE_TXT_INFO_RAM), _message_VALSET_DISABLE_TXT_INFO_RAM);
+                clearBuffer();
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to disable Info messages for M10 GPS RAM.\n");
+                }
+                delay(250);
+                // Next disable Info txt messages in BBR layer
+                msglen =
+                    makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_DISABLE_TXT_INFO_BBR), _message_VALSET_DISABLE_TXT_INFO_BBR);
+                clearBuffer();
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to disable Info messages for M10 GPS BBR.\n");
+                }
+                // Do M10 configuration for Power Management.
+
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_PM_RAM), _message_VALSET_PM_RAM);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to enable powersaving for M10 GPS RAM.\n");
+                }
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_PM_BBR), _message_VALSET_PM_BBR);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to enable powersaving for M10 GPS BBR.\n");
+                }
+
+                delay(250);
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_ITFM_RAM), _message_VALSET_ITFM_RAM);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to enable Jamming detection M10 GPS RAM.\n");
+                }
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_ITFM_BBR), _message_VALSET_ITFM_BBR);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to enable Jamming detection M10 GPS BBR.\n");
+                }
+
+                // Here is where the init commands should go to do further M10 initialization.
+                delay(250);
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_DISABLE_SBAS_RAM), _message_VALSET_DISABLE_SBAS_RAM);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to disable SBAS M10 GPS RAM.\n");
+                }
+                delay(750); // will cause a receiver restart so wait a bit
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_DISABLE_SBAS_BBR), _message_VALSET_DISABLE_SBAS_BBR);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to disable SBAS M10 GPS BBR.\n");
+                }
+                delay(750); // will cause a receiver restart so wait a bit
+                // Done with initialization, Now enable wanted NMEA messages in BBR layer so they will survive a periodic sleep.
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_ENABLE_NMEA_BBR), _message_VALSET_ENABLE_NMEA_BBR);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to enable messages for M10 GPS BBR.\n");
+                }
+                delay(250);
+                // Next enable wanted NMEA messages in RAM layer
+                msglen = makeUBXPacket(0x06, 0x8A, sizeof(_message_VALSET_ENABLE_NMEA_RAM), _message_VALSET_ENABLE_NMEA_RAM);
+                _serial_gps->write(UBXscratch, msglen);
+                if (getACK(0x06, 0x8A, 300) != GNSS_RESPONSE_OK) {
+                    LOG_WARN("Unable to enable messages for M10 GPS RAM.\n");
+                }
+                // As the M10 has no flash, the best we can do to preserve the config is to set it in RAM and BBR.
+                // BBR will survive a restart, and power off for a while, but modules with small backup
+                // batteries or super caps will not retain the config for a long power off time.
             }
         }
         didSerialInit = true;
@@ -547,10 +647,17 @@ void GPS::setGPSPower(bool on, bool standbyOnly, uint32_t sleepTime)
         if (gnssModel == GNSS_MODEL_UBLOX) {
             uint8_t msglen;
             LOG_DEBUG("Sleep Time: %i\n", sleepTime);
-            for (int i = 0; i < 4; i++) {
-                gps->_message_PMREQ[0 + i] = sleepTime >> (i * 8); // Encode the sleep time in millis into the packet
+            if (strncmp(info.hwVersion, "000A0000", 8) != 0) {
+                for (int i = 0; i < 4; i++) {
+                    gps->_message_PMREQ[0 + i] = sleepTime >> (i * 8); // Encode the sleep time in millis into the packet
+                }
+                msglen = gps->makeUBXPacket(0x02, 0x41, sizeof(_message_PMREQ), gps->_message_PMREQ);
+            } else {
+                for (int i = 0; i < 4; i++) {
+                    gps->_message_PMREQ_10[4 + i] = sleepTime >> (i * 8); // Encode the sleep time in millis into the packet
+                }
+                msglen = gps->makeUBXPacket(0x02, 0x41, sizeof(_message_PMREQ_10), gps->_message_PMREQ_10);
             }
-            msglen = gps->makeUBXPacket(0x02, 0x41, 0x08, gps->_message_PMREQ);
             gps->_serial_gps->write(gps->UBXscratch, msglen);
         }
     } else {

src/gps/GPS.h

@@ -106,6 +106,7 @@ class GPS : private concurrency::OSThread
     static const uint8_t _message_NAVX5[];
     static const uint8_t _message_NAVX5_8[];
     static const uint8_t _message_NMEA[];
+    static const uint8_t _message_DISABLE_TXT_INFO[];
     static const uint8_t _message_1HZ[];
     static const uint8_t _message_GLL[];
     static const uint8_t _message_GSA[];
@@ -117,6 +118,21 @@ class GPS : private concurrency::OSThread
     static const uint8_t _message_PMS[];
     static const uint8_t _message_SAVE[];
 
+    // VALSET Commands for M10
+    static const uint8_t _message_VALSET_PM[];
+    static const uint8_t _message_VALSET_PM_RAM[];
+    static const uint8_t _message_VALSET_PM_BBR[];
+    static const uint8_t _message_VALSET_ITFM_RAM[];
+    static const uint8_t _message_VALSET_ITFM_BBR[];
+    static const uint8_t _message_VALSET_DISABLE_NMEA_RAM[];
+    static const uint8_t _message_VALSET_DISABLE_NMEA_BBR[];
+    static const uint8_t _message_VALSET_DISABLE_TXT_INFO_RAM[];
+    static const uint8_t _message_VALSET_DISABLE_TXT_INFO_BBR[];
+    static const uint8_t _message_VALSET_ENABLE_NMEA_RAM[];
+    static const uint8_t _message_VALSET_ENABLE_NMEA_BBR[];
+    static const uint8_t _message_VALSET_DISABLE_SBAS_RAM[];
+    static const uint8_t _message_VALSET_DISABLE_SBAS_BBR[];
+
     meshtastic_Position p = meshtastic_Position_init_default;
 
     GPS() : concurrency::OSThread("GPS") {}

src/gps/ubx.h

@@ -1,16 +1,16 @@
+// Power Management
+
 uint8_t GPS::_message_PMREQ[] PROGMEM = {
-    0x00, 0x00, // 4 bytes duration of request task
-    0x00, 0x00, // (milliseconds)
-    0x02, 0x00, // Task flag bitfield
-    0x00, 0x00, // byte index 1 = sleep mode
+    0x00, 0x00, 0x00, 0x00, // 4 bytes duration of request task (milliseconds)
+    0x02, 0x00, 0x00, 0x00  // Bitfield, set backup = 1
 };
 
 uint8_t GPS::_message_PMREQ_10[] PROGMEM = {
-    0x00, 0x00,                                    // 4 bytes duration of request task
-    0x00, 0x00,                                    // (milliseconds)
-    0x02, 0x00,                                    // Task flag bitfield
-    0x00, 0x00,                                    // byte index 1 = sleep mode
-    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 // wakeupSources
+    0x00,                   // version (0 for this version)
+    0x00, 0x00, 0x00,       // Reserved 1
+    0x00, 0x00, 0x00, 0x00, // 4 bytes duration of request task (milliseconds)
+    0x06, 0x00, 0x00, 0x00, // Bitfield, set backup =1 and force =1
+    0x08, 0x00, 0x00, 0x00  // wakeupSources Wake on uartrx
 };
 
 const uint8_t GPS::_message_CFG_RXM_PSM[] PROGMEM = {
@@ -46,6 +46,9 @@ const uint8_t GPS::_message_CFG_PM2[] PROGMEM = {
     0x00, 0x00, 0x00, 0x00  // 0x64, 0x40, 0x01, 0x00  // reserved 11
 };
 
+// Constallation setup, none required for Neo-6
+
+// For Neo-7 GPS & SBAS
 const uint8_t GPS::_message_GNSS_7[] = {
     0x00, // msgVer (0 for this version)
     0x00, // numTrkChHw (max number of hardware channels, read only, so it's always 0)
@@ -210,7 +213,7 @@ const uint8_t GPS::_message_GSA[] = {
     0x00,       // Rate for DDC
     0x01,       // Rate for UART1
     0x00,       // Rate for UART2
-    0x00,       // Rate for USB
+    0x01,       // Rate for USB usefull for native linux
     0x00,       // Rate for SPI
     0x00        // Reserved
 };
@@ -244,7 +247,7 @@ const uint8_t GPS::_message_RMC[] = {
     0x00,       // Rate for DDC
     0x01,       // Rate for UART1
     0x00,       // Rate for UART2
-    0x00,       // Rate for USB
+    0x01,       // Rate for USB usefull for native linux
     0x00,       // Rate for SPI
     0x00        // Reserved
 };
@@ -255,7 +258,7 @@ const uint8_t GPS::_message_GGA[] = {
     0x00,       // Rate for DDC
     0x01,       // Rate for UART1
     0x00,       // Rate for UART2
-    0x00,       // Rate for USB
+    0x01,       // Rate for USB, usefull for native linux
     0x00,       // Rate for SPI
     0x00        // Reserved
 };
@@ -272,6 +275,20 @@ const uint8_t GPS::_message_AID[] = {
     0x00        // Reserved
 };
 
+// Turn off TEXT INFO Messages for all but M10 series
+
+// B5 62 06 02 0A 00 01 00 00 00 03 03 00 03 03 00 1F 20
+const uint8_t GPS::_message_DISABLE_TXT_INFO[] = {
+    0x01,             // Protocol ID for NMEA
+    0x00, 0x00, 0x00, // Reserved
+    0x03,             // I2C
+    0x03,             // I/O Port 1
+    0x00,             // I/O Port 2
+    0x03,             // USB
+    0x03,             // SPI
+    0x00              // Reserved
+};
+
 // The Power Management configuration allows the GPS module to operate in different power modes for optimized
 // power consumption. The modes supported are: 0x00 = Full power: The module operates at full power with no power
 // saving. 0x01 = Balanced: The module dynamically adjusts the tracking behavior to balance power consumption.
@@ -283,7 +300,7 @@ const uint8_t GPS::_message_AID[] = {
 // is set to Interval; otherwise, it must be set to '0'. The 'onTime' field specifies the duration of the ON phase
 // and must be smaller than the period. It is only valid when the powerSetupValue is set to Interval; otherwise,
 // it must be set to '0'.
-// This command applies to M8 and higher products
+// This command applies to M8 products
 const uint8_t GPS::_message_PMS[] = {
     0x00,       // Version (0)
     0x03,       // Power setup value 3 = Agresssive 1Hz
@@ -297,4 +314,140 @@ const uint8_t GPS::_message_SAVE[] = {
     0xFF, 0xFF, 0x00, 0x00, // saveMask: save all sections
     0x00, 0x00, 0x00, 0x00, // loadMask: no sections loaded
     0x17                    // deviceMask: BBR, Flash, EEPROM, and SPI Flash
-};
+};
+
+// As the M10 has no flash, the best we can do to preserve the config is to set it in RAM and BBR.
+// BBR will survive a restart, and power off for a while, but modules with small backup
+// batteries or super caps will not retain the config for a long power off time.
+
+// VALSET Commands for M10
+// Please refer to the M10 Protocol Specification:
+// https://content.u-blox.com/sites/default/files/u-blox-M10-SPG-5.10_InterfaceDescription_UBX-21035062.pdf
+// Where the VALSET/VALGET/VALDEL commands are described in detail.
+// and:
+// https://content.u-blox.com/sites/default/files/u-blox-M10-ROM-5.10_ReleaseNotes_UBX-22001426.pdf
+// for interesting insights.
+/*
+CFG-PM2 has been replaced by many CFG-PM commands
+OPERATEMODE E1 2 (0 | 1 | 2)
+POSUPDATEPERIOD U4 1000ms for M10 must be >= 5s try 5
+ACQPERIOD U4 10 seems ok for M10 def ok
+GRIDOFFSET U4 0 seems ok for M10 def ok
+ONTIME U2 1 will try 1
+MINACQTIME U1 0 will try 0 def ok
+MAXACQTIME U1 stick with default of 0 def ok
+DONOTENTEROFF L 1 stay at 1
+WAITTIMEFIX  L 1 stay with 1
+UPDATEEPH L 1 changed to 1 for gps rework default is 1
+EXTINTWAKE L 0 no ext ints
+EXTINTBACKUP L 0 no ext ints
+EXTINTINACTIVE L 0 no ext ints
+EXTINTACTIVITY U4 0 no ext ints
+LIMITPEAKCURRENT L 1 stay with 1
+*/
+// CFG-PMS has been removed
+
+// Ram layer config message:
+// b5 62 06 8a 26 00 00 01 00 00 01 00 d0 20 02 02 00 d0 40 05 00 00 00 05 00 d0 30 01 00 08 00 d0 10 01 09 00 d0 10 01 10 00 d0
+// 10 01 8b de
+
+// BBR layer config message:
+// b5 62 06 8a 26 00 00 02 00 00 01 00 d0 20 02 02 00 d0 40 05 00 00 00 05 00 d0 30 01 00 08 00 d0 10 01 09 00 d0 10 01 10 00 d0
+// 10 01 8c 03
+
+const uint8_t GPS::_message_VALSET_PM_RAM[] = {0x00, 0x01, 0x00, 0x00, 0x01, 0x00, 0xd0, 0x20, 0x02, 0x02, 0x00, 0xd0, 0x40,
+                                               0x05, 0x00, 0x00, 0x00, 0x05, 0x00, 0xd0, 0x30, 0x01, 0x00, 0x08, 0x00, 0xd0,
+                                               0x10, 0x01, 0x09, 0x00, 0xd0, 0x10, 0x01, 0x10, 0x00, 0xd0, 0x10, 0x01};
+const uint8_t GPS::_message_VALSET_PM_BBR[] = {0x00, 0x02, 0x00, 0x00, 0x01, 0x00, 0xd0, 0x20, 0x02, 0x02, 0x00, 0xd0, 0x40,
+                                               0x05, 0x00, 0x00, 0x00, 0x05, 0x00, 0xd0, 0x30, 0x01, 0x00, 0x08, 0x00, 0xd0,
+                                               0x10, 0x01, 0x09, 0x00, 0xd0, 0x10, 0x01, 0x10, 0x00, 0xd0, 0x10, 0x01};
+
+/*
+CFG-ITFM replaced by 5 valset messages which can be combined into one for RAM and one for BBR
+
+20410001 bbthreshold U1 3
+20410002 cwthreshold U1 15
+1041000d enable L        0 -> 1
+20410010 ant E1          0
+10410013 enable aux L    0 -> 1
+
+
+b5 62 06 8a 0e 00 00 01 00 00 0d 00 41 10 01 13 00 41 10 01 63 c6
+*/
+const uint8_t GPS::_message_VALSET_ITFM_RAM[] = {0x00, 0x01, 0x00, 0x00, 0x0d, 0x00, 0x41,
+                                                 0x10, 0x01, 0x13, 0x00, 0x41, 0x10, 0x01};
+const uint8_t GPS::_message_VALSET_ITFM_BBR[] = {0x00, 0x02, 0x00, 0x00, 0x0d, 0x00, 0x41,
+                                                 0x10, 0x01, 0x13, 0x00, 0x41, 0x10, 0x01};
+
+// Turn off all NMEA messages:
+// Ram layer config message:
+// b5 62 06 8a 22 00 00 01 00 00 c0 00 91 20 00 ca 00 91 20 00 c5 00 91 20 00 ac 00 91 20 00 b1 00 91 20 00 bb 00 91 20 00 40 8f
+
+// Disable GLL, GSV, VTG messages in BBR layer
+// BBR layer config message:
+// b5 62 06 8a 13 00 00 02 00 00 ca 00 91 20 00 c5 00 91 20 00 b1 00 91 20 00 f8 4e
+
+const uint8_t GPS::_message_VALSET_DISABLE_NMEA_RAM[] = {
+    /*0x00, 0x01, 0x00, 0x00, 0xca, 0x00, 0x91, 0x20, 0x00, 0xc5, 0x00, 0x91, 0x20, 0x00, 0xb1, 0x00, 0x91, 0x20, 0x00 */
+    0x00, 0x01, 0x00, 0x00, 0xc0, 0x00, 0x91, 0x20, 0x00, 0xca, 0x00, 0x91, 0x20, 0x00, 0xc5, 0x00, 0x91,
+    0x20, 0x00, 0xac, 0x00, 0x91, 0x20, 0x00, 0xb1, 0x00, 0x91, 0x20, 0x00, 0xbb, 0x00, 0x91, 0x20, 0x00};
+
+const uint8_t GPS::_message_VALSET_DISABLE_NMEA_BBR[] = {0x00, 0x02, 0x00, 0x00, 0xca, 0x00, 0x91, 0x20, 0x00, 0xc5,
+                                                         0x00, 0x91, 0x20, 0x00, 0xb1, 0x00, 0x91, 0x20, 0x00};
+
+// Turn off text info messages:
+// Ram layer config message:
+// b5 62 06 8a 09 00 00 01 00 00 07 00 92 20 06 59 50
+
+// BBR layer config message:
+// b5 62 06 8a 09 00 00 02 00 00 07 00 92 20 06 5a 58
+
+// Turn NMEA GSA, GGA, RMC messages on:
+// Ram layer config message:
+// b5 62 06 8a 13 00 00 01 00 00 c0 00 91 20 01 bb 00 91 20 01 ac 00 91 20 01 e1 3b
+
+// BBR layer config message:
+// b5 62 06 8a 13 00 00 02 00 00 c0 00 91 20 01 bb 00 91 20 01 ac 00 91 20 01 e2 4d
+
+const uint8_t GPS::_message_VALSET_DISABLE_TXT_INFO_RAM[] = {0x00, 0x01, 0x00, 0x00, 0x07, 0x00, 0x92, 0x20, 0x03};
+const uint8_t GPS::_message_VALSET_DISABLE_TXT_INFO_BBR[] = {0x00, 0x02, 0x00, 0x00, 0x07, 0x00, 0x92, 0x20, 0x03};
+const uint8_t GPS::_message_VALSET_ENABLE_NMEA_RAM[] = {0x00, 0x01, 0x00, 0x00, 0xc0, 0x00, 0x91, 0x20, 0x01, 0xbb,
+                                                        0x00, 0x91, 0x20, 0x01, 0xac, 0x00, 0x91, 0x20, 0x01};
+const uint8_t GPS::_message_VALSET_ENABLE_NMEA_BBR[] = {0x00, 0x02, 0x00, 0x00, 0xc0, 0x00, 0x91, 0x20, 0x01, 0xbb,
+                                                        0x00, 0x91, 0x20, 0x01, 0xac, 0x00, 0x91, 0x20, 0x01};
+const uint8_t GPS::_message_VALSET_DISABLE_SBAS_RAM[] = {0x00, 0x01, 0x00, 0x00, 0x20, 0x00, 0x31,
+                                                         0x10, 0x00, 0x05, 0x00, 0x31, 0x10, 0x00};
+const uint8_t GPS::_message_VALSET_DISABLE_SBAS_BBR[] = {0x00, 0x02, 0x00, 0x00, 0x20, 0x00, 0x31,
+                                                         0x10, 0x00, 0x05, 0x00, 0x31, 0x10, 0x00};
+/*
+Operational issues with the M10:
+
+PowerSave doesn't work with SBAS, seems like you can have SBAS enabled, but it will never lock
+onto the SBAS sats.
+PowerSave doesn't work with BDS B1C, u-blox says use B1l instead.
+BDS B1l cannot be enabled with BDS B1C or GLONASS L1OF, so GLONASS will work with B1C, but not B1l
+So no powersave with GLONASS and BDS B1l enabled.
+So disable GLONASS and use BDS B1l, which is part of the default M10 config.
+
+GNSS configuration:
+
+Default GNSS configuration is: GPS, Galileo, BDS B1l, with QZSS and SBAS enabled.
+The PMREQ puts the receiver to sleep and wakeup re-acquires really fast and seems to not need
+the PM config. Lets try without it.
+PMREQ sort of works with SBAS, but the awake time is too short to re-acquire any SBAS sats.
+The defination of "Got Fix" doesn't seem to include SBAS. Much more too this...
+Even if it was, it can take minutes (up to 12.5),
+even under good sat visability conditions to re-acquire the SBAS data.
+
+Another effect fo the quick transition to sleep is that no other sats will be acquired so the
+sat count will tend to remain at what the initial fix was.
+*/
+
+// GNSS disable SBAS as recommended by u-blox if using GNSS defaults and power save mode
+/*
+Ram layer config message:
+b5 62 06 8a 0e 00 00 01 00 00 20 00 31 10 00 05 00 31 10 00 46 87
+
+BBR layer config message:
+b5 62 06 8a 0e 00 00 02 00 00 20 00 31 10 00 05 00 31 10 00 47 94
+*/

src/graphics/EInkDisplay2.cpp

@@ -125,61 +125,68 @@ bool EInkDisplay::forceDisplay(uint32_t msecLimit)
     // No need to grab this lock because we are on our own SPI bus
     // concurrency::LockGuard g(spiLock);
 
+#if defined(USE_EINK_DYNAMIC_PARTIAL)
+    // Decide if update is partial or full
+    bool continueUpdate = determineRefreshMode();
+    if (!continueUpdate)
+        return false;
+#else
+
     uint32_t now = millis();
     uint32_t sinceLast = now - lastDrawMsec;
 
-    if (adafruitDisplay && (sinceLast > msecLimit || lastDrawMsec == 0)) {
+    if (adafruitDisplay && (sinceLast > msecLimit || lastDrawMsec == 0))
         lastDrawMsec = now;
-
-        // FIXME - only draw bits have changed (use backbuf similar to the other displays)
-        // tft.drawBitmap(0, 0, buffer, 128, 64, TFT_YELLOW, TFT_BLACK);
-        for (uint32_t y = 0; y < displayHeight; y++) {
-            for (uint32_t x = 0; x < displayWidth; x++) {
-                // get src pixel in the page based ordering the OLED lib uses FIXME, super inefficient
-                auto b = buffer[x + (y / 8) * displayWidth];
-                auto isset = b & (1 << (y & 7));
-                adafruitDisplay->drawPixel(x, y, isset ? COLORED : UNCOLORED);
-            }
-        }
-
-        LOG_DEBUG("Updating E-Paper... ");
-
-#if defined(TTGO_T_ECHO)
-        adafruitDisplay->nextPage();
-#elif defined(RAK4630) || defined(MAKERPYTHON)
-
-        // RAK14000 2.13 inch b/w 250x122 actually now does support partial updates
-
-        // Full update mode (slow)
-        // adafruitDisplay->display(false); // FIXME, use partial update mode
-
-        // Only enable for e-Paper with support for partial updates and comment out above adafruitDisplay->display(false);
-        //  1.54 inch 200x200 - GxEPD2_154_M09
-        //  2.13 inch 250x122 - GxEPD2_213_BN
-        //  2.9 inch 296x128 - GxEPD2_290_T5D
-        //  4.2 inch 300x400 - GxEPD2_420_M01
-        adafruitDisplay->nextPage();
-
-#elif defined(PCA10059) || defined(M5_COREINK)
-        adafruitDisplay->nextPage();
-#elif defined(HELTEC_WIRELESS_PAPER_V1_0)
-        adafruitDisplay->nextPage();
-#elif defined(HELTEC_WIRELESS_PAPER)
-        adafruitDisplay->nextPage();
-#elif defined(PRIVATE_HW) || defined(my)
-        adafruitDisplay->nextPage();
+    else
+        return false;
 
 #endif
 
-        // Put screen to sleep to save power (possibly not necessary because we already did poweroff inside of display)
-        adafruitDisplay->hibernate();
-        LOG_DEBUG("done\n");
-
-        return true;
-    } else {
-        // LOG_DEBUG("Skipping eink display\n");
-        return false;
+    // FIXME - only draw bits have changed (use backbuf similar to the other displays)
+    // tft.drawBitmap(0, 0, buffer, 128, 64, TFT_YELLOW, TFT_BLACK);
+    for (uint32_t y = 0; y < displayHeight; y++) {
+        for (uint32_t x = 0; x < displayWidth; x++) {
+            // get src pixel in the page based ordering the OLED lib uses FIXME, super inefficient
+            auto b = buffer[x + (y / 8) * displayWidth];
+            auto isset = b & (1 << (y & 7));
+            adafruitDisplay->drawPixel(x, y, isset ? COLORED : UNCOLORED);
+        }
     }
+
+    LOG_DEBUG("Updating E-Paper... ");
+
+#if defined(TTGO_T_ECHO)
+    adafruitDisplay->nextPage();
+#elif defined(RAK4630) || defined(MAKERPYTHON)
+
+    // RAK14000 2.13 inch b/w 250x122 actually now does support partial updates
+
+    // Full update mode (slow)
+    // adafruitDisplay->display(false); // FIXME, use partial update mode
+
+    // Only enable for e-Paper with support for partial updates and comment out above adafruitDisplay->display(false);
+    //  1.54 inch 200x200 - GxEPD2_154_M09
+    //  2.13 inch 250x122 - GxEPD2_213_BN
+    //  2.9 inch 296x128 - GxEPD2_290_T5D
+    //  4.2 inch 300x400 - GxEPD2_420_M01
+    adafruitDisplay->nextPage();
+
+#elif defined(PCA10059) || defined(M5_COREINK)
+    adafruitDisplay->nextPage();
+#elif defined(HELTEC_WIRELESS_PAPER_V1_0)
+    adafruitDisplay->nextPage();
+#elif defined(HELTEC_WIRELESS_PAPER)
+    adafruitDisplay->nextPage();
+#elif defined(PRIVATE_HW) || defined(my)
+    adafruitDisplay->nextPage();
+
+#endif
+
+    // Put screen to sleep to save power (possibly not necessary because we already did poweroff inside of display)
+    adafruitDisplay->hibernate();
+    LOG_DEBUG("done\n");
+
+    return true;
 }
 
 // Write the buffer to the display memory
@@ -188,8 +195,16 @@ void EInkDisplay::display(void)
     // We don't allow regular 'dumb' display() calls to draw on eink until we've shown
     // at least one forceDisplay() keyframe.  This prevents flashing when we should the critical
     // bootscreen (that we want to look nice)
-    if (lastDrawMsec)
+
+#ifdef USE_EINK_DYNAMIC_PARTIAL
+    lowPriority();
+    forceDisplay();
+    highPriority();
+#else
+    if (lastDrawMsec) {
         forceDisplay(slowUpdateMsec); // Show the first screen a few seconds after boot, then slower
+    }
+#endif
 }
 
 // Send a command to the display (low level function)
@@ -329,4 +344,130 @@ bool EInkDisplay::connect()
     return true;
 }
 
+// Use a mix of full and partial refreshes, to preserve display health
+#if defined(USE_EINK_DYNAMIC_PARTIAL)
+
+// Suggest that subsequent updates should use partial-refresh
+void EInkDisplay::highPriority()
+{
+    isHighPriority = true;
+}
+
+// Suggest that subsequent updates should use full-refresh
+void EInkDisplay::lowPriority()
+{
+    isHighPriority = false;
+}
+
+// configure display for partial-refresh
+void EInkDisplay::configForPartialRefresh()
+{
+    // Display-specific code can go here
+#if defined(PRIVATE_HW)
+#else
+    // Otherwise:
+    adafruitDisplay->setPartialWindow(0, 0, adafruitDisplay->width(), adafruitDisplay->height());
+#endif
+}
+
+// Configure display for full-refresh
+void EInkDisplay::configForFullRefresh()
+{
+    // Display-specific code can go here
+#if defined(PRIVATE_HW)
+#else
+    // Otherwise:
+    adafruitDisplay->setFullWindow();
+#endif
+}
+
+bool EInkDisplay::newImageMatchesOld()
+{
+    uint32_t newImageHash = 0;
+
+    // Generate hash: sum all bytes in the image buffer
+    for (uint16_t b = 0; b < (displayWidth / 8) * displayHeight; b++) {
+        newImageHash += buffer[b];
+    }
+
+    // Compare hashes
+    bool hashMatches = (newImageHash == prevImageHash);
+
+    // Update the cached hash
+    prevImageHash = newImageHash;
+
+    // Return the comparison result
+    return hashMatches;
+}
+
+// Change between partial and full refresh config, or skip update, balancing urgency and display health.
+bool EInkDisplay::determineRefreshMode()
+{
+    uint32_t now = millis();
+    uint32_t sinceLast = now - lastUpdateMsec;
+
+    // If rate-limiting dropped a high-priority update:
+    // promote this update, so it runs ASAP
+    if (missedHighPriorityUpdate) {
+        isHighPriority = true;
+        missedHighPriorityUpdate = false;
+    }
+
+    // Abort: if too soon for a new frame
+    if (isHighPriority && partialRefreshCount > 0 && sinceLast < highPriorityLimitMsec) {
+        LOG_DEBUG("Update skipped: exceeded EINK_HIGHPRIORITY_LIMIT_SECONDS\n");
+        missedHighPriorityUpdate = true;
+        return false;
+    }
+    if (!isHighPriority && sinceLast < lowPriorityLimitMsec) {
+        return false;
+    }
+
+    // Check if old image (partial) should be redrawn (as full), for image quality
+    if (partialRefreshCount > 0 && !isHighPriority)
+        needsFull = true;
+
+    // If too many partials, require a full-refresh (display health)
+    if (partialRefreshCount >= partialRefreshLimit)
+        needsFull = true;
+
+    // If image matches
+    if (newImageMatchesOld()) {
+        // If low priority: limit rate
+        // otherwise, every loop() will run the hash method
+        if (!isHighPriority)
+            lastUpdateMsec = now;
+
+        // If update is *not* for display health or image quality, skip it
+        if (!needsFull)
+            return false;
+    }
+
+    // Conditions assessed - not skipping - load the appropriate config
+
+    // If options require a full refresh
+    if (!isHighPriority || needsFull) {
+        if (partialRefreshCount > 0)
+            configForFullRefresh();
+
+        LOG_DEBUG("Conditions met for full-refresh\n");
+        partialRefreshCount = 0;
+        needsFull = false;
+    }
+
+    // If options allow a partial refresh
+    else {
+        if (partialRefreshCount == 0)
+            configForPartialRefresh();
+
+        LOG_DEBUG("Conditions met for partial-refresh\n");
+        partialRefreshCount++;
+    }
+
+    lastUpdateMsec = now; // Mark time for rate limiting
+    return true;          // Instruct calling method to continue with update
+}
+
+#endif // End USE_EINK_DYNAMIC_PARTIAL
+
 #endif

src/graphics/EInkDisplay2.h

@@ -54,4 +54,68 @@ class EInkDisplay : public OLEDDisplay
 
     // Connect to the display
     virtual bool connect() override;
+
+#if defined(USE_EINK_DYNAMIC_PARTIAL)
+    // Full, partial, or skip: balance urgency with display health
+
+    // Use partial refresh if EITHER:
+    // * highPriority() was set
+    // * a highPriority() update was previously skipped, for rate-limiting - (EINK_HIGHPRIORITY_LIMIT_SECONDS)
+
+    // Use full refresh if EITHER:
+    // * lowPriority() was set
+    // * too many partial updates in a row: protect display - (EINK_PARTIAL_REPEAT_LIMIT)
+    // * no recent updates, and last update was partial: redraw for image quality (EINK_LOWPRIORITY_LIMIT_SECONDS)
+
+    // Rate limit if:
+    // * lowPriority() - (EINK_LOWPRIORITY_LIMIT_SECONDS)
+    // * highPriority(), if multiple partials have run back-to-back - (EINK_HIGHPRIORITY_LIMIT_SECONDS)
+
+    // Skip update entirely if ALL criteria met:
+    // * new image matches old image
+    // * lowPriority()
+    // * not redrawing for image quality
+    // * not refreshing for display health
+
+    // ------------------------------------
+
+    // To implement for your E-Ink display:
+    // * edit configForPartialRefresh()
+    // * edit configForFullRefresh()
+    // * add macros to variant.h, and adjust to taste:
+
+    /*
+        #define USE_EINK_DYNAMIC_PARTIAL
+        #define EINK_LOWPRIORITY_LIMIT_SECONDS 30
+        #define EINK_HIGHPRIORITY_LIMIT_SECONDS 1
+        #define EINK_PARTIAL_REPEAT_LIMIT 5
+    */
+
+  public:
+    void highPriority(); // Suggest partial refresh
+    void lowPriority();  // Suggest full refresh
+
+  protected:
+    void configForPartialRefresh(); // Display specific code to select partial refresh mode
+    void configForFullRefresh();    // Display specific code to return to full refresh mode
+    bool newImageMatchesOld();      // Is the new update actually different to the last image?
+    bool determineRefreshMode();    // Called immediately before data written to display - choose refresh mode, or abort update
+
+    bool isHighPriority = true;            // Does the method calling update believe that this is urgent?
+    bool needsFull = false;                // Is a full refresh forced? (display health)
+    bool missedHighPriorityUpdate = false; // Was a high priority update skipped for rate-limiting?
+    uint16_t partialRefreshCount = 0;      // How many partials have occurred since last full refresh?
+    uint32_t lastUpdateMsec = 0;           // When did the last update occur?
+    uint32_t prevImageHash = 0;            // Used to check if update will change screen image (skippable or not)
+
+    // Set in variant.h
+    const uint32_t lowPriorityLimitMsec = (uint32_t)1000 * EINK_LOWPRIORITY_LIMIT_SECONDS;   // Max rate for partial refreshes
+    const uint32_t highPriorityLimitMsec = (uint32_t)1000 * EINK_HIGHPRIORITY_LIMIT_SECONDS; // Max rate for full refreshes
+    const uint32_t partialRefreshLimit = EINK_PARTIAL_REPEAT_LIMIT; // Max consecutive partials, before full is triggered
+
+#else // !USE_EINK_DYNAMIC_PARTIAL
+    // Tolerate calls to these methods anywhere, just to be safe
+    void highPriority() {}
+    void lowPriority() {}
+#endif
 };

src/input/RotaryEncoderInterruptBase.cpp

@@ -104,7 +104,6 @@ RotaryEncoderInterruptBaseStateType RotaryEncoderInterruptBase::intHandler(bool
             newState = ROTARY_EVENT_OCCURRED;
             if ((this->action != ROTARY_ACTION_PRESSED) && (this->action != action)) {
                 this->action = action;
-                LOG_DEBUG("Rotary action\n");
             }
         }
     } else if (!actualPinRaising && (otherPinLevel == HIGH)) {

src/main.cpp

@@ -191,15 +191,10 @@ static int32_t ledBlinker()
 
 uint32_t timeLastPowered = 0;
 
-#if HAS_BUTTON || defined(ARCH_PORTDUINO)
-bool ButtonThread::shutdown_on_long_stop = false;
-#endif
-
 static Periodic *ledPeriodic;
 static OSThread *powerFSMthread;
 #if HAS_BUTTON || defined(ARCH_PORTDUINO)
 static OSThread *buttonThread;
-uint32_t ButtonThread::longPressTime = 0;
 #endif
 static OSThread *accelerometerThread;
 static OSThread *ambientLightingThread;

src/mesh/NodeDB.cpp

@@ -325,6 +325,17 @@ void NodeDB::installRoleDefaults(meshtastic_Config_DeviceConfig_Role role)
             (meshtastic_Config_PositionConfig_PositionFlags_ALTITUDE | meshtastic_Config_PositionConfig_PositionFlags_SPEED |
              meshtastic_Config_PositionConfig_PositionFlags_HEADING | meshtastic_Config_PositionConfig_PositionFlags_DOP);
         moduleConfig.telemetry.device_update_interval = ONE_DAY;
+    } else if (role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER) {
+        config.device.node_info_broadcast_secs = ONE_DAY;
+        config.position.position_broadcast_smart_enabled = true;
+        config.position.position_broadcast_secs = 3 * 60; // Every 3 minutes
+        config.position.broadcast_smart_minimum_distance = 20;
+        config.position.broadcast_smart_minimum_interval_secs = 15;
+        // Remove Altitude MSL from flags since CoTs use HAE (height above ellipsoid)
+        config.position.position_flags =
+            (meshtastic_Config_PositionConfig_PositionFlags_ALTITUDE | meshtastic_Config_PositionConfig_PositionFlags_SPEED |
+             meshtastic_Config_PositionConfig_PositionFlags_HEADING | meshtastic_Config_PositionConfig_PositionFlags_DOP);
+        moduleConfig.telemetry.device_update_interval = ONE_DAY;
     } else if (role == meshtastic_Config_DeviceConfig_Role_CLIENT_HIDDEN) {
         config.device.rebroadcast_mode = meshtastic_Config_DeviceConfig_RebroadcastMode_LOCAL_ONLY;
         config.device.node_info_broadcast_secs = UINT32_MAX;

src/mesh/generated/meshtastic/config.pb.h

@@ -12,49 +12,53 @@
 /* Enum definitions */
 /* Defines the device's role on the Mesh network */
 typedef enum _meshtastic_Config_DeviceConfig_Role {
-    /* Client device role */
+    /* Description: App connected or stand alone messaging device.
+ Technical Details: Default Role */
     meshtastic_Config_DeviceConfig_Role_CLIENT = 0,
-    /* Client Mute device role
-   Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. */
+    /* Description: Device that does not forward packets from other devices. */
     meshtastic_Config_DeviceConfig_Role_CLIENT_MUTE = 1,
-    /* Router device role.
-   Mesh packets will prefer to be routed over this node. This node will not be used by client apps.
-   The wifi/ble radios and the oled screen will be put to sleep.
+    /* Description: Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list.
+ Technical Details: Mesh packets will prefer to be routed over this node. This node will not be used by client apps.
+   The wifi radio and the oled screen will be put to sleep.
    This mode may still potentially have higher power usage due to it's preference in message rebroadcasting on the mesh. */
     meshtastic_Config_DeviceConfig_Role_ROUTER = 2,
-    /* Router Client device role
-   Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. */
+    /* Description: Combination of both ROUTER and CLIENT. Not for mobile devices. */
     meshtastic_Config_DeviceConfig_Role_ROUTER_CLIENT = 3,
-    /* Repeater device role
-   Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry
+    /* Description: Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list.
+ Technical Details: Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry
    or any other packet type. They will simply rebroadcast any mesh packets on the same frequency, channel num, spread factor, and coding rate. */
     meshtastic_Config_DeviceConfig_Role_REPEATER = 4,
-    /* Tracker device role
-   Position Mesh packets will be prioritized higher and sent more frequently by default.
+    /* Description: Broadcasts GPS position packets as priority.
+ Technical Details: Position Mesh packets will be prioritized higher and sent more frequently by default.
    When used in conjunction with power.is_power_saving = true, nodes will wake up, 
    send position, and then sleep for position.position_broadcast_secs seconds. */
     meshtastic_Config_DeviceConfig_Role_TRACKER = 5,
-    /* Sensor device role
-   Telemetry Mesh packets will be prioritized higher and sent more frequently by default.
+    /* Description: Broadcasts telemetry packets as priority.
+ Technical Details: Telemetry Mesh packets will be prioritized higher and sent more frequently by default.
    When used in conjunction with power.is_power_saving = true, nodes will wake up, 
    send environment telemetry, and then sleep for telemetry.environment_update_interval seconds. */
     meshtastic_Config_DeviceConfig_Role_SENSOR = 6,
-    /* TAK device role
-    Used for nodes dedicated for connection to an ATAK EUD.
+    /* Description: Optimized for ATAK system communication and reduces routine broadcasts.
+ Technical Details: Used for nodes dedicated for connection to an ATAK EUD.
     Turns off many of the routine broadcasts to favor CoT packet stream
     from the Meshtastic ATAK plugin -> IMeshService -> Node */
     meshtastic_Config_DeviceConfig_Role_TAK = 7,
-    /* Client Hidden device role
-    Used for nodes that "only speak when spoken to"
+    /* Description: Device that only broadcasts as needed for stealth or power savings.
+ Technical Details: Used for nodes that "only speak when spoken to"
     Turns all of the routine broadcasts but allows for ad-hoc communication
     Still rebroadcasts, but with local only rebroadcast mode (known meshes only)
     Can be used for clandestine operation or to dramatically reduce airtime / power consumption */
     meshtastic_Config_DeviceConfig_Role_CLIENT_HIDDEN = 8,
-    /* Lost and Found device role
-    Used to automatically send a text message to the mesh 
+    /* Description: Broadcasts location as message to default channel regularly for to assist with device recovery.
+ Technical Details: Used to automatically send a text message to the mesh 
     with the current position of the device on a frequent interval:
     "I'm lost! Position: lat / long" */
-    meshtastic_Config_DeviceConfig_Role_LOST_AND_FOUND = 9
+    meshtastic_Config_DeviceConfig_Role_LOST_AND_FOUND = 9,
+    /* Description: Enables automatic TAK PLI broadcasts and reduces routine broadcasts.
+ Technical Details: Turns off many of the routine broadcasts to favor ATAK CoT packet stream
+    and automatic TAK PLI (position location information) broadcasts.
+    Uses position module configuration to determine TAK PLI broadcast interval. */
+    meshtastic_Config_DeviceConfig_Role_TAK_TRACKER = 10
 } meshtastic_Config_DeviceConfig_Role;
 
 /* Defines the device's behavior for how messages are rebroadcast */
@@ -313,6 +317,9 @@ typedef struct _meshtastic_Config_PositionConfig {
     uint32_t gps_en_gpio;
     /* Set where GPS is enabled, disabled, or not present */
     meshtastic_Config_PositionConfig_GpsMode gps_mode;
+    /* Set GPS precision in bits per channel, or 0 for disabled */
+    pb_size_t channel_precision_count;
+    uint32_t channel_precision[8];
 } meshtastic_Config_PositionConfig;
 
 /* Power Config\
@@ -509,8 +516,8 @@ extern "C" {
 
 /* Helper constants for enums */
 #define _meshtastic_Config_DeviceConfig_Role_MIN meshtastic_Config_DeviceConfig_Role_CLIENT
-#define _meshtastic_Config_DeviceConfig_Role_MAX meshtastic_Config_DeviceConfig_Role_LOST_AND_FOUND
-#define _meshtastic_Config_DeviceConfig_Role_ARRAYSIZE ((meshtastic_Config_DeviceConfig_Role)(meshtastic_Config_DeviceConfig_Role_LOST_AND_FOUND+1))
+#define _meshtastic_Config_DeviceConfig_Role_MAX meshtastic_Config_DeviceConfig_Role_TAK_TRACKER
+#define _meshtastic_Config_DeviceConfig_Role_ARRAYSIZE ((meshtastic_Config_DeviceConfig_Role)(meshtastic_Config_DeviceConfig_Role_TAK_TRACKER+1))
 
 #define _meshtastic_Config_DeviceConfig_RebroadcastMode_MIN meshtastic_Config_DeviceConfig_RebroadcastMode_ALL
 #define _meshtastic_Config_DeviceConfig_RebroadcastMode_MAX meshtastic_Config_DeviceConfig_RebroadcastMode_KNOWN_ONLY
@@ -580,7 +587,7 @@ extern "C" {
 /* Initializer values for message structs */
 #define meshtastic_Config_init_default           {0, {meshtastic_Config_DeviceConfig_init_default}}
 #define meshtastic_Config_DeviceConfig_init_default {_meshtastic_Config_DeviceConfig_Role_MIN, 0, 0, 0, 0, _meshtastic_Config_DeviceConfig_RebroadcastMode_MIN, 0, 0, 0, 0}
-#define meshtastic_Config_PositionConfig_init_default {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, _meshtastic_Config_PositionConfig_GpsMode_MIN}
+#define meshtastic_Config_PositionConfig_init_default {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, _meshtastic_Config_PositionConfig_GpsMode_MIN, 0, {0, 0, 0, 0, 0, 0, 0, 0}}
 #define meshtastic_Config_PowerConfig_init_default {0, 0, 0, 0, 0, 0, 0, 0}
 #define meshtastic_Config_NetworkConfig_init_default {0, "", "", "", 0, _meshtastic_Config_NetworkConfig_AddressMode_MIN, false, meshtastic_Config_NetworkConfig_IpV4Config_init_default, ""}
 #define meshtastic_Config_NetworkConfig_IpV4Config_init_default {0, 0, 0, 0}
@@ -589,7 +596,7 @@ extern "C" {
 #define meshtastic_Config_BluetoothConfig_init_default {0, _meshtastic_Config_BluetoothConfig_PairingMode_MIN, 0}
 #define meshtastic_Config_init_zero              {0, {meshtastic_Config_DeviceConfig_init_zero}}
 #define meshtastic_Config_DeviceConfig_init_zero {_meshtastic_Config_DeviceConfig_Role_MIN, 0, 0, 0, 0, _meshtastic_Config_DeviceConfig_RebroadcastMode_MIN, 0, 0, 0, 0}
-#define meshtastic_Config_PositionConfig_init_zero {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, _meshtastic_Config_PositionConfig_GpsMode_MIN}
+#define meshtastic_Config_PositionConfig_init_zero {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, _meshtastic_Config_PositionConfig_GpsMode_MIN, 0, {0, 0, 0, 0, 0, 0, 0, 0}}
 #define meshtastic_Config_PowerConfig_init_zero  {0, 0, 0, 0, 0, 0, 0, 0}
 #define meshtastic_Config_NetworkConfig_init_zero {0, "", "", "", 0, _meshtastic_Config_NetworkConfig_AddressMode_MIN, false, meshtastic_Config_NetworkConfig_IpV4Config_init_zero, ""}
 #define meshtastic_Config_NetworkConfig_IpV4Config_init_zero {0, 0, 0, 0}
@@ -621,6 +628,7 @@ extern "C" {
 #define meshtastic_Config_PositionConfig_broadcast_smart_minimum_interval_secs_tag 11
 #define meshtastic_Config_PositionConfig_gps_en_gpio_tag 12
 #define meshtastic_Config_PositionConfig_gps_mode_tag 13
+#define meshtastic_Config_PositionConfig_channel_precision_tag 14
 #define meshtastic_Config_PowerConfig_is_power_saving_tag 1
 #define meshtastic_Config_PowerConfig_on_battery_shutdown_after_secs_tag 2
 #define meshtastic_Config_PowerConfig_adc_multiplier_override_tag 3
@@ -724,7 +732,8 @@ X(a, STATIC,   SINGULAR, UINT32,   tx_gpio,           9) \
 X(a, STATIC,   SINGULAR, UINT32,   broadcast_smart_minimum_distance,  10) \
 X(a, STATIC,   SINGULAR, UINT32,   broadcast_smart_minimum_interval_secs,  11) \
 X(a, STATIC,   SINGULAR, UINT32,   gps_en_gpio,      12) \
-X(a, STATIC,   SINGULAR, UENUM,    gps_mode,         13)
+X(a, STATIC,   SINGULAR, UENUM,    gps_mode,         13) \
+X(a, STATIC,   REPEATED, UINT32,   channel_precision,  14)
 #define meshtastic_Config_PositionConfig_CALLBACK NULL
 #define meshtastic_Config_PositionConfig_DEFAULT NULL
 
@@ -830,7 +839,7 @@ extern const pb_msgdesc_t meshtastic_Config_BluetoothConfig_msg;
 #define meshtastic_Config_LoRaConfig_size        80
 #define meshtastic_Config_NetworkConfig_IpV4Config_size 20
 #define meshtastic_Config_NetworkConfig_size     196
-#define meshtastic_Config_PositionConfig_size    62
+#define meshtastic_Config_PositionConfig_size    110
 #define meshtastic_Config_PowerConfig_size       40
 #define meshtastic_Config_size                   199
 

src/mesh/generated/meshtastic/deviceonly.pb.h

@@ -316,7 +316,7 @@ extern const pb_msgdesc_t meshtastic_NodeRemoteHardwarePin_msg;
 #define meshtastic_DeviceState_size              17062
 #define meshtastic_NodeInfoLite_size             153
 #define meshtastic_NodeRemoteHardwarePin_size    29
-#define meshtastic_OEMStore_size                 3246
+#define meshtastic_OEMStore_size                 3294
 #define meshtastic_PositionLite_size             28
 
 #ifdef __cplusplus

src/mesh/generated/meshtastic/localonly.pb.h

@@ -180,7 +180,7 @@ extern const pb_msgdesc_t meshtastic_LocalModuleConfig_msg;
 #define meshtastic_LocalModuleConfig_fields &meshtastic_LocalModuleConfig_msg
 
 /* Maximum encoded size of messages (where known) */
-#define meshtastic_LocalConfig_size              469
+#define meshtastic_LocalConfig_size              517
 #define meshtastic_LocalModuleConfig_size        631
 
 #ifdef __cplusplus

src/mesh/generated/meshtastic/mesh.pb.h

@@ -73,6 +73,8 @@ typedef enum _meshtastic_HardwareModel {
     meshtastic_HardwareModel_SENSELORA_S3 = 28,
     /* Canary Radio Company - CanaryOne: https://canaryradio.io/products/canaryone */
     meshtastic_HardwareModel_CANARYONE = 29,
+    /* Waveshare RP2040 LoRa - https://www.waveshare.com/rp2040-lora.htm */
+    meshtastic_HardwareModel_RP2040_LORA = 30,
     /* ---------------------------------------------------------------------------
  Less common/prototype boards listed here (needs one more byte over the air)
  --------------------------------------------------------------------------- */
@@ -107,7 +109,8 @@ typedef enum _meshtastic_HardwareModel {
     meshtastic_HardwareModel_BETAFPV_900_NANO_TX = 46,
     /* Raspberry Pi Pico (W) with Waveshare SX1262 LoRa Node Module */
     meshtastic_HardwareModel_RPI_PICO = 47,
-    /* Heltec Wireless Tracker with ESP32-S3 CPU, built-in GPS, and TFT */
+    /* Heltec Wireless Tracker with ESP32-S3 CPU, built-in GPS, and TFT
+ Newer V1.1, version is written on the PCB near the display. */
     meshtastic_HardwareModel_HELTEC_WIRELESS_TRACKER = 48,
     /* Heltec Wireless Paper with ESP32-S3 CPU and E-Ink display */
     meshtastic_HardwareModel_HELTEC_WIRELESS_PAPER = 49,
@@ -133,6 +136,9 @@ typedef enum _meshtastic_HardwareModel {
  Tab on the screen protector is RED
  Flex connector marking is FPC-7528B */
     meshtastic_HardwareModel_HELTEC_WIRELESS_PAPER_V1_0 = 57,
+    /* Heltec Wireless Tracker with ESP32-S3 CPU, built-in GPS, and TFT
+ Older "V1.0" Variant */
+    meshtastic_HardwareModel_HELTEC_WIRELESS_TRACKER_V1_0 = 58,
     /* ------------------------------------------------------------------------------------------------------------------------------------------
  Reserved ID For developing private Ports. These will show up in live traffic sparsely, so we can use a high number. Keep it within 8 bits.
  ------------------------------------------------------------------------------------------------------------------------------------------ */

src/mesh/generated/meshtastic/storeforward.pb.h

@@ -30,6 +30,10 @@ typedef enum _meshtastic_StoreAndForward_RequestResponse {
     meshtastic_StoreAndForward_RequestResponse_ROUTER_HISTORY = 6,
     /* Router is responding to a request for stats. */
     meshtastic_StoreAndForward_RequestResponse_ROUTER_STATS = 7,
+    /* Router sends a text message from its history that was a direct message. */
+    meshtastic_StoreAndForward_RequestResponse_ROUTER_TEXT_DIRECT = 8,
+    /* Router sends a text message from its history that was a broadcast. */
+    meshtastic_StoreAndForward_RequestResponse_ROUTER_TEXT_BROADCAST = 9,
     /* Client is an in error state. */
     meshtastic_StoreAndForward_RequestResponse_CLIENT_ERROR = 64,
     /* Client has requested a replay from the router. */
@@ -62,9 +66,9 @@ typedef struct _meshtastic_StoreAndForward_Statistics {
     uint32_t requests_history;
     /* Is the heartbeat enabled on the server? */
     bool heartbeat;
-    /* Is the heartbeat enabled on the server? */
+    /* Maximum number of messages the server will return. */
     uint32_t return_max;
-    /* Is the heartbeat enabled on the server? */
+    /* Maximum history window in minutes the server will return messages from. */
     uint32_t return_window;
 } meshtastic_StoreAndForward_Statistics;
 
@@ -74,18 +78,20 @@ typedef struct _meshtastic_StoreAndForward_History {
     uint32_t history_messages;
     /* The window of messages that was used to filter the history client requested */
     uint32_t window;
-    /* The window of messages that was used to filter the history client requested */
+    /* Index in the packet history of the last message sent in a previous request to the server.
+ Will be sent to the client before sending the history and can be set in a subsequent request to avoid getting packets the server already sent to the client. */
     uint32_t last_request;
 } meshtastic_StoreAndForward_History;
 
 /* TODO: REPLACE */
 typedef struct _meshtastic_StoreAndForward_Heartbeat {
-    /* Number of that will be sent to the client */
+    /* Period in seconds that the heartbeat is sent out that will be sent to the client */
     uint32_t period;
     /* If set, this is not the primary Store & Forward router on the mesh */
     uint32_t secondary;
 } meshtastic_StoreAndForward_Heartbeat;
 
+typedef PB_BYTES_ARRAY_T(237) meshtastic_StoreAndForward_text_t;
 /* TODO: REPLACE */
 typedef struct _meshtastic_StoreAndForward {
     /* TODO: REPLACE */
@@ -98,8 +104,8 @@ typedef struct _meshtastic_StoreAndForward {
         meshtastic_StoreAndForward_History history;
         /* TODO: REPLACE */
         meshtastic_StoreAndForward_Heartbeat heartbeat;
-        /* Empty Payload */
-        bool empty;
+        /* Text from history message. */
+        meshtastic_StoreAndForward_text_t text;
     } variant;
 } meshtastic_StoreAndForward;
 
@@ -148,7 +154,7 @@ extern "C" {
 #define meshtastic_StoreAndForward_stats_tag     2
 #define meshtastic_StoreAndForward_history_tag   3
 #define meshtastic_StoreAndForward_heartbeat_tag 4
-#define meshtastic_StoreAndForward_empty_tag     5
+#define meshtastic_StoreAndForward_text_tag      5
 
 /* Struct field encoding specification for nanopb */
 #define meshtastic_StoreAndForward_FIELDLIST(X, a) \
@@ -156,7 +162,7 @@ X(a, STATIC,   SINGULAR, UENUM,    rr,                1) \
 X(a, STATIC,   ONEOF,    MESSAGE,  (variant,stats,variant.stats),   2) \
 X(a, STATIC,   ONEOF,    MESSAGE,  (variant,history,variant.history),   3) \
 X(a, STATIC,   ONEOF,    MESSAGE,  (variant,heartbeat,variant.heartbeat),   4) \
-X(a, STATIC,   ONEOF,    BOOL,     (variant,empty,variant.empty),   5)
+X(a, STATIC,   ONEOF,    BYTES,    (variant,text,variant.text),   5)
 #define meshtastic_StoreAndForward_CALLBACK NULL
 #define meshtastic_StoreAndForward_DEFAULT NULL
 #define meshtastic_StoreAndForward_variant_stats_MSGTYPE meshtastic_StoreAndForward_Statistics
@@ -204,7 +210,7 @@ extern const pb_msgdesc_t meshtastic_StoreAndForward_Heartbeat_msg;
 #define meshtastic_StoreAndForward_Heartbeat_size 12
 #define meshtastic_StoreAndForward_History_size  18
 #define meshtastic_StoreAndForward_Statistics_size 50
-#define meshtastic_StoreAndForward_size          54
+#define meshtastic_StoreAndForward_size          242
 
 #ifdef __cplusplus
 } /* extern "C" */

src/modules/PositionModule.cpp

@@ -8,9 +8,15 @@
 #include "airtime.h"
 #include "configuration.h"
 #include "gps/GeoCoord.h"
+#include "main.h"
+#include "meshtastic/atak.pb.h"
 #include "sleep.h"
 #include "target_specific.h"
 
+extern "C" {
+#include "mesh/compression/unishox2.h"
+}
+
 PositionModule *positionModule;
 
 PositionModule::PositionModule()
@@ -18,11 +24,14 @@ PositionModule::PositionModule()
       concurrency::OSThread("PositionModule")
 {
     isPromiscuous = true; // We always want to update our nodedb, even if we are sniffing on others
-    if (config.device.role != meshtastic_Config_DeviceConfig_Role_TRACKER)
+    if (config.device.role != meshtastic_Config_DeviceConfig_Role_TRACKER &&
+        config.device.role != meshtastic_Config_DeviceConfig_Role_TAK_TRACKER)
         setIntervalFromNow(60 * 1000);
 
     // Power saving trackers should clear their position on startup to avoid waking up and sending a stale position
-    if (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER && config.power.is_power_saving) {
+    if ((config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
+         config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER) &&
+        config.power.is_power_saving) {
         clearPosition();
     }
 }
@@ -157,9 +166,47 @@ meshtastic_MeshPacket *PositionModule::allocReply()
 
     LOG_INFO("Position reply: time=%i, latI=%i, lonI=-%i\n", p.time, p.latitude_i, p.longitude_i);
 
+    // TAK Tracker devices should send their position in a TAK packet over the ATAK port
+    if (config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER)
+        return allocAtakPli();
+
     return allocDataProtobuf(p);
 }
 
+meshtastic_MeshPacket *PositionModule::allocAtakPli()
+{
+    LOG_INFO("Sending TAK PLI packet\n");
+    meshtastic_MeshPacket *mp = allocDataPacket();
+    mp->decoded.portnum = meshtastic_PortNum_ATAK_PLUGIN;
+
+    meshtastic_TAKPacket takPacket = {.is_compressed = true,
+                                      .has_contact = true,
+                                      .contact = {0},
+                                      .has_group = true,
+                                      .group = {meshtastic_MemberRole_TeamMember, meshtastic_Team_Cyan},
+                                      .has_status = true,
+                                      .status =
+                                          {
+                                              .battery = powerStatus->getBatteryChargePercent(),
+                                          },
+                                      .which_payload_variant = meshtastic_TAKPacket_pli_tag,
+                                      {.pli = {
+                                           .latitude_i = localPosition.latitude_i,
+                                           .longitude_i = localPosition.longitude_i,
+                                           .altitude = localPosition.altitude_hae > 0 ? localPosition.altitude_hae : 0,
+                                           .speed = localPosition.ground_speed,
+                                           .course = static_cast<uint16_t>(localPosition.ground_track),
+                                       }}};
+
+    auto length = unishox2_compress_simple(owner.long_name, strlen(owner.long_name), takPacket.contact.device_callsign);
+    LOG_DEBUG("Uncompressed device_callsign '%s' - %d bytes\n", owner.long_name, strlen(owner.long_name));
+    LOG_DEBUG("Compressed device_callsign '%s' - %d bytes\n", takPacket.contact.device_callsign, length);
+    length = unishox2_compress_simple(owner.long_name, strlen(owner.long_name), takPacket.contact.callsign);
+    mp->decoded.payload.size =
+        pb_encode_to_bytes(mp->decoded.payload.bytes, sizeof(mp->decoded.payload.bytes), &meshtastic_TAKPacket_msg, &takPacket);
+    return mp;
+}
+
 void PositionModule::sendOurPosition(NodeNum dest, bool wantReplies, uint8_t channel)
 {
     // cancel any not yet sent (now stale) position packets
@@ -174,7 +221,8 @@ void PositionModule::sendOurPosition(NodeNum dest, bool wantReplies, uint8_t cha
 
     p->to = dest;
     p->decoded.want_response = config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ? false : wantReplies;
-    if (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER)
+    if (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
+        config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER)
         p->priority = meshtastic_MeshPacket_Priority_RELIABLE;
     else
         p->priority = meshtastic_MeshPacket_Priority_BACKGROUND;
@@ -185,7 +233,9 @@ void PositionModule::sendOurPosition(NodeNum dest, bool wantReplies, uint8_t cha
 
     service.sendToMesh(p, RX_SRC_LOCAL, true);
 
-    if (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER && config.power.is_power_saving) {
+    if ((config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
+         config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER) &&
+        config.power.is_power_saving) {
         LOG_DEBUG("Starting next execution in 5 seconds and then going to sleep.\n");
         sleepOnNextExecution = true;
         setIntervalFromNow(5000);
@@ -212,7 +262,8 @@ int32_t PositionModule::runOnce()
     uint32_t intervalMs = getConfiguredOrDefaultMs(config.position.position_broadcast_secs, default_broadcast_interval_secs);
     uint32_t msSinceLastSend = now - lastGpsSend;
     // Only send packets if the channel util. is less than 25% utilized or we're a tracker with less than 40% utilized.
-    if (!airTime->isTxAllowedChannelUtil(config.device.role != meshtastic_Config_DeviceConfig_Role_TRACKER)) {
+    if (!airTime->isTxAllowedChannelUtil(config.device.role != meshtastic_Config_DeviceConfig_Role_TRACKER &&
+                                         config.device.role != meshtastic_Config_DeviceConfig_Role_TAK_TRACKER)) {
         return RUNONCE_INTERVAL;
     }
 

src/modules/PositionModule.h

@@ -49,6 +49,7 @@ class PositionModule : public ProtobufModule<meshtastic_Position>, private concu
 
   private:
     struct SmartPosition getDistanceTraveledSinceLastSend(meshtastic_PositionLite currentPosition);
+    meshtastic_MeshPacket *allocAtakPli();
 
     /** Only used in power saving trackers for now */
     void clearPosition();

src/modules/SerialModule.cpp

@@ -58,7 +58,7 @@
 SerialModule *serialModule;
 SerialModuleRadio *serialModuleRadio;
 
-#ifdef TTGO_T_ECHO
+#if defined(TTGO_T_ECHO) || defined(CANARYONE)
 SerialModule::SerialModule() : StreamAPI(&Serial), concurrency::OSThread("SerialModule") {}
 static Print *serialPrint = &Serial;
 #else
@@ -140,7 +140,7 @@ int32_t SerialModule::runOnce()
                 Serial.begin(baud);
                 Serial.setTimeout(moduleConfig.serial.timeout > 0 ? moduleConfig.serial.timeout : TIMEOUT);
             }
-#elif !defined(TTGO_T_ECHO)
+#elif !defined(TTGO_T_ECHO) && !defined(CANARYONE)
             if (moduleConfig.serial.rxd && moduleConfig.serial.txd) {
 #ifdef ARCH_RP2040
                 Serial2.setFIFOSize(RX_BUFFER);
@@ -188,7 +188,7 @@ int32_t SerialModule::runOnce()
                     }
                 }
             }
-#if !defined(TTGO_T_ECHO)
+#if !defined(TTGO_T_ECHO) && !defined(CANARYONE)
             else {
                 while (Serial2.available()) {
                     serialPayloadSize = Serial2.readBytes(serialBytes, meshtastic_Constants_DATA_PAYLOAD_LEN);

src/modules/esp32/StoreForwardModule.cpp

@@ -38,16 +38,11 @@ int32_t StoreForwardModule::runOnce()
             // Only send packets if the channel is less than 25% utilized.
             if (airTime->isTxAllowedChannelUtil(true)) {
                 storeForwardModule->sendPayload(this->busyTo, this->packetHistoryTXQueue_index);
-                if (this->packetHistoryTXQueue_index == packetHistoryTXQueue_size) {
-                    // Tell the client we're done sending
-                    meshtastic_StoreAndForward sf = meshtastic_StoreAndForward_init_zero;
-                    sf.rr = meshtastic_StoreAndForward_RequestResponse_ROUTER_PING;
-                    storeForwardModule->sendMessage(this->busyTo, sf);
-                    LOG_INFO("*** S&F - Done. (ROUTER_PING)\n");
+                if (this->packetHistoryTXQueue_index < packetHistoryTXQueue_size - 1) {
+                    this->packetHistoryTXQueue_index++;
+                } else {
                     this->packetHistoryTXQueue_index = 0;
                     this->busy = false;
-                } else {
-                    this->packetHistoryTXQueue_index++;
                 }
             }
         } else if ((millis() - lastHeartbeat > (heartbeatInterval * 1000)) && airTime->isTxAllowedChannelUtil(true)) {
@@ -56,7 +51,7 @@ int32_t StoreForwardModule::runOnce()
             meshtastic_StoreAndForward sf = meshtastic_StoreAndForward_init_zero;
             sf.rr = meshtastic_StoreAndForward_RequestResponse_ROUTER_HEARTBEAT;
             sf.which_variant = meshtastic_StoreAndForward_heartbeat_tag;
-            sf.variant.heartbeat.period = 300;
+            sf.variant.heartbeat.period = heartbeatInterval;
             sf.variant.heartbeat.secondary = 0; // TODO we always have one primary router for now
             storeForwardModule->sendMessage(NODENUM_BROADCAST, sf);
         }
@@ -104,7 +99,8 @@ void StoreForwardModule::populatePSRAM()
  */
 void StoreForwardModule::historySend(uint32_t msAgo, uint32_t to)
 {
-    uint32_t queueSize = storeForwardModule->historyQueueCreate(msAgo, to);
+    uint32_t lastIndex = lastRequest.find(to) != lastRequest.end() ? lastRequest[to] : 0;
+    uint32_t queueSize = storeForwardModule->historyQueueCreate(msAgo, to, &lastIndex);
 
     if (queueSize) {
         LOG_INFO("*** S&F - Sending %u message(s)\n", queueSize);
@@ -118,6 +114,8 @@ void StoreForwardModule::historySend(uint32_t msAgo, uint32_t to)
     sf.which_variant = meshtastic_StoreAndForward_history_tag;
     sf.variant.history.history_messages = queueSize;
     sf.variant.history.window = msAgo;
+    sf.variant.history.last_request = lastIndex;
+    lastRequest[to] = lastIndex;
     storeForwardModule->sendMessage(to, sf);
 }
 
@@ -125,15 +123,18 @@ void StoreForwardModule::historySend(uint32_t msAgo, uint32_t to)
  * Creates a new history queue with messages that were received within the specified time frame.
  *
  * @param msAgo The number of milliseconds ago to start the history queue.
- * @param to The maximum number of messages to include in the history queue.
+ * @param to The NodeNum of the recipient.
+ * @param last_request_index The index in the packet history of the last request from this node.
  * @return The ID of the newly created history queue.
  */
-uint32_t StoreForwardModule::historyQueueCreate(uint32_t msAgo, uint32_t to)
+uint32_t StoreForwardModule::historyQueueCreate(uint32_t msAgo, uint32_t to, uint32_t *last_request_index)
 {
 
     this->packetHistoryTXQueue_size = 0;
+    // If our history was cleared, ignore the last request index
+    uint32_t last_index = *last_request_index > this->packetHistoryCurrent ? 0 : *last_request_index;
 
-    for (int i = 0; i < this->packetHistoryCurrent; i++) {
+    for (uint32_t i = last_index; i < this->packetHistoryCurrent; i++) {
         /*
             LOG_DEBUG("SF historyQueueCreate\n");
             LOG_DEBUG("SF historyQueueCreate - time %d\n", this->packetHistory[i].time);
@@ -141,16 +142,11 @@ uint32_t StoreForwardModule::historyQueueCreate(uint32_t msAgo, uint32_t to)
             LOG_DEBUG("SF historyQueueCreate - math %d\n", (millis() - msAgo));
         */
         if (this->packetHistory[i].time && (this->packetHistory[i].time < (millis() - msAgo))) {
-            LOG_DEBUG("*** SF historyQueueCreate - Time matches - ok\n");
-            /*
-                Copy the messages that were received by the router in the last msAgo
+            /*  Copy the messages that were received by the router in the last msAgo
                 to the packetHistoryTXQueue structure.
-
-                TODO: The condition (this->packetHistory[i].to & NODENUM_BROADCAST) == to) is not tested since
-                I don't have an easy way to target a specific user. Will need to do this soon.
-            */
-            if ((this->packetHistory[i].to & NODENUM_BROADCAST) == NODENUM_BROADCAST ||
-                ((this->packetHistory[i].to & NODENUM_BROADCAST) == to)) {
+                Client not interested in packets from itself and only in broadcast packets or packets towards it. */
+            if (this->packetHistory[i].from != to &&
+                (this->packetHistory[i].to == NODENUM_BROADCAST || this->packetHistory[i].to == to)) {
                 this->packetHistoryTXQueue[this->packetHistoryTXQueue_size].time = this->packetHistory[i].time;
                 this->packetHistoryTXQueue[this->packetHistoryTXQueue_size].to = this->packetHistory[i].to;
                 this->packetHistoryTXQueue[this->packetHistoryTXQueue_size].from = this->packetHistory[i].from;
@@ -159,9 +155,10 @@ uint32_t StoreForwardModule::historyQueueCreate(uint32_t msAgo, uint32_t to)
                 memcpy(this->packetHistoryTXQueue[this->packetHistoryTXQueue_size].payload, this->packetHistory[i].payload,
                        meshtastic_Constants_DATA_PAYLOAD_LEN);
                 this->packetHistoryTXQueue_size++;
+                *last_request_index = i + 1; // Set to one higher such that we don't send the same message again
 
-                LOG_DEBUG("*** PacketHistoryStruct time=%d\n", this->packetHistory[i].time);
-                LOG_DEBUG("*** PacketHistoryStruct msg=%s\n", this->packetHistory[i].payload);
+                LOG_DEBUG("*** PacketHistoryStruct time=%d, msg=%s\n", this->packetHistory[i].time,
+                          this->packetHistory[i].payload);
             }
         }
     }
@@ -177,15 +174,20 @@ void StoreForwardModule::historyAdd(const meshtastic_MeshPacket &mp)
 {
     const auto &p = mp.decoded;
 
-    this->packetHistory[this->packetHistoryCurrent].time = millis();
-    this->packetHistory[this->packetHistoryCurrent].to = mp.to;
-    this->packetHistory[this->packetHistoryCurrent].channel = mp.channel;
-    this->packetHistory[this->packetHistoryCurrent].from = mp.from;
-    this->packetHistory[this->packetHistoryCurrent].payload_size = p.payload.size;
-    memcpy(this->packetHistory[this->packetHistoryCurrent].payload, p.payload.bytes, meshtastic_Constants_DATA_PAYLOAD_LEN);
+    if (this->packetHistoryCurrent < this->records) {
+        this->packetHistory[this->packetHistoryCurrent].time = millis();
+        this->packetHistory[this->packetHistoryCurrent].to = mp.to;
+        this->packetHistory[this->packetHistoryCurrent].channel = mp.channel;
+        this->packetHistory[this->packetHistoryCurrent].from = mp.from;
+        this->packetHistory[this->packetHistoryCurrent].payload_size = p.payload.size;
+        memcpy(this->packetHistory[this->packetHistoryCurrent].payload, p.payload.bytes, meshtastic_Constants_DATA_PAYLOAD_LEN);
 
-    this->packetHistoryCurrent++;
-    this->packetHistoryMax++;
+        this->packetHistoryCurrent++;
+        this->packetHistoryMax++;
+    } else {
+        // TODO: Overwrite the oldest message in the history buffer when it is full.
+        LOG_WARN("*** S&F - PSRAM Full. Packet is not added to the history.\n");
+    }
 }
 
 meshtastic_MeshPacket *StoreForwardModule::allocReply()
@@ -213,10 +215,19 @@ void StoreForwardModule::sendPayload(NodeNum dest, uint32_t packetHistory_index)
     //   TODO: Make this configurable.
     p->want_ack = false;
 
-    p->decoded.payload.size =
-        this->packetHistoryTXQueue[packetHistory_index].payload_size; // You must specify how many bytes are in the reply
-    memcpy(p->decoded.payload.bytes, this->packetHistoryTXQueue[packetHistory_index].payload,
+    meshtastic_StoreAndForward sf = meshtastic_StoreAndForward_init_zero;
+    sf.which_variant = meshtastic_StoreAndForward_text_tag;
+    sf.variant.text.size = this->packetHistoryTXQueue[packetHistory_index].payload_size;
+    memcpy(sf.variant.text.bytes, this->packetHistoryTXQueue[packetHistory_index].payload,
            this->packetHistoryTXQueue[packetHistory_index].payload_size);
+    if (this->packetHistoryTXQueue[packetHistory_index].to == NODENUM_BROADCAST) {
+        sf.rr = meshtastic_StoreAndForward_RequestResponse_ROUTER_TEXT_BROADCAST;
+    } else {
+        sf.rr = meshtastic_StoreAndForward_RequestResponse_ROUTER_TEXT_DIRECT;
+    }
+
+    p->decoded.payload.size =
+        pb_encode_to_bytes(p->decoded.payload.bytes, sizeof(p->decoded.payload.bytes), &meshtastic_StoreAndForward_msg, &sf);
 
     service.sendToMesh(p);
 }
@@ -387,7 +398,8 @@ bool StoreForwardModule::handleReceivedProtobuf(const meshtastic_MeshPacket &mp,
                 LOG_INFO("*** S&F - Busy. Try again shortly.\n");
             } else {
                 if ((p->which_variant == meshtastic_StoreAndForward_history_tag) && (p->variant.history.window > 0)) {
-                    storeForwardModule->historySend(p->variant.history.window * 60000, getFrom(&mp)); // window is in minutes
+                    // window is in minutes
+                    storeForwardModule->historySend(p->variant.history.window * 60000, getFrom(&mp));
                 } else {
                     storeForwardModule->historySend(historyReturnWindow * 60000, getFrom(&mp)); // defaults to 4 hours
                 }
@@ -406,8 +418,7 @@ bool StoreForwardModule::handleReceivedProtobuf(const meshtastic_MeshPacket &mp,
     case meshtastic_StoreAndForward_RequestResponse_CLIENT_PONG:
         if (is_server) {
             LOG_INFO("*** StoreAndForward_RequestResponse_CLIENT_PONG\n");
-            // The Client is alive, update NodeDB
-            nodeDB.updateFrom(mp);
+            // NodeDB is already updated
         }
         break;
 
@@ -546,9 +557,7 @@ StoreForwardModule::StoreForwardModule()
             }
 
             // Client
-        }
-        if ((config.device.role == meshtastic_Config_DeviceConfig_Role_CLIENT) ||
-            (config.device.role == meshtastic_Config_DeviceConfig_Role_ROUTER_CLIENT)) {
+        } else {
             is_client = true;
             LOG_INFO("*** Initializing Store & Forward Module in Client mode\n");
         }

src/modules/esp32/StoreForwardModule.h

@@ -7,13 +7,13 @@
 #include "configuration.h"
 #include <Arduino.h>
 #include <functional>
+#include <unordered_map>
 
 struct PacketHistoryStruct {
     uint32_t time;
     uint32_t to;
     uint32_t from;
     uint8_t channel;
-    bool ack;
     uint8_t payload[meshtastic_Constants_DATA_PAYLOAD_LEN];
     pb_size_t payload_size;
 };
@@ -32,16 +32,19 @@ class StoreForwardModule : private concurrency::OSThread, public ProtobufModule<
     uint32_t packetHistoryTXQueue_size = 0;
     uint32_t packetHistoryTXQueue_index = 0;
 
-    uint32_t packetTimeMax = 5000;
+    uint32_t packetTimeMax = 5000; // Interval between sending history packets as a server.
 
     bool is_client = false;
     bool is_server = false;
 
+    // Unordered_map stores the last request for each nodeNum (`to` field)
+    std::unordered_map<NodeNum, uint32_t> lastRequest;
+
   public:
     StoreForwardModule();
 
     unsigned long lastHeartbeat = 0;
-    uint32_t heartbeatInterval = 300;
+    uint32_t heartbeatInterval = default_broadcast_interval_secs;
 
     /**
      Update our local reference of when we last saw that node.
@@ -51,7 +54,7 @@ class StoreForwardModule : private concurrency::OSThread, public ProtobufModule<
     void statsSend(uint32_t to);
     void historySend(uint32_t msAgo, uint32_t to);
 
-    uint32_t historyQueueCreate(uint32_t msAgo, uint32_t to);
+    uint32_t historyQueueCreate(uint32_t msAgo, uint32_t to, uint32_t *last_request_index);
 
     /**
      * Send our payload into the mesh
@@ -79,16 +82,16 @@ class StoreForwardModule : private concurrency::OSThread, public ProtobufModule<
     void populatePSRAM();
 
     // S&F Defaults
-    uint32_t historyReturnMax = 250;    // 250 records
-    uint32_t historyReturnWindow = 240; // 4 hours
+    uint32_t historyReturnMax = 25;     // Return maximum of 25 records by default.
+    uint32_t historyReturnWindow = 240; // Return history of last 4 hours by default.
     uint32_t records = 0;               // Calculated
     bool heartbeat = false;             // No heartbeat.
 
     // stats
-    uint32_t requests = 0;
-    uint32_t requests_history = 0;
+    uint32_t requests = 0;         // Number of times any client sent a request to the S&F.
+    uint32_t requests_history = 0; // Number of times the history was requested.
 
-    uint32_t retry_delay = 0;
+    uint32_t retry_delay = 0; // If server is busy, retry after this delay (in ms).
 
   protected:
     virtual int32_t runOnce() override;
@@ -102,4 +105,4 @@ class StoreForwardModule : private concurrency::OSThread, public ProtobufModule<
     virtual bool handleReceivedProtobuf(const meshtastic_MeshPacket &mp, meshtastic_StoreAndForward *p);
 };
 
-extern StoreForwardModule *storeForwardModule;
+extern StoreForwardModule *storeForwardModule;

src/platform/nrf52/architecture.h

@@ -48,6 +48,8 @@
 #define HW_VENDOR meshtastic_HardwareModel_T_ECHO
 #elif defined(NANO_G2_ULTRA)
 #define HW_VENDOR meshtastic_HardwareModel_NANO_G2_ULTRA
+#elif defined(CANARYONE)
+#define HW_VENDOR meshtastic_HardwareModel_CANARYONE
 #elif defined(NORDIC_PCA10059)
 #define HW_VENDOR meshtastic_HardwareModel_NRF52840_PCA10059
 #elif defined(PRIVATE_HW) || defined(FEATHER_DIY)

src/platform/nrf52/main-nrf52.cpp

@@ -185,6 +185,7 @@ void cpuDeepSleep(uint32_t msecToWake)
     // Don't enter this if we're sleeping portMAX_DELAY, since that's a shutdown event
     if (msecToWake != portMAX_DELAY &&
         (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER ||
+         config.device.role == meshtastic_Config_DeviceConfig_Role_TAK_TRACKER ||
          config.device.role == meshtastic_Config_DeviceConfig_Role_SENSOR) &&
         config.power.is_power_saving == true) {
         sd_power_mode_set(NRF_POWER_MODE_LOWPWR);

src/platform/rp2040/architecture.h

@@ -27,4 +27,6 @@
 #define HW_VENDOR meshtastic_HardwareModel_RAK11310
 #elif defined(SENSELORA_RP2040)
 #define HW_VENDOR meshtastic_HardwareModel_SENSELORA_RP2040
+#elif defined(RP2040_LORA)
+#define HW_VENDOR meshtastic_HardwareModel_RP2040_LORA
 #endif

src/power.h

@@ -5,18 +5,39 @@
 #include <esp_adc_cal.h>
 #include <soc/adc_channel.h>
 #endif
-/**
- * Per @spattinson
- * MIN_BAT_MILLIVOLTS seems high. Typical 18650 are different chemistry to LiPo, even for LiPos that chart seems a bit off, other
- * charts put 3690mV at about 30% for a lipo, for 18650 i think 10% remaining iis in the region of 3.2-3.3V. Reference 1st graph
- * in [this test report](https://lygte-info.dk/review/batteries2012/Samsung%20INR18650-30Q%203000mAh%20%28Pink%29%20UK.html)
- * looking at the red line - discharge at 0.2A - he gets a capacity of 2900mah, 90% of 2900 = 2610, that point in the graph looks
- * to be a shade above 3.2V
- */
-#define MIN_BAT_MILLIVOLTS 3250 // millivolts. 10% per https://blog.ampow.com/lipo-voltage-chart/
 
-#define BAT_MILLIVOLTS_FULL 4100
-#define BAT_MILLIVOLTS_EMPTY 3500
+#ifndef NUM_OCV_POINTS
+#define NUM_OCV_POINTS 11
+#endif
+
+// 3400,3350,3320,3290,3270,3260,3250,3230,3200,3120,3000 //3.4 to 3.0 LiFePO4
+// 2120,2090,2070,2050,2030,2010,1990,1980,1970,1960,1950 //2.12 to 1.95 Lead Acid
+// 4200,4050,3990,3890,3790,3700,3650,3550,3450,3300,3200 //4.2 to 3.2 LiIon/LiPo
+// 4200,4050,3990,3890,3790,3700,3650,3550,3400,3300,3000 //4.2 to 3.0 LiIon/LiPo
+// 4150,4050,3990,3890,3790,3690,3620,3520,3420,3300,3100 //4.15 to 3.1 LiIon/LiPo
+// 2770,2650,2540,2420,2300,2180,2060,1940,1800,1680,1550 //2.8 to 1.5 Lithium Titanate
+
+#ifndef OCV_ARRAY
+#ifdef CELL_TYPE_LIFEPO4
+#define OCV_ARRAY 3400, 3350, 3320, 3290, 3270, 3260, 3250, 3230, 3200, 3120, 3000
+#elif defined(CELL_TYPE_LEADACID)
+#define OCV_ARRAY 2120, 2090, 2070, 2050, 2030, 2010, 1990, 1980, 1970, 1960, 1950
+#elif defined(CELL_TYPE_ALKALINE)
+#define OCV_ARRAY 1580, 1400, 1350, 1300, 1280, 1250, 1230, 1190, 1150, 1100, 1000
+#elif defined(CELL_TYPE_NIMH)
+#define OCV_ARRAY 1400, 1300, 1280, 1270, 1260, 1250, 1240, 1230, 1210, 1150, 1000
+#elif defined(CELL_TYPE_LTO)
+#define OCV_ARRAY 2770, 2650, 2540, 2420, 2300, 2180, 2060, 1940, 1800, 1680, 1550
+#else // LiIon
+#define OCV_ARRAY 4190, 4050, 3990, 3890, 3800, 3720, 3630, 3530, 3420, 3300, 3100
+#endif
+#endif
+
+/*Note: 12V lead acid is 6 cells, most board accept only 1 cell LiIon/LiPo*/
+#ifndef NUM_CELLS
+#define NUM_CELLS 1
+#endif
+
 #ifdef BAT_MEASURE_ADC_UNIT
 extern RTC_NOINIT_ATTR uint64_t RTC_reg_b;
 #include "soc/sens_reg.h" // needed for adc pin reset
@@ -44,6 +65,7 @@ class Power : private concurrency::OSThread
     virtual bool setup();
     virtual int32_t runOnce() override;
     void setStatusHandler(meshtastic::PowerStatus *handler) { statusHandler = handler; }
+    const uint16_t OCV[11] = {OCV_ARRAY};
 
   protected:
     meshtastic::PowerStatus *statusHandler;
@@ -54,6 +76,7 @@ class Power : private concurrency::OSThread
     bool analogInit();
 
   private:
+    // open circuit voltage lookup table
     uint8_t low_voltage_counter;
 #ifdef DEBUG_HEAP
     uint32_t lastheap;

variants/canaryone/platformio.ini

@@ -0,0 +1,15 @@
+; Public Beta oled/nrf52840/sx1262 device
+[env:canaryone]
+extends = nrf52840_base
+board = canaryone
+debug_tool = jlink
+
+# add -DCFG_SYSVIEW if you want to use the Segger systemview tool for OS profiling.
+build_flags = ${nrf52840_base.build_flags} -Ivariants/canaryone
+  -L "${platformio.libdeps_dir}/${this.__env__}/BSEC2 Software Library/src/cortex-m4/fpv4-sp-d16-hard"
+build_src_filter = ${nrf52_base.build_src_filter} +<../variants/canaryone>
+lib_deps = 
+  ${nrf52840_base.lib_deps}
+  adafruit/Adafruit BusIO@^1.13.2
+  lewisxhe/PCF8563_Library@^1.0.1
+;upload_protocol = fs

variants/canaryone/variant.cpp

@@ -0,0 +1,56 @@
+/*
+  Copyright (c) 2014-2015 Arduino LLC.  All right reserved.
+  Copyright (c) 2016 Sandeep Mistry All right reserved.
+  Copyright (c) 2018, Adafruit Industries (adafruit.com)
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#include "variant.h"
+#include "nrf.h"
+#include "wiring_constants.h"
+#include "wiring_digital.h"
+
+const uint32_t g_ADigitalPinMap[] = {
+    // P0 - pins 0 and 1 are hardwired for xtal and should never be enabled
+    0xff, 0xff, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
+
+    // P1
+    32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47};
+
+void initVariant()
+{
+    // LEDs
+    pinMode(PIN_LED1, OUTPUT);
+    ledOff(PIN_LED1);
+
+    pinMode(PIN_LED2, OUTPUT);
+    ledOff(PIN_LED2);
+
+    pinMode(PIN_LED3, OUTPUT);
+    ledOff(PIN_LED3);
+
+    // Turn on power to the GPS and LoRa
+    pinMode(PIN_PWR_EN, OUTPUT);
+    digitalWrite(PIN_PWR_EN, HIGH);
+
+    // Pull the GPS out of reset
+    pinMode(GPS_RESET_PIN, OUTPUT);
+    digitalWrite(GPS_RESET_PIN, HIGH);
+
+    // Pull the LoRa out of reset
+    pinMode(LORA_RF_PWR, OUTPUT);
+    digitalWrite(LORA_RF_PWR, HIGH);
+}

variants/canaryone/variant.h

@@ -0,0 +1,188 @@
+/*
+ Copyright (c) 2014-2015 Arduino LLC.  All right reserved.
+ Copyright (c) 2016 Sandeep Mistry All right reserved.
+ Copyright (c) 2018, Adafruit Industries (adafruit.com)
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU Lesser General Public License for more details.
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef _VARIANT_CANARYONE
+#define _VARIANT_CANARYONE
+
+/** Master clock frequency */
+#define VARIANT_MCK (64000000ul)
+
+#define USE_LFXO // Board uses 32khz crystal for LF
+
+/*----------------------------------------------------------------------------
+ *        Headers
+ *----------------------------------------------------------------------------*/
+
+#include "WVariant.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif // __cplusplus
+
+#define CANARYONE
+
+#define GPIO_PORT0 0
+#define GPIO_PORT1 32
+
+// Number of pins defined in PinDescription array
+#define PINS_COUNT (48)
+#define NUM_DIGITAL_PINS (48)
+#define NUM_ANALOG_INPUTS (1)
+#define NUM_ANALOG_OUTPUTS (0)
+
+// LEDs
+#define PIN_LED1 (GPIO_PORT1 + 1)  // blue P1.01
+#define PIN_LED2 (GPIO_PORT0 + 14) // yellow P0.14
+#define PIN_LED3 (GPIO_PORT1 + 3)  // green P1.03
+
+#define LED_BLUE PIN_LED1
+
+#define LED_BUILTIN PIN_LED1
+#define LED_CONN PIN_LED3
+
+#define LED_STATE_ON 0 // State when LED is lit
+#define LED_INVERTED 1
+
+/*
+ * Buttons
+ */
+#define PIN_BUTTON1 (GPIO_PORT0 + 15) // BTN0 on schematic
+#define PIN_BUTTON2 (GPIO_PORT0 + 16) // BTN1 on schematic
+
+/*
+ * Analog pins
+ */
+#define PIN_A0 (4) // Battery ADC P0.04
+
+#define BATTERY_PIN PIN_A0
+
+static const uint8_t A0 = PIN_A0;
+
+#define ADC_RESOLUTION 14
+
+/**
+ * Wire Interfaces
+ */
+#define WIRE_INTERFACES_COUNT 1
+
+#define PIN_WIRE_SDA (GPIO_PORT0 + 26)
+// #define I2C_SDA  (GPIO_PORT0 + 26)
+#define PIN_WIRE_SCL (GPIO_PORT0 + 27)
+// #define I2C_SCL (GPIO_PORT0 + 27)
+
+#define PIN_LCD_RESET (GPIO_PORT0 + 2)
+
+/*
+ * External serial flash WP25R1635FZUIL0
+ */
+
+// QSPI Pins
+#define PIN_QSPI_SCK (GPIO_PORT1 + 14)
+#define PIN_QSPI_CS (GPIO_PORT1 + 15)
+#define PIN_QSPI_IO0 (GPIO_PORT1 + 12) // MOSI if using two bit interface
+#define PIN_QSPI_IO1 (GPIO_PORT1 + 13) // MISO if using two bit interface
+#define PIN_QSPI_IO2 (GPIO_PORT0 + 7)  // WP if using two bit interface (i.e. not used)
+#define PIN_QSPI_IO3 (GPIO_PORT0 + 5)  // HOLD if using two bit interface (i.e. not used)
+
+// On-board QSPI Flash
+#define EXTERNAL_FLASH_DEVICES MX25R1635F
+#define EXTERNAL_FLASH_USE_QSPI
+
+/*
+ * Lora radio
+ */
+#define RADIOLIB_DEBUG 1
+#define USE_SX1262
+#define SX126X_CS (GPIO_PORT0 + 24)
+#define SX126X_DIO1 (GPIO_PORT1 + 11)
+// #define SX126X_DIO3 (GPIO_PORT0 + 21)
+// #define SX126X_DIO2 () // LORA_BUSY // LoRa RX/TX
+#define SX126X_BUSY (GPIO_PORT0 + 17)
+#define SX126X_RESET (GPIO_PORT0 + 25)
+#define LORA_RF_PWR (GPIO_PORT0 + 28) // LORA_RF_SWITCH
+
+/*
+ * GPS pins
+ */
+#define HAS_GPS 1
+#define GPS_UBLOX
+#define GPS_BAUDRATE 38400
+
+// #define PIN_GPS_WAKE (GPIO_PORT1 + 2) // An output to wake GPS, low means allow sleep, high means force wake
+// Seems to be missing on this new board
+#define PIN_GPS_PPS (GPIO_PORT1 + 4) // Pulse per second input from the GPS
+#define GPS_TX_PIN (GPIO_PORT1 + 9)  // This is for bits going TOWARDS the CPU
+#define GPS_RX_PIN (GPIO_PORT1 + 8)  // This is for bits going TOWARDS the GPS
+
+#define GPS_THREAD_INTERVAL 50
+
+#define PIN_SERIAL1_RX GPS_TX_PIN
+#define PIN_SERIAL1_TX GPS_RX_PIN
+
+#define GPS_RESET_PIN (GPIO_PORT1 + 5) // GPS reset pin
+
+/*
+ * SPI Interfaces
+ */
+#define SPI_INTERFACES_COUNT 1
+
+// For LORA, spi 0
+#define PIN_SPI_MISO (GPIO_PORT0 + 23)
+#define PIN_SPI_MOSI (GPIO_PORT0 + 22)
+#define PIN_SPI_SCK (GPIO_PORT0 + 19)
+
+// #define PIN_SPI1_MISO (GPIO_PORT1 + 6) // FIXME not really needed, but for now the SPI code requires something to be defined,
+//  pick an used GPIO #define PIN_SPI1_MOSI (GPIO_PORT1 + 8) #define PIN_SPI1_SCK (GPIO_PORT1 + 9)
+
+#define PIN_PWR_EN (GPIO_PORT0 + 12)
+
+// To debug via the segger JLINK console rather than the CDC-ACM serial device
+#define USE_SEGGER 1
+
+// #define LORA_DISABLE_SENDING 1
+#define SX126X_DIO2_AS_RF_SWITCH 1
+
+// Battery
+// The battery sense is hooked to pin A0 (4)
+// it is defined in the anlaolgue pin section of this file
+// and has 12 bit resolution
+#define BATTERY_SENSE_RESOLUTION_BITS 12
+#define BATTERY_SENSE_RESOLUTION 4096.0
+// Definition of milliVolt per LSB => 3.0V ADC range and 12-bit ADC resolution = 3000mV/4096
+#define VBAT_MV_PER_LSB (0.73242188F)
+// Voltage divider value => 100K + 100K voltage divider on VBAT = (100K / (100K + 100K))
+#define VBAT_DIVIDER (0.5F)
+// Compensation factor for the VBAT divider
+#define VBAT_DIVIDER_COMP (2.0)
+// Fixed calculation of milliVolt from compensation value
+#define REAL_VBAT_MV_PER_LSB (VBAT_DIVIDER_COMP * VBAT_MV_PER_LSB)
+#undef AREF_VOLTAGE
+#define AREF_VOLTAGE 3.0
+#define VBAT_AR_INTERNAL AR_INTERNAL_3_0
+#define ADC_MULTIPLIER VBAT_DIVIDER_COMP
+#define VBAT_RAW_TO_SCALED(x) (REAL_VBAT_MV_PER_LSB * x)
+
+#ifdef __cplusplus
+}
+#endif
+
+/*----------------------------------------------------------------------------
+ *        Arduino objects - C++ only
+ *----------------------------------------------------------------------------*/
+
+#endif

variants/chatter2/variant.h

@@ -72,14 +72,13 @@
 #define BATTERY_PIN 34 // A battery voltage measurement pin, voltage divider connected here to measure battery voltage
 #define ADC_CHANNEL ADC1_GPIO34_CHANNEL
 #define ADC_ATTENUATION                                                                                                          \
-    ADC_ATTEN_DB_2_5 // 2_5-> 100mv-1250mv, 11-> 150mv-3100mv for ESP32
-                     // ESP32-S2/C3/S3 are different
-                     // lower dB for lower voltage rnage
-#define ADC_MULTIPLIER                                                                                                           \
-    5.0                   // VBATT---10k--pin34---2.5K---GND
-                          // Chatter2 uses 3 AAA cells
-#define BAT_FULLVOLT 4800 // with the 5.0 divider, input to BATTERY_PIN is 900mv
-#define BAT_EMPTYVOLT 3300
+    ADC_ATTEN_DB_2_5       // 2_5-> 100mv-1250mv, 11-> 150mv-3100mv for ESP32
+                           // ESP32-S2/C3/S3 are different
+                           // lower dB for lower voltage rnage
+#define ADC_MULTIPLIER 5.0 // VBATT---10k--pin34---2.5K---GND
+// Chatter2 uses 3 AAA cells
+#define CELL_TYPE_ALKALINE
+#define NUM_CELLS 3
 #undef EXT_PWR_DETECT
 
 // GPS

variants/heltec_v2.1/variant.h

@@ -29,7 +29,8 @@
 #define LORA_DIO1 35 // https://www.thethingsnetwork.org/forum/t/big-esp32-sx127x-topic-part-3/18436
 #define LORA_DIO2 34 // Not really used
 
-#define ADC_MULTIPLIER 3.8
+#define ADC_MULTIPLIER 3.2 // 220k + 100k (320k/100k=3.2)
+// #define ADC_WIDTH ADC_WIDTH_BIT_10
 
 #define BATTERY_PIN 37 // A battery voltage measurement pin, voltage divider connected here to measure battery voltage
 #define ADC_CHANNEL ADC1_GPIO37_CHANNEL

variants/heltec_v3/variant.h

@@ -11,6 +11,8 @@
 #define VEXT_ENABLE Vext // active low, powers the oled display and the lora antenna boost
 #define BUTTON_PIN 0
 
+#define ADC_CTRL 37
+#define ADC_CTRL_ENABLED LOW
 #define BATTERY_PIN 1 // A battery voltage measurement pin, voltage divider connected here to measure battery voltage
 #define ADC_CHANNEL ADC1_GPIO1_CHANNEL
 #define ADC_ATTENUATION ADC_ATTEN_DB_2_5 // lower dB for high resistance voltage divider

variants/heltec_wireless_paper/variant.h

@@ -27,10 +27,12 @@
 #define VEXT_ENABLE 45 // active low, powers the oled display and the lora antenna boost
 #define BUTTON_PIN 0
 
-#define BATTERY_PIN 1 // A battery voltage measurement pin, voltage divider connected here to measure battery voltage
-#define ADC_CHANNEL ADC1_GPIO1_CHANNEL
-#define ADC_ATTENUATION ADC_ATTEN_DB_2_5 // lower dB for high resistance voltage divider
-#define ADC_MULTIPLIER 4.9
+#define ADC_CTRL 19
+#define BATTERY_PIN 20
+#define ADC_CHANNEL ADC2_GPIO20_CHANNEL
+#define ADC_MULTIPLIER 2                // Voltage divider is roughly 1:1
+#define BAT_MEASURE_ADC_UNIT 2          // Use ADC2
+#define ADC_ATTENUATION ADC_ATTEN_DB_11 // Voltage divider output is quite high
 
 #define USE_SX1262
 

variants/heltec_wireless_paper_v1/variant.h

@@ -5,6 +5,14 @@
 #define I2C_SCL SCL
 
 #define USE_EINK
+
+// Settings for Dynamic Partial mode
+// Change between partial and full refresh config, or skip update, balancing urgency and display health.
+#define USE_EINK_DYNAMIC_PARTIAL
+#define EINK_LOWPRIORITY_LIMIT_SECONDS 30
+#define EINK_HIGHPRIORITY_LIMIT_SECONDS 1
+#define EINK_PARTIAL_REPEAT_LIMIT 5
+
 /*
  * eink display pins
  */
@@ -27,10 +35,12 @@
 #define VEXT_ENABLE 45 // active low, powers the oled display and the lora antenna boost
 #define BUTTON_PIN 0
 
-#define BATTERY_PIN 1 // A battery voltage measurement pin, voltage divider connected here to measure battery voltage
-#define ADC_CHANNEL ADC1_GPIO1_CHANNEL
-#define ADC_ATTENUATION ADC_ATTEN_DB_2_5 // lower dB for high resistance voltage divider
-#define ADC_MULTIPLIER 4.9
+#define ADC_CTRL 19
+#define BATTERY_PIN 20
+#define ADC_CHANNEL ADC2_GPIO20_CHANNEL
+#define ADC_MULTIPLIER 2                // Voltage divider is roughly 1:1
+#define BAT_MEASURE_ADC_UNIT 2          // Use ADC2
+#define ADC_ATTENUATION ADC_ATTEN_DB_11 // Voltage divider output is quite high
 
 #define USE_SX1262
 

variants/heltec_wireless_tracker/variant.h

@@ -35,6 +35,7 @@
 #define ADC_ATTENUATION ADC_ATTEN_DB_2_5 // lower dB for high resistance voltage divider
 #define ADC_MULTIPLIER 4.9
 #define ADC_CTRL 2 // active HIGH, powers the voltage divider. Only on 1.1
+#define ADC_CTRL_ENABLED HIGH
 
 #undef GPS_RX_PIN
 #undef GPS_TX_PIN

variants/heltec_wsl_v3/variant.h

@@ -8,6 +8,8 @@
 #define VEXT_ENABLE Vext // active low, powers the oled display and the lora antenna boost
 #define BUTTON_PIN 0
 
+#define ADC_CTRL 37
+#define ADC_CTRL_ENABLED LOW
 #define BATTERY_PIN 1 // A battery voltage measurement pin, voltage divider connected here to measure battery voltage
 #define ADC_CHANNEL ADC1_GPIO1_CHANNEL
 #define ADC_ATTENUATION ADC_ATTEN_DB_2_5 // lower dB for high resistance voltage divider

variants/portduino/variant.h

@@ -1,2 +1,3 @@
 #define HAS_SCREEN 1
-#define CANNED_MESSAGE_MODULE_ENABLE 1
+#define CANNED_MESSAGE_MODULE_ENABLE 1
+#define HAS_GPS 1

variants/rp2040-lora/platformio.ini

@@ -0,0 +1,16 @@
+[env:rp2040-lora]
+extends = rp2040_base
+board = rpipico
+upload_protocol = picotool
+
+# add our variants files to the include and src paths
+build_flags = ${rp2040_base.build_flags} 
+  -DRP2040_LORA
+  -Ivariants/rp2040-lora
+  -DDEBUG_RP2040_PORT=Serial
+  -DHW_SPI1_DEVICE
+  -L "${platformio.libdeps_dir}/${this.__env__}/BSEC2 Software Library/src/cortex-m0plus"
+lib_deps =
+  ${rp2040_base.lib_deps}
+debug_build_flags = ${rp2040_base.build_flags}
+debug_tool = cmsis-dap ; for e.g. Picotool

variants/rp2040-lora/variant.h

@@ -0,0 +1,54 @@
+// #define RADIOLIB_CUSTOM_ARDUINO 1
+// #define RADIOLIB_TONE_UNSUPPORTED 1
+// #define RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED 1
+
+#define ARDUINO_ARCH_AVR
+
+// #define USE_SH1106 1
+
+// default I2C pins:
+// SDA = 4
+// SCL = 5
+
+// Recommended pins for SerialModule:
+// txd = 8
+// rxd = 9
+
+#define EXT_NOTIFY_OUT 22
+#define BUTTON_PIN 17
+
+#define LED_PIN PIN_LED
+
+// #define BATTERY_PIN 26
+//  ratio of voltage divider = 3.0 (R17=200k, R18=100k)
+// #define ADC_MULTIPLIER 3.1 // 3.0 + a bit for being optimistic
+
+#define USE_SX1262
+
+#undef LORA_SCK
+#undef LORA_MISO
+#undef LORA_MOSI
+#undef LORA_CS
+
+// https://www.waveshare.com/rp2040-lora.htm
+// https://www.waveshare.com/img/devkit/RP2040-LoRa-HF/RP2040-LoRa-HF-details-11.jpg
+#define LORA_SCK 14  // 10
+#define LORA_MISO 24 // 12
+#define LORA_MOSI 15 // 11
+#define LORA_CS 13   // 3
+
+#define LORA_DIO0 RADIOLIB_NC
+#define LORA_RESET 23 // 15
+#define LORA_DIO1 16  // 20
+#define LORA_DIO2 18  // 2
+#define LORA_DIO3 RADIOLIB_NC
+#define LORA_DIO4 17
+
+#ifdef USE_SX1262
+#define SX126X_CS LORA_CS
+#define SX126X_DIO1 LORA_DIO1
+#define SX126X_BUSY LORA_DIO2
+#define SX126X_RESET LORA_RESET
+#define SX126X_DIO2_AS_RF_SWITCH
+// #define SX126X_DIO3_TCXO_VOLTAGE 1.8
+#endif

variants/station-g1/variant.h

@@ -37,10 +37,8 @@
 #define ADC_CHANNEL ADC1_GPIO35_CHANNEL
 #define BATTERY_SENSE_SAMPLES 30 // Set the number of samples, It has an effect of increasing sensitivity.
 #define ADC_MULTIPLIER 6.45
-#define BAT_FULLVOLT 12600
-#define BAT_EMPTYVOLT 8200
-#define BAT_CHARGINGVOLT 12600
-#define BAT_NOBATVOLT 6690
+#define CELL_TYPE_LION // same curve for liion/lipo
+#define NUM_CELLS 3
 
 // different screen
 #define USE_SH1106

version.properties

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