Merge remote-tracking branch 'upstream/master' into brc-2023

.github/ISSUE_TEMPLATE/Bug Report.yml

@@ -37,14 +37,18 @@ body:
         - T-Lora v1
         - T-Lora v1.3
         - T-Lora v2 1.6
+        - T-Deck
         - T-Echo
+        - T-Watch
         - Rak4631
         - Rak11200
         - Rak11310
         - Heltec v1
         - Heltec v2
         - Heltec v2.1
         - Heltec V3
+        - Heltec Wireless Paper
+        - Heltec Wireless Tracker
         - Raspberry Pi Pico (W)
         - Relay v1
         - Relay v2

.github/workflows/build_esp32.yml

@@ -17,11 +17,11 @@ jobs:
         uses: ./.github/actions/setup-base
 
       - name: Pull web ui
-        uses: dsaltares/fetch-gh-release-asset@master
+        uses: dsaltares/fetch-gh-release-asset@a40c8b4a0471f9ab81bdf73a010f74cc51476ad4
         with:
-          repo: "meshtastic/web"
-          file: "build.tar"
-          target: "build.tar"
+          repo: meshtastic/web
+          file: build.tar
+          target: build.tar
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Unpack web ui
@@ -40,11 +40,11 @@ jobs:
         run: bin/build-esp32.sh ${{ inputs.board }}
 
       - name: Pull OTA Firmware
-        uses: dsaltares/fetch-gh-release-asset@master
+        uses: dsaltares/fetch-gh-release-asset@a40c8b4a0471f9ab81bdf73a010f74cc51476ad4
         with:
-          repo: "meshtastic/firmware-ota"
-          file: "firmware.bin"
-          target: "release/bleota.bin"
+          repo: meshtastic/firmware-ota
+          file: firmware.bin
+          target: release/bleota.bin
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get release version string

.github/workflows/build_esp32_s3.yml

@@ -17,11 +17,11 @@ jobs:
         uses: ./.github/actions/setup-base
 
       - name: Pull web ui
-        uses: dsaltares/fetch-gh-release-asset@master
+        uses: dsaltares/fetch-gh-release-asset@a40c8b4a0471f9ab81bdf73a010f74cc51476ad4
         with:
-          repo: "meshtastic/web"
-          file: "build.tar"
-          target: "build.tar"
+          repo: meshtastic/web
+          file: build.tar
+          target: build.tar
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Unpack web ui
@@ -38,11 +38,11 @@ jobs:
         run: bin/build-esp32.sh ${{ inputs.board }}
 
       - name: Pull OTA Firmware
-        uses: dsaltares/fetch-gh-release-asset@master
+        uses: dsaltares/fetch-gh-release-asset@a40c8b4a0471f9ab81bdf73a010f74cc51476ad4
         with:
-          repo: "meshtastic/firmware-ota"
-          file: "firmware-s3.bin"
-          target: "release/bleota-s3.bin"
+          repo: meshtastic/firmware-ota
+          file: firmware-s3.bin
+          target: release/bleota-s3.bin
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get release version string

.github/workflows/main_matrix.yml

@@ -1,4 +1,7 @@
 name: CI
+#concurrency:
+#  group: ${{ github.ref }}
+#  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
 on:
   # # Triggers the workflow on push but only for the master branch
   push:
@@ -46,7 +49,7 @@ jobs:
 
       - name: Trunk Check
         if: ${{ github.event_name != 'workflow_dispatch' }}
-        uses: trunk-io/trunk-action@v1
+        uses: trunk-io/trunk-action@782e83f803ca6e369f035d64c6ba2768174ba61b
 
       - name: Check ${{ matrix.board }}
         run: bin/check-all.sh ${{ matrix.board }}
@@ -108,6 +111,7 @@ jobs:
           - board: t-echo
           - board: pca10059_diy_eink
           - board: feather_diy
+          - board: nano-g2-ultra
     uses: ./.github/workflows/build_nrf52.yml
     with:
       board: ${{ matrix.board }}
@@ -255,6 +259,7 @@ jobs:
           retention-days: 30
 
       - name: Create request artifacts
+        continue-on-error: true # FIXME: Why are we getting 502, but things still work?
         if: ${{ github.event_name == 'pull_request_target' || github.event_name == 'pull_request' }}
         uses: gavv/[email protected]
         with:

.github/workflows/nightly.yml

@@ -14,6 +14,6 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Trunk Check
-        uses: trunk-io/trunk-action@v1
+        uses: trunk-io/trunk-action@782e83f803ca6e369f035d64c6ba2768174ba61b
         with:
           trunk-token: ${{ secrets.TRUNK_TOKEN }}

