remove ci setup

Rak

.github/actions/initbuild/action.yml

@@ -0,0 +1,38 @@
+name: 'Common init'
+
+# WARNING due to https://github.com/actions/runner/issues/646
+# this code can't work - must copy and paste into workflows for now because 'uses' is not supported
+runs:
+  using: "composite"
+  steps:
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.x
+
+    - name: Cache python libs
+      uses: actions/cache@v1
+      id: cache-pip # needed in if test
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip
+
+    - name: Upgrade python tools
+      # We actually want to run this every time
+      # if: steps.cache-pip.outputs.cache-hit != 'true'
+      run: |
+        python -m pip install --upgrade pip
+        pip install -U platformio meshtastic adafruit-nrfutil
+
+    - name: Cache platformio
+      uses: actions/cache@v1
+      id: cache-platformio # needed in if test
+      with:
+        path: ~/.platformio
+        key: ${{ runner.os }}-platformio
+
+    - name: Upgrade platformio
+      run: |
+        pio upgrade
+
+

.github/pull_request_template.md

@@ -7,7 +7,7 @@
   is appreciated." This will allow other devs to potentially save you time by not accidentially duplicating work etc...
 - Please do not check in files that don't have real changes
 - Please do not reformat lines that you didn't have to change the code on
-- We recommend using the [Visual Studio Code](https://platformio.org/install/ide?install=vscode) editor,
+- We recommend using the [Visual Studio Code](https://platformio.org/install/ide?install=vscode) editor and the 'clang-format' extension,
   because automatically follows our indentation rules and it's auto reformatting will not cause spurious changes to lines.
 - If your PR fixes a bug, mention "fixes #bugnum" somewhere in your pull request description.
 - If your other co-developers have comments on your PR please tweak as needed.

.github/workflows/main.yml

@@ -1,34 +1,82 @@
 name: Continuous Integration
 on:
-  - push
-  - pull_request
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
 
 jobs:
-  setup:
+  # setup:
+  # runs-on: ubuntu-latest
+  # steps:
+  
+  # - name: Startup
+  #   run: echo "No action setup currently needed, skipping..."
+
+  build:
+    # needs: setup
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
-      - name: Checkout submodules
-        uses: textbook/git-checkout-submodule-action@master
-      - name: Setup Python
-        uses: actions/setup-python@master
-        with:
-          python-version: 3.x
-      - name: Install Platform IO
-        run: |
-          python -m pip install --upgrade pip
-          pip install -U platformio
-      - name: Install extra python tools
-        run: |
-          pip install -U adafruit-nrfutil
-      - name: Install libs needed for linux build
-        run: |
-          sudo apt install -y libpsocksxx-dev
-      - name: Build for tbeam
-        run: platformio run -e tbeam
-      - name: Build for heltec
-        run: platformio run -e heltec
-      - name: Build for lora-relay-v1
-        run: platformio run -e lora-relay-v1 
-      - name: Build for linux
-        run: platformio run -e linux
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.x
+
+    - name: Cache python libs
+      uses: actions/cache@v1
+      id: cache-pip # needed in if test
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip
+
+    - name: Upgrade python tools
+      # We actually want to run this every time
+      # if: steps.cache-pip.outputs.cache-hit != 'true'
+      run: |
+        python -m pip install --upgrade pip
+        pip install -U platformio meshtastic adafruit-nrfutil
+
+    - name: Cache platformio
+      uses: actions/cache@v1
+      id: cache-platformio # needed in if test
+      with:
+        path: ~/.platformio
+        key: ${{ runner.os }}-platformio
+
+    - name: Upgrade platformio
+      run: |
+        pio upgrade
+
+    # We now run integration test before other build steps (to quickly see runtime failures)
+    - name: Build for native
+      run: platformio run -e native
+    - name: Integration test
+      run: |
+        .pio/build/native/program &
+        sleep 20 # 5 seconds was not enough
+        echo "Simulator started, launching python test..."
+        python3 -c 'from meshtastic.test import testSimulator; testSimulator()'
+
+    # - name: Build for tbeam
+    #   run: platformio run -e tbeam
+    # - name: Build for heltec
+    #   run: platformio run -e heltec
+    # - name: Build for wisblock RAK4631
+    #   run: platformio run -e rak4631
+
+    - name: Build everything
+      run: bin/build-all.sh
+
+    - name: Store release zip as an artifact
+      uses: actions/upload-artifact@v2
+      with:
+        name: built
+        path: release/archive/firmware-*.zip
+        retention-days: 30

.github/workflows/release.yml

@@ -0,0 +1,80 @@
+name: Make Release
+on:
+  # Can optionally take parameters from the github UI, more info here https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/#:~:text=You%20can%20now%20create%20workflows,the%20workflow%20is%20run%20on.
+  # workflow_dispatch:
+  #  inputs:
+
+  # Only want to be run if a new tag starting with v is pushed.
+  push:
+    branches:
+      - "!*"
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        submodules: 'recursive'
+
+    # get github branch and tag names as ${{ steps.branch_name.outputs.SOURCE_TAG }}
+    - name: Branch name
+      id: branch_name
+      run: |
+        echo ::set-output name=SOURCE_NAME::${GITHUB_REF#refs/*/}
+        echo ::set-output name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
+        echo ::set-output name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
+
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.x
+
+    # Note: we don't use caches on release builds because we don't want to accidentally not have a virgin build machine
+
+    - name: Upgrade python tools
+      # We actually want to run this every time
+      # if: steps.cache-pip.outputs.cache-hit != 'true'
+      run: |
+        python -m pip install --upgrade pip
+        pip install -U platformio meshtastic adafruit-nrfutil
+
+    - name: Upgrade platformio
+      run: |
+        pio upgrade
+
+    # Will be available in steps.version.outputs.version
+    - name: Get version string
+      run: echo "::set-output name=version::$(./bin/buildinfo.py)"
+      id: version
+
+    - name: Build everything
+      run: bin/build-all.sh
+
+    - name: Create release
+      uses: actions/create-release@v1
+      id: create_release
+      with:
+        draft: true
+        prerelease: true
+        release_name: ${{ steps.version.outputs.version }} alpha
+        tag_name: ${{ steps.branch_name.outputs.SOURCE_TAG }}
+        # was ${{ github.ref }}
+        body: |
+          Autogenerated by github action, developer should edit as required before publishing...
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+
+    - name: Add artifact to release
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: release/archive/firmware-${{ steps.version.outputs.version }}.zip
+        asset_name: firmware-${{ steps.version.outputs.version }}.zip
+        asset_content_type: application/zip

.gitignore

@@ -15,7 +15,8 @@ Thumbs.db
 .built
 .context
 .cproject
-.idea/*
 .vagrant
 nanopb*
 flash.uf2
+cmake-build*
+__pycache__

.idea/codeStyles/Project.xml

@@ -0,0 +1,7 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <clangFormatSettings>
+      <option name="ENABLED" value="true" />
+    </clangFormatSettings>
+  </code_scheme>
+</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

.idea/meshtastic-esp32.iml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module classpath="CMake" type="CPP_MODULE" version="4" />

.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CMakeWorkspace" PROJECT_DIR="$PROJECT_DIR$" />
+</project>

.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/meshtastic-esp32.iml" filepath="$PROJECT_DIR$/.idea/meshtastic-esp32.iml" />
+    </modules>
+  </component>
+</project>

.idea/vcs.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/design" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/proto" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/sdk-nrfxlib" vcs="Git" />
+  </component>
+</project>

.idea/workspace.xml

@@ -0,0 +1,162 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CMakeRunConfigurationManager" shouldGenerate="true" shouldDeleteObsolete="true">
+    <generated>
+      <config projectName="meshtastic-esp32" targetName="Debug" />
+      <config projectName="meshtastic-esp32" targetName="Production" />
+      <config projectName="meshtastic-esp32" targetName="Z_DUMMY_TARGET" />
+    </generated>
+  </component>
+  <component name="CMakeSettings">
+    <configurations>
+      <configuration PROFILE_NAME="native" CONFIG_NAME="native" ENABLED="true" />
+    </configurations>
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="58922733-b05b-4b90-9655-b9b18914977a" name="Default Changelist" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="ProjectId" id="1pmWHw2wau2TbdKvXvmQUB0EUE9" />
+  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">
+    <property name="ASKED_ADD_EXTERNAL_FILES" value="true" />
+    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
+    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
+    <property name="WebServerToolWindowFactoryState" value="false" />
+    <property name="cf.advertisement.text.overridden" value="true" />
+    <property name="cf.first.check.clang-format" value="false" />
+    <property name="node.js.detected.package.eslint" value="true" />
+    <property name="node.js.detected.package.tslint" value="true" />
+    <property name="node.js.path.for.package.eslint" value="project" />
+    <property name="node.js.path.for.package.tslint" value="project" />
+    <property name="node.js.selected.package.eslint" value="(autodetect)" />
+    <property name="node.js.selected.package.tslint" value="(autodetect)" />
+    <property name="settings.editor.selected.configurable" value="CMakeSettings" />
+  </component>
+  <component name="RunManager" selected="GDB Remote Debug.gdbremote-localhost-2345">
+    <configuration default="true" type="CLion_Remote" version="1" remoteCommand="tcp:localhost:2345" symbolFile="" sysroot="">
+      <debugger kind="GDB" isBundled="true" />
+      <method v="2" />
+    </configuration>
+    <configuration name="gdbremote-localhost-2345" type="CLion_Remote" version="1" remoteCommand="tcp:localhost:2345" symbolFile="" sysroot="">
+      <debugger kind="GDB" isBundled="true" />
+      <method v="2" />
+    </configuration>
+    <configuration name="Z_DUMMY_TARGET" type="CMakeRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="meshtastic-esp32" TARGET_NAME="Z_DUMMY_TARGET" CONFIG_NAME="native" RUN_TARGET_PROJECT_NAME="meshtastic-esp32" RUN_TARGET_NAME="Z_DUMMY_TARGET">
+      <method v="2">
+        <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+      </method>
+    </configuration>
+    <configuration default="true" type="GradleAppRunConfiguration" factoryName="Application" REDIRECT_INPUT="false" ELEVATE="false" PASS_PARENT_ENVS_2="true">
+      <method v="2">
+        <option name="com.jetbrains.cidr.cpp.gradle.execution.GradleNativeBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+      </method>
+    </configuration>
+    <configuration name="PlatformIO Debug" type="platformio" factoryName="PlatformIO Debug" REDIRECT_INPUT="false" ELEVATE="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="meshtastic-esp32" TARGET_NAME="Debug" CONFIG_NAME="native" RUN_TARGET_PROJECT_NAME="meshtastic-esp32" RUN_TARGET_NAME="Debug">
+      <method v="2">
+        <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+      </method>
+    </configuration>
+    <configuration name="PlatformIO Upload" type="platformio" factoryName="PlatformIO Upload" REDIRECT_INPUT="false" ELEVATE="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="meshtastic-esp32" TARGET_NAME="Production" CONFIG_NAME="native" RUN_TARGET_PROJECT_NAME="meshtastic-esp32" RUN_TARGET_NAME="Production">
+      <method v="2">
+        <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+      </method>
+    </configuration>
+    <list>
+      <item itemvalue="CMake Application.Z_DUMMY_TARGET" />
+      <item itemvalue="GDB Remote Debug.gdbremote-localhost-2345" />
+      <item itemvalue="PlatformIO.PlatformIO Debug" />
+      <item itemvalue="PlatformIO.PlatformIO Upload" />
+    </list>
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="58922733-b05b-4b90-9655-b9b18914977a" name="Default Changelist" comment="" />
+      <created>1615788661896</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1615788661896</updated>
+      <workItem from="1615788663210" duration="6661000" />
+      <workItem from="1615938346019" duration="1208000" />
+      <workItem from="1615971126983" duration="5945000" />
+      <workItem from="1617115374907" duration="357000" />
+      <workItem from="1617115747078" duration="1391000" />
+      <workItem from="1617117632667" duration="307000" />
+      <workItem from="1617160691713" duration="1016000" />
+      <workItem from="1617279002260" duration="1626000" />
+      <workItem from="1617425689081" duration="1896000" />
+      <workItem from="1617437366919" duration="1182000" />
+      <workItem from="1618544034975" duration="1185000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State />
+          </value>
+        </entry>
+      </map>
+    </option>
+    <option name="oldMeFiltersMigrated" value="true" />
+  </component>
+  <component name="XDebuggerManager">
+    <breakpoint-manager>
+      <breakpoints>
+        <line-breakpoint enabled="true" type="com.jetbrains.cidr.execution.debugger.OCBreakpointType">
+          <url>file://$PROJECT_DIR$/src/mesh/wifi/WiFiServerAPI.cpp</url>
+          <line>53</line>
+          <option name="timeStamp" value="6" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" type="com.jetbrains.cidr.execution.debugger.OCBreakpointType">
+          <url>file://$PROJECT_DIR$/src/mesh/wifi/WiFiServerAPI.cpp</url>
+          <line>37</line>
+          <option name="timeStamp" value="7" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" type="com.jetbrains.cidr.execution.debugger.OCBreakpointType">
+          <url>file://$PROJECT_DIR$/src/mqtt/MQTT.cpp</url>
+          <line>166</line>
+          <option name="timeStamp" value="10" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" type="com.jetbrains.cidr.execution.debugger.OCBreakpointType">
+          <url>file://$PROJECT_DIR$/.pio/libdeps/native/PubSubClient/src/PubSubClient.cpp</url>
+          <line>468</line>
+          <option name="timeStamp" value="11" />
+        </line-breakpoint>
+        <line-breakpoint enabled="true" type="com.jetbrains.cidr.execution.debugger.OCBreakpointType">
+          <url>file://$PROJECT_DIR$/src/mesh/mesh-pb-constants.cpp</url>
+          <line>20</line>
+          <option name="timeStamp" value="12" />
+        </line-breakpoint>
+      </breakpoints>
+    </breakpoint-manager>
+    <watches-manager>
+      <configuration name="CLion_Remote">
+        <watch expression="radioConfig" language="ObjectiveC" />
+        <watch expression="fromRadioScratch" language="ObjectiveC" />
+      </configuration>
+    </watches-manager>
+  </component>
+  <component name="XSLT-Support.FileAssociations.UIState">
+    <expand />
+    <select />
+  </component>
+</project>

.vscode/extensions.json

@@ -2,6 +2,7 @@
     // See http://go.microsoft.com/fwlink/?LinkId=827846
     // for the documentation about the extensions.json format
     "recommendations": [
-        "platformio.platformio-ide"
+        "platformio.platformio-ide",
+        "xaver.clang-format"
     ]
 }

.vscode/settings.json

@@ -69,6 +69,7 @@
         "wifi"
     ],
     "C_Cpp.dimInactiveRegions": true,
+    "cmake.configureOnOpen": true,
     "protoc": {
         "compile_on_save": false,
         "compile_all_path": "/home/kevinh/development/meshtastic/meshtastic-esp32/proto",
@@ -76,5 +77,6 @@
             "--java_out=/tmp",
             "-I=/home/kevinh/development/meshtastic/meshtastic-esp32/proto"
         ]
-    }    
+    },
+    "editor.formatOnSave": true
 }

CMakeLists.txt

@@ -0,0 +1,36 @@
+# !!! WARNING !!! AUTO-GENERATED FILE, PLEASE DO NOT MODIFY IT AND USE
+# https://docs.platformio.org/page/projectconf/section_env_build.html#build-flags
+#
+# If you need to override existing CMake configuration or add extra,
+# please create `CMakeListsUser.txt` in the root of project.
+# The `CMakeListsUser.txt` will not be overwritten by PlatformIO.
+
+cmake_minimum_required(VERSION 3.13)
+set(CMAKE_SYSTEM_NAME Generic)
+set(CMAKE_C_COMPILER_WORKS 1)
+set(CMAKE_CXX_COMPILER_WORKS 1)
+
+project("meshtastic-esp32" C CXX)
+
+include(CMakeListsPrivate.txt)
+
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/CMakeListsUser.txt)
+include(CMakeListsUser.txt)
+endif()
+
+include_directories("$ENV{HOME}/.platformio/packages/framework-portduino")
+include_directories("/usr/include")
+
+add_custom_target(
+    Production ALL
+    COMMAND platformio -c clion run "$<$<NOT:$<CONFIG:All>>:-e${CMAKE_BUILD_TYPE}>"
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+add_custom_target(
+    Debug ALL
+    COMMAND platformio -c clion run --target debug "$<$<NOT:$<CONFIG:All>>:-e${CMAKE_BUILD_TYPE}>"
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+add_executable(Z_DUMMY_TARGET ${SRC_LIST})

README.md

@@ -199,7 +199,7 @@ We'd love to have you join us on this merry little project. Please see our [deve
 
 # Credits
 
-This project is run by volunteers. Past contributors include:
+This project is run by volunteers. We are a friendly group and welcome any contribution (code fixes, documentation, features, bug reports etc...).  We try to be good about listing contributor names in release notes, but it has become unwieldy for the main-devs to keep updating the list below and we've neglected it too long.  If you'd like your name included in this list please send a pull request to edit this README and simply add your line yourself.  Thank you very much for your help!
 
 - @astro-arphid: Added support for 433MHz radios in europe.
 - @claesg: Various documentation fixes and 3D print enclosures

bin/build-all.sh

@@ -4,17 +4,11 @@ set -e
 
 VERSION=`bin/buildinfo.py`
 
-# We now only do regionless builds
-COUNTRIES=""
-#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="tlora-v2 tlora-v1 tlora_v1_3 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_NRF52="rak4631"
 
 OUTDIR=release/latest
 
@@ -24,32 +18,23 @@ ARCHIVEDIR=release/archive
 rm -f $OUTDIR/firmware*
 
 mkdir -p $OUTDIR/bins $ARCHIVEDIR
-rm -r $OUTDIR/bins/*
+rm -r $OUTDIR/bins/* || true
 mkdir -p $OUTDIR/bins/universal $OUTDIR/elfs/universal
 
 # build the named environment and copy the bins to the release directory
 function do_build() {
 	BOARD=$1
-	COUNTRY=$2
 	isNrf=$3
 	
-    echo "Building $COUNTRY for $BOARD with $PLATFORMIO_BUILD_FLAGS"
+    echo "Building for $BOARD with $PLATFORMIO_BUILD_FLAGS"
     rm -f .pio/build/$BOARD/firmware.*
 
     # The shell vars the build tool expects to find
     export APP_VERSION=$VERSION
 
     # 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
+    export HW_VERSION="1.0"
+    basename=universal/firmware-$BOARD-$VERSION
 
     pio run --environment $BOARD # -v
     SRCELF=.pio/build/$BOARD/firmware.elf
@@ -71,10 +56,6 @@ 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

bin/build-nightly.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+source ~/.bashrc
+
+# Meshtastic Nightly Build Script.
+#  McHamster (jm@casler.org)
+#
+# This is the script that is used for the nightly build server.
+#
+# It's probably not useful for most people, but you may want to run your own
+#   nightly builds.
+#
+# The last line of ~/.bashrc contains an inclusion of platformio in the path.
+#   Without this, the build script won't run from the crontab:
+#
+#    export PATH="$HOME/.platformio/penv/bin:$PATH" 
+#
+# The crontab contains:
+#  0 2 * * * cd ~/meshtastic/github/meshtastic && source "~/.bashrc"; ./build-nightly.sh > ~/cronout.txt 2> ~/cronout.txt
+
+cd Meshtastic-device
+
+git pull
+
+bin/build-all.sh
+
+date_stamp=$(date +'%Y-%m-%d')
+
+cd ..
+
+# TODO: Archive the same binaries used by the build-all script.
+#zip -r meshtastic_device_nightly_${date_stamp} Meshtastic-device/release/latest/bins
+cp Meshtastic-device/release/archive/`ls -t ./Meshtastic-device/release/archive/| head -1` meshtastic_device_nightly_${date_stamp}.zip
+
+# Copy the file to the webserver
+scp meshtastic_device_nightly_${date_stamp}.zip jm@10.11.12.20:/volume1/web/meshtastic/nightly_builds/
+
+# Delete the local copy
+rm meshtastic_device_nightly_${date_stamp}.zip

bin/buildinfo.py

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

bin/device-install.sh

@@ -1,21 +1,24 @@
 #!/bin/sh
 
+PYTHON=${PYTHON:-$(which python3 python|head -n 1)}
+
 set -e
 
 # Usage info
 show_help() {
 cat << EOF
-Usage: ${0##*/} [-h] [-p ESPTOOL_PORT] [-f FILENAME]
+Usage: $(basename $0) [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME|FILENAME]
 Flash image file to device, but first erasing and writing system information"
 
     -h               Display this help and exit
     -p ESPTOOL_PORT  Set the environment variable for ESPTOOL_PORT.  If not set, ESPTOOL iterates all ports (Dangerrous).
-    -f FILENAME         The .bin file to flash.  Custom to your device type and region.
+    -P PYTHON        Specify alternate python interpreter to use to invoke esptool. (Default: "$PYTHON")
+    -f FILENAME      The .bin file to flash.  Custom to your device type and region.
 EOF
 }
 
 
-while getopts ":h:p:f:" opt; do
+while getopts ":hp:P:f:" opt; do
     case "${opt}" in
         h)
             show_help
