Merge pull request #547 from geeksville/udp

1.1.20

.github/workflows/main.yml

@@ -23,4 +23,4 @@ jobs:
         run: |
           pip install -U adafruit-nrfutil
       - name: Build
-        run: platformio run -e tbeam -e heltec -e lora-relay-v1
+        run: platformio run -e tbeam -e heltec -e lora-relay-v1 -e linux

.vscode/settings.json

@@ -48,13 +48,18 @@
         "optional": "cpp",
         "string_view": "cpp",
         "cassert": "cpp",
-        "iterator": "cpp"
+        "iterator": "cpp",
+        "shared_mutex": "cpp",
+        "iostream": "cpp"
     },
     "cSpell.words": [
         "Blox",
+        "EINK",
         "HFSR",
         "Meshtastic",
         "NEMAGPS",
+        "NMEAGPS",
+        "RDEF",
         "Ublox",
         "bkpt",
         "cfsr",

README.md

@@ -25,7 +25,7 @@ We currently support three models of radios.
 - TTGO T-Beam (usually the recommended choice)
   - [T-Beam V1.1 w/ NEO-6M - special Meshtastic version](https://www.aliexpress.com/item/4001178678568.html) (Includes built-in OLED display and they have **preinstalled** the meshtastic software)
   - [T-Beam V1.1 w/ NEO-M8N](https://www.aliexpress.com/item/33047631119.html) (slightly better GPS)
-  - [T-Beam V1.1 w/ NEO-M8N /w SX1262](https://de.aliexpress.com/item/4001287221970.html) (slightly better GPS + LoRa)
+  - [T-Beam V1.1 w/ NEO-M8N /w SX1262](https://www.aliexpress.com/item/4001287221970.html) (slightly better GPS + LoRa)
     - board labels "TTGO T22_V1.1 20191212"
   - [T-Beam V0.7 w/ NEO-6M](https://www.aliexpress.com/item/4000574335430.html) (will work but **you must use the tbeam0.7 firmware ** - but the T-Beam V1.0 or later are better!)
      - board labels "TTGO T22_V07 20180711"
@@ -103,10 +103,10 @@ Hard resetting via RTS pin...
 ```
 
 5. cd into the directory where the release zip file was expanded.
-6. Install the correct firmware for your board with `device-install.sh firmware-_board_-_country_.bin`.
-   - Example: `./device-install.sh firmware-HELTEC-US-0.0.3.bin`.
-7. To update run `device-update.sh firmware-_board_-_country_.bin`
-   - Example: `./device-update.sh firmware-HELTEC-US-0.0.3.bin`.
+6. Install the correct firmware for your board with `device-install.sh -f firmware-_board_-_country_.bin`.
+   - Example: `./device-install.sh -f firmware-HELTEC-US-0.0.3.bin`.
+7. To update run `device-update.sh -f firmware-_board_-_country_.bin`
+   - Example: `./device-update.sh -f firmware-HELTEC-US-0.0.3.bin`.
 
 Note: If you have previously installed meshtastic, you don't need to run this full script instead just run `esptool.py --baud 921600 write_flash 0x10000 firmware-_board_-_country_-_version_.bin`. This will be faster, also all of your current preferences will be preserved.
 

bin/build-all.sh

@@ -2,18 +2,17 @@
 
 set -e
 
-source bin/version.sh
+VERSION=`bin/buildinfo.py`
 
-COUNTRIES="US EU433 EU865 CN JP"
+COUNTRIES="US EU433 EU865 CN JP ANZ KR"
 #COUNTRIES=US
 #COUNTRIES=CN
 
 BOARDS_ESP32="tlora-v2 tlora-v1 tlora-v2-1-1.6 tbeam heltec tbeam0.7"
+#BOARDS_ESP32=tbeam
 
 # FIXME note nrf52840dk build is for some reason only generating a BIN file but not a HEX file nrf52840dk-geeksville is fine
 BOARDS_NRF52="lora-relay-v1"
-BOARDS="$BOARDS_ESP32 $BOARDS_NRF52"
-#BOARDS=tbeam
 
 OUTDIR=release/latest
 
@@ -22,22 +21,61 @@ ARCHIVEDIR=release/archive
 
 rm -f $OUTDIR/firmware*
 
-mkdir -p $OUTDIR/bins $OUTDIR/elfs
-rm -f $OUTDIR/bins/*
+mkdir -p $OUTDIR/bins
+rm -r $OUTDIR/bins/*
+mkdir -p $OUTDIR/bins/universal $OUTDIR/elfs/universal
 
 # build the named environment and copy the bins to the release directory
-function do_build {
-    echo "Building for $BOARD with $PLATFORMIO_BUILD_FLAGS"
+function do_build() {
+	BOARD=$1
+	COUNTRY=$2
+	isNrf=$3
+	
+    echo "Building $COUNTRY for $BOARD with $PLATFORMIO_BUILD_FLAGS"
     rm -f .pio/build/$BOARD/firmware.*
 
     # The shell vars the build tool expects to find
-    export HW_VERSION="1.0-$COUNTRY"
     export APP_VERSION=$VERSION
-    export COUNTRY
+
+    # Are we building a universal/regionless rom?
+    if [ "x$COUNTRY" != "x" ]
+    then
+        export HW_VERSION="1.0-$COUNTRY"
+        export COUNTRY
+        basename=firmware-$BOARD-$COUNTRY-$VERSION
+    else
+        export HW_VERSION="1.0"
+        unset COUNTRY
+        basename=universal/firmware-$BOARD-$VERSION
+    fi
 
     pio run --jobs 4 --environment $BOARD # -v
     SRCELF=.pio/build/$BOARD/firmware.elf
-    cp $SRCELF $OUTDIR/elfs/firmware-$BOARD-$COUNTRY-$VERSION.elf
+    cp $SRCELF $OUTDIR/elfs/$basename.elf
+
+    if [ "$isNrf" = "false" ]
+    then
+        echo "Copying ESP32 bin file"
+        SRCBIN=.pio/build/$BOARD/firmware.bin
+        cp $SRCBIN $OUTDIR/bins/$basename.bin
+    else
+        echo "Generating NRF52 uf2 file"
+        SRCHEX=.pio/build/$BOARD/firmware.hex
+        bin/uf2conv.py $SRCHEX -c -o $OUTDIR/bins/$basename.uf2 -f 0xADA52840
+    fi
+}
+
+function do_boards() {
+	declare boards=$1
+	declare isNrf=$2
+	for board in $boards; do
+		for country in $COUNTRIES; do 
+		    do_build $board $country "$isNrf"   
+		done
+
+		# Build universal
+		do_build $board "" "$isNrf" 
+	done
 }
 
 # Make sure our submodules are current
@@ -46,26 +84,20 @@ git submodule update
 # Important to pull latest version of libs into all device flavors, otherwise some devices might be stale
 platformio lib update 
 
-for COUNTRY in $COUNTRIES; do 
-    for BOARD in $BOARDS; do
-        do_build $BOARD
-    done
+do_boards "$BOARDS_ESP32" "false"
+do_boards "$BOARDS_NRF52" "true"
 
-    echo "Copying ESP32 bin files"
-    for BOARD in $BOARDS_ESP32; do
-        SRCBIN=.pio/build/$BOARD/firmware.bin
-        cp $SRCBIN $OUTDIR/bins/firmware-$BOARD-$COUNTRY-$VERSION.bin
-    done
-
-    echo "Generating NRF52 uf2 files"
-    for BOARD in $BOARDS_NRF52; do
-        SRCHEX=.pio/build/$BOARD/firmware.hex
-        bin/uf2conv.py $SRCHEX -c -o $OUTDIR/bins/firmware-$BOARD-$COUNTRY-$VERSION.uf2 -f 0xADA52840
-    done
-done
+echo "Building SPIFFS for ESP32 targets"
+pio run --environment tbeam -t buildfs
+cp .pio/build/tbeam/spiffs.bin $OUTDIR/bins/universal/spiffs-$VERSION.bin
 
 # keep the bins in archive also
-cp $OUTDIR/bins/firmware* $OUTDIR/elfs/firmware* $ARCHIVEDIR
+cp $OUTDIR/bins/firmware* $OUTDIR/bins/universal/spiffs* $OUTDIR/elfs/firmware* $OUTDIR/bins/universal/firmware* $OUTDIR/elfs/universal/firmware* $ARCHIVEDIR
+
+echo Updating android bins $OUTDIR/forandroid
+rm -rf $OUTDIR/forandroid
+mkdir -p $OUTDIR/forandroid
+cp -a $OUTDIR/bins/universal/*.bin $OUTDIR/forandroid/
 
 cat >$OUTDIR/curfirmwareversion.xml <<XML
 <?xml version="1.0" encoding="utf-8"?>
@@ -79,7 +111,8 @@ Generated by bin/buildall.sh -->
 </resources>
 XML
 
+echo Generating $ARCHIVEDIR/firmware-$VERSION.zip
 rm -f $ARCHIVEDIR/firmware-$VERSION.zip
-zip --junk-paths $ARCHIVEDIR/firmware-$VERSION.zip $OUTDIR/bins/firmware-*-$VERSION.* images/system-info.bin bin/device-install.sh bin/device-update.sh
+zip --junk-paths $ARCHIVEDIR/firmware-$VERSION.zip $ARCHIVEDIR/spiffs-$VERSION.bin $OUTDIR/bins/firmware-*-$VERSION.* images/system-info.bin bin/device-install.sh bin/device-update.sh
 
 echo BUILT ALL

bin/buildinfo.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+import configparser
+
+config = configparser.RawConfigParser()
+config.read('version.properties')
+
+version = dict(config.items('VERSION'))
+
+verStr = "{}.{}.{}".format(version["major"], version["minor"], version["build"])
+
+print(f"{verStr}")

bin/device-install.sh

@@ -1,5 +1,7 @@
 #!/bin/sh
 
+set -e
+
 # Usage info
 show_help() {
 cat << EOF
@@ -36,6 +38,7 @@ if [ -f "${FILENAME}" ]; then
 	echo "Trying to flash ${FILENAME}, but first erasing and writing system information"
 	esptool.py --baud 921600 erase_flash
 	esptool.py --baud 921600 write_flash 0x1000 system-info.bin
+    esptool.py --baud 921600 write_flash 0x00390000 spiffs-*.bin
 	esptool.py --baud 921600 write_flash 0x10000 ${FILENAME}
 else
 	echo "Invalid file: ${FILENAME}"

bin/install-bootloader.sh

@@ -0,0 +1,35 @@
+# You probably don't want to use this script, it programs a custom bootloader build onto a nrf52 board
+
+set -e 
+
+# dependencies
+# apt install srecord
+
+BOOTDIR=/home/kevinh/development/meshtastic/Adafruit_nRF52_Bootloader
+BOARD=othernet_ppr1
+BOOTVER=0.3.2
+BOOTNUM=128
+BOOTSHA=gc01b9ea
+SDCODE=s113
+SDVER=7.2.0
+PROJ=ppr1
+
+# FIXME for nRF52840 use 0xff000, for nRF52833 use 0x7f000
+BOOTSET=0x7f000
+
+nrfjprog --eraseall -f nrf52
+
+# this generates an intel hex file that can be programmed into a NRF52 to tell the adafruit bootloader that the current app image is valid
+# Bootloader settings are at BOOTLOADER_SETTINGS (rw) : ORIGIN = 0xFF000, LENGTH = 0x1000
+# first 4 bytes should be 0x01 to indicate valid app image
+# second 4 bytes should be 0x00 to indicate no CRC required for image
+echo "01 00 00 00 00 00 00 00" | xxd -r -p - >/tmp/bootconf.bin
+srec_cat /tmp/bootconf.bin -binary -offset $BOOTSET -output /tmp/bootconf.hex -intel   
+
+echo Generating merged hex file from .pio/build/$PROJ/firmware.hex
+mergehex -o ${BOARD}_full.hex -m $BOOTDIR/_build/build-$BOARD/${BOARD}_bootloader-$BOOTVER-$BOOTNUM-$BOOTSHA-dirty_${SDCODE}_$SDVER.hex .pio/build/$PROJ/firmware.hex /tmp/bootconf.hex
+
+echo Telling bootloader app region is valid and telling CPU to run
+nrfjprog --program ${BOARD}_full.hex -f nrf52 --reset
+
+# nrfjprog --readuicr /tmp/uicr.hex; objdump -s /tmp/uicr.hex | less

bin/install-eink.sh

@@ -0,0 +1,22 @@
+# You probably don't want to use this script, it programs a custom bootloader build onto a nrf52 board
+
+set -e 
+
+BOOTDIR=/home/kevinh/development/meshtastic/Adafruit_nRF52_Bootloader
+
+nrfjprog --eraseall -f nrf52
+
+# this generates an intel hex file that can be programmed into a NRF52 to tell the adafruit bootloader that the current app image is valid
+# Bootloader settings are at BOOTLOADER_SETTINGS (rw) : ORIGIN = 0xFF000, LENGTH = 0x1000
+# first 4 bytes should be 0x01 to indicate valid app image
+# second 4 bytes should be 0x00 to indicate no CRC required for image
+echo "01 00 00 00 00 00 00 00" | xxd -r -p - >/tmp/bootconf.bin
+srec_cat /tmp/bootconf.bin -binary -offset 0xff000 -output /tmp/bootconf.hex -intel   
+
+echo Generating merged hex file 
+mergehex -m $BOOTDIR/_build/build-ttgo_eink/ttgo_eink_bootloader-0.3.2-125-gf38f8f4-dirty_s140_6.1.1.hex .pio/build/eink/firmware.hex /tmp/bootconf.hex -o ttgo_eink_full.hex
+
+echo Telling bootloader app region is valid and telling CPU to run
+nrfjprog --program ttgo_eink_full.hex -f nrf52 --reset
+
+# nrfjprog --readuicr /tmp/uicr.hex; objdump -s /tmp/uicr.hex | less

bin/nrf52832-gdbserver.sh

@@ -1,3 +1,3 @@
 
 
-JLinkGDBServerCLExe -if SWD -select USB -port 2331 -device NRF52840_XXAA
+JLinkGDBServerCLExe -if SWD -select USB -port 2331 -device NRF52832_XXAA

bin/nrf52833-gdbserver.sh

@@ -0,0 +1,3 @@
+
+
+JLinkGDBServerCLExe -if SWD -select USB -port 2331 -device NRF52833_XXAA

bin/nrf52840-gdbserver.sh

@@ -1,3 +1,3 @@
 
 
-JLinkGDBServerCLExe -if SWD -select USB -port 2331 -device NRF52832_XXAA
+JLinkGDBServerCLExe -if SWD -select USB -port 2331 -device NRF52840_XXAA

bin/platformio-custom.py

@@ -0,0 +1,21 @@
+
+Import("projenv")
+
+import configparser
+prefsLoc = projenv["PROJECT_DIR"] + "/version.properties"
+print(f"Preferences in {prefsLoc}")
+try:
+	config = configparser.RawConfigParser()
+	config.read(prefsLoc)
+	version = dict(config.items('VERSION'))
+	verStr = "{}.{}.{}".format(version["major"], version["minor"], version["build"])
+except:
+	print("Can't read preferences, using 0.0.0")
+	verStr = "0.0.0"
+
+print(f"Using meshtastic platform-custom.py, firmare version {verStr}")
+
+# General options that are passed to the C and C++ compilers
+projenv.Append(CCFLAGS=[
+    f"-DAPP_VERSION={verStr}"
+    ])

bin/program-release-universal.sh

@@ -0,0 +1,6 @@
+
+set -e
+
+source bin/version.sh
+
+esptool.py --baud 921600 write_flash 0x10000 release/latest/bins/universal/firmware-tbeam-$VERSION.bin

bin/qspi-flash-test.sh

@@ -0,0 +1,6 @@
+# You probably don't need this - it is a basic test of the serial flash on the TTGO eink board
+
+nrfjprog -qspiini nrf52/ttgo_eink_qpsi.ini --qspieraseall
+nrfjprog --qspiini nrf52/ttgo_eink_qpsi.ini --memwr 0x12000000 --val 0xdeadbeef --verify
+nrfjprog --qspiini nrf52/ttgo_eink_qpsi.ini --readqspi spi.hex
+objdump -s spi.hex | less

bin/regen-protos.sh

@@ -1,6 +1,12 @@
 #!/bin/bash
 
+set -e
+
 echo "This script requires https://jpa.kapsi.fi/nanopb/download/ version 0.4.1"
 # the nanopb tool seems to require that the .options file be in the current directory!
 cd proto
-../../nanopb-0.4.1-linux-x86/generator-bin/protoc --nanopb_out=-v:../src/mesh -I=../proto mesh.proto
+../../nanopb-0.4.1-linux-x86/generator-bin/protoc --nanopb_out=-v:../src/mesh -I=../proto *.proto
+
+echo "Regenerating protobuf documentation - if you see an error message"
+echo "you can ignore it unless doing a new protobuf release to github."
+bin/regen-docs.sh

bin/upload-to-bootloader.sh

@@ -1,4 +1,4 @@
 
 echo "Converting to uf2 for NRF52 Adafruit bootloader"
-bin/uf2conv.py .pio/build/lora-relay-v1/firmware.hex -f 0xADA52840
+bin/uf2conv.py .pio/build/lora-relay-v2/firmware.hex -f 0xADA52840
 # cp flash.uf2 /media/kevinh/FTH*BOOT/

bin/version.sh

@@ -1,3 +0,0 @@
-
-
-export VERSION=1.0.0

bin/view-map.sh

@@ -0,0 +1,2 @@
+echo using amap tool to display memory map
+amap .pio/build/output.map

boards/eink.json

@@ -0,0 +1,61 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52840_s140_v6.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DARDUINO_NRF52840_TTGO_EINK -DNRF52840_XXAA",
+    "f_cpu": "64000000L",
+    "hwids": [
+      [
+        "0x239A",
+        "0x4405"
+      ]
+    ],
+    "usb_product": "TTGO_eink",
+    "mcu": "nrf52840",
+    "variant": "eink",
+    "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"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "TTGO eink (Adafruit BSP)",
+  "upload": {
+    "maximum_ram_size": 248832,
+    "maximum_size": 815104,
+    "require_upload_port": true,
+    "speed": 115200,
+    "protocol": "jlink",
+    "protocols": [
+      "jlink",
+      "nrfjprog",
+      "stlink"
+    ]
+  },
+  "url": "FIXME",
+  "vendor": "TTGO"
+}

boards/lora-relay-v2.json

@@ -0,0 +1,46 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52840_s140_v6.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DARDUINO_NRF52840_LORA_RELAY_V2 -DNRF52840_XXAA",
+    "f_cpu": "64000000L",
+    "hwids": [["0x239A", "0x4406"]],
+    "usb_product": "LORA_RELAY",
+    "mcu": "nrf52840",
+    "variant": "lora_relay_v2",
+    "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"
+  },
+  "frameworks": ["arduino"],
+  "name": "Meshtastic Lora Relay V1 (Adafruit BSP)",
+  "upload": {
+    "maximum_ram_size": 248832,
+    "maximum_size": 815104,
+    "require_upload_port": true,
+    "speed": 115200,
+    "protocol": "jlink",
+    "protocols": ["jlink", "nrfjprog", "stlink"]
+  },
+  "url": "https://github.com/BigCorvus/SX1262-LoRa-BLE-Relay",
+  "vendor": "BigCorvus"
+}

boards/nrf52840_dk_modified.json

@@ -1,7 +1,7 @@
 {
   "build": {
     "arduino": {
-      "ldscript": "nrf52840_s140_v6.ld"
+      "ldscript": "nrf52840_s113_v7.ld"
     },
     "core": "nRF5",
     "cpu": "cortex-m4",
@@ -16,9 +16,9 @@
       "name": "adafruit"
     },
     "softdevice": {
-      "sd_flags": "-DS140",
-      "sd_name": "s140",
-      "sd_version": "6.1.1",
+      "sd_flags": "-DS113",
+      "sd_name": "s113",
+      "sd_version": "7.2.0",
       "sd_fwid": "0x00B6"
     },
     "bootloader": {

boards/ppr1.json

@@ -0,0 +1,46 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52833_s113_v7.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DARDUINO_NRF52833_PPR -DNRF52833_XXAA",
+    "f_cpu": "64000000L",
+    "hwids": [["0x239A", "0x4406"]],
+    "usb_product": "PPR",
+    "mcu": "nrf52833",
+    "variant": "ppr",
+    "variants_dir": "variants",
+    "bsp": {
+      "name": "adafruit"
+    },
+    "softdevice": {
+      "sd_flags": "-DS113",
+      "sd_name": "s113",
+      "sd_version": "7.2.0",
+      "sd_fwid": "0x00b6"
+    },
+    "bootloader": {
+      "settings_addr": "0xFF000"
+    }
+  },
+  "connectivity": ["bluetooth"],
+  "debug": {
+    "jlink_device": "nRF52833_xxAA",
+    "onboard_tools": ["jlink"],
+    "svd_path": "nrf52833.svd"
+  },
+  "frameworks": ["arduino"],
+  "name": "Meshtastic PPR1 (Adafruit BSP)",
+  "upload": {
+    "maximum_ram_size": 248832,
+    "maximum_size": 815104,
+    "require_upload_port": true,
+    "speed": 115200,
+    "protocol": "jlink",
+    "protocols": ["jlink", "nrfjprog", "stlink"]
+  },
+  "url": "https://meshtastic.org/",
+  "vendor": "Othernet"
+}

data/static/basic.js

@@ -0,0 +1,43 @@
+var meshtasticClient;
+var connectionOne;
+
+
+// Important: the connect action must be called from a user interaction (e.g. button press), otherwise the browsers won't allow the connect
+function connect() {
+
+    // Create new connection
+    var httpconn = new meshtasticjs.IHTTPConnection();
+
+    // Set connection params
+    let sslActive;
+    if (window.location.protocol === 'https:') {
+        sslActive = true;
+    } else {
+        sslActive = false;
+    }
+    let deviceIp = window.location.hostname; // Your devices IP here
+
+
+    // Add event listeners that get called when a new packet is received / state of device changes
+    httpconn.addEventListener('fromRadio', function (packet) { console.log(packet) });
+
+    // Connect to the device async, then send a text message
+    httpconn.connect(deviceIp, sslActive)
+        .then(result => {
+
+            alert('device has been configured')
+            // This gets called when the connection has been established
+            // -> send a message over the mesh network. If no recipient node is provided, it gets sent as a broadcast
+            return httpconn.sendText('meshtastic is awesome');
+
+        })
+        .then(result => {
+
+            // This gets called when the message has been sucessfully sent
+            console.log('Message sent!');
+        })
+
+        .catch(error => { console.log(error); });
+
+}
+

data/static/index.html

@@ -0,0 +1,18 @@
+<!doctype html>
+<html class="no-js" lang="">
+
+<head>
+  <meta charset="utf-8">
+  <title></title>
+
+  <script src="/static/meshtastic.js"></script>
+  <script src="/static/basic.js"></script>
+</head>
+
+<body>
+
+  <button id="connect_button" onclick="connect()">Connect to Meshtastic device</button>
+ 
+</body>
+
+</html>

docs/README.md

@@ -39,11 +39,16 @@ This software is 100% open source and developed by a group of hobbyist experimen
 
 For an detailed walk-through aimed at beginners, we recommend [meshtastic.letstalkthis.com](https://meshtastic.letstalkthis.com/).
 
+### Related Groups
+
+Telegram group for **Italy**-based users [t.me/meshtastic_italia](http://t.me/meshtastic_italia) (Italian language, unofficial).
+
 # Updates
 
 Note: Updates are happening almost daily, only major updates are listed below. For more details see our forum.
 
-- 06/24/2020 - 0.7.x Now with over 1000 android users, over 600 people using the radios and translated into 13 languages. Fairly stable and we are working through bugs to get to 1.0.
+- 09/14/2020 - 1.0.0 Now with over 1700 android users, over 2000 nodes and translated into 15 languages. This project will always be a "beta" experiment, but now quite usable. We are currently selecting 1.1 features in our discussion forum.
+- 06/24/2020 - 0.7.x Now with over 1000 android users, over 600 people using the radios and translated into 22 languages. Fairly stable and we are working through bugs to get to 1.0.
 - 06/04/2020 - 0.6.7 Beta releases of both the application and the device code are released. Features are fairly solid now with a sizable number of users.
 - 04/28/2020 - 0.6.0 [Python API](https://pypi.org/project/meshtastic/) released. Makes it easy to use meshtastic devices as "zero config / just works" mesh transport adapters for other projects.
 - 04/20/2020 - 0.4.3 Pretty solid now both for the android app and the device code. Many people have donated translations and code. Probably going to call it a beta soon.
@@ -77,13 +82,14 @@ Make sure to buy the frequency range which is legal for your country. For the US
 Instructions for installing prebuilt firmware can be found [here](https://github.com/meshtastic/Meshtastic-esp32/blob/master/README.md).
 
 For a nice looking cases:
-  - 3D printable cases
-    1. TTGO T-Beam V0 see this [design](https://www.thingiverse.com/thing:3773717) by [bsiege](https://www.thingiverse.com/bsiege).
-    2. TTGO T_Beam V1 (SMA) see this [design](https://www.thingiverse.com/thing:3830711) by [rwanrooy](https://www.thingiverse.com/rwanrooy) or this [remix](https://www.thingiverse.com/thing:3949330) by [8ung](https://www.thingiverse.com/8ung)
-    3. TTGO T_Beam V1 (IPEX) see this [design](https://www.thingiverse.com/thing:4587297) by [drewsed](https://www.thingiverse.com/drewsed)
-    4. Heltec Lora32 see this [design](https://www.thingiverse.com/thing:3125854) by [ornotermes](https://www.thingiverse.com/ornotermes).
-  - Laser-cut cases
-    1. TTGO T_Beam V1 (SMA) see this [design](https://www.thingiverse.com/thing:4552771) by [jefish](https://www.thingiverse.com/jefish) 
+
+- 3D printable cases
+  1. TTGO T-Beam V0 see this [design](https://www.thingiverse.com/thing:3773717) by [bsiege](https://www.thingiverse.com/bsiege).
+  2. TTGO T_Beam V1 (SMA) see this [design](https://www.thingiverse.com/thing:3830711) by [rwanrooy](https://www.thingiverse.com/rwanrooy) or this [remix](https://www.thingiverse.com/thing:3949330) by [8ung](https://www.thingiverse.com/8ung)
+  3. TTGO T_Beam V1 (IPEX) see this [design](https://www.thingiverse.com/thing:4587297) by [drewsed](https://www.thingiverse.com/drewsed)
+  4. Heltec Lora32 see this [design](https://www.thingiverse.com/thing:3125854) by [ornotermes](https://www.thingiverse.com/ornotermes).
+- Laser-cut cases
+  1. TTGO T_Beam V1 (SMA) see this [design](https://www.thingiverse.com/thing:4552771) by [jefish](https://www.thingiverse.com/jefish)
 
 # IMPORTANT DISCLAIMERS AND FAQ
 

docs/_config.yml

@@ -1,7 +1,7 @@
 theme: jekyll-theme-cayman
 
 title: Meshtastic
-description: An opensource hiking, pilot, skiing, Signal-App-extending GPS mesh communicator
+description: An opensource hiking, pilot, skiing, secure GPS mesh communicator
 google_analytics: G-DRZ5H5EXHV
 
 include: [".well-known"]

docs/radio-settings.md

@@ -8,7 +8,7 @@ See [this site](https://www.rfwireless-world.com/Tutorials/LoRa-channels-list.ht
 
 ## LoRaWAN Europe Frequency Band
 
-The maximum power allowed is +14dBM.
+The maximum power allowed is +14dBm ERP (Effective Radiated Power, see [this site](https://en.wikipedia.org/wiki/Effective_radiated_power) for more information).
 
 ### 433 MHz
 
@@ -24,7 +24,7 @@ Channel zero starts at 865.20 MHz
 
 LoRaWAN defines 64, 125 kHz channels from 902.3 to 914.9 MHz increments.
 
-The maximum output power for North America is +30 dBM.
+The maximum output power for North America is +30 dBm ERP.
 
 The band is from 902 to 928 MHz. It mentions channel number and its respective channel frequency. All the 13 channels are separated by 2.16 MHz with respect to the adjacent channels.  
-Channel zero starts at 903.08 MHz center frequency.
+Channel zero starts at 903.08 MHz center frequency.

docs/software/TODO.md

@@ -2,21 +2,90 @@
 
 You probably don't care about this section - skip to the next one.
 
-Nimble tasks:
+For app cleanup:
 
-- readerror.txt stress test bug
-- started RPA long test, jul 22 6pm
-- implement nimble software update api
-- update to latest bins, test OTA again (measure times) and then checkin bins
-- do alpha release
+* DONE make device build always have a valid version
+* DONE do fixed position bug https://github.com/meshtastic/Meshtastic-device/issues/536
+* check build guide
+* generate autodocs
+* write devapi user guide
+* DONE update android code: https://developer.android.com/topic/libraries/view-binding/migration
+* only do wantReplies once per packet type, if we change network settings force it again
+* make gpio watch work, use thread and setup
+* make hello world example service
+* make python ping command
+* make python gpio read a bit cleaner
+* DONE have python tool check max packet size before sending to device
+* DONE if request was sent reliably, send reply reliably
+* DONE require a recent python api to talk to these new device loads
+* DONE require a recent android app to talk to these new device loads
+* DONE fix handleIncomingPosition
+* DONE move want_replies handling into plugins
+* DONE on android for received positions handle either old or new positions / user messages
+* on android side send old or new positions as needed / user messages
+* test python side handle new position/user messages
+* DONE make a gpio example. --gpiowrb 4 1, --gpiord 0x444, --gpiowatch 0x3ff
+* DONE fix position sending to use new plugin
+* DONE Add SinglePortNumPlugin - as the new most useful baseclass
+* DONE move positions into regular data packets (use new app framework)
+* DONE move user info into regular data packets (use new app framework)
+* DONE test that positions, text messages and user info still work
+* DONE test that position, text messages and user info work properly with new android app and old device code
+* fix the RTC drift bug
+* move python ping functionality into device, reply with rxsnr info
+* use channels for gpio security https://github.com/meshtastic/Meshtastic-device/issues/104
+
+For high speed/lots of devices/short range tasks:
+
+- When guessing numhops for sending: if I've heard from many local (0 hop neighbors) decrease hopcount by 2 rather than 1. 
+This should nicely help 'router' nodes do the right thing when long range, or if there are many local nodes for short range.
+- fix timeouts/delays to be based on packet length at current radio settings
 
-* update protocol description per cyclomies email thread
 * update faq with antennas https://meshtastic.discourse.group/t/range-test-ideas-requested/738/2
 * update faq on recommended android version and phones
 * add help link inside the app, reference a page on the wiki
 * turn on amazon reviews support
 * add a tablet layout (with map next to messages) in the android app
 
+# Old docs to merge
+
+MESH RADIO PROTOCOL
+
+Old TODO notes on the mesh radio protocol, merge into real docs someday...
+
+for each named group we have a pre-shared key known by all group members and
+wrapped around the device. you can only be in one group at a time (FIXME?!) To
+join the group we read a qr code with the preshared key and ParamsCodeEnum. that
+gets sent via bluetooth to the device.  ParamsCodeEnum maps to a set of various
+radio params (regulatory region, center freq, SF, bandwidth, bitrate, power
+etc...) so all members of the mesh can have their radios set the same way.
+
+once in that group, we can talk between 254 node numbers.
+to get our node number (and announce our presence in the channel) we pick a
+random node number and broadcast as that node with WANT-NODENUM(my globally
+unique name).  If anyone on the channel has seen someone _else_ using that name
+within the last 24 hrs(?) they reply with DENY-NODENUM. Note: we might receive
+multiple denies.  Note: this allows others to speak up for some other node that
+might be saving battery right now. Any time we hear from another node (for any
+message type), we add that node number to the unpickable list.  To dramatically
+decrease the odds a node number we request is already used by someone. If no one
+denies within TBD seconds, we assume that we have that node number.  As long as
+we keep talking to folks at least once every 24 hrs, others should remember we
+have it.
+
+Once we have a node number we can broadcast POSITION-UPDATE(my globally unique
+name, lat, lon, alt, amt battery remaining).  All receivers will use this to a)
+update the mapping of who is at what node nums, b) the time of last rx, c)
+position.  If we haven't heard from that node in a while we reply to that node
+(only) with our current POSITION_UPDATE state - so that node (presumably just
+rejoined the network) can build a map of all participants.
+
+We will periodically broadcast POSITION-UPDATE as needed based on distance moved
+or a periodic minimum heartbeat.
+
+If user wants to send a text they can SEND_TEXT(dest user, short text message).
+Dest user is a node number, or 0xff for broadcast.
+
 # Medium priority
 
 Items to complete before 1.0.

docs/software/device-api.md

@@ -42,7 +42,6 @@ Expected sequence for initial download:
 - Read a RadioConfig from "radio" - used to get the channel and radio settings
 - Read a User from "user" - to get the username for this node
 - Read a MyNodeInfo from "mynode" to get information about this local device
-- Write an empty record to "nodeinfo" to restart the nodeinfo reading state machine
 - Read a series of NodeInfo packets to build the phone's copy of the current NodeDB for the mesh
 - Read a endConfig packet that indicates that the entire state you need has been sent.
 - Read a series of MeshPackets until it returns empty to get any messages that arrived for this node while the phone was away
@@ -112,6 +111,7 @@ Characteristics
 | e272ebac-d463-4b98-bc84-5cc1a39ee517 | write       | data, variable sized, recommended 512 bytes, write one for each block of file                                     |
 | 4826129c-c22a-43a3-b066-ce8f0d5bacc6 | write       | crc32, write last - writing this will complete the OTA operation, now you can read result                         |
 | 5e134862-7411-4424-ac4a-210937432c77 | read,notify | result code, readable but will notify when the OTA operation completes                                            |
+| 5e134862-7411-4424-ac4a-210937432c67 | write | sets the region for programming, currently only 0 (app) or 100 (spiffs) are defined, if not set app is assumed |
 | GATT_UUID_SW_VERSION_STR/0x2a28      | read        | We also implement these standard GATT entries because SW update probably needs them:                              |
 | GATT_UUID_MANU_NAME/0x2a29           | read        |                                                                                                                   |
 | GATT_UUID_HW_VERSION_STR/0x2a27      | read        |                                                                                                                   |

docs/software/gps-todo.txt

@@ -0,0 +1,17 @@
+You probably don't care about this ugly file of personal notes ;-)
+
+for taiwan region:
+bin/run.sh --set region 8
+
+time only mode
+./bin/run.sh --set gps_operation 3
+
+ublox parsing failure
+
+record power measurements and update spreadsheet
+
+have loop methods return allowable sleep time (from their perspective)
+increase main cpu sleep time
+
+warn people about crummy gps antennas - add to faq
+

docs/software/nrf52-TODO.md

@@ -5,7 +5,27 @@
 
 ## RAK815
 
-TODO:
+### PPR1 TODO
+
+* V_BK for the GPS should probably be supplied from something always on
+
+* use S113 soft device 7.2.0
+* properly test charge controller config and read battery/charge status
+* fix bluetooth
+* fix LCD max contrast (currently too high, needs to be about 40?)
+* save brightness settings in flash
+* make ST7567Wire driver less ugly, move OLED stuff into a common class treee
+* add LCD power save mode for lcd per page 31 of datasheet
+* add LCD power off sequence per datasheet to lcd driver
+* leave LCD screen on most of the time (because it needs little power)
+
+### general nrf52 TODO:
+
+- turn off transitions on eink screens
+- change update interval on eink from 1/sec frames to one frame every 5 mins
+- enter SDS state at correct time (to protect battery or loss of phone contact)
+- show screen on eink when we enter SDS state (with app info and say sleeping)
+- require button press to pair
 
 - shrink soft device RAM usage
 - get nrf52832 working again (currently OOM)
@@ -196,7 +216,7 @@ Nice ideas worth considering someday...
 - DONE neg 7 error code from receive
 - DONE remove unused sx1262 lib from github
 - at boot we are starting our message IDs at 1, rather we should start them at a random number. also, seed random based on timer. this could be the cause of our first message not seen bug.
-- add a NEMA based GPS driver to test GPS
+- add a NMEA based GPS driver to test GPS
 - DONE use "variants" to get all gpio bindings
 - DONE plug in correct variants for the real board
 - turn on DFU assistance in the appload using the nordic DFU helper lib call

docs/software/pinetab.md

@@ -2,18 +2,25 @@
 
 These are **preliminary** notes on support for Meshtastic in the Pinetab.
 
-A RF95 is connected via a CS341 USB-SPI chip.
+A RF95 is connected via a CH341 USB-SPI chip.
 
 Pin assignments:
-CS0 from RF95 goes to CS0 on CS341
-DIO0 from RF95 goes to INT on CS341
-RST from RF95 goes to RST on CS341
+CS0 from RF95 goes to CS0 on CH341
+DIO0 from RF95 goes to INT on CH341
+RST from RF95 goes to RST on CH341
 
 This linux driver claims to provide USB-SPI support: https://github.com/gschorcht/spi-ch341-usb
 Notes here on using that driver: https://www.linuxquestions.org/questions/linux-hardware-18/ch341-usb-to-spi-adaptor-driver-doesn%27t-work-4175622736/
 
 Or if **absolutely** necessary could bitbang: https://www.cnx-software.com/2018/02/16/wch-ch341-usb-to-serial-chip-gets-linux-driver-to-control-gpios-over-usb/
 
+## Portduino tasks
+
+* How to access spi devices via ioctl (spidev): https://www.raspberrypi.org/documentation/hardware/raspberrypi/spi/README.md#:~:text=Troubleshooting-,Overview,bus)%2C%20UARTs%2C%20etc.
+* access gpio via libgpiod?
+* Use dkms to distribute driver? 
+* echo 100 > /sys/module/spi_ch341_usb/parameters/poll_period
+
 ## Task list
 
 * Port meshtastic to build (under platformio) for a poxix target.  spec: no screen, no gpios, sim network interface, posix threads, posix semaphores & queues, IO to the console only

docs/software/power.md

@@ -32,21 +32,25 @@ From lower to higher power consumption.
   onEntry: setBluetoothOn(true)
   onExit:
 
-- full on (ON) - Everything is on
-  onEntry: setBluetoothOn(true), screen.setOn(true)
-  onExit: screen.setOn(false)
-
 - serial API usage (SERIAL) - Screen is on, device doesn't sleep, bluetooth off
   onEntry: setBluetooth off, screen on
   onExit:
 
+- full on (ON) - Everything is on, can eventually timeout and lower to a lower power state
+  onEntry: setBluetoothOn(true), screen.setOn(true)
+  onExit: screen->setOn(false)
+
+- has power (POWER) - Screen is on, device doesn't sleep, bluetooth on, will stay in this state as long as we have power
+  onEntry: setBluetooth off, screen on
+  onExit:
+
 ## Behavior
 
 ### events that increase CPU activity
 
 - At cold boot: The initial state (after setup() has run) is DARK
 - While in DARK: if we receive EVENT_BOOT, transition to ON (and show the bootscreen). This event will be sent if we detect we woke due to reset (as opposed to deep sleep)
-- While in LS: Once every position_broadcast_secs (default 15 mins) - the unit will wake into DARK mode and broadcast a "networkPing" (our position) and stay alive for wait_bluetooth_secs (default 30 seconds). This allows other nodes to have a record of our last known position if we go away and allows a paired phone to hear from us and download messages.
+- While in LS: Once every position_broadcast_secs (default 15 mins) - the unit will wake into DARK mode and broadcast a "networkPing" (our position) and stay alive for wait_bluetooth_secs (default 60 seconds). This allows other nodes to have a record of our last known position if we go away and allows a paired phone to hear from us and download messages.
 - While in LS: Every send*owner_interval (defaults to 4, i.e. one hour), when we wake to send our position we \_also* broadcast our owner. This lets new nodes on the network find out about us or correct duplicate node number assignments.
 - While in LS/NB/DARK: If the user presses a button (EVENT_PRESS) we go to full ON mode for screen_on_secs (default 30 seconds). Multiple presses keeps resetting this timeout
 - While in LS/NB/DARK: If we receive new text messages (EVENT_RECEIVED_TEXT_MSG), we go to full ON mode for screen_on_secs (same as if user pressed a button)
@@ -56,9 +60,11 @@ From lower to higher power consumption.
 - While in NB/DARK/ON: If we receive EVENT_NODEDB_UPDATED we transition to ON (so the new screen can be shown)
 - While in DARK: While the phone talks to us over BLE (EVENT_CONTACT_FROM_PHONE) reset any sleep timers and stay in DARK (needed for bluetooth sw update and nice user experience if the user is reading/replying to texts)
 - while in LS/NB/DARK: if SERIAL_CONNECTED, go to serial
+- while in any state: if we have AC power, go to POWER
 
 ### events that decrease cpu activity
 
+- While in POWER: if lose AC go to ON
 - While in SERIAL: if SERIAL_DISCONNECTED, go to NB
 - While in ON: If PRESS event occurs, reset screen_on_secs timer and tell the screen to handle the pess
 - While in ON: If it has been more than screen_on_secs since a press, lower to DARK

docs/software/sw-design.md

@@ -5,5 +5,5 @@ This is a mini design doc for developing the meshtastic software.
 * Our [project board](https://github.com/orgs/meshtastic/projects/1) - shows what things we are currently working on and remaining work items for the current release.
 * [Power Management](power.md)
 * [Mesh algorithm](mesh-alg.md)
-* [Bluetooth API](bluetooth-api.md) and porting guide for new clients (iOS, python, etc...)
+* [Device API](device-api.md) and porting guide for new clients (iOS, python, etc...)
 * TODO: how to port the device code to a new device.

nrf52/ttgo_eink_qpsi.ini

@@ -0,0 +1,69 @@
+; nrfjprog.exe configuration file.
+
+; Note: QSPI flash is mapped into memory at address 0x12000000
+
+[DEFAULT_CONFIGURATION]
+; Define the capacity of the flash memory device in bytes. Set to 0 if no external memory device is present in your board.
+; MX25R1635F is 16Mbit/2Mbyte
+MemSize = 0x200000
+
+; Define the desired ReadMode. Valid options are FASTREAD, READ2O, READ2IO, READ4O and READ4IO
+ReadMode = READ2IO
+
+; Define the desired WriteMode. Valid options are PP, PP2O, PP4O and PP4IO
+WriteMode = PP
+
+; Define the desired AddressMode. Valid options are BIT24 and BIT32
+AddressMode = BIT24
+
+; Define the desired Frequency. Valid options are M2, M4, M8, M16 and M32
+Frequency = M16
+
+; Define the desired SPI mode. Valid options are MODE0 and MODE3
+SpiMode = MODE0
+
+; Define the desired SckDelay. Valid options are in the range 0 to 255
+SckDelay = 0x80
+
+; Define the desired IO level for DIO2 and DIO3 during a custom instruction. Valid options are LEVEL_HIGH and LEVEL_LOW
+CustomInstructionIO2Level = LEVEL_LOW
+CustomInstructionIO3Level = LEVEL_HIGH
+
+; Define the assigned pins for the QSPI peripheral. Valid options are those existing in your device
+CSNPin = 15
+CSNPort = 1
+SCKPin = 14
+SCKPort = 1
+DIO0Pin = 12
+DIO0Port = 1
+DIO1Pin = 13
+DIO1Port = 1
+
+;These two pins are not connected, but we must name something
+DIO2Pin = 3
+DIO2Port = 1
+DIO3Pin = 5
+DIO3Port = 1
+
+; Define the Index of the Write In Progress (WIP) bit in the status register. Valid options are in the range of 0 to 7.
+WIPIndex = 0
+
+; Define page size for commands. Valid sizes are PAGE256 and PAGE512.
+PPSize = PAGE256
+
+; Custom instructions to send to the external memory after initialization. Format is instruction code plus data to send in between optional brakets. 
+; These instructions will be executed each time the qspi peripheral is initiated by nrfjprog. 
+; To improve execution speed on consecutive interations with QSPI, you can run nrfjprog once with custom initialization, and then comment out the lines below.
+; Numbers can be given in decimal, hex (starting with either 0x or 0X) and binary (starting with either 0b or 0B) formats. 
+; The custom instructions will be executed in the order found. 
+
+; This example includes two commands, first a WREN (WRite ENable) and then a WRSR (WRite Satus Register) enabling the Quad Operation and the High Performance
+; mode for the MX25R6435F memory present in the nRF52840 DK.
+;InitializationCustomInstruction =  0x06
+;InitializationCustomInstruction =  0x01, [0x40, 0, 0x2]
+
+; For MX25R1635F on TTGO board, only two data lines are connected
+; This example includes two commands, first a WREN (WRite ENable) and then a WRSR (WRite Satus Register) disabling Quad Operation and the High Performance
+; mode.  For normal operation you might want low power mode instead.
+InitializationCustomInstruction =  0x06
+InitializationCustomInstruction =  0x01, [0x00, 0, 0x2]

platformio.ini

@@ -9,7 +9,8 @@
 ; https://docs.platformio.org/page/projectconf.html
 
 [platformio]
-default_envs = tbeam # or if you'd like to change the default to something like lora-relay-v1 put that here
+default_envs = tbeam # 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 = heltec # lora-relay-v1 # nrf52840dk-geeksville # linux # or if you'd like to change the default to something like lora-relay-v1 put that here
 
 [common]
 ; common is not currently used
@@ -18,28 +19,28 @@ default_envs = tbeam # or if you'd like to change the default to something like
 ; The following environment variables must be set in the shell if you'd like to override them.
 ; They are used in this ini file as systenv.VARNAME, so in your shell do export "VARNAME=fish"
 ; COUNTRY (default US), i.e. "export COUNTRY=EU865"
-; APP_VERSION (default emptystring)
 ; HW_VERSION (default emptystring)
 
 [env]
 
-framework = arduino
-
-; customize the partition table
-; http://docs.platformio.org/en/latest/platforms/espressif32.html#partition-tables
-board_build.partitions = partition-table.csv
+; note: APP_VERSION now comes from bin/version.json
+extra_scripts = bin/platformio-custom.py 
 
 ; note: we add src to our include search path so that lmic_project_config can override
 ; FIXME: fix lib/BluetoothOTA dependency back on src/ so we can remove -Isrc
-build_flags = -Wno-missing-field-initializers -Isrc -Isrc/mesh -Isrc/gps -Ilib/nanopb/include -Os -Wl,-Map,.pio/build/output.map 
+build_flags = -Wno-missing-field-initializers -Isrc -Isrc/mesh -Isrc/gps -Ilib/nanopb/include -Wl,-Map,.pio/build/output.map 
   -DHW_VERSION_${sysenv.COUNTRY}
-  -DAPP_VERSION=${sysenv.APP_VERSION}
   -DHW_VERSION=${sysenv.HW_VERSION}
+  -DUSE_THREAD_NAMES
+  -DTINYGPSPLUS_OPTION_NO_CUSTOM_FIELDS
 
 ; leave this commented out to avoid breaking Windows
 ;upload_port = /dev/ttyUSB0
 ;monitor_port = /dev/ttyUSB0
 
+;upload_port = /dev/cu.SLAB_USBtoUART
+;monitor_port = /dev/cu.SLAB_USBtoUART
+
 ; the default is esptool
 ; upload_protocol = esp-prog
 
@@ -60,33 +61,54 @@ debug_tool = jlink
 
 lib_deps =
   https://github.com/meshtastic/esp8266-oled-ssd1306.git ; ESP8266_SSD1306 
-  SPI
-  1260 ; OneButton library for non-blocking button debounce
+  https://github.com/geeksville/OneButton.git ; OneButton library for non-blocking button debounce
   1202 ; CRC32, explicitly needed because dependency is missing in the ble ota update lib
-  Wire ; explicitly needed here because the AXP202 library forgets to add it
-  https://github.com/meshtastic/arduino-fsm.git 
-  https://github.com/meshtastic/SparkFun_Ublox_Arduino_Library.git
-  https://github.com/meshtastic/RadioLib.git#7989a269be590a5d4914ac04069b58f4930c45c1
-  https://github.com/meshtastic/TinyGPSPlus.git 
+  https://github.com/meshtastic/arduino-fsm.git#2f106146071fc7bc620e1e8d4b88dc4e0266ce39
+  https://github.com/meshtastic/SparkFun_Ublox_Arduino_Library.git#31015a55e630a2df77d9d714669c621a5bf355ad
+  https://github.com/meshtastic/RadioLib.git#8657380241bce681c33aab46598bbf13b11f876c
+  https://github.com/meshtastic/TinyGPSPlus.git#9c1d584d2469523381e077b0b9c1bf868d6c0206
   https://github.com/meshtastic/AXP202X_Library.git#8404abb6d4b486748636bc6ad72d2a47baaf5460
+  Wire ; explicitly needed here because the AXP202 library forgets to add it
+  SPI
+  https://github.com/geeksville/ArduinoThread.git#333ffd09b596977c217ba25da4258f588b462ac6
+  
+; Common settings for conventional (non Portduino) Ardino targets
+[arduino_base]
+
+framework = arduino
+
+lib_deps =
+  ${env.lib_deps}
+
+build_flags = ${env.build_flags} -Os
+
+src_filter = ${env.src_filter} -<portduino/>
 
 ; Common settings for ESP targes, mixin with extends = esp32_base
 [esp32_base]
+extends = arduino_base
 platform = espressif32
 src_filter = 
-  ${env.src_filter} -<nrf52/>
+  ${arduino_base.src_filter} -<nrf52/>
 upload_speed = 921600
 debug_init_break = tbreak setup
 build_flags =
-  ${env.build_flags} -Wall -Wextra -Isrc/esp32 -mfix-esp32-psram-cache-issue -lnimble -std=c++11 
+  ${arduino_base.build_flags} -Wall -Wextra -Isrc/esp32 -Isrc/esp32-mfix-esp32-psram-cache-issue -lnimble -std=c++11 
   -DLOG_LOCAL_LEVEL=ESP_LOG_DEBUG -DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG
   -DAXP_DEBUG_PORT=Serial
+lib_deps =
+  ${arduino_base.lib_deps}
+  https://github.com/meshtastic/esp32_https_server.git
 # Hmm - this doesn't work yet
 # board_build.ldscript = linker/esp32.extram.bss.ld
 lib_ignore = segger_rtt
 platform_packages =
     framework-arduinoespressif32@https://github.com/meshtastic/arduino-esp32.git#2814f110aa618429bdd9a0a2d6a93c55f29f87a6
 
+; customize the partition table
+; http://docs.platformio.org/en/latest/platforms/espressif32.html#partition-tables
+board_build.partitions = partition-table.csv
+
 ; not needed included in ttgo-t-beam board file
 ; also to use PSRAM https://docs.platformio.org/en/latest/platforms/espressif32.html#external-ram-psram
 ;  -DBOARD_HAS_PSRAM
@@ -99,7 +121,7 @@ platform_packages =
 extends = esp32_base
 board = ttgo-t-beam
 lib_deps =
-  ${env.lib_deps}
+  ${esp32_base.lib_deps}
 build_flags = 
   ${esp32_base.build_flags} -D TBEAM_V10
 
@@ -142,25 +164,26 @@ build_flags =
 platform = https://github.com/HelTecAutomation/platform-asrmicro650x.git ; we use top-of-tree because stable version has too many bugs - asrmicro650x
 board = cubecell_board_plus
 ; FIXME, bug in cubecell arduino - they are supposed to set ARDUINO
-build_flags = ${env.build_flags} -DARDUINO=100 -Isrc/cubecell
+build_flags = ${arduino_base.build_flags} -DARDUINO=100 -Isrc/cubecell
 src_filter = 
-  ${env.src_filter} -<esp32/> -<nrf52/>
+  ${arduino_base.src_filter} -<esp32/> -<nrf52/>
   
 ; Common settings for NRF52 based targets
 [nrf52_base]
 ; Instead of the standard nordicnrf52 platform, we use our fork which has our added variant files
 ; platform = nordicnrf52
 platform = https://github.com/meshtastic/platform-nordicnrf52.git#1a2639a6b0f79b5df66bea3e3089f0d5285fdc63
+extends = arduino_base
 debug_tool = jlink
 build_type = debug ; I'm debugging with ICE a lot now
 ; note: liboberon provides the AES256 implementation for NRF52 (though not using the hardware acceleration of the NRF52840 - FIXME)
 build_flags = 
-  ${env.build_flags} -Wno-unused-variable 
+  ${arduino_base.build_flags} -Wno-unused-variable 
   -Isrc/nrf52 
   -Isdk-nrfxlib/crypto/nrf_oberon/include -Lsdk-nrfxlib/crypto/nrf_oberon/lib/cortex-m4/hard-float/ -lliboberon_3.0.3 
 ;-DCFG_DEBUG=3
 src_filter = 
-  ${env.src_filter} -<esp32/> -<nimble/>
+  ${arduino_base.src_filter} -<esp32/> -<nimble/> -<meshwifi/>
 lib_ignore =
   BluetoothOTA
 monitor_port = /dev/ttyACM1
@@ -212,9 +235,32 @@ monitor_speed = 115200
 extends = nrf52_base
 board = ppr
 lib_deps = 
-  ${env.lib_deps}
+  ${arduino_base.lib_deps}
   UC1701
 
+; The PPR board
+[env:ppr1]
+extends = nrf52_base
+board = ppr1
+build_flags = ${nrf52_base.build_flags} -Ivariants/ppr1
+src_filter = ${nrf52_base.src_filter} +<../variants/ppr1>
+lib_deps = 
+  ${arduino_base.lib_deps}
+
+; Prototype eink/nrf52840/sx1262 device
+[env:eink]
+extends = nrf52_base
+board = eink
+# add our variants files to the include and src paths
+# define build flags for the TFT_eSPI library
+build_flags = ${nrf52_base.build_flags} -Ivariants/eink
+  -DBUSY_PIN=3 -DRST_PIN=2 -DDC_PIN=28 -DCS_PIN=30
+src_filter = ${nrf52_base.src_filter} +<../variants/eink>
+lib_deps = 
+  ${arduino_base.lib_deps}
+  https://github.com/geeksville/EPD_Libraries.git
+  TFT_eSPI
+
 ; The https://github.com/BigCorvus/SX1262-LoRa-BLE-Relay board by @BigCorvus
 [env:lora-relay-v1]
 extends = nrf52_base
@@ -233,11 +279,38 @@ build_flags = ${nrf52_base.build_flags} -Ivariants/lora_relay_v1
   -DSPI_FREQUENCY=27000000
 src_filter = ${nrf52_base.src_filter} +<../variants/lora_relay_v1>
 lib_deps = 
-  ${env.lib_deps}
+  ${arduino_base.lib_deps}
   SparkFun BQ27441 LiPo Fuel Gauge Arduino Library
   TFT_eSPI
-  # Adafruit ST7735 and ST7789 Library
-
-
 
+; The https://github.com/BigCorvus/LoRa-BLE-Relay-v2 board by @BigCorvus
+[env:lora-relay-v2]
+extends = nrf52_base
+board = lora-relay-v2
+# add our variants files to the include and src paths
+# define build flags for the TFT_eSPI library
+build_flags = ${nrf52_base.build_flags} -Ivariants/lora_relay_v2
+  -DUSER_SETUP_LOADED
+  -DTFT_WIDTH=80
+  -DTFT_HEIGHT=160
+  -DST7735_GREENTAB160x80
+  -DST7735_DRIVER
+  -DTFT_CS=ST7735_CS
+  -DTFT_DC=ST7735_RS
+  -DTFT_RST=ST7735_RESET
+  -DSPI_FREQUENCY=27000000
+  -DTFT_WR=ST7735_SDA
+  -DTFT_SCLK=ST7735_SCK
+src_filter = ${nrf52_base.src_filter} +<../variants/lora_relay_v2>
+lib_deps = 
+  ${arduino_base.lib_deps}
+  SparkFun BQ27441 LiPo Fuel Gauge Arduino Library
+  TFT_eSPI
 
+; The Portduino based sim environment on top of linux
+[env:linux]
+platform = https://github.com/geeksville/platform-portduino.git
+src_filter = ${env.src_filter} -<esp32/> -<nimble/> -<nrf52/> -<meshwifi/>
+build_flags = ${arduino_base.build_flags} -O0
+framework = arduino
+board = linux_x86_64

src/FSCommon.cpp

@@ -0,0 +1,21 @@
+#include "FSCommon.h"
+
+void fsInit()
+{
+#ifdef FS
+    if (!FSBegin()) 
+    {
+        DEBUG_MSG("ERROR filesystem mount Failed\n");
+        assert(0); // FIXME - report failure to phone
+    }
+
+    DEBUG_MSG("Filesystem files:\n");
+    File dir = FS.open("/");
+    File f = dir.openNextFile();
+    while (f) {
+        DEBUG_MSG("  %s\n", f.name());
+        f.close();
+        f = dir.openNextFile(); 
+    }
+#endif
+}

src/FSCommon.h

@@ -0,0 +1,29 @@
+#pragma once
+
+#include "configuration.h"
+
+// Cross platform filesystem API
+
+#ifdef PORTDUINO
+// Portduino version
+#include "PortduinoFS.h"
+#define FS PortduinoFS
+#define FSBegin() true
+#define FILE_O_WRITE "w"
+#define FILE_O_READ "r"
+#elif !defined(NO_ESP32)
+// ESP32 version
+#include "SPIFFS.h"
+#define FS SPIFFS
+#define FSBegin() FS.begin(true)
+#define FILE_O_WRITE "w"
+#define FILE_O_READ "r"
+#else
+// NRF52 version
+#include "InternalFileSystem.h"
+#define FS InternalFS
+#define FSBegin() FS.begin()
+using namespace Adafruit_LittleFS_Namespace;
+#endif
+
+void fsInit();

src/GPSStatus.h

@@ -1,126 +1,98 @@
 #pragma once
-#include <Arduino.h>
 #include "Status.h"
 #include "configuration.h"
+#include <Arduino.h>
 
-namespace meshtastic {
+namespace meshtastic
+{
 
-    /// Describes the state of the GPS system.
-    class GPSStatus : public Status
+/// Describes the state of the GPS system.
+class GPSStatus : public Status
+{
+
+  private:
+    CallbackObserver<GPSStatus, const GPSStatus *> statusObserver =
+        CallbackObserver<GPSStatus, const GPSStatus *>(this, &GPSStatus::updateStatus);
+
+    bool hasLock = false;                // default to false, until we complete our first read
+    bool isConnected = false;            // Do we have a GPS we are talking to
+    int32_t latitude = 0, longitude = 0; // as an int mult by 1e-7 to get value as double
+    int32_t altitude = 0;
+    uint32_t dop = 0; // Diminution of position; PDOP where possible (UBlox), HDOP otherwise (TinyGPS) in 10^2 units (needs
+                      // scaling before use)
+    uint32_t heading = 0;
+    uint32_t numSatellites = 0;
+
+  public:
+    GPSStatus() { statusType = STATUS_TYPE_GPS; }
+    GPSStatus(bool hasLock, bool isConnected, int32_t latitude, int32_t longitude, int32_t altitude, uint32_t dop,
+              uint32_t heading, uint32_t numSatellites)
+        : Status()
     {
+        this->hasLock = hasLock;
+        this->isConnected = isConnected;
+        this->latitude = latitude;
+        this->longitude = longitude;
+        this->altitude = altitude;
+        this->dop = dop;
+        this->heading = heading;
+        this->numSatellites = numSatellites;
+    }
+    GPSStatus(const GPSStatus &);
+    GPSStatus &operator=(const GPSStatus &);
 
-       private:
-        CallbackObserver<GPSStatus, const GPSStatus *> statusObserver = CallbackObserver<GPSStatus, const GPSStatus *>(this, &GPSStatus::updateStatus);
+    void observe(Observable<const GPSStatus *> *source) { statusObserver.observe(source); }
 
-        bool hasLock = false; // default to false, until we complete our first read
-        bool isConnected = false; // Do we have a GPS we are talking to
-        int32_t latitude = 0, longitude = 0; // as an int mult by 1e-7 to get value as double
-        int32_t altitude = 0;
-        uint32_t dop = 0; // Diminution of position; PDOP where possible (UBlox), HDOP otherwise (TinyGPS) in 10^2 units (needs scaling before use)
-        uint32_t heading = 0;
-        uint32_t numSatellites = 0;
+    bool getHasLock() const { return hasLock; }
 
-       public:
+    bool getIsConnected() const { return isConnected; }
 
-        GPSStatus() {
-            statusType = STATUS_TYPE_GPS;
-        }
-        GPSStatus( bool hasLock, bool isConnected, int32_t latitude, int32_t longitude, int32_t altitude, uint32_t dop, uint32_t heading, uint32_t numSatellites ) : Status()
+    int32_t getLatitude() const { return latitude; }
+
+    int32_t getLongitude() const { return longitude; }
+
+    int32_t getAltitude() const { return altitude; }
+
+    uint32_t getDOP() const { return dop; }
+
+    uint32_t getHeading() const { return heading; }
+
+    uint32_t getNumSatellites() const { return numSatellites; }
+
+    bool matches(const GPSStatus *newStatus) const
+    {
+        return (newStatus->hasLock != hasLock || newStatus->isConnected != isConnected || newStatus->latitude != latitude ||
+                newStatus->longitude != longitude || newStatus->altitude != altitude || newStatus->dop != dop ||
+                newStatus->heading != heading || newStatus->numSatellites != numSatellites);
+    }
+    int updateStatus(const GPSStatus *newStatus)
+    {
+        // Only update the status if values have actually changed
+        bool isDirty;
         {
-            this->hasLock = hasLock;
-            this->isConnected = isConnected;
-            this->latitude = latitude;
-            this->longitude = longitude;
-            this->altitude = altitude;
-            this->dop = dop;
-            this->heading = heading;
-            this->numSatellites = numSatellites;
+            isDirty = matches(newStatus);
+            initialized = true;
+            hasLock = newStatus->hasLock;
+            isConnected = newStatus->isConnected;
+            latitude = newStatus->latitude;
+            longitude = newStatus->longitude;
+            altitude = newStatus->altitude;
+            dop = newStatus->dop;
+            heading = newStatus->heading;
+            numSatellites = newStatus->numSatellites;
         }
-        GPSStatus(const GPSStatus &);
-        GPSStatus &operator=(const GPSStatus &);
-
-        void observe(Observable<const GPSStatus *> *source)
-        {
-            statusObserver.observe(source);
+        if (isDirty) {
+            if (hasLock)
+                DEBUG_MSG("New GPS pos lat=%f, lon=%f, alt=%d, pdop=%f, heading=%f, sats=%d\n", latitude * 1e-7, longitude * 1e-7,
+                          altitude, dop * 1e-2, heading * 1e-5, numSatellites);
+            else
+                DEBUG_MSG("No GPS lock\n");
+            onNewStatus.notifyObservers(this);
         }
+        return 0;
+    }
+};
 
-        bool getHasLock() const
-        { 
-            return hasLock; 
-        }
-
-        bool getIsConnected() const
-        { 
-            return isConnected; 
-        }
-
-        int32_t getLatitude() const
-        { 
-            return latitude; 
-        }
-
-        int32_t getLongitude() const
-        { 
-            return longitude;
-        }
-
-        int32_t getAltitude() const
-        { 
-            return altitude; 
-        }
-
-        uint32_t getDOP() const
-        { 
-            return dop; 
-        }
-
-        uint32_t getHeading() const
-        {
-            return heading;
-        }
-
-        uint32_t getNumSatellites() const
-        {
-            return numSatellites;
-        }
-
-        bool matches(const GPSStatus *newStatus) const
-        {
-            return (
-                newStatus->hasLock != hasLock ||
-                newStatus->isConnected != isConnected ||
-                newStatus->latitude != latitude ||
-                newStatus->longitude != longitude ||
-                newStatus->altitude != altitude ||
-                newStatus->dop != dop ||
-                newStatus->heading != heading ||
-                newStatus->numSatellites != numSatellites
-            );
-        }
-        int updateStatus(const GPSStatus *newStatus) {
-            // Only update the status if values have actually changed
-            bool isDirty;
-            {
-                isDirty = matches(newStatus);
-                initialized = true; 
-                hasLock = newStatus->hasLock;
-                isConnected = newStatus->isConnected;
-                latitude = newStatus->latitude;
-                longitude = newStatus->longitude;
-                altitude = newStatus->altitude;
-                dop = newStatus->dop;
-                heading = newStatus->heading;
-                numSatellites = newStatus->numSatellites;
-            }
-            if(isDirty) {
-                DEBUG_MSG("New GPS pos lat=%f, lon=%f, alt=%d, pdop=%f, heading=%f, sats=%d\n", latitude * 1e-7, longitude * 1e-7, altitude, dop * 1e-2, heading * 1e-5, numSatellites);
-                onNewStatus.notifyObservers(this);
-            }
-            return 0;
-        }
-
-    };
-
-}
+} // namespace meshtastic
 
 extern meshtastic::GPSStatus *gpsStatus;

src/Power.cpp

@@ -18,6 +18,21 @@ Power *power;
 
 using namespace meshtastic;
 
+#if defined(NRF52_SERIES)
+/*
+ * Internal Reference is +/-0.6V, with an adjustable gain of 1/6, 1/5, 1/4,
+ * 1/3, 1/2 or 1, meaning 3.6, 3.0, 2.4, 1.8, 1.2 or 0.6V for the ADC levels.
+ *
+ * External Reference is VDD/4, with an adjustable gain of 1, 2 or 4, meaning
+ * VDD/4, VDD/2 or VDD for the ADC levels.
+ *
+ * Default settings are internal reference with 1/6 gain (GND..3.6V ADC range)
+ */
+#define AREF_VOLTAGE 3.6
+#else
+#define AREF_VOLTAGE 3.3
+#endif
+
 /**
  * If this board has a battery level sensor, set this to a valid implementation
  */
@@ -37,10 +52,13 @@ class AnalogBatteryLevel : public HasBatteryLevel
     {
         float v = getBattVoltage() / 1000;
 
-        if (v < 2.1)
+        if (v < noBatVolt)
             return -1; // If voltage is super low assume no battery installed
 
-        return 100 * (v - 3.27) / (4.2 - 3.27);
+        if (v > chargingVolt)
+            return 0; // While charging we can't report % full on the battery
+
+        return 100 * (v - emptyVolt) / (fullVolt - emptyVolt);
     }
 
     /**
@@ -48,9 +66,11 @@ class AnalogBatteryLevel : public HasBatteryLevel
      */
     virtual float getBattVoltage()
     {
+        // Tested ttgo eink nrf52 board and the reported value is perfect
+        // DEBUG_MSG("raw val %u", raw);
         return
 #ifdef BATTERY_PIN
-            1000.0 * analogRead(BATTERY_PIN) * 2.0 * (3.3 / 1024.0);
+            1000.0 * 2.0 * (AREF_VOLTAGE / 1024.0) * analogRead(BATTERY_PIN);
 #else
             NAN;
 #endif
@@ -59,14 +79,40 @@ class AnalogBatteryLevel : public HasBatteryLevel
     /**
      * return true if there is a battery installed in this unit
      */
-    virtual bool isBatteryConnect() { return getBattVoltage() != -1; }
+    virtual bool isBatteryConnect() { return getBattPercentage() != -1; }
+
+    /// If we see a battery voltage higher than physics allows - assume charger is pumping
+    /// in power
+    virtual bool isVBUSPlug() { return getBattVoltage() > chargingVolt; }
+
+    /// Assume charging if we have a battery and external power is connected.
+    /// we can't be smart enough to say 'full'?
+    virtual bool isChargeing() { return isBatteryConnect() && isVBUSPlug(); }
+
+  private:
+    /// If we see a battery voltage higher than physics allows - assume charger is pumping
+    /// in power
+    const float fullVolt = 4.2, emptyVolt = 3.27, chargingVolt = 4.3, noBatVolt = 2.1;
 } analogLevel;
 
+Power::Power() : OSThread("Power") {}
+
 bool Power::analogInit()
 {
 #ifdef BATTERY_PIN
     DEBUG_MSG("Using analog input for battery level\n");
+
+    // disable any internal pullups
+    pinMode(BATTERY_PIN, INPUT);
+
+#ifndef NO_ESP32
+    // ESP32 needs special analog stuff
     adcAttachPin(BATTERY_PIN);
+#endif
+#ifdef NRF52_SERIES
+    analogReference(AR_INTERNAL); // 3.6V
+#endif
+
     // adcStart(BATTERY_PIN);
     analogReadResolution(10); // Default of 12 is not very linear. Recommended to use 10 or 11 depending on needed resolution.
     batteryLevel = &analogLevel;
@@ -83,14 +129,19 @@ bool Power::setup()
     if (!found) {
         found = analogInit();
     }
-    if (found) {
-        concurrency::PeriodicTask::setup(); // We don't start our periodic task unless we actually found the device
-        setPeriod(1);
-    }
+    enabled = found;
 
     return found;
 }
 
+void Power::shutdown()
+{
+#ifdef TBEAM_V10
+    DEBUG_MSG("Shutting down\n");
+    axp.shutdown();
+#endif
+}
+
 /// Reads power status to powerStatus singleton.
 //
 // TODO(girts): move this and other axp stuff to power.h/power.cpp.
@@ -119,6 +170,8 @@ void Power::readPowerStatus()
         const PowerStatus powerStatus =
             PowerStatus(hasBattery ? OptTrue : OptFalse, batteryLevel->isVBUSPlug() ? OptTrue : OptFalse,
                         batteryLevel->isChargeing() ? OptTrue : OptFalse, batteryVoltageMv, batteryChargePercent);
+        DEBUG_MSG("Battery: usbPower=%d, isCharging=%d, batMv=%d, batPct=%d\n", powerStatus.getHasUSB(),
+                  powerStatus.getIsCharging(), powerStatus.getBatteryVoltageMv(), powerStatus.getBatteryChargePercent());
         newStatus.notifyObservers(&powerStatus);
 
         // If we have a battery at all and it is less than 10% full, force deep sleep
@@ -131,13 +184,47 @@ void Power::readPowerStatus()
     }
 }
 
-void Power::doTask()
+int32_t Power::runOnce()
 {
     readPowerStatus();
 
+#ifdef TBEAM_V10
+    // WE no longer use the IRQ line to wake the CPU (due to false wakes from sleep), but we do poll
+    // the IRQ status by reading the registers over I2C
+    axp.readIRQ();
+
+    if (axp.isVbusRemoveIRQ()) {
+        DEBUG_MSG("USB unplugged\n");
+        powerFSM.trigger(EVENT_POWER_DISCONNECTED);
+    }
+    if (axp.isVbusPlugInIRQ()) {
+        DEBUG_MSG("USB plugged In\n");
+        powerFSM.trigger(EVENT_POWER_CONNECTED);
+    }
+    /*
+    Other things we could check if we cared...
+
+    if (axp.isChargingIRQ()) {
+        DEBUG_MSG("Battery start charging\n");
+    }
+    if (axp.isChargingDoneIRQ()) {
+        DEBUG_MSG("Battery fully charged\n");
+    }
+    if (axp.isBattPlugInIRQ()) {
+        DEBUG_MSG("Battery inserted\n");
+    }
+    if (axp.isBattRemoveIRQ()) {
+        DEBUG_MSG("Battery removed\n");
+    }
+    if (axp.isPEKShortPressIRQ()) {
+        DEBUG_MSG("PEK short button press\n");
+    }
+    */
+    axp.clearIRQ();
+#endif
+
     // Only read once every 20 seconds once the power status for the app has been initialized
-    if (statusHandler && statusHandler->isInitialized())
-        setPeriod(1000 * 20);
+    return (statusHandler && statusHandler->isInitialized()) ? (1000 * 20) : RUN_SAME;
 }
 
 /**
@@ -168,7 +255,7 @@ bool Power::axp192Init()
             DEBUG_MSG("----------------------------------------\n");
 
             axp.setPowerOutPut(AXP192_LDO2, AXP202_ON); // LORA radio
-            axp.setPowerOutPut(AXP192_LDO3, AXP202_ON); // GPS main power
+            // axp.setPowerOutPut(AXP192_LDO3, AXP202_ON); // GPS main power - now turned on in setGpsPower
             axp.setPowerOutPut(AXP192_DCDC2, AXP202_ON);
             axp.setPowerOutPut(AXP192_EXTEN, AXP202_ON);
             axp.setPowerOutPut(AXP192_DCDC1, AXP202_ON);
@@ -200,9 +287,11 @@ bool Power::axp192Init()
                 PMU_IRQ, [] { pmu_irq = true; }, FALLING);
 
             axp.adc1Enable(AXP202_BATT_CUR_ADC1, 1);
-            axp.enableIRQ(AXP202_BATT_REMOVED_IRQ | AXP202_BATT_CONNECT_IRQ | AXP202_CHARGING_FINISHED_IRQ | AXP202_CHARGING_IRQ |
-                              AXP202_VBUS_REMOVED_IRQ | AXP202_VBUS_CONNECT_IRQ | AXP202_PEK_SHORTPRESS_IRQ,
-                          1);
+            // we do not look for AXP202_CHARGING_FINISHED_IRQ & AXP202_CHARGING_IRQ because it occurs repeatedly while there is
+            // no battery also it could cause inadvertent waking from light sleep just because the battery filled
+            // we don't look for AXP202_BATT_REMOVED_IRQ because it occurs repeatedly while no battery installed
+            // we don't look at AXP202_VBUS_REMOVED_IRQ because we don't have anything hooked to vbus
+            axp.enableIRQ(AXP202_BATT_CONNECT_IRQ | AXP202_VBUS_CONNECT_IRQ | AXP202_PEK_SHORTPRESS_IRQ, 1);
 
             axp.clearIRQ();
 #endif
@@ -219,41 +308,3 @@ bool Power::axp192Init()
     return false;
 #endif
 }
-
-void Power::loop()
-{
-#ifdef PMU_IRQ
-    if (pmu_irq) {
-        pmu_irq = false;
-        axp.readIRQ();
-
-        DEBUG_MSG("pmu irq!\n");
-
-        if (axp.isChargingIRQ()) {
-            DEBUG_MSG("Battery start charging\n");
-        }
-        if (axp.isChargingDoneIRQ()) {
-            DEBUG_MSG("Battery fully charged\n");
-        }
-        if (axp.isVbusRemoveIRQ()) {
-            DEBUG_MSG("USB unplugged\n");
-        }
-        if (axp.isVbusPlugInIRQ()) {
-            DEBUG_MSG("USB plugged In\n");
-        }
-        if (axp.isBattPlugInIRQ()) {
-            DEBUG_MSG("Battery inserted\n");
-        }
-        if (axp.isBattRemoveIRQ()) {
-            DEBUG_MSG("Battery removed\n");
-        }
-        if (axp.isPEKShortPressIRQ()) {
-            DEBUG_MSG("PEK short button press\n");
-        }
-
-        readPowerStatus();
-        axp.clearIRQ();
-    }
-
-#endif
-}

src/PowerFSM.cpp

@@ -4,25 +4,15 @@
 #include "MeshService.h"
 #include "NodeDB.h"
 #include "configuration.h"
-#include "main.h"
 #include "graphics/Screen.h"
+#include "main.h"
 #include "sleep.h"
 #include "target_specific.h"
-#include "timing.h"
 
 static void sdsEnter()
 {
-    /*
-
-  // Don't deepsleep if we have USB power or if the user as pressed a button recently
-  // !isUSBPowered <- doesn't work yet because the axp192 isn't letting the battery fully charge when we are awake - FIXME
-  if (timing::millis() - lastPressMs > radioConfig.preferences.mesh_sds_timeout_secs)
-  {
-    doDeepSleep(radioConfig.preferences.sds_secs);
-  }
-*/
-
-    doDeepSleep(radioConfig.preferences.sds_secs * 1000LL);
+    // FIXME - make sure GPS and LORA radio are off first - because we want close to zero current draw
+    doDeepSleep(getPref_sds_secs() * 1000LL);
 }
 
 #include "error.h"
@@ -31,8 +21,8 @@ static uint32_t secsSlept;
 
 static void lsEnter()
 {
-    DEBUG_MSG("lsEnter begin, ls_secs=%u\n", radioConfig.preferences.ls_secs);
-    screen.setOn(false);
+    DEBUG_MSG("lsEnter begin, ls_secs=%u\n", getPref_ls_secs());
+    screen->setOn(false);
     secsSlept = 0; // How long have we been sleeping this time
 
     DEBUG_MSG("lsEnter end\n");
@@ -40,13 +30,13 @@ static void lsEnter()
 
 static void lsIdle()
 {
-    // DEBUG_MSG("lsIdle begin ls_secs=%u\n", radioConfig.preferences.ls_secs);
+    // DEBUG_MSG("lsIdle begin ls_secs=%u\n", getPref_ls_secs());
 
 #ifndef NO_ESP32
     esp_sleep_source_t wakeCause = ESP_SLEEP_WAKEUP_UNDEFINED;
 
     // Do we have more sleeping to do?
-    if (secsSlept < radioConfig.preferences.ls_secs) {
+    if (secsSlept < getPref_ls_secs()) {
         // Briefly come out of sleep long enough to blink the led once every few seconds
         uint32_t sleepTime = 30;
 
@@ -55,7 +45,8 @@ static void lsIdle()
             setLed(false); // Never leave led on while in light sleep
             wakeCause = doLightSleep(sleepTime * 1000LL);
 
-            if (wakeCause == ESP_SLEEP_WAKEUP_TIMER) {
+            switch (wakeCause) {
+            case ESP_SLEEP_WAKEUP_TIMER:
                 // Normal case: timer expired, we should just go back to sleep ASAP
 
                 setLed(true);                // briefly turn on led
@@ -63,12 +54,15 @@ static void lsIdle()
 
                 secsSlept += sleepTime;
                 // DEBUG_MSG("sleeping, flash led!\n");
-            }
-            if (wakeCause == ESP_SLEEP_WAKEUP_UART) {
+                break;
+
+            case ESP_SLEEP_WAKEUP_UART:
                 // Not currently used (because uart triggers in hw have problems)
                 powerFSM.trigger(EVENT_SERIAL_CONNECTED);
-            } else {
-                // We woke for some other reason (button press, uart, device interrupt)
+                break;
+
+            default:
+                // We woke for some other reason (button press, device interrupt)
                 // uint64_t status = esp_sleep_get_ext1_wakeup_status();
                 DEBUG_MSG("wakeCause %d\n", wakeCause);
 
@@ -82,8 +76,10 @@ static void lsIdle()
                     powerFSM.trigger(EVENT_PRESS);
                 } else {
                     // Otherwise let the NB state handle the IRQ (and that state will handle stuff like IRQs etc)
+                    // we lie and say "wake timer" because the interrupt will be handled by the regular IRQ code
                     powerFSM.trigger(EVENT_WAKE_TIMER);
                 }
+                break;
             }
         } else {
             // Someone says we can't sleep now, so just save some power by sleeping the CPU for 100ms or so
@@ -101,12 +97,12 @@ static void lsIdle()
 static void lsExit()
 {
     // setGPSPower(true); // restore GPS power
-    gps->startLock();
+    gps->forceWake(true);
 }
 
 static void nbEnter()
 {
-    screen.setOn(false);
+    screen->setOn(false);
     setBluetoothEnable(false);
 
     // FIXME - check if we already have packets for phone and immediately trigger EVENT_PACKETS_FOR_PHONE
@@ -115,36 +111,50 @@ static void nbEnter()
 static void darkEnter()
 {
     setBluetoothEnable(true);
-    screen.setOn(false);
+    screen->setOn(false);
 }
 
 static void serialEnter()
 {
     setBluetoothEnable(false);
-    screen.setOn(true);
+    screen->setOn(true);
+    screen->print("Using API...\n");
+}
+
+static void powerEnter()
+{
+    screen->setOn(true);
+    setBluetoothEnable(true);
+    screen->print("Powered...\n");
+}
+
+static void powerExit()
+{
+    screen->setOn(true);
+    setBluetoothEnable(true);
+    screen->print("Unpowered...\n");
 }
 
 static void onEnter()
 {
-    screen.setOn(true);
+    screen->setOn(true);
     setBluetoothEnable(true);
 
     static uint32_t lastPingMs;
 
-    uint32_t now = timing::millis();
+    uint32_t now = millis();
 
     if (now - lastPingMs > 30 * 1000) { // if more than a minute since our last press, ask other nodes to update their state
         if (displayedNodeNum)
             service.sendNetworkPing(displayedNodeNum, true); // Refresh the currently displayed node
         lastPingMs = now;
     }
-}
 
-static void wakeForPing() {}
+}
 
 static void screenPress()
 {
-    screen.onPress();
+    screen->onPress();
 }
 
 static void bootEnter() {}
@@ -156,16 +166,25 @@ State stateDARK(darkEnter, NULL, NULL, "DARK");
 State stateSERIAL(serialEnter, NULL, NULL, "SERIAL");
 State stateBOOT(bootEnter, NULL, NULL, "BOOT");
 State stateON(onEnter, NULL, NULL, "ON");
+State statePOWER(powerEnter, NULL, powerExit, "POWER");
 Fsm powerFSM(&stateBOOT);
 
 void PowerFSM_setup()
 {
-    powerFSM.add_timed_transition(&stateBOOT, &stateON, 3 * 1000, NULL, "boot timeout");
+    // If we are not a router and we already have AC power go to POWER state after init, otherwise go to ON
+    // We assume routers might be powered all the time, but from a low current (solar) source
+    bool isLowPower = radioConfig.preferences.is_low_power;
+    bool hasPower = !isLowPower && powerStatus && powerStatus->getHasUSB();
+    bool isRouter = radioConfig.preferences.is_router;
+    DEBUG_MSG("PowerFSM init, USB power=%d\n", hasPower);
+    powerFSM.add_timed_transition(&stateBOOT, hasPower ? &statePOWER : &stateON, 3 * 1000, NULL, "boot timeout");
 
-    powerFSM.add_transition(&stateLS, &stateDARK, EVENT_WAKE_TIMER, wakeForPing, "Wake timer");
+    // wake timer expired or a packet arrived
+    // if we are a router node, we go to NB (no need for bluetooth) otherwise we go to DARK (so we can send message to phone)
+    powerFSM.add_transition(&stateLS, isRouter ? &stateNB : &stateDARK, EVENT_WAKE_TIMER, NULL, "Wake timer");
 
-    // Note we don't really use this transition, because when we wake from light sleep we _always_ transition to NB and then it
-    // handles things powerFSM.add_transition(&stateLS, &stateNB, EVENT_RECEIVED_PACKET, NULL, "Received packet");
+    // Note we don't really use this transition, because when we wake from light sleep we _always_ transition to NB or dark and
+    // then it handles things powerFSM.add_transition(&stateLS, &stateNB, EVENT_RECEIVED_PACKET, NULL, "Received packet");
 
     powerFSM.add_transition(&stateNB, &stateNB, EVENT_RECEIVED_PACKET, NULL, "Received packet, resetting win wake");
 
@@ -173,7 +192,10 @@ void PowerFSM_setup()
     powerFSM.add_transition(&stateLS, &stateON, EVENT_PRESS, NULL, "Press");
     powerFSM.add_transition(&stateNB, &stateON, EVENT_PRESS, NULL, "Press");
     powerFSM.add_transition(&stateDARK, &stateON, EVENT_PRESS, NULL, "Press");
+    powerFSM.add_transition(&statePOWER, &statePOWER, EVENT_PRESS, screenPress, "Press");
     powerFSM.add_transition(&stateON, &stateON, EVENT_PRESS, screenPress, "Press"); // reenter On to restart our timers
+    powerFSM.add_transition(&stateSERIAL, &stateSERIAL, EVENT_PRESS, screenPress,
+                            "Press"); // Allow button to work while in serial API
 
     // Handle critically low power battery by forcing deep sleep
     powerFSM.add_transition(&stateBOOT, &stateSDS, EVENT_LOW_BATTERY, NULL, "LowBat");
@@ -186,42 +208,61 @@ void PowerFSM_setup()
     powerFSM.add_transition(&stateDARK, &stateON, EVENT_BLUETOOTH_PAIR, NULL, "Bluetooth pairing");
     powerFSM.add_transition(&stateON, &stateON, EVENT_BLUETOOTH_PAIR, NULL, "Bluetooth pairing");
 
-    powerFSM.add_transition(&stateNB, &stateON, EVENT_NODEDB_UPDATED, NULL, "NodeDB update");
-    powerFSM.add_transition(&stateDARK, &stateON, EVENT_NODEDB_UPDATED, NULL, "NodeDB update");
-    powerFSM.add_transition(&stateON, &stateON, EVENT_NODEDB_UPDATED, NULL, "NodeDB update");
+    // if we are a router we don't turn the screen on for these things
+    if (!isRouter) {
+        // show the latest node when we get a new node db update
+        powerFSM.add_transition(&stateNB, &stateON, EVENT_NODEDB_UPDATED, NULL, "NodeDB update");
+        powerFSM.add_transition(&stateDARK, &stateON, EVENT_NODEDB_UPDATED, NULL, "NodeDB update");
+        powerFSM.add_transition(&stateON, &stateON, EVENT_NODEDB_UPDATED, NULL, "NodeDB update");
 
-    powerFSM.add_transition(&stateLS, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text");
-    powerFSM.add_transition(&stateNB, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text");
-    powerFSM.add_transition(&stateDARK, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text");
-    powerFSM.add_transition(&stateON, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text"); // restarts the sleep timer
+        // Show the received text message
+        powerFSM.add_transition(&stateLS, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text");
+        powerFSM.add_transition(&stateNB, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text");
+        powerFSM.add_transition(&stateDARK, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text");
+        powerFSM.add_transition(&stateON, &stateON, EVENT_RECEIVED_TEXT_MSG, NULL, "Received text"); // restarts the sleep timer
+    }
 
     powerFSM.add_transition(&stateLS, &stateSERIAL, EVENT_SERIAL_CONNECTED, NULL, "serial API");
     powerFSM.add_transition(&stateNB, &stateSERIAL, EVENT_SERIAL_CONNECTED, NULL, "serial API");
     powerFSM.add_transition(&stateDARK, &stateSERIAL, EVENT_SERIAL_CONNECTED, NULL, "serial API");
     powerFSM.add_transition(&stateON, &stateSERIAL, EVENT_SERIAL_CONNECTED, NULL, "serial API");
 
+    if (!isLowPower) {
+        powerFSM.add_transition(&stateLS, &statePOWER, EVENT_POWER_CONNECTED, NULL, "power connect");
+        powerFSM.add_transition(&stateNB, &statePOWER, EVENT_POWER_CONNECTED, NULL, "power connect");
+        powerFSM.add_transition(&stateDARK, &statePOWER, EVENT_POWER_CONNECTED, NULL, "power connect");
+        powerFSM.add_transition(&stateON, &statePOWER, EVENT_POWER_CONNECTED, NULL, "power connect");
+    }
+
+    powerFSM.add_transition(&statePOWER, &stateON, EVENT_POWER_DISCONNECTED, NULL, "power disconnected");
+    powerFSM.add_transition(&stateSERIAL, &stateON, EVENT_POWER_DISCONNECTED, NULL, "power disconnected");
+
     powerFSM.add_transition(&stateSERIAL, &stateNB, EVENT_SERIAL_DISCONNECTED, NULL, "serial disconnect");
 
     powerFSM.add_transition(&stateDARK, &stateDARK, EVENT_CONTACT_FROM_PHONE, NULL, "Contact from phone");
 
     powerFSM.add_transition(&stateNB, &stateDARK, EVENT_PACKET_FOR_PHONE, NULL, "Packet for phone");
 
-    powerFSM.add_timed_transition(&stateON, &stateDARK, radioConfig.preferences.screen_on_secs * 1000, NULL, "Screen-on timeout");
+    powerFSM.add_timed_transition(&stateON, &stateDARK, getPref_screen_on_secs() * 1000, NULL, "Screen-on timeout");
 
-    powerFSM.add_timed_transition(&stateDARK, &stateNB, radioConfig.preferences.phone_timeout_secs * 1000, NULL, "Phone timeout");
+    // On most boards we use light-sleep to be our main state, but on NRF52 we just stay in DARK
+    State *lowPowerState = &stateLS;
 
 #ifndef NRF52_SERIES
-    // We never enter light-sleep state on NRF52 (because the CPU uses so little power normally)
-    powerFSM.add_timed_transition(&stateNB, &stateLS, radioConfig.preferences.min_wake_secs * 1000, NULL, "Min wake timeout");
+    // We never enter light-sleep or NB states on NRF52 (because the CPU uses so little power normally)
 
-    powerFSM.add_timed_transition(&stateDARK, &stateLS, radioConfig.preferences.wait_bluetooth_secs * 1000, NULL,
-                                  "Bluetooth timeout");
+    powerFSM.add_timed_transition(&stateDARK, &stateNB, getPref_phone_timeout_secs() * 1000, NULL, "Phone timeout");
+    powerFSM.add_timed_transition(&stateNB, &stateLS, getPref_min_wake_secs() * 1000, NULL, "Min wake timeout");
+    powerFSM.add_timed_transition(&stateDARK, &stateLS, getPref_wait_bluetooth_secs() * 1000, NULL, "Bluetooth timeout");
+#else
+    lowPowerState = &stateDARK;
 #endif
 
-    powerFSM.add_timed_transition(&stateLS, &stateSDS, radioConfig.preferences.mesh_sds_timeout_secs * 1000, NULL,
-                                  "mesh timeout");
+    auto meshSds = getPref_mesh_sds_timeout_secs();
+    if (meshSds != UINT32_MAX)
+        powerFSM.add_timed_transition(lowPowerState, &stateSDS, meshSds * 1000, NULL, "mesh timeout");
     // removing for now, because some users don't even have phones
-    // powerFSM.add_timed_transition(&stateLS, &stateSDS, radioConfig.preferences.phone_sds_timeout_sec * 1000, NULL, "phone
+    // powerFSM.add_timed_transition(lowPowerState, &stateSDS, getPref_phone_sds_timeout_sec() * 1000, NULL, "phone
     // timeout");
 
     powerFSM.run_machine(); // run one interation of the state machine, so we run our on enter tasks for the initial DARK state

src/PowerFSM.h

@@ -13,10 +13,13 @@
 #define EVENT_BLUETOOTH_PAIR 7
 #define EVENT_NODEDB_UPDATED 8     // NodeDB has a big enough change that we think you should turn on the screen
 #define EVENT_CONTACT_FROM_PHONE 9 // the phone just talked to us over bluetooth
-#define EVENT_LOW_BATTERY 10 // Battery is critically low, go to sleep
+#define EVENT_LOW_BATTERY 10       // Battery is critically low, go to sleep
 #define EVENT_SERIAL_CONNECTED 11
 #define EVENT_SERIAL_DISCONNECTED 12
+#define EVENT_POWER_CONNECTED 13
+#define EVENT_POWER_DISCONNECTED 14
 
 extern Fsm powerFSM;
+extern State statePOWER, stateSERIAL;
 
 void PowerFSM_setup();

src/PowerStatus.h

@@ -82,7 +82,7 @@ class PowerStatus : public Status
             isCharging = newStatus->isCharging;
         }
         if (isDirty) {
-            DEBUG_MSG("Battery %dmV %d%%\n", batteryVoltageMv, batteryChargePercent);
+            // DEBUG_MSG("Battery %dmV %d%%\n", batteryVoltageMv, batteryChargePercent);
             onNewStatus.notifyObservers(this);
         }
         return 0;

src/RedirectablePrint.cpp

@@ -1,4 +1,5 @@
 #include "RedirectablePrint.h"
+#include "configuration.h"
 #include <assert.h>
 
 /**
@@ -10,4 +11,14 @@ void RedirectablePrint::setDestination(Print *_dest)
 {
     assert(_dest);
     dest = _dest;
+}
+
+size_t RedirectablePrint::write(uint8_t c)
+{
+#ifdef SEGGER_STDOUT_CH
+    SEGGER_RTT_PutCharSkip(SEGGER_STDOUT_CH, c);
+#endif
+
+    dest->write(c);
+    return 1; // We always claim one was written, rather than trusting what the serial port said (which could be zero)
 }

src/RedirectablePrint.h

@@ -19,7 +19,7 @@ class RedirectablePrint : public Print
      */
     void setDestination(Print *dest);
 
-    virtual size_t write(uint8_t c) { return dest->write(c); }
+    virtual size_t write(uint8_t c);
 };
 
 class NoopPrint : public Print

src/SerialConsole.cpp

@@ -1,6 +1,7 @@
 #include "SerialConsole.h"
 #include "PowerFSM.h"
 #include "configuration.h"
+#include "NodeDB.h"
 #include <Arduino.h>
 
 #define Port Serial
@@ -28,7 +29,8 @@ void SerialConsole::init()
 void SerialConsole::handleToRadio(const uint8_t *buf, size_t len)
 {
     // Turn off debug serial printing once the API is activated, because other threads could print and corrupt packets
-    setDestination(&noopPrint);
+    if(!radioConfig.preferences.debug_log_enabled)
+        setDestination(&noopPrint);
     canWrite = true;
 
     StreamAPI::handleToRadio(buf, len);
@@ -40,6 +42,8 @@ void SerialConsole::onConnectionChanged(bool connected)
     if (connected) { // To prevent user confusion, turn off bluetooth while using the serial port api
         powerFSM.trigger(EVENT_SERIAL_CONNECTED);
     } else {
+        // FIXME, we get no notice of serial going away, we should instead automatically generate this event if we haven't
+        // received a packet in a while
         powerFSM.trigger(EVENT_SERIAL_DISCONNECTED);
     }
 }

src/concurrency/BinarySemaphoreFreeRTOS.cpp

@@ -0,0 +1,39 @@
+#include "concurrency/BinarySemaphoreFreeRTOS.h"
+#include "configuration.h"
+
+#ifdef HAS_FREE_RTOS
+
+namespace concurrency
+{
+
+BinarySemaphoreFreeRTOS::BinarySemaphoreFreeRTOS()
+{
+    semaphore = xSemaphoreCreateBinary();
+}
+
+BinarySemaphoreFreeRTOS::~BinarySemaphoreFreeRTOS()
+{
+    vSemaphoreDelete(semaphore);
+}
+
+/**
+ * Returns false if we were interrupted
+ */
+bool BinarySemaphoreFreeRTOS::take(uint32_t msec)
+{
+    return xSemaphoreTake(semaphore, pdMS_TO_TICKS(msec));
+}
+
+void BinarySemaphoreFreeRTOS::give()
+{
+    xSemaphoreGive(semaphore);
+}
+
+IRAM_ATTR void BinarySemaphoreFreeRTOS::giveFromISR(BaseType_t *pxHigherPriorityTaskWoken)
+{
+    xSemaphoreGiveFromISR(semaphore, pxHigherPriorityTaskWoken);
+}
+
+} // namespace concurrency
+
+#endif

src/concurrency/BinarySemaphoreFreeRTOS.h

@@ -0,0 +1,31 @@
+#pragma once
+
+#include "configuration.h"
+#include "../freertosinc.h"
+
+namespace concurrency
+{
+
+#ifdef HAS_FREE_RTOS
+
+class BinarySemaphoreFreeRTOS
+{
+    SemaphoreHandle_t semaphore;
+
+  public:
+    BinarySemaphoreFreeRTOS();
+    ~BinarySemaphoreFreeRTOS();
+
+    /**
+     * Returns false if we timed out
+     */
+    bool take(uint32_t msec);
+
+    void give();
+
+    void giveFromISR(BaseType_t *pxHigherPriorityTaskWoken);
+};
+
+#endif
+
+} 

src/concurrency/BinarySemaphorePosix.cpp

@@ -0,0 +1,36 @@
+#include "concurrency/BinarySemaphorePosix.h"
+#include "configuration.h"
+
+#ifndef HAS_FREE_RTOS
+
+namespace concurrency
+{
+
+BinarySemaphorePosix::BinarySemaphorePosix()
+{
+}
+
+BinarySemaphorePosix::~BinarySemaphorePosix()
+{
+}
+
+/**
+ * Returns false if we timed out
+ */
+bool BinarySemaphorePosix::take(uint32_t msec)
+{
+    delay(msec); // FIXME
+    return false;
+}
+
+void BinarySemaphorePosix::give()
+{
+}
+
+IRAM_ATTR void BinarySemaphorePosix::giveFromISR(BaseType_t *pxHigherPriorityTaskWoken)
+{
+}
+
+} // namespace concurrency
+
+#endif

src/concurrency/BinarySemaphorePosix.h

@@ -0,0 +1,31 @@
+#pragma once
+
+#include "configuration.h"
+#include "../freertosinc.h"
+
+namespace concurrency
+{
+
+#ifndef HAS_FREE_RTOS
+
+class BinarySemaphorePosix
+{
+    // SemaphoreHandle_t semaphore;
+
+  public:
+    BinarySemaphorePosix();
+    ~BinarySemaphorePosix();
+
+    /**
+     * Returns false if we timed out
+     */
+    bool take(uint32_t msec);
+
+    void give();
+
+    void giveFromISR(BaseType_t *pxHigherPriorityTaskWoken);
+};
+
+#endif
+
+} 

src/concurrency/InterruptableDelay.cpp

@@ -0,0 +1,35 @@
+#include "concurrency/InterruptableDelay.h"
+#include "configuration.h"
+
+namespace concurrency
+{
+
+InterruptableDelay::InterruptableDelay() {}
+
+InterruptableDelay::~InterruptableDelay() {}
+
+/**
+ * Returns false if we were interrupted
+ */
+bool InterruptableDelay::delay(uint32_t msec)
+{
+    // DEBUG_MSG("delay %u ", msec);
+
+    // sem take will return false if we timed out (i.e. were not interrupted)
+    bool r = semaphore.take(msec);
+
+    // DEBUG_MSG("interrupt=%d\n", r);
+    return !r;
+}
+
+void InterruptableDelay::interrupt()
+{
+    semaphore.give();
+}
+
+IRAM_ATTR void InterruptableDelay::interruptFromISR(BaseType_t *pxHigherPriorityTaskWoken)
+{
+    semaphore.giveFromISR(pxHigherPriorityTaskWoken);
+}
+
+} // namespace concurrency

src/concurrency/InterruptableDelay.h

@@ -0,0 +1,42 @@
+#pragma once
+
+#include "../freertosinc.h"
+
+
+#ifdef HAS_FREE_RTOS
+#include "concurrency/BinarySemaphoreFreeRTOS.h"
+#define BinarySemaphore BinarySemaphoreFreeRTOS
+#else
+#include "concurrency/BinarySemaphorePosix.h"
+#define BinarySemaphore BinarySemaphorePosix
+#endif
+
+namespace concurrency
+{
+
+/**
+ * An object that provides delay(msec) like functionality, but can be interrupted by calling interrupt().
+ *
+ * Useful for they top level loop() delay call to keep the CPU powered down until our next scheduled event or some external event.
+ *
+ * This is implmented for FreeRTOS but should be easy to port to other operating systems.
+ */
+class InterruptableDelay
+{
+    BinarySemaphore semaphore;
+
+  public:
+    InterruptableDelay();
+    ~InterruptableDelay();
+
+    /**
+     * Returns false if we were interrupted
+     */
+    bool delay(uint32_t msec);
+
+    void interrupt();
+
+    void interruptFromISR(BaseType_t *pxHigherPriorityTaskWoken);
+};
+
+} // namespace concurrency

src/concurrency/Lock.cpp

@@ -1,8 +1,10 @@
 #include "Lock.h"
 #include <cassert>
 
-namespace concurrency {
+namespace concurrency
+{
 
+#ifdef HAS_FREE_RTOS
 Lock::Lock()
 {
     handle = xSemaphoreCreateBinary();
@@ -19,5 +21,12 @@ void Lock::unlock()
 {
     assert(xSemaphoreGive(handle));
 }
+#else
+Lock::Lock() {}
+
+void Lock::lock() {}
+
+void Lock::unlock() {}
+#endif
 
 } // namespace concurrency

src/concurrency/Lock.h

@@ -2,7 +2,8 @@
 
 #include "../freertosinc.h"
 
-namespace concurrency {
+namespace concurrency
+{
 
 /**
  * @brief Simple wrapper around FreeRTOS API for implementing a mutex lock
@@ -26,8 +27,9 @@ class Lock
     void unlock();
 
   private:
+#ifdef HAS_FREE_RTOS
     SemaphoreHandle_t handle;
-
+#endif
 };
 
 } // namespace concurrency

src/concurrency/NotifiedWorkerThread.cpp

@@ -1,19 +1,85 @@
 #include "NotifiedWorkerThread.h"
+#include "configuration.h"
+#include <assert.h>
 
-namespace concurrency {
+namespace concurrency
+{
+
+static bool debugNotification;
 
 /**
  * Notify this thread so it can run
  */
-void NotifiedWorkerThread::notify(uint32_t v, eNotifyAction action)
+bool NotifiedWorkerThread::notify(uint32_t v, bool overwrite)
 {
-    xTaskNotify(taskHandle, v, action);
+    bool r = notifyCommon(v, overwrite);
+
+    if (r)
+        mainDelay.interrupt();
+
+    return r;
 }
 
-void NotifiedWorkerThread::block()
+/**
+ * Notify this thread so it can run
+ */
+IRAM_ATTR bool NotifiedWorkerThread::notifyCommon(uint32_t v, bool overwrite)
 {
-    xTaskNotifyWait(0,                                          // don't clear notification on entry
-                    clearOnRead, &notification, portMAX_DELAY); // Wait forever
+    if (overwrite || notification == 0) {
+        enabled = true;
+        setInterval(0); // Run ASAP
+
+        notification = v;
+        if (debugNotification)
+            DEBUG_MSG("setting notification %d\n", v);
+        return true;
+    } else {
+        if (debugNotification)
+            DEBUG_MSG("dropping notification %d\n", v);
+        return false;
+    }
 }
 
-} // namespace concurrency
+/**
+ * Notify from an ISR
+ *
+ * This must be inline or IRAM_ATTR on ESP32
+ */
+IRAM_ATTR bool NotifiedWorkerThread::notifyFromISR(BaseType_t *highPriWoken, uint32_t v, bool overwrite)
+{
+    bool r = notifyCommon(v, overwrite);
+    if (r)
+        mainDelay.interruptFromISR(highPriWoken);
+
+    return r;
+}
+
+/**
+ * Schedule a notification to fire in delay msecs
+ */
+bool NotifiedWorkerThread::notifyLater(uint32_t delay, uint32_t v, bool overwrite)
+{
+    bool didIt = notify(v, overwrite);
+
+    if (didIt) {                   // If we didn't already have something queued, override the delay to be larger
+        setIntervalFromNow(delay); // a new version of setInterval relative to the current time
+        if (debugNotification)
+            DEBUG_MSG("delaying notification %u\n", delay);
+    }
+
+    return didIt;
+}
+
+int32_t NotifiedWorkerThread::runOnce()
+{
+    auto n = notification;
+    enabled = false;  // Only run once per notification
+    notification = 0; // clear notification
+    if (n) {
+        onNotify(n);
+    }
+
+    return RUN_SAME;
+}
+
+} // namespace concurrency

src/concurrency/NotifiedWorkerThread.h

@@ -1,47 +1,50 @@
 #pragma once
 
-#include "WorkerThread.h"
+#include "OSThread.h"
 
-namespace concurrency {
+namespace concurrency
+{
 
 /**
  * @brief A worker thread that waits on a freertos notification
  */
-class NotifiedWorkerThread : public WorkerThread
+class NotifiedWorkerThread : public OSThread
 {
+    /**
+     * The notification that was most recently used to wake the thread.  Read from runOnce()
+     */
+    uint32_t notification = 0;
+
   public:
+    NotifiedWorkerThread(const char *name) : OSThread(name) {}
+
     /**
      * Notify this thread so it can run
      */
-    void notify(uint32_t v = 0, eNotifyAction action = eNoAction);
+    bool notify(uint32_t v, bool overwrite);
 
     /**
      * Notify from an ISR
      *
      * This must be inline or IRAM_ATTR on ESP32
      */
-    inline void notifyFromISR(BaseType_t *highPriWoken, uint32_t v = 0, eNotifyAction action = eNoAction)
-    {
-        xTaskNotifyFromISR(taskHandle, v, action, highPriWoken);
-    }
+    bool notifyFromISR(BaseType_t *highPriWoken, uint32_t v, bool overwrite);
+
+    /**
+     * Schedule a notification to fire in delay msecs
+     */
+    bool notifyLater(uint32_t delay, uint32_t v, bool overwrite);
 
   protected:
-    /**
-     * The notification that was most recently used to wake the thread.  Read from loop()
-     */
-    uint32_t notification = 0;
+    virtual void onNotify(uint32_t notification) = 0;
 
-    /**
-     * What notification bits should be cleared just after we read and return them in notification?
-     *
-     * Defaults to clear all of them.
-     */
-    uint32_t clearOnRead = UINT32_MAX;
+    virtual int32_t runOnce();
 
+  private:
     /**
-     * A method that should block execution - either waiting ona queue/mutex or a "task notification"
+     * Notify this thread so it can run
      */
-    virtual void block();
+    bool notifyCommon(uint32_t v, bool overwrite);
 };
 
 } // namespace concurrency

src/concurrency/OSThread.cpp

@@ -0,0 +1,79 @@
+#include "OSThread.h"
+#include "configuration.h"
+#include <assert.h>
+
+namespace concurrency
+{
+
+/// Show debugging info for disabled threads
+bool OSThread::showDisabled;
+
+/// Show debugging info for threads when we run them
+bool OSThread::showRun = false;
+
+/// Show debugging info for threads we decide not to run;
+bool OSThread::showWaiting = false;
+
+ThreadController mainController, timerController;
+InterruptableDelay mainDelay;
+
+void OSThread::setup()
+{
+    mainController.ThreadName = "mainController";
+    timerController.ThreadName = "timerController";
+}
+
+OSThread::OSThread(const char *_name, uint32_t period, ThreadController *_controller)
+    : Thread(NULL, period), controller(_controller)
+{
+    ThreadName = _name;
+
+    if (controller)
+        controller->add(this);
+}
+
+OSThread::~OSThread()
+{
+    if (controller)
+        controller->remove(this);
+}
+
+/**
+ * Wait a specified number msecs starting from the current time (rather than the last time we were run)
+ */
+void OSThread::setIntervalFromNow(unsigned long _interval)
+{
+    // Save interval
+    interval = _interval;
+
+    // Cache the next run based on the last_run
+    _cached_next_run = millis() + interval;
+}
+
+bool OSThread::shouldRun(unsigned long time)
+{
+    bool r = Thread::shouldRun(time);
+
+    if (showRun && r)
+        DEBUG_MSG("Thread %s: run\n", ThreadName.c_str());
+
+    if (showWaiting && enabled && !r)
+        DEBUG_MSG("Thread %s: wait %lu\n", ThreadName.c_str(), interval);
+
+    if (showDisabled && !enabled)
+        DEBUG_MSG("Thread %s: disabled\n", ThreadName.c_str());
+
+    return r;
+}
+
+void OSThread::run()
+{
+    auto newDelay = runOnce();
+
+    runned();
+
+    if (newDelay >= 0)
+        setInterval(newDelay);
+}
+
+} // namespace concurrency

src/concurrency/OSThread.h

@@ -0,0 +1,70 @@
+#pragma once
+
+#include <cstdlib>
+#include <stdint.h>
+
+#include "Thread.h"
+#include "ThreadController.h"
+#include "concurrency/InterruptableDelay.h"
+
+namespace concurrency
+{
+
+extern ThreadController mainController, timerController;
+extern InterruptableDelay mainDelay;
+
+#define RUN_SAME -1
+
+/**
+ * @brief Base threading
+ * 
+ * This is a pseudo threading layer that is super easy to port, well suited to our slow network and very ram & power efficient.
+ *
+ * TODO FIXME @geeksville
+ *
+ * move more things into OSThreads
+ * remove lock/lockguard
+ * 
+ * move typedQueue into concurrency
+ * remove freertos from typedqueue
+ */
+class OSThread : public Thread
+{
+    ThreadController *controller;
+
+    /// Show debugging info for disabled threads
+    static bool showDisabled;
+
+    /// Show debugging info for threads when we run them
+    static bool showRun;
+
+    /// Show debugging info for threads we decide not to run;
+    static bool showWaiting;
+
+  public:
+    OSThread(const char *name, uint32_t period = 0, ThreadController *controller = &mainController);
+
+    virtual ~OSThread();
+
+    virtual bool shouldRun(unsigned long time);
+
+    static void setup();
+
+    /**
+     * Wait a specified number msecs starting from the current time (rather than the last time we were run)
+     */
+    void setIntervalFromNow(unsigned long _interval);
+
+  protected:
+    /**
+     * The method that will be called each time our thread gets a chance to run
+     *
+     * Returns desired period for next invocation (or RUN_SAME for no change)
+     */
+    virtual int32_t runOnce() = 0;
+
+    // Do not override this
+    virtual void run();
+};
+
+} // namespace concurrency

src/concurrency/Periodic.h

@@ -1,26 +1,24 @@
 #pragma once
 
-#include "PeriodicTask.h"
+#include "concurrency/OSThread.h"
 
-namespace concurrency {
+namespace concurrency
+{
 
 /**
- * @brief Periodically invoke a callback. This just provides C-style callback conventions 
+ * @brief Periodically invoke a callback. This just provides C-style callback conventions
  *        rather than a virtual function - FIXME, remove?
  */
-class Periodic : public PeriodicTask
+class Periodic : public OSThread
 {
-    uint32_t (*callback)();
+    int32_t (*callback)();
 
   public:
     // callback returns the period for the next callback invocation (or 0 if we should no longer be called)
-    Periodic(uint32_t (*_callback)()) : callback(_callback) {}
+    Periodic(const char *name, int32_t (*_callback)()) : OSThread(name), callback(_callback) {}
 
   protected:
-    void doTask() {
-        uint32_t p = callback();
-        setPeriod(p);
-    }
+    int32_t runOnce() { return callback(); }
 };
 
 } // namespace concurrency

src/concurrency/PeriodicScheduler.cpp

@@ -1,35 +0,0 @@
-#include "PeriodicScheduler.h"
-#include "PeriodicTask.h"
-#include "LockGuard.h"
-#include "../timing.h"
-
-namespace concurrency {
-
-/// call this from loop
-void PeriodicScheduler::loop()
-{
-    LockGuard lg(&lock);
-
-    uint32_t now = timing::millis();
-    for (auto t : tasks) {
-        if (t->period && (now - t->lastMsec) >= t->period) {
-
-            t->doTask();
-            t->lastMsec = now;
-        }
-    }
-}
-
-void PeriodicScheduler::schedule(PeriodicTask *t)
-{
-    LockGuard lg(&lock);
-    tasks.insert(t);
-}
-
-void PeriodicScheduler::unschedule(PeriodicTask *t)
-{
-    LockGuard lg(&lock);
-    tasks.erase(t);
-}
-
-} // namespace concurrency

src/concurrency/PeriodicScheduler.h

@@ -1,40 +0,0 @@
-#pragma once
-
-#include "Lock.h"
-#include <cstdint>
-#include <unordered_set>
-
-namespace concurrency {
-
-class PeriodicTask;
-
-/**
- * @brief Runs all PeriodicTasks in the system. Currently called from main loop() 
- *        but eventually should be its own thread blocked on a freertos timer.
- */
-class PeriodicScheduler
-{
-    friend class PeriodicTask;
-
-    /**
-     * This really should be some form of heap, and when the period gets changed on a task it should get
-     * rescheduled in that heap.  Currently it is just a dumb array and everytime we run loop() we check
-     * _every_ tasks.  If it was a heap we'd only have to check the first task.
-     */
-    std::unordered_set<PeriodicTask *> tasks;
-
-    // Protects the above variables.
-    Lock lock;
-
-  public:
-    /// Run any next tasks which are due for execution
-    void loop();
-
-  private:
-    void schedule(PeriodicTask *t);
-    void unschedule(PeriodicTask *t);
-};
-
-extern PeriodicScheduler periodicScheduler;
-
-} // namespace concurrency

src/concurrency/PeriodicTask.cpp

@@ -1,16 +0,0 @@
-#include "PeriodicTask.h"
-#include "Periodic.h"
-#include "LockGuard.h"
-
-namespace concurrency {
-
-PeriodicScheduler periodicScheduler;
-
-PeriodicTask::PeriodicTask(uint32_t initialPeriod) : period(initialPeriod) {}
-
-void PeriodicTask::setup()
-{
-    periodicScheduler.schedule(this);
-}
-
-} // namespace concurrency

src/concurrency/PeriodicTask.h

@@ -1,56 +0,0 @@
-#pragma once
-
-#include "PeriodicScheduler.h"
-#include "timing.h"
-
-namespace concurrency {
-
-/**
- * @brief A base class for tasks that want their doTask() method invoked periodically
- *
- * @todo currently just syntatic sugar for polling in loop (you must call .loop), but eventually
- *        generalize with the freertos scheduler so we can save lots of power by having everything either in
- *        something like this or triggered off of an irq.
- */
-class PeriodicTask
-{
-    friend class PeriodicScheduler;
-
-    uint32_t lastMsec = 0;
-    uint32_t period = 1; // call soon after creation
-
-  public:
-    virtual ~PeriodicTask() { periodicScheduler.unschedule(this); }
-
-    /**
-     * Constructor (will schedule with the global PeriodicScheduler)
-     */
-    PeriodicTask(uint32_t initialPeriod = 1);
-
-    /** 
-     * MUST be be called once at startup (but after threading is running - i.e. not from a constructor)
-     */
-    void setup();
-
-    /**
-     * Set a new period in msecs (can be called from doTask or elsewhere and the scheduler will cope)
-     * While zero this task is disabled and will not run
-     */
-    void setPeriod(uint32_t p)
-    {
-        lastMsec = timing::millis(); // reset starting from now
-        period = p;
-    }
-
-    uint32_t getPeriod() const { return period; }
-
-    /**
-     * Syntatic sugar for suspending tasks
-     */
-    void disable() { setPeriod(0); }
-
-  protected:
-    virtual void doTask() = 0;
-};
-
-} // namespace concurrency

src/concurrency/Thread.cpp

@@ -1,46 +0,0 @@
-#include "Thread.h"
-#include "timing.h"
-#include <assert.h>
-
-#ifdef ARDUINO_ARCH_ESP32
-#include "esp_task_wdt.h"
-#endif
-
-namespace concurrency
-{
-
-void Thread::start(const char *name, size_t stackSize, uint32_t priority)
-{
-    auto r = xTaskCreate(callRun, name, stackSize, this, priority, &taskHandle);
-    assert(r == pdPASS);
-}
-
-void Thread::callRun(void *_this)
-{
-    ((Thread *)_this)->doRun();
-}
-
-void Thread::serviceWatchdog()
-{
-#ifdef ARDUINO_ARCH_ESP32
-    esp_task_wdt_reset();
-#endif
-}
-
-void Thread::startWatchdog()
-{
-#ifdef ARDUINO_ARCH_ESP32
-    auto r = esp_task_wdt_add(taskHandle);
-    assert(r == ESP_OK);
-#endif
-}
-
-void Thread::stopWatchdog()
-{
-#ifdef ARDUINO_ARCH_ESP32
-    auto r = esp_task_wdt_delete(taskHandle);
-    assert(r == ESP_OK);
-#endif
-}
-
-} // namespace concurrency

src/concurrency/Thread.h

@@ -1,47 +0,0 @@
-#pragma once
-
-#include "freertosinc.h"
-
-namespace concurrency {
-
-/**
- * @brief Base threading
- */
-class Thread
-{
-  protected:
-    TaskHandle_t taskHandle = NULL;
-
-    /**
-     * set this to true to ask thread to cleanly exit asap
-     */
-    volatile bool wantExit = false;
-
-  public:
-    void start(const char *name, size_t stackSize = 1024, uint32_t priority = tskIDLE_PRIORITY);
-
-    virtual ~Thread() { vTaskDelete(taskHandle); }
-
-    uint32_t getStackHighwaterMark() { return uxTaskGetStackHighWaterMark(taskHandle); }
-
-  protected:
-    /**
-     * The method that will be called when start is called.
-     */
-    virtual void doRun() = 0;
-
-    /**
-     * All thread run methods must periodically call serviceWatchdog, or the system will declare them hung and panic.
-     *
-     * this only applies after startWatchdog() has been called.  If you need to sleep for a long time call stopWatchdog()
-     */
-    void serviceWatchdog();
-    void startWatchdog();
-    void stopWatchdog();
-
-  private:
-    static void callRun(void *_this);
-};
-
-
-} // namespace concurrency

src/concurrency/WorkerThread.cpp

@@ -1,32 +0,0 @@
-#include "WorkerThread.h"
-#include "timing.h"
-
-namespace concurrency {
-
-void WorkerThread::doRun()
-{
-    startWatchdog();
-
-    while (!wantExit) {
-        stopWatchdog();
-        block();
-        startWatchdog();
-
-        // no need - startWatchdog is guaranteed to give us one full watchdog interval
-        // serviceWatchdog(); // Let our loop worker have one full watchdog interval (at least) to run
-
-#ifdef DEBUG_STACK
-        static uint32_t lastPrint = 0;
-        if (timing::millis() - lastPrint > 10 * 1000L) {
-            lastPrint = timing::millis();
-            meshtastic::printThreadInfo("net");
-        }
-#endif
-
-        loop();
-    }
-
-    stopWatchdog();
-}
-
-} // namespace concurrency

src/concurrency/WorkerThread.h

@@ -1,29 +0,0 @@
-#pragma once
-
-#include "Thread.h"
-
-namespace concurrency {
-
-/**
- * @brief This wraps threading (FreeRTOS for now) with a blocking API intended for efficiently converting 
- *        old-school arduino loop() code. Use as a mixin base class for the classes you want to convert.
- *
- * @link https://www.freertos.org/RTOS_Task_Notification_As_Mailbox.html
- */
-class WorkerThread : public Thread
-{
-  protected:
-    /**
-     * A method that should block execution - either waiting ona queue/mutex or a "task notification"
-     */
-    virtual void block() = 0;
-
-    virtual void loop() = 0;
-
-    /**
-     * The method that will be called when start is called.
-     */
-    virtual void doRun();
-};
-
-} // namespace concurrency

src/configuration.h

@@ -31,9 +31,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 // If app version is not specified we assume we are not being invoked by the build script
 #ifndef APP_VERSION
-#error APP_VERSION, HW_VERSION, and HW_VERSION_countryname must be set by the build environment
-//#define APP_VERSION 0.0.0   // this def normally comes from build-all.sh
-//#define HW_VERSION 1.0 - US // normally comes from build-all.sh and contains the region code
+#error APP_VERSION must be set by the build environment
+#endif
+
+// If app version is not specified we assume we are not being invoked by the build script
+#ifndef HW_VERSION
+#error HW_VERSION, and HW_VERSION_countryname must be set by the build environment
 #endif
 
 // -----------------------------------------------------------------------------
@@ -55,24 +58,21 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 /// Convert a preprocessor name into a quoted string and if that string is empty use "unset"
 #define optstr(s) (xstr(s)[0] ? xstr(s) : "unset")
 
-#ifdef NRF52_SERIES // All of the NRF52 targets are configured using variant.h, so this section shouldn't need to be
-                    // board specific
+#ifdef PORTDUINO
+
+#define NO_ESP32 // Don't use ESP32 libs (mainly bluetooth)
+
+#elif defined(NRF52_SERIES) // All of the NRF52 targets are configured using variant.h, so this section shouldn't need to be
+// board specific
 
 //
 // Standard definitions for NRF52 targets
 //
 
-// Nop definition for these attributes - not used on NRF52
-#define EXT_RAM_ATTR
-#define IRAM_ATTR
-
 #define NO_ESP32 // Don't use ESP32 libs (mainly bluetooth)
 
 // We bind to the GPS using variant.h instead for this platform (Serial1)
 
-// FIXME, not yet ready for NRF52
-#define RTC_DATA_ATTR
-
 #define LED_PIN PIN_LED1 // LED1 on nrf52840-DK
 
 // If the variant filed defines as standard button
@@ -80,6 +80,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define BUTTON_PIN PIN_BUTTON1
 #endif
 
+#ifdef PIN_BUTTON2
+#define BUTTON_PIN_ALT PIN_BUTTON2
+#endif
+
 // FIXME, use variant.h defs for all of this!!! (even on the ESP32 targets)
 #elif defined(CubeCell_BoardPlus)
 
@@ -89,9 +93,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #define NO_ESP32 // Don't use ESP32 libs (mainly bluetooth)
 
-// FIXME, not yet ready for NRF52
-#define RTC_DATA_ATTR
-
 #define LED_PIN -1 // FIXME totally bogus
 #define BUTTON_PIN -1
 
@@ -101,6 +102,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // Standard definitions for ESP32 targets
 //
 
+#define HAS_WIFI
+
 #define GPS_SERIAL_NUM 1
 #define GPS_RX_PIN 34
 #ifdef USE_JTAG
@@ -123,11 +126,23 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #endif
 
+//
+// Standard definitions for !ESP32 targets
+//
+
+#ifdef NO_ESP32
+// Nop definition for these attributes - not used on NRF52
+#define EXT_RAM_ATTR
+#define IRAM_ATTR
+#define RTC_DATA_ATTR
+#endif
+
 // -----------------------------------------------------------------------------
 // OLED
 // -----------------------------------------------------------------------------
 
 #define SSD1306_ADDRESS 0x3C
+#define ST7567_ADDRESS 0x3F
 
 // The SH1106 controller is almost, but not quite, the same as SSD1306
 // Define this if you know you have that controller or your "SSD1306" misbehaves.
@@ -135,10 +150,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 // Flip the screen upside down by default as it makes more sense on T-BEAM
 // devices. Comment this out to not rotate screen 180 degrees.
-#define FLIP_SCREEN_VERTICALLY
+#define SCREEN_FLIP_VERTICALLY
 
-// DEBUG LED
-#define LED_INVERTED 0 // define as 1 if LED is active low (on)
+// Define if screen should be mirrored left to right
+// #define SCREEN_MIRROR
 
 // -----------------------------------------------------------------------------
 // GPS
@@ -158,6 +173,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define BUTTON_PIN 38     // The middle button GPIO on the T-Beam
 #define BUTTON_PIN_ALT 13 // Alternate GPIO for an external button if needed
 
+#define LED_INVERTED 1
+#define LED_PIN 4 // Newer tbeams (1.1) have an extra led on GPIO4
+
 // TTGO uses a common pinout for their SX1262 vs RF95 modules - both can be enabled and we will probe at runtime for RF95 and if
 // not found then probe for SX1262
 #define USE_RF95
@@ -179,8 +197,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // code)
 #endif
 
-// Leave undefined to disable our PMU IRQ handler
-#define PMU_IRQ 35
+// Leave undefined to disable our PMU IRQ handler.  DO NOT ENABLE THIS because the pmuirq can cause sperious interrupts
+// and waking from light sleep
+// #define PMU_IRQ 35
 #define AXP192_SLAVE_ADDRESS 0x34
 
 #elif defined(TBEAM_V07)
@@ -195,8 +214,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define BUTTON_PIN 39
 #define BATTERY_PIN 35 // A battery voltage measurement pin, voltage divider connected here to measure battery voltage
 
-#define USE_RF95
-
 #define USE_RF95
 #define LORA_DIO0 26 // a No connect on the SX1262 module
 #define LORA_RESET 23
@@ -338,6 +355,29 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #define HW_VENDOR "nrf52unknown" // FIXME - unknown nrf52 board
 
+#elif PORTDUINO
+
+#define HW_VENDOR "portduino"
+
+#define USE_SIM_RADIO
+
+#define USE_RF95
+#define LORA_DIO0 26 // a No connect on the SX1262 module
+#define LORA_RESET 23
+#define LORA_DIO1 33 // Not really used
+#define LORA_DIO2 32 // Not really used
+
+// Fake SPI device selections
+#define RF95_SCK 5
+#define RF95_MISO 19
+#define RF95_MOSI 27
+#define RF95_NSS 18
+
+#endif
+
+// DEBUG LED
+#ifndef LED_INVERTED
+#define LED_INVERTED 0 // define as 1 if LED is active low (on)
 #endif
 
 #ifdef USE_RF95
@@ -367,8 +407,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // Always include the SEGGER code on NRF52 - because useful for debugging
 #include "SEGGER_RTT.h"
 
+// The channel we send stdout data to
+#define SEGGER_STDOUT_CH 0
+
 // Debug printing to segger console
-#define SEGGER_MSG(...) SEGGER_RTT_printf(0, __VA_ARGS__)
+#define SEGGER_MSG(...) SEGGER_RTT_printf(SEGGER_STDOUT_CH, __VA_ARGS__)
 
 // If we are not on a NRF52840 (which has built in USB-ACM serial support) and we don't have serial pins hooked up, then we MUST
 // use SEGGER for debug output
@@ -397,3 +440,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #define GPS_POWER_CTRL_CH 3
 #define LORA_POWER_CTRL_CH 2
+
+// Default Bluetooth PIN
+#define defaultBLEPin 123456

src/esp32/BluetoothSoftwareUpdate.cpp

@@ -1,12 +1,12 @@
 #include <Arduino.h>
 
 #include "../concurrency/LockGuard.h"
-#include "../timing.h"
 #include "BluetoothSoftwareUpdate.h"
 #include "PowerFSM.h"
 #include "RadioLibInterface.h"
 #include "configuration.h"
 #include "nimble/BluetoothUtil.h"
+#include "NodeDB.h"
 
 #include <CRC32.h>
 #include <Update.h>
@@ -17,6 +17,8 @@ static CRC32 crc;
 static uint32_t rebootAtMsec = 0; // If not zero we will reboot at this time (used to reboot shortly after the update completes)
 
 static uint32_t updateExpectedSize, updateActualSize;
+static uint8_t update_result;
+static uint8_t update_region;
 
 static concurrency::Lock *updateLock;
 
@@ -33,8 +35,8 @@ int update_size_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_
         crc.reset();
         if (Update.isRunning())
             Update.abort();
-        bool canBegin = Update.begin(updateExpectedSize);
-        DEBUG_MSG("Setting update size %u, result %d\n", updateExpectedSize, canBegin);
+        bool canBegin = Update.begin(updateExpectedSize, update_region);
+        DEBUG_MSG("Setting region %d update size %u, result %d\n", update_region, updateExpectedSize, canBegin);
         if (!canBegin) {
             // Indicate failure by forcing the size to 0 (client will read it back)
             updateExpectedSize = 0;
@@ -73,13 +75,11 @@ int update_data_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_
     crc.update(data, len);
     Update.write(data, len);
     updateActualSize += len;
-    powerFSM.trigger(EVENT_RECEIVED_TEXT_MSG); // Not exactly correct, but we want to force the device to not sleep now
+    powerFSM.trigger(EVENT_CONTACT_FROM_PHONE);
 
     return 0;
 }
 
-static uint8_t update_result;
-
 /// Handle writes to crc32
 int update_crc32_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_gatt_access_ctxt *ctxt, void *arg)
 {
@@ -101,8 +101,14 @@ int update_crc32_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble
         result = 0xe0; // FIXME, use real error codes
     } else {
         if (Update.end()) {
-            DEBUG_MSG("OTA done, rebooting in 5 seconds!\n");
-            rebootAtMsec = timing::millis() + 5000;
+            if (update_region == U_SPIFFS) {
+                DEBUG_MSG("SPIFFS updated!\n");
+                nodeDB.saveToDisk(); // Since we just wiped spiffs, we need to save our current state
+            }
+            else {
+                DEBUG_MSG("Appload updated, rebooting in 5 seconds!\n");
+                rebootAtMsec = millis() + 5000;
+            }
         } else {
             DEBUG_MSG("Error Occurred. Error #: %d\n", Update.getError());
         }
@@ -126,9 +132,14 @@ int update_result_callback(uint16_t conn_handle, uint16_t attr_handle, struct bl
     return chr_readwrite8(&update_result, sizeof(update_result), ctxt);
 }
 
+int update_region_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_gatt_access_ctxt *ctxt, void *arg)
+{
+    return chr_readwrite8(&update_region, sizeof(update_region), ctxt);
+}
+
 void bluetoothRebootCheck()
 {
-    if (rebootAtMsec && timing::millis() > rebootAtMsec) {
+    if (rebootAtMsec && millis() > rebootAtMsec) {
         DEBUG_MSG("Rebooting for update\n");
         ESP.restart();
     }

src/esp32/BluetoothSoftwareUpdate.h

@@ -14,10 +14,11 @@ int update_size_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_
 int update_data_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_gatt_access_ctxt *ctxt, void *arg);
 int update_result_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_gatt_access_ctxt *ctxt, void *arg);
 int update_crc32_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_gatt_access_ctxt *ctxt, void *arg);
+int update_region_callback(uint16_t conn_handle, uint16_t attr_handle, struct ble_gatt_access_ctxt *ctxt, void *arg);
 
 extern const struct ble_gatt_svc_def gatt_update_svcs[];
 
-extern const ble_uuid128_t update_result_uuid;
+extern const ble_uuid128_t update_result_uuid, update_region_uuid;
 
 extern int16_t updateResultHandle;
 

src/esp32/NimbleSoftwareUpdate.c

@@ -23,6 +23,10 @@ const ble_uuid128_t update_crc32_uuid =
 const ble_uuid128_t update_result_uuid =
     BLE_UUID128_INIT(0x77, 0x2c, 0x43, 0x37, 0x09, 0x21, 0x4a, 0xac, 0x24, 0x44, 0x11, 0x74, 0x62, 0x48, 0x13, 0x5e);
 
+// "5e134862-7411-4424-ac4a-210937432c67" write
+const ble_uuid128_t update_region_uuid =
+    BLE_UUID128_INIT(0x67, 0x2c, 0x43, 0x37, 0x09, 0x21, 0x4a, 0xac, 0x24, 0x44, 0x11, 0x74, 0x62, 0x48, 0x13, 0x5e);
+
 const struct ble_gatt_svc_def gatt_update_svcs[] = {
     {
         /*** Service: Security test. */
@@ -47,9 +51,14 @@ const struct ble_gatt_svc_def gatt_update_svcs[] = {
                                         },
                                         {
                                             .uuid = &update_result_uuid.u,
-                                            .access_cb = update_size_callback,
+                                            .access_cb = update_result_callback,
                                             .flags = BLE_GATT_CHR_F_READ | BLE_GATT_CHR_F_READ_AUTHEN | BLE_GATT_CHR_F_NOTIFY,
                                         },
+                                        {
+                                            .uuid = &update_region_uuid.u,
+                                            .access_cb = update_region_callback,
+                                            .flags = BLE_GATT_CHR_F_WRITE | BLE_GATT_CHR_F_WRITE_AUTHEN,
+                                        },
                                         {
                                             0, /* No more characteristics in this service. */
                                         }},

src/esp32/WiFiServerAPI.cpp

@@ -33,25 +33,36 @@ void WiFiServerAPI::loop()
     if (client.connected()) {
         StreamAPI::loop();
     } else {
-        DEBUG_MSG("Client dropped connection, closing UDP server\n");
+        DEBUG_MSG("Client dropped connection, closing TCP server\n");
         delete this;
     }
 }
 
 #define MESHTASTIC_PORTNUM 4403
 
-WiFiServerPort::WiFiServerPort() : WiFiServer(MESHTASTIC_PORTNUM) {}
+WiFiServerPort::WiFiServerPort() : WiFiServer(MESHTASTIC_PORTNUM), concurrency::OSThread("ApiServer") {}
 
 void WiFiServerPort::init()
 {
-    DEBUG_MSG("Listening on TCP port %d\n", MESHTASTIC_PORTNUM);
+    DEBUG_MSG("API server sistening on TCP port %d\n", MESHTASTIC_PORTNUM);
     begin();
 }
 
-void WiFiServerPort::loop()
+int32_t WiFiServerPort::runOnce()
 {
     auto client = available();
     if (client) {
-        new WiFiServerAPI(client);
+        // Close any previous connection (see FIXME in header file)
+        if (openAPI)
+            delete openAPI;
+
+        openAPI = new WiFiServerAPI(client);
     }
+
+    if (openAPI) {
+        // Allow idle processing so the API can read from its incoming stream
+        openAPI->loop();
+        return 0; // run fast while our API server is running
+    } else
+        return 100; // only check occasionally for incoming connections
 }

src/esp32/WiFiServerAPI.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "StreamAPI.h"
+#include "concurrency/OSThread.h"
 #include <WiFi.h>
 
 /**
@@ -27,12 +28,19 @@ class WiFiServerAPI : public StreamAPI
 /**
  * Listens for incoming connections and does accepts and creates instances of WiFiServerAPI as needed
  */
-class WiFiServerPort : public WiFiServer
+class WiFiServerPort : public WiFiServer, private concurrency::OSThread
 {
+    /** The currently open port
+     *
+     * FIXME: We currently only allow one open TCP connection at a time, because we depend on the loop() call in this class to
+     * delegate to the worker.  Once coroutines are implemented we can relax this restriction.
+     */
+    WiFiServerAPI *openAPI = NULL;
+
   public:
     WiFiServerPort();
 
     void init();
 
-    void loop();
+    int32_t runOnce();
 };

src/esp32/main-esp32.cpp

@@ -9,6 +9,7 @@
 #include "utils.h"
 #include <nvs.h>
 #include <nvs_flash.h>
+#include <driver/rtc_io.h>
 
 void getMacAddr(uint8_t *dmac)
 {
@@ -86,4 +87,58 @@ void esp32Loop()
 
     // for debug printing
     // radio.radioIf.canSleep();
+}
+
+void cpuDeepSleep(uint64_t msecToWake)
+{
+    /*
+    Some ESP32 IOs have internal pullups or pulldowns, which are enabled by default.
+    If an external circuit drives this pin in deep sleep mode, current consumption may
+    increase due to current flowing through these pullups and pulldowns.
+
+    To isolate a pin, preventing extra current draw, call rtc_gpio_isolate() function.
+    For example, on ESP32-WROVER module, GPIO12 is pulled up externally.
+    GPIO12 also has an internal pulldown in the ESP32 chip. This means that in deep sleep,
+    some current will flow through these external and internal resistors, increasing deep
+    sleep current above the minimal possible value.
+
+    Note: we don't isolate pins that are used for the LORA, LED, i2c, spi or the wake button
+    */
+    static const uint8_t rtcGpios[] = {/* 0, */ 2,
+    /* 4, */
+#ifndef USE_JTAG
+                                       13,
+    /* 14, */ /* 15, */
+#endif
+                                       /* 25, */ 26, /* 27, */
+                                       32,           33, 34, 35,
+                                       36,           37
+                                       /* 38, 39 */};
+
+    for (int i = 0; i < sizeof(rtcGpios); i++)
+        rtc_gpio_isolate((gpio_num_t)rtcGpios[i]);
+
+    // FIXME, disable internal rtc pullups/pulldowns on the non isolated pins. for inputs that we aren't using
+    // to detect wake and in normal operation the external part drives them hard.
+
+    // We want RTC peripherals to stay on
+    esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH, ESP_PD_OPTION_ON);
+
+#ifdef BUTTON_PIN
+    // Only GPIOs which are have RTC functionality can be used in this bit map: 0,2,4,12-15,25-27,32-39.
+    uint64_t gpioMask = (1ULL << BUTTON_PIN);
+
+#ifdef BUTTON_NEED_PULLUP
+    gpio_pullup_en((gpio_num_t)BUTTON_PIN);
+#endif
+
+    // Not needed because both of the current boards have external pullups
+    // FIXME change polarity in hw so we can wake on ANY_HIGH instead - that would allow us to use all three buttons (instead of
+    // just the first) gpio_pullup_en((gpio_num_t)BUTTON_PIN);
+
+    esp_sleep_enable_ext1_wakeup(gpioMask, ESP_EXT1_WAKEUP_ALL_LOW);
+#endif
+
+    esp_sleep_enable_timer_wakeup(msecToWake * 1000ULL); // call expects usecs
+    esp_deep_sleep_start();                              // TBD mA sleep current (battery)
 }

src/freertosinc.h

@@ -3,22 +3,32 @@
 // The FreeRTOS includes are in a different directory on ESP32 and I can't figure out how to make that work with platformio gcc
 // options so this is my quick hack to make things work
 
-#ifdef ARDUINO_ARCH_ESP32
+#if defined(ARDUINO_ARCH_ESP32)
 #define HAS_FREE_RTOS
+
 #include <freertos/FreeRTOS.h>
 #include <freertos/queue.h>
 #include <freertos/semphr.h>
 #include <freertos/task.h>
-#else
-// not yet supported on cubecell
-#ifndef CubeCell_BoardPlus
+#endif
+
+#if defined(ARDUINO_NRF52_ADAFRUIT)
 #define HAS_FREE_RTOS
+
 #include <FreeRTOS.h>
 #include <queue.h>
 #include <semphr.h>
 #include <task.h>
+#endif
+
+#ifdef HAS_FREE_RTOS
+
+// Include real FreeRTOS defs above
+
 #else
 
+// Include placeholder fake FreeRTOS defs
+
 #include <Arduino.h>
 
 typedef uint32_t TickType_t;
@@ -26,5 +36,12 @@ typedef uint32_t BaseType_t;
 
 #define portMAX_DELAY UINT32_MAX
 
+#define tskIDLE_PRIORITY 0
+#define configMAX_PRIORITIES 10 // Highest priority level
+
+// Don't do anything on non free rtos platforms when done with the ISR
+#define portYIELD_FROM_ISR(x)
+
+enum eNotifyAction { eNoAction, eSetValueWithoutOverwrite, eSetValueWithOverwrite };
+
 #endif
-#endif

src/gps/Air530GPS.cpp

@@ -0,0 +1,83 @@
+#include "Air530GPS.h"
+#include <assert.h>
+
+/*
+Helpful translations from the Air530 GPS datasheet
+
+Sat acquision mode
+捕获电流值@3.3v 42.6 mA
+
+sat tracking mode
+跟踪电流值@3.3v 36.7 mA
+
+Low power mode
+低功耗模式@3.3V 0.85 mA
+(发送指令:$PGKC051,0)
+
+Super low power mode
+超低功耗模式@3.3V 31 uA
+(发送指令:$PGKC105,4)
+
+To exit sleep use WAKE pin
+
+Commands to enter sleep
+6、Command: 105
+进入周期性低功耗模式
+Arguments:
+
+Arg1: “0”,正常运行模式 (normal mode)
+“1”,周期超低功耗跟踪模式,需要拉高 WAKE 来唤醒 (periodic low power tracking mode - keeps sat positions, use wake to wake up)
+“2”,周期低功耗模式 (periodic low power mode)
+“4”,直接进入超低功耗跟踪模式,需要拉高 WAKE 来唤醒 (super low power consumption mode immediately, need WAKE to resume)
+“8”,自动低功耗模式,可以通过串口唤醒 (automatic low power mode, wake by sending characters to serial port)
+“9”, 自动超低功耗跟踪模式,需要拉高 WAKE 来唤醒 (automatic low power tracking when possible, need wake pin to resume)
+
+(Arg 2 & 3 only valid if Arg1 is "1" or "2")
+Arg2:运行时间(毫秒),在 Arg1 为 1、2 的周期模式下,此参数起作用
+ON time in msecs
+
+Arg3:睡眠时间(毫秒),在 Arg1 为 1、2 的周期模式下,此参数起作用
+Sleep time in msecs
+
+Example:
+$PGKC105,8*3F<CR><LF>
+This will set automatic low power mode with waking when we send chars to the serial port.  Possibly do this as soon as we get a
+new location.  When we wake again in a minute we send a character to wake up.
+
+*/
+
+
+void Air530GPS::sendCommand(const char *cmd) {
+    uint8_t sum = 0;
+
+    // Skip the $
+    assert(cmd[0] == '$');
+    const char *p = cmd + 1;
+    while(*p)
+        sum ^= *p++;
+
+    assert(_serial_gps);
+   
+    _serial_gps->write(cmd);
+    _serial_gps->printf("*%02x\r\n", sum);
+
+    // DEBUG_MSG("xsum %02x\n", sum);
+}
+
+void Air530GPS::sleep() {
+    NMEAGPS::sleep();
+#ifdef PIN_GPS_WAKE
+    sendCommand("$PGKC105,4");
+#endif
+}
+
+/// wake the GPS into normal operation mode
+void Air530GPS::wake()
+{
+#if 1
+    NMEAGPS::wake();
+#else
+    // For power testing - keep GPS sleeping forever
+    sleep();
+#endif
+}

src/gps/Air530GPS.h

@@ -0,0 +1,22 @@
+#pragma once
+
+#include "NMEAGPS.h"
+
+/**
+ * A gps class thatreads from a NMEA GPS stream (and FIXME - eventually keeps the gps powered down except when reading)
+ *
+ * When new data is available it will notify observers.
+ */
+class Air530GPS : public NMEAGPS
+{
+  protected:
+    /// If possible force the GPS into sleep/low power mode
+    virtual void sleep();
+
+    /// wake the GPS into normal operation mode
+    virtual void wake();
+
+  private:
+    /// Send a NMEA cmd with checksum
+    void sendCommand(const char *str);
+};

src/gps/GPS.cpp

@@ -1,15 +1,16 @@
 
 #include "GPS.h"
+#include "NodeDB.h"
+#include "RTC.h"
 #include "configuration.h"
-#include "timing.h"
+#include "sleep.h"
 #include <assert.h>
-#include <time.h>
 
 // If we have a serial GPS port it will not be null
 #ifdef GPS_RX_PIN
 HardwareSerial _serial_gps_real(GPS_SERIAL_NUM);
 HardwareSerial *GPS::_serial_gps = &_serial_gps_real;
-#elif defined(NRF52840_XXAA)
+#elif defined(NRF52840_XXAA) || defined(NRF52833_XXAA)
 // Assume NRF52840
 HardwareSerial *GPS::_serial_gps = &Serial1;
 #else
@@ -22,67 +23,279 @@ uint8_t GPS::i2cAddress = GPS_I2C_ADDRESS;
 uint8_t GPS::i2cAddress = 0;
 #endif
 
-bool timeSetFromGPS; // We try to set our time from GPS each time we wake from sleep
-
 GPS *gps;
 
-// stuff that really should be in in the instance instead...
-static uint32_t
-    timeStartMsec; // Once we have a GPS lock, this is where we hold the initial msec clock that corresponds to that time
-static uint64_t zeroOffsetSecs; // GPS based time in secs since 1970 - only updated once on initial lock
+/// Multiple GPS instances might use the same serial port (in sequence), but we can 
+/// only init that port once.
+static bool didSerialInit;
 
-void readFromRTC()
+bool GPS::setupGPS()
 {
-    struct timeval tv; /* btw settimeofday() is helpfull here too*/
-
-    if (!gettimeofday(&tv, NULL)) {
-        uint32_t now = timing::millis();
-
-        DEBUG_MSG("Read RTC time as %ld (cur millis %u) valid=%d\n", tv.tv_sec, now, timeSetFromGPS);
-        timeStartMsec = now;
-        zeroOffsetSecs = tv.tv_sec;
-    }
-}
-
-/// If we haven't yet set our RTC this boot, set it from a GPS derived time
-void perhapsSetRTC(const struct timeval *tv)
-{
-    if (!timeSetFromGPS) {
-        timeSetFromGPS = true;
-        DEBUG_MSG("Setting RTC %ld secs\n", tv->tv_sec);
-#ifndef NO_ESP32
-        settimeofday(tv, NULL);
+    if (_serial_gps && !didSerialInit) {
+        didSerialInit = true;
+        
+#ifdef GPS_RX_PIN
+        _serial_gps->begin(GPS_BAUDRATE, SERIAL_8N1, GPS_RX_PIN, GPS_TX_PIN);
 #else
-        DEBUG_MSG("ERROR TIME SETTING NOT IMPLEMENTED!\n");
+        _serial_gps->begin(GPS_BAUDRATE);
 #endif
-        readFromRTC();
+#ifndef NO_ESP32
+        _serial_gps->setRxBufferSize(2048); // the default is 256
+#endif
+    }
+
+    return true;
+}
+
+bool GPS::setup()
+{
+    // Master power for the GPS
+#ifdef PIN_GPS_EN
+    digitalWrite(PIN_GPS_EN, PIN_GPS_EN);
+    pinMode(PIN_GPS_EN, OUTPUT);
+#endif
+
+#ifdef PIN_GPS_RESET
+    digitalWrite(PIN_GPS_RESET, 1); // assert for 10ms
+    pinMode(PIN_GPS_RESET, OUTPUT);
+    delay(10);
+    digitalWrite(PIN_GPS_RESET, 0);
+#endif
+
+    setAwake(true); // Wake GPS power before doing any init
+    bool ok = setupGPS();
+
+    if (ok) {
+        notifySleepObserver.observe(&notifySleep);
+        notifyDeepSleepObserver.observe(&notifyDeepSleep);
+    }
+
+    return ok;
+}
+
+// Allow defining the polarity of the WAKE output.  default is active high
+#ifndef GPS_WAKE_ACTIVE
+#define GPS_WAKE_ACTIVE 1
+#endif
+
+void GPS::wake()
+{
+#ifdef PIN_GPS_WAKE
+    digitalWrite(PIN_GPS_WAKE, GPS_WAKE_ACTIVE);
+    pinMode(PIN_GPS_WAKE, OUTPUT);
+#endif
+}
+
+
+void GPS::sleep() {
+#ifdef PIN_GPS_WAKE
+    digitalWrite(PIN_GPS_WAKE, GPS_WAKE_ACTIVE ? 0 : 1);
+    pinMode(PIN_GPS_WAKE, OUTPUT);
+#endif
+}
+
+/// Record that we have a GPS
+void GPS::setConnected()
+{
+    if (!hasGPS) {
+        hasGPS = true;
+        shouldPublish = true;
     }
 }
 
-void perhapsSetRTC(struct tm &t)
+void GPS::setNumSatellites(uint8_t n)
 {
-    /* Convert to unix time
-    The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds that have elapsed since January 1, 1970
-    (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970-01-01T00:00:00Z).
-    */
-    time_t res = mktime(&t);
-    struct timeval tv;
-    tv.tv_sec = res;
-    tv.tv_usec = 0; // time.centisecond() * (10 / 1000);
-
-    // DEBUG_MSG("Got time from GPS month=%d, year=%d, unixtime=%ld\n", t.tm_mon, t.tm_year, tv.tv_sec);
-    if (t.tm_year < 0 || t.tm_year >= 300)
-        DEBUG_MSG("Ignoring invalid GPS month=%d, year=%d, unixtime=%ld\n", t.tm_mon, t.tm_year, tv.tv_sec);
-    else
-        perhapsSetRTC(&tv);
+    if (n != numSatellites) {
+        numSatellites = n;
+        shouldPublish = true;
+    }
 }
 
-uint32_t getTime()
+/**
+ * Switch the GPS into a mode where we are actively looking for a lock, or alternatively switch GPS into a low power mode
+ *
+ * calls sleep/wake
+ */
+void GPS::setAwake(bool on)
 {
-    return ((timing::millis() - timeStartMsec) / 1000) + zeroOffsetSecs;
+    if (!wakeAllowed && on) {
+        DEBUG_MSG("Inhibiting because !wakeAllowed\n");
+        on = false;
+    }
+
+    if (isAwake != on) {
+        DEBUG_MSG("WANT GPS=%d\n", on);
+        if (on) {
+            lastWakeStartMsec = millis();
+            wake();
+        } else {
+            lastSleepStartMsec = millis();
+            sleep();
+        }
+
+        isAwake = on;
+    }
 }
 
-uint32_t getValidTime()
+GpsOperation GPS::getGpsOp() const
 {
-    return timeSetFromGPS ? getTime() : 0;
+    auto op = radioConfig.preferences.gps_operation;
+
+    if (op == GpsOperation_GpsOpUnset)
+        op = (radioConfig.preferences.location_share == LocationSharing_LocDisabled) ? GpsOperation_GpsOpTimeOnly
+                                                                                     : GpsOperation_GpsOpMobile;
+
+    return op;
+}
+
+/** Get how long we should stay looking for each aquisition in msecs
+ */
+uint32_t GPS::getWakeTime() const
+{
+    uint32_t t = radioConfig.preferences.gps_attempt_time;
+
+    if (t == UINT32_MAX)
+        return t; // already maxint
+
+    if (t == 0)
+        t = 15 * 60; // Allow up to 5 mins for each attempt (probably will be much less if we can find sats)
+
+    t *= 1000; // msecs
+
+    return t;
+}
+
+/** Get how long we should sleep between aqusition attempts in msecs
+ */
+uint32_t GPS::getSleepTime() const
+{
+    uint32_t t = radioConfig.preferences.gps_update_interval;
+
+    auto op = getGpsOp();
+    bool gotTime = (getRTCQuality() >= RTCQualityGPS);
+    if ((gotTime && op == GpsOperation_GpsOpTimeOnly) || (op == GpsOperation_GpsOpDisabled))
+        t = UINT32_MAX; // Sleep forever now
+
+    if (t == UINT32_MAX)
+        return t; // already maxint
+
+    if (t == 0)
+        t = 2 * 60; // 2 mins
+
+    t *= 1000;
+
+    return t;
+}
+
+void GPS::publishUpdate()
+{
+    if (shouldPublish) {
+        shouldPublish = false;
+
+        DEBUG_MSG("publishing GPS lock=%d\n", hasLock());
+
+        // Notify any status instances that are observing us
+        const meshtastic::GPSStatus status =
+            meshtastic::GPSStatus(hasLock(), isConnected(), latitude, longitude, altitude, dop, heading, numSatellites);
+        newStatus.notifyObservers(&status);
+    }
+}
+
+int32_t GPS::runOnce()
+{
+    if (whileIdle()) {
+        // if we have received valid NMEA claim we are connected
+        setConnected();
+    }
+
+    // If we are overdue for an update, turn on the GPS and at least publish the current status
+    uint32_t now = millis();
+
+    auto sleepTime = getSleepTime();
+    if (!isAwake && sleepTime != UINT32_MAX && (now - lastSleepStartMsec) > sleepTime) {
+        // We now want to be awake - so wake up the GPS
+        setAwake(true);
+    }
+
+    // While we are awake
+    if (isAwake) {
+        // DEBUG_MSG("looking for location\n");
+        if ((now - lastWhileActiveMsec) > 5000) {
+            lastWhileActiveMsec = now;
+            whileActive();
+        }
+
+        // If we've already set time from the GPS, no need to ask the GPS
+        bool gotTime = (getRTCQuality() >= RTCQualityGPS);
+        if (!gotTime && lookForTime()) { // Note: we count on this && short-circuiting and not resetting the RTC time
+            gotTime = true;
+            shouldPublish = true;
+        }
+
+        bool gotLoc = lookForLocation();
+        if (gotLoc && !hasValidLocation) { // declare that we have location ASAP
+            hasValidLocation = true;
+            shouldPublish = true;
+        }
+
+        // We've been awake too long - force sleep
+        auto wakeTime = getWakeTime();
+        bool tooLong = wakeTime != UINT32_MAX && (now - lastWakeStartMsec) > wakeTime;
+
+        // Once we get a location we no longer desperately want an update
+        // or if we got a time and we are in GpsOpTimeOnly mode
+        // DEBUG_MSG("gotLoc %d, tooLong %d, gotTime %d\n", gotLoc, tooLong, gotTime);
+        if ((gotLoc && gotTime) || tooLong || (gotTime && getGpsOp() == GpsOperation_GpsOpTimeOnly)) {
+
+            if (tooLong) {
+                // we didn't get a location during this ack window, therefore declare loss of lock
+                hasValidLocation = false;
+            }
+
+            setAwake(false);
+            shouldPublish = true; // publish our update for this just finished acquisition window
+        }
+    }
+
+    // If state has changed do a publish
+    publishUpdate();
+
+    // 9600bps is approx 1 byte per msec, so considering our buffer size we never need to wake more often than 200ms
+    // if not awake we can run super infrquently (once every 5 secs?) to see if we need to wake.
+    return isAwake ? 100 : 5000;
+}
+
+void GPS::forceWake(bool on)
+{
+    if (on) {
+        DEBUG_MSG("Allowing GPS lock\n");
+        // lastSleepStartMsec = 0; // Force an update ASAP
+        wakeAllowed = true;
+    } else {
+        wakeAllowed = false;
+
+        // Note: if the gps was already awake, we DO NOT shut it down, because we want to allow it to complete its lock
+        // attempt even if we are in light sleep.  Once the attempt succeeds (or times out) we'll then shut it down.
+        // setAwake(false);
+    }
+}
+
+/// Prepare the GPS for the cpu entering deep or light sleep, expect to be gone for at least 100s of msecs
+int GPS::prepareSleep(void *unused)
+{
+    DEBUG_MSG("GPS prepare sleep!\n");
+    forceWake(false);
+
+    return 0;
+}
+
+/// Prepare the GPS for the cpu entering deep or light sleep, expect to be gone for at least 100s of msecs
+int GPS::prepareDeepSleep(void *unused)
+{
+    DEBUG_MSG("GPS deep sleep!\n");
+
+    // For deep sleep we also want abandon any lock attempts (because we want minimum power)
+    setAwake(false);
+
+    return 0;
 }

src/gps/GPS.h

@@ -1,35 +1,37 @@
 #pragma once
 
-#include "../concurrency/PeriodicTask.h"
 #include "GPSStatus.h"
 #include "Observer.h"
-#include "sys/time.h"
-
-/// If we haven't yet set our RTC this boot, set it from a GPS derived time
-void perhapsSetRTC(const struct timeval *tv);
-void perhapsSetRTC(struct tm &t);
+#include "concurrency/OSThread.h"
 
 // Generate a string representation of DOP
 const char *getDOPString(uint32_t dop);
 
-/// Return time since 1970 in secs.  Until we have a GPS lock we will be returning time based at zero
-uint32_t getTime();
-
-/// Return time since 1970 in secs.  If we don't have a GPS lock return zero
-uint32_t getValidTime();
-
-void readFromRTC();
-
 /**
  * A gps class that only reads from the GPS periodically (and FIXME - eventually keeps the gps powered down except when reading)
  *
  * When new data is available it will notify observers.
  */
-class GPS
+class GPS : private concurrency::OSThread
 {
-  protected:
+  private:
+    uint32_t lastWakeStartMsec = 0, lastSleepStartMsec = 0, lastWhileActiveMsec = 0;
+
     bool hasValidLocation = false; // default to false, until we complete our first read
 
+    bool isAwake = false; // true if we want a location right now
+
+    bool wakeAllowed = true; // false if gps must be forced to sleep regardless of what time it is
+
+    bool shouldPublish = false; // If we've changed GPS state, this will force a publish the next loop()
+
+    bool hasGPS = false; // Do we have a GPS we are talking to
+
+    uint8_t numSatellites = 0;
+
+    CallbackObserver<GPS, void *> notifySleepObserver = CallbackObserver<GPS, void *>(this, &GPS::prepareSleep);
+    CallbackObserver<GPS, void *> notifyDeepSleepObserver = CallbackObserver<GPS, void *>(this, &GPS::prepareDeepSleep);
+
   public:
     /** If !NULL we will use this serial port to construct our GPS */
     static HardwareSerial *_serial_gps;
@@ -42,11 +44,10 @@ class GPS
     uint32_t dop = 0;     // Diminution of position; PDOP where possible (UBlox), HDOP otherwise (TinyGPS) in 10^2 units (needs
                           // scaling before use)
     uint32_t heading = 0; // Heading of motion, in degrees * 10^-5
-    uint32_t numSatellites = 0;
 
-    bool isConnected = false; // Do we have a GPS we are talking to
+    GPS() : concurrency::OSThread("GPS") {}
 
-    virtual ~GPS() {}
+    virtual ~GPS() {} // FIXME, we really should unregister our sleep observer
 
     /** We will notify this observable anytime GPS state has changed meaningfully */
     Observable<const meshtastic::GPSStatus *> newStatus;
@@ -54,18 +55,94 @@ class GPS
     /**
      * Returns true if we succeeded
      */
-    virtual bool setup() { return true; }
-
-    /// A loop callback for subclasses that need it.  FIXME, instead just block on serial reads
-    virtual void loop() {}
+    virtual bool setup();
 
     /// Returns ture if we have acquired GPS lock.
     bool hasLock() const { return hasValidLocation; }
 
+    /// Return true if we are connected to a GPS
+    bool isConnected() const { return hasGPS; }
+
     /**
      * Restart our lock attempt - try to get and broadcast a GPS reading ASAP
-     * called after the CPU wakes from light-sleep state */
-    virtual void startLock() {}
+     * called after the CPU wakes from light-sleep state
+     *
+     * Or set to false, to disallow any sort of waking
+     * */
+    void forceWake(bool on);
+
+  protected:
+    /// Do gps chipset specific init, return true for success
+    virtual bool setupGPS();
+
+    /// If possible force the GPS into sleep/low power mode
+    virtual void sleep();
+
+    /// wake the GPS into normal operation mode
+    virtual void wake();
+
+    /** Subclasses should look for serial rx characters here and feed it to their GPS parser
+     *
+     * Return true if we received a valid message from the GPS
+     */
+    virtual bool whileIdle() = 0;
+
+    /** Idle processing while GPS is looking for lock, called once per secondish */
+    virtual void whileActive() {}
+
+    /**
+     * Perform any processing that should be done only while the GPS is awake and looking for a fix.
+     * Override this method to check for new locations
+     *
+     * @return true if we've acquired a time
+     */
+    virtual bool lookForTime() = 0;
+
+    /**
+     * Perform any processing that should be done only while the GPS is awake and looking for a fix.
+     * Override this method to check for new locations
+     *
+     * @return true if we've acquired a new location
+     */
+    virtual bool lookForLocation() = 0;
+
+    /// Record that we have a GPS
+    void setConnected();
+
+    void setNumSatellites(uint8_t n);
+
+  private:
+    /// Prepare the GPS for the cpu entering deep or light sleep, expect to be gone for at least 100s of msecs
+    /// always returns 0 to indicate okay to sleep
+    int prepareSleep(void *unused);
+
+    /// Prepare the GPS for the cpu entering deep sleep, expect to be gone for at least 100s of msecs
+    /// always returns 0 to indicate okay to sleep
+    int prepareDeepSleep(void *unused);
+
+    /**
+     * Switch the GPS into a mode where we are actively looking for a lock, or alternatively switch GPS into a low power mode
+     *
+     * calls sleep/wake
+     */
+    void setAwake(bool on);
+
+    /** Get how long we should stay looking for each aquisition
+     */
+    uint32_t getWakeTime() const;
+
+    /** Get how long we should sleep between aqusition attempts
+     */
+    uint32_t getSleepTime() const;
+
+    GpsOperation getGpsOp() const;
+
+    /**
+     * Tell users we have new GPS readings
+     */
+    void publishUpdate();
+
+    virtual int32_t runOnce();
 };
 
 extern GPS *gps;

src/gps/NEMAGPS.cpp

@@ -1,75 +0,0 @@
-#include "NEMAGPS.h"
-#include "configuration.h"
-#include "timing.h"
-
-static int32_t toDegInt(RawDegrees d)
-{
-    int32_t degMult = 10000000; // 1e7
-    int32_t r = d.deg * degMult + d.billionths / 100;
-    if (d.negative)
-        r *= -1;
-    return r;
-}
-
-void NEMAGPS::loop()
-{
-    while (_serial_gps->available() > 0) {
-        int c = _serial_gps->read();
-        // Serial.write(c);
-        reader.encode(c);
-    }
-
-    uint32_t now = timing::millis();
-    if ((now - lastUpdateMsec) > 20 * 1000) { // Ugly hack for now - limit update checks to once every 20 secs (but still consume
-                                              // serial chars at whatever rate)
-        lastUpdateMsec = now;
-
-        auto ti = reader.time;
-        auto d = reader.date;
-        if (ti.isUpdated() && ti.isValid() && d.isValid()) {
-            /* Convert to unix time
-    The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds that have elapsed since January 1, 1970
-    (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970-01-01T00:00:00Z).
-    */
-            struct tm t;
-            t.tm_sec = ti.second();
-            t.tm_min = ti.minute();
-            t.tm_hour = ti.hour();
-            t.tm_mday = d.day();
-            t.tm_mon = d.month() - 1;
-            t.tm_year = d.year() - 1900;
-            t.tm_isdst = false;
-            perhapsSetRTC(t);
-
-            isConnected = true; // we seem to have a real GPS (but not necessarily a lock)
-        }
-
-        if (reader.location.isUpdated()) {
-            if (reader.altitude.isValid())
-                altitude = reader.altitude.meters();
-
-            if (reader.location.isValid()) {
-                auto loc = reader.location.value();
-                latitude = toDegInt(loc.lat);
-                longitude = toDegInt(loc.lng);
-            }
-            // Diminution of precision (an accuracy metric) is reported in 10^2 units, so we need to scale down when we use it
-            if (reader.hdop.isValid()) {
-                dop = reader.hdop.value();
-            }
-            if (reader.course.isValid()) {
-                heading = reader.course.value() * 1e3;  //Scale the heading (in degrees * 10^-2) to match the expected degrees * 10^-5
-            }
-            if (reader.satellites.isValid()) {
-                numSatellites = reader.satellites.value();
-            }
-
-            // expect gps pos lat=37.520825, lon=-122.309162, alt=158
-            DEBUG_MSG("new NEMA GPS pos lat=%f, lon=%f, alt=%d, hdop=%f, heading=%f\n", latitude * 1e-7, longitude * 1e-7, altitude, dop * 1e-2, heading * 1e-5);
-        }
-
-        // Notify any status instances that are observing us
-        const meshtastic::GPSStatus status = meshtastic::GPSStatus(hasLock(), isConnected, latitude, longitude, altitude, dop, heading, numSatellites);
-        newStatus.notifyObservers(&status);
-    }
-}

src/gps/NEMAGPS.h

@@ -1,21 +0,0 @@
-#pragma once
-
-#include "GPS.h"
-#include "Observer.h"
-#include "../concurrency/PeriodicTask.h"
-#include "TinyGPS++.h"
-
-/**
- * A gps class thatreads from a NEMA GPS stream (and FIXME - eventually keeps the gps powered down except when reading)
- *
- * When new data is available it will notify observers.
- */
-class NEMAGPS : public GPS
-{
-    TinyGPSPlus reader;
-    
-    uint32_t lastUpdateMsec = 0;
-
-  public:
-    virtual void loop();
-};

src/gps/NMEAGPS.cpp

@@ -0,0 +1,112 @@
+#include "NMEAGPS.h"
+#include "RTC.h"
+#include "configuration.h"
+
+static int32_t toDegInt(RawDegrees d)
+{
+    int32_t degMult = 10000000; // 1e7
+    int32_t r = d.deg * degMult + d.billionths / 100;
+    if (d.negative)
+        r *= -1;
+    return r;
+}
+
+bool NMEAGPS::setupGPS()
+{
+    GPS::setupGPS();
+    
+#ifdef PIN_GPS_PPS
+    // pulse per second
+    // FIXME - move into shared GPS code
+    pinMode(PIN_GPS_PPS, INPUT);
+#endif
+
+    return true;
+}
+
+/**
+ * Perform any processing that should be done only while the GPS is awake and looking for a fix.
+ * Override this method to check for new locations
+ *
+ * @return true if we've acquired a new location
+ */
+bool NMEAGPS::lookForTime()
+{
+    auto ti = reader.time;
+    auto d = reader.date;
+    if (ti.isValid() && d.isValid()) { // Note: we don't check for updated, because we'll only be called if needed
+        /* Convert to unix time
+The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds that have elapsed since January 1, 1970
+(midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970-01-01T00:00:00Z).
+*/
+        struct tm t;
+        t.tm_sec = ti.second();
+        t.tm_min = ti.minute();
+        t.tm_hour = ti.hour();
+        t.tm_mday = d.day();
+        t.tm_mon = d.month() - 1;
+        t.tm_year = d.year() - 1900;
+        t.tm_isdst = false;
+        perhapsSetRTC(RTCQualityGPS, t);
+
+        return true;
+    } else
+        return false;
+}
+
+/**
+ * Perform any processing that should be done only while the GPS is awake and looking for a fix.
+ * Override this method to check for new locations
+ *
+ * @return true if we've acquired a new location
+ */
+bool NMEAGPS::lookForLocation()
+{
+    bool foundLocation = false;
+
+    // uint8_t fixtype = reader.fixQuality();
+    // hasValidLocation = ((fixtype >= 1) && (fixtype <= 5));
+
+    if (reader.satellites.isUpdated()) {
+        setNumSatellites(reader.satellites.value());
+    }
+
+    // Diminution of precision (an accuracy metric) is reported in 10^2 units, so we need to scale down when we use it
+    if (reader.hdop.isUpdated()) {
+        dop = reader.hdop.value();
+    }
+    if (reader.course.isUpdated()) {
+        heading = reader.course.value() * 1e3; // Scale the heading (in degrees * 10^-2) to match the expected degrees * 10^-5
+    }
+
+    if (reader.altitude.isUpdated())
+        altitude = reader.altitude.meters();
+
+    if (reader.location.isUpdated()) {
+
+        auto loc = reader.location.value();
+        latitude = toDegInt(loc.lat);
+        longitude = toDegInt(loc.lng);
+        foundLocation = true;
+
+        // expect gps pos lat=37.520825, lon=-122.309162, alt=158
+        DEBUG_MSG("new NMEA GPS pos lat=%f, lon=%f, alt=%d, hdop=%g, heading=%f\n", latitude * 1e-7, longitude * 1e-7, altitude,
+                  dop * 1e-2, heading * 1e-5);
+    }
+
+    return foundLocation;
+}
+
+bool NMEAGPS::whileIdle()
+{
+    bool isValid = false;
+
+    // First consume any chars that have piled up at the receiver
+    while (_serial_gps->available() > 0) {
+        int c = _serial_gps->read();
+        // DEBUG_MSG("%c", c);
+        isValid |= reader.encode(c);
+    }
+
+    return isValid;
+}

src/gps/NMEAGPS.h

@@ -0,0 +1,41 @@
+#pragma once
+
+#include "GPS.h"
+#include "Observer.h"
+#include "TinyGPS++.h"
+
+/**
+ * A gps class thatreads from a NMEA GPS stream (and FIXME - eventually keeps the gps powered down except when reading)
+ *
+ * When new data is available it will notify observers.
+ */
+class NMEAGPS : public GPS
+{
+    TinyGPSPlus reader;
+
+  public:
+    virtual bool setupGPS();
+
+  protected:
+    /** Subclasses should look for serial rx characters here and feed it to their GPS parser
+     * 
+     * Return true if we received a valid message from the GPS
+    */
+    virtual bool whileIdle();
+
+    /**
+     * Perform any processing that should be done only while the GPS is awake and looking for a fix.
+     * Override this method to check for new locations
+     *
+     * @return true if we've acquired a time
+     */
+    virtual bool lookForTime();
+
+    /**
+     * Perform any processing that should be done only while the GPS is awake and looking for a fix.
+     * Override this method to check for new locations
+     *
+     * @return true if we've acquired a new location
+     */
+    virtual bool lookForLocation();
+};

src/gps/RTC.cpp

@@ -0,0 +1,77 @@
+#include "RTC.h"
+#include "configuration.h"
+#include <sys/time.h>
+#include <time.h>
+
+static RTCQuality currentQuality = RTCQualityNone;
+
+RTCQuality getRTCQuality()
+{
+    return currentQuality;
+}
+
+// stuff that really should be in in the instance instead...
+static uint32_t
+    timeStartMsec; // Once we have a GPS lock, this is where we hold the initial msec clock that corresponds to that time
+static uint64_t zeroOffsetSecs; // GPS based time in secs since 1970 - only updated once on initial lock
+
+void readFromRTC()
+{
+    struct timeval tv; /* btw settimeofday() is helpfull here too*/
+
+    if (!gettimeofday(&tv, NULL)) {
+        uint32_t now = millis();
+
+        DEBUG_MSG("Read RTC time as %ld (cur millis %u) quality=%d\n", tv.tv_sec, now, currentQuality);
+        timeStartMsec = now;
+        zeroOffsetSecs = tv.tv_sec;
+    }
+}
+
+/// If we haven't yet set our RTC this boot, set it from a GPS derived time
+bool perhapsSetRTC(RTCQuality q, const struct timeval *tv)
+{
+    if (q > currentQuality) {
+        currentQuality = q;
+        DEBUG_MSG("Setting RTC %ld secs\n", tv->tv_sec);
+#ifndef NO_ESP32
+        settimeofday(tv, NULL);
+#else
+        DEBUG_MSG("ERROR TIME SETTING NOT IMPLEMENTED!\n");
+#endif
+        readFromRTC();
+        return true;
+    } else {
+        return false;
+    }
+}
+
+bool perhapsSetRTC(RTCQuality q, struct tm &t)
+{
+    /* Convert to unix time
+    The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds that have elapsed since January 1, 1970
+    (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970-01-01T00:00:00Z).
+    */
+    time_t res = mktime(&t);
+    struct timeval tv;
+    tv.tv_sec = res;
+    tv.tv_usec = 0; // time.centisecond() * (10 / 1000);
+
+    // DEBUG_MSG("Got time from GPS month=%d, year=%d, unixtime=%ld\n", t.tm_mon, t.tm_year, tv.tv_sec);
+    if (t.tm_year < 0 || t.tm_year >= 300) {
+        // DEBUG_MSG("Ignoring invalid GPS month=%d, year=%d, unixtime=%ld\n", t.tm_mon, t.tm_year, tv.tv_sec);
+        return false;
+    } else {
+        return perhapsSetRTC(q, &tv);
+    }
+}
+
+uint32_t getTime()
+{
+    return ((millis() - timeStartMsec) / 1000) + zeroOffsetSecs;
+}
+
+uint32_t getValidTime(RTCQuality minQuality)
+{
+    return (currentQuality >= minQuality) ? getTime() : 0;
+}