.vscode/extensions.json

@@ -6,4 +6,4 @@
         "platformio.platformio-ide",
         "trunk.io"
     ],
-}
+}

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
   "editor.formatOnSave": true,
-  "editor.defaultFormatter": "trunk.io"
+  "editor.defaultFormatter": "trunk.io",
+  "trunk.enableWindows": true
 }

arch/nrf52/nrf52.ini

@@ -5,7 +5,9 @@ extends = arduino_base
 
 build_type = debug ; I'm debugging with ICE a lot now
 build_flags = 
-  ${arduino_base.build_flags} -Wno-unused-variable 
+  ${arduino_base.build_flags}
+  -DSERIAL_BUFFER_SIZE=1024
+  -Wno-unused-variable
   -Isrc/platform/nrf52
 
 build_src_filter = 

bin/device-install.bat

@@ -32,7 +32,7 @@ IF EXIST %FILENAME% IF x%FILENAME:update=%==x%FILENAME% (
 	%PYTHON% -m esptool --baud 115200 write_flash 0x00 %FILENAME%
 
     @REM Account for S3 board's different OTA partition
-    IF x%FILENAME:s3=%==x%FILENAME% IF x%FILENAME:v3=%==x%FILENAME% (
+    IF x%FILENAME:s3=%==x%FILENAME% IF x%FILENAME:v3=%==x%FILENAME% IF x%FILENAME:t-deck=%==x%FILENAME% IF x%FILENAME:wireless-paper=%==x%FILENAME% IF x%FILENAME:wireless-tracker=%==x%FILENAME% (
         %PYTHON% -m esptool --baud 115200 write_flash 0x260000 bleota.bin
 	) else (
         %PYTHON% -m esptool --baud 115200 write_flash 0x260000 bleota-s3.bin

bin/device-install.sh

@@ -50,7 +50,7 @@ if [ -f "${FILENAME}" ] && [ ! -z "${FILENAME##*"update"*}" ]; then
 	"$PYTHON" -m esptool  erase_flash
 	"$PYTHON" -m esptool  write_flash 0x00 ${FILENAME}
 	# Account for S3 board's different OTA partition
-	if [ ! -z "${FILENAME##*"s3"*}" ] && [ ! -z "${FILENAME##*"-v3"*}" ]; then
+	if [ ! -z "${FILENAME##*"s3"*}" ] && [ ! -z "${FILENAME##*"-v3"*}" ] && [ ! -z "${FILENAME##*"t-deck"*}" ] && [ ! -z "${FILENAME##*"wireless-paper"*}" ] && [ ! -z "${FILENAME##*"wireless-tracker"*}" ]; then
 		"$PYTHON" -m esptool  write_flash 0x260000 bleota.bin
 	else
 	    "$PYTHON" -m esptool  write_flash 0x260000 bleota-s3.bin

boards/nano-g2-ultra.json

@@ -0,0 +1,51 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52840_s140_v6.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DARDUINO_NRF52840_FEATHER -DNRF52840_XXAA",
+    "f_cpu": "64000000L",
+    "hwids": [
+      ["0x239A", "0x8029"],
+      ["0x239A", "0x0029"],
+      ["0x239A", "0x002A"],
+      ["0x239A", "0x802A"]
+    ],
+    "usb_product": "BQ nRF52840",
+    "mcu": "nrf52840",
+    "variant": "nano-g2-ultra",
+    "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",
+    "svd_path": "nrf52840.svd"
+  },
+  "frameworks": ["arduino"],
+  "name": "BQ nRF52840",
+  "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://wiki.uniteng.com/en/meshtastic/nano-g2-ultra",
+  "vendor": "BQ Consulting"
+}

src/ButtonThread.h

@@ -101,23 +101,8 @@ class ButtonThread : public concurrency::OSThread
 #endif
         // if (!canSleep) LOG_DEBUG("Suppressing sleep!\n");
         // else LOG_DEBUG("sleep ok\n");
-#if defined(ST7735_CS) || defined(ILI9341_DRIVER) || defined(ST7789_CS)
-        int x, y = 0;
-        screen->getTouch(&x, &y);
-        if (x > 0 && y > 0) {
-#ifdef T_WATCH_S3
-            drv.setWaveform(0, 75);
-            drv.setWaveform(1, 0); // end waveform
-            drv.go();
-#endif
-            LOG_DEBUG("touch %d %d\n", x, y);
-            powerFSM.trigger(EVENT_PRESS);
-            return 150; // Check for next touch every in 150ms
-        }
-
-#endif
 
-        return 5;
+        return 50;
     }
 
   private:

src/FSCommon.cpp

@@ -1,3 +1,13 @@
+/**
+ * @file FSCommon.cpp
+ * @brief This file contains functions for common filesystem operations such as copying, renaming, listing and deleting files and
+ * directories.
+ *
+ * The functions in this file are used to perform common filesystem operations such as copying, renaming, listing and deleting
+ * files and directories. These functions are used in the Meshtastic-device project to manage files and directories on the
+ * device's filesystem.
+ *
+ */
 #include "FSCommon.h"
 #include "configuration.h"
 
@@ -14,6 +24,13 @@ SPIClass SPI1(HSPI);
 
 #endif // HAS_SDCARD
 
+/**
+ * @brief Copies a file from one location to another.
+ *
+ * @param from The path of the source file.
+ * @param to The path of the destination file.
+ * @return true if the file was successfully copied, false otherwise.
+ */
 bool copyFile(const char *from, const char *to)
 {
 #ifdef FSCom
@@ -43,6 +60,14 @@ bool copyFile(const char *from, const char *to)
 #endif
 }
 
+/**
+ * Renames a file from pathFrom to pathTo.
+ *
+ * @param pathFrom The original path of the file.
+ * @param pathTo The new path of the file.
+ *
+ * @return True if the file was successfully renamed, false otherwise.
+ */
 bool renameFile(const char *pathFrom, const char *pathTo)
 {
 #ifdef FSCom
@@ -59,6 +84,13 @@ bool renameFile(const char *pathFrom, const char *pathTo)
 #endif
 }
 
+/**
+ * Lists the contents of a directory.
+ *
+ * @param dirname The name of the directory to list.
+ * @param levels The number of levels of subdirectories to list.
+ * @param del Whether or not to delete the contents of the directory after listing.
+ */
 void listDir(const char *dirname, uint8_t levels, bool del = false)
 {
 #ifdef FSCom
@@ -154,6 +186,13 @@ void listDir(const char *dirname, uint8_t levels, bool del = false)
 #endif
 }
 
+/**
+ * @brief Removes a directory and all its contents.
+ *
+ * This function recursively removes a directory and all its contents, including subdirectories and files.
+ *
+ * @param dirname The name of the directory to remove.
+ */
 void rmDir(const char *dirname)
 {
 #ifdef FSCom
@@ -182,6 +221,9 @@ void fsInit()
 #endif
 }
 
+/**
+ * Initializes the SD card and mounts the file system.
+ */
 void setupSDCard()
 {
 #ifdef HAS_SDCARD
@@ -212,4 +254,4 @@ void setupSDCard()
     LOG_DEBUG("Total space: %llu MB\n", SD.totalBytes() / (1024 * 1024));
     LOG_DEBUG("Used space: %llu MB\n", SD.usedBytes() / (1024 * 1024));
 #endif
-}
+}

src/OSTimer.cpp

@@ -29,6 +29,16 @@ static void IRAM_ATTR onTimer()
     (*tCallback)(tParam1, tParam2);
 }
 
+/**
+ * Schedules a hardware callback function to be executed after a specified delay.
+ *
+ * @param callback The function to be executed.
+ * @param param1 The first parameter to be passed to the function.
+ * @param param2 The second parameter to be passed to the function.
+ * @param delayMsec The delay time in milliseconds before the function is executed.
+ *
+ * @return True if the function was successfully scheduled, false otherwise.
+ */
 bool scheduleHWCallback(PendableFunction callback, void *param1, uint32_t param2, uint32_t delayMsec)
 {
     if (!timer) {

src/Power.cpp

@@ -1,3 +1,15 @@
+/**
+ * @file Power.cpp
+ * @brief This file contains the implementation of the Power class, which is responsible for managing power-related functionality
+ * of the device. It includes battery level sensing, power management unit (PMU) control, and power state machine management. The
+ * Power class is used by the main device class to manage power-related functionality.
+ *
+ * The file also includes implementations of various battery level sensors, such as the AnalogBatteryLevel class, which assumes
+ * the battery voltage is attached via a voltage-divider to an analog input.
+ *
+ * This file is part of the Meshtastic project.
+ * For more information, see: https://meshtastic.org/
+ */
 #include "power.h"
 #include "NodeDB.h"
 #include "PowerFSM.h"
@@ -366,6 +378,11 @@ bool Power::analogInit()
 #endif
 }
 
+/**
+ * Initializes the Power class.
+ *
+ * @return true if the setup was successful, false otherwise.
+ */
 bool Power::setup()
 {
     bool found = axpChipInit();