@@ -23,6 +26,8 @@ while getopts ":h:p:f:" opt; do
             ;;
         p)  export ESPTOOL_PORT=${OPTARG}
 	    ;;
+        P)  PYTHON=${OPTARG}
+            ;;
         f)  FILENAME=${OPTARG}
             ;;
         *)
@@ -34,12 +39,17 @@ while getopts ":h:p:f:" opt; do
 done
 shift "$((OPTIND-1))"
 
+[ -z "$FILENAME" -a -n "$1" ] && {
+    FILENAME=$1
+    shift
+}
+
 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}
+	$PYTHON -m esptool --baud 921600 erase_flash
+	$PYTHON -m esptool --baud 921600 write_flash 0x1000 system-info.bin
+	$PYTHON -m esptool --baud 921600 write_flash 0x00390000 spiffs-*.bin
+	$PYTHON -m esptool --baud 921600 write_flash 0x10000 ${FILENAME}
 else
 	echo "Invalid file: ${FILENAME}"
 	show_help

bin/device-update.sh

@@ -1,19 +1,22 @@
 #!/bin/sh
 
+PYTHON=${PYTHON:-$(which python3 python|head -n 1)}
+
 # Usage info
 show_help() {
 cat << EOF
-Usage: ${0##*/} [-h] [-p ESPTOOL_PORT] -f FILENAME
+Usage: $(basename $0) [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME|FILENAME]
 Flash image file to device, leave existing system intact."
 
     -h               Display this help and exit
     -p ESPTOOL_PORT  Set the environment variable for ESPTOOL_PORT.  If not set, ESPTOOL iterates all ports (Dangerrous).
-    -f FILENAME         The .bin file to flash.  Custom to your device type and region.
+    -P PYTHON        Specify alternate python interpreter to use to invoke esptool. (Default: "$PYTHON")
+    -f FILENAME      The .bin file to flash.  Custom to your device type and region.
 EOF
 }
 
 
-while getopts ":h:p:f:" opt; do
+while getopts ":hp:P:f:" opt; do
     case "${opt}" in
         h)
             show_help
@@ -21,6 +24,8 @@ while getopts ":h:p:f:" opt; do
             ;;
         p)  export ESPTOOL_PORT=${OPTARG}
 	    ;;
+        P)  PYTHON=${OPTARG}
+            ;;
         f)  FILENAME=${OPTARG}
             ;;
         *)
@@ -32,9 +37,16 @@ while getopts ":h:p:f:" opt; do
 done
 shift "$((OPTIND-1))"
 
+[ -z "$FILENAME" -a -n "$1" ] && {
+    FILENAME=$1
+    shift
+}
+
 if [ -f "${FILENAME}" ]; then
 	echo "Trying to flash update ${FILENAME}."
-	esptool.py --baud 921600 write_flash 0x10000 ${FILENAME}
+	$PYTHON -m esptool --baud 921600 write_flash 0x10000 ${FILENAME}
+	echo "Erasing the otadata partition, which will turn off flash flippy-flop and force the first image to be used"
+	$PYTHON -m esptool --baud 921600 erase_region 0xe000 0x2000
 else
 	echo "Invalid file: ${FILENAME}"
 	show_help

bin/install-eink.sh

@@ -6,6 +6,8 @@ BOOTDIR=/home/kevinh/development/meshtastic/Adafruit_nRF52_Bootloader
 
 nrfjprog --eraseall -f nrf52
 
+# to get tool run "sudo apt-get install srecord"
+
 # 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
@@ -14,7 +16,7 @@ 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
+mergehex -m $BOOTDIR/_build/build-ttgo_eink/ttgo_eink_bootloader-0.3.2-213-gf67f592-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

bin/mqtt-listen.sh

@@ -0,0 +1,3 @@
+
+mosquitto_sub -h mqtt.meshtastic.org -v -t \$SYS/\# -t msh/+/stat/\# -t msh/+/json/\#
+# mosquitto_sub -h test.mosquitto.org -v -t mesh/\# -F "%j"

bin/mqtt-send-status.sh

@@ -0,0 +1 @@
+mosquitto_pub -h mqtt.meshtastic.org -u meshdev -P large4cats -t msh/1/stat/FakeNode -m online -d

bin/native-gdbserver.sh

@@ -0,0 +1,3 @@
+set -e
+pio run --environment native
+gdbserver --once localhost:2345 .pio/build/native/program "$@"

bin/native-run.sh

@@ -0,0 +1,3 @@
+set -e
+pio run --environment native
+.pio/build/native/program "$@"

bin/nrf52840-gdbserver.sh

@@ -1,3 +1,3 @@
 
 
-JLinkGDBServerCLExe -if SWD -select USB -port 2331 -device NRF52840_XXAA
+JLinkGDBServerCLExe -if SWD -select USB -port 2331 -device NRF52840_XXAA -SuppressInfoUpdateFW -DisableAutoUpdateFW -rtos GDBServer/RTOSPlugin_FreeRTOS

bin/platformio-custom.py

@@ -1,16 +1,19 @@
 
+
+import subprocess
+import configparser
+import traceback
+import sys
+from readprops import readProps
+
 Import("projenv")
 
-import configparser
 prefsLoc = projenv["PROJECT_DIR"] + "/version.properties"
-config = configparser.RawConfigParser()
-config.read(prefsLoc)
-version = dict(config.items('VERSION'))
-verStr = "{}.{}.{}".format(version["major"], version["minor"], version["build"])
-
+verStr = readProps(prefsLoc)
 print("Using meshtastic platform-custom.py, firmare version " + verStr)
+# print("path is" + ','.join(sys.path))
 
 # General options that are passed to the C and C++ compilers
 projenv.Append(CCFLAGS=[
     "-DAPP_VERSION=" + verStr
-    ])
+])

bin/program-1.0-tbeam.sh

@@ -0,0 +1,3 @@
+esptool.py --baud 921600 write_flash 0x10000 release/archive/old/firmware-tbeam-EU865-1.0.0.bin
+echo "Erasing the otadata partition, which will turn off flash flippy-flop and force the first image to be used"
+esptool.py --baud 921600 erase_region 0xe000 0x2000

bin/program-1.1-tbeam.sh

@@ -0,0 +1 @@
+esptool.py --baud 921600 write_flash 0x10000 release/archive/old/firmware-tbeam-1.1.50.bin

bin/readprops.py

@@ -0,0 +1,36 @@
+
+
+import subprocess
+import configparser
+import traceback
+import sys
+
+
+def readProps(prefsLoc):
+    """Read the version of our project as a string"""
+
+    config = configparser.RawConfigParser()
+    config.read(prefsLoc)
+    version = dict(config.items('VERSION'))
+
+    # Try to find current build SHA if if the workspace is clean.  This could fail if git is not installed
+    try:
+        sha = subprocess.check_output(
+            ['git', 'rev-parse', '--short', 'HEAD']).decode("utf-8").strip()
+        isDirty = subprocess.check_output(
+            ['git', 'diff', 'HEAD']).decode("utf-8").strip()
+        suffix = sha
+        if isDirty:
+            # short for 'dirty', we want to keep our verstrings source for protobuf reasons
+            suffix = sha + "-d"
+        verStr = "{}.{}.{}.{}".format(
+            version["major"], version["minor"], version["build"], suffix)
+    except:
+        # print("Unexpected error:", sys.exc_info()[0])
+        # traceback.print_exc()
+        verStr = "{}.{}.{}".format(
+            version["major"], version["minor"], version["build"])
+
+    # print("firmare version " + verStr)
+    return verStr
+# print("path is" + ','.join(sys.path))

bin/run-both.sh

@@ -0,0 +1,13 @@
+set -e 
+
+TARG=tbeam
+
+pio run -e $TARG
+
+echo uploading to usb1
+pio run --upload-port /dev/ttyUSB1 -t upload -e $TARG &
+
+echo uploading to usb0
+pio run --upload-port /dev/ttyUSB0 -t upload -e $TARG &
+
+wait

bin/upload-to-bootloader.sh

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

boards/lora_isp4520.json

@@ -0,0 +1,48 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52832_s132_v6.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DNRF52832_XXAA -DNRF52",
+    "f_cpu": "64000000L",
+    "mcu": "nrf52832",
+    "variant": "lora_isp4520",
+    "bsp": {
+      "name": "adafruit"
+    },
+    "softdevice": {
+      "sd_flags": "-DS132",
+      "sd_name": "s132",
+      "sd_version": "6.1.1",
+      "sd_fwid": "0x00B7"
+    }
+  },
+  "connectivity": [
+    "bluetooth"
+  ],
+  "debug": {
+    "jlink_device": "nRF52832_xxAA",
+    "svd_path": "nrf52.svd"
+  },
+  "frameworks": [
+    "arduino"
+  ],
+  "name": "lora ISP4520",
+  "upload": {
+    "maximum_ram_size": 65536,
+    "maximum_size": 524288,
+    "require_upload_port": true,
+    "speed": 115200,
+    "protocol": "nrfutil",
+    "protocols": [
+      "jlink",
+      "nrfjprog",
+      "nrfutil",
+      "stlink"
+    ]
+  },
+  "url": "",
+  "vendor": "PsiSoft"
+}

boards/wiscore_rak4600.json

