Merge branch 'dev'

Author: Scott Powell

README.md

@@ -39,9 +39,11 @@ For developers;
 - Clone and open the MeshCore repository in Visual Studio Code.
 - See the example applications you can modify and run:
   - [Companion Radio](./examples/companion_radio) - For use with an external chat app, over BLE, USB or WiFi.
+  - [KISS Modem](./examples/kiss_modem) - Serial KISS protocol bridge for host applications. ([protocol docs](./docs/kiss_modem_protocol.md))
   - [Simple Repeater](./examples/simple_repeater) - Extends network coverage by relaying messages.
   - [Simple Room Server](./examples/simple_room_server) - A simple BBS server for shared Posts.
   - [Simple Secure Chat](./examples/simple_secure_chat) - Secure terminal based text communication between devices.
+  - [Simple Sensor](./examples/simple_sensor) - Remote sensor node with telemetry and alerting.
 
 The Simple Secure Chat example can be interacted with through the Serial Monitor in Visual Studio Code, or with a Serial USB Terminal on Android.
 

boards/t_beam_1w.json

@@ -0,0 +1,50 @@
+{
+    "build": {
+        "arduino": {
+            "ldscript": "esp32s3_out.ld",
+            "memory_type": "qio_opi"
+        },
+        "core": "esp32",
+        "extra_flags": [
+            "-DBOARD_HAS_PSRAM",
+            "-DLILYGO_TBEAM_1W",
+            "-DARDUINO_USB_CDC_ON_BOOT=1",
+            "-DARDUINO_USB_MODE=0",
+            "-DARDUINO_RUNNING_CORE=1",
+            "-DARDUINO_EVENT_RUNNING_CORE=1"
+        ],
+        "f_cpu": "240000000L",
+        "f_flash": "80000000L",
+        "flash_mode": "qio",
+        "psram_type": "opi",
+        "hwids": [
+            [
+                "0x303A",
+                "0x1001"
+            ]
+        ],
+        "mcu": "esp32s3",
+        "variant": "lilygo_tbeam_1w"
+    },
+    "connectivity": [
+        "wifi",
+        "bluetooth",
+        "lora"
+    ],
+    "debug": {
+        "openocd_target": "esp32s3.cfg"
+    },
+    "frameworks": [
+        "arduino"
+    ],
+    "name": "LilyGo TBeam-1W",
+    "upload": {
+        "flash_size": "16MB",
+        "maximum_ram_size": 327680,
+        "maximum_size": 16777216,
+        "require_upload_port": true,
+        "speed": 921600
+    },
+    "url": "http://www.lilygo.cn/",
+    "vendor": "LilyGo"
+}

build.sh

@@ -7,6 +7,7 @@ sh build.sh <command> [target]
 
 Commands:
   help|usage|-h|--help: Shows this message.
+  list|-l: List firmwares available to build.
   build-firmware <target>: Build the firmware for the given build target.
   build-firmwares: Build all firmwares for all targets.
   build-matching-firmwares <build-match-spec>: Build all firmwares for build targets containing the string given for <build-match-spec>.
@@ -46,19 +47,25 @@ $ sh build.sh build-firmware RAK_4631_repeater
 EOF
 }
 
+# get a list of pio env names that start with "env:"
+get_pio_envs() {
+  pio project config | grep 'env:' | sed 's/env://'
+}
+
 # Catch cries for help before doing anything else.
 case $1 in
   help|usage|-h|--help)
     global_usage
     exit 1
     ;;
+  list|-l)
+    get_pio_envs
+    exit 0
+    ;;
 esac
 
-
-# get a list of pio env names that start with "env:"
-get_pio_envs() {
-  echo $(pio project config | grep 'env:' | sed 's/env://')
-}
+# cache project config json for use in get_platform_for_env()
+PIO_CONFIG_JSON=$(pio project config --json-output)
 
 # $1 should be the string to find (case insensitive)
 get_pio_envs_containing_string() {
@@ -82,6 +89,25 @@ get_pio_envs_ending_with_string() {
   done
 }
 
+# get platform flag for a given environment
+# $1 should be the environment name
+get_platform_for_env() {
+  local env_name=$1
+  echo "$PIO_CONFIG_JSON" | python3 -c "
+import sys, json, re
+data = json.load(sys.stdin)
+for section, options in data:
+    if section == 'env:$env_name':
+        for key, value in options:
+            if key == 'build_flags':
+                for flag in value:
+                    match = re.search(r'(ESP32_PLATFORM|NRF52_PLATFORM|STM32_PLATFORM|RP2040_PLATFORM)', flag)
+                    if match:
+                        print(match.group(1))
+                        sys.exit(0)
+"
+}
+
 # disable all debug logging flags if DISABLE_DEBUG=1 is set
 disable_debug_flags() {
   if [ "$DISABLE_DEBUG" == "1" ]; then
@@ -91,6 +117,8 @@ disable_debug_flags() {
 
 # build firmware for the provided pio env in $1
 build_firmware() {
+  # get env platform for post build actions
+  ENV_PLATFORM=($(get_platform_for_env $1))
 
   # get git commit sha
   COMMIT_HASH=$(git rev-parse --short HEAD)
@@ -121,27 +149,31 @@ build_firmware() {
   # build firmware target
   pio run -e $1
 
-  # build merge-bin for esp32 fresh install
-  if [ -f .pio/build/$1/firmware.bin ]; then
+  # build merge-bin for esp32 fresh install, copy .bins to out folder (e.g: Heltec_v3_room_server-v1.0.0-SHA.bin)
+  if [ "$ENV_PLATFORM" == "ESP32_PLATFORM" ]; then
     pio run -t mergebin -e $1
+    cp .pio/build/$1/firmware.bin out/${FIRMWARE_FILENAME}.bin 2>/dev/null || true
+    cp .pio/build/$1/firmware-merged.bin out/${FIRMWARE_FILENAME}-merged.bin 2>/dev/null || true
   fi
 
-  # build .uf2 for nrf52 boards
-  if [[ -f .pio/build/$1/firmware.zip && -f .pio/build/$1/firmware.hex ]]; then
+  # build .uf2 for nrf52 boards, copy .uf2 and .zip to out folder (e.g: RAK_4631_Repeater-v1.0.0-SHA.uf2)
+  if [ "$ENV_PLATFORM" == "NRF52_PLATFORM" ]; then
     python3 bin/uf2conv/uf2conv.py .pio/build/$1/firmware.hex -c -o .pio/build/$1/firmware.uf2 -f 0xADA52840
+    cp .pio/build/$1/firmware.uf2 out/${FIRMWARE_FILENAME}.uf2 2>/dev/null || true
+    cp .pio/build/$1/firmware.zip out/${FIRMWARE_FILENAME}.zip 2>/dev/null || true
   fi
 
-  # copy .bin, .uf2, and .zip to out folder
-  # e.g: Heltec_v3_room_server-v1.0.0-SHA.bin
-  # e.g: RAK_4631_Repeater-v1.0.0-SHA.uf2
-
-  # copy .bin for esp32 boards
-  cp .pio/build/$1/firmware.bin out/${FIRMWARE_FILENAME}.bin 2>/dev/null || true
-  cp .pio/build/$1/firmware-merged.bin out/${FIRMWARE_FILENAME}-merged.bin 2>/dev/null || true
+  # for stm32, copy .bin and .hex to out folder
+  if [ "$ENV_PLATFORM" == "STM32_PLATFORM" ]; then
+    cp .pio/build/$1/firmware.bin out/${FIRMWARE_FILENAME}.bin 2>/dev/null || true
+    cp .pio/build/$1/firmware.hex out/${FIRMWARE_FILENAME}.hex 2>/dev/null || true
+  fi
 
-  # copy .zip and .uf2 of nrf52 boards
-  cp .pio/build/$1/firmware.uf2 out/${FIRMWARE_FILENAME}.uf2 2>/dev/null || true
-  cp .pio/build/$1/firmware.zip out/${FIRMWARE_FILENAME}.zip 2>/dev/null || true
+  # for rp2040, copy .bin and .uf2 to out folder
+  if [ "$ENV_PLATFORM" == "RP2040_PLATFORM" ]; then
+    cp .pio/build/$1/firmware.bin out/${FIRMWARE_FILENAME}.bin 2>/dev/null || true
+    cp .pio/build/$1/firmware.uf2 out/${FIRMWARE_FILENAME}.uf2 2>/dev/null || true
+  fi
 
 }
 

docs/cli_commands.md

@@ -644,7 +644,7 @@ This document provides an overview of CLI commands that can be sent to MeshCore
 **Usage:** 
 - `region`
 
-**Serial Only:** Yes
+**Serial Only:** For firmware older than 1.12.0
 
 ---