@@ -0,0 +1,71 @@
+{
+  "build": {
+    "arduino": {
+      "ldscript": "nrf52832_s132_v6.ld"
+    },
+    "core": "nRF5",
+    "cpu": "cortex-m4",
+    "extra_flags": "-DNRF52832_XXAA -DNRF52",
+    "f_cpu": "64000000L",
+    "hwids": [
+      [
+        "0x239A",
+        "0x8029"
+      ],
+      [
+        "0x239A",
+        "0x0029"
+      ],
+      [
+        "0x239A",
+        "0x002A"
+      ],
+      [
+        "0x239A",
+        "0x802A"
+      ]
+    ],
+    "usb_product": "Feather nRF52832 Express",
+    "mcu": "nrf52832",
+    "variant": "WisCore_RAK4600_Board",
+    "bsp": {
+      "name": "adafruit"
+    },
+    "softdevice": {
+      "sd_flags": "-DS132",
+      "sd_name": "s132",
+      "sd_version": "6.1.1",
+      "sd_fwid": "0x00B7"
+    },
+    "zephyr": {
+      "variant": "nrf52_adafruit_feather"
+    }
+  },
+  "connectivity": [
+    "bluetooth"
+  ],
+  "debug": {
+    "jlink_device": "nRF52832_xxAA",
+    "svd_path": "nrf52.svd"
+  },
+  "frameworks": [
+    "arduino",
+    "zephyr"
+  ],
+  "name": "Adafruit Bluefruit nRF52832 Feather",
+  "upload": {
+    "maximum_ram_size": 65536,
+    "maximum_size": 524288,
+    "require_upload_port": true,
+    "speed": 115200,
+    "protocol": "nrfutil",
+    "protocols": [
+      "jlink",
+      "nrfjprog",
+      "nrfutil",
+      "stlink"
+    ]
+  },
+  "url": "https://www.adafruit.com/product/3406",
+  "vendor": "Adafruit"
+}

boards/wiscore_rak4631.json

@@ -0,0 +1,72 @@
+{
+    "build": {
+        "arduino": {
+            "ldscript": "nrf52840_s140_v6.ld"
+        },
+        "core": "nRF5",
+        "cpu": "cortex-m4",
+        "extra_flags": "-DARDUINO_NRF52840_FEATHER -DNRF52840_XXAA",
+        "f_cpu": "64000000L",
+        "hwids": [
+            [
+                "0x239A",
+                "0x8029"
+            ],
+            [
+                "0x239A",
+                "0x0029"
+            ],
+            [
+                "0x239A",
+                "0x002A"
+            ],
+            [
+                "0x239A",
+                "0x802A"
+            ]
+        ],
+        "usb_product": "WisCore RAK4631 Board",
+        "mcu": "nrf52840",
+        "variant": "WisCore_RAK4631_Board",
+        "bsp": {
+            "name": "adafruit"
+        },
+        "softdevice": {
+            "sd_flags": "-DS140",
+            "sd_name": "s140",
+            "sd_version": "6.1.1",
+            "sd_fwid": "0x00B6"
+        },
+        "bootloader": {
+            "settings_addr": "0xFF000"
+        }
+    },
+    "connectivity": [
+        "bluetooth"
+    ],
+    "debug": {
+        "jlink_device": "nRF52840_xxAA",
+        "svd_path": "nrf52840.svd"
+    },
+    "frameworks": [
+        "arduino"
+    ],
+    "name": "WisCore RAK4631 Board",
+    "upload": {
+        "maximum_ram_size": 248832,
+        "maximum_size": 815104,
+        "speed": 115200,
+        "protocol": "nrfutil",
+        "protocols": [
+            "jlink",
+            "nrfjprog",
+            "nrfutil",
+            "stlink"
+        ],
+        "use_1200bps_touch": true,
+        "require_upload_port": true,
+        "wait_for_upload_port": true
+    },
+    "url": "https://www.rakwireless.com",
+    "vendor": "RAKwireless"
+}

data/static/basic.js

@@ -1,43 +0,0 @@
-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

@@ -1,18 +1 @@
-<!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>
+not yet supported - soon will be included in build

docs/.well-known/assetlinks.json

@@ -1,9 +0,0 @@
-[{
-  "relation": ["delegate_permission/common.handle_all_urls"],
-  "target": {
-    "namespace": "android_app",
-    "package_name": "com.geeksville.mesh",
-    "sha256_cert_fingerprints":
-    ["D0:05:E7:8B:D2:1B:FA:94:56:1D:6B:90:EB:53:07:1A:74:4F:D9:C2:6F:13:87:6A:D9:17:4F:C2:59:48:02:9D", "42:17:52:DC:57:40:38:B5:6B:86:61:1C:2F:47:DB:2B:0F:A2:EA:59:E1:18:9C:AA:90:8D:37:D6:CD:40:0E:BB", "A9:3B:45:65:68:C1:75:DB:08:00:A0:9F:06:77:7F:89:2D:81:24:32:AD:B8:A3:DF:73:BC:3E:7F:06:C8:0C:6D"]
-  }
-}]

docs/CNAME

@@ -1 +0,0 @@
-www.meshtastic.org

docs/README.md

@@ -1,97 +0,0 @@
-# What is Meshtastic?
-
-Meshtastic® is a project that lets you use
-inexpensive (\$30 ish) GPS radios as an extensible, long battery life, secure, mesh GPS communicator. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of your private mesh can always see the location and distance of all other members and any text messages sent to your group chat.
-
-The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.
-
-Note: Questions after reading this? See our new [forum](https://meshtastic.discourse.group/).
-
-## Uses
-
-- Outdoor sports where cellular coverage is limited. (Hiking, Skiing, Boating, Paragliding, Gliders etc..)
-- Applications where closed source GPS communicators just won't cut it (it is easy to add features for glider pilots etc...)
-- Secure long-range communication within groups without depending on cellular providers
-- Finding your lost kids ;-)
-- Through our [python API](https://pypi.org/project/meshtastic/) use these inexpensive radios to easily add mesh networking to your own projects.
-
-[![Youtube video demo](desk-video-screenshot.png)](https://www.youtube.com/watch?v=WlNbMbVZlHI "Meshtastic early demo")
-
-## Features
-
-Not all of these features are fully implemented yet - see **important** disclaimers below. But they should be in by the time we decide to call this project beta (three months?)
-
-- Very long battery life (should be about eight days with the beta software)
-- Built in GPS and [LoRa](https://en.wikipedia.org/wiki/LoRa) radio, but we manage the radio automatically for you
-- Long range - a few miles per node but each node will forward packets as needed
-- Secure - channels are encrypted by AES256 (But see important disclaimers below wrt this feature)
-- Shows direction and distance to all members of your channel
-- Directed or broadcast text messages for channel members
-- Open and extensible codebase supporting multiple hardware vendors - no lock in to one vendor
-- Communication API for bluetooth devices (such as our Android app) to use the mesh. An iOS application is in the works. And [Meshtastic-python](https://pypi.org/project/meshtastic/) provides access from desktop computers.
-- Very easy sharing of private secured channels. Just share a special link or QR code with friends and they can join your encrypted mesh
-
-This project is currently in beta testing but it is fairly stable and feature complete - if you have questions please [join our discussion forum](https://meshtastic.discourse.group/).
-
-This software is 100% open source and developed by a group of hobbyist experimenters. No warranty is provided, if you'd like to improve it - we'd love your help. Please post in the [forum](https://meshtastic.discourse.group/).
-
-### Beginner's Guide
-
-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).<br/>
-Telegram group for **Russian**-based users [t.me/meshtastic_russia](https://t.me/meshtastic_russia) (Russian language, unofficial).
-
-# Updates
-
-Note: Updates are happening almost daily, only major updates are listed below. For more details see our forum.
-
-- 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.
-- 03/03/2020 - 0.0.9 of the Android app and device code is released. Still an alpha but fairly functional.
-- 02/25/2020 - 0.0.4 of the Android app is released. This is a very early alpha, see below to join the alpha-testers group.
-- 02/23/2020 - 0.0.4 release. Still very bleeding edge but much closer to the final power management, a charged T-BEAM should run for many days with this load. If you'd like to try it, we'd love your feedback. Click [here](https://github.com/meshtastic/Meshtastic-esp32/blob/master/README.md) for instructions.
-- 02/20/2020 - Our first alpha release (0.0.3) of the radio software is ready brave early people.
-
-## Meshtastic Android app
-
-Our Android application is available here:
-
-[![Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh](https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png)](https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source%3Dgithub-homepage)
-
-The link above will return older more stable releases. We would prefer if you join our alpha-test group, because the application is rapidly improving. Three steps to opt-in to the alpha- test:
-
-1. Join [this Google group](https://groups.google.com/forum/#!forum/meshtastic-alpha-testers) with the account you use in Google Play.
-2. Go to this [URL](https://play.google.com/apps/testing/com.geeksville.mesh) to opt-in to the alpha test.
-3. If you encounter any problems or have questions, post in our [forum](https://meshtastic.discourse.group/) and we'll help.
-
-If you'd like to help with development, the source code is [on github](https://github.com/meshtastic/Meshtastic-Android).
-
-The app is also distributed for Amazon Fire devices via the Amazon appstore: [![Amazon appstore link](https://raw.githubusercontent.com/meshtastic/Meshtastic-device/master/images/amazon-fire-button.png)](https://www.amazon.com/Geeksville-Industries-Meshtastic/dp/B08CY9394Q)
-
-## Supported hardware
-
-We currently support two brands of radios. The [TTGO T-Beam](https://www.aliexpress.com/item/4001178678568.html) and the [Heltec LoRa 32](https://heltec.org/project/wifi-lora-32/). Most people should buy the T-Beam and a 18650 battery (total cost less than \$35). Also, the version of the T-Beam we link to is shipped with Meshtastic **preinstalled** by TTGO, so you don't have to install it yourself.
-
-Make sure to buy the frequency range which is legal for your country. For the USA, you should buy the 915MHz version. Getting a version that include a screen is optional, but highly recommended.
-
-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)
-
-# IMPORTANT DISCLAIMERS AND FAQ
-
-For a listing of currently missing features and a FAQ click [here](faq.md).

docs/SupportedHardware.md

@@ -1,8 +0,0 @@
-| Vendor  | Product line  | Version  | Board labels  | Notes  | URL |
-|---|---|---|---|---|---|
-| TTGO  | T-Beam  | 0.7  | T22_V07 20180711  | LoRa 433/470MHz *OR* LoRa 868/915MHz , <br/>GPS ublox NEO-6M , <br/>battery holder for Li-Ion 18650  |  [buy](https://www.aliexpress.com/item/4000574335430.html)  |
-| TTGO  | T-Beam  | 1.0  |   |   |  [buy](https://www.aliexpress.com/item/4001178678568.html)  |
-| TTGO  | T-Beam  | 1.1  | T22_V11 20191212 | LoRa 433/470MHz *OR* LoRa 868/915MHz *OR* LoRa 923MHz , <br/>GPS ublox NEO-M8N , <br/>battery holder for Li-Ion 18650  | [buy](https://www.aliexpress.com/item/4001178678568.html) |
-| TTGO  | Lora32  | 2.0  | *missing*  | LoRa 433/470MHz *OR* LoRa 868/915MHz , <br/>OLED SSD1306 , <br/>SD card holder | [buy](https://www.aliexpress.com/item/4000211331316.html) |
-| TTGO  | Lora32  | 2.1  | T3_V1.6 20180606  | LoRa 32 (V2) , <br/>SD card holder | [buy](https://www.aliexpress.com/item/4000119208093.html) |
-| Heltec | Lora 32 | V2  | V2 | LoRa 433/470MHz *OR* LoRa 868/915MHz | [buy](https://heltec.org/project/wifi-lora-32/) |

docs/_config.yml

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

docs/editing-this-site.md

@@ -1,10 +0,0 @@
-If you'd like to edit this website and test it locally:
-
-Not yet implemented:
-Per https://help.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll
-
-* follow instructions here: https://jekyllrb.com/docs/installation/ubuntu/
-* run "run-locally.sh"
-* view webpages at localhost:4000
-
-The template seems to come from here: https://github.com/pages-themes/cayman

docs/faq.md

@@ -1,34 +0,0 @@
-# Disclaimers
-
-This project is still pretty young but moving at a pretty good pace. Not all features are fully implemented in the current alpha builds.
-Most of these problems should be solved by the beta release (within three months):
-
-- We don't make these devices and they haven't been tested by UL or the FCC. If you use them you are experimenting and we can't promise they won't burn your house down ;-)
-- The encryption implementation is good but see this list of [caveats](software/crypto.md#summary-of-strengthsweaknesses-of-our-current-implementation) to determine risks you might face.
-- A number of (straightforward) software work items have to be completed before battery life matches our measurements, currently battery life is about three days. Join us on chat if you want the spreadsheet of power measurements/calculations.
-- The Android API needs to be documented better
-- No one has written an iOS app yet. But some good souls [are talking about it](https://github.com/meshtastic/Meshtastic-esp32/issues/14) ;-)
-
-For more details see the [device software TODO](https://github.com/meshtastic/Meshtastic-esp32/blob/master/docs/software/TODO.md) or the [Android app TODO](https://github.com/meshtastic/Meshtastic-Android/blob/master/TODO.md).
-
-# FAQ
-
-If you have a question missing from this faq, please [ask in our discussion forum](https://meshtastic.discourse.group/). And if you are feeling extra generous send in a pull-request for this faq.md with whatever we answered ;-).
-
-## Q: Which of the various supported radios should I buy?
-
-Basically you just need the radio + (optional but recommended) battery. The TBEAM is usually better because it has gps and huge battery socket. The Heltec is basically the same hardware but without the GPS (the phone provides position data to the radio in that case, so the behavior is similar - but it does burn some battery in the phone). Also the battery for the Heltec can be smaller.
-
-In addition to Aliexpress, (banggood.com) usually has stock and faster shipping, or Amazon. If buying a TBEAM, make sure to buy a version that includes the OLED screen - this project doesn't absolutely require the screen, but we use it if is installed.
-
-@claesg has added links to various 3D printable cases, you can see them at (www.meshtastic.org).
-
-## Q: Do you have plans to commercialize this project
-
-Nope. though if some other person/group wanted to use this software and a more customized device we think that would be awesome (as long as they obey the GPL license).
-
-## Q: Does this project use patented algorithms?
-
-(Kindly borrowed from the geeks at [ffmpeg](http://ffmpeg.org/legal.html))
-
-We do not know, we are not lawyers so we are not qualified to answer this. Also we have never read patents to implement any part of this, so even if we were qualified we could not answer it as we do not know what is patented. Furthermore the sheer number of software patents makes it impossible to read them all so no one (lawyer or not) could answer such a question with a definite no. We are merely geeks experimenting on a fun and free project.

docs/hardware/corvus.md

@@ -1,35 +0,0 @@
-# Notes on @BigCorvus boards
-
-## Board version 1.1
-
-variant name lora_relay_v1
-
-### Remaining TODOs
-
-- power hold for the ST7735
-- look at example sketch
-- turn on xmit boost
-
-## Recommendations for future boards
-
-@BigCorvus your board is **really** nice. Here's some ideas for the future:
-
-- make the SWDIO header more standard (the small ARM 2x5 micro footprint?) or at least througholes so it is easy to solder a header
-
-## How to program bootloader
-
-Download from here: https://github.com/adafruit/Adafruit_nRF52_Bootloader/releases
-
-```
-nrfjprog -f nrf52 --eraseall
-Erasing user available code and UICR flash areas.
-Applying system reset.
-
-nrfjprog -f nrf52 --program feather_nrf52840_express_bootloader-0.3.2_s140_6.1.1.hex
-Parsing hex file.
-Reading flash area to program to guarantee it is erased.
-Checking that the area to write is not protected.
-Programming device.
-```
-
-Then reboot the board, if all went well it now shows up as a mountable filesystem on your USB bus.

docs/hardware/cubecell-TODO.md

@@ -1,6 +0,0 @@
-
-https://heltec-automation-docs.readthedocs.io/en/latest/cubecell/index.html
-
-https://github.com/HelTecAutomation/ASR650x-Arduino?utm_source=platformio.org&utm_medium=docs
-
-* Either portfreertos or make not theaded versions of Lock, WorkerThread, Queue (probably the latter).

docs/privacy.md

@@ -1,11 +0,0 @@
-# Meshtastic privacy policy
-
-We don't collect any personal identifying information.  
-
-If you have opted-in to analytics (thank you - that helps us know what things we need to improve), we'll receive anonymized information about user behavior.  i.e. which screens you used in the app etc...  We never
-capture usernames, the contents of your texts or your location.
-
-This is an open-source project run by hobbyists and we try to be completely transparent.  If you have questions on this policy, please file [a github issue](https://github.com/meshtastic/meshtastic-esp32/issues) and we'll reply/clarify/correct.
-
-Keep being awesome!
-

docs/radio-settings.md

@@ -1,105 +0,0 @@
-# Radio settings
-
-We use the same channel maps as LoRaWAN (though this is not LoRaWAN).
-
-![freq table](/images/LoRa-Frequency-Bands.jpg)
-
-See [this site](https://www.rfwireless-world.com/Tutorials/LoRa-channels-list.html) for more information.
-
-## LoRaWAN Europe Frequency Band
-
-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
-
-There are eight channels defined with a 0.2 MHz gap between them.
-Channel zero starts at 433.175 MHz
-
-### 870 MHz
-
-There are eight channels defined with a 0.3 MHz gap between them.
-Channel zero starts at 865.20 MHz
-
-## LoRaWAN for North America
-
-LoRaWAN defines 64, 125 kHz channels from 902.3 to 914.9 MHz increments.
-
-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.
-
-## Data-rates
-
-### About
-
-Various data-rates are selectable when configuring a channel and are inversely proportional to the theoretical range of the devices.
-
-Considerations:
-
-* Spreading Factor - How much we "spread" our data over time.
-* * Each step up in Spreading Factor dobules the airtime to transmit.
-* * Each step up in Spreading Factor adds about 2.5db extra link budget.
-* Bandwidth - How big of a slice of the spectrum we use.
-* * Each doubling of the bandwidth is almost 3db less link budget.
-* * Bandwidths less than 31 may be unstable unless you have a high quality Crystal Ossilator.
-* Coding Rate - How much redundency we encode to resist noise.
-* * Increasing coding rate increases reliability while decrasing data-rate.
-* * 4/5 - 1.25x overhead
-* * 4/6 - 1.5x overhead
-* * 4/7 - 1.75x overhead
-* * 4/8 - 2x overhead
-
-
-### Pre-Defined
-
-We have four predefined channels. These are the most common settings and have been proven to work well:
-
-| Channel setting            | Alt Channel Name | Data-rate            | SF / Symbols | Coding Rate | Bandwidth | Link Budget |
-|:---------------------------|:-----------------|:---------------------|:-------------|:------------|:----------|:------------|
-| Short range (but fast)     | Short Fast       | 21.875 kbps          | 7 / 128      | 4/5         | 125       | 134dB       |
-| Medium range (but fast)    | Medium           | 5.469 kbps           | 7 / 128      | 4/5         | 500       | 140dB       |
-| Long range (but slower)    | Long Alt         | 0.275 kbps           | 9 / 512      | 4/8         | 31        | 153dB       |
-| Very long range (but slow) | Long Slow        | 0.183 kbps (default) | 12 / 4096    | 4/8         | 125       | 154dB       |
-
-The link budget used by these calculations assumes a transmit power of 17dBm and an antenna with 0dB gain. Adjust your link budget assumptions based on your actual devices.
-
-### Custom Settings
-
-You may want to select other channels for your usage. The other settings can be set by using the Python API.
-
-> meshtastic --setchan spread_factor 10 --setchan coding_rate 8 --setchan bandwidth 125
-
-After applying the settings, you will need to restart the device. After your device is restarted, it will generate a new crypto key and you will need to share the newly generated QR Code or URL to all your other devices.
-
-Some example settings:
-
-| Data-rate            | SF / Symbols | Coding Rate | Bandwidth | Link Budget | Note |
-|:---------------------|:-------------|:------------|:----------|:------------|:-----|
-| 37.50 kbps           | 6 / 64       | 4/5         | 500       | 129dB       | Fastest possible speed |
-| 3.125 kbps           | 8 / 256      | 4/5         | 125       | 143dB       | |
-| 1.953 kbps           | 8 / 256      | 4/8         | 125       | 143dB       | |
-| 1.343 kbps           | 11 / 2048    | 4/8         | 500       | 145dB       | | 
-| 1.099 kbps           | 9 / 512      | 4/8         | 125       | 146dB       | |
-| 0.814 kbps           | 10 / 1024    | 4/6         | 125       | 149dB       | |
-| 0.610 kbps           | 10 / 1024    | 4/8         | 125       | 149dB       | |
-| 0.488 kbps           | 11 / 2048    | 4/6         | 125       | 152dB       | |
-| 0.336 kbps           | 11 / 2048    | 4/8         | 125       | 152dB       | |
-| 0.073 kbps           | 12 / 4096    | 4/5         | 31        | 160dB       | Twice the range and/or coverage of "Long Slow", low resliance to noise |
-| 0.046 kbps           | 12 / 4096    | 4/8         | 31        | 160dB       | Twice the range and/or coverage of "Long Slow", high resliance to noise |
-
-The link budget used by these calculations assumes a transmit power of 17dBm and an antenna with 0dB gain. Adjust your link budget assumptions based on your actual devices.
-
-These channel settings may have not been tested. Use at your own discression. Share on https://meshtastic.discourse.group with your successes or failure.
-
-## Cryptography
-
-The preshared key used by the devices can be modified.
-
-* 0 = No crypto
-* 1 = Default channel key
-* 2 - 10 = The default channel key, except with 1 through 9 added to the last byte
-
-Use of cryptography can also be modified. To disable cryptography (maybe useful if you have HAM radio license):
-
-> meshtastic --setchan psk 0

docs/software/android-too-old.md

@@ -1,13 +0,0 @@
-# Your android application needs updating
-
-Hi.
-
-If you've landed here that means your android application is too old for the running device firmware.  Usually our updates are backwards compatible, but in this special circumstance it is not.  Sorry.
-
-Probably, what this means is that you installed the **alpha test** version of the firmware from github.  We really love people helping with development by running the alpha test binaries.  But if you aren't ready to sign up for that right now, please go back to [github](https://github.com/meshtastic/Meshtastic-device/releases) and install the latest **not alpha** 1.1.x firmware.
-
-If you **do** intend to run the alpha test please [opt-in](https://play.google.com/apps/testing/com.geeksville.mesh) to receive the alpha test version of the android application.
-
-If you are willing to be an alpha tester, please keep an eye on our forum where we post frequent release notes.  We also will actively help you with any bugs you might encounter (along our shared journey of new feature goodness).
-
-If you have problems/questions please post in our [forum](https://meshtastic.discourse.group) and some nice person will probably help.

docs/software/ant.md

@@ -1,14 +0,0 @@
-# ANT protocol notes
-
-SD340 terms are reasonable for NRF52
-https://www.thisisant.com/developer/components/nrf52832#tab_protocol_stacks_tab
-
-Profiles to implement:
-
-tracker
-https://www.thisisant.com/developer/ant-plus/device-profiles/#4365_tab
-
-ebike
-https://www.thisisant.com/developer/ant-plus/device-profiles/#527_tab
-
-no profile for messaging?

docs/software/build-instructions.md

@@ -1,58 +0,0 @@
-# Build instructions
-
-This project uses the simple PlatformIO build system. PlatformIO is an extension to Microsoft VSCode.  Workflows from building from the GUI or from the commandline are listed below.  
-
-If you encounter any problems, please post a question in [our forum](meshtastic.discourse.group).  And when you learn a fix, update these instructions for the next person (i.e. edit this file and send in a [pull-request](https://opensource.com/article/19/7/create-pull-request-github) which we will eagerly merge).
-
-## GUI
-
-1. Purchase a suitable [radio](https://github.com/meshtastic/Meshtastic-device/wiki/Hardware-Information).
-2. Install [Python](https://www.python.org/downloads/).
-3. Install [Git](https://git-scm.com/downloads).
-4. Reboot your computer.
-5. Install [PlatformIO](https://platformio.org/platformio-ide).
-6. Click the PlatformIO icon on the side bar. ![platformio icon](https://user-images.githubusercontent.com/47490997/89482668-77c7ea00-d7ee-11ea-8785-5faf8ff99800.png)
-7. Under `Quick Access, Miscellaneous, Clone Git Project` enter the URL of the Meshtastic repo found [here](https://github.com/meshtastic/Meshtastic-device). ![image](https://user-images.githubusercontent.com/47490997/89483047-4c91ca80-d7ef-11ea-91f4-1d53d4e8acd9.png) 
-8. Select a file location to save the repo.
-9. Once loaded, open the `platformio.ini` file. 
-10. At the line `default_envs` you can change it to the board type you are building for ie. `tlora-v2, tlora-v1, tlora-v2-1-1.6, tbeam, heltec, tbeam0.7` (boards are listed further down in the file).
-11. The hardware can be configured for different countries by adding a definition to the `configuration.h` file. `#define HW_VERSION_US` or `HW_VERSION_EU433, HW_VERSION_EU865, HW_VERSION_CN, HW_VERSION_JP`. Other country settings can be found in `MeshRadio.h`. The default is `HW_VERSION_US`.
-12. Click the PlatformIO icon on the side bar. Under `Project Tasks` you can now build or upload.
-
-Note - To get a clean build you may have to delete the auto-generated file `./.vscode/c_cpp_properties.json`, close and re-open Visual Studio and WAIT until the file is auto-generated before compiling again.
-
-## Command Line
-
-1. Purchase a suitable [radio](https://github.com/meshtastic/Meshtastic-device/wiki/Hardware-Information).
-2. Install [PlatformIO](https://platformio.org/platformio-ide)
-3. Download this git repo and cd into it:
-
-```
-git clone https://github.com/meshtastic/Meshtastic-device.git
-cd Meshtastic-device
-```
-4. Run `git submodule update --init --recursive` to pull in dependencies this project needs.
-5. If you are outside the USA, run "export COUNTRY=EU865" (or whatever) to set the correct frequency range for your country. Options are provided for `EU433`, `EU865`, `CN`, `JP` and `US` (default). Pull-requests eagerly accepted for other countries.
-6. Plug the radio into your USB port
-7. Type `pio run --environment XXX -t upload` (This command will fetch dependencies, build the project and install it on the board via USB). For XXX, use the board type you have (either `tlora-v2, tlora-v1, tlora-v2-1-1.6, tbeam, heltec, tbeam0.7`).
-8. Platform IO also installs a very nice VisualStudio Code based IDE, see their [tutorial](https://docs.platformio.org/en/latest/tutorials/espressif32/arduino_debugging_unit_testing.html) if you'd like to use it.
-
-## Decoding stack traces
-
-### Option 1
-
-If you get a crash, you can decode the addresses from the `Backtrace:` line:
-
-1. Save the `Backtrace: 0x....` line to a file, e.g., `backtrace.txt`.
-2. Run `bin/exception_decoder.py backtrace.txt` (this uses symbols from the
-   last `firmware.elf`, so you must be running the same binary that's still in
-   your `.pio/build` directory).
-
-### Option 2
-
-You can run the exception decoder to monitor the serial output and decode backtraces in real time.
-
-1. From within PlatformIO, open a new terminal.
-2. At the the terminal, enter:
-   `pio device monitor --port /dev/cu.SLAB_USBtoUART -f esp32_exception_decoder`
-   Replace the value of port with the location of your serial port.

docs/software/crypto.md

@@ -1,51 +0,0 @@
-# Encryption in Meshtastic
-
-Cryptography is tricky, so we've tried to 'simply' apply standard crypto solutions to our implementation. However,
-the project developers are not cryptography experts. Therefore we ask two things:
-
-- If you are a cryptography expert, please review these notes and our questions below. Can you help us by reviewing our
-  notes below and offering advice? We will happily give as much or as little credit as you wish ;-).
-- Consider our existing solution 'alpha' and probably fairly secure against a not particularly aggressive adversary
-(but we can't yet make a more confident statement).
-
-## Summary of strengths/weaknesses of our current implementation
-
-Based on comments from reviewers (see below), here's some tips for usage of these radios.  So you can know the level of protection offered:
-
-* It is pretty likely that the AES256 security is implemented 'correctly' and an observer will not be able to decode your messages.
-* Warning: If an attacker is able to get one of the radios in their posession, they could either a) extract the channel key from that device or b) use that radio to listen to new communications.
-* Warning: If an attacker is able to get the "Channel QR code/URL" that you share with others - that attacker could then be able to read any messages sent on the channel (either tomorrow or in the past - if they kept a raw copy of those broadcast packets)
-
-Possible future areas of work (if there is enough interest - post in our [forum](https://meshtastic.discourse.group) if you want this):
-
-1. Optionally requiring users to provide a PIN to regain access to the mesh.  This could be based on: intentionally locking the device, time since last use, or any member could force all members to reauthenticate,
-2. Until a device reauthenticates, any other access via BLE or USB would be blocked (this would protect against attackers who are not prepared to write custom software to extract and reverse engineer meshtastic flash memory)
-3. Turning on read-back protection in the device fuse-bits (this would extend protection in #2 to block all but **extremely** advanced attacks involving chip disassembly)
-4. Time limiting keys used for message transmission and automatically cycling them on a schedule.  This would protect past messages from being decoded even if an attacker learns the current key.
-
-### Notes for reviewers
-
-If you are reviewing our implementation, this is a brief statement of our method.
-
-- We do all crypto at the SubPacket (payload) level only, so that all meshtastic nodes will route for others - even those channels which are encrypted with a different key.
-- Mostly based on reading [Wikipedia](<https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Counter_(CTR)>) and using the modes the ESP32 provides support for in hardware.
-- We use AES256-CTR as a stream cypher (with zero padding on the last BLOCK) because it is well supported with hardware acceleration.
-- Our AES key is 128 or 256 bits, shared as part of the 'Channel' specification.
-- The node number concatenated with the packet number is used as the NONCE. This nonce will be stored in flash in the device and should essentially never repeat. If the user makes a new 'Channel' (i.e. picking a new random 256 bit key), the packet number will start at zero. 
-- The packet number is sent in cleartext with each packet. The node number can be derived from the "from" field of each packet. (Cleartext is acceptable because it merely provides IV for each encryption run)
-- Each 16 byte BLOCK for a packet has an incrementing COUNTER. COUNTER starts at zero for the first block of each packet.
-- The IV for each block is constructed by concatenating the NONCE as the upper 96 bits of the IV and the COUNTER as the bottom 32 bits. Since our packets are small counter portion will really never be higher than 32 (five bits).
-
-## Comments from reviewer #1
-
-This reviewer is a cryptography professional, but would like to remain anonymous. We thank them for their comments ;-):
-
-I'm assuming that meshtastic is being used to hike in places where someone capable is trying to break it - like you were going to walk around DefCon using these. I spent about an hour reviewing the encryption, and have the following notes:
-
-* The write-up isn't quite as clear as the code.
-* The code is using AES-CTR mode correctly to ensure confidentiality.
-* The comment for initNonce really covers the necessary information.
-* I think the bigger encryption question is "what does the encryption need to do"? As it stands, an attacker who has yet to capture any of the devices cannot reasonably capture text or location data. An attacker who captures any device in the channel/mesh can read everything going to that device, everything stored on that device, and any other communication within the channel that they captured in encrypted form. If that capability basically matches your expectations, it is suitable for whatever adventures this was intended for, then, based on information publicly available or widely disclosed, the encryption is good. If those properties are distressing (like, device history is deliberately limited and you don't want a device captured today to endanger the information sent over the channel yesterday) we could talk about ways to achieve that (most likely synchronizing time and replacing the key with its own SHA256 every X hours, and ensuring the old key is not retained unnecessarily).
-* Two other things to keep in mind are that AES-CTR does not itself provide authenticity (e.g. an attacker can flip bits in replaying data and scramble the resulting plaintext), and that the current scheme gives some hints about transmission in the size. So, if you worry about an adversary deliberately messing-up messages or knowing the length of a text message, it looks like those might be possible.
-
-I'm guessing that the network behaves somewhat like a store-and-forward network - or, at least, that the goal is to avoid establishing a two-way connection to transmit data. I'm afraid I haven't worked with mesh networks much, but remember studying them briefly in school about ten years ago.

docs/software/device-api.md

@@ -1,127 +0,0 @@
-# Bluetooth/serial/TCP protocol API
-
-(This document describes the protocol for external API clients using our devices.  If you are interested in running your own code on the device itself, see the [on-device](plugin-api.md) documentation instead)
-
-The Device API is design to have only a simple stream of ToRadio and FromRadio packets and all polymorphism comes from the flexible set of Google Protocol Buffers which are sent over the wire. We use protocol buffers extensively both for the bluetooth API and for packets inside the mesh or when providing packets to other applications on the phone.
-
-## Streaming version
-
-This protocol is **almost** identical when it is deployed over BLE, Serial/USB or TCP (our three currently supported transports for connecting to phone/PC). Most of this document is in terms of the original BLE version, but this section describes the small changes when this API is exposed over a Streaming (non datagram) transport. The streaming version has the following changes:
-
-- We assume the stream is reliable (though the protocol will resynchronize if bytes are lost or corrupted). i.e. we do not include CRCs or error correction codes.
-- Packets always have a four byte header (described below) prefixed before each packet. This header provides framing characters and length.
-- The stream going towards the radio is only a series of ToRadio packets (with the extra 4 byte headers)
-- The stream going towards the PC is a stream of FromRadio packets (with the 4 byte headers), or if the receiver state machine does not see valid header bytes it can (optionally) print those bytes as the debug console from the radio. This allows the device to emit regular serial debugging messages (which can be understood by a terminal program) but also switch to a more structured set of protobufs once it sees that the PC client has sent a protobuf towards it.
-
-The 4 byte header is constructed to both provide framing and to not look line 'normal' 7 bit ASCII.
-
-- Byte 0: START1 (0x94)
-- Byte 1: START2 (0xc3)
-- Byte 2: MSB of protobuf length
-- Byte 3: LSB of protobuf length
-
-The receiver will validate length and if >512 it will assume the packet is corrupted and return to looking for START1. While looking for START1 any other characters are printed as "debug output". For small example implementation of this reader see the meshtastic-python implementation.
-
-## MeshBluetoothService (the BLE API)
-
-This is the main bluetooth service for the device and provides the API your app should use to get information about the mesh, send packets or provision the radio.
-
-For a reference implementation of a client that uses this service see [RadioInterfaceService](https://github.com/meshtastic/Meshtastic-Android/blob/master/app/src/main/java/com/geeksville/mesh/service/RadioInterfaceService.kt).
-
-Typical flow when a phone connects to the device should be the following (if you want to watch this flow from the python app just run "meshtastic --debug --info" - the flow over BLE is identical):
-
-- There are only three relevant endpoints (and they have built in BLE documentation - so use a BLE tool of your choice to watch them): FromRadio, FromNum (sends notifies when new data is available in FromRadio) and ToRadio
-- SetMTU size to 512
-- Write a ToRadio.startConfig protobuf to the "ToRadio" endpoint" - this tells the radio you are a new connection and you need the entire NodeDB sent down.
-- Read repeatedly from the "FromRadio" endpoint. Each time you read you will get back a FromRadio protobuf (see Meshtatastic-protobuf). Keep reading from this endpoint until you get back and empty buffer.
-- See below for the expected sequence for your initial download.
-- After the initial download, you should subscribe for BLE "notify" on the "FromNum" endpoint. If a notification arrives, that means there are now one or more FromRadio packets waiting inside FromRadio. Read from FromRadio until you get back an empty packet.
-- Any time you want to send packets to the radio, you should write a ToRadio packet into ToRadio.
-
-Expected sequence for initial download:
-
-- After your send startConfig, you will receive a series of FromRadio packets. The sequence of these packets will be as follows (but you are best not counting on this, instead just update your model for whatever packet you receive - based on looking at the type)
-- 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
-- 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
-
-For definitions (and documentation) on FromRadio, ToRadio, MyNodeInfo, NodeInfo and User protocol buffers see [mesh.proto](https://github.com/meshtastic/Meshtastic-protobufs/blob/master/mesh.proto)
-
-UUID for the service: 6ba1b218-15a8-461f-9fa8-5dcae273eafd
-
-Each characteristic is listed as follows:
-
-UUID
-Properties
-Description (including human readable name)
-
-8ba2bcc2-ee02-4a55-a531-c525c5e454d5
-read
-fromradio - contains a newly received FromRadio packet destined towards the phone (up to MAXPACKET bytes per packet).
-After reading the esp32 will put the next packet in this mailbox. If the FIFO is empty it will put an empty packet in this
-mailbox.
-
-f75c76d2-129e-4dad-a1dd-7866124401e7
-write
-toradio - write ToRadio protobufs to this characteristic to send them (up to MAXPACKET len)
-
-ed9da18c-a800-4f66-a670-aa7547e34453
-read,notify,write
-fromnum - the current packet # in the message waiting inside fromradio, if the phone sees this notify it should read messages
-until it catches up with this number.
-
-The phone can write to this register to go backwards up to FIXME packets, to handle the rare case of a fromradio packet was dropped after the esp32 callback was called, but before it arrives at the phone. If the phone writes to this register the esp32 will discard older packets and put the next packet >= fromnum in fromradio.
-When the esp32 advances fromnum, it will delay doing the notify by 100ms, in the hopes that the notify will never actally need to be sent if the phone is already pulling from fromradio.
-
-Note: that if the phone ever sees this number decrease, it means the esp32 has rebooted.
-
-Re: queue management
-Not all messages are kept in the fromradio queue (filtered based on SubPacket):
-
-- only the most recent Position and User messages for a particular node are kept
-- all Data SubPackets are kept
-- No WantNodeNum / DenyNodeNum messages are kept
-  A variable keepAllPackets, if set to true will suppress this behavior and instead keep everything for forwarding to the phone (for debugging)
-
-### A note on MTU sizes
-
-This device will work with any MTU size, but it is highly recommended that you call your phone's "setMTU function to increase MTU to 512 bytes" as soon as you connect to a service. This will dramatically improve performance when reading/writing packets.
-
-### Protobuf API
-
-On connect, you should send a want_config_id protobuf to the device. This will cause the device to send its node DB and radio config via the fromradio endpoint. After sending the full DB, the radio will send a want_config_id to indicate it is done sending the configuration.
-
-### Other bluetooth services
-
-This document focuses on the core device protocol, but it is worth noting that the following other Bluetooth services are also
-provided by the device.
-
-#### BluetoothSoftwareUpdate
-
-The software update service. For a sample function that performs a software update using this API see [startUpdate](https://github.com/meshtastic/Meshtastic-Android/blob/master/app/src/main/java/com/geeksville/mesh/service/SoftwareUpdateService.kt).
-
-SoftwareUpdateService UUID cb0b9a0b-a84c-4c0d-bdbb-442e3144ee30
-
-Characteristics
-
-| UUID                                 | properties  | description                                                                                                       |
-| ------------------------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------- |
-| e74dd9c0-a301-4a6f-95a1-f0e1dbea8e1e | write,read  | total image size, 32 bit, write this first, then read read back to see if it was acceptable (0 mean not accepted) |
-| 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        |                                                                                                                   |
-
-#### DeviceInformationService
-
-Implements the standard BLE contract for this service (has software version, hardware model, serial number, etc...)
-
-#### BatteryLevelService
-
-Implements the standard BLE contract service, provides battery level in a way that most client devices should automatically understand (i.e. it should show in the bluetooth devices screen automatically)

docs/software/esp32-arduino-build-notes.md

@@ -1,29 +0,0 @@
-# esp32-arduino build instructions
-
-We build our own custom version of esp32-arduino, in order to get some fixes we've made but haven't yet been merged in master.
-
-These are a set of currently unformatted notes on how to build and install them. Most developers should not care about this, because
-you'll automatically get our fixed libraries.
-
-```
-  last EDF release in arduino is: https://github.com/espressif/arduino-esp32/commit/1977370e6fc069e93ffd8818798fbfda27ae7d99
-  IDF release/v3.3 46b12a560
-  IDF release/v3.3 367c3c09c
-  https://docs.espressif.com/projects/esp-idf/en/release-v3.3/get-started/linux-setup.html
-  kevinh@kevin-server:~/development/meshtastic/esp32-arduino-lib-builder\$ python /home/kevinh/development/meshtastic/
-  cp -a out/tools/sdk/* components/arduino/tools/sdk
-  cp -ar components/arduino/* ~/.platformio/packages/framework-arduinoespressif32
-  
-  /// @src-fba9d33740f719f712e9f8b07da6ea13/
-
-  or
-
-  cp -ar out/tools/sdk/* ~/.platformio/packages/framework-arduinoespressif32/tools/sdk
-
-```
-
-How to flash new bootloader
-
-```
-esp32-arduino-lib-builder/esp-idf/components/esptool*py/esptool/esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dout --flash_freq 40m --flash_size detect 0x1000 /home/kevinh/development/meshtastic/esp32-arduino-lib-builder/build/bootloader/bootloader.bin
-```

docs/software/gps-todo.txt

@@ -1,17 +0,0 @@
-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/install-OSX.md

@@ -1,27 +0,0 @@
-(Here's some quick tips on installing the device code from OS-X, thanks to @android606)
-
-First time using LoRa for anything, just checking it out.
-
-I bought a T-Beam on eBay, followed the instructions to install the firmware here:
-[https://github.com/meshtastic/Meshtastic-esp32](https://github.com/meshtastic/Meshtastic-esp32)
-
-I'm using a Mac for this, so that might account for differences in the steps to get it working. I just swapped out my SSD last month, I'm using a pretty fresh install of OS X 10.15.3/Catalina.
-
-I got it working fairly smoothly, but there were two hang-ups I thought I'd mention:
-
-1. I am about 0% familiar with Python, so there were some issues getting esptool.py working. Basically, this OS X comes with Python 2.7 and no pip. Pip installed okay, so I used it to install esptool. Esptool appeared to install correctly, but I couldn't get it to work to save my life. Simply typing "esptool.py" doesn't work, and I just don't know enough python to figure out why. For some reason, it installs but isn't in the \$PATH anywhere, and I don't know where it went. Python 2.7 kept giving me warning messages about being old and unsupported, so I figured that might be a hint that I should upgrade.
-
-I ended up doing this:
-
-- brew install pyenv (to install pyenv)
-- pyenv install 3.7.7 (to install and select python 3.7.7)
-- pyenv global 3.7.7 (to select the new version of python)
-- brew install pip (to install pip3)
-- pip3 install --upgrade esptool (note I specifically had to use "pip3", not "pip")
-
-...then I was able to execute esptool.py
-
-2. esptool.py didn't work though, because the virtual com port wasn't showing up as a device. I had to install a driver from Silicon Labs, which I got here:
-   [driver for the CP210X USB to UART bridge from Silicon Labs](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
-
-After I installed that, esptool.py was completely happy and the firmware loaded right up.

docs/software/mesh-alg.md

@@ -1,218 +0,0 @@
-# Mesh broadcast algorithm
-
-## Current algorithm
-
-The routing protocol for Meshtastic is really quite simple (and suboptimal). It is heavily influenced by the mesh routing algorithm used in [Radiohead](https://www.airspayce.com/mikem/arduino/RadioHead/) (which was used in very early versions of this project). It has four conceptual layers.
-
-### A note about protocol buffers
-
-Because we want our devices to work across various vendors and implementations, we use [Protocol Buffers](https://github.com/meshtastic/Meshtastic-protobufs) pervasively. For information on how the protocol buffers are used wrt API clients see [sw-design](sw-design.md), for purposes of this document you mostly only
-need to consider the MeshPacket and Subpacket message types.
-
-### Layer 1: Non reliable zero hop messaging
-
-This layer is conventional non-reliable lora packet transmission. The transmitted packet has the following representation on the ether:
-
-- A 32 bit LORA preamble (to allow receiving radios to synchronize clocks and start framing). We use a longer than minimum (8 bit) preamble to maximize the amount of time the LORA receivers can stay asleep, which dramatically lowers power consumption.
-
-After the preamble the 16 byte packet header is transmitted. This header is described directly by the PacketHeader class in the C++ source code. But indirectly it matches the first portion of the "MeshPacket" protobuf definition. But notably: this portion of the packet is sent directly as the following 16 bytes (rather than using the protobuf encoding). We do this to both save airtime and to allow receiving radio hardware the option of filtering packets before even waking the main CPU.
-
-- to (4 bytes): the unique NodeId of the destination (or 0xffffffff for NodeNum_BROADCAST)
-- from (4 bytes): the unique NodeId of the sender)
-- id (4 bytes): the unique (wrt the sending node only) packet ID number for this packet. We use a large (32 bit) packet ID to ensure there is enough unique state to protect any encrypted payload from attack.
-- flags (4 bytes): Only a few bits are are currently used - 3 bits for for the "HopLimit" (see below) and 1 bit for "WantAck"
-
-After the packet header the actual packet is placed onto the the wire. These bytes are merely the encrypted packed protobuf encoding of the SubPacket protobuf. A full description of our encryption is available in [crypto](crypto.md). It is worth noting that only this SubPacket is encrypted, headers are not. Which leaves open the option of eventually allowing nodes to route packets without knowing the keys used to encrypt.
-
-NodeIds are constructed from the bottom four bytes of the macaddr of the bluetooth address. Because the OUI is assigned by the IEEE and we currently only support a few CPU manufacturers, the upper byte is defacto guaranteed unique for each vendor. The bottom 3 bytes are guaranteed unique by that vendor.
-
-To prevent collisions all transmitters will listen before attempting to send. If they hear some other node transmitting, they will reattempt transmission in x milliseconds. This retransmission delay is random between FIXME and FIXME (these two numbers are currently hardwired, but really should be scaled based on expected packet transmission time at current channel settings).
-
-### Layer 2: Reliable zero hop messaging
-
-This layer adds reliable messaging between the node and its immediate neighbors (only).
-
-The default messaging provided by layer-1 is extended by setting the "want-ack" flag in the MeshPacket protobuf. If want-ack is set the following documentation from mesh.proto applies:
-
-"""This packet is being sent as a reliable message, we would prefer it to arrive
-at the destination. We would like to receive a ack packet in response.
-
-Broadcasts messages treat this flag specially: Since acks for broadcasts would
-rapidly flood the channel, the normal ack behavior is suppressed. Instead,
-the original sender listens to see if at least one node is rebroadcasting this
-packet (because naive flooding algorithm). If it hears that the odds (given
-typical LoRa topologies) the odds are very high that every node should
-eventually receive the message. So FloodingRouter.cpp generates an implicit
-ack which is delivered to the original sender. If after some time we don't
-hear anyone rebroadcast our packet, we will timeout and retransmit, using the
-regular resend logic."""
-
-If a transmitting node does not receive an ACK (or a NAK) packet within FIXME milliseconds, it will use layer-1 to attempt a retransmission of the sent packet. A reliable packet (at this 'zero hop' level) will be resent a maximum of three times. If no ack or nak has been received by then the local node will internally generate a nak (either for local consumption or use by higher layers of the protocol).
-
-### Layer 3: (Naive) flooding for multi-hop messaging
-
-Given our use-case for the initial release, most of our protocol is built around [flooding](<https://en.wikipedia.org/wiki/Flooding_(computer_networking)>). The implementation is currently 'naive' - i.e. it doesn't try to optimize flooding other than abandoning retransmission once we've seen a nearby receiver has acked the packet. Therefore, for each source packet up to N retransmissions might occur (if there are N nodes in the mesh).
-
-Each node in the mesh, if it sees a packet on the ether with HopLimit set to a value other than zero, it will decrement that HopLimit and attempt retransmission on behalf of the original sending node.
-
-### Layer 4: DSR for multi-hop unicast messaging
-
-This layer is not yet fully implemented (and not yet used). But eventually (if we stay with our own transport rather than switching to QMesh or Reticulum)
-we will use conventional DSR for unicast messaging. Currently (even when not requiring 'broadcasts') we send any multi-hop unicasts as 'broadcasts' so that we can
-leverage our (functional) flooding implementation. This is suboptimal but it is a very rare use-case, because the odds are high that most nodes (given our small networks and 'hiking' use case) are within a very small number of hops. When any node witnesses an ack for a packet, it will realize that it can abandon its own
-broadcast attempt for that packet.
-
-## Misc notes on remaining tasks
-
-This section is currently poorly formatted, it is mostly a mere set of todo lists and notes for @geeksville during his initial development. After release 1.0 ideas for future optimization include:
-
-- Make flood-routing less naive (because we have GPS and radio signal strength as heuristics to avoid redundant retransmissions)
-- If nodes have been user marked as 'routers', preferentially do flooding via those nodes
-- Fully implement DSR to improve unicast efficiency (or switch to QMesh/Reticulum as these projects mature)
-
-great source of papers and class notes: http://www.cs.jhu.edu/~cs647/
-
-flood routing improvements
-
-- DONE if we don't see anyone rebroadcast our want_ack=true broadcasts, retry as needed.
-
-reliable messaging tasks (stage one for DSR):
-
-- DONE generalize naive flooding
-- DONE add a max hops parameter, use it for broadcast as well (0 means adjacent only, 1 is one forward etc...). Store as three bits in the header.
-- DONE add a 'snoopReceived' hook for all messages that pass through our node.
-- DONE use the same 'recentmessages' array used for broadcast msgs to detect duplicate retransmitted messages.
-- DONE in the router receive path?, send an ack packet if want_ack was set and we are the final destination. FIXME, for now don't handle multihop or merging of data replies with these acks.
-- DONE keep a list of packets waiting for acks
-- DONE for each message keep a count of # retries (max of three). Local to the node, only for the most immediate hop, ignorant of multihop routing.
-- DONE delay some random time for each retry (large enough to allow for acks to come in)
-- DONE once an ack comes in, remove the packet from the retry list and deliver the ack to the original sender
-- DONE after three retries, deliver a no-ack packet to the original sender (i.e. the phone app or mesh router service)
-- DONE test one hop ack/nak with the python framework
-- DONE Do stress test with acks
-
-dsr tasks
-
-- DONE oops I might have broken message reception
-- DONE Don't use broadcasts for the network pings (close open github issue)
-- DONE add ignoreSenders to radioconfig to allow testing different mesh topologies by refusing to see certain senders
-- DONE test multihop delivery with the python framework
-
-optimizations / low priority:
-
-- read this [this](http://pages.cs.wisc.edu/~suman/pubs/nadv-mobihoc05.pdf) paper and others and make our naive flood routing less naive
-- read @cyclomies long email with good ideas on optimizations and reply
-- DONE Remove NodeNum assignment algorithm (now that we use 4 byte node nums)
-- DONE make android app warn if firmware is too old or too new to talk to
-- change nodenums and packetids in protobuf to be fixed32
-- low priority: think more careful about reliable retransmit intervals
-- make ReliableRouter.pending threadsafe
-- bump up PacketPool size for all the new ack/nak/routing packets
-- handle 51 day rollover in doRetransmissions
-- use a priority queue for the messages waiting to send. Send acks first, then routing messages, then data messages, then broadcasts?
-
-when we send a packet
-
-- do "hop by hop" routing
-- when sending, if destnodeinfo.next_hop is zero (and no message is already waiting for an arp for that node), startRouteDiscovery() for that node. Queue the message in the 'waiting for arp queue' so we can send it later when then the arp completes.
-- otherwise, use next_hop and start sending a message (with ack request) towards that node (starting with next_hop).
-
-when we receive any packet
-
-- sniff and update tables (especially useful to find adjacent nodes). Update user, network and position info.
-- if we need to route() that packet, resend it to the next_hop based on our nodedb.
-- if it is broadcast or destined for our node, deliver locally
-- handle routereply/routeerror/routediscovery messages as described below
-- then free it
-
-routeDiscovery
-
-- if we've already passed through us (or is from us), then it ignore it
-- use the nodes already mentioned in the request to update our routing table
-- if they were looking for us, send back a routereply
-- NOT DOING FOR NOW -if max_hops is zero and they weren't looking for us, drop (FIXME, send back error - I think not though?)
-- if we receive a discovery packet, and we don't have next_hop set in our nodedb, we use it to populate next_hop (if needed) towards the requester (after decrementing max_hops)
-- if we receive a discovery packet, and we have a next_hop in our nodedb for that destination we send a (reliable) we send a route reply towards the requester
-
-when sending any reliable packet
-
-- if timeout doing retries, send a routeError (nak) message back towards the original requester. all nodes eavesdrop on that packet and update their route caches.
-
-when we receive a routereply packet
-
-- update next_hop on the node, if the new reply needs fewer hops than the existing one (we prefer shorter paths). fixme, someday use a better heuristic
-
-when we receive a routeError packet
-
-- delete the route for that failed recipient, restartRouteDiscovery()
-- if we receive routeerror in response to a discovery,
-- fixme, eventually keep caches of possible other routes.
-
-TODO:
-
-- optimize our generalized flooding with heuristics, possibly have particular nodes self mark as 'router' nodes.
-
-- DONE reread the radiohead mesh implementation - hop to hop acknowledgement seems VERY expensive but otherwise it seems like DSR
-- DONE read about mesh routing solutions (DSR and AODV)
-- DONE read about general mesh flooding solutions (naive, MPR, geo assisted)
-- DONE reread the disaster radio protocol docs - seems based on Babel (which is AODVish)
-- REJECTED - seems dying - possibly dash7? https://www.slideshare.net/MaartenWeyn1/dash7-alliance-protocol-technical-presentation https://github.com/MOSAIC-LoPoW/dash7-ap-open-source-stack - does the opensource stack implement multihop routing? flooding? their discussion mailing list looks dead-dead
-- update duty cycle spreadsheet for our typical usecase
-
-a description of DSR: https://tools.ietf.org/html/rfc4728 good slides here: https://www.slideshare.net/ashrafmath/dynamic-source-routing
-good description of batman protocol: https://www.open-mesh.org/projects/open-mesh/wiki/BATMANConcept
-
-interesting paper on lora mesh: https://portal.research.lu.se/portal/files/45735775/paper.pdf
-It seems like DSR might be the algorithm used by RadioheadMesh. DSR is described in https://tools.ietf.org/html/rfc4728
-https://en.wikipedia.org/wiki/Dynamic_Source_Routing
-
-broadcast solution:
-Use naive flooding at first (FIXME - do some math for a 20 node, 3 hop mesh. A single flood will require a max of 20 messages sent)
-Then move to MPR later (http://www.olsr.org/docs/report_html/node28.html). Use altitude and location as heursitics in selecting the MPR set
-
-compare to db sync algorithm?
-
-what about never flooding gps broadcasts. instead only have them go one hop in the common case, but if any node X is looking at the position of Y on their gui, then send a unicast to Y asking for position update. Y replies.
-
-If Y were to die, at least the neighbor nodes of Y would have their last known position of Y.
-
-## approach 1
-
-- send all broadcasts with a TTL
-- periodically(?) do a survey to find the max TTL that is needed to fully cover the current network.
-- to do a study first send a broadcast (maybe our current initial user announcement?) with TTL set to one (so therefore no one will rebroadcast our request)
-- survey replies are sent unicast back to us (and intervening nodes will need to keep the route table that they have built up based on past packets)
-- count the number of replies to this TTL 1 attempt. That is the number of nodes we can reach without any rebroadcasts
-- repeat the study with a TTL of 2 and then 3. stop once the # of replies stops going up.
-- it is important for any node to do listen before talk to prevent stomping on other rebroadcasters...
-- For these little networks I bet a max TTL would never be higher than 3?
-
-## approach 2
-
-- send a TTL1 broadcast, the replies let us build a list of the nodes (stored as a bitvector?) that we can see (and their rssis)
-- we then broadcast out that bitvector (also TTL1) asking "can any of ya'll (even indirectly) see anyone else?"
-- if a node can see someone I missed (and they are the best person to see that node), they reply (unidirectionally) with the missing nodes and their rssis (other nodes might sniff (and update their db) based on this reply but they don't have to)
-- given that the max number of nodes in this mesh will be like 20 (for normal cases), I bet globally updating this db of "nodenums and who has the best rssi for packets from that node" would be useful
-- once the global DB is shared, when a node wants to broadcast, it just sends out its broadcast . the first level receivers then make a decision "am I the best to rebroadcast to someone who likely missed this packet?" if so, rebroadcast
-
-## approach 3
-
-- when a node X wants to know other nodes positions, it broadcasts its position with want_replies=true. Then each of the nodes that received that request broadcast their replies (possibly by using special timeslots?)
-- all nodes constantly update their local db based on replies they witnessed.
-- after 10s (or whatever) if node Y notices that it didn't hear a reply from node Z (that Y has heard from recently ) to that initial request, that means Z never heard the request from X. Node Y will reply to X on Z's behalf.
-- could this work for more than one hop? Is more than one hop needed? Could it work for sending messages (i.e. for a msg sent to Z with want-reply set).
-
-## approach 4
-
-look into the literature for this idea specifically.
-
-- don't view it as a mesh protocol as much as a "distributed db unification problem". When nodes talk to nearby nodes they work together
-  to update their nodedbs. Each nodedb would have a last change date and any new changes that only one node has would get passed to the
-  other node. This would nicely allow distant nodes to propogate their position to all other nodes (eventually).
-- handle group messages the same way, there would be a table of messages and time of creation.
-- when a node has a new position or message to send out, it does a broadcast. All the adjacent nodes update their db instantly (this handles 90% of messages I'll bet).
-- Occasionally a node might broadcast saying "anyone have anything newer than time X?" If someone does, they send the diffs since that date.
-- essentially everything in this variant becomes broadcasts of "request db updates for >time X - for _all_ or for a particular nodenum" and nodes sending (either due to request or because they changed state) "here's a set of db updates". Every node is constantly trying to
-  build the most recent version of reality, and if some nodes are too far, then nodes closer in will eventually forward their changes to the distributed db.
-- construct non ambigious rules for who broadcasts to request db updates. ideally the algorithm should nicely realize node X can see most other nodes, so they should just listen to all those nodes and minimize the # of broadcasts. the distributed picture of nodes rssi could be useful here?
-- possibly view the BLE protocol to the radio the same way - just a process of reconverging the node/msgdb database.

docs/software/mqtt.md

@@ -1,192 +0,0 @@
-
-# Table of Contents
-- [Table of Contents](#table-of-contents)
-  - [Abstract](#abstract)
-  - [Short term goals](#short-term-goals)
-  - [Long term goals](#long-term-goals)
-  - [Multiple Channel support / Security](#multiple-channel-support--security)
-  - [On device API](#on-device-api)
-  - [MQTT transport](#mqtt-transport)
-    - [Topics](#topics)
-      - [Service Envelope](#service-envelope)
-      - [NODEID](#nodeid)
-      - [USERID](#userid)
-      - [CHANNELID](#channelid)
-    - [Gateway nodes](#gateway-nodes)
-    - [Optional web services](#optional-web-services)
-      - [Public MQTT broker service](#public-mqtt-broker-service)
-      - [Riot.im messaging bridge](#riotim-messaging-bridge)
-    - [Deprecated concepts](#deprecated-concepts)
-      - [MESHID (deprecated)](#meshid-deprecated)
-      - [DESTCLASS (deprecated)](#destclass-deprecated)
-      - [DESTID (deprecated)](#destid-deprecated)
-  - [Rejected idea: RAW UDP](#rejected-idea-raw-udp)
-  - [Development plan](#development-plan)
-    - [Work items](#work-items)
-    - [Enhancements in following releases](#enhancements-in-following-releases)
-
-## Abstract
-
-This is a mini-doc/RFC sketching out a development plan to satisfy a number of 1.1 goals.
-
-- [MQTT](https://opensource.com/article/18/6/mqtt) internet accessible API.  Issue #[369](https://github.com/meshtastic/Meshtastic-device/issues/169)
-- An open API to easily run custom mini-apps on the devices
-- A text messaging bridge when a node in the mesh can gateway to the internet. Issue #[353](https://github.com/meshtastic/Meshtastic-device/issues/353) and this nicely documented [android issue](https://github.com/meshtastic/Meshtastic-Android/issues/2).
-- An easy way to let desktop app developers remotely control GPIOs. Issue #[182](https://github.com/meshtastic/Meshtastic-device/issues/182)
-- Remote attribute access (to change settings of distant nodes). Issue #182
-
-## Short term goals
-
-- We want a clean API for novice developers to write mini "apps" that run **on the device** with the existing messaging/location "apps".
-- We want the ability to have a gateway web service, so that if any node in the mesh can connect to the internet (via its connected phone app or directly) then that node will provide bidirectional messaging between nodes and the internet.
-- We want an easy way for novice developers to remotely read and control GPIOs (because this is an often requested use case), without those developers having to write any device code.
-- We want a way to gateway text messaging between our current private meshes and the broader internet (when that mesh is able to connect to the internet)
-- We want a way to remotely set any device/channel parameter on a node. This is particularly important for administering physically inaccessible router nodes. Ideally this mechanism would also be used for administering the local node (so one common mechanism for both cases).
-- This work should be independent of our current (semi-custom) LoRa transport, so that in the future we can swap out that transport if we wish (to QMesh or Reticulum?)
-- Our networks are (usually) very slow and low bandwidth, so the messaging must be very airtime efficient.
-
-## Long term goals
-
-- Store and forward messaging should be supported, so apps can send messages that might be delivered to their destination in **hours** or **days** if a node/mesh was partitioned.
-
-## Multiple Channel support / Security
-
-Mini-apps API can bind to particular channels. They will only see messages sent on that channel.
-
-During the 1.0 timeframe only one channel was supported per node.  Starting in the 1.1 tree we will do things like "remote admin operations / channel settings etc..." are on the "Control" channel and only especially trusted users should have the keys to access that channel.
-
-FIXME - explain this more, talk about how useful for users and security domains.
-- add channels as security
-
-## On device API
-
-For information on the related on-device API see [here](device-api.md).
-
-## MQTT transport
-
-Any gateway-device will contact the MQTT broker. 
-
-### Topics
-
-The "mesh/crypt/CHANNELID/NODEID/PORTID" [topic](https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/) will be used for messages sent from/to a mesh.
-
-Gateway nodes will foward any MeshPacket from a local mesh channel with uplink_enabled.  The packet (encapsulated in a ServiceEnvelope) will remain encrypted with the key for the specified channel.  
-
-For any channels in the local node with downlink_enabled, the gateway node will forward packets from MQTT to the local mesh.  It will do this by subscribing to mesh/crypt/CHANNELID/# and forwarding relevant packets.
-
-If the channelid 'well known'/public it could be decrypted by a web service (if the web service was provided with the associated channel key), in which case it will be decrypted by a web service and appear at "mesh/clear/CHANNELID/NODEID/PORTID". Note: This is not in the initial deliverable. 
-
-FIXME, discuss how text message global mirroring could scale (or not)
-FIXME, possibly don't global mirror text messages - instead rely on matrix/riot? 
-FIXME, discuss possible attacks by griefers and how they can be prvented
-
-#### Service Envelope
-
-The payload published on mesh/... will always be wrapped in a [ServiceEnvelope protobuf](https://github.com/meshtastic/Meshtastic-protobufs/blob/master/docs/docs.md#.ServiceEnvelope).
-
-ServiceEnvelope will include the message, and full information about arrival time, who forwarded it, source channel, source mesh id, etc... 
-
-#### NODEID
-
-The unique ID for a node. A hex string that starts with a ! symbol.
-
-#### USERID
-
-A user ID string. This string is either a user ID if known or a nodeid to simply deliver the message to whoever the local user is of a particular device (i.e. person who might see the screen). FIXME, see what riot.im uses and perhaps use that convention? Or use the signal +phone number convention? Or the email addr?
-
-#### CHANNELID
-
-FIXME, figure out how channelids work
-
-### Gateway nodes
-
-Any meshtastic node that has a direct connection to the internet (either via a helper app or installed wifi/4G/satellite hardware) can function as a "Gateway node". 
-
-Gateway nodes (via code running in the phone) will contain two tables to whitelist particular traffic to either be delivered toward the internet, or down toward the mesh. Users that are developing custom apps will be able to customize these filters/subscriptions.
-
-Since multiple gateway nodes might be connected to a single mesh, it is possible that duplicate messages will be published on any particular topic.  Therefore subscribers to these topics should
-deduplicate if needed by using the packet ID of each message.
-
-### Optional web services
-
-#### Public MQTT broker service
-
-An existing public [MQTT broker](https://mosquitto.org/) will be the default for this service, but clients can use any MQTT broker they choose. 
-
-FIXME - figure out how to avoid impersonation (because we are initially using a public mqtt server with no special security options).  FIXME, include some ideas on this in the ServiceEnvelope documentation.
-
-#### Riot.im messaging bridge
-
-@Geeksville will run a riot.im bridge that talks to the public MQTT broker and sends/receives into the riot.im network.
-
-There is apparently [already](https://github.com/derEisele/tuple) a riot.im [bridge](https://matrix.org/bridges/) for MQTT. That will possibly need to be customized a bit. But by doing this, we should be able to let random riot.im users send/receive messages to/from any meshtastic device. (FIXME ponder security).  See this [issue](https://github.com/meshtastic/Meshtastic-Android/issues/2#issuecomment-645660990) with discussion with the dev.
-
-### Deprecated concepts
-
-You can ignore these for now...
-
-#### MESHID (deprecated)
-
-Earlier drafts of this document included the concept of a MESHID.  That concept has been removed for now, but might be useful in the future.  The old idea is listed below:
-
-A unique ID for this mesh. There will be some sort of key exchange process so that the mesh ID can not be impersonated by other meshes. 
-
-#### DESTCLASS (deprecated)
-
-Earlier drafts of this document included the concept of a DESTCLASS.  That concept has been removed for now, but might be useful in the future.  The old idea is listed below:
-
-The type of DESTID this message should be delivered to. A short one letter sequence:
-
-| Symbol | Description                                                   |
-| ------ | ------------------------------------------------------------- |
-| R      | riot.im                                                       |
-| L      | local mesh node ID or ^all                                    |
-| A      | an application specific message, ID will be an APP ID         |
-| S      | SMS gateway, DESTID is a phone number to reach via Twilio.com |
-| E      | Emergency message, see bug #fixme for more context            |
-
-#### DESTID (deprecated)
-
-Earlier drafts of this document included the concept of a DESTCLASS.  That concept has been removed for now, but might be useful in the future.  The old idea is listed below:
-
-Can be...
-
-- an internet username: kevinh@geeksville.com
-- ^ALL for anyone
-- An app ID (to allow apps out in the web to receive arbitrary binary data from nodes or simply other apps using meshtastic as a transport). They would connect to the MQTT broker and subscribe to their topic
-
-## Rejected idea: RAW UDP
-
-A number of commenters have requested/proposed using UDP for the transport.  We've considered this option and decided to use MQTT instead for the following reasons:
-
-  - Most UDP uses cases would need to have a server anyways so that nodes can reach each other from anywhere (i.e. if most gateways will be behind some form of NAT which would need to be tunnelled)
-  - Raw UDP is dropped **very** agressively by many cellular providers.  MQTT from the gateway to a broker can be done over a TCP connection for this reason.
-  - MQTT provides a nice/documented/standard security model to build upon
-  - MQTT is fairly wire efficient with multiple broker implementations/providers and numerous client libraries for any language.  The actual implementation of MQTT is quite simple.
-  
-## Development plan
-
-Given the previous problem/goals statement, here's the initial thoughts on the work items required.  As this idea becomes a bit more fully baked we should add details
-on how this will be implemented and guesses at approximate work items.
-
-### Work items
-
-- Change nodeIDs to be base64 instead of eight hex digits.
-- DONE Refactor the position features into a position "mini-app". Use only the new public on-device API to implement this app.
-- DONE Refactor the on device texting features into a messaging "mini-app". (Similar to the position mini-app)
-- Add new multi channel concept
-- Send new channels to python client
-- Let python client add channels
-- Add portion of channelid to the raw lora packet header
-- Confirm that we can now forward encrypted packets without decrypting at each node
-- Use a channel named "remotehw" to secure the GPIO service.  If that channel is not found, don't even start the service.  Document this as the standard method for securing services.
-- Add first cut of the "gateway node" code (i.e. MQTT broker client) to the python API (very little code needed for this component)
-- Confirm that texting works to/from the internet
-- Confirm that positions are optionally sent to the internet
-- Add the first cut of the "gateway node" code to the android app (very little code needed for this component)
-
-### Enhancements in following releases
-
-The initial gateway will be added to the python tool.  But the gateway implementation is designed to be fairly trivial/dumb.  After the initial release the actual gateway code can be ported to also run inside of the android app.  In fact, we could have ESP32 based nodes include a built-in "gateway node" implementation.
-
-Store and forward could be added so that nodes on the mesh could deliver messages (i.e. text messages) on an "as possible" basis.  This would allow things like "hiker sends a message to friend - mesh can not currently reach friend - eventually (days later) mesh can somehow reach friend, message gets delivered"

docs/software/nrf52-TODO.md

@@ -1,289 +0,0 @@
-# NRF52 TODO
-
-- Possibly switch from softdevice to Apachy Newt: https://github.com/espressif/esp-nimble
-  https://github.com/apache/mynewt-core - use nimble BLE on both ESP32 and NRF52
-
-## RAK815
-
-### 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)
-- i2c gps comms not quite right
-- ble: AdafruitBluefruit::begin - adafruit_ble_task was assigned an invalid stack pointer. out of memory?
-- measure power draw
-
-### Bootloader
-
-Install our (temporarily hacked up) adafruit bootloader
-
-```
-kevinh@kevin-server:~/development/meshtastic/Adafruit_nRF52_Bootloader$ make BOARD=rak815 sd flash
-LD rak815_bootloader-0.3.2-111-g9478eb7-dirty.out
-   text	   data	    bss	    dec	    hex	filename
-  20888	   1124	  15006	  37018	   909a	_build/build-rak815/rak815_bootloader-0.3.2-111-g9478eb7-dirty.out
-Create rak815_bootloader-0.3.2-111-g9478eb7-dirty.hex
-Create rak815_bootloader-0.3.2-111-g9478eb7-dirty-nosd.hex
-Flashing: rak815_bootloader-0.3.2-111-g9478eb7-dirty-nosd.hex
-nrfjprog --program _build/build-rak815/rak815_bootloader-0.3.2-111-g9478eb7-dirty-nosd.hex --sectoranduicrerase -f nrf52 --reset
-Parsing hex file.
-Erasing page at address 0x0.
-Erasing page at address 0x74000.
-Erasing page at address 0x75000.
-Erasing page at address 0x76000.
-Erasing page at address 0x77000.
-Erasing page at address 0x78000.
-Erasing page at address 0x79000.
-Erasing UICR flash area.
-Applying system reset.
-Checking that the area to write is not protected.
-Programming device.
-Applying system reset.
-Run.
-```
-
-### Appload
-
-tips on installing https://github.com/platformio/platform-nordicnrf52/issues/8#issuecomment-374017768
-
-to see console output over jlink:
-
-```
-12:17
-in one tab run "bin/nrf52832-gdbserver.sh" - leave this running the whole time while developing/debugging
-12:17
-~/development/meshtastic/meshtastic-esp32$ bin/nrf52-console.sh
-###RTT Client: ************************************************************
-###RTT Client: *               SEGGER Microcontroller GmbH                *
-###RTT Client: *   Solutions for real time microcontroller applications   *
-###RTT Client: ************************************************************
-###RTT Client: *                                                          *
-###RTT Client: *       (c) 2012 - 2016  SEGGER Microcontroller GmbH       *
-###RTT Client: *                                                          *
-###RTT Client: *     www.segger.com     Support: support@segger.com       *
-###RTT Client: *                                                          *
-###RTT Client: ************************************************************
-###RTT Client: *                                                          *
-###RTT Client: * SEGGER J-Link RTT Client   Compiled Apr  7 2020 15:01:22 *
-###RTT Client: *                                                          *
-###RTT Client: ************************************************************
-###RTT Client: -----------------------------------------------
-###RTT Client: Connecting to J-Link RTT Server via localhost:19021 ..............
-###RTT Client: Connected.
-SEGGER J-Link V6.70c - Real time terminal output
-SEGGER J-Link ARM V9.6, SN=69663845
-Process: JLinkGDBServerCLExein another tab run:
-12:18
-On NRF52 I've been using the jlink fake serial console.  But since the rak815 has the serial port hooked up we can switch back to that once the basics are working.
-```
-
-## Misc work items
-
-RAM investigation.
-nRF52832-QFAA 64KB ram, 512KB flash vs
-nrf52832-QFAB 32KB ram, 512kb flash
-nrf52833 128KB RAM
-nrf52840 256KB RAM, 1MB flash
-
-Manual hacks needed to build (for now):
-
-kevinh@kevin-server:~/.platformio/packages/framework-arduinoadafruitnrf52/variants\$ ln -s ~/development/meshtastic/meshtastic-esp32/variants/\* .
-
-## Initial work items
-
-Minimum items needed to make sure hardware is good.
-
-- DONE set power UICR per https://devzone.nordicsemi.com/f/nordic-q-a/28562/nrf52840-regulator-configuration
-- switch charge controller into / out of performance mode (see 8.3.1 in datasheet)
-- write UC1701 wrapper
-- Test hardfault handler for null ptrs (if one isn't already installed)
-- test my hackedup bootloader on the real hardware
-- Use the PMU driver on real hardware
-- Use new radio driver on real hardware
-- Use UC1701 LCD driver on real hardware. Still need to create at startup and probe on SPI. Make sure SPI is atomic.
-- set vbus voltage per https://infocenter.nordicsemi.com/topic/ps_nrf52840/power.html?cp=4_0_0_4_2
-- test the LEDs
-- test the buttons
-
-## Secondary work items
-
-Needed to be fully functional at least at the same level of the ESP32 boards. At this point users would probably want them.
-
-- DONE get serial API working
-- get full BLE api working
-- make power management/sleep work properly
-- make a settimeofday implementation
-- DONE increase preamble length? - will break other clients? so all devices must update
-- DONE enable BLE DFU somehow
-- report appversion/hwversion in BLE
-- use new LCD driver from screen.cpp. Still need to hook it to a subclass of (poorly named) OLEDDisplay, and override display() to stream bytes out to the screen.
-- we need to enable the external tcxo for the sx1262 (on dio3)?
-- figure out which regulator mode the sx1262 is operating in
-- turn on security for BLE, make pairing work
-- make ble endpoints not require "start config", just have them start in config mode
-- use new PMU to provide battery voltage/% full to app (both bluetooth and screen)
-- do initial power measurements, measure effects of more preamble bits, measure power management and confirm battery life
-- set UICR.CUSTOMER to indicate board model & version
-
-## Items to be 'feature complete'
-
-- check datasheet about sx1262 temperature compensation
-- enable brownout detection and watchdog
-- stop polling for GPS characters, instead stay blocked on read in a thread
-- figure out what the correct current limit should be for the sx1262, currently we just use the default 100
-- put sx1262 in sleepmode when processor gets shutdown (or rebooted), ideally even for critical faults (to keep power draw low). repurpose deepsleep state for this.
-- good power management tips: https://devzone.nordicsemi.com/nordic/nordic-blog/b/blog/posts/optimizing-power-on-nrf52-designs
-- call PMU set_ADC_CONV(0) during sleep, to stop reading PMU adcs and decrease current draw
-- do final power measurements
-- backport the common PMU API between AXP192 and PmuBQ25703A
-- use the new buttons in the UX
-- currently using soft device SD140, is that ideal?
-- turn on the watchdog timer, require servicing from key application threads
-- nrf52setup should call randomSeed(tbd)
-- implement SYSTEMOFF behavior per https://infocenter.nordicsemi.com/topic/ps_nrf52840/power.html?cp=4_0_0_4_2
-
-## Things to do 'someday'
-
-Nice ideas worth considering someday...
-
-- enable monitor mode debugging (need to use real jlink): https://devzone.nordicsemi.com/nordic/nordic-blog/b/blog/posts/monitor-mode-debugging-with-j-link-and-gdbeclipse
-- Improve efficiency of PeriodicTimer by only checking the next queued timer event, and carefully sorting based on schedule
-- make a Mfg Controller and device under test classes as examples of custom app code for third party devs. Make a post about this. Use a custom payload type code. Have device under test send a broadcast with max hopcount of 0 for the 'mfgcontroller' payload type. mfg controller will read SNR and reply. DOT will declare failure/success and switch to the regular app screen.
-- Hook Segger RTT to the nordic logging framework. https://devzone.nordicsemi.com/nordic/nordic-blog/b/blog/posts/debugging-with-real-time-terminal
-- Use nordic logging for DEBUG_MSG
-- use the Jumper simulator to run meshes of simulated hardware: https://docs.jumper.io/docs/install.html
-- make/find a multithread safe debug logging class (include remote logging and timestamps and levels). make each log event atomic.
-- turn on freertos stack size checking
-- Currently we use Nordic's vendor ID, which is apparently okay: https://devzone.nordicsemi.com/f/nordic-q-a/44014/using-nordic-vid-and-pid-for-nrf52840 and I just picked a PID of 0x4403
-- Use NRF logger module (includes flash logging etc...) instead of DEBUG_MSG
-- Use "LED softblink" library on NRF52 to do nice pretty "breathing" LEDs. Don't whack LED from main thread anymore.
-- decrease BLE xmit power "At 0dBm with the DC/DC on, the nRF52832 transmitter draws 5.3mA. Increasing the TX power to +4dBm adds only 2.2mA. Decreasing it to -40 dBm saves only 2.6mA."
-- in addition to the main CPU watchdog, use the PMU watchdog as a really big emergency hammer
-- turn on 'shipping mode' in the PMU when device is 'off' - to cut battery draw to essentially zero
-- make Lorro_BQ25703A read/write operations atomic, current version could let other threads sneak in (once we start using threads)
-- make the segger logbuffer larger, move it to RAM that is preserved across reboots and support reading it out at runtime (to allow full log messages to be included in crash reports). Share this code with ESP32 (use gcc noinit attribute)
-- convert hardfaults/panics/asserts/wd exceptions into fault codes sent to phone
-- stop enumerating all i2c devices at boot, it wastes power & time
-- consider using "SYSTEMOFF" deep sleep mode, without RAM retension. Only useful for 'truly off - wake only by button press' only saves 1.5uA vs SYSTEMON. (SYSTEMON only costs 1.5uA). Possibly put PMU into shipping mode?
-- change the BLE protocol to be more symmetric. Have the phone _also_ host a GATT service which receives writes to
-  'fromradio'. This would allow removing the 'fromnum' mailbox/notify scheme of the current approach and decrease the number of packet handoffs when a packet is received.
-- Using the preceeding, make a generalized 'nrf52/esp32 ble to internet' bridge service. To let nrf52 apps do MQTT/UDP/HTTP POST/HTTP GET operations to web services.
-- lower advertise interval to save power, lower ble transmit power to save power
-- the SX126x class does SPI transfers on a byte by byte basis, which is very ineffecient. Much better to do block writes/reads.
-
-## Old unorganized notes
-
-## Notes on PCA10059 Dongle
-
-- docs: https://infocenter.nordicsemi.com/pdf/nRF52840_Dongle_User_Guide_v1.0.pdf
-
-- Currently using Nordic PCA10059 Dongle hardware
-- https://community.platformio.org/t/same-bootloader-same-softdevice-different-board-different-pins/11411/9
-
-- To make Segger JLink more reliable, turn off its fake filesystem. "JLinkExe MSDDisable" per https://learn.adafruit.com/circuitpython-on-the-nrf52/nrf52840-bootloader
-
-## Done
-
-- DONE add "DFU trigger library" to application load
-- DONE: using this: Possibly use this bootloader? https://github.com/adafruit/Adafruit_nRF52_Bootloader
-- DONE select and install a bootloader (adafruit)
-- DONE get old radio driver working on NRF52
-- DONE basic test of BLE
-- DONE get a debug 'serial' console working via the ICE passthrough feature
-- DONE switch to RadioLab? test it with current radio. https://github.com/jgromes/RadioLib
-- DONE change rx95 to radiolib
-- DONE track rxbad, rxgood, txgood
-- 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 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
-- make a new boarddef with a variant.h file. Fix pins in that file. In particular (at least):
-  #define PIN_SPI_MISO (46)
-  #define PIN_SPI_MOSI (45)
-  #define PIN_SPI_SCK (47)
-  #define PIN_WIRE_SDA (26)
-  #define PIN_WIRE_SCL (27)
-- customize the bootloader to use proper button bindings
-- remove the MeshRadio wrapper - we don't need it anymore, just do everything in RadioInterface subclasses.
-- DONE use SX126x::startReceiveDutyCycleAuto to save power by sleeping and briefly waking to check for preamble bits. Change xmit rules to have more preamble bits.
-- scheduleOSCallback doesn't work yet - it is way too fast (causes rapid polling of busyTx, high power draw etc...)
-- find out why we reboot while debugging - it was bluetooth/softdevice
-- make a file system implementation (preferably one that can see the files the bootloader also sees) - preferably https://github.com/adafruit/Adafruit_nRF52_Arduino/blob/master/libraries/InternalFileSytem/examples/Internal_ReadWrite/Internal_ReadWrite.ino else use https://infocenter.nordicsemi.com/topic/com.nordic.infocenter.sdk5.v15.3.0/lib_fds_usage.html?cp=7_5_0_3_55_3
-- change packet numbers to be 32 bits
-
-```
-
-/*
-per
-https://docs.platformio.org/en/latest/tutorials/nordicnrf52/arduino_debugging_unit_testing.html
-
-ardunino github is here https://github.com/sandeepmistry/arduino-nRF5
-devboard hw docs here:
-https://infocenter.nordicsemi.com/topic/ug_nrf52840_dk/UG/nrf52840_DK/hw_buttons_leds.html?cp=4_0_4_7_6
-
-https://docs.platformio.org/en/latest/boards/nordicnrf52/nrf52840_dk_adafruit.html
-
-must install adafruit bootloader first!
-https://learn.adafruit.com/circuitpython-on-the-nrf52/nrf52840-bootloader
-see link above and turn off jlink filesystem if we see unreliable serial comms
-over USBCDC
-
-adafruit bootloader install commands (from their readme)
-kevinh@kevin-server:~/.platformio/packages/framework-arduinoadafruitnrf52/bootloader$
-nrfjprog -e -f nrf52 Erasing user available code and UICR flash areas. Applying
-system reset.
-kevinh@kevin-server:~/.platformio/packages/framework-arduinoadafruitnrf52/bootloader$
-nrfjprog --program pca10056/pca10056_bootloader-0.3.2_s140_6.1.1.hex -f nrf52
-Parsing hex file.
-Reading flash area to program to guarantee it is erased.
-Checking that the area to write is not protected.
-Programming device.
-kevinh@kevin-server:~/.platformio/packages/framework-arduinoadafruitnrf52/bootloader$
-nrfjprog --reset -f nrf52 Applying system reset. Run.
-
-install jlink tools from here:
-https://www.segger.com/downloads/jlink#J-LinkSoftwareAndDocumentationPack
-
-install nrf tools from here:
-https://www.nordicsemi.com/Software-and-tools/Development-Tools/nRF-Command-Line-Tools/Download#infotabs
-
-examples of turning off the loop call to save power:
-https://learn.adafruit.com/bluefruit-nrf52-feather-learning-guide/advertising-beacon
-
-example of a more complex BLE service:
-https://learn.adafruit.com/bluefruit-nrf52-feather-learning-guide/custom-hrm
-*/
-
-// See g_ADigitalPinMap to see how arduino maps to the real gpio#s - and all in
-// P0
-#define LED1 14
-#define LED2 13
-
-/*
-good led ble demo:
-https://github.com/adafruit/Adafruit_nRF52_Arduino/blob/master/libraries/Bluefruit52Lib/examples/Peripheral/nrf_blinky/nrf_blinky.ino
-*/
-```

docs/software/pinetab.md

@@ -1,34 +0,0 @@
-# Pinetab
-
-These are **preliminary** notes on support for Meshtastic in the Pinetab.
-
-A RF95 is connected via a CH341 USB-SPI chip.
-
-Pin assignments:
-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
-Use ARM linux: https://platformio.org/platforms/linux_arm
-And  linux native: https://platformio.org/platforms/native
-
-* Test cs341 driver - just test reading/writing a register and detecting interrupts, confirm can see rf95
-* Make a radiolib spi module that targets the cs341 (and builds on linux)
-* use new radiolib module to hook pinebook lora to meshtastic, confirm mesh discovery works
-* Make a subclass of StreamAPI that works as a posix TCP server
-* Use new TCP endpoint from meshtastic-python

docs/software/plugin-api.md

@@ -1,81 +0,0 @@
-# Plugin-API
-
-This is a tutorial on how to write small plugins which run on the device.  Plugins are bits regular 'arduino' code that can send and receive packets to other nodes/apps/PCs using our mesh.
-
-## Key concepts
-
-All plugins should be subclasses of MeshPlugin.  By inheriting from this class and creating an instance of your new plugin your plugin will be automatically registered to receive packets.
-
-Messages are sent to particular port numbers (similar to UDP networking).  Your new plugin should eventually pick its own port number (see below), but at first you can simply use PRIVATE_APP (which is the default).
-
-Packets can be sent/received either as raw binary structures or as [Protobufs](https://developers.google.com/protocol-buffers).
-
-### Class heirarchy
-
-The relevant bits of the class heirarchy are as follows
-
-* [MeshPlugin](/src/mesh/MeshPlugin.h) (in src/mesh/MeshPlugin.h) - you probably don't want to use this baseclass directly
-  * [SinglePortPlugin](/src/mesh/SinglePortPlugin.h) (in src/mesh/SinglePortPlugin.h) - for plugins that send/receive from a single port number (the normal case)
-    * [ProtobufPlugin](/src/mesh/ProtobufPlugin.h) (in src/mesh/ProtobufPlugin.h) - for plugins that send/receive a single particular Protobuf type.  Inherit from this if you are using protocol buffers in your plugin.
-
-You will typically want to inherit from either SinglePortPlugin (if you are just sending/receiving raw bytes) or ProtobufPlugin (if you are sending/receiving protobufs).  You'll implement your own handleReceived/handleReceivedProtobuf - probably based on the example code.
-
-If your plugin needs to perform any operations at startup you can override and implement the setup() method to run your code.
-
-If you need to send a packet you can call service.sendToMesh with code like this (from the examples):
-
-```
-    MeshPacket *p = allocReply();
-    p->to = dest;
-
-    service.sendToMesh(p);
-```
-
-## Example plugins
-
-A number of [key services](/src/plugins) are implemented using the plugin API, these plugins are as follows:
-
-* [TextMessagePlugin](/src/plugins/TextMessagePlugin.h) - receives text messages and displays them on the LCD screen/stores them in the local DB
-* [NodeInfoPlugin](/src/plugins/NodeInfoPlugin.h) - receives/sends User information to other nodes so that usernames are available in the databases
-* [RemoteHardwarePlugin](/src/plugins/RemoteHardwarePlugin.h) - a plugin that provides easy remote access to device hardware (for things like turning GPIOs on or off).  Intended to be a more extensive example and provide a useful feature of its own.  See [remote-hardware](remote-hardware.md) for details.
-* [ReplyPlugin](/src/plugins/ReplyPlugin.h) - a simple plugin that just replies to any packet it receives (provides a 'ping' service).
-
-## Getting started
-
-The easiest way to get started is:
-
-* [Build and install](build-instructions.md) the standard codebase from github.
-* Copy [src/plugins/ReplyPlugin.*](/src/plugins/ReplyPlugin.cpp) into src/plugins/YourPlugin.*.  Then change the port number from *PortNum_REPLY_APP* to *PortNum_PRIVATE_APP*.
-* Edit plugins/Plugins.cpp:setupPlugins() to add a call to create an instance of your plugin (see comment at head of that function)
-* Rebuild with your new messaging goodness and install on the device
-* Use the [meshtastic commandline tool](https://github.com/meshtastic/Meshtastic-python) to send a packet to your board, for example "*meshtastic --dest 1234 --sendping*", where *1234* is another mesh node to send the ping to.
-
-## Threading
-
-It is very common that you would like your plugin to be invoked periodically.
-We use a crude/basic cooperative threading system to allow this on any of our supported platforms.  Simply inherit from OSThread and implement runOnce().  See the OSThread [documentation](/src/concurrency/OSThread.h) for more details.  For an example consumer of this API see RemoteHardwarePlugin::runOnce.
-
-## Sending messages
-
-If you would like to proactively send messages (rather than just responding to them), just call service.sendToMesh().  For an example of this see [NodeInfoPlugin::sendOurNodeInfo(...)](/src/plugins/NodeInfoPlugin.cpp).
-
-## Picking a port number
-
-For any new 'apps' that run on the device or via sister apps on phones/PCs they should pick and use a unique 'portnum' for their application.
-
-If you are making a new app using meshtastic, please send in a pull request to add your 'portnum' to [the master list](https://github.com/meshtastic/Meshtastic-protobufs/blob/master/portnums.proto).  PortNums should be assigned in the following range:
-
-* **0-63** Core Meshtastic use; do not use for third party apps
-* **64-127** Registered 3rd party apps.  Send in a pull request that adds a new entry to portnums.proto to register your application
-* **256-511** Use one of these portnums for your private applications that you don't want to register publically
-* **1024-66559** Are reserved for use by IP tunneling (see *FIXME* for more information)
-
-All other values are reserved.
-
-## How to add custom protocol buffers
-
-If you would like to use protocol buffers to define the structures you send over the mesh (recommended), here's how to do that.
-
-* Create a new .proto file in the protos directory.  You can use the existing [remote_hardware.proto](https://github.com/meshtastic/Meshtastic-protobufs/blob/master/remote_hardware.proto) file as an example.
-* Run "bin/regen-protos.sh" to regenerate the C code for accessing the protocol buffers.  If you don't have the required nanopb tool, follow the instructions printed by the script to get it.
-* Done!  You can now use your new protobuf just like any of the existing protobufs in meshtastic.

docs/software/plugins/ExternalNotificationPlugin.md

@@ -1,89 +0,0 @@
-# About
-
-The ExternalNotification Plugin will allow you to connect a speaker, LED or other device to notify you when a message has been received from the mesh network.
-
-# Configuration
-
-These are the settings that can be configured.
-
-    ext_notification_plugin_enabled
-        Is the plugin enabled?
-        
-        0 = Disabled (Default)
-        1 = Enabled
-
-    ext_notification_plugin_active
-        Is your external circuit triggered when our GPIO is low or high?
-
-        0 = Active Low (Default)
-        1 = Active High
-
-    ext_notification_plugin_alert_message
-        Do you want to be notified on an incoming message?
-
-        0 = Disabled (Default)
-        1 = Alert when a text message comes
-
-    ext_notification_plugin_alert_bell
-        Do you want to be notified on an incoming bell?
-
-        0 = Disabled (Default)
-        1 = Alert when the bell character is received
-
-    ext_notification_plugin_output
-        What GPIO is your external circuit attached?
-
-        GPIO of the output. (Default = 13)
-
-    ext_notification_plugin_output_ms
-        How long do you want us to trigger your external circuit?
-    
-        Amount of time in ms for the alert. Default is 1000.
-
-
-# Usage Notes
-
-For basic usage, start with:
-
-	ext_notification_plugin_enabled = 1
-	ext_notification_plugin_alert_message = 1
-    
-Depending on how your external cirtcuit configured is configured, you may need to set the active state to true.
-
-	ext_notification_plugin_active = 1
-	
-## Alert Types
-
-We support being alerted on two events:
-
-1) Incoming Text Message
-
-2) Incoming Text Message that contains the ascii bell character. At present, only the Python API can send an ascii bell character, but more support may be added in the future.
-
-### Bell Character
-
-The bell character is ASCII 0x07. Include 0x07 anywhere in the text message and with ext_notification_plugin_alert_bell enabled, we will issue an external notification.
-    
-# External Hardware
-
-Be mindful of the max current sink and source of the esp32 GPIO. The easiest devices to interface with would be either an LED or Active Buzzer.
-
-Ideas for external hardware:
-
-* LED
-* Active Buzzer
-* Flame thrower
-* Strobe Light
-* Siren
-    
-# Known Problems
-
-* This won't directly support an passive (normal) speaker as it does not generate any audio wave forms.
-* This currently only supports the esp32. Other targets may be possible, I just don't have to test with.
-* This plugin only monitors text messages. We won't trigger on any other packet types.
-
-# Need more help?
-
-Go to the Meshtastic Discourse Group if you have any questions or to share how you have used this.
-
-https://meshtastic.discourse.group