tweak the roadmap in README a little

add a warning on --ch-enable and --ch-disable, which should usually be avoided

.gitattributes

@@ -0,0 +1,4 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
+*.{sh,[sS][hH]} text eol=lf

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Linting and Tests
+name: CI
 on:
   push:
     branches:
@@ -13,11 +13,10 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.6"
-          - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
     steps:
       - uses: actions/checkout@v2
       - name: Install Python 3
@@ -35,31 +34,33 @@ jobs:
           which meshtastic
           meshtastic --version
       - name: Run pylint
-        run: pylint meshtastic examples/
+        run: pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"
+      - name: Check types with mypy
+        run: mypy meshtastic/
       - name: Run tests with pytest
         run: pytest --cov=meshtastic
       - name: Generate coverage report
         run: |
           pytest --cov=meshtastic --cov-report=xml
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          file: ./coverage.xml
+          env_vars: OS, PYTHON
+          files: ./coverage.xml
           flags: unittests
           name: codecov-umbrella
-          yml: ./codecov.yml
           fail_ci_if_error: true
+          verbose: true
   validate:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version:
-          - "3.6"
-          - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
     steps:
       - uses: actions/checkout@v2
       - name: Install Python 3

.github/workflows/cleanup_artifacts.yml

@@ -0,0 +1,20 @@
+name: Remove old artifacts
+
+on:
+  schedule:
+    # Every day at 1am
+    - cron: "0 1 * * *"
+
+  workflow_dispatch:
+
+jobs:
+  remove-old-artifacts:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Remove old artifacts
+        uses: c-hive/gha-remove-artifacts@v1
+        with:
+          age: "1 month"
+          skip-tags: true

.github/workflows/release.yml

@@ -1,40 +1,52 @@
 name: Make Release
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: "Release version (Example: 1.0.0, must match 'version' in setup.py)"
-        required: true
-        default: '1.0.0'
+on: workflow_dispatch
 
 jobs:
   release_create:
     runs-on: ubuntu-latest
 
-    steps:
-
-    - name: Create GitHub release
-      uses: actions/create-release@v1
-      id: create_release
-      with:
-        draft: true
-        prerelease: true
-        release_name: ${{ github.event.inputs.version}}
-        tag_name: ${{ github.event.inputs.version}}
-        body: |
-          Autogenerated by github action, developer should edit as required before publishing...
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
     outputs:
+      version: ${{ steps.get_version.outputs.version }}
       upload_url: ${{ steps.create_release.outputs.upload_url }}
+      new_sha: ${{ steps.commit_updated.outputs.sha }}
 
-  publish_to_pypi:
-    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
+      - name: Bump version
+        run: >-
+          bin/bump_version.py
+
+      - name: Commit updated version.py
+        id: commit_updated
+        run: |
+          git config --global user.name 'github-actions'
+          git config --global user.email 'bot@noreply.github.com'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          git add setup.py
+          git commit -m "bump version" && git push || echo "No changes to commit"
+          git log -n 1 --pretty=format:"%H" | tail -n 1 | awk '{print "::set-output name=sha::"$0}'
+
+      - name: Get version
+        id: get_version
+        run: >-
+          bin/show_version.py
+
+      - name: Create GitHub release
+        uses: actions/create-release@v1
+        id: create_release
+
+        with:
+          draft: true
+          prerelease: true
+          release_name: Meshtastic Python ${{ steps.get_version.outputs.version }}
+          tag_name: ${{ steps.get_version.outputs.version }}
+          body: |
+            Autogenerated by github action, developer should edit as required before publishing...
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
@@ -62,59 +74,60 @@ jobs:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
 
+  # build-and-publish-mac:
+  #   runs-on: macos-latest
+  #   needs: release_create
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+  #       with:
+  #         ref: ${{ needs.release_create.outputs.new_sha }}
 
-  build-and-publish-mac:
-    runs-on: macos-latest
-    needs: release_create
-    steps:
+  #     - name: Set up Python 3.9
+  #       uses: actions/setup-python@v2
+  #       with:
+  #         python-version: 3.9
 
-      - name: Checkout
-        uses: actions/checkout@v2
+  #     - name: Setup code signing
+  #       env:
+  #         MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
+  #         MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
+  #         MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
+  #       run: |
+  #         echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
+  #         security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+  #         security default-keychain -s meshtastic.keychain
+  #         security unlock-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+  #         security import certificate.p12 -k meshtastic.keychain -P "$MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
+  #         security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
 
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
+  #     - name: Build
+  #       env:
+  #         MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
+  #       run: |
+  #         pip install pyinstaller
+  #         pip install -r requirements.txt
+  #         pip install .
+  #         pyinstaller -F -n meshtastic --collect-all meshtastic --codesign-identity "$MACOS_SIGNING_IDENTITY" meshtastic/__main__.py
 
-      - name: Setup code signing
-        env:
-          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
-          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
-          MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
-        run: |
-          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
-          security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-          security default-keychain -s meshtastic.keychain
-          security unlock-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-          security import certificate.p12 -k meshtastic.keychain -P "$MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
-          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-
-      - name: Build
-        env:
-          MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
-        run: |
-          pip install pyinstaller
-          pip install -r requirements.txt
-          pip install .
-          pyinstaller -F -n meshtastic --collect-all meshtastic --codesign-identity "$MACOS_SIGNING_IDENTITY" meshtastic/__main__.py
-
-      - name: Add mac to release
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.release_create.outputs.upload_url }}
-          asset_path: dist/meshtastic
-          asset_name: meshtastic_mac
-          asset_content_type: application/zip
+  #     - name: Add mac to release
+  #       uses: actions/upload-release-asset@v1
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #       with:
+  #         upload_url: ${{ needs.release_create.outputs.upload_url }}
+  #         asset_path: dist/meshtastic
+  #         asset_name: meshtastic_mac
+  #         asset_content_type: application/zip
 
   build-and-publish-ubuntu:
     runs-on: ubuntu-latest
     needs: release_create
     steps:
-
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.release_create.outputs.new_sha }}
 
       - name: Set up Python 3.9
         uses: actions/setup-python@v2
@@ -137,7 +150,7 @@ jobs:
           asset_path: dist/meshtastic
           asset_name: meshtastic_ubuntu
           asset_content_type: application/zip
-          
+
       - name: Add readme.txt to release
         uses: actions/upload-release-asset@v1
         env:
@@ -146,15 +159,16 @@ jobs:
           upload_url: ${{ needs.release_create.outputs.upload_url }}
           asset_path: standalone_readme.txt
           asset_name: readme.txt
-          asset_content_type: text/plain          
+          asset_content_type: text/plain
 
   build-and-publish-windows:
     runs-on: windows-latest
     needs: release_create
     steps:
-
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ needs.release_create.outputs.new_sha }}
 
       - name: Set up Python 3.9
         uses: actions/setup-python@v2

.github/workflows/update_protobufs.yml

@@ -15,22 +15,22 @@ jobs:
         run: |
           git pull --recurse-submodules
           git submodule update --remote --recursive
-          
+
       - name: Download nanopb
         run: |
-          wget https://jpa.kapsi.fi/nanopb/download/nanopb-0.4.4-linux-x86.tar.gz
-          tar xvzf nanopb-0.4.4-linux-x86.tar.gz
-          mv nanopb-0.4.4-linux-x86 nanopb-0.4.4
-          
+          wget https://jpa.kapsi.fi/nanopb/download/nanopb-0.4.6-linux-x86.tar.gz
+          tar xvzf nanopb-0.4.6-linux-x86.tar.gz
+          mv nanopb-0.4.6-linux-x86 nanopb-0.4.6
+
       - name: Re-generate protocol buffers
         run: |
-          ./bin/regen-protos.sh  
-          
+          ./bin/regen-protobufs.sh
+
       - name: Commit update
         run: |
           git config --global user.name 'github-actions'
           git config --global user.email 'bot@noreply.github.com'
           git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
-          git add proto
+          git add protobufs
           git add meshtastic
           git commit -m "Update protobuf submodule" && git push || echo "No changes to commit"

.gitignore

@@ -5,7 +5,7 @@ dist
 *.egg-info
 log_*
 .eggs
-nanopb-0.4.4
+nanopb-*
 .*swp
 .coverage
 *.py-E

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "proto"]
-	path = proto
-	url = https://github.com/meshtastic/Meshtastic-protobufs.git
+[submodule "protobufs"]
+	path = protobufs
+	url = http://github.com/meshtastic/protobufs

.pylintrc

@@ -7,7 +7,7 @@
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
-ignore-patterns=mqtt_pb2.py,channel_pb2.py,environmental_measurement_pb2.py,admin_pb2.py,radioconfig_pb2.py,deviceonly_pb2.py,apponly_pb2.py,remote_hardware_pb2.py,portnums_pb2.py,mesh_pb2.py,storeforward_pb2.py,cannedmessages_pb2.py
+ignore-patterns=mqtt_pb2.py,channel_pb2.py,telemetry_pb2.py,admin_pb2.py,config_pb2.py,deviceonly_pb2.py,apponly_pb2.py,remote_hardware_pb2.py,portnums_pb2.py,mesh_pb2.py,storeforward_pb2.py,cannedmessages_pb2.py,module_config_pb2.py,localonly_pb2.py,node.py,device_metadata_pb2.py,nanopb_pb2.py
 
 
 
@@ -23,8 +23,7 @@ ignore-patterns=mqtt_pb2.py,channel_pb2.py,environmental_measurement_pb2.py,admi
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 #
-disable=invalid-name,fixme,logging-fstring-interpolation,too-many-statements,too-many-branches,too-many-locals,no-member,f-string-without-interpolation,protected-access,no-self-use,pointless-string-statement,too-few-public-methods,broad-except,no-else-return,no-else-raise,bare-except
-
+disable=invalid-name,fixme,logging-fstring-interpolation,too-many-statements,too-many-branches,too-many-locals,no-member,f-string-without-interpolation,protected-access,pointless-string-statement,too-few-public-methods,broad-except,no-else-return,no-else-raise,bare-except,too-many-public-methods
 
 [BASIC]
 
@@ -41,7 +40,7 @@ bad-names=foo,bar,baz,toto,tutu,tata
 max-line-length=150
 
 # Maximum number of lines in a module
-max-module-lines=1200
+max-module-lines=1600
 
 
 

.trunk/.gitignore

@@ -0,0 +1,8 @@
+*out
+*logs
+*actions
+*notifications
+*tools
+plugins
+user_trunk.yaml
+user.yaml

.trunk/configs/.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

.trunk/configs/.markdownlint.yaml

@@ -0,0 +1,10 @@
+# Autoformatter friendly markdownlint config (all formatting rules disabled)
+default: true
+blank_lines: false
+bullet: false
+html: false
+indentation: false
+line_length: false
+spaces: false
+url: false
+whitespace: false

.trunk/configs/.shellcheckrc

@@ -0,0 +1,7 @@
+enable=all
+source-path=SCRIPTDIR
+disable=SC2154
+
+# If you're having issues with shellcheck following source, disable the errors via:
+# disable=SC1090
+# disable=SC1091

.trunk/configs/.yamllint.yaml

@@ -0,0 +1,10 @@
+rules:
+  quoted-strings:
+    required: only-when-needed
+    extra-allowed: ["{|}"]
+  empty-values:
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true
+  key-duplicates: {}
+  octal-values:
+    forbid-implicit-octal: true

.trunk/configs/ruff.toml

@@ -0,0 +1,5 @@
+# Generic, formatter-friendly config.
+select = ["B", "D3", "D4", "E", "F"]
+
+# Never enforce `E501` (line length violations). This should be handled by formatters.
+ignore = ["E501"]

.trunk/trunk.yaml

@@ -0,0 +1,46 @@
+version: 0.1
+cli:
+  version: 1.15.0
+plugins:
+  sources:
+    - id: trunk
+      ref: v1.2.2
+      uri: https://github.com/trunk-io/plugins
+lint:
+  disabled:
+    - bandit
+  ignore:
+    - linters: [ALL]
+      paths:
+        # Ignore generated files
+        - meshtastic/*_pb2.py
+  enabled:
+    - actionlint@1.6.25
+    - black@23.7.0
+    - checkov@2.4.9
+    - git-diff-check
+    - gitleaks@8.18.0
+    - isort@5.12.0
+    - markdownlint@0.36.0
+    - osv-scanner@1.3.6
+    - prettier@3.0.3
+    - pylint@2.17.5
+    - ruff@0.0.287
+    - shellcheck@0.9.0
+    - shfmt@3.6.0
+    - taplo@0.8.1
+    - trivy@0.44.1
+    - trufflehog@3.54.3
+    - yamllint@1.32.0
+runtimes:
+  enabled:
+    - go@1.21.0
+    - node@18.12.1
+    - python@3.10.8
+actions:
+  disabled:
+    - trunk-announce
+    - trunk-check-pre-push
+    - trunk-fmt-pre-commit
+  enabled:
+    - trunk-upgrade-available

.vscode/launch.json

@@ -10,7 +10,7 @@
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": false,
-      "args": ["--debug", "--ble", "--device", "24:62:AB:DD:DF:3A"]
+      "args": ["--debug", "--ble", "24:62:AB:DD:DF:3A"]
     },
     {
       "name": "meshtastic admin",
@@ -42,7 +42,95 @@
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
-      "args": ["--debug" ]
+      "args": ["--debug"]
+    },
+    {
+      "name": "meshtastic listen",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--listen", "--debug"]
+    },
+    {
+      "name": "meshtastic debug getPref",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--get", "power.is_power_saving"]
+    },
+    {
+      "name": "meshtastic debug getPref telemetry",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--get", "telemetry.environment_update_interval"]
+    },
+    {
+      "name": "meshtastic debug info",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--info"]
+    },
+    {
+      "name": "meshtastic debug set region",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "lora.region", "TW"]
+    },
+    {
+      "name": "meshtastic debug set bluetooth fixed pin",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "bluetooth.fixed_pin", "555555"]
+    },
+    {
+      "name": "meshtastic debug get bluetooth fixed pin",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--get", "bluetooth.fixed_pin"]
+    },
+    {
+      "name": "meshtastic debug setPref",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "power.is_power_saving", "1"]
+    },
+    {
+      "name": "meshtastic debug setPref telemetry.environment_measurement_enabled",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "telemetry.environment_measurement_enabled", "1"]
+    },
+    {
+      "name": "meshtastic debug setPref telemetry.environment_screen_enabled",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "telemetry.environment_screen_enabled", "1"]
+    },
+    {
+      "name": "meshtastic debug setPref telemetry",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "telemetry.environment_measurement_enabled", "1"]
     },
     {
       "name": "meshtastic setpref",
@@ -52,6 +140,15 @@
       "justMyCode": true,
       "args": ["--debug", "--setchan", "psk", ""]
     },
+    {
+      "name": "meshtastic --ch-set",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--ch-set", "channel_num", "0", "--ch-index", "0"]
+    },
+    
     {
       "name": "meshtastic seturl",
       "type": "python",
@@ -92,7 +189,7 @@
       "module": "meshtastic",
       "justMyCode": true,
       "args": ["--debug", "--sendtext", "pytest"]
-    }
+    },
     {
       "name": "meshtastic showNodes",
       "type": "python",

Makefile

@@ -6,6 +6,10 @@ test:
 virt:
 	pytest -m smokevirt
 
+# run the smoke1 test (after doing a factory reset and unplugging/replugging in device)
+smoke1:
+	pytest -m smoke1 -s -vv
+
 # local install
 install:
 	pip install .
@@ -22,6 +26,12 @@ lint:
 slow:
 	pytest -m unit --durations=5
 
+protobufs: FORCE
+	git submodule update --init --recursive
+	git pull --rebase
+	git submodule update --remote --merge
+	./bin/regen-protobufs.sh
+
 # run the coverage report and open results in a browser
 cov:
 	pytest --cov-report html --cov=meshtastic

README.md

@@ -1,15 +1,50 @@
-# Meshtastic-python
+# Meshtastic Python
 
-[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-python)
-![Unit Tests](https://github.com/meshtastic/Meshtastic-python/actions/workflows/ci.yml/badge.svg)
-[![codecov](https://codecov.io/gh/meshtastic/Meshtastic-python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/Meshtastic-python)
+[![codecov](https://codecov.io/gh/meshtastic/python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/python)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/meshtastic)
+[![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/python/ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic/python/actions/workflows/ci.yml)
+[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/python)](https://cla-assistant.io/meshtastic/python)
+[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
 
-A python client for using [Meshtastic](https://www.meshtastic.org) devices. This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. It also provides access to any of the operations/data available in the device user interface or the Android application. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
+## Overview
 
-Full documentation including examples [here](https://meshtastic.org/docs/software/python/python-installation).
+A Python client for use with Meshtastic devices.
+This small library (and example application) provides an easy API for sending and receiving messages over mesh radios.
+It also provides access to any of the operations/data available in the device user interface or the Android application.
+Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
 
-The library api is documented [here](https://meshtastic-python.vercel.app/meshtastic/index.html)
+**[Getting Started Guide](https://meshtastic.org/docs/software/python/cli/installation)**
 
+(Documentation/API Reference is currently offline)
 
-[![Powered by Vercel](https://raw.githubusercontent.com/abumalick/powered-by-vercel/master/powered-by-vercel.svg)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
+## Call for Contributors
+
+This library and CLI has gone without a consistent maintainer for a while, and there's many improvements that could be made. We're all volunteers here and help is extremely appreciated, whether in implementing your own needs or helping maintain the library and CLI in general.
+
+If you're interested in contributing but don't have specific things you'd like to work on, look at the roadmap below!
+
+## Roadmap
+
+This should always be considered a list in progress and flux -- inclusion doesn't guarantee implementation, and exclusion doesn't mean something's not wanted. GitHub issues are a great place to discuss ideas.
+
+* Types
+  * type annotations throughout the codebase, and upgrading mypy running in CI to `--strict`
+* async-friendliness
+* CLI completeness & consistency
+  * the CLI should support all features of the firmware
+  * there should be a consistent output format available for shell scripting
+* CLI input validation & documentation
+  * what arguments and options are compatible & incompatible with one another?
+  * can the options be restructured in a way that is more self-documenting?
+  * pubsub events should be documented clearly
+* helpers for third-party code
+  * it should be easy to write a script that supports similar options to the CLI so many tools support the same ways of connecting to nodes
+* data storage & processing
+  * there should be a standardized way of recording packets for later use, debugging, etc.
+  * a persistence layer could also keep track of nodes beyond nodedb, as the apps do
+  * a sqlite database schema and tools for writing to it may be a good starting point
+  * enable maps, charts, visualizations
+
+## Stats
+
+![Alt](https://repobeats.axiom.co/api/embed/c71ee8fc4a79690402e5d2807a41eec5e96d9039.svg "Repobeats analytics image")

TODO.md

@@ -5,7 +5,6 @@ Basic functionality is complete now.
 ## Eventual tasks
 
 - Improve documentation on properties/fields
-- change back to Bleak for BLE support - now that they fixed https://github.com/hbldh/bleak/issues/139#event-3499535304
 - include more examples: textchat.py, replymessage.py all as one little demo
 
 - possibly use tk to make a multiwindow test console: https://stackoverflow.com/questions/12351786/how-to-redirect-print-statements-to-tkinter-text-widget
@@ -17,11 +16,8 @@ Basic functionality is complete now.
 
 ## Bluetooth support
 
-(Pre-alpha level feature - you probably don't want this one yet)
-
-- This library supports connecting to Meshtastic devices over either USB (serial) or Bluetooth. Before connecting to the device you must [pair](https://docs.ubuntu.com/core/en/stacks/bluetooth/bluez/docs/reference/pairing/outbound.html) your PC with it.
-- We use the pip3 install "pygatt[GATTTOOL]"
-- ./bin/run.sh --debug --ble --device 24:62:AB:DD:DF:3A
+- ./bin/run.sh --ble-scan # To look for Meshtastic devices
+- ./bin/run.sh --ble 24:62:AB:DD:DF:3A --info
 
 ## Done
 
@@ -34,7 +30,7 @@ Basic functionality is complete now.
 - DONE add fromId and toId to received messages dictionaries
 - make command line options for displaying/changing config
 - update nodedb as nodes change
-- radioConfig - getter/setter syntax: https://www.python-course.eu/python3_properties.php
+- localConfig - getter/setter syntax: https://www.python-course.eu/python3_properties.php
 - let user change radio params via commandline options
 - keep nodedb up-to-date based on received MeshPackets
 - handle radio reboots and redownload db when that happens. Look for a special FromRadio.rebooted packet

bin/bump_version.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+"""Bump the version number"""
+import re
+
+version_filename = "setup.py"
+
+lines = None
+
+with open(version_filename, "r", encoding="utf-8") as f:
+    lines = f.readlines()
+
+with open(version_filename, "w", encoding="utf-8") as f:
+    for line in lines:
+        if line.lstrip().startswith("version="):
+            # get rid of quotes around the version
+            line = line.replace('"', "")
+            # get rid of trailing comma
+            line = line.replace(",", "")
+            # split on '='
+            words = line.split("=")
+            # split the version into parts (by period)
+            v = words[1].split(".")
+            build_num = re.findall(r"\d+", v[2])[0]
+            new_build_num = str(int(build_num) + 1)
+            ver = f"{v[0]}.{v[1]}.{v[2].replace(build_num, new_build_num)}".replace(
+                "\n", ""
+            )
+            f.write(f'    version="{ver}",\n')
+        else:
+            f.write(line)

bin/regen-docs.sh

@@ -1,4 +1,4 @@
 # Note: Docs are generated from this command below, albeit from Vercel.
-# The docs/ dir is not used and is no longer commited.
+# The docs/ dir is not used and is no longer committed.
 # see sachaw if you have questions
 pdoc3 --html -f --output-dir docs meshtastic

bin/regen-protobufs.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+#Uncomment to run hack
+#gsed -i 's/import "\//import ".\//g' ./protobufs/meshtastic/*
+#gsed -i 's/package meshtastic;//g' ./protobufs/meshtastic/*
+
+./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./ --mypy_out ./ ./protobufs/meshtastic/*.proto
+./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./meshtastic/ --mypy_out ./meshtastic/ ./protobufs/nanopb.proto
+
+# workaround for import bug in protoc https://github.com/protocolbuffers/protobuf/issues/1491#issuecomment-690618628
+
+if [[ $OSTYPE == 'darwin'* ]]; then
+	sed -i '' -E 's/^(import.*_pb2)/from . \1/' meshtastic/*.py
+	# automate the current workaround (may be related to Meshtastic-protobufs issue #27 https://github.com/meshtastic/protobufs/issues/27)
+	sed -i '' -E "s/^None = 0/globals()['None'] = 0/" meshtastic/mesh_pb2.py
+else
+	sed -i -e 's/^import.*_pb2/from . \0/' meshtastic/*.py
+	# automate the current workaround (may be related to Meshtastic-protobufs issue #27 https://github.com/meshtastic/protobufs/issues/27)
+	sed -i -e "s/^None = 0/globals()['None'] = 0/" meshtastic/mesh_pb2.py
+fi

bin/regen-protos.sh

@@ -1,15 +0,0 @@
-#!/bin/bash
-
-./nanopb-0.4.4/generator-bin/protoc -I=proto --python_out meshtastic `ls proto/*.proto`
-
-# workaround for import bug in protoc https://github.com/protocolbuffers/protobuf/issues/1491#issuecomment-690618628
-
-if [[ $OSTYPE == 'darwin'* ]]; then
-  sed -i '' -E 's/^(import.*_pb2)/from . \1/' meshtastic/*.py
-  # automate the current workaround (may be related to Meshtastic-protobufs issue #27 https://github.com/meshtastic/Meshtastic-protobufs/issues/27)
-  sed -i '' -E "s/^None = 0/globals()['None'] = 0/" meshtastic/mesh_pb2.py
-else
-  sed -i -e 's/^import.*_pb2/from . \0/' meshtastic/*.py
-  # automate the current workaround (may be related to Meshtastic-protobufs issue #27 https://github.com/meshtastic/Meshtastic-protobufs/issues/27)
-  sed -i -e "s/^None = 0/globals()['None'] = 0/" meshtastic/mesh_pb2.py
-fi

bin/show_version.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+"""Show the version number"""
+
+version_filename = "setup.py"
+
+lines = None
+
+with open(version_filename, "r", encoding="utf-8") as f:
+    lines = f.readlines()
+
+for line in lines:
+    if line.lstrip().startswith("version="):
+        # get rid of quotes around the version
+        line2 = line.replace('"', "")
+        # get rid of the trailing comma
+        line2 = line2.replace(",", "")
+        # split on =
+        words = line2.split("=")
+        # Note: This format is for github actions
+        print(f"::set-output name=version::{words[1].strip()}")

bin/test-release.sh

@@ -7,4 +7,4 @@ python3 setup.py sdist bdist_wheel
 python3 -m twine check dist/*
 # test the upload
 python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
-echo "view the upload at https://test.pypi.org/ it it looks good upload for real"
+echo "view the upload at https://test.pypi.org/ it it looks good upload for real"

exampleConfig.yaml

@@ -11,7 +11,6 @@ location:
 
 userPrefs:
   region: 1
-  isAlwaysPowered: 'true'
-  sendOwnerInterval: 2
+  isAlwaysPowered: "true"
   screenOnSecs: 31536000
   waitBluetoothSecs: 31536000

example_config.yaml

@@ -2,17 +2,42 @@
 owner: Bob TBeam
 owner_short: BOB
 
-channel_url: https://www.meshtastic.org/d/#CgUYAyIBAQ
+channel_url: https://www.meshtastic.org/e/#CgMSAQESCDgBQANIAVAe
 
 location:
   lat: 35.88888
   lon: -93.88888
   alt: 304
 
-user_prefs:
-  region: 1
-  is_always_powered: 'true'
-  send_owner_interval: 2
-  screen_on_secs: 31536000
-  wait_bluetooth_secs: 31536000
-  location_share: 'LocEnabled'
+config:
+  bluetooth:
+    enabled: true
+    fixedPin: 123456
+  device:
+    serialEnabled: true
+  display:
+    screenOnSecs: 600
+  lora:
+    region: US
+    hopLimit: 3
+    txEnabled: true
+    txPower: 30
+  network:
+    ntpServer: 0.pool.ntp.org
+  position:
+    gpsAttemptTime: 900
+    gpsEnabled: true
+    gpsUpdateInterval: 120
+    positionBroadcastSecs: 900
+    positionBroadcastSmartEnabled: true
+    positionFlags: 3
+  power:
+    lsSecs: 300
+    meshSdsTimeoutSecs: 7200
+    minWakeSecs: 10
+    sdsSecs: 4294967295
+
+module_config:
+  telemetry:
+    deviceUpdateInterval: 900
+    environmentUpdateInterval: 900

examples/get_hw.py

@@ -3,6 +3,7 @@
 """
 
 import sys
+
 import meshtastic
 import meshtastic.serial_interface
 
@@ -15,6 +16,6 @@ if len(sys.argv) != 1:
 iface = meshtastic.serial_interface.SerialInterface()
 if iface.nodes:
     for n in iface.nodes.values():
-        if n['num'] == iface.myInfo.my_node_num:
-            print(n['user']['hwModel'])
+        if n["num"] == iface.myInfo.my_node_num:
+            print(n["user"]["hwModel"])
 iface.close()

examples/hello_world_serial.py

@@ -3,6 +3,7 @@
 """
 
 import sys
+
 import meshtastic
 import meshtastic.serial_interface
 

examples/info_example.py

@@ -8,16 +8,13 @@ import meshtastic.serial_interface
 iface = meshtastic.serial_interface.SerialInterface()
 
 # call showInfo() just to ensure values are populated
-#info = iface.showInfo()
+# info = iface.showInfo()
 
-if iface.myInfo:
-    #print(f'myInfo:{iface.myInfo}')
-    print(f'firmware_version:{iface.myInfo.firmware_version}')
 
 if iface.nodes:
     for n in iface.nodes.values():
-        if n['num'] == iface.myInfo.my_node_num:
-            print(n['user']['hwModel'])
+        if n["num"] == iface.myInfo.my_node_num:
+            print(n["user"]["hwModel"])
             break
 
 iface.close()

examples/pub_sub_example.py

@@ -3,6 +3,7 @@
 """
 
 import sys
+
 from pubsub import pub
 
 import meshtastic
@@ -13,10 +14,13 @@ if len(sys.argv) < 2:
     print(f"usage: {sys.argv[0]} host")
     sys.exit(1)
 
-def onConnection(interface, topic=pub.AUTO_TOPIC): # pylint: disable=unused-argument
+
+def onConnection(interface, topic=pub.AUTO_TOPIC):  # pylint: disable=unused-argument
     """This is called when we (re)connect to the radio."""
     print(interface.myInfo)
     interface.close()
+
+
 pub.subscribe(onConnection, "meshtastic.connection.established")
 
 try:

examples/pub_sub_example2.py

@@ -4,6 +4,7 @@
 
 import sys
 import time
+
 from pubsub import pub
 
 import meshtastic
@@ -14,15 +15,18 @@ if len(sys.argv) < 2:
     print(f"usage: {sys.argv[0]} host")
     sys.exit(1)
 
-def onReceive(packet, interface): # pylint: disable=unused-argument
+
+def onReceive(packet, interface):  # pylint: disable=unused-argument
     """called when a packet arrives"""
     print(f"Received: {packet}")
 
-def onConnection(interface, topic=pub.AUTO_TOPIC): # pylint: disable=unused-argument
+
+def onConnection(interface, topic=pub.AUTO_TOPIC):  # pylint: disable=unused-argument
     """called when we (re)connect to the radio"""
     # defaults to broadcast, specify a destination ID if you wish
     interface.sendText("hello mesh")
 
+
 pub.subscribe(onReceive, "meshtastic.receive")
 pub.subscribe(onConnection, "meshtastic.connection.established")
 try:
@@ -30,6 +34,6 @@ try:
     while True:
         time.sleep(1000)
     iface.close()
-except(Exception) as ex:
+except Exception as ex:
     print(f"Error: Could not connect to {sys.argv[1]} {ex}")
     sys.exit(1)

examples/scan_for_devices.py

@@ -3,8 +3,12 @@
 """
 
 import sys
-from meshtastic.supported_device import get_unique_vendor_ids, active_ports_on_supported_devices
-from meshtastic.util import detect_supported_devices
+
+from meshtastic.util import (
+    active_ports_on_supported_devices,
+    detect_supported_devices,
+    get_unique_vendor_ids,
+)
 
 # simple arg check
 if len(sys.argv) != 1:
@@ -13,13 +17,13 @@ if len(sys.argv) != 1:
     sys.exit(3)
 
 vids = get_unique_vendor_ids()
-print(f'Searching for all devices with these vendor ids {vids}')
+print(f"Searching for all devices with these vendor ids {vids}")
 
 sds = detect_supported_devices()
 if len(sds) > 0:
-    print('Detected possible devices:')
+    print("Detected possible devices:")
 for d in sds:
-    print(f' name:{d.name}{d.version} firmware:{d.for_firmware}')
+    print(f" name:{d.name}{d.version} firmware:{d.for_firmware}")
 
 ports = active_ports_on_supported_devices(sds)
-print(f'ports:{ports}')
+print(f"ports:{ports}")

examples/set_owner.py

@@ -3,6 +3,7 @@
 """
 
 import sys
+
 import meshtastic
 import meshtastic.serial_interface
 

examples/show_ports.py

@@ -0,0 +1,6 @@
+"""Simple program to show serial ports.
+"""
+
+from meshtastic.util import findPorts
+
+print(findPorts())

examples/tcp_gps_example.py

@@ -0,0 +1,14 @@
+"""Demonstration of how to look up a radio's location via its LAN connection.
+   Before running, connect your machine to the same WiFi network as the radio.
+"""
+
+import meshtastic
+import meshtastic.tcp_interface
+
+radio_hostname = "meshtastic.local"  # Can also be an IP
+iface = meshtastic.tcp_interface.TCPInterface(radio_hostname)
+my_node_num = iface.myInfo.my_node_num
+pos = iface.nodesByNum[my_node_num]["position"]
+print(pos)
+
+iface.close()

info/mac/nano_g1.txt

@@ -0,0 +1,30 @@
+meshtastic detected port: /dev/cu.wchusbserial53820208781
+
+ioreg -p IOUSB
+
+shows this:
+
+| +-o USB Single Serial@14300000  <class AppleUSBDevice, id 0x1000407a5, registered, matched, active, busy 0 (18 ms), retain 14>
+
+
+
+
+system_profiler SPUSBDataType > /tmp/a
+	with device plugged in
+
+system_profiler SPUSBDataType > /tmp/b
+	with device not plugged in
+
+diff /tmp/a /tmp/b
+
+<         USB Single Serial:
+<
+<           Product ID: 0x55d4
+<           Vendor ID: 0x1a86
+<           Version: 4.43
+<           Serial Number: 5382020878
+<           Speed: Up to 12 Mb/s
+<           Location ID: 0x14300000 / 63
+<           Current Available (mA): 500
+<           Current Required (mA): 134
+<           Extra Operating Current (mA): 0

info/ubuntu/nano_g1.txt

@@ -0,0 +1,91 @@
+lsusb -d 1a86: -v
+
+Bus 001 Device 013: ID 1a86:55d4 QinHeng Electronics
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               1.10
+  bDeviceClass            2 Communications
+  bDeviceSubClass         0
+  bDeviceProtocol         0
+  bMaxPacketSize0         8
+  idVendor           0x1a86 QinHeng Electronics
+  idProduct          0x55d4
+  bcdDevice            4.43
+  iManufacturer           0
+  iProduct                2
+  iSerial                 3
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0043
+    bNumInterfaces          2
+    bConfigurationValue     1
+    iConfiguration          0
+    bmAttributes         0xa0
+      (Bus Powered)
+      Remote Wakeup
+    MaxPower              134mA
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           1
+      bInterfaceClass         2 Communications
+      bInterfaceSubClass      2 Abstract (modem)
+      bInterfaceProtocol      1 AT-commands (v.25ter)
+      iInterface              0
+      CDC Header:
+        bcdCDC               1.10
+      CDC Call Management:
+        bmCapabilities       0x00
+        bDataInterface          1
+      CDC ACM:
+        bmCapabilities       0x02
+          line coding and serial state
+      CDC Union:
+        bMasterInterface        0
+        bSlaveInterface         1
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x83  EP 3 IN
+        bmAttributes            3
+          Transfer Type            Interrupt
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0010  1x 16 bytes
+        bInterval               1
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        1
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass        10 CDC Data
+      bInterfaceSubClass      0
+      bInterfaceProtocol      0
+      iInterface              0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x02  EP 2 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0020  1x 32 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x82  EP 2 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0

info/windows/nano_g1.txt

@@ -0,0 +1,39 @@
+Get-PnpDevice -PresentOnly | Format-List >a
+Get-PnpDevice -PresentOnly | Format-List >b
+Compare-Object (get-content a) (Get-Content b)
+
+InputObject                                                                                              SideIndicator
+-----------                                                                                              -------------
+Caption                     : USB-Enhanced-SERIAL CH9102 (COM9)                                          =>
+Description                 : USB-Enhanced-SERIAL CH9102                                                 =>
+Name                        : USB-Enhanced-SERIAL CH9102 (COM9)                                          =>
+DeviceID                    : USB\VID_1A86&PID_55D4\5382020745                                           =>
+PNPDeviceID                 : USB\VID_1A86&PID_55D4\5382020745                                           =>
+ClassGuid                   : {4d36e978-e325-11ce-bfc1-08002be10318}                                     =>
+CompatibleID                : {USB\Class_02&SubClass_02&Prot_01, USB\Class_02&SubClass_02, USB\Class_02} =>
+HardwareID                  : {USB\VID_1A86&PID_55D4&REV_0443, USB\VID_1A86&PID_55D4}                    =>
+Manufacturer                : wch.cn                                                                     =>
+PNPClass                    : Ports                                                                      =>
+Service                     : CH343SER_A64                                                               =>
+Class                       : Ports                                                                      =>
+FriendlyName                : USB-Enhanced-SERIAL CH9102 (COM9)                                          =>
+InstanceId                  : USB\VID_1A86&PID_55D4\5382020745                                           =>
+InstallDate                 :                                                                            =>
+Status                      : OK                                                                         =>
+Availability                :                                                                            =>
+ConfigManagerErrorCode      : CM_PROB_NONE                                                               =>
+ConfigManagerUserConfig     : False                                                                      =>
+CreationClassName           : Win32_PnPEntity                                                            =>
+ErrorCleared                :                                                                            =>
+ErrorDescription            :                                                                            =>
+LastErrorCode               :                                                                            =>
+PowerManagementCapabilities :                                                                            =>
+PowerManagementSupported    :                                                                            =>
+StatusInfo                  :                                                                            =>
+SystemCreationClassName     : Win32_ComputerSystem                                                       =>
+SystemName                  : DESKTOP-FRFQN8H                                                            =>
+Present                     : True                                                                       =>
+PSComputerName              :                                                                            =>
+Problem                     : CM_PROB_NONE                                                               =>
+ProblemDescription          :                                                                            =>
+                                                                                                         =>

meshtastic/__init__.py

@@ -3,11 +3,11 @@
 
 Primary class: SerialInterface
 Install with pip: "[pip3 install meshtastic](https://pypi.org/project/meshtastic/)"
-Source code on [github](https://github.com/meshtastic/Meshtastic-python)
+Source code on [github](https://github.com/meshtastic/python)
 
 properties of SerialInterface:
 
-- radioConfig - Current radio configuration and device settings, if you write to this the new settings will be applied to
+- localConfig - Current radio configuration and device settings, if you write to this the new settings will be applied to
 the device.
 - nodes - The database of received nodes.  Includes always up-to-date location and username information for each
 node in the mesh.  This is a read-only datastructure.
@@ -62,39 +62,51 @@ import os
 import platform
 import random
 import socket
-import sys
 import stat
+import sys
 import threading
-import traceback
 import time
+import traceback
 from datetime import datetime
 from typing import *
-import serial
-import timeago
-import google.protobuf.json_format
-from pubsub import pub
-from dotmap import DotMap
-from tabulate import tabulate
-from google.protobuf.json_format import MessageToJson
-from meshtastic.util import fixme, catchAndIgnore, stripnl, DeferredExecution, Timeout
-from meshtastic.node import Node
-from meshtastic import (mesh_pb2, portnums_pb2, apponly_pb2, admin_pb2,
-                        environmental_measurement_pb2, remote_hardware_pb2,
-                        channel_pb2, radioconfig_pb2, util)
 
+import google.protobuf.json_format
+import serial # type: ignore[import-untyped]
+import timeago # type: ignore[import-untyped]
+from dotmap import DotMap # type: ignore[import-untyped]
+from google.protobuf.json_format import MessageToJson
+from pubsub import pub # type: ignore[import-untyped]
+from tabulate import tabulate
+
+from meshtastic import (
+    admin_pb2,
+    apponly_pb2,
+    channel_pb2,
+    config_pb2,
+    mesh_pb2,
+    mqtt_pb2,
+    paxcount_pb2,
+    portnums_pb2,
+    remote_hardware_pb2,
+    storeforward_pb2,
+    telemetry_pb2,
+    util,
+)
+from meshtastic.node import Node
+from meshtastic.util import DeferredExecution, Timeout, catchAndIgnore, fixme, stripnl
 
 # Note: To follow PEP224, comments should be after the module variable.
 
 LOCAL_ADDR = "^local"
 """A special ID that means the local node"""
 
-BROADCAST_NUM = 0xffffffff
-"""if using 8 bit nodenums this will be shortend on the target"""
+BROADCAST_NUM = 0xFFFFFFFF
+"""if using 8 bit nodenums this will be shortened on the target"""
 
 BROADCAST_ADDR = "^all"
 """A special ID that means broadcast"""
 
-OUR_APP_VERSION = 20200
+OUR_APP_VERSION = 20300
 """The numeric buildnumber (shared with android apps) specifying the
    level of device code we are guaranteed to understand
 
@@ -106,6 +118,7 @@ publishingThread = DeferredExecution("publishing")
 
 class ResponseHandler(NamedTuple):
     """A pending response callback, waiting for a response to one of our messages"""
+
     # requestId: int - used only as a key
     callback: Callable
     # FIXME, add timestamp and age out old requests
@@ -113,12 +126,13 @@ class ResponseHandler(NamedTuple):
 
 class KnownProtocol(NamedTuple):
     """Used to automatically decode known protocol payloads"""
+
     name: str
     # portnum: int, now a key
     # If set, will be called to prase as a protocol buffer
-    protobufFactory: Callable = None
+    protobufFactory: Optional[Callable] = None
     # If set, invoked as onReceive(interface, packet)
-    onReceive: Callable = None
+    onReceive: Optional[Callable] = None
 
 
 def _onTextReceive(iface, asDict):
@@ -129,7 +143,7 @@ def _onTextReceive(iface, asDict):
     #
     # Usually btw this problem is caused by apps sending binary data but setting the payload type to
     # text.
-    logging.debug(f'in _onTextReceive() asDict:{asDict}')
+    logging.debug(f"in _onTextReceive() asDict:{asDict}")
     try:
         asBytes = asDict["decoded"]["payload"]
         asDict["decoded"]["text"] = asBytes.decode("utf-8")
@@ -140,28 +154,28 @@ def _onTextReceive(iface, asDict):
 
 def _onPositionReceive(iface, asDict):
     """Special auto parsing for received messages"""
-    logging.debug(f'in _onPositionReceive() asDict:{asDict}')
-    if 'decoded' in asDict:
-        if 'position' in asDict['decoded'] and 'from' in asDict:
+    logging.debug(f"in _onPositionReceive() asDict:{asDict}")
+    if "decoded" in asDict:
+        if "position" in asDict["decoded"] and "from" in asDict:
             p = asDict["decoded"]["position"]
-            logging.debug(f'p:{p}')
+            logging.debug(f"p:{p}")
             p = iface._fixupPosition(p)
-            logging.debug(f'after fixup p:{p}')
+            logging.debug(f"after fixup p:{p}")
             # update node DB as needed
             iface._getOrCreateByNum(asDict["from"])["position"] = p
 
 
 def _onNodeInfoReceive(iface, asDict):
     """Special auto parsing for received messages"""
-    logging.debug(f'in _onNodeInfoReceive() asDict:{asDict}')
-    if 'decoded' in asDict:
-        if 'user' in asDict['decoded'] and 'from' in asDict:
+    logging.debug(f"in _onNodeInfoReceive() asDict:{asDict}")
+    if "decoded" in asDict:
+        if "user" in asDict["decoded"] and "from" in asDict:
             p = asDict["decoded"]["user"]
             # decode user protobufs and update nodedb, provide decoded version as "position" in the published msg
             # update node DB as needed
             n = iface._getOrCreateByNum(asDict["from"])
             n["user"] = p
-            # We now have a node ID, make sure it is uptodate in that table
+            # We now have a node ID, make sure it is up-to-date in that table
             iface.nodes[p["id"]] = n
             _receiveInfoUpdate(iface, asDict)
 
@@ -176,12 +190,37 @@ def _receiveInfoUpdate(iface, asDict):
 
 """Well known message payloads can register decoders for automatic protobuf parsing"""
 protocols = {
-    portnums_pb2.PortNum.TEXT_MESSAGE_APP: KnownProtocol("text", onReceive=_onTextReceive),
-    portnums_pb2.PortNum.POSITION_APP: KnownProtocol("position", mesh_pb2.Position, _onPositionReceive),
-    portnums_pb2.PortNum.NODEINFO_APP: KnownProtocol("user", mesh_pb2.User, _onNodeInfoReceive),
+    portnums_pb2.PortNum.TEXT_MESSAGE_APP: KnownProtocol(
+        "text", onReceive=_onTextReceive
+    ),
+    portnums_pb2.PortNum.RANGE_TEST_APP: KnownProtocol(
+        "rangetest", onReceive=_onTextReceive
+    ),
+    portnums_pb2.PortNum.DETECTION_SENSOR_APP: KnownProtocol(
+        "detectionsensor", onReceive=_onTextReceive
+    ),
+
+    portnums_pb2.PortNum.POSITION_APP: KnownProtocol(
+        "position", mesh_pb2.Position, _onPositionReceive
+    ),
+    portnums_pb2.PortNum.NODEINFO_APP: KnownProtocol(
+        "user", mesh_pb2.User, _onNodeInfoReceive
+    ),
     portnums_pb2.PortNum.ADMIN_APP: KnownProtocol("admin", admin_pb2.AdminMessage),
     portnums_pb2.PortNum.ROUTING_APP: KnownProtocol("routing", mesh_pb2.Routing),
-    portnums_pb2.PortNum.ENVIRONMENTAL_MEASUREMENT_APP: KnownProtocol("environmental", environmental_measurement_pb2.EnvironmentalMeasurement),
+    portnums_pb2.PortNum.TELEMETRY_APP: KnownProtocol(
+        "telemetry", telemetry_pb2.Telemetry
+    ),
     portnums_pb2.PortNum.REMOTE_HARDWARE_APP: KnownProtocol(
-        "remotehw", remote_hardware_pb2.HardwareMessage)
+        "remotehw", remote_hardware_pb2.HardwareMessage
+    ),
+    portnums_pb2.PortNum.SIMULATOR_APP: KnownProtocol("simulator", mesh_pb2.Compressed),
+    portnums_pb2.PortNum.TRACEROUTE_APP: KnownProtocol(
+        "traceroute", mesh_pb2.RouteDiscovery
+    ),
+    portnums_pb2.PortNum.WAYPOINT_APP: KnownProtocol("waypoint", mesh_pb2.Waypoint),
+    portnums_pb2.PortNum.PAXCOUNTER_APP: KnownProtocol("paxcounter", paxcount_pb2.Paxcount),
+    portnums_pb2.PortNum.STORE_FORWARD_APP: KnownProtocol("storeforward", storeforward_pb2.StoreAndForward),
+    portnums_pb2.PortNum.NEIGHBORINFO_APP: KnownProtocol("neighborinfo", mesh_pb2.NeighborInfo),
+    portnums_pb2.PortNum.MAP_REPORT_APP: KnownProtocol("mapreport", mqtt_pb2.MapReport),
 }

meshtastic/admin_pb2.py

@@ -1,39 +1,39 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: admin.proto
+# source: meshtastic/admin.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
 _sym_db = _symbol_database.Default()
 
 
-from . import cannedmessages_pb2 as cannedmessages__pb2
-from . import channel_pb2 as channel__pb2
-from . import mesh_pb2 as mesh__pb2
-from . import radioconfig_pb2 as radioconfig__pb2
+from meshtastic import channel_pb2 as meshtastic_dot_channel__pb2
+from meshtastic import config_pb2 as meshtastic_dot_config__pb2
+from meshtastic import connection_status_pb2 as meshtastic_dot_connection__status__pb2
+from meshtastic import mesh_pb2 as meshtastic_dot_mesh__pb2
+from meshtastic import module_config_pb2 as meshtastic_dot_module__config__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0b\x61\x64min.proto\x1a\x14\x63\x61nnedmessages.proto\x1a\rchannel.proto\x1a\nmesh.proto\x1a\x11radioconfig.proto\"\x87\x0c\n\x0c\x41\x64minMessage\x12!\n\tset_radio\x18\x01 \x01(\x0b\x32\x0c.RadioConfigH\x00\x12\x1a\n\tset_owner\x18\x02 \x01(\x0b\x32\x05.UserH\x00\x12\x1f\n\x0bset_channel\x18\x03 \x01(\x0b\x32\x08.ChannelH\x00\x12\x1b\n\x11get_radio_request\x18\x04 \x01(\x08H\x00\x12*\n\x12get_radio_response\x18\x05 \x01(\x0b\x32\x0c.RadioConfigH\x00\x12\x1d\n\x13get_channel_request\x18\x06 \x01(\rH\x00\x12(\n\x14get_channel_response\x18\x07 \x01(\x0b\x32\x08.ChannelH\x00\x12\x1b\n\x11get_owner_request\x18\x08 \x01(\x08H\x00\x12#\n\x12get_owner_response\x18\t \x01(\x0b\x32\x05.UserH\x00\x12\x1d\n\x13\x63onfirm_set_channel\x18  \x01(\x08H\x00\x12\x1b\n\x11\x63onfirm_set_radio\x18! \x01(\x08H\x00\x12\x18\n\x0e\x65xit_simulator\x18\" \x01(\x08H\x00\x12\x18\n\x0ereboot_seconds\x18# \x01(\x05H\x00\x12\x31\n\'get_canned_message_plugin_part1_request\x18$ \x01(\x08H\x00\x12T\n(get_canned_message_plugin_part1_response\x18% \x01(\x0b\x32 .CannedMessagePluginMessagePart1H\x00\x12\x31\n\'get_canned_message_plugin_part2_request\x18& \x01(\x08H\x00\x12T\n(get_canned_message_plugin_part2_response\x18\' \x01(\x0b\x32 .CannedMessagePluginMessagePart2H\x00\x12\x31\n\'get_canned_message_plugin_part3_request\x18( \x01(\x08H\x00\x12T\n(get_canned_message_plugin_part3_response\x18) \x01(\x0b\x32 .CannedMessagePluginMessagePart3H\x00\x12\x31\n\'get_canned_message_plugin_part4_request\x18* \x01(\x08H\x00\x12T\n(get_canned_message_plugin_part4_response\x18+ \x01(\x0b\x32 .CannedMessagePluginMessagePart4H\x00\x12\x31\n\'get_canned_message_plugin_part5_request\x18, \x01(\x08H\x00\x12T\n(get_canned_message_plugin_part5_response\x18- \x01(\x0b\x32 .CannedMessagePluginMessagePart5H\x00\x12K\n\x1fset_canned_message_plugin_part1\x18. \x01(\x0b\x32 .CannedMessagePluginMessagePart1H\x00\x12K\n\x1fset_canned_message_plugin_part2\x18/ \x01(\x0b\x32 .CannedMessagePluginMessagePart2H\x00\x12K\n\x1fset_canned_message_plugin_part3\x18\x30 \x01(\x0b\x32 .CannedMessagePluginMessagePart3H\x00\x12K\n\x1fset_canned_message_plugin_part4\x18\x31 \x01(\x0b\x32 .CannedMessagePluginMessagePart4H\x00\x12K\n\x1fset_canned_message_plugin_part5\x18\x32 \x01(\x0b\x32 .CannedMessagePluginMessagePart5H\x00\x12\x1a\n\x10shutdown_seconds\x18\x33 \x01(\x05H\x00\x42\t\n\x07variantBG\n\x13\x63om.geeksville.meshB\x0b\x41\x64minProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_ADMINMESSAGE = DESCRIPTOR.message_types_by_name['AdminMessage']
-AdminMessage = _reflection.GeneratedProtocolMessageType('AdminMessage', (_message.Message,), {
-  'DESCRIPTOR' : _ADMINMESSAGE,
-  '__module__' : 'admin_pb2'
-  # @@protoc_insertion_point(class_scope:AdminMessage)
-  })
-_sym_db.RegisterMessage(AdminMessage)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16meshtastic/admin.proto\x12\nmeshtastic\x1a\x18meshtastic/channel.proto\x1a\x17meshtastic/config.proto\x1a\"meshtastic/connection_status.proto\x1a\x15meshtastic/mesh.proto\x1a\x1emeshtastic/module_config.proto\"\xce\x11\n\x0c\x41\x64minMessage\x12\x1d\n\x13get_channel_request\x18\x01 \x01(\rH\x00\x12\x33\n\x14get_channel_response\x18\x02 \x01(\x0b\x32\x13.meshtastic.ChannelH\x00\x12\x1b\n\x11get_owner_request\x18\x03 \x01(\x08H\x00\x12.\n\x12get_owner_response\x18\x04 \x01(\x0b\x32\x10.meshtastic.UserH\x00\x12\x41\n\x12get_config_request\x18\x05 \x01(\x0e\x32#.meshtastic.AdminMessage.ConfigTypeH\x00\x12\x31\n\x13get_config_response\x18\x06 \x01(\x0b\x32\x12.meshtastic.ConfigH\x00\x12N\n\x19get_module_config_request\x18\x07 \x01(\x0e\x32).meshtastic.AdminMessage.ModuleConfigTypeH\x00\x12>\n\x1aget_module_config_response\x18\x08 \x01(\x0b\x32\x18.meshtastic.ModuleConfigH\x00\x12\x34\n*get_canned_message_module_messages_request\x18\n \x01(\x08H\x00\x12\x35\n+get_canned_message_module_messages_response\x18\x0b \x01(\tH\x00\x12%\n\x1bget_device_metadata_request\x18\x0c \x01(\x08H\x00\x12\x42\n\x1cget_device_metadata_response\x18\r \x01(\x0b\x32\x1a.meshtastic.DeviceMetadataH\x00\x12\x1e\n\x14get_ringtone_request\x18\x0e \x01(\x08H\x00\x12\x1f\n\x15get_ringtone_response\x18\x0f \x01(\tH\x00\x12.\n$get_device_connection_status_request\x18\x10 \x01(\x08H\x00\x12S\n%get_device_connection_status_response\x18\x11 \x01(\x0b\x32\".meshtastic.DeviceConnectionStatusH\x00\x12\x31\n\x0cset_ham_mode\x18\x12 \x01(\x0b\x32\x19.meshtastic.HamParametersH\x00\x12/\n%get_node_remote_hardware_pins_request\x18\x13 \x01(\x08H\x00\x12\\\n&get_node_remote_hardware_pins_response\x18\x14 \x01(\x0b\x32*.meshtastic.NodeRemoteHardwarePinsResponseH\x00\x12 \n\x16\x65nter_dfu_mode_request\x18\x15 \x01(\x08H\x00\x12\x1d\n\x13\x64\x65lete_file_request\x18\x16 \x01(\tH\x00\x12%\n\tset_owner\x18  \x01(\x0b\x32\x10.meshtastic.UserH\x00\x12*\n\x0bset_channel\x18! \x01(\x0b\x32\x13.meshtastic.ChannelH\x00\x12(\n\nset_config\x18\" \x01(\x0b\x32\x12.meshtastic.ConfigH\x00\x12\x35\n\x11set_module_config\x18# \x01(\x0b\x32\x18.meshtastic.ModuleConfigH\x00\x12,\n\"set_canned_message_module_messages\x18$ \x01(\tH\x00\x12\x1e\n\x14set_ringtone_message\x18% \x01(\tH\x00\x12\x1b\n\x11remove_by_nodenum\x18& \x01(\rH\x00\x12\x1b\n\x11set_favorite_node\x18\' \x01(\rH\x00\x12\x1e\n\x14remove_favorite_node\x18( \x01(\rH\x00\x12\x32\n\x12set_fixed_position\x18) \x01(\x0b\x32\x14.meshtastic.PositionH\x00\x12\x1f\n\x15remove_fixed_position\x18* \x01(\x08H\x00\x12\x1d\n\x13\x62\x65gin_edit_settings\x18@ \x01(\x08H\x00\x12\x1e\n\x14\x63ommit_edit_settings\x18\x41 \x01(\x08H\x00\x12\x1c\n\x12reboot_ota_seconds\x18_ \x01(\x05H\x00\x12\x18\n\x0e\x65xit_simulator\x18` \x01(\x08H\x00\x12\x18\n\x0ereboot_seconds\x18\x61 \x01(\x05H\x00\x12\x1a\n\x10shutdown_seconds\x18\x62 \x01(\x05H\x00\x12\x17\n\rfactory_reset\x18\x63 \x01(\x05H\x00\x12\x16\n\x0cnodedb_reset\x18\x64 \x01(\x05H\x00\"\x95\x01\n\nConfigType\x12\x11\n\rDEVICE_CONFIG\x10\x00\x12\x13\n\x0fPOSITION_CONFIG\x10\x01\x12\x10\n\x0cPOWER_CONFIG\x10\x02\x12\x12\n\x0eNETWORK_CONFIG\x10\x03\x12\x12\n\x0e\x44ISPLAY_CONFIG\x10\x04\x12\x0f\n\x0bLORA_CONFIG\x10\x05\x12\x14\n\x10\x42LUETOOTH_CONFIG\x10\x06\"\xbb\x02\n\x10ModuleConfigType\x12\x0f\n\x0bMQTT_CONFIG\x10\x00\x12\x11\n\rSERIAL_CONFIG\x10\x01\x12\x13\n\x0f\x45XTNOTIF_CONFIG\x10\x02\x12\x17\n\x13STOREFORWARD_CONFIG\x10\x03\x12\x14\n\x10RANGETEST_CONFIG\x10\x04\x12\x14\n\x10TELEMETRY_CONFIG\x10\x05\x12\x14\n\x10\x43\x41NNEDMSG_CONFIG\x10\x06\x12\x10\n\x0c\x41UDIO_CONFIG\x10\x07\x12\x19\n\x15REMOTEHARDWARE_CONFIG\x10\x08\x12\x17\n\x13NEIGHBORINFO_CONFIG\x10\t\x12\x1a\n\x16\x41MBIENTLIGHTING_CONFIG\x10\n\x12\x1a\n\x16\x44\x45TECTIONSENSOR_CONFIG\x10\x0b\x12\x15\n\x11PAXCOUNTER_CONFIG\x10\x0c\x42\x11\n\x0fpayload_variant\"[\n\rHamParameters\x12\x11\n\tcall_sign\x18\x01 \x01(\t\x12\x10\n\x08tx_power\x18\x02 \x01(\x05\x12\x11\n\tfrequency\x18\x03 \x01(\x02\x12\x12\n\nshort_name\x18\x04 \x01(\t\"f\n\x1eNodeRemoteHardwarePinsResponse\x12\x44\n\x19node_remote_hardware_pins\x18\x01 \x03(\x0b\x32!.meshtastic.NodeRemoteHardwarePinB`\n\x13\x63om.geeksville.meshB\x0b\x41\x64minProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.admin_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\013AdminProtosH\003Z!github.com/meshtastic/gomeshproto'
-  _ADMINMESSAGE._serialized_start=84
-  _ADMINMESSAGE._serialized_end=1627
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\013AdminProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _ADMINMESSAGE._serialized_start=181
+  _ADMINMESSAGE._serialized_end=2435
+  _ADMINMESSAGE_CONFIGTYPE._serialized_start=1949
+  _ADMINMESSAGE_CONFIGTYPE._serialized_end=2098
+  _ADMINMESSAGE_MODULECONFIGTYPE._serialized_start=2101
+  _ADMINMESSAGE_MODULECONFIGTYPE._serialized_end=2416
+  _HAMPARAMETERS._serialized_start=2437
+  _HAMPARAMETERS._serialized_end=2528
+  _NODEREMOTEHARDWAREPINSRESPONSE._serialized_start=2530
+  _NODEREMOTEHARDWAREPINSRESPONSE._serialized_end=2632
 # @@protoc_insertion_point(module_scope)

meshtastic/admin_pb2.pyi

@@ -0,0 +1,557 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import meshtastic.channel_pb2
+import meshtastic.config_pb2
+import meshtastic.connection_status_pb2
+import meshtastic.mesh_pb2
+import meshtastic.module_config_pb2
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class AdminMessage(google.protobuf.message.Message):
+    """
+    This message is handled by the Admin module and is responsible for all settings/channel read/write operations.
+    This message is used to do settings operations to both remote AND local nodes.
+    (Prior to 1.2 these operations were done via special ToRadio operations)
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _ConfigType:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _ConfigTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[AdminMessage._ConfigType.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        DEVICE_CONFIG: AdminMessage._ConfigType.ValueType  # 0
+        """
+        TODO: REPLACE
+        """
+        POSITION_CONFIG: AdminMessage._ConfigType.ValueType  # 1
+        """
+        TODO: REPLACE
+        """
+        POWER_CONFIG: AdminMessage._ConfigType.ValueType  # 2
+        """
+        TODO: REPLACE
+        """
+        NETWORK_CONFIG: AdminMessage._ConfigType.ValueType  # 3
+        """
+        TODO: REPLACE
+        """
+        DISPLAY_CONFIG: AdminMessage._ConfigType.ValueType  # 4
+        """
+        TODO: REPLACE
+        """
+        LORA_CONFIG: AdminMessage._ConfigType.ValueType  # 5
+        """
+        TODO: REPLACE
+        """
+        BLUETOOTH_CONFIG: AdminMessage._ConfigType.ValueType  # 6
+        """
+        TODO: REPLACE
+        """
+
+    class ConfigType(_ConfigType, metaclass=_ConfigTypeEnumTypeWrapper):
+        """
+        TODO: REPLACE
+        """
+
+    DEVICE_CONFIG: AdminMessage.ConfigType.ValueType  # 0
+    """
+    TODO: REPLACE
+    """
+    POSITION_CONFIG: AdminMessage.ConfigType.ValueType  # 1
+    """
+    TODO: REPLACE
+    """
+    POWER_CONFIG: AdminMessage.ConfigType.ValueType  # 2
+    """
+    TODO: REPLACE
+    """
+    NETWORK_CONFIG: AdminMessage.ConfigType.ValueType  # 3
+    """
+    TODO: REPLACE
+    """
+    DISPLAY_CONFIG: AdminMessage.ConfigType.ValueType  # 4
+    """
+    TODO: REPLACE
+    """
+    LORA_CONFIG: AdminMessage.ConfigType.ValueType  # 5
+    """
+    TODO: REPLACE
+    """
+    BLUETOOTH_CONFIG: AdminMessage.ConfigType.ValueType  # 6
+    """
+    TODO: REPLACE
+    """
+
+    class _ModuleConfigType:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _ModuleConfigTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[AdminMessage._ModuleConfigType.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        MQTT_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 0
+        """
+        TODO: REPLACE
+        """
+        SERIAL_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 1
+        """
+        TODO: REPLACE
+        """
+        EXTNOTIF_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 2
+        """
+        TODO: REPLACE
+        """
+        STOREFORWARD_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 3
+        """
+        TODO: REPLACE
+        """
+        RANGETEST_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 4
+        """
+        TODO: REPLACE
+        """
+        TELEMETRY_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 5
+        """
+        TODO: REPLACE
+        """
+        CANNEDMSG_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 6
+        """
+        TODO: REPLACE
+        """
+        AUDIO_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 7
+        """
+        TODO: REPLACE
+        """
+        REMOTEHARDWARE_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 8
+        """
+        TODO: REPLACE
+        """
+        NEIGHBORINFO_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 9
+        """
+        TODO: REPLACE
+        """
+        AMBIENTLIGHTING_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 10
+        """
+        TODO: REPLACE
+        """
+        DETECTIONSENSOR_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 11
+        """
+        TODO: REPLACE
+        """
+        PAXCOUNTER_CONFIG: AdminMessage._ModuleConfigType.ValueType  # 12
+        """
+        TODO: REPLACE
+        """
+
+    class ModuleConfigType(_ModuleConfigType, metaclass=_ModuleConfigTypeEnumTypeWrapper):
+        """
+        TODO: REPLACE
+        """
+
+    MQTT_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 0
+    """
+    TODO: REPLACE
+    """
+    SERIAL_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 1
+    """
+    TODO: REPLACE
+    """
+    EXTNOTIF_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 2
+    """
+    TODO: REPLACE
+    """
+    STOREFORWARD_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 3
+    """
+    TODO: REPLACE
+    """
+    RANGETEST_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 4
+    """
+    TODO: REPLACE
+    """
+    TELEMETRY_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 5
+    """
+    TODO: REPLACE
+    """
+    CANNEDMSG_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 6
+    """
+    TODO: REPLACE
+    """
+    AUDIO_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 7
+    """
+    TODO: REPLACE
+    """
+    REMOTEHARDWARE_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 8
+    """
+    TODO: REPLACE
+    """
+    NEIGHBORINFO_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 9
+    """
+    TODO: REPLACE
+    """
+    AMBIENTLIGHTING_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 10
+    """
+    TODO: REPLACE
+    """
+    DETECTIONSENSOR_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 11
+    """
+    TODO: REPLACE
+    """
+    PAXCOUNTER_CONFIG: AdminMessage.ModuleConfigType.ValueType  # 12
+    """
+    TODO: REPLACE
+    """
+
+    GET_CHANNEL_REQUEST_FIELD_NUMBER: builtins.int
+    GET_CHANNEL_RESPONSE_FIELD_NUMBER: builtins.int
+    GET_OWNER_REQUEST_FIELD_NUMBER: builtins.int
+    GET_OWNER_RESPONSE_FIELD_NUMBER: builtins.int
+    GET_CONFIG_REQUEST_FIELD_NUMBER: builtins.int
+    GET_CONFIG_RESPONSE_FIELD_NUMBER: builtins.int
+    GET_MODULE_CONFIG_REQUEST_FIELD_NUMBER: builtins.int
+    GET_MODULE_CONFIG_RESPONSE_FIELD_NUMBER: builtins.int
+    GET_CANNED_MESSAGE_MODULE_MESSAGES_REQUEST_FIELD_NUMBER: builtins.int
+    GET_CANNED_MESSAGE_MODULE_MESSAGES_RESPONSE_FIELD_NUMBER: builtins.int
+    GET_DEVICE_METADATA_REQUEST_FIELD_NUMBER: builtins.int
+    GET_DEVICE_METADATA_RESPONSE_FIELD_NUMBER: builtins.int
+    GET_RINGTONE_REQUEST_FIELD_NUMBER: builtins.int
+    GET_RINGTONE_RESPONSE_FIELD_NUMBER: builtins.int
+    GET_DEVICE_CONNECTION_STATUS_REQUEST_FIELD_NUMBER: builtins.int
+    GET_DEVICE_CONNECTION_STATUS_RESPONSE_FIELD_NUMBER: builtins.int
+    SET_HAM_MODE_FIELD_NUMBER: builtins.int
+    GET_NODE_REMOTE_HARDWARE_PINS_REQUEST_FIELD_NUMBER: builtins.int
+    GET_NODE_REMOTE_HARDWARE_PINS_RESPONSE_FIELD_NUMBER: builtins.int
+    ENTER_DFU_MODE_REQUEST_FIELD_NUMBER: builtins.int
+    DELETE_FILE_REQUEST_FIELD_NUMBER: builtins.int
+    SET_OWNER_FIELD_NUMBER: builtins.int
+    SET_CHANNEL_FIELD_NUMBER: builtins.int
+    SET_CONFIG_FIELD_NUMBER: builtins.int
+    SET_MODULE_CONFIG_FIELD_NUMBER: builtins.int
+    SET_CANNED_MESSAGE_MODULE_MESSAGES_FIELD_NUMBER: builtins.int
+    SET_RINGTONE_MESSAGE_FIELD_NUMBER: builtins.int
+    REMOVE_BY_NODENUM_FIELD_NUMBER: builtins.int
+    SET_FAVORITE_NODE_FIELD_NUMBER: builtins.int
+    REMOVE_FAVORITE_NODE_FIELD_NUMBER: builtins.int
+    SET_FIXED_POSITION_FIELD_NUMBER: builtins.int
+    REMOVE_FIXED_POSITION_FIELD_NUMBER: builtins.int
+    BEGIN_EDIT_SETTINGS_FIELD_NUMBER: builtins.int
+    COMMIT_EDIT_SETTINGS_FIELD_NUMBER: builtins.int
+    REBOOT_OTA_SECONDS_FIELD_NUMBER: builtins.int
+    EXIT_SIMULATOR_FIELD_NUMBER: builtins.int
+    REBOOT_SECONDS_FIELD_NUMBER: builtins.int
+    SHUTDOWN_SECONDS_FIELD_NUMBER: builtins.int
+    FACTORY_RESET_FIELD_NUMBER: builtins.int
+    NODEDB_RESET_FIELD_NUMBER: builtins.int
+    get_channel_request: builtins.int
+    """
+    Send the specified channel in the response to this message
+    NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)
+    """
+    @property
+    def get_channel_response(self) -> meshtastic.channel_pb2.Channel:
+        """
+        TODO: REPLACE
+        """
+    get_owner_request: builtins.bool
+    """
+    Send the current owner data in the response to this message.
+    """
+    @property
+    def get_owner_response(self) -> meshtastic.mesh_pb2.User:
+        """
+        TODO: REPLACE
+        """
+    get_config_request: global___AdminMessage.ConfigType.ValueType
+    """
+    Ask for the following config data to be sent
+    """
+    @property
+    def get_config_response(self) -> meshtastic.config_pb2.Config:
+        """
+        Send the current Config in the response to this message.
+        """
+    get_module_config_request: global___AdminMessage.ModuleConfigType.ValueType
+    """
+    Ask for the following config data to be sent
+    """
+    @property
+    def get_module_config_response(self) -> meshtastic.module_config_pb2.ModuleConfig:
+        """
+        Send the current Config in the response to this message.
+        """
+    get_canned_message_module_messages_request: builtins.bool
+    """
+    Get the Canned Message Module messages in the response to this message.
+    """
+    get_canned_message_module_messages_response: builtins.str
+    """
+    Get the Canned Message Module messages in the response to this message.
+    """
+    get_device_metadata_request: builtins.bool
+    """
+    Request the node to send device metadata (firmware, protobuf version, etc)
+    """
+    @property
+    def get_device_metadata_response(self) -> meshtastic.mesh_pb2.DeviceMetadata:
+        """
+        Device metadata response
+        """
+    get_ringtone_request: builtins.bool
+    """
+    Get the Ringtone in the response to this message.
+    """
+    get_ringtone_response: builtins.str
+    """
+    Get the Ringtone in the response to this message.
+    """
+    get_device_connection_status_request: builtins.bool
+    """
+    Request the node to send it's connection status
+    """
+    @property
+    def get_device_connection_status_response(self) -> meshtastic.connection_status_pb2.DeviceConnectionStatus:
+        """
+        Device connection status response
+        """
+    @property
+    def set_ham_mode(self) -> global___HamParameters:
+        """
+        Setup a node for licensed amateur (ham) radio operation
+        """
+    get_node_remote_hardware_pins_request: builtins.bool
+    """
+    Get the mesh's nodes with their available gpio pins for RemoteHardware module use
+    """
+    @property
+    def get_node_remote_hardware_pins_response(self) -> global___NodeRemoteHardwarePinsResponse:
+        """
+        Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use
+        """
+    enter_dfu_mode_request: builtins.bool
+    """
+    Enter (UF2) DFU mode
+    Only implemented on NRF52 currently
+    """
+    delete_file_request: builtins.str
+    """
+    Delete the file by the specified path from the device
+    """
+    @property
+    def set_owner(self) -> meshtastic.mesh_pb2.User:
+        """
+        Set the owner for this node
+        """
+    @property
+    def set_channel(self) -> meshtastic.channel_pb2.Channel:
+        """
+        Set channels (using the new API).
+        A special channel is the "primary channel".
+        The other records are secondary channels.
+        Note: only one channel can be marked as primary.
+        If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.
+        """
+    @property
+    def set_config(self) -> meshtastic.config_pb2.Config:
+        """
+        Set the current Config
+        """
+    @property
+    def set_module_config(self) -> meshtastic.module_config_pb2.ModuleConfig:
+        """
+        Set the current Config
+        """
+    set_canned_message_module_messages: builtins.str
+    """
+    Set the Canned Message Module messages text.
+    """
+    set_ringtone_message: builtins.str
+    """
+    Set the ringtone for ExternalNotification.
+    """
+    remove_by_nodenum: builtins.int
+    """
+    Remove the node by the specified node-num from the NodeDB on the device
+    """
+    set_favorite_node: builtins.int
+    """
+    Set specified node-num to be favorited on the NodeDB on the device
+    """
+    remove_favorite_node: builtins.int
+    """
+    Set specified node-num to be un-favorited on the NodeDB on the device
+    """
+    @property
+    def set_fixed_position(self) -> meshtastic.mesh_pb2.Position:
+        """
+        Set fixed position data on the node and then set the position.fixed_position = true
+        """
+    remove_fixed_position: builtins.bool
+    """
+    Clear fixed position coordinates and then set position.fixed_position = false
+    """
+    begin_edit_settings: builtins.bool
+    """
+    Begins an edit transaction for config, module config, owner, and channel settings changes
+    This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)
+    """
+    commit_edit_settings: builtins.bool
+    """
+    Commits an open transaction for any edits made to config, module config, owner, and channel settings
+    """
+    reboot_ota_seconds: builtins.int
+    """
+    Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
+    Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.
+    """
+    exit_simulator: builtins.bool
+    """
+    This message is only supported for the simulator Portduino build.
+    If received the simulator will exit successfully.
+    """
+    reboot_seconds: builtins.int
+    """
+    Tell the node to reboot in this many seconds (or <0 to cancel reboot)
+    """
+    shutdown_seconds: builtins.int
+    """
+    Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)
+    """
+    factory_reset: builtins.int
+    """
+    Tell the node to factory reset, all device settings will be returned to factory defaults.
+    """
+    nodedb_reset: builtins.int
+    """
+    Tell the node to reset the nodedb.
+    """
+    def __init__(
+        self,
+        *,
+        get_channel_request: builtins.int = ...,
+        get_channel_response: meshtastic.channel_pb2.Channel | None = ...,
+        get_owner_request: builtins.bool = ...,
+        get_owner_response: meshtastic.mesh_pb2.User | None = ...,
+        get_config_request: global___AdminMessage.ConfigType.ValueType = ...,
+        get_config_response: meshtastic.config_pb2.Config | None = ...,
+        get_module_config_request: global___AdminMessage.ModuleConfigType.ValueType = ...,
+        get_module_config_response: meshtastic.module_config_pb2.ModuleConfig | None = ...,
+        get_canned_message_module_messages_request: builtins.bool = ...,
+        get_canned_message_module_messages_response: builtins.str = ...,
+        get_device_metadata_request: builtins.bool = ...,
+        get_device_metadata_response: meshtastic.mesh_pb2.DeviceMetadata | None = ...,
+        get_ringtone_request: builtins.bool = ...,
+        get_ringtone_response: builtins.str = ...,
+        get_device_connection_status_request: builtins.bool = ...,
+        get_device_connection_status_response: meshtastic.connection_status_pb2.DeviceConnectionStatus | None = ...,
+        set_ham_mode: global___HamParameters | None = ...,
+        get_node_remote_hardware_pins_request: builtins.bool = ...,
+        get_node_remote_hardware_pins_response: global___NodeRemoteHardwarePinsResponse | None = ...,
+        enter_dfu_mode_request: builtins.bool = ...,
+        delete_file_request: builtins.str = ...,
+        set_owner: meshtastic.mesh_pb2.User | None = ...,
+        set_channel: meshtastic.channel_pb2.Channel | None = ...,
+        set_config: meshtastic.config_pb2.Config | None = ...,
+        set_module_config: meshtastic.module_config_pb2.ModuleConfig | None = ...,
+        set_canned_message_module_messages: builtins.str = ...,
+        set_ringtone_message: builtins.str = ...,
+        remove_by_nodenum: builtins.int = ...,
+        set_favorite_node: builtins.int = ...,
+        remove_favorite_node: builtins.int = ...,
+        set_fixed_position: meshtastic.mesh_pb2.Position | None = ...,
+        remove_fixed_position: builtins.bool = ...,
+        begin_edit_settings: builtins.bool = ...,
+        commit_edit_settings: builtins.bool = ...,
+        reboot_ota_seconds: builtins.int = ...,
+        exit_simulator: builtins.bool = ...,
+        reboot_seconds: builtins.int = ...,
+        shutdown_seconds: builtins.int = ...,
+        factory_reset: builtins.int = ...,
+        nodedb_reset: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["begin_edit_settings", b"begin_edit_settings", "commit_edit_settings", b"commit_edit_settings", "delete_file_request", b"delete_file_request", "enter_dfu_mode_request", b"enter_dfu_mode_request", "exit_simulator", b"exit_simulator", "factory_reset", b"factory_reset", "get_canned_message_module_messages_request", b"get_canned_message_module_messages_request", "get_canned_message_module_messages_response", b"get_canned_message_module_messages_response", "get_channel_request", b"get_channel_request", "get_channel_response", b"get_channel_response", "get_config_request", b"get_config_request", "get_config_response", b"get_config_response", "get_device_connection_status_request", b"get_device_connection_status_request", "get_device_connection_status_response", b"get_device_connection_status_response", "get_device_metadata_request", b"get_device_metadata_request", "get_device_metadata_response", b"get_device_metadata_response", "get_module_config_request", b"get_module_config_request", "get_module_config_response", b"get_module_config_response", "get_node_remote_hardware_pins_request", b"get_node_remote_hardware_pins_request", "get_node_remote_hardware_pins_response", b"get_node_remote_hardware_pins_response", "get_owner_request", b"get_owner_request", "get_owner_response", b"get_owner_response", "get_ringtone_request", b"get_ringtone_request", "get_ringtone_response", b"get_ringtone_response", "nodedb_reset", b"nodedb_reset", "payload_variant", b"payload_variant", "reboot_ota_seconds", b"reboot_ota_seconds", "reboot_seconds", b"reboot_seconds", "remove_by_nodenum", b"remove_by_nodenum", "remove_favorite_node", b"remove_favorite_node", "remove_fixed_position", b"remove_fixed_position", "set_canned_message_module_messages", b"set_canned_message_module_messages", "set_channel", b"set_channel", "set_config", b"set_config", "set_favorite_node", b"set_favorite_node", "set_fixed_position", b"set_fixed_position", "set_ham_mode", b"set_ham_mode", "set_module_config", b"set_module_config", "set_owner", b"set_owner", "set_ringtone_message", b"set_ringtone_message", "shutdown_seconds", b"shutdown_seconds"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["begin_edit_settings", b"begin_edit_settings", "commit_edit_settings", b"commit_edit_settings", "delete_file_request", b"delete_file_request", "enter_dfu_mode_request", b"enter_dfu_mode_request", "exit_simulator", b"exit_simulator", "factory_reset", b"factory_reset", "get_canned_message_module_messages_request", b"get_canned_message_module_messages_request", "get_canned_message_module_messages_response", b"get_canned_message_module_messages_response", "get_channel_request", b"get_channel_request", "get_channel_response", b"get_channel_response", "get_config_request", b"get_config_request", "get_config_response", b"get_config_response", "get_device_connection_status_request", b"get_device_connection_status_request", "get_device_connection_status_response", b"get_device_connection_status_response", "get_device_metadata_request", b"get_device_metadata_request", "get_device_metadata_response", b"get_device_metadata_response", "get_module_config_request", b"get_module_config_request", "get_module_config_response", b"get_module_config_response", "get_node_remote_hardware_pins_request", b"get_node_remote_hardware_pins_request", "get_node_remote_hardware_pins_response", b"get_node_remote_hardware_pins_response", "get_owner_request", b"get_owner_request", "get_owner_response", b"get_owner_response", "get_ringtone_request", b"get_ringtone_request", "get_ringtone_response", b"get_ringtone_response", "nodedb_reset", b"nodedb_reset", "payload_variant", b"payload_variant", "reboot_ota_seconds", b"reboot_ota_seconds", "reboot_seconds", b"reboot_seconds", "remove_by_nodenum", b"remove_by_nodenum", "remove_favorite_node", b"remove_favorite_node", "remove_fixed_position", b"remove_fixed_position", "set_canned_message_module_messages", b"set_canned_message_module_messages", "set_channel", b"set_channel", "set_config", b"set_config", "set_favorite_node", b"set_favorite_node", "set_fixed_position", b"set_fixed_position", "set_ham_mode", b"set_ham_mode", "set_module_config", b"set_module_config", "set_owner", b"set_owner", "set_ringtone_message", b"set_ringtone_message", "shutdown_seconds", b"shutdown_seconds"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["payload_variant", b"payload_variant"]) -> typing_extensions.Literal["get_channel_request", "get_channel_response", "get_owner_request", "get_owner_response", "get_config_request", "get_config_response", "get_module_config_request", "get_module_config_response", "get_canned_message_module_messages_request", "get_canned_message_module_messages_response", "get_device_metadata_request", "get_device_metadata_response", "get_ringtone_request", "get_ringtone_response", "get_device_connection_status_request", "get_device_connection_status_response", "set_ham_mode", "get_node_remote_hardware_pins_request", "get_node_remote_hardware_pins_response", "enter_dfu_mode_request", "delete_file_request", "set_owner", "set_channel", "set_config", "set_module_config", "set_canned_message_module_messages", "set_ringtone_message", "remove_by_nodenum", "set_favorite_node", "remove_favorite_node", "set_fixed_position", "remove_fixed_position", "begin_edit_settings", "commit_edit_settings", "reboot_ota_seconds", "exit_simulator", "reboot_seconds", "shutdown_seconds", "factory_reset", "nodedb_reset"] | None: ...
+
+global___AdminMessage = AdminMessage
+
+@typing_extensions.final
+class HamParameters(google.protobuf.message.Message):
+    """
+    Parameters for setting up Meshtastic for ameteur radio usage
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CALL_SIGN_FIELD_NUMBER: builtins.int
+    TX_POWER_FIELD_NUMBER: builtins.int
+    FREQUENCY_FIELD_NUMBER: builtins.int
+    SHORT_NAME_FIELD_NUMBER: builtins.int
+    call_sign: builtins.str
+    """
+    Amateur radio call sign, eg. KD2ABC
+    """
+    tx_power: builtins.int
+    """
+    Transmit power in dBm at the LoRA transceiver, not including any amplification
+    """
+    frequency: builtins.float
+    """
+    The selected frequency of LoRA operation
+    Please respect your local laws, regulations, and band plans.
+    Ensure your radio is capable of operating of the selected frequency before setting this.
+    """
+    short_name: builtins.str
+    """
+    Optional short name of user
+    """
+    def __init__(
+        self,
+        *,
+        call_sign: builtins.str = ...,
+        tx_power: builtins.int = ...,
+        frequency: builtins.float = ...,
+        short_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["call_sign", b"call_sign", "frequency", b"frequency", "short_name", b"short_name", "tx_power", b"tx_power"]) -> None: ...
+
+global___HamParameters = HamParameters
+
+@typing_extensions.final
+class NodeRemoteHardwarePinsResponse(google.protobuf.message.Message):
+    """
+    Response envelope for node_remote_hardware_pins
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    NODE_REMOTE_HARDWARE_PINS_FIELD_NUMBER: builtins.int
+    @property
+    def node_remote_hardware_pins(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[meshtastic.mesh_pb2.NodeRemoteHardwarePin]:
+        """
+        Nodes and their respective remote hardware GPIO pins
+        """
+    def __init__(
+        self,
+        *,
+        node_remote_hardware_pins: collections.abc.Iterable[meshtastic.mesh_pb2.NodeRemoteHardwarePin] | None = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["node_remote_hardware_pins", b"node_remote_hardware_pins"]) -> None: ...
+
+global___NodeRemoteHardwarePinsResponse = NodeRemoteHardwarePinsResponse

meshtastic/apponly_pb2.py

@@ -1,36 +1,28 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: apponly.proto
+# source: meshtastic/apponly.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
 _sym_db = _symbol_database.Default()
 
 
-from . import channel_pb2 as channel__pb2
+from meshtastic import channel_pb2 as meshtastic_dot_channel__pb2
+from meshtastic import config_pb2 as meshtastic_dot_config__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rapponly.proto\x1a\rchannel.proto\"0\n\nChannelSet\x12\"\n\x08settings\x18\x01 \x03(\x0b\x32\x10.ChannelSettingsBI\n\x13\x63om.geeksville.meshB\rAppOnlyProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_CHANNELSET = DESCRIPTOR.message_types_by_name['ChannelSet']
-ChannelSet = _reflection.GeneratedProtocolMessageType('ChannelSet', (_message.Message,), {
-  'DESCRIPTOR' : _CHANNELSET,
-  '__module__' : 'apponly_pb2'
-  # @@protoc_insertion_point(class_scope:ChannelSet)
-  })
-_sym_db.RegisterMessage(ChannelSet)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18meshtastic/apponly.proto\x12\nmeshtastic\x1a\x18meshtastic/channel.proto\x1a\x17meshtastic/config.proto\"o\n\nChannelSet\x12-\n\x08settings\x18\x01 \x03(\x0b\x32\x1b.meshtastic.ChannelSettings\x12\x32\n\x0blora_config\x18\x02 \x01(\x0b\x32\x1d.meshtastic.Config.LoRaConfigBb\n\x13\x63om.geeksville.meshB\rAppOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.apponly_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\rAppOnlyProtosH\003Z!github.com/meshtastic/gomeshproto'
-  _CHANNELSET._serialized_start=32
-  _CHANNELSET._serialized_end=80
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\rAppOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _CHANNELSET._serialized_start=91
+  _CHANNELSET._serialized_end=202
 # @@protoc_insertion_point(module_scope)

meshtastic/apponly_pb2.pyi

@@ -0,0 +1,54 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.message
+import meshtastic.channel_pb2
+import meshtastic.config_pb2
+import sys
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class ChannelSet(google.protobuf.message.Message):
+    """
+    This is the most compact possible representation for a set of channels.
+    It includes only one PRIMARY channel (which must be first) and
+    any SECONDARY channels.
+    No DISABLED channels are included.
+    This abstraction is used only on the the 'app side' of the world (ie python, javascript and android etc) to show a group of Channels as a (long) URL
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    SETTINGS_FIELD_NUMBER: builtins.int
+    LORA_CONFIG_FIELD_NUMBER: builtins.int
+    @property
+    def settings(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[meshtastic.channel_pb2.ChannelSettings]:
+        """
+        Channel list with settings
+        """
+    @property
+    def lora_config(self) -> meshtastic.config_pb2.Config.LoRaConfig:
+        """
+        LoRa config
+        """
+    def __init__(
+        self,
+        *,
+        settings: collections.abc.Iterable[meshtastic.channel_pb2.ChannelSettings] | None = ...,
+        lora_config: meshtastic.config_pb2.Config.LoRaConfig | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["lora_config", b"lora_config"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["lora_config", b"lora_config", "settings", b"settings"]) -> None: ...
+
+global___ChannelSet = ChannelSet

meshtastic/atak_pb2.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/atak.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15meshtastic/atak.proto\x12\nmeshtastic\"\xe6\x01\n\tTAKPacket\x12\x15\n\ris_compressed\x18\x01 \x01(\x08\x12$\n\x07\x63ontact\x18\x02 \x01(\x0b\x32\x13.meshtastic.Contact\x12 \n\x05group\x18\x03 \x01(\x0b\x32\x11.meshtastic.Group\x12\"\n\x06status\x18\x04 \x01(\x0b\x32\x12.meshtastic.Status\x12\x1e\n\x03pli\x18\x05 \x01(\x0b\x32\x0f.meshtastic.PLIH\x00\x12#\n\x04\x63hat\x18\x06 \x01(\x0b\x32\x13.meshtastic.GeoChatH\x00\x42\x11\n\x0fpayload_variant\"2\n\x07GeoChat\x12\x0f\n\x07message\x18\x01 \x01(\t\x12\x0f\n\x02to\x18\x02 \x01(\tH\x00\x88\x01\x01\x42\x05\n\x03_to\"M\n\x05Group\x12$\n\x04role\x18\x01 \x01(\x0e\x32\x16.meshtastic.MemberRole\x12\x1e\n\x04team\x18\x02 \x01(\x0e\x32\x10.meshtastic.Team\"\x19\n\x06Status\x12\x0f\n\x07\x62\x61ttery\x18\x01 \x01(\r\"4\n\x07\x43ontact\x12\x10\n\x08\x63\x61llsign\x18\x01 \x01(\t\x12\x17\n\x0f\x64\x65vice_callsign\x18\x02 \x01(\t\"_\n\x03PLI\x12\x12\n\nlatitude_i\x18\x01 \x01(\x0f\x12\x13\n\x0blongitude_i\x18\x02 \x01(\x0f\x12\x10\n\x08\x61ltitude\x18\x03 \x01(\x05\x12\r\n\x05speed\x18\x04 \x01(\r\x12\x0e\n\x06\x63ourse\x18\x05 \x01(\r*\xc0\x01\n\x04Team\x12\x14\n\x10Unspecifed_Color\x10\x00\x12\t\n\x05White\x10\x01\x12\n\n\x06Yellow\x10\x02\x12\n\n\x06Orange\x10\x03\x12\x0b\n\x07Magenta\x10\x04\x12\x07\n\x03Red\x10\x05\x12\n\n\x06Maroon\x10\x06\x12\n\n\x06Purple\x10\x07\x12\r\n\tDark_Blue\x10\x08\x12\x08\n\x04\x42lue\x10\t\x12\x08\n\x04\x43yan\x10\n\x12\x08\n\x04Teal\x10\x0b\x12\t\n\x05Green\x10\x0c\x12\x0e\n\nDark_Green\x10\r\x12\t\n\x05\x42rown\x10\x0e*\x7f\n\nMemberRole\x12\x0e\n\nUnspecifed\x10\x00\x12\x0e\n\nTeamMember\x10\x01\x12\x0c\n\x08TeamLead\x10\x02\x12\x06\n\x02HQ\x10\x03\x12\n\n\x06Sniper\x10\x04\x12\t\n\x05Medic\x10\x05\x12\x13\n\x0f\x46orwardObserver\x10\x06\x12\x07\n\x03RTO\x10\x07\x12\x06\n\x02K9\x10\x08\x42_\n\x13\x63om.geeksville.meshB\nATAKProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.atak_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nATAKProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _TEAM._serialized_start=580
+  _TEAM._serialized_end=772
+  _MEMBERROLE._serialized_start=774
+  _MEMBERROLE._serialized_end=901
+  _TAKPACKET._serialized_start=38
+  _TAKPACKET._serialized_end=268
+  _GEOCHAT._serialized_start=270
+  _GEOCHAT._serialized_end=320
+  _GROUP._serialized_start=322
+  _GROUP._serialized_end=399
+  _STATUS._serialized_start=401
+  _STATUS._serialized_end=426
+  _CONTACT._serialized_start=428
+  _CONTACT._serialized_end=480
+  _PLI._serialized_start=482
+  _PLI._serialized_end=577
+# @@protoc_insertion_point(module_scope)

meshtastic/atak_pb2.pyi

@@ -0,0 +1,455 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _Team:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _TeamEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_Team.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    Unspecifed_Color: _Team.ValueType  # 0
+    """
+    Unspecifed
+    """
+    White: _Team.ValueType  # 1
+    """
+    White
+    """
+    Yellow: _Team.ValueType  # 2
+    """
+    Yellow
+    """
+    Orange: _Team.ValueType  # 3
+    """
+    Orange
+    """
+    Magenta: _Team.ValueType  # 4
+    """
+    Magenta
+    """
+    Red: _Team.ValueType  # 5
+    """
+    Red
+    """
+    Maroon: _Team.ValueType  # 6
+    """
+    Maroon
+    """
+    Purple: _Team.ValueType  # 7
+    """
+    Purple
+    """
+    Dark_Blue: _Team.ValueType  # 8
+    """
+    Dark Blue
+    """
+    Blue: _Team.ValueType  # 9
+    """
+    Blue
+    """
+    Cyan: _Team.ValueType  # 10
+    """
+    Cyan
+    """
+    Teal: _Team.ValueType  # 11
+    """
+    Teal
+    """
+    Green: _Team.ValueType  # 12
+    """
+    Green
+    """
+    Dark_Green: _Team.ValueType  # 13
+    """
+    Dark Green
+    """
+    Brown: _Team.ValueType  # 14
+    """
+    Brown
+    """
+
+class Team(_Team, metaclass=_TeamEnumTypeWrapper): ...
+
+Unspecifed_Color: Team.ValueType  # 0
+"""
+Unspecifed
+"""
+White: Team.ValueType  # 1
+"""
+White
+"""
+Yellow: Team.ValueType  # 2
+"""
+Yellow
+"""
+Orange: Team.ValueType  # 3
+"""
+Orange
+"""
+Magenta: Team.ValueType  # 4
+"""
+Magenta
+"""
+Red: Team.ValueType  # 5
+"""
+Red
+"""
+Maroon: Team.ValueType  # 6
+"""
+Maroon
+"""
+Purple: Team.ValueType  # 7
+"""
+Purple
+"""
+Dark_Blue: Team.ValueType  # 8
+"""
+Dark Blue
+"""
+Blue: Team.ValueType  # 9
+"""
+Blue
+"""
+Cyan: Team.ValueType  # 10
+"""
+Cyan
+"""
+Teal: Team.ValueType  # 11
+"""
+Teal
+"""
+Green: Team.ValueType  # 12
+"""
+Green
+"""
+Dark_Green: Team.ValueType  # 13
+"""
+Dark Green
+"""
+Brown: Team.ValueType  # 14
+"""
+Brown
+"""
+global___Team = Team
+
+class _MemberRole:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _MemberRoleEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_MemberRole.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    Unspecifed: _MemberRole.ValueType  # 0
+    """
+    Unspecifed
+    """
+    TeamMember: _MemberRole.ValueType  # 1
+    """
+    Team Member
+    """
+    TeamLead: _MemberRole.ValueType  # 2
+    """
+    Team Lead
+    """
+    HQ: _MemberRole.ValueType  # 3
+    """
+    Headquarters
+    """
+    Sniper: _MemberRole.ValueType  # 4
+    """
+    Airsoft enthusiast
+    """
+    Medic: _MemberRole.ValueType  # 5
+    """
+    Medic
+    """
+    ForwardObserver: _MemberRole.ValueType  # 6
+    """
+    ForwardObserver
+    """
+    RTO: _MemberRole.ValueType  # 7
+    """
+    Radio Telephone Operator
+    """
+    K9: _MemberRole.ValueType  # 8
+    """
+    Doggo
+    """
+
+class MemberRole(_MemberRole, metaclass=_MemberRoleEnumTypeWrapper):
+    """
+    Role of the group member
+    """
+
+Unspecifed: MemberRole.ValueType  # 0
+"""
+Unspecifed
+"""
+TeamMember: MemberRole.ValueType  # 1
+"""
+Team Member
+"""
+TeamLead: MemberRole.ValueType  # 2
+"""
+Team Lead
+"""
+HQ: MemberRole.ValueType  # 3
+"""
+Headquarters
+"""
+Sniper: MemberRole.ValueType  # 4
+"""
+Airsoft enthusiast
+"""
+Medic: MemberRole.ValueType  # 5
+"""
+Medic
+"""
+ForwardObserver: MemberRole.ValueType  # 6
+"""
+ForwardObserver
+"""
+RTO: MemberRole.ValueType  # 7
+"""
+Radio Telephone Operator
+"""
+K9: MemberRole.ValueType  # 8
+"""
+Doggo
+"""
+global___MemberRole = MemberRole
+
+@typing_extensions.final
+class TAKPacket(google.protobuf.message.Message):
+    """
+    Packets for the official ATAK Plugin
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    IS_COMPRESSED_FIELD_NUMBER: builtins.int
+    CONTACT_FIELD_NUMBER: builtins.int
+    GROUP_FIELD_NUMBER: builtins.int
+    STATUS_FIELD_NUMBER: builtins.int
+    PLI_FIELD_NUMBER: builtins.int
+    CHAT_FIELD_NUMBER: builtins.int
+    is_compressed: builtins.bool
+    """
+    Are the payloads strings compressed for LoRA transport?
+    """
+    @property
+    def contact(self) -> global___Contact:
+        """
+        The contact / callsign for ATAK user
+        """
+    @property
+    def group(self) -> global___Group:
+        """
+        The group for ATAK user
+        """
+    @property
+    def status(self) -> global___Status:
+        """
+        The status of the ATAK EUD
+        """
+    @property
+    def pli(self) -> global___PLI:
+        """
+        TAK position report
+        """
+    @property
+    def chat(self) -> global___GeoChat:
+        """
+        ATAK GeoChat message
+        """
+    def __init__(
+        self,
+        *,
+        is_compressed: builtins.bool = ...,
+        contact: global___Contact | None = ...,
+        group: global___Group | None = ...,
+        status: global___Status | None = ...,
+        pli: global___PLI | None = ...,
+        chat: global___GeoChat | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["chat", b"chat", "contact", b"contact", "group", b"group", "payload_variant", b"payload_variant", "pli", b"pli", "status", b"status"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["chat", b"chat", "contact", b"contact", "group", b"group", "is_compressed", b"is_compressed", "payload_variant", b"payload_variant", "pli", b"pli", "status", b"status"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["payload_variant", b"payload_variant"]) -> typing_extensions.Literal["pli", "chat"] | None: ...
+
+global___TAKPacket = TAKPacket
+
+@typing_extensions.final
+class GeoChat(google.protobuf.message.Message):
+    """
+    ATAK GeoChat message
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MESSAGE_FIELD_NUMBER: builtins.int
+    TO_FIELD_NUMBER: builtins.int
+    message: builtins.str
+    """
+    The text message
+    """
+    to: builtins.str
+    """
+    Uid recipient of the message
+    """
+    def __init__(
+        self,
+        *,
+        message: builtins.str = ...,
+        to: builtins.str | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["_to", b"_to", "to", b"to"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["_to", b"_to", "message", b"message", "to", b"to"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_to", b"_to"]) -> typing_extensions.Literal["to"] | None: ...
+
+global___GeoChat = GeoChat
+
+@typing_extensions.final
+class Group(google.protobuf.message.Message):
+    """
+    ATAK Group
+    <__group role='Team Member' name='Cyan'/>
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ROLE_FIELD_NUMBER: builtins.int
+    TEAM_FIELD_NUMBER: builtins.int
+    role: global___MemberRole.ValueType
+    """
+    Role of the group member
+    """
+    team: global___Team.ValueType
+    """
+    Team (color)
+    Default Cyan
+    """
+    def __init__(
+        self,
+        *,
+        role: global___MemberRole.ValueType = ...,
+        team: global___Team.ValueType = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["role", b"role", "team", b"team"]) -> None: ...
+
+global___Group = Group
+
+@typing_extensions.final
+class Status(google.protobuf.message.Message):
+    """
+    ATAK EUD Status
+    <status battery='100' />
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    BATTERY_FIELD_NUMBER: builtins.int
+    battery: builtins.int
+    """
+    Battery level
+    """
+    def __init__(
+        self,
+        *,
+        battery: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["battery", b"battery"]) -> None: ...
+
+global___Status = Status
+
+@typing_extensions.final
+class Contact(google.protobuf.message.Message):
+    """
+    ATAK Contact
+    <contact endpoint='0.0.0.0:4242:tcp' phone='+12345678' callsign='FALKE'/>
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CALLSIGN_FIELD_NUMBER: builtins.int
+    DEVICE_CALLSIGN_FIELD_NUMBER: builtins.int
+    callsign: builtins.str
+    """
+    Callsign
+    """
+    device_callsign: builtins.str
+    """
+    Device callsign
+
+    IP address of endpoint in integer form (0.0.0.0 default)
+    """
+    def __init__(
+        self,
+        *,
+        callsign: builtins.str = ...,
+        device_callsign: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["callsign", b"callsign", "device_callsign", b"device_callsign"]) -> None: ...
+
+global___Contact = Contact
+
+@typing_extensions.final
+class PLI(google.protobuf.message.Message):
+    """
+    Position Location Information from ATAK
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    LATITUDE_I_FIELD_NUMBER: builtins.int
+    LONGITUDE_I_FIELD_NUMBER: builtins.int
+    ALTITUDE_FIELD_NUMBER: builtins.int
+    SPEED_FIELD_NUMBER: builtins.int
+    COURSE_FIELD_NUMBER: builtins.int
+    latitude_i: builtins.int
+    """
+    The new preferred location encoding, multiply by 1e-7 to get degrees
+    in floating point
+    """
+    longitude_i: builtins.int
+    """
+    The new preferred location encoding, multiply by 1e-7 to get degrees
+    in floating point
+    """
+    altitude: builtins.int
+    """
+    Altitude (ATAK prefers HAE)
+    """
+    speed: builtins.int
+    """
+    Speed
+    """
+    course: builtins.int
+    """
+    Course in degrees
+    """
+    def __init__(
+        self,
+        *,
+        latitude_i: builtins.int = ...,
+        longitude_i: builtins.int = ...,
+        altitude: builtins.int = ...,
+        speed: builtins.int = ...,
+        course: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["altitude", b"altitude", "course", b"course", "latitude_i", b"latitude_i", "longitude_i", b"longitude_i", "speed", b"speed"]) -> None: ...
+
+global___PLI = PLI

meshtastic/ble_interface.py

@@ -1,67 +1,238 @@
 """Bluetooth interface
 """
 import logging
-import platform
+import time
+import struct
+import asyncio
+from threading import Thread, Event
+from typing import Optional
+
+from bleak import BleakScanner, BleakClient
 
 from meshtastic.mesh_interface import MeshInterface
 from meshtastic.util import our_exit
 
-if platform.system() == 'Linux':
-    # pylint: disable=E0401
-    import pygatt
-
-
-
-# Our standard BLE characteristics
+SERVICE_UUID = "6ba1b218-15a8-461f-9fa8-5dcae273eafd"
 TORADIO_UUID = "f75c76d2-129e-4dad-a1dd-7866124401e7"
-FROMRADIO_UUID = "8ba2bcc2-ee02-4a55-a531-c525c5e454d5"
+FROMRADIO_UUID = "2c55e69e-4993-11ed-b878-0242ac120002"
 FROMNUM_UUID = "ed9da18c-a800-4f66-a670-aa7547e34453"
 
 
 class BLEInterface(MeshInterface):
-    """A not quite ready - FIXME - BLE interface to devices"""
+    """MeshInterface using BLE to connect to devices"""
+    class BLEError(Exception):
+        """An exception class for BLE errors"""
+        def __init__(self, message):
+            self.message = message
+            super().__init__(self.message)
 
-    def __init__(self, address, noProto=False, debugOut=None):
-        if platform.system() != 'Linux':
-            our_exit("Linux is the only platform with experimental BLE support.", 1)
-        self.address = address
-        if not noProto:
-            self.adapter = pygatt.GATTToolBackend()  # BGAPIBackend()
-            self.adapter.start()
-            logging.debug(f"Connecting to {self.address}")
-            self.device = self.adapter.connect(address)
-        else:
-            self.adapter = None
-            self.device = None
-        logging.debug("Connected to device")
-        # fromradio = self.device.char_read(FROMRADIO_UUID)
-        MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto)
+    class BLEState(): # pylint: disable=C0115
+        THREADS = False
+        BLE = False
+        MESH = False
 
-        self._readFromRadio()  # read the initial responses
 
-        def handle_data(handle, data): # pylint: disable=W0613
-            self._handleFromRadio(data)
+    def __init__(self, address: Optional[str], noProto: bool = False, debugOut = None):
+        self.state = BLEInterface.BLEState()
 
-        if self.device:
-            self.device.subscribe(FROMNUM_UUID, callback=handle_data)
+        if not address:
+            return
+
+        self.should_read = False
+
+        logging.debug("Threads starting")
+        self._receiveThread = Thread(target = self._receiveFromRadioImpl)
+        self._receiveThread_started = Event()
+        self._receiveThread_stopped = Event()
+        self._receiveThread.start()
+        self._receiveThread_started.wait(1)
+        self.state.THREADS = True
+        logging.debug("Threads running")
+
+        try:
+            logging.debug(f"BLE connecting to: {address}")
+            self.client = self.connect(address)
+            self.state.BLE = True
+            logging.debug("BLE connected")
+        except BLEInterface.BLEError as e:
+            self.close()
+            our_exit(e.message, 1)
+            return
+
+        logging.debug("Mesh init starting")
+        MeshInterface.__init__(self, debugOut = debugOut, noProto = noProto)
+        self._startConfig()
+        if not self.noProto:
+            self._waitConnected(timeout = 60.0)
+            self.waitForConfig()
+        self.state.MESH = True
+        logging.debug("Mesh init finished")
+
+        logging.debug("Register FROMNUM notify callback")
+        self.client.start_notify(FROMNUM_UUID, self.from_num_handler)
+
+
+    async def from_num_handler(self, _, b): # pylint: disable=C0116
+        from_num = struct.unpack('<I', bytes(b))[0]
+        logging.debug(f"FROMNUM notify: {from_num}")
+        self.should_read = True
+
+
+    def scan(self):
+        "Scan for available BLE devices"
+        with BLEClient() as client:
+            return [
+                (x[0], x[1]) for x in (client.discover(
+                    return_adv = True,
+                    service_uuids = [ SERVICE_UUID ]
+                )).values()
+            ]
+
+
+    def find_device(self, address):
+        "Find a device by address"
+        meshtastic_devices = self.scan()
+
+        addressed_devices = list(filter(lambda x: address in (x[1].local_name, x[0].name), meshtastic_devices))
+        # If nothing is found try on the address
+        if len(addressed_devices) == 0:
+            addressed_devices = list(filter(
+                lambda x: BLEInterface._sanitize_address(address) == BLEInterface._sanitize_address(x[0].address),
+                meshtastic_devices))
+
+        if len(addressed_devices) == 0:
+            raise BLEInterface.BLEError(f"No Meshtastic BLE peripheral with identifier or address '{address}' found. Try --ble-scan to find it.")
+        if len(addressed_devices) > 1:
+            raise BLEInterface.BLEError(f"More than one Meshtastic BLE peripheral with identifier or address '{address}' found.")
+        return addressed_devices[0][0]
+
+    def _sanitize_address(address): # pylint: disable=E0213
+        "Standardize BLE address by removing extraneous characters and lowercasing"
+        return address \
+            .replace("-", "") \
+            .replace("_", "") \
+            .replace(":", "") \
+            .lower()
+
+    def connect(self, address):
+        "Connect to a device by address"
+        device = self.find_device(address)
+        client = BLEClient(device.address)
+        client.connect()
+        try:
+            client.pair()
+        except NotImplementedError:
+            # Some bluetooth backends do not require explicit pairing.
+            # See Bleak docs for details on this.
+            pass
+        return client
+
+
+    def _receiveFromRadioImpl(self):
+        self._receiveThread_started.set()
+        while self._receiveThread_started.is_set():
+            if self.should_read:
+                self.should_read = False
+                retries = 0
+                while True:
+                    b = bytes(self.client.read_gatt_char(FROMRADIO_UUID))
+                    if not b:
+                        if retries < 5:
+                            time.sleep(0.1)
+                            retries += 1
+                            continue
+                        break
+                    logging.debug(f"FROMRADIO read: {b.hex()}")
+                    self._handleFromRadio(b)
+            else:
+                time.sleep(0.1)
+        self._receiveThread_stopped.set()
 
     def _sendToRadioImpl(self, toRadio):
-        """Send a ToRadio protobuf to the device"""
-        #logging.debug(f"Sending: {stripnl(toRadio)}")
         b = toRadio.SerializeToString()
-        self.device.char_write(TORADIO_UUID, b)
+        if b:
+            logging.debug(f"TORADIO write: {b.hex()}")
+            self.client.write_gatt_char(TORADIO_UUID, b, response = True)
+            # Allow to propagate and then make sure we read
+            time.sleep(0.1)
+            self.should_read = True
+
 
     def close(self):
-        MeshInterface.close(self)
-        if self.adapter:
-            self.adapter.stop()
+        if self.state.MESH:
+            MeshInterface.close(self)
 
-    def _readFromRadio(self):
-        if not self.noProto:
-            wasEmpty = False
-            while not wasEmpty:
-                if self.device:
-                    b = self.device.char_read(FROMRADIO_UUID)
-                    wasEmpty = len(b) == 0
-                    if not wasEmpty:
-                        self._handleFromRadio(b)
+        if self.state.THREADS:
+            self._receiveThread_started.clear()
+            self._receiveThread_stopped.wait(5)
+
+        if self.state.BLE:
+            self.client.disconnect()
+            self.client.close()
+
+
+class BLEClient():
+    """Client for managing connection to a BLE device"""
+    def __init__(self, address = None, **kwargs):
+        self._eventThread = Thread(target = self._run_event_loop)
+        self._eventThread_started = Event()
+        self._eventThread_stopped = Event()
+        self._eventThread.start()
+        self._eventThread_started.wait(1)
+
+        if not address:
+            logging.debug("No address provided - only discover method will work.")
+            return
+
+        self.bleak_client = BleakClient(address, **kwargs)
+
+
+    def discover(self, **kwargs): # pylint: disable=C0116
+        return self.async_await(BleakScanner.discover(**kwargs))
+
+    def pair(self, **kwargs): # pylint: disable=C0116
+        return self.async_await(self.bleak_client.pair(**kwargs))
+
+    def connect(self, **kwargs): # pylint: disable=C0116
+        return self.async_await(self.bleak_client.connect(**kwargs))
+
+    def disconnect(self, **kwargs): # pylint: disable=C0116
+        self.async_await(self.bleak_client.disconnect(**kwargs))
+
+    def read_gatt_char(self, *args, **kwargs): # pylint: disable=C0116
+        return self.async_await(self.bleak_client.read_gatt_char(*args, **kwargs))
+
+    def write_gatt_char(self, *args, **kwargs): # pylint: disable=C0116
+        self.async_await(self.bleak_client.write_gatt_char(*args, **kwargs))
+
+    def start_notify(self, *args, **kwargs): # pylint: disable=C0116
+        self.async_await(self.bleak_client.start_notify(*args, **kwargs))
+
+    def close(self): # pylint: disable=C0116
+        self.async_run(self._stop_event_loop())
+        self._eventThread_stopped.wait(5)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, _type, _value, _traceback):
+        self.close()
+
+    def async_await(self, coro, timeout = None): # pylint: disable=C0116
+        return self.async_run(coro).result(timeout)
+
+    def async_run(self, coro): # pylint: disable=C0116
+        return asyncio.run_coroutine_threadsafe(coro, self._eventLoop)
+
+    def _run_event_loop(self):
+        # I don't know if the event loop can be initialized in __init__ so silencing pylint
+        self._eventLoop = asyncio.new_event_loop() # pylint: disable=W0201
+        self._eventThread_started.set()
+        try:
+            self._eventLoop.run_forever()
+        finally:
+            self._eventLoop.close()
+        self._eventThread_stopped.set()
+
+    async def _stop_event_loop(self):
+        self._eventLoop.stop()

meshtastic/cannedmessages_pb2.py

@@ -1,11 +1,10 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: cannedmessages.proto
+# source: meshtastic/cannedmessages.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
@@ -14,62 +13,14 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x63\x61nnedmessages.proto\"/\n\x1f\x43\x61nnedMessagePluginMessagePart1\x12\x0c\n\x04text\x18\x01 \x01(\t\"/\n\x1f\x43\x61nnedMessagePluginMessagePart2\x12\x0c\n\x04text\x18\x01 \x01(\t\"/\n\x1f\x43\x61nnedMessagePluginMessagePart3\x12\x0c\n\x04text\x18\x01 \x01(\t\"/\n\x1f\x43\x61nnedMessagePluginMessagePart4\x12\x0c\n\x04text\x18\x01 \x01(\t\"/\n\x1f\x43\x61nnedMessagePluginMessagePart5\x12\x0c\n\x04text\x18\x01 \x01(\tBU\n\x13\x63om.geeksville.meshB\x19\x43\x61nnedMessageConfigProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_CANNEDMESSAGEPLUGINMESSAGEPART1 = DESCRIPTOR.message_types_by_name['CannedMessagePluginMessagePart1']
-_CANNEDMESSAGEPLUGINMESSAGEPART2 = DESCRIPTOR.message_types_by_name['CannedMessagePluginMessagePart2']
-_CANNEDMESSAGEPLUGINMESSAGEPART3 = DESCRIPTOR.message_types_by_name['CannedMessagePluginMessagePart3']
-_CANNEDMESSAGEPLUGINMESSAGEPART4 = DESCRIPTOR.message_types_by_name['CannedMessagePluginMessagePart4']
-_CANNEDMESSAGEPLUGINMESSAGEPART5 = DESCRIPTOR.message_types_by_name['CannedMessagePluginMessagePart5']
-CannedMessagePluginMessagePart1 = _reflection.GeneratedProtocolMessageType('CannedMessagePluginMessagePart1', (_message.Message,), {
-  'DESCRIPTOR' : _CANNEDMESSAGEPLUGINMESSAGEPART1,
-  '__module__' : 'cannedmessages_pb2'
-  # @@protoc_insertion_point(class_scope:CannedMessagePluginMessagePart1)
-  })
-_sym_db.RegisterMessage(CannedMessagePluginMessagePart1)
-
-CannedMessagePluginMessagePart2 = _reflection.GeneratedProtocolMessageType('CannedMessagePluginMessagePart2', (_message.Message,), {
-  'DESCRIPTOR' : _CANNEDMESSAGEPLUGINMESSAGEPART2,
-  '__module__' : 'cannedmessages_pb2'
-  # @@protoc_insertion_point(class_scope:CannedMessagePluginMessagePart2)
-  })
-_sym_db.RegisterMessage(CannedMessagePluginMessagePart2)
-
-CannedMessagePluginMessagePart3 = _reflection.GeneratedProtocolMessageType('CannedMessagePluginMessagePart3', (_message.Message,), {
-  'DESCRIPTOR' : _CANNEDMESSAGEPLUGINMESSAGEPART3,
-  '__module__' : 'cannedmessages_pb2'
-  # @@protoc_insertion_point(class_scope:CannedMessagePluginMessagePart3)
-  })
-_sym_db.RegisterMessage(CannedMessagePluginMessagePart3)
-
-CannedMessagePluginMessagePart4 = _reflection.GeneratedProtocolMessageType('CannedMessagePluginMessagePart4', (_message.Message,), {
-  'DESCRIPTOR' : _CANNEDMESSAGEPLUGINMESSAGEPART4,
-  '__module__' : 'cannedmessages_pb2'
-  # @@protoc_insertion_point(class_scope:CannedMessagePluginMessagePart4)
-  })
-_sym_db.RegisterMessage(CannedMessagePluginMessagePart4)
-
-CannedMessagePluginMessagePart5 = _reflection.GeneratedProtocolMessageType('CannedMessagePluginMessagePart5', (_message.Message,), {
-  'DESCRIPTOR' : _CANNEDMESSAGEPLUGINMESSAGEPART5,
-  '__module__' : 'cannedmessages_pb2'
-  # @@protoc_insertion_point(class_scope:CannedMessagePluginMessagePart5)
-  })
-_sym_db.RegisterMessage(CannedMessagePluginMessagePart5)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1fmeshtastic/cannedmessages.proto\x12\nmeshtastic\"-\n\x19\x43\x61nnedMessageModuleConfig\x12\x10\n\x08messages\x18\x01 \x01(\tBn\n\x13\x63om.geeksville.meshB\x19\x43\x61nnedMessageConfigProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.cannedmessages_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\031CannedMessageConfigProtosH\003Z!github.com/meshtastic/gomeshproto'
-  _CANNEDMESSAGEPLUGINMESSAGEPART1._serialized_start=24
-  _CANNEDMESSAGEPLUGINMESSAGEPART1._serialized_end=71
-  _CANNEDMESSAGEPLUGINMESSAGEPART2._serialized_start=73
-  _CANNEDMESSAGEPLUGINMESSAGEPART2._serialized_end=120
-  _CANNEDMESSAGEPLUGINMESSAGEPART3._serialized_start=122
-  _CANNEDMESSAGEPLUGINMESSAGEPART3._serialized_end=169
-  _CANNEDMESSAGEPLUGINMESSAGEPART4._serialized_start=171
-  _CANNEDMESSAGEPLUGINMESSAGEPART4._serialized_end=218
-  _CANNEDMESSAGEPLUGINMESSAGEPART5._serialized_start=220
-  _CANNEDMESSAGEPLUGINMESSAGEPART5._serialized_end=267
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\031CannedMessageConfigProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _CANNEDMESSAGEMODULECONFIG._serialized_start=47
+  _CANNEDMESSAGEMODULECONFIG._serialized_end=92
 # @@protoc_insertion_point(module_scope)

meshtastic/cannedmessages_pb2.pyi

@@ -0,0 +1,37 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import sys
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class CannedMessageModuleConfig(google.protobuf.message.Message):
+    """
+    Canned message module configuration.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MESSAGES_FIELD_NUMBER: builtins.int
+    messages: builtins.str
+    """
+    Predefined messages for canned message module separated by '|' characters.
+    """
+    def __init__(
+        self,
+        *,
+        messages: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["messages", b"messages"]) -> None: ...
+
+global___CannedMessageModuleConfig = CannedMessageModuleConfig

meshtastic/channel_pb2.py

@@ -1,11 +1,10 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: channel.proto
+# source: meshtastic/channel.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
@@ -14,38 +13,22 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\rchannel.proto\"\x91\x03\n\x0f\x43hannelSettings\x12\x10\n\x08tx_power\x18\x01 \x01(\x05\x12\x32\n\x0cmodem_config\x18\x03 \x01(\x0e\x32\x1c.ChannelSettings.ModemConfig\x12\x11\n\tbandwidth\x18\x06 \x01(\r\x12\x15\n\rspread_factor\x18\x07 \x01(\r\x12\x13\n\x0b\x63oding_rate\x18\x08 \x01(\r\x12\x13\n\x0b\x63hannel_num\x18\t \x01(\r\x12\x0b\n\x03psk\x18\x04 \x01(\x0c\x12\x0c\n\x04name\x18\x05 \x01(\t\x12\n\n\x02id\x18\n \x01(\x07\x12\x16\n\x0euplink_enabled\x18\x10 \x01(\x08\x12\x18\n\x10\x64ownlink_enabled\x18\x11 \x01(\x08\"\x8a\x01\n\x0bModemConfig\x12\x12\n\x0e\x42w125Cr45Sf128\x10\x00\x12\x12\n\x0e\x42w500Cr45Sf128\x10\x01\x12\x14\n\x10\x42w31_25Cr48Sf512\x10\x02\x12\x13\n\x0f\x42w125Cr48Sf4096\x10\x03\x12\x13\n\x0f\x42w250Cr46Sf2048\x10\x04\x12\x13\n\x0f\x42w250Cr47Sf1024\x10\x05\"\x8b\x01\n\x07\x43hannel\x12\r\n\x05index\x18\x01 \x01(\x05\x12\"\n\x08settings\x18\x02 \x01(\x0b\x32\x10.ChannelSettings\x12\x1b\n\x04role\x18\x03 \x01(\x0e\x32\r.Channel.Role\"0\n\x04Role\x12\x0c\n\x08\x44ISABLED\x10\x00\x12\x0b\n\x07PRIMARY\x10\x01\x12\r\n\tSECONDARY\x10\x02\x42I\n\x13\x63om.geeksville.meshB\rChannelProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_CHANNELSETTINGS = DESCRIPTOR.message_types_by_name['ChannelSettings']
-_CHANNEL = DESCRIPTOR.message_types_by_name['Channel']
-_CHANNELSETTINGS_MODEMCONFIG = _CHANNELSETTINGS.enum_types_by_name['ModemConfig']
-_CHANNEL_ROLE = _CHANNEL.enum_types_by_name['Role']
-ChannelSettings = _reflection.GeneratedProtocolMessageType('ChannelSettings', (_message.Message,), {
-  'DESCRIPTOR' : _CHANNELSETTINGS,
-  '__module__' : 'channel_pb2'
-  # @@protoc_insertion_point(class_scope:ChannelSettings)
-  })
-_sym_db.RegisterMessage(ChannelSettings)
-
-Channel = _reflection.GeneratedProtocolMessageType('Channel', (_message.Message,), {
-  'DESCRIPTOR' : _CHANNEL,
-  '__module__' : 'channel_pb2'
-  # @@protoc_insertion_point(class_scope:Channel)
-  })
-_sym_db.RegisterMessage(Channel)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18meshtastic/channel.proto\x12\nmeshtastic\"\xb8\x01\n\x0f\x43hannelSettings\x12\x17\n\x0b\x63hannel_num\x18\x01 \x01(\rB\x02\x18\x01\x12\x0b\n\x03psk\x18\x02 \x01(\x0c\x12\x0c\n\x04name\x18\x03 \x01(\t\x12\n\n\x02id\x18\x04 \x01(\x07\x12\x16\n\x0euplink_enabled\x18\x05 \x01(\x08\x12\x18\n\x10\x64ownlink_enabled\x18\x06 \x01(\x08\x12\x33\n\x0fmodule_settings\x18\x07 \x01(\x0b\x32\x1a.meshtastic.ModuleSettings\"E\n\x0eModuleSettings\x12\x1a\n\x12position_precision\x18\x01 \x01(\r\x12\x17\n\x0fis_client_muted\x18\x02 \x01(\x08\"\xa1\x01\n\x07\x43hannel\x12\r\n\x05index\x18\x01 \x01(\x05\x12-\n\x08settings\x18\x02 \x01(\x0b\x32\x1b.meshtastic.ChannelSettings\x12&\n\x04role\x18\x03 \x01(\x0e\x32\x18.meshtastic.Channel.Role\"0\n\x04Role\x12\x0c\n\x08\x44ISABLED\x10\x00\x12\x0b\n\x07PRIMARY\x10\x01\x12\r\n\tSECONDARY\x10\x02\x42\x62\n\x13\x63om.geeksville.meshB\rChannelProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.channel_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\rChannelProtosH\003Z!github.com/meshtastic/gomeshproto'
-  _CHANNELSETTINGS._serialized_start=18
-  _CHANNELSETTINGS._serialized_end=419
-  _CHANNELSETTINGS_MODEMCONFIG._serialized_start=281
-  _CHANNELSETTINGS_MODEMCONFIG._serialized_end=419
-  _CHANNEL._serialized_start=422
-  _CHANNEL._serialized_end=561
-  _CHANNEL_ROLE._serialized_start=513
-  _CHANNEL_ROLE._serialized_end=561
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\rChannelProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _CHANNELSETTINGS.fields_by_name['channel_num']._options = None
+  _CHANNELSETTINGS.fields_by_name['channel_num']._serialized_options = b'\030\001'
+  _CHANNELSETTINGS._serialized_start=41
+  _CHANNELSETTINGS._serialized_end=225
+  _MODULESETTINGS._serialized_start=227
+  _MODULESETTINGS._serialized_end=296
+  _CHANNEL._serialized_start=299
+  _CHANNEL._serialized_end=460
+  _CHANNEL_ROLE._serialized_start=412
+  _CHANNEL_ROLE._serialized_end=460
 # @@protoc_insertion_point(module_scope)

meshtastic/channel_pb2.pyi

@@ -0,0 +1,231 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class ChannelSettings(google.protobuf.message.Message):
+    """
+    This information can be encoded as a QRcode/url so that other users can configure
+    their radio to join the same channel.
+    A note about how channel names are shown to users: channelname-X
+    poundsymbol is a prefix used to indicate this is a channel name (idea from @professr).
+    Where X is a letter from A-Z (base 26) representing a hash of the PSK for this
+    channel - so that if the user changes anything about the channel (which does
+    force a new PSK) this letter will also change. Thus preventing user confusion if
+    two friends try to type in a channel name of "BobsChan" and then can't talk
+    because their PSKs will be different.
+    The PSK is hashed into this letter by "0x41 + [xor all bytes of the psk ] modulo 26"
+    This also allows the option of someday if people have the PSK off (zero), the
+    users COULD type in a channel name and be able to talk.
+    FIXME: Add description of multi-channel support and how primary vs secondary channels are used.
+    FIXME: explain how apps use channels for security.
+    explain how remote settings and remote gpio are managed as an example
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CHANNEL_NUM_FIELD_NUMBER: builtins.int
+    PSK_FIELD_NUMBER: builtins.int
+    NAME_FIELD_NUMBER: builtins.int
+    ID_FIELD_NUMBER: builtins.int
+    UPLINK_ENABLED_FIELD_NUMBER: builtins.int
+    DOWNLINK_ENABLED_FIELD_NUMBER: builtins.int
+    MODULE_SETTINGS_FIELD_NUMBER: builtins.int
+    channel_num: builtins.int
+    """
+    Deprecated in favor of LoraConfig.channel_num
+    """
+    psk: builtins.bytes
+    """
+    A simple pre-shared key for now for crypto.
+    Must be either 0 bytes (no crypto), 16 bytes (AES128), or 32 bytes (AES256).
+    A special shorthand is used for 1 byte long psks.
+    These psks should be treated as only minimally secure,
+    because they are listed in this source code.
+    Those bytes are mapped using the following scheme:
+    `0` = No crypto
+    `1` = The special "default" channel key: {0xd4, 0xf1, 0xbb, 0x3a, 0x20, 0x29, 0x07, 0x59, 0xf0, 0xbc, 0xff, 0xab, 0xcf, 0x4e, 0x69, 0x01}
+    `2` through 10 = The default channel key, except with 1 through 9 added to the last byte.
+    Shown to user as simple1 through 10
+    """
+    name: builtins.str
+    """
+    A SHORT name that will be packed into the URL.
+    Less than 12 bytes.
+    Something for end users to call the channel
+    If this is the empty string it is assumed that this channel
+    is the special (minimally secure) "Default"channel.
+    In user interfaces it should be rendered as a local language translation of "X".
+    For channel_num hashing empty string will be treated as "X".
+    Where "X" is selected based on the English words listed above for ModemPreset
+    """
+    id: builtins.int
+    """
+    Used to construct a globally unique channel ID.
+    The full globally unique ID will be: "name.id" where ID is shown as base36.
+    Assuming that the number of meshtastic users is below 20K (true for a long time)
+    the chance of this 64 bit random number colliding with anyone else is super low.
+    And the penalty for collision is low as well, it just means that anyone trying to decrypt channel messages might need to
+    try multiple candidate channels.
+    Any time a non wire compatible change is made to a channel, this field should be regenerated.
+    There are a small number of 'special' globally known (and fairly) insecure standard channels.
+    Those channels do not have a numeric id included in the settings, but instead it is pulled from
+    a table of well known IDs.
+    (see Well Known Channels FIXME)
+    """
+    uplink_enabled: builtins.bool
+    """
+    If true, messages on the mesh will be sent to the *public* internet by any gateway ndoe
+    """
+    downlink_enabled: builtins.bool
+    """
+    If true, messages seen on the internet will be forwarded to the local mesh.
+    """
+    @property
+    def module_settings(self) -> global___ModuleSettings:
+        """
+        Per-channel module settings.
+        """
+    def __init__(
+        self,
+        *,
+        channel_num: builtins.int = ...,
+        psk: builtins.bytes = ...,
+        name: builtins.str = ...,
+        id: builtins.int = ...,
+        uplink_enabled: builtins.bool = ...,
+        downlink_enabled: builtins.bool = ...,
+        module_settings: global___ModuleSettings | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["module_settings", b"module_settings"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["channel_num", b"channel_num", "downlink_enabled", b"downlink_enabled", "id", b"id", "module_settings", b"module_settings", "name", b"name", "psk", b"psk", "uplink_enabled", b"uplink_enabled"]) -> None: ...
+
+global___ChannelSettings = ChannelSettings
+
+@typing_extensions.final
+class ModuleSettings(google.protobuf.message.Message):
+    """
+    This message is specifically for modules to store per-channel configuration data.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    POSITION_PRECISION_FIELD_NUMBER: builtins.int
+    IS_CLIENT_MUTED_FIELD_NUMBER: builtins.int
+    position_precision: builtins.int
+    """
+    Bits of precision for the location sent in position packets.
+    """
+    is_client_muted: builtins.bool
+    """
+    Controls whether or not the phone / clients should mute the current channel
+    Useful for noisy public channels you don't necessarily want to disable
+    """
+    def __init__(
+        self,
+        *,
+        position_precision: builtins.int = ...,
+        is_client_muted: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["is_client_muted", b"is_client_muted", "position_precision", b"position_precision"]) -> None: ...
+
+global___ModuleSettings = ModuleSettings
+
+@typing_extensions.final
+class Channel(google.protobuf.message.Message):
+    """
+    A pair of a channel number, mode and the (sharable) settings for that channel
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _Role:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _RoleEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[Channel._Role.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        DISABLED: Channel._Role.ValueType  # 0
+        """
+        This channel is not in use right now
+        """
+        PRIMARY: Channel._Role.ValueType  # 1
+        """
+        This channel is used to set the frequency for the radio - all other enabled channels must be SECONDARY
+        """
+        SECONDARY: Channel._Role.ValueType  # 2
+        """
+        Secondary channels are only used for encryption/decryption/authentication purposes.
+        Their radio settings (freq etc) are ignored, only psk is used.
+        """
+
+    class Role(_Role, metaclass=_RoleEnumTypeWrapper):
+        """
+        How this channel is being used (or not).
+        Note: this field is an enum to give us options for the future.
+        In particular, someday we might make a 'SCANNING' option.
+        SCANNING channels could have different frequencies and the radio would
+        occasionally check that freq to see if anything is being transmitted.
+        For devices that have multiple physical radios attached, we could keep multiple PRIMARY/SCANNING channels active at once to allow
+        cross band routing as needed.
+        If a device has only a single radio (the common case) only one channel can be PRIMARY at a time
+        (but any number of SECONDARY channels can't be sent received on that common frequency)
+        """
+
+    DISABLED: Channel.Role.ValueType  # 0
+    """
+    This channel is not in use right now
+    """
+    PRIMARY: Channel.Role.ValueType  # 1
+    """
+    This channel is used to set the frequency for the radio - all other enabled channels must be SECONDARY
+    """
+    SECONDARY: Channel.Role.ValueType  # 2
+    """
+    Secondary channels are only used for encryption/decryption/authentication purposes.
+    Their radio settings (freq etc) are ignored, only psk is used.
+    """
+
+    INDEX_FIELD_NUMBER: builtins.int
+    SETTINGS_FIELD_NUMBER: builtins.int
+    ROLE_FIELD_NUMBER: builtins.int
+    index: builtins.int
+    """
+    The index of this channel in the channel table (from 0 to MAX_NUM_CHANNELS-1)
+    (Someday - not currently implemented) An index of -1 could be used to mean "set by name",
+    in which case the target node will find and set the channel by settings.name.
+    """
+    @property
+    def settings(self) -> global___ChannelSettings:
+        """
+        The new settings, or NULL to disable that channel
+        """
+    role: global___Channel.Role.ValueType
+    """
+    TODO: REPLACE
+    """
+    def __init__(
+        self,
+        *,
+        index: builtins.int = ...,
+        settings: global___ChannelSettings | None = ...,
+        role: global___Channel.Role.ValueType = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["settings", b"settings"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["index", b"index", "role", b"role", "settings", b"settings"]) -> None: ...
+
+global___Channel = Channel

meshtastic/clientonly_pb2.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/clientonly.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from meshtastic import localonly_pb2 as meshtastic_dot_localonly__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bmeshtastic/clientonly.proto\x12\nmeshtastic\x1a\x1ameshtastic/localonly.proto\"\x8d\x02\n\rDeviceProfile\x12\x16\n\tlong_name\x18\x01 \x01(\tH\x00\x88\x01\x01\x12\x17\n\nshort_name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x18\n\x0b\x63hannel_url\x18\x03 \x01(\tH\x02\x88\x01\x01\x12,\n\x06\x63onfig\x18\x04 \x01(\x0b\x32\x17.meshtastic.LocalConfigH\x03\x88\x01\x01\x12\x39\n\rmodule_config\x18\x05 \x01(\x0b\x32\x1d.meshtastic.LocalModuleConfigH\x04\x88\x01\x01\x42\x0c\n\n_long_nameB\r\n\x0b_short_nameB\x0e\n\x0c_channel_urlB\t\n\x07_configB\x10\n\x0e_module_configBe\n\x13\x63om.geeksville.meshB\x10\x43lientOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.clientonly_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\020ClientOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _DEVICEPROFILE._serialized_start=72
+  _DEVICEPROFILE._serialized_end=341
+# @@protoc_insertion_point(module_scope)

meshtastic/clientonly_pb2.pyi

@@ -0,0 +1,77 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import meshtastic.localonly_pb2
+import sys
+import typing
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class DeviceProfile(google.protobuf.message.Message):
+    """
+    This abstraction is used to contain any configuration for provisioning a node on any client.
+    It is useful for importing and exporting configurations.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    LONG_NAME_FIELD_NUMBER: builtins.int
+    SHORT_NAME_FIELD_NUMBER: builtins.int
+    CHANNEL_URL_FIELD_NUMBER: builtins.int
+    CONFIG_FIELD_NUMBER: builtins.int
+    MODULE_CONFIG_FIELD_NUMBER: builtins.int
+    long_name: builtins.str
+    """
+    Long name for the node
+    """
+    short_name: builtins.str
+    """
+    Short name of the node
+    """
+    channel_url: builtins.str
+    """
+    The url of the channels from our node
+    """
+    @property
+    def config(self) -> meshtastic.localonly_pb2.LocalConfig:
+        """
+        The Config of the node
+        """
+    @property
+    def module_config(self) -> meshtastic.localonly_pb2.LocalModuleConfig:
+        """
+        The ModuleConfig of the node
+        """
+    def __init__(
+        self,
+        *,
+        long_name: builtins.str | None = ...,
+        short_name: builtins.str | None = ...,
+        channel_url: builtins.str | None = ...,
+        config: meshtastic.localonly_pb2.LocalConfig | None = ...,
+        module_config: meshtastic.localonly_pb2.LocalModuleConfig | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["_channel_url", b"_channel_url", "_config", b"_config", "_long_name", b"_long_name", "_module_config", b"_module_config", "_short_name", b"_short_name", "channel_url", b"channel_url", "config", b"config", "long_name", b"long_name", "module_config", b"module_config", "short_name", b"short_name"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["_channel_url", b"_channel_url", "_config", b"_config", "_long_name", b"_long_name", "_module_config", b"_module_config", "_short_name", b"_short_name", "channel_url", b"channel_url", "config", b"config", "long_name", b"long_name", "module_config", b"module_config", "short_name", b"short_name"]) -> None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_channel_url", b"_channel_url"]) -> typing_extensions.Literal["channel_url"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_config", b"_config"]) -> typing_extensions.Literal["config"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_long_name", b"_long_name"]) -> typing_extensions.Literal["long_name"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_module_config", b"_module_config"]) -> typing_extensions.Literal["module_config"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_short_name", b"_short_name"]) -> typing_extensions.Literal["short_name"] | None: ...
+
+global___DeviceProfile = DeviceProfile

meshtastic/connection_status_pb2.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/connection_status.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\"meshtastic/connection_status.proto\x12\nmeshtastic\"\xb1\x02\n\x16\x44\x65viceConnectionStatus\x12\x33\n\x04wifi\x18\x01 \x01(\x0b\x32 .meshtastic.WifiConnectionStatusH\x00\x88\x01\x01\x12;\n\x08\x65thernet\x18\x02 \x01(\x0b\x32$.meshtastic.EthernetConnectionStatusH\x01\x88\x01\x01\x12=\n\tbluetooth\x18\x03 \x01(\x0b\x32%.meshtastic.BluetoothConnectionStatusH\x02\x88\x01\x01\x12\x37\n\x06serial\x18\x04 \x01(\x0b\x32\".meshtastic.SerialConnectionStatusH\x03\x88\x01\x01\x42\x07\n\x05_wifiB\x0b\n\t_ethernetB\x0c\n\n_bluetoothB\t\n\x07_serial\"g\n\x14WifiConnectionStatus\x12\x33\n\x06status\x18\x01 \x01(\x0b\x32#.meshtastic.NetworkConnectionStatus\x12\x0c\n\x04ssid\x18\x02 \x01(\t\x12\x0c\n\x04rssi\x18\x03 \x01(\x05\"O\n\x18\x45thernetConnectionStatus\x12\x33\n\x06status\x18\x01 \x01(\x0b\x32#.meshtastic.NetworkConnectionStatus\"{\n\x17NetworkConnectionStatus\x12\x12\n\nip_address\x18\x01 \x01(\x07\x12\x14\n\x0cis_connected\x18\x02 \x01(\x08\x12\x19\n\x11is_mqtt_connected\x18\x03 \x01(\x08\x12\x1b\n\x13is_syslog_connected\x18\x04 \x01(\x08\"L\n\x19\x42luetoothConnectionStatus\x12\x0b\n\x03pin\x18\x01 \x01(\r\x12\x0c\n\x04rssi\x18\x02 \x01(\x05\x12\x14\n\x0cis_connected\x18\x03 \x01(\x08\"<\n\x16SerialConnectionStatus\x12\x0c\n\x04\x62\x61ud\x18\x01 \x01(\r\x12\x14\n\x0cis_connected\x18\x02 \x01(\x08\x42\x65\n\x13\x63om.geeksville.meshB\x10\x43onnStatusProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.connection_status_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\020ConnStatusProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _DEVICECONNECTIONSTATUS._serialized_start=51
+  _DEVICECONNECTIONSTATUS._serialized_end=356
+  _WIFICONNECTIONSTATUS._serialized_start=358
+  _WIFICONNECTIONSTATUS._serialized_end=461
+  _ETHERNETCONNECTIONSTATUS._serialized_start=463
+  _ETHERNETCONNECTIONSTATUS._serialized_end=542
+  _NETWORKCONNECTIONSTATUS._serialized_start=544
+  _NETWORKCONNECTIONSTATUS._serialized_end=667
+  _BLUETOOTHCONNECTIONSTATUS._serialized_start=669
+  _BLUETOOTHCONNECTIONSTATUS._serialized_end=745
+  _SERIALCONNECTIONSTATUS._serialized_start=747
+  _SERIALCONNECTIONSTATUS._serialized_end=807
+# @@protoc_insertion_point(module_scope)

meshtastic/connection_status_pb2.pyi

@@ -0,0 +1,227 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class DeviceConnectionStatus(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    WIFI_FIELD_NUMBER: builtins.int
+    ETHERNET_FIELD_NUMBER: builtins.int
+    BLUETOOTH_FIELD_NUMBER: builtins.int
+    SERIAL_FIELD_NUMBER: builtins.int
+    @property
+    def wifi(self) -> global___WifiConnectionStatus:
+        """
+        WiFi Status
+        """
+    @property
+    def ethernet(self) -> global___EthernetConnectionStatus:
+        """
+        WiFi Status
+        """
+    @property
+    def bluetooth(self) -> global___BluetoothConnectionStatus:
+        """
+        Bluetooth Status
+        """
+    @property
+    def serial(self) -> global___SerialConnectionStatus:
+        """
+        Serial Status
+        """
+    def __init__(
+        self,
+        *,
+        wifi: global___WifiConnectionStatus | None = ...,
+        ethernet: global___EthernetConnectionStatus | None = ...,
+        bluetooth: global___BluetoothConnectionStatus | None = ...,
+        serial: global___SerialConnectionStatus | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["_bluetooth", b"_bluetooth", "_ethernet", b"_ethernet", "_serial", b"_serial", "_wifi", b"_wifi", "bluetooth", b"bluetooth", "ethernet", b"ethernet", "serial", b"serial", "wifi", b"wifi"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["_bluetooth", b"_bluetooth", "_ethernet", b"_ethernet", "_serial", b"_serial", "_wifi", b"_wifi", "bluetooth", b"bluetooth", "ethernet", b"ethernet", "serial", b"serial", "wifi", b"wifi"]) -> None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_bluetooth", b"_bluetooth"]) -> typing_extensions.Literal["bluetooth"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_ethernet", b"_ethernet"]) -> typing_extensions.Literal["ethernet"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_serial", b"_serial"]) -> typing_extensions.Literal["serial"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["_wifi", b"_wifi"]) -> typing_extensions.Literal["wifi"] | None: ...
+
+global___DeviceConnectionStatus = DeviceConnectionStatus
+
+@typing_extensions.final
+class WifiConnectionStatus(google.protobuf.message.Message):
+    """
+    WiFi connection status
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    STATUS_FIELD_NUMBER: builtins.int
+    SSID_FIELD_NUMBER: builtins.int
+    RSSI_FIELD_NUMBER: builtins.int
+    @property
+    def status(self) -> global___NetworkConnectionStatus:
+        """
+        Connection status
+        """
+    ssid: builtins.str
+    """
+    WiFi access point SSID
+    """
+    rssi: builtins.int
+    """
+    RSSI of wireless connection
+    """
+    def __init__(
+        self,
+        *,
+        status: global___NetworkConnectionStatus | None = ...,
+        ssid: builtins.str = ...,
+        rssi: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["status", b"status"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["rssi", b"rssi", "ssid", b"ssid", "status", b"status"]) -> None: ...
+
+global___WifiConnectionStatus = WifiConnectionStatus
+
+@typing_extensions.final
+class EthernetConnectionStatus(google.protobuf.message.Message):
+    """
+    Ethernet connection status
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    STATUS_FIELD_NUMBER: builtins.int
+    @property
+    def status(self) -> global___NetworkConnectionStatus:
+        """
+        Connection status
+        """
+    def __init__(
+        self,
+        *,
+        status: global___NetworkConnectionStatus | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["status", b"status"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["status", b"status"]) -> None: ...
+
+global___EthernetConnectionStatus = EthernetConnectionStatus
+
+@typing_extensions.final
+class NetworkConnectionStatus(google.protobuf.message.Message):
+    """
+    Ethernet or WiFi connection status
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    IP_ADDRESS_FIELD_NUMBER: builtins.int
+    IS_CONNECTED_FIELD_NUMBER: builtins.int
+    IS_MQTT_CONNECTED_FIELD_NUMBER: builtins.int
+    IS_SYSLOG_CONNECTED_FIELD_NUMBER: builtins.int
+    ip_address: builtins.int
+    """
+    IP address of device
+    """
+    is_connected: builtins.bool
+    """
+    Whether the device has an active connection or not
+    """
+    is_mqtt_connected: builtins.bool
+    """
+    Whether the device has an active connection to an MQTT broker or not
+    """
+    is_syslog_connected: builtins.bool
+    """
+    Whether the device is actively remote syslogging or not
+    """
+    def __init__(
+        self,
+        *,
+        ip_address: builtins.int = ...,
+        is_connected: builtins.bool = ...,
+        is_mqtt_connected: builtins.bool = ...,
+        is_syslog_connected: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["ip_address", b"ip_address", "is_connected", b"is_connected", "is_mqtt_connected", b"is_mqtt_connected", "is_syslog_connected", b"is_syslog_connected"]) -> None: ...
+
+global___NetworkConnectionStatus = NetworkConnectionStatus
+
+@typing_extensions.final
+class BluetoothConnectionStatus(google.protobuf.message.Message):
+    """
+    Bluetooth connection status
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PIN_FIELD_NUMBER: builtins.int
+    RSSI_FIELD_NUMBER: builtins.int
+    IS_CONNECTED_FIELD_NUMBER: builtins.int
+    pin: builtins.int
+    """
+    The pairing PIN for bluetooth
+    """
+    rssi: builtins.int
+    """
+    RSSI of bluetooth connection
+    """
+    is_connected: builtins.bool
+    """
+    Whether the device has an active connection or not
+    """
+    def __init__(
+        self,
+        *,
+        pin: builtins.int = ...,
+        rssi: builtins.int = ...,
+        is_connected: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["is_connected", b"is_connected", "pin", b"pin", "rssi", b"rssi"]) -> None: ...
+
+global___BluetoothConnectionStatus = BluetoothConnectionStatus
+
+@typing_extensions.final
+class SerialConnectionStatus(google.protobuf.message.Message):
+    """
+    Serial connection status
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    BAUD_FIELD_NUMBER: builtins.int
+    IS_CONNECTED_FIELD_NUMBER: builtins.int
+    baud: builtins.int
+    """
+    Serial baud rate
+    """
+    is_connected: builtins.bool
+    """
+    Whether the device has an active connection or not
+    """
+    def __init__(
+        self,
+        *,
+        baud: builtins.int = ...,
+        is_connected: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["baud", b"baud", "is_connected", b"is_connected"]) -> None: ...
+
+global___SerialConnectionStatus = SerialConnectionStatus

meshtastic/deviceonly_pb2.py

@@ -1,69 +1,46 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: deviceonly.proto
+# source: meshtastic/deviceonly.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
 _sym_db = _symbol_database.Default()
 
 
-from . import channel_pb2 as channel__pb2
-from . import mesh_pb2 as mesh__pb2
-from . import radioconfig_pb2 as radioconfig__pb2
+from meshtastic import channel_pb2 as meshtastic_dot_channel__pb2
+from meshtastic import localonly_pb2 as meshtastic_dot_localonly__pb2
+from meshtastic import mesh_pb2 as meshtastic_dot_mesh__pb2
+from meshtastic import module_config_pb2 as meshtastic_dot_module__config__pb2
+from meshtastic import telemetry_pb2 as meshtastic_dot_telemetry__pb2
+from . import nanopb_pb2 as nanopb__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x10\x64\x65viceonly.proto\x1a\rchannel.proto\x1a\nmesh.proto\x1a\x11radioconfig.proto\"\x80\x01\n\x11LegacyRadioConfig\x12\x39\n\x0bpreferences\x18\x01 \x01(\x0b\x32$.LegacyRadioConfig.LegacyPreferences\x1a\x30\n\x11LegacyPreferences\x12\x1b\n\x06region\x18\x0f \x01(\x0e\x32\x0b.RegionCode\"\xf0\x03\n\x0b\x44\x65viceState\x12\'\n\x0blegacyRadio\x18\x01 \x01(\x0b\x32\x12.LegacyRadioConfig\x12\x1c\n\x07my_node\x18\x02 \x01(\x0b\x32\x0b.MyNodeInfo\x12\x14\n\x05owner\x18\x03 \x01(\x0b\x32\x05.User\x12\x1a\n\x07node_db\x18\x04 \x03(\x0b\x32\t.NodeInfo\x12\"\n\rreceive_queue\x18\x05 \x03(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07version\x18\x08 \x01(\r\x12$\n\x0frx_text_message\x18\x07 \x01(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07no_save\x18\t \x01(\x08\x12\x15\n\rdid_gps_reset\x18\x0b \x01(\x08\x12+\n#canned_message_plugin_message_part1\x18\r \x01(\t\x12+\n#canned_message_plugin_message_part2\x18\x0e \x01(\t\x12+\n#canned_message_plugin_message_part3\x18\x0f \x01(\t\x12+\n#canned_message_plugin_message_part4\x18\x10 \x01(\t\x12+\n#canned_message_plugin_message_part5\x18\x11 \x01(\tJ\x04\x08\x0c\x10\r\")\n\x0b\x43hannelFile\x12\x1a\n\x08\x63hannels\x18\x01 \x03(\x0b\x32\x08.ChannelBF\n\x13\x63om.geeksville.meshB\nDeviceOnlyH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_LEGACYRADIOCONFIG = DESCRIPTOR.message_types_by_name['LegacyRadioConfig']
-_LEGACYRADIOCONFIG_LEGACYPREFERENCES = _LEGACYRADIOCONFIG.nested_types_by_name['LegacyPreferences']
-_DEVICESTATE = DESCRIPTOR.message_types_by_name['DeviceState']
-_CHANNELFILE = DESCRIPTOR.message_types_by_name['ChannelFile']
-LegacyRadioConfig = _reflection.GeneratedProtocolMessageType('LegacyRadioConfig', (_message.Message,), {
-
-  'LegacyPreferences' : _reflection.GeneratedProtocolMessageType('LegacyPreferences', (_message.Message,), {
-    'DESCRIPTOR' : _LEGACYRADIOCONFIG_LEGACYPREFERENCES,
-    '__module__' : 'deviceonly_pb2'
-    # @@protoc_insertion_point(class_scope:LegacyRadioConfig.LegacyPreferences)
-    })
-  ,
-  'DESCRIPTOR' : _LEGACYRADIOCONFIG,
-  '__module__' : 'deviceonly_pb2'
-  # @@protoc_insertion_point(class_scope:LegacyRadioConfig)
-  })
-_sym_db.RegisterMessage(LegacyRadioConfig)
-_sym_db.RegisterMessage(LegacyRadioConfig.LegacyPreferences)
-
-DeviceState = _reflection.GeneratedProtocolMessageType('DeviceState', (_message.Message,), {
-  'DESCRIPTOR' : _DEVICESTATE,
-  '__module__' : 'deviceonly_pb2'
-  # @@protoc_insertion_point(class_scope:DeviceState)
-  })
-_sym_db.RegisterMessage(DeviceState)
-
-ChannelFile = _reflection.GeneratedProtocolMessageType('ChannelFile', (_message.Message,), {
-  'DESCRIPTOR' : _CHANNELFILE,
-  '__module__' : 'deviceonly_pb2'
-  # @@protoc_insertion_point(class_scope:ChannelFile)
-  })
-_sym_db.RegisterMessage(ChannelFile)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bmeshtastic/deviceonly.proto\x12\nmeshtastic\x1a\x18meshtastic/channel.proto\x1a\x1ameshtastic/localonly.proto\x1a\x15meshtastic/mesh.proto\x1a\x1emeshtastic/module_config.proto\x1a\x1ameshtastic/telemetry.proto\x1a\x0cnanopb.proto\"\x90\x01\n\x0cPositionLite\x12\x12\n\nlatitude_i\x18\x01 \x01(\x0f\x12\x13\n\x0blongitude_i\x18\x02 \x01(\x0f\x12\x10\n\x08\x61ltitude\x18\x03 \x01(\x05\x12\x0c\n\x04time\x18\x04 \x01(\x07\x12\x37\n\x0flocation_source\x18\x05 \x01(\x0e\x32\x1e.meshtastic.Position.LocSource\"\x86\x02\n\x0cNodeInfoLite\x12\x0b\n\x03num\x18\x01 \x01(\r\x12\x1e\n\x04user\x18\x02 \x01(\x0b\x32\x10.meshtastic.User\x12*\n\x08position\x18\x03 \x01(\x0b\x32\x18.meshtastic.PositionLite\x12\x0b\n\x03snr\x18\x04 \x01(\x02\x12\x12\n\nlast_heard\x18\x05 \x01(\x07\x12\x31\n\x0e\x64\x65vice_metrics\x18\x06 \x01(\x0b\x32\x19.meshtastic.DeviceMetrics\x12\x0f\n\x07\x63hannel\x18\x07 \x01(\r\x12\x10\n\x08via_mqtt\x18\x08 \x01(\x08\x12\x11\n\thops_away\x18\t \x01(\r\x12\x13\n\x0bis_favorite\x18\n \x01(\x08\"\xc3\x03\n\x0b\x44\x65viceState\x12\'\n\x07my_node\x18\x02 \x01(\x0b\x32\x16.meshtastic.MyNodeInfo\x12\x1f\n\x05owner\x18\x03 \x01(\x0b\x32\x10.meshtastic.User\x12-\n\rreceive_queue\x18\x05 \x03(\x0b\x32\x16.meshtastic.MeshPacket\x12\x0f\n\x07version\x18\x08 \x01(\r\x12/\n\x0frx_text_message\x18\x07 \x01(\x0b\x32\x16.meshtastic.MeshPacket\x12\x13\n\x07no_save\x18\t \x01(\x08\x42\x02\x18\x01\x12\x15\n\rdid_gps_reset\x18\x0b \x01(\x08\x12+\n\x0brx_waypoint\x18\x0c \x01(\x0b\x32\x16.meshtastic.MeshPacket\x12\x44\n\x19node_remote_hardware_pins\x18\r \x03(\x0b\x32!.meshtastic.NodeRemoteHardwarePin\x12Z\n\x0cnode_db_lite\x18\x0e \x03(\x0b\x32\x18.meshtastic.NodeInfoLiteB*\x92?\'\x92\x01$std::vector<meshtastic_NodeInfoLite>\"E\n\x0b\x43hannelFile\x12%\n\x08\x63hannels\x18\x01 \x03(\x0b\x32\x13.meshtastic.Channel\x12\x0f\n\x07version\x18\x02 \x01(\r\"\x97\x02\n\x08OEMStore\x12\x16\n\x0eoem_icon_width\x18\x01 \x01(\r\x12\x17\n\x0foem_icon_height\x18\x02 \x01(\r\x12\x15\n\roem_icon_bits\x18\x03 \x01(\x0c\x12)\n\x08oem_font\x18\x04 \x01(\x0e\x32\x17.meshtastic.ScreenFonts\x12\x10\n\x08oem_text\x18\x05 \x01(\t\x12\x13\n\x0boem_aes_key\x18\x06 \x01(\x0c\x12\x31\n\x10oem_local_config\x18\x07 \x01(\x0b\x32\x17.meshtastic.LocalConfig\x12>\n\x17oem_local_module_config\x18\x08 \x01(\x0b\x32\x1d.meshtastic.LocalModuleConfig*>\n\x0bScreenFonts\x12\x0e\n\nFONT_SMALL\x10\x00\x12\x0f\n\x0b\x46ONT_MEDIUM\x10\x01\x12\x0e\n\nFONT_LARGE\x10\x02\x42m\n\x13\x63om.geeksville.meshB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x92?\x0b\xc2\x01\x08<vector>b\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.deviceonly_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nDeviceOnlyH\003Z!github.com/meshtastic/gomeshproto'
-  _LEGACYRADIOCONFIG._serialized_start=67
-  _LEGACYRADIOCONFIG._serialized_end=195
-  _LEGACYRADIOCONFIG_LEGACYPREFERENCES._serialized_start=147
-  _LEGACYRADIOCONFIG_LEGACYPREFERENCES._serialized_end=195
-  _DEVICESTATE._serialized_start=198
-  _DEVICESTATE._serialized_end=694
-  _CHANNELFILE._serialized_start=696
-  _CHANNELFILE._serialized_end=737
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000\222?\013\302\001\010<vector>'
+  _DEVICESTATE.fields_by_name['no_save']._options = None
+  _DEVICESTATE.fields_by_name['no_save']._serialized_options = b'\030\001'
+  _DEVICESTATE.fields_by_name['node_db_lite']._options = None
+  _DEVICESTATE.fields_by_name['node_db_lite']._serialized_options = b'\222?\'\222\001$std::vector<meshtastic_NodeInfoLite>'
+  _SCREENFONTS._serialized_start=1413
+  _SCREENFONTS._serialized_end=1475
+  _POSITIONLITE._serialized_start=195
+  _POSITIONLITE._serialized_end=339
+  _NODEINFOLITE._serialized_start=342
+  _NODEINFOLITE._serialized_end=604
+  _DEVICESTATE._serialized_start=607
+  _DEVICESTATE._serialized_end=1058
+  _CHANNELFILE._serialized_start=1060
+  _CHANNELFILE._serialized_end=1129
+  _OEMSTORE._serialized_start=1132
+  _OEMSTORE._serialized_end=1411
 # @@protoc_insertion_point(module_scope)

meshtastic/deviceonly_pb2.pyi

@@ -0,0 +1,386 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import meshtastic.channel_pb2
+import meshtastic.localonly_pb2
+import meshtastic.mesh_pb2
+import meshtastic.telemetry_pb2
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _ScreenFonts:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _ScreenFontsEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_ScreenFonts.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    FONT_SMALL: _ScreenFonts.ValueType  # 0
+    """
+    TODO: REPLACE
+    """
+    FONT_MEDIUM: _ScreenFonts.ValueType  # 1
+    """
+    TODO: REPLACE
+    """
+    FONT_LARGE: _ScreenFonts.ValueType  # 2
+    """
+    TODO: REPLACE
+    """
+
+class ScreenFonts(_ScreenFonts, metaclass=_ScreenFontsEnumTypeWrapper):
+    """
+    Font sizes for the device screen
+    """
+
+FONT_SMALL: ScreenFonts.ValueType  # 0
+"""
+TODO: REPLACE
+"""
+FONT_MEDIUM: ScreenFonts.ValueType  # 1
+"""
+TODO: REPLACE
+"""
+FONT_LARGE: ScreenFonts.ValueType  # 2
+"""
+TODO: REPLACE
+"""
+global___ScreenFonts = ScreenFonts
+
+@typing_extensions.final
+class PositionLite(google.protobuf.message.Message):
+    """
+    Position with static location information only for NodeDBLite
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    LATITUDE_I_FIELD_NUMBER: builtins.int
+    LONGITUDE_I_FIELD_NUMBER: builtins.int
+    ALTITUDE_FIELD_NUMBER: builtins.int
+    TIME_FIELD_NUMBER: builtins.int
+    LOCATION_SOURCE_FIELD_NUMBER: builtins.int
+    latitude_i: builtins.int
+    """
+    The new preferred location encoding, multiply by 1e-7 to get degrees
+    in floating point
+    """
+    longitude_i: builtins.int
+    """
+    TODO: REPLACE
+    """
+    altitude: builtins.int
+    """
+    In meters above MSL (but see issue #359)
+    """
+    time: builtins.int
+    """
+    This is usually not sent over the mesh (to save space), but it is sent
+    from the phone so that the local device can set its RTC If it is sent over
+    the mesh (because there are devices on the mesh without GPS), it will only
+    be sent by devices which has a hardware GPS clock.
+    seconds since 1970
+    """
+    location_source: meshtastic.mesh_pb2.Position.LocSource.ValueType
+    """
+    TODO: REPLACE
+    """
+    def __init__(
+        self,
+        *,
+        latitude_i: builtins.int = ...,
+        longitude_i: builtins.int = ...,
+        altitude: builtins.int = ...,
+        time: builtins.int = ...,
+        location_source: meshtastic.mesh_pb2.Position.LocSource.ValueType = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["altitude", b"altitude", "latitude_i", b"latitude_i", "location_source", b"location_source", "longitude_i", b"longitude_i", "time", b"time"]) -> None: ...
+
+global___PositionLite = PositionLite
+
+@typing_extensions.final
+class NodeInfoLite(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    NUM_FIELD_NUMBER: builtins.int
+    USER_FIELD_NUMBER: builtins.int
+    POSITION_FIELD_NUMBER: builtins.int
+    SNR_FIELD_NUMBER: builtins.int
+    LAST_HEARD_FIELD_NUMBER: builtins.int
+    DEVICE_METRICS_FIELD_NUMBER: builtins.int
+    CHANNEL_FIELD_NUMBER: builtins.int
+    VIA_MQTT_FIELD_NUMBER: builtins.int
+    HOPS_AWAY_FIELD_NUMBER: builtins.int
+    IS_FAVORITE_FIELD_NUMBER: builtins.int
+    num: builtins.int
+    """
+    The node number
+    """
+    @property
+    def user(self) -> meshtastic.mesh_pb2.User:
+        """
+        The user info for this node
+        """
+    @property
+    def position(self) -> global___PositionLite:
+        """
+        This position data. Note: before 1.2.14 we would also store the last time we've heard from this node in position.time, that is no longer true.
+        Position.time now indicates the last time we received a POSITION from that node.
+        """
+    snr: builtins.float
+    """
+    Returns the Signal-to-noise ratio (SNR) of the last received message,
+    as measured by the receiver. Return SNR of the last received message in dB
+    """
+    last_heard: builtins.int
+    """
+    Set to indicate the last time we received a packet from this node
+    """
+    @property
+    def device_metrics(self) -> meshtastic.telemetry_pb2.DeviceMetrics:
+        """
+        The latest device metrics for the node.
+        """
+    channel: builtins.int
+    """
+    local channel index we heard that node on. Only populated if its not the default channel.
+    """
+    via_mqtt: builtins.bool
+    """
+    True if we witnessed the node over MQTT instead of LoRA transport
+    """
+    hops_away: builtins.int
+    """
+    Number of hops away from us this node is (0 if adjacent)
+    """
+    is_favorite: builtins.bool
+    """
+    True if node is in our favorites list
+    Persists between NodeDB internal clean ups
+    """
+    def __init__(
+        self,
+        *,
+        num: builtins.int = ...,
+        user: meshtastic.mesh_pb2.User | None = ...,
+        position: global___PositionLite | None = ...,
+        snr: builtins.float = ...,
+        last_heard: builtins.int = ...,
+        device_metrics: meshtastic.telemetry_pb2.DeviceMetrics | None = ...,
+        channel: builtins.int = ...,
+        via_mqtt: builtins.bool = ...,
+        hops_away: builtins.int = ...,
+        is_favorite: builtins.bool = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["device_metrics", b"device_metrics", "position", b"position", "user", b"user"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["channel", b"channel", "device_metrics", b"device_metrics", "hops_away", b"hops_away", "is_favorite", b"is_favorite", "last_heard", b"last_heard", "num", b"num", "position", b"position", "snr", b"snr", "user", b"user", "via_mqtt", b"via_mqtt"]) -> None: ...
+
+global___NodeInfoLite = NodeInfoLite
+
+@typing_extensions.final
+class DeviceState(google.protobuf.message.Message):
+    """
+    This message is never sent over the wire, but it is used for serializing DB
+    state to flash in the device code
+    FIXME, since we write this each time we enter deep sleep (and have infinite
+    flash) it would be better to use some sort of append only data structure for
+    the receive queue and use the preferences store for the other stuff
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MY_NODE_FIELD_NUMBER: builtins.int
+    OWNER_FIELD_NUMBER: builtins.int
+    RECEIVE_QUEUE_FIELD_NUMBER: builtins.int
+    VERSION_FIELD_NUMBER: builtins.int
+    RX_TEXT_MESSAGE_FIELD_NUMBER: builtins.int
+    NO_SAVE_FIELD_NUMBER: builtins.int
+    DID_GPS_RESET_FIELD_NUMBER: builtins.int
+    RX_WAYPOINT_FIELD_NUMBER: builtins.int
+    NODE_REMOTE_HARDWARE_PINS_FIELD_NUMBER: builtins.int
+    NODE_DB_LITE_FIELD_NUMBER: builtins.int
+    @property
+    def my_node(self) -> meshtastic.mesh_pb2.MyNodeInfo:
+        """
+        Read only settings/info about this node
+        """
+    @property
+    def owner(self) -> meshtastic.mesh_pb2.User:
+        """
+        My owner info
+        """
+    @property
+    def receive_queue(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[meshtastic.mesh_pb2.MeshPacket]:
+        """
+        Received packets saved for delivery to the phone
+        """
+    version: builtins.int
+    """
+    A version integer used to invalidate old save files when we make
+    incompatible changes This integer is set at build time and is private to
+    NodeDB.cpp in the device code.
+    """
+    @property
+    def rx_text_message(self) -> meshtastic.mesh_pb2.MeshPacket:
+        """
+        We keep the last received text message (only) stored in the device flash,
+        so we can show it on the screen.
+        Might be null
+        """
+    no_save: builtins.bool
+    """
+    Used only during development.
+    Indicates developer is testing and changes should never be saved to flash.
+    Deprecated in 2.3.1
+    """
+    did_gps_reset: builtins.bool
+    """
+    Some GPS receivers seem to have bogus settings from the factory, so we always do one factory reset.
+    """
+    @property
+    def rx_waypoint(self) -> meshtastic.mesh_pb2.MeshPacket:
+        """
+        We keep the last received waypoint stored in the device flash,
+        so we can show it on the screen.
+        Might be null
+        """
+    @property
+    def node_remote_hardware_pins(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[meshtastic.mesh_pb2.NodeRemoteHardwarePin]:
+        """
+        The mesh's nodes with their available gpio pins for RemoteHardware module
+        """
+    @property
+    def node_db_lite(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___NodeInfoLite]:
+        """
+        New lite version of NodeDB to decrease memory footprint
+        """
+    def __init__(
+        self,
+        *,
+        my_node: meshtastic.mesh_pb2.MyNodeInfo | None = ...,
+        owner: meshtastic.mesh_pb2.User | None = ...,
+        receive_queue: collections.abc.Iterable[meshtastic.mesh_pb2.MeshPacket] | None = ...,
+        version: builtins.int = ...,
+        rx_text_message: meshtastic.mesh_pb2.MeshPacket | None = ...,
+        no_save: builtins.bool = ...,
+        did_gps_reset: builtins.bool = ...,
+        rx_waypoint: meshtastic.mesh_pb2.MeshPacket | None = ...,
+        node_remote_hardware_pins: collections.abc.Iterable[meshtastic.mesh_pb2.NodeRemoteHardwarePin] | None = ...,
+        node_db_lite: collections.abc.Iterable[global___NodeInfoLite] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["my_node", b"my_node", "owner", b"owner", "rx_text_message", b"rx_text_message", "rx_waypoint", b"rx_waypoint"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["did_gps_reset", b"did_gps_reset", "my_node", b"my_node", "no_save", b"no_save", "node_db_lite", b"node_db_lite", "node_remote_hardware_pins", b"node_remote_hardware_pins", "owner", b"owner", "receive_queue", b"receive_queue", "rx_text_message", b"rx_text_message", "rx_waypoint", b"rx_waypoint", "version", b"version"]) -> None: ...
+
+global___DeviceState = DeviceState
+
+@typing_extensions.final
+class ChannelFile(google.protobuf.message.Message):
+    """
+    The on-disk saved channels
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CHANNELS_FIELD_NUMBER: builtins.int
+    VERSION_FIELD_NUMBER: builtins.int
+    @property
+    def channels(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[meshtastic.channel_pb2.Channel]:
+        """
+        The channels our node knows about
+        """
+    version: builtins.int
+    """
+    A version integer used to invalidate old save files when we make
+    incompatible changes This integer is set at build time and is private to
+    NodeDB.cpp in the device code.
+    """
+    def __init__(
+        self,
+        *,
+        channels: collections.abc.Iterable[meshtastic.channel_pb2.Channel] | None = ...,
+        version: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["channels", b"channels", "version", b"version"]) -> None: ...
+
+global___ChannelFile = ChannelFile
+
+@typing_extensions.final
+class OEMStore(google.protobuf.message.Message):
+    """
+    This can be used for customizing the firmware distribution. If populated,
+    show a secondary bootup screen with custom logo and text for 2.5 seconds.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    OEM_ICON_WIDTH_FIELD_NUMBER: builtins.int
+    OEM_ICON_HEIGHT_FIELD_NUMBER: builtins.int
+    OEM_ICON_BITS_FIELD_NUMBER: builtins.int
+    OEM_FONT_FIELD_NUMBER: builtins.int
+    OEM_TEXT_FIELD_NUMBER: builtins.int
+    OEM_AES_KEY_FIELD_NUMBER: builtins.int
+    OEM_LOCAL_CONFIG_FIELD_NUMBER: builtins.int
+    OEM_LOCAL_MODULE_CONFIG_FIELD_NUMBER: builtins.int
+    oem_icon_width: builtins.int
+    """
+    The Logo width in Px
+    """
+    oem_icon_height: builtins.int
+    """
+    The Logo height in Px
+    """
+    oem_icon_bits: builtins.bytes
+    """
+    The Logo in XBM bytechar format
+    """
+    oem_font: global___ScreenFonts.ValueType
+    """
+    Use this font for the OEM text.
+    """
+    oem_text: builtins.str
+    """
+    Use this font for the OEM text.
+    """
+    oem_aes_key: builtins.bytes
+    """
+    The default device encryption key, 16 or 32 byte
+    """
+    @property
+    def oem_local_config(self) -> meshtastic.localonly_pb2.LocalConfig:
+        """
+        A Preset LocalConfig to apply during factory reset
+        """
+    @property
+    def oem_local_module_config(self) -> meshtastic.localonly_pb2.LocalModuleConfig:
+        """
+        A Preset LocalModuleConfig to apply during factory reset
+        """
+    def __init__(
+        self,
+        *,
+        oem_icon_width: builtins.int = ...,
+        oem_icon_height: builtins.int = ...,
+        oem_icon_bits: builtins.bytes = ...,
+        oem_font: global___ScreenFonts.ValueType = ...,
+        oem_text: builtins.str = ...,
+        oem_aes_key: builtins.bytes = ...,
+        oem_local_config: meshtastic.localonly_pb2.LocalConfig | None = ...,
+        oem_local_module_config: meshtastic.localonly_pb2.LocalModuleConfig | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["oem_local_config", b"oem_local_config", "oem_local_module_config", b"oem_local_module_config"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["oem_aes_key", b"oem_aes_key", "oem_font", b"oem_font", "oem_icon_bits", b"oem_icon_bits", "oem_icon_height", b"oem_icon_height", "oem_icon_width", b"oem_icon_width", "oem_local_config", b"oem_local_config", "oem_local_module_config", b"oem_local_module_config", "oem_text", b"oem_text"]) -> None: ...
+
+global___OEMStore = OEMStore

meshtastic/environmental_measurement_pb2.py

@@ -1,35 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: environmental_measurement.proto
-"""Generated protocol buffer code."""
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
-from google.protobuf import symbol_database as _symbol_database
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1f\x65nvironmental_measurement.proto\"\xa1\x01\n\x18\x45nvironmentalMeasurement\x12\x13\n\x0btemperature\x18\x01 \x01(\x02\x12\x19\n\x11relative_humidity\x18\x02 \x01(\x02\x12\x1b\n\x13\x62\x61rometric_pressure\x18\x03 \x01(\x02\x12\x16\n\x0egas_resistance\x18\x04 \x01(\x02\x12\x0f\n\x07voltage\x18\x05 \x01(\x02\x12\x0f\n\x07\x63urrent\x18\x06 \x01(\x02\x42#Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_ENVIRONMENTALMEASUREMENT = DESCRIPTOR.message_types_by_name['EnvironmentalMeasurement']
-EnvironmentalMeasurement = _reflection.GeneratedProtocolMessageType('EnvironmentalMeasurement', (_message.Message,), {
-  'DESCRIPTOR' : _ENVIRONMENTALMEASUREMENT,
-  '__module__' : 'environmental_measurement_pb2'
-  # @@protoc_insertion_point(class_scope:EnvironmentalMeasurement)
-  })
-_sym_db.RegisterMessage(EnvironmentalMeasurement)
-
-if _descriptor._USE_C_DESCRIPTORS == False:
-
-  DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'Z!github.com/meshtastic/gomeshproto'
-  _ENVIRONMENTALMEASUREMENT._serialized_start=36
-  _ENVIRONMENTALMEASUREMENT._serialized_end=197
-# @@protoc_insertion_point(module_scope)

meshtastic/globals.py

@@ -1,94 +0,0 @@
-"""Globals singleton class.
-
-   Instead of using a global, stuff your variables in this "trash can".
-   This is not much better than using python's globals, but it allows
-   us to better test meshtastic. Plus, there are some weird python
-   global issues/gotcha that we can hopefully avoid by using this
-   class instead.
-
-"""
-
-class Globals:
-    """Globals class is a Singleton."""
-    __instance = None
-
-    @staticmethod
-    def getInstance():
-        """Get an instance of the Globals class."""
-        if Globals.__instance is None:
-            Globals()
-        return Globals.__instance
-
-    def __init__(self):
-        """Constructor for the Globals CLass"""
-        if Globals.__instance is not None:
-            raise Exception("This class is a singleton")
-        else:
-            Globals.__instance = self
-        self.args = None
-        self.parser = None
-        self.channel_index = None
-        self.logfile = None
-        self.tunnelInstance = None
-        # TODO: to migrate to camel_case for v1.3 change this value to True
-        self.camel_case = False
-
-    def reset(self):
-        """Reset all of our globals. If you add a member, add it to this method, too."""
-        self.args = None
-        self.parser = None
-        self.channel_index = None
-        self.logfile = None
-        self.tunnelInstance = None
-        # TODO: to migrate to camel_case for v1.3 change this value to True
-        self.camel_case = False
-
-    # setters
-    def set_args(self, args):
-        """Set the args"""
-        self.args = args
-
-    def set_parser(self, parser):
-        """Set the parser"""
-        self.parser = parser
-
-    def set_channel_index(self, channel_index):
-        """Set the channel_index"""
-        self.channel_index = channel_index
-
-    def set_logfile(self, logfile):
-        """Set the logfile"""
-        self.logfile = logfile
-
-    def set_tunnelInstance(self, tunnelInstance):
-        """Set the tunnelInstance"""
-        self.tunnelInstance = tunnelInstance
-
-    def set_camel_case(self):
-        """Force using camelCase for things like prefs/set/set"""
-        self.camel_case = True
-
-    # getters
-    def get_args(self):
-        """Get args"""
-        return self.args
-
-    def get_parser(self):
-        """Get parser"""
-        return self.parser
-
-    def get_channel_index(self):
-        """Get channel_index"""
-        return self.channel_index
-
-    def get_logfile(self):
-        """Get logfile"""
-        return self.logfile
-
-    def get_tunnelInstance(self):
-        """Get tunnelInstance"""
-        return self.tunnelInstance
-
-    def get_camel_case(self):
-        """Get whether or not to use camelCase"""
-        return self.camel_case

meshtastic/localonly_pb2.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/localonly.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from meshtastic import config_pb2 as meshtastic_dot_config__pb2
+from meshtastic import module_config_pb2 as meshtastic_dot_module__config__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1ameshtastic/localonly.proto\x12\nmeshtastic\x1a\x17meshtastic/config.proto\x1a\x1emeshtastic/module_config.proto\"\xfd\x02\n\x0bLocalConfig\x12/\n\x06\x64\x65vice\x18\x01 \x01(\x0b\x32\x1f.meshtastic.Config.DeviceConfig\x12\x33\n\x08position\x18\x02 \x01(\x0b\x32!.meshtastic.Config.PositionConfig\x12-\n\x05power\x18\x03 \x01(\x0b\x32\x1e.meshtastic.Config.PowerConfig\x12\x31\n\x07network\x18\x04 \x01(\x0b\x32 .meshtastic.Config.NetworkConfig\x12\x31\n\x07\x64isplay\x18\x05 \x01(\x0b\x32 .meshtastic.Config.DisplayConfig\x12+\n\x04lora\x18\x06 \x01(\x0b\x32\x1d.meshtastic.Config.LoRaConfig\x12\x35\n\tbluetooth\x18\x07 \x01(\x0b\x32\".meshtastic.Config.BluetoothConfig\x12\x0f\n\x07version\x18\x08 \x01(\r\"\xfb\x06\n\x11LocalModuleConfig\x12\x31\n\x04mqtt\x18\x01 \x01(\x0b\x32#.meshtastic.ModuleConfig.MQTTConfig\x12\x35\n\x06serial\x18\x02 \x01(\x0b\x32%.meshtastic.ModuleConfig.SerialConfig\x12R\n\x15\x65xternal_notification\x18\x03 \x01(\x0b\x32\x33.meshtastic.ModuleConfig.ExternalNotificationConfig\x12\x42\n\rstore_forward\x18\x04 \x01(\x0b\x32+.meshtastic.ModuleConfig.StoreForwardConfig\x12<\n\nrange_test\x18\x05 \x01(\x0b\x32(.meshtastic.ModuleConfig.RangeTestConfig\x12;\n\ttelemetry\x18\x06 \x01(\x0b\x32(.meshtastic.ModuleConfig.TelemetryConfig\x12\x44\n\x0e\x63\x61nned_message\x18\x07 \x01(\x0b\x32,.meshtastic.ModuleConfig.CannedMessageConfig\x12\x33\n\x05\x61udio\x18\t \x01(\x0b\x32$.meshtastic.ModuleConfig.AudioConfig\x12\x46\n\x0fremote_hardware\x18\n \x01(\x0b\x32-.meshtastic.ModuleConfig.RemoteHardwareConfig\x12\x42\n\rneighbor_info\x18\x0b \x01(\x0b\x32+.meshtastic.ModuleConfig.NeighborInfoConfig\x12H\n\x10\x61mbient_lighting\x18\x0c \x01(\x0b\x32..meshtastic.ModuleConfig.AmbientLightingConfig\x12H\n\x10\x64\x65tection_sensor\x18\r \x01(\x0b\x32..meshtastic.ModuleConfig.DetectionSensorConfig\x12=\n\npaxcounter\x18\x0e \x01(\x0b\x32).meshtastic.ModuleConfig.PaxcounterConfig\x12\x0f\n\x07version\x18\x08 \x01(\rBd\n\x13\x63om.geeksville.meshB\x0fLocalOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.localonly_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\017LocalOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _LOCALCONFIG._serialized_start=100
+  _LOCALCONFIG._serialized_end=481
+  _LOCALMODULECONFIG._serialized_start=484
+  _LOCALMODULECONFIG._serialized_end=1375
+# @@protoc_insertion_point(module_scope)

meshtastic/localonly_pb2.pyi

@@ -0,0 +1,204 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import meshtastic.config_pb2
+import meshtastic.module_config_pb2
+import sys
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class LocalConfig(google.protobuf.message.Message):
+    """
+    Protobuf structures common to apponly.proto and deviceonly.proto
+    This is never sent over the wire, only for local use
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    DEVICE_FIELD_NUMBER: builtins.int
+    POSITION_FIELD_NUMBER: builtins.int
+    POWER_FIELD_NUMBER: builtins.int
+    NETWORK_FIELD_NUMBER: builtins.int
+    DISPLAY_FIELD_NUMBER: builtins.int
+    LORA_FIELD_NUMBER: builtins.int
+    BLUETOOTH_FIELD_NUMBER: builtins.int
+    VERSION_FIELD_NUMBER: builtins.int
+    @property
+    def device(self) -> meshtastic.config_pb2.Config.DeviceConfig:
+        """
+        The part of the config that is specific to the Device
+        """
+    @property
+    def position(self) -> meshtastic.config_pb2.Config.PositionConfig:
+        """
+        The part of the config that is specific to the GPS Position
+        """
+    @property
+    def power(self) -> meshtastic.config_pb2.Config.PowerConfig:
+        """
+        The part of the config that is specific to the Power settings
+        """
+    @property
+    def network(self) -> meshtastic.config_pb2.Config.NetworkConfig:
+        """
+        The part of the config that is specific to the Wifi Settings
+        """
+    @property
+    def display(self) -> meshtastic.config_pb2.Config.DisplayConfig:
+        """
+        The part of the config that is specific to the Display
+        """
+    @property
+    def lora(self) -> meshtastic.config_pb2.Config.LoRaConfig:
+        """
+        The part of the config that is specific to the Lora Radio
+        """
+    @property
+    def bluetooth(self) -> meshtastic.config_pb2.Config.BluetoothConfig:
+        """
+        The part of the config that is specific to the Bluetooth settings
+        """
+    version: builtins.int
+    """
+    A version integer used to invalidate old save files when we make
+    incompatible changes This integer is set at build time and is private to
+    NodeDB.cpp in the device code.
+    """
+    def __init__(
+        self,
+        *,
+        device: meshtastic.config_pb2.Config.DeviceConfig | None = ...,
+        position: meshtastic.config_pb2.Config.PositionConfig | None = ...,
+        power: meshtastic.config_pb2.Config.PowerConfig | None = ...,
+        network: meshtastic.config_pb2.Config.NetworkConfig | None = ...,
+        display: meshtastic.config_pb2.Config.DisplayConfig | None = ...,
+        lora: meshtastic.config_pb2.Config.LoRaConfig | None = ...,
+        bluetooth: meshtastic.config_pb2.Config.BluetoothConfig | None = ...,
+        version: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["bluetooth", b"bluetooth", "device", b"device", "display", b"display", "lora", b"lora", "network", b"network", "position", b"position", "power", b"power"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["bluetooth", b"bluetooth", "device", b"device", "display", b"display", "lora", b"lora", "network", b"network", "position", b"position", "power", b"power", "version", b"version"]) -> None: ...
+
+global___LocalConfig = LocalConfig
+
+@typing_extensions.final
+class LocalModuleConfig(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MQTT_FIELD_NUMBER: builtins.int
+    SERIAL_FIELD_NUMBER: builtins.int
+    EXTERNAL_NOTIFICATION_FIELD_NUMBER: builtins.int
+    STORE_FORWARD_FIELD_NUMBER: builtins.int
+    RANGE_TEST_FIELD_NUMBER: builtins.int
+    TELEMETRY_FIELD_NUMBER: builtins.int
+    CANNED_MESSAGE_FIELD_NUMBER: builtins.int
+    AUDIO_FIELD_NUMBER: builtins.int
+    REMOTE_HARDWARE_FIELD_NUMBER: builtins.int
+    NEIGHBOR_INFO_FIELD_NUMBER: builtins.int
+    AMBIENT_LIGHTING_FIELD_NUMBER: builtins.int
+    DETECTION_SENSOR_FIELD_NUMBER: builtins.int
+    PAXCOUNTER_FIELD_NUMBER: builtins.int
+    VERSION_FIELD_NUMBER: builtins.int
+    @property
+    def mqtt(self) -> meshtastic.module_config_pb2.ModuleConfig.MQTTConfig:
+        """
+        The part of the config that is specific to the MQTT module
+        """
+    @property
+    def serial(self) -> meshtastic.module_config_pb2.ModuleConfig.SerialConfig:
+        """
+        The part of the config that is specific to the Serial module
+        """
+    @property
+    def external_notification(self) -> meshtastic.module_config_pb2.ModuleConfig.ExternalNotificationConfig:
+        """
+        The part of the config that is specific to the ExternalNotification module
+        """
+    @property
+    def store_forward(self) -> meshtastic.module_config_pb2.ModuleConfig.StoreForwardConfig:
+        """
+        The part of the config that is specific to the Store & Forward module
+        """
+    @property
+    def range_test(self) -> meshtastic.module_config_pb2.ModuleConfig.RangeTestConfig:
+        """
+        The part of the config that is specific to the RangeTest module
+        """
+    @property
+    def telemetry(self) -> meshtastic.module_config_pb2.ModuleConfig.TelemetryConfig:
+        """
+        The part of the config that is specific to the Telemetry module
+        """
+    @property
+    def canned_message(self) -> meshtastic.module_config_pb2.ModuleConfig.CannedMessageConfig:
+        """
+        The part of the config that is specific to the Canned Message module
+        """
+    @property
+    def audio(self) -> meshtastic.module_config_pb2.ModuleConfig.AudioConfig:
+        """
+        The part of the config that is specific to the Audio module
+        """
+    @property
+    def remote_hardware(self) -> meshtastic.module_config_pb2.ModuleConfig.RemoteHardwareConfig:
+        """
+        The part of the config that is specific to the Remote Hardware module
+        """
+    @property
+    def neighbor_info(self) -> meshtastic.module_config_pb2.ModuleConfig.NeighborInfoConfig:
+        """
+        The part of the config that is specific to the Neighbor Info module
+        """
+    @property
+    def ambient_lighting(self) -> meshtastic.module_config_pb2.ModuleConfig.AmbientLightingConfig:
+        """
+        The part of the config that is specific to the Ambient Lighting module
+        """
+    @property
+    def detection_sensor(self) -> meshtastic.module_config_pb2.ModuleConfig.DetectionSensorConfig:
+        """
+        The part of the config that is specific to the Detection Sensor module
+        """
+    @property
+    def paxcounter(self) -> meshtastic.module_config_pb2.ModuleConfig.PaxcounterConfig:
+        """
+        Paxcounter Config
+        """
+    version: builtins.int
+    """
+    A version integer used to invalidate old save files when we make
+    incompatible changes This integer is set at build time and is private to
+    NodeDB.cpp in the device code.
+    """
+    def __init__(
+        self,
+        *,
+        mqtt: meshtastic.module_config_pb2.ModuleConfig.MQTTConfig | None = ...,
+        serial: meshtastic.module_config_pb2.ModuleConfig.SerialConfig | None = ...,
+        external_notification: meshtastic.module_config_pb2.ModuleConfig.ExternalNotificationConfig | None = ...,
+        store_forward: meshtastic.module_config_pb2.ModuleConfig.StoreForwardConfig | None = ...,
+        range_test: meshtastic.module_config_pb2.ModuleConfig.RangeTestConfig | None = ...,
+        telemetry: meshtastic.module_config_pb2.ModuleConfig.TelemetryConfig | None = ...,
+        canned_message: meshtastic.module_config_pb2.ModuleConfig.CannedMessageConfig | None = ...,
+        audio: meshtastic.module_config_pb2.ModuleConfig.AudioConfig | None = ...,
+        remote_hardware: meshtastic.module_config_pb2.ModuleConfig.RemoteHardwareConfig | None = ...,
+        neighbor_info: meshtastic.module_config_pb2.ModuleConfig.NeighborInfoConfig | None = ...,
+        ambient_lighting: meshtastic.module_config_pb2.ModuleConfig.AmbientLightingConfig | None = ...,
+        detection_sensor: meshtastic.module_config_pb2.ModuleConfig.DetectionSensorConfig | None = ...,
+        paxcounter: meshtastic.module_config_pb2.ModuleConfig.PaxcounterConfig | None = ...,
+        version: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["ambient_lighting", b"ambient_lighting", "audio", b"audio", "canned_message", b"canned_message", "detection_sensor", b"detection_sensor", "external_notification", b"external_notification", "mqtt", b"mqtt", "neighbor_info", b"neighbor_info", "paxcounter", b"paxcounter", "range_test", b"range_test", "remote_hardware", b"remote_hardware", "serial", b"serial", "store_forward", b"store_forward", "telemetry", b"telemetry"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["ambient_lighting", b"ambient_lighting", "audio", b"audio", "canned_message", b"canned_message", "detection_sensor", b"detection_sensor", "external_notification", b"external_notification", "mqtt", b"mqtt", "neighbor_info", b"neighbor_info", "paxcounter", b"paxcounter", "range_test", b"range_test", "remote_hardware", b"remote_hardware", "serial", b"serial", "store_forward", b"store_forward", "telemetry", b"telemetry", "version", b"version"]) -> None: ...
+
+global___LocalModuleConfig = LocalModuleConfig

meshtastic/mqtt_pb2.py

@@ -1,36 +1,30 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: mqtt.proto
+# source: meshtastic/mqtt.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
 _sym_db = _symbol_database.Default()
 
 
-from . import mesh_pb2 as mesh__pb2
+from meshtastic import config_pb2 as meshtastic_dot_config__pb2
+from meshtastic import mesh_pb2 as meshtastic_dot_mesh__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\nmqtt.proto\x1a\nmesh.proto\"V\n\x0fServiceEnvelope\x12\x1b\n\x06packet\x18\x01 \x01(\x0b\x32\x0b.MeshPacket\x12\x12\n\nchannel_id\x18\x02 \x01(\t\x12\x12\n\ngateway_id\x18\x03 \x01(\tBF\n\x13\x63om.geeksville.meshB\nMQTTProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_SERVICEENVELOPE = DESCRIPTOR.message_types_by_name['ServiceEnvelope']
-ServiceEnvelope = _reflection.GeneratedProtocolMessageType('ServiceEnvelope', (_message.Message,), {
-  'DESCRIPTOR' : _SERVICEENVELOPE,
-  '__module__' : 'mqtt_pb2'
-  # @@protoc_insertion_point(class_scope:ServiceEnvelope)
-  })
-_sym_db.RegisterMessage(ServiceEnvelope)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15meshtastic/mqtt.proto\x12\nmeshtastic\x1a\x17meshtastic/config.proto\x1a\x15meshtastic/mesh.proto\"a\n\x0fServiceEnvelope\x12&\n\x06packet\x18\x01 \x01(\x0b\x32\x16.meshtastic.MeshPacket\x12\x12\n\nchannel_id\x18\x02 \x01(\t\x12\x12\n\ngateway_id\x18\x03 \x01(\t\"\xbc\x03\n\tMapReport\x12\x11\n\tlong_name\x18\x01 \x01(\t\x12\x12\n\nshort_name\x18\x02 \x01(\t\x12\x32\n\x04role\x18\x03 \x01(\x0e\x32$.meshtastic.Config.DeviceConfig.Role\x12+\n\x08hw_model\x18\x04 \x01(\x0e\x32\x19.meshtastic.HardwareModel\x12\x18\n\x10\x66irmware_version\x18\x05 \x01(\t\x12\x38\n\x06region\x18\x06 \x01(\x0e\x32(.meshtastic.Config.LoRaConfig.RegionCode\x12?\n\x0cmodem_preset\x18\x07 \x01(\x0e\x32).meshtastic.Config.LoRaConfig.ModemPreset\x12\x1b\n\x13has_default_channel\x18\x08 \x01(\x08\x12\x12\n\nlatitude_i\x18\t \x01(\x0f\x12\x13\n\x0blongitude_i\x18\n \x01(\x0f\x12\x10\n\x08\x61ltitude\x18\x0b \x01(\x05\x12\x1a\n\x12position_precision\x18\x0c \x01(\r\x12\x1e\n\x16num_online_local_nodes\x18\r \x01(\rB_\n\x13\x63om.geeksville.meshB\nMQTTProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.mqtt_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nMQTTProtosH\003Z!github.com/meshtastic/gomeshproto'
-  _SERVICEENVELOPE._serialized_start=26
-  _SERVICEENVELOPE._serialized_end=112
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nMQTTProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _SERVICEENVELOPE._serialized_start=85
+  _SERVICEENVELOPE._serialized_end=182
+  _MAPREPORT._serialized_start=185
+  _MAPREPORT._serialized_end=629
 # @@protoc_insertion_point(module_scope)

meshtastic/mqtt_pb2.pyi

@@ -0,0 +1,151 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import meshtastic.config_pb2
+import meshtastic.mesh_pb2
+import sys
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class ServiceEnvelope(google.protobuf.message.Message):
+    """
+    This message wraps a MeshPacket with extra metadata about the sender and how it arrived.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PACKET_FIELD_NUMBER: builtins.int
+    CHANNEL_ID_FIELD_NUMBER: builtins.int
+    GATEWAY_ID_FIELD_NUMBER: builtins.int
+    @property
+    def packet(self) -> meshtastic.mesh_pb2.MeshPacket:
+        """
+        The (probably encrypted) packet
+        """
+    channel_id: builtins.str
+    """
+    The global channel ID it was sent on
+    """
+    gateway_id: builtins.str
+    """
+    The sending gateway node ID. Can we use this to authenticate/prevent fake
+    nodeid impersonation for senders? - i.e. use gateway/mesh id (which is authenticated) + local node id as
+    the globally trusted nodenum
+    """
+    def __init__(
+        self,
+        *,
+        packet: meshtastic.mesh_pb2.MeshPacket | None = ...,
+        channel_id: builtins.str = ...,
+        gateway_id: builtins.str = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["packet", b"packet"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["channel_id", b"channel_id", "gateway_id", b"gateway_id", "packet", b"packet"]) -> None: ...
+
+global___ServiceEnvelope = ServiceEnvelope
+
+@typing_extensions.final
+class MapReport(google.protobuf.message.Message):
+    """
+    Information about a node intended to be reported unencrypted to a map using MQTT.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    LONG_NAME_FIELD_NUMBER: builtins.int
+    SHORT_NAME_FIELD_NUMBER: builtins.int
+    ROLE_FIELD_NUMBER: builtins.int
+    HW_MODEL_FIELD_NUMBER: builtins.int
+    FIRMWARE_VERSION_FIELD_NUMBER: builtins.int
+    REGION_FIELD_NUMBER: builtins.int
+    MODEM_PRESET_FIELD_NUMBER: builtins.int
+    HAS_DEFAULT_CHANNEL_FIELD_NUMBER: builtins.int
+    LATITUDE_I_FIELD_NUMBER: builtins.int
+    LONGITUDE_I_FIELD_NUMBER: builtins.int
+    ALTITUDE_FIELD_NUMBER: builtins.int
+    POSITION_PRECISION_FIELD_NUMBER: builtins.int
+    NUM_ONLINE_LOCAL_NODES_FIELD_NUMBER: builtins.int
+    long_name: builtins.str
+    """
+    A full name for this user, i.e. "Kevin Hester"
+    """
+    short_name: builtins.str
+    """
+    A VERY short name, ideally two characters.
+    Suitable for a tiny OLED screen
+    """
+    role: meshtastic.config_pb2.Config.DeviceConfig.Role.ValueType
+    """
+    Role of the node that applies specific settings for a particular use-case
+    """
+    hw_model: meshtastic.mesh_pb2.HardwareModel.ValueType
+    """
+    Hardware model of the node, i.e. T-Beam, Heltec V3, etc...
+    """
+    firmware_version: builtins.str
+    """
+    Device firmware version string
+    """
+    region: meshtastic.config_pb2.Config.LoRaConfig.RegionCode.ValueType
+    """
+    The region code for the radio (US, CN, EU433, etc...)
+    """
+    modem_preset: meshtastic.config_pb2.Config.LoRaConfig.ModemPreset.ValueType
+    """
+    Modem preset used by the radio (LongFast, MediumSlow, etc...)
+    """
+    has_default_channel: builtins.bool
+    """
+    Whether the node has a channel with default PSK and name (LongFast, MediumSlow, etc...)
+    and it uses the default frequency slot given the region and modem preset.
+    """
+    latitude_i: builtins.int
+    """
+    Latitude: multiply by 1e-7 to get degrees in floating point
+    """
+    longitude_i: builtins.int
+    """
+    Longitude: multiply by 1e-7 to get degrees in floating point
+    """
+    altitude: builtins.int
+    """
+    Altitude in meters above MSL
+    """
+    position_precision: builtins.int
+    """
+    Indicates the bits of precision for latitude and longitude set by the sending node
+    """
+    num_online_local_nodes: builtins.int
+    """
+    Number of online nodes (heard in the last 2 hours) this node has in its list that were received locally (not via MQTT)
+    """
+    def __init__(
+        self,
+        *,
+        long_name: builtins.str = ...,
+        short_name: builtins.str = ...,
+        role: meshtastic.config_pb2.Config.DeviceConfig.Role.ValueType = ...,
+        hw_model: meshtastic.mesh_pb2.HardwareModel.ValueType = ...,
+        firmware_version: builtins.str = ...,
+        region: meshtastic.config_pb2.Config.LoRaConfig.RegionCode.ValueType = ...,
+        modem_preset: meshtastic.config_pb2.Config.LoRaConfig.ModemPreset.ValueType = ...,
+        has_default_channel: builtins.bool = ...,
+        latitude_i: builtins.int = ...,
+        longitude_i: builtins.int = ...,
+        altitude: builtins.int = ...,
+        position_precision: builtins.int = ...,
+        num_online_local_nodes: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["altitude", b"altitude", "firmware_version", b"firmware_version", "has_default_channel", b"has_default_channel", "hw_model", b"hw_model", "latitude_i", b"latitude_i", "long_name", b"long_name", "longitude_i", b"longitude_i", "modem_preset", b"modem_preset", "num_online_local_nodes", b"num_online_local_nodes", "position_precision", b"position_precision", "region", b"region", "role", b"role", "short_name", b"short_name"]) -> None: ...
+
+global___MapReport = MapReport

meshtastic/mt_config.py

@@ -0,0 +1,37 @@
+"""
+Globals singleton class.
+
+The Global object is gone, as are all its setters and getters. Instead the
+module itself is the singleton namespace, which can be imported into
+whichever module is used. The associated tests have also been removed,
+since we now rely on built in Python mechanisms.
+
+This is intended to make the Python read more naturally, and to make the
+intention of the code clearer and more compact. It is merely a sticking
+plaster over the use of shared mt_config, but the coupling issues wil be dealt
+with rather more easily once the code is simplified by this change.
+
+"""
+
+def reset():
+    """
+    Restore the namespace to pristine condition.
+    """
+    # pylint: disable=W0603
+    global args, parser, channel_index, logfile, tunnelInstance, camel_case
+    args = None
+    parser = None
+    channel_index = None
+    logfile = None
+    tunnelInstance = None
+    # TODO: to migrate to camel_case for v1.3 change this value to True
+    camel_case = False
+
+# These assignments are used instead of calling reset()
+# purely to shut pylint up.
+args = None
+parser = None
+channel_index = None
+logfile = None
+tunnelInstance = None
+camel_case = False

meshtastic/nanopb_pb2.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: nanopb.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import descriptor_pb2 as google_dot_protobuf_dot_descriptor__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0cnanopb.proto\x1a google/protobuf/descriptor.proto\"\xa4\x07\n\rNanoPBOptions\x12\x10\n\x08max_size\x18\x01 \x01(\x05\x12\x12\n\nmax_length\x18\x0e \x01(\x05\x12\x11\n\tmax_count\x18\x02 \x01(\x05\x12&\n\x08int_size\x18\x07 \x01(\x0e\x32\x08.IntSize:\nIS_DEFAULT\x12$\n\x04type\x18\x03 \x01(\x0e\x32\n.FieldType:\nFT_DEFAULT\x12\x18\n\nlong_names\x18\x04 \x01(\x08:\x04true\x12\x1c\n\rpacked_struct\x18\x05 \x01(\x08:\x05\x66\x61lse\x12\x1a\n\x0bpacked_enum\x18\n \x01(\x08:\x05\x66\x61lse\x12\x1b\n\x0cskip_message\x18\x06 \x01(\x08:\x05\x66\x61lse\x12\x18\n\tno_unions\x18\x08 \x01(\x08:\x05\x66\x61lse\x12\r\n\x05msgid\x18\t \x01(\r\x12\x1e\n\x0f\x61nonymous_oneof\x18\x0b \x01(\x08:\x05\x66\x61lse\x12\x15\n\x06proto3\x18\x0c \x01(\x08:\x05\x66\x61lse\x12#\n\x14proto3_singular_msgs\x18\x15 \x01(\x08:\x05\x66\x61lse\x12\x1d\n\x0e\x65num_to_string\x18\r \x01(\x08:\x05\x66\x61lse\x12\x1b\n\x0c\x66ixed_length\x18\x0f \x01(\x08:\x05\x66\x61lse\x12\x1a\n\x0b\x66ixed_count\x18\x10 \x01(\x08:\x05\x66\x61lse\x12\x1e\n\x0fsubmsg_callback\x18\x16 \x01(\x08:\x05\x66\x61lse\x12/\n\x0cmangle_names\x18\x11 \x01(\x0e\x32\x11.TypenameMangling:\x06M_NONE\x12(\n\x11\x63\x61llback_datatype\x18\x12 \x01(\t:\rpb_callback_t\x12\x34\n\x11\x63\x61llback_function\x18\x13 \x01(\t:\x19pb_default_field_callback\x12\x30\n\x0e\x64\x65scriptorsize\x18\x14 \x01(\x0e\x32\x0f.DescriptorSize:\x07\x44S_AUTO\x12\x1a\n\x0b\x64\x65\x66\x61ult_has\x18\x17 \x01(\x08:\x05\x66\x61lse\x12\x0f\n\x07include\x18\x18 \x03(\t\x12\x0f\n\x07\x65xclude\x18\x1a \x03(\t\x12\x0f\n\x07package\x18\x19 \x01(\t\x12\x41\n\rtype_override\x18\x1b \x01(\x0e\x32*.google.protobuf.FieldDescriptorProto.Type\x12\x19\n\x0bsort_by_tag\x18\x1c \x01(\x08:\x04true\x12.\n\rfallback_type\x18\x1d \x01(\x0e\x32\n.FieldType:\x0b\x46T_CALLBACK*i\n\tFieldType\x12\x0e\n\nFT_DEFAULT\x10\x00\x12\x0f\n\x0b\x46T_CALLBACK\x10\x01\x12\x0e\n\nFT_POINTER\x10\x04\x12\r\n\tFT_STATIC\x10\x02\x12\r\n\tFT_IGNORE\x10\x03\x12\r\n\tFT_INLINE\x10\x05*D\n\x07IntSize\x12\x0e\n\nIS_DEFAULT\x10\x00\x12\x08\n\x04IS_8\x10\x08\x12\t\n\x05IS_16\x10\x10\x12\t\n\x05IS_32\x10 \x12\t\n\x05IS_64\x10@*Z\n\x10TypenameMangling\x12\n\n\x06M_NONE\x10\x00\x12\x13\n\x0fM_STRIP_PACKAGE\x10\x01\x12\r\n\tM_FLATTEN\x10\x02\x12\x16\n\x12M_PACKAGE_INITIALS\x10\x03*E\n\x0e\x44\x65scriptorSize\x12\x0b\n\x07\x44S_AUTO\x10\x00\x12\x08\n\x04\x44S_1\x10\x01\x12\x08\n\x04\x44S_2\x10\x02\x12\x08\n\x04\x44S_4\x10\x04\x12\x08\n\x04\x44S_8\x10\x08:E\n\x0enanopb_fileopt\x12\x1c.google.protobuf.FileOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions:G\n\rnanopb_msgopt\x12\x1f.google.protobuf.MessageOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions:E\n\x0enanopb_enumopt\x12\x1c.google.protobuf.EnumOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptions:>\n\x06nanopb\x12\x1d.google.protobuf.FieldOptions\x18\xf2\x07 \x01(\x0b\x32\x0e.NanoPBOptionsB\x1a\n\x18\x66i.kapsi.koti.jpa.nanopb')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'nanopb_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+  google_dot_protobuf_dot_descriptor__pb2.FileOptions.RegisterExtension(nanopb_fileopt)
+  google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(nanopb_msgopt)
+  google_dot_protobuf_dot_descriptor__pb2.EnumOptions.RegisterExtension(nanopb_enumopt)
+  google_dot_protobuf_dot_descriptor__pb2.FieldOptions.RegisterExtension(nanopb)
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\030fi.kapsi.koti.jpa.nanopb'
+  _FIELDTYPE._serialized_start=985
+  _FIELDTYPE._serialized_end=1090
+  _INTSIZE._serialized_start=1092
+  _INTSIZE._serialized_end=1160
+  _TYPENAMEMANGLING._serialized_start=1162
+  _TYPENAMEMANGLING._serialized_end=1252
+  _DESCRIPTORSIZE._serialized_start=1254
+  _DESCRIPTORSIZE._serialized_end=1323
+  _NANOPBOPTIONS._serialized_start=51
+  _NANOPBOPTIONS._serialized_end=983
+# @@protoc_insertion_point(module_scope)

meshtastic/nanopb_pb2.pyi

@@ -0,0 +1,321 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+Custom options for defining:
+- Maximum size of string/bytes
+- Maximum number of elements in array
+
+These are used by nanopb to generate statically allocable structures
+for memory-limited environments.
+"""
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.descriptor_pb2
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.internal.extension_dict
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _FieldType:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _FieldTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_FieldType.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    FT_DEFAULT: _FieldType.ValueType  # 0
+    """Automatically decide field type, generate static field if possible."""
+    FT_CALLBACK: _FieldType.ValueType  # 1
+    """Always generate a callback field."""
+    FT_POINTER: _FieldType.ValueType  # 4
+    """Always generate a dynamically allocated field."""
+    FT_STATIC: _FieldType.ValueType  # 2
+    """Generate a static field or raise an exception if not possible."""
+    FT_IGNORE: _FieldType.ValueType  # 3
+    """Ignore the field completely."""
+    FT_INLINE: _FieldType.ValueType  # 5
+    """Legacy option, use the separate 'fixed_length' option instead"""
+
+class FieldType(_FieldType, metaclass=_FieldTypeEnumTypeWrapper): ...
+
+FT_DEFAULT: FieldType.ValueType  # 0
+"""Automatically decide field type, generate static field if possible."""
+FT_CALLBACK: FieldType.ValueType  # 1
+"""Always generate a callback field."""
+FT_POINTER: FieldType.ValueType  # 4
+"""Always generate a dynamically allocated field."""
+FT_STATIC: FieldType.ValueType  # 2
+"""Generate a static field or raise an exception if not possible."""
+FT_IGNORE: FieldType.ValueType  # 3
+"""Ignore the field completely."""
+FT_INLINE: FieldType.ValueType  # 5
+"""Legacy option, use the separate 'fixed_length' option instead"""
+global___FieldType = FieldType
+
+class _IntSize:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _IntSizeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_IntSize.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    IS_DEFAULT: _IntSize.ValueType  # 0
+    """Default, 32/64bit based on type in .proto"""
+    IS_8: _IntSize.ValueType  # 8
+    IS_16: _IntSize.ValueType  # 16
+    IS_32: _IntSize.ValueType  # 32
+    IS_64: _IntSize.ValueType  # 64
+
+class IntSize(_IntSize, metaclass=_IntSizeEnumTypeWrapper): ...
+
+IS_DEFAULT: IntSize.ValueType  # 0
+"""Default, 32/64bit based on type in .proto"""
+IS_8: IntSize.ValueType  # 8
+IS_16: IntSize.ValueType  # 16
+IS_32: IntSize.ValueType  # 32
+IS_64: IntSize.ValueType  # 64
+global___IntSize = IntSize
+
+class _TypenameMangling:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _TypenameManglingEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_TypenameMangling.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    M_NONE: _TypenameMangling.ValueType  # 0
+    """Default, no typename mangling"""
+    M_STRIP_PACKAGE: _TypenameMangling.ValueType  # 1
+    """Strip current package name"""
+    M_FLATTEN: _TypenameMangling.ValueType  # 2
+    """Only use last path component"""
+    M_PACKAGE_INITIALS: _TypenameMangling.ValueType  # 3
+    """Replace the package name by the initials"""
+
+class TypenameMangling(_TypenameMangling, metaclass=_TypenameManglingEnumTypeWrapper): ...
+
+M_NONE: TypenameMangling.ValueType  # 0
+"""Default, no typename mangling"""
+M_STRIP_PACKAGE: TypenameMangling.ValueType  # 1
+"""Strip current package name"""
+M_FLATTEN: TypenameMangling.ValueType  # 2
+"""Only use last path component"""
+M_PACKAGE_INITIALS: TypenameMangling.ValueType  # 3
+"""Replace the package name by the initials"""
+global___TypenameMangling = TypenameMangling
+
+class _DescriptorSize:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _DescriptorSizeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_DescriptorSize.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    DS_AUTO: _DescriptorSize.ValueType  # 0
+    """Select minimal size based on field type"""
+    DS_1: _DescriptorSize.ValueType  # 1
+    """1 word; up to 15 byte fields, no arrays"""
+    DS_2: _DescriptorSize.ValueType  # 2
+    """2 words; up to 4095 byte fields, 4095 entry arrays"""
+    DS_4: _DescriptorSize.ValueType  # 4
+    """4 words; up to 2^32-1 byte fields, 2^16-1 entry arrays"""
+    DS_8: _DescriptorSize.ValueType  # 8
+    """8 words; up to 2^32-1 entry arrays"""
+
+class DescriptorSize(_DescriptorSize, metaclass=_DescriptorSizeEnumTypeWrapper): ...
+
+DS_AUTO: DescriptorSize.ValueType  # 0
+"""Select minimal size based on field type"""
+DS_1: DescriptorSize.ValueType  # 1
+"""1 word; up to 15 byte fields, no arrays"""
+DS_2: DescriptorSize.ValueType  # 2
+"""2 words; up to 4095 byte fields, 4095 entry arrays"""
+DS_4: DescriptorSize.ValueType  # 4
+"""4 words; up to 2^32-1 byte fields, 2^16-1 entry arrays"""
+DS_8: DescriptorSize.ValueType  # 8
+"""8 words; up to 2^32-1 entry arrays"""
+global___DescriptorSize = DescriptorSize
+
+@typing_extensions.final
+class NanoPBOptions(google.protobuf.message.Message):
+    """This is the inner options message, which basically defines options for
+    a field. When it is used in message or file scope, it applies to all
+    fields.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MAX_SIZE_FIELD_NUMBER: builtins.int
+    MAX_LENGTH_FIELD_NUMBER: builtins.int
+    MAX_COUNT_FIELD_NUMBER: builtins.int
+    INT_SIZE_FIELD_NUMBER: builtins.int
+    TYPE_FIELD_NUMBER: builtins.int
+    LONG_NAMES_FIELD_NUMBER: builtins.int
+    PACKED_STRUCT_FIELD_NUMBER: builtins.int
+    PACKED_ENUM_FIELD_NUMBER: builtins.int
+    SKIP_MESSAGE_FIELD_NUMBER: builtins.int
+    NO_UNIONS_FIELD_NUMBER: builtins.int
+    MSGID_FIELD_NUMBER: builtins.int
+    ANONYMOUS_ONEOF_FIELD_NUMBER: builtins.int
+    PROTO3_FIELD_NUMBER: builtins.int
+    PROTO3_SINGULAR_MSGS_FIELD_NUMBER: builtins.int
+    ENUM_TO_STRING_FIELD_NUMBER: builtins.int
+    FIXED_LENGTH_FIELD_NUMBER: builtins.int
+    FIXED_COUNT_FIELD_NUMBER: builtins.int
+    SUBMSG_CALLBACK_FIELD_NUMBER: builtins.int
+    MANGLE_NAMES_FIELD_NUMBER: builtins.int
+    CALLBACK_DATATYPE_FIELD_NUMBER: builtins.int
+    CALLBACK_FUNCTION_FIELD_NUMBER: builtins.int
+    DESCRIPTORSIZE_FIELD_NUMBER: builtins.int
+    DEFAULT_HAS_FIELD_NUMBER: builtins.int
+    INCLUDE_FIELD_NUMBER: builtins.int
+    EXCLUDE_FIELD_NUMBER: builtins.int
+    PACKAGE_FIELD_NUMBER: builtins.int
+    TYPE_OVERRIDE_FIELD_NUMBER: builtins.int
+    SORT_BY_TAG_FIELD_NUMBER: builtins.int
+    FALLBACK_TYPE_FIELD_NUMBER: builtins.int
+    max_size: builtins.int
+    """Allocated size for 'bytes' and 'string' fields.
+    For string fields, this should include the space for null terminator.
+    """
+    max_length: builtins.int
+    """Maximum length for 'string' fields. Setting this is equivalent
+    to setting max_size to a value of length+1.
+    """
+    max_count: builtins.int
+    """Allocated number of entries in arrays ('repeated' fields)"""
+    int_size: global___IntSize.ValueType
+    """Size of integer fields. Can save some memory if you don't need
+    full 32 bits for the value.
+    """
+    type: global___FieldType.ValueType
+    """Force type of field (callback or static allocation)"""
+    long_names: builtins.bool
+    """Use long names for enums, i.e. EnumName_EnumValue."""
+    packed_struct: builtins.bool
+    """Add 'packed' attribute to generated structs.
+    Note: this cannot be used on CPUs that break on unaligned
+    accesses to variables.
+    """
+    packed_enum: builtins.bool
+    """Add 'packed' attribute to generated enums."""
+    skip_message: builtins.bool
+    """Skip this message"""
+    no_unions: builtins.bool
+    """Generate oneof fields as normal optional fields instead of union."""
+    msgid: builtins.int
+    """integer type tag for a message"""
+    anonymous_oneof: builtins.bool
+    """decode oneof as anonymous union"""
+    proto3: builtins.bool
+    """Proto3 singular field does not generate a "has_" flag"""
+    proto3_singular_msgs: builtins.bool
+    """Force proto3 messages to have no "has_" flag.
+    This was default behavior until nanopb-0.4.0.
+    """
+    enum_to_string: builtins.bool
+    """Generate an enum->string mapping function (can take up lots of space)."""
+    fixed_length: builtins.bool
+    """Generate bytes arrays with fixed length"""
+    fixed_count: builtins.bool
+    """Generate repeated field with fixed count"""
+    submsg_callback: builtins.bool
+    """Generate message-level callback that is called before decoding submessages.
+    This can be used to set callback fields for submsgs inside oneofs.
+    """
+    mangle_names: global___TypenameMangling.ValueType
+    """Shorten or remove package names from type names.
+    This option applies only on the file level.
+    """
+    callback_datatype: builtins.str
+    """Data type for storage associated with callback fields."""
+    callback_function: builtins.str
+    """Callback function used for encoding and decoding.
+    Prior to nanopb-0.4.0, the callback was specified in per-field pb_callback_t
+    structure. This is still supported, but does not work inside e.g. oneof or pointer
+    fields. Instead, a new method allows specifying a per-message callback that
+    will be called for all callback fields in a message type.
+    """
+    descriptorsize: global___DescriptorSize.ValueType
+    """Select the size of field descriptors. This option has to be defined
+    for the whole message, not per-field. Usually automatic selection is
+    ok, but if it results in compilation errors you can increase the field
+    size here.
+    """
+    default_has: builtins.bool
+    """Set default value for has_ fields."""
+    @property
+    def include(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Extra files to include in generated `.pb.h`"""
+    @property
+    def exclude(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Automatic includes to exclude from generated `.pb.h`
+        Same as nanopb_generator.py command line flag -x.
+        """
+    package: builtins.str
+    """Package name that applies only for nanopb."""
+    type_override: google.protobuf.descriptor_pb2.FieldDescriptorProto.Type.ValueType
+    """Override type of the field in generated C code. Only to be used with related field types"""
+    sort_by_tag: builtins.bool
+    """Due to historical reasons, nanopb orders fields in structs by their tag number
+    instead of the order in .proto. Set this to false to keep the .proto order.
+    The default value will probably change to false in nanopb-0.5.0.
+    """
+    fallback_type: global___FieldType.ValueType
+    """Set the FT_DEFAULT field conversion strategy.
+    A field that can become a static member of a c struct (e.g. int, bool, etc)
+    will be a a static field.
+    Fields with dynamic length are converted to either a pointer or a callback.
+    """
+    def __init__(
+        self,
+        *,
+        max_size: builtins.int | None = ...,
+        max_length: builtins.int | None = ...,
+        max_count: builtins.int | None = ...,
+        int_size: global___IntSize.ValueType | None = ...,
+        type: global___FieldType.ValueType | None = ...,
+        long_names: builtins.bool | None = ...,
+        packed_struct: builtins.bool | None = ...,
+        packed_enum: builtins.bool | None = ...,
+        skip_message: builtins.bool | None = ...,
+        no_unions: builtins.bool | None = ...,
+        msgid: builtins.int | None = ...,
+        anonymous_oneof: builtins.bool | None = ...,
+        proto3: builtins.bool | None = ...,
+        proto3_singular_msgs: builtins.bool | None = ...,
+        enum_to_string: builtins.bool | None = ...,
+        fixed_length: builtins.bool | None = ...,
+        fixed_count: builtins.bool | None = ...,
+        submsg_callback: builtins.bool | None = ...,
+        mangle_names: global___TypenameMangling.ValueType | None = ...,
+        callback_datatype: builtins.str | None = ...,
+        callback_function: builtins.str | None = ...,
+        descriptorsize: global___DescriptorSize.ValueType | None = ...,
+        default_has: builtins.bool | None = ...,
+        include: collections.abc.Iterable[builtins.str] | None = ...,
+        exclude: collections.abc.Iterable[builtins.str] | None = ...,
+        package: builtins.str | None = ...,
+        type_override: google.protobuf.descriptor_pb2.FieldDescriptorProto.Type.ValueType | None = ...,
+        sort_by_tag: builtins.bool | None = ...,
+        fallback_type: global___FieldType.ValueType | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["anonymous_oneof", b"anonymous_oneof", "callback_datatype", b"callback_datatype", "callback_function", b"callback_function", "default_has", b"default_has", "descriptorsize", b"descriptorsize", "enum_to_string", b"enum_to_string", "fallback_type", b"fallback_type", "fixed_count", b"fixed_count", "fixed_length", b"fixed_length", "int_size", b"int_size", "long_names", b"long_names", "mangle_names", b"mangle_names", "max_count", b"max_count", "max_length", b"max_length", "max_size", b"max_size", "msgid", b"msgid", "no_unions", b"no_unions", "package", b"package", "packed_enum", b"packed_enum", "packed_struct", b"packed_struct", "proto3", b"proto3", "proto3_singular_msgs", b"proto3_singular_msgs", "skip_message", b"skip_message", "sort_by_tag", b"sort_by_tag", "submsg_callback", b"submsg_callback", "type", b"type", "type_override", b"type_override"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["anonymous_oneof", b"anonymous_oneof", "callback_datatype", b"callback_datatype", "callback_function", b"callback_function", "default_has", b"default_has", "descriptorsize", b"descriptorsize", "enum_to_string", b"enum_to_string", "exclude", b"exclude", "fallback_type", b"fallback_type", "fixed_count", b"fixed_count", "fixed_length", b"fixed_length", "include", b"include", "int_size", b"int_size", "long_names", b"long_names", "mangle_names", b"mangle_names", "max_count", b"max_count", "max_length", b"max_length", "max_size", b"max_size", "msgid", b"msgid", "no_unions", b"no_unions", "package", b"package", "packed_enum", b"packed_enum", "packed_struct", b"packed_struct", "proto3", b"proto3", "proto3_singular_msgs", b"proto3_singular_msgs", "skip_message", b"skip_message", "sort_by_tag", b"sort_by_tag", "submsg_callback", b"submsg_callback", "type", b"type", "type_override", b"type_override"]) -> None: ...
+
+global___NanoPBOptions = NanoPBOptions
+
+NANOPB_FILEOPT_FIELD_NUMBER: builtins.int
+NANOPB_MSGOPT_FIELD_NUMBER: builtins.int
+NANOPB_ENUMOPT_FIELD_NUMBER: builtins.int
+NANOPB_FIELD_NUMBER: builtins.int
+nanopb_fileopt: google.protobuf.internal.extension_dict._ExtensionFieldDescriptor[google.protobuf.descriptor_pb2.FileOptions, global___NanoPBOptions]
+nanopb_msgopt: google.protobuf.internal.extension_dict._ExtensionFieldDescriptor[google.protobuf.descriptor_pb2.MessageOptions, global___NanoPBOptions]
+nanopb_enumopt: google.protobuf.internal.extension_dict._ExtensionFieldDescriptor[google.protobuf.descriptor_pb2.EnumOptions, global___NanoPBOptions]
+nanopb: google.protobuf.internal.extension_dict._ExtensionFieldDescriptor[google.protobuf.descriptor_pb2.FieldOptions, global___NanoPBOptions]

meshtastic/node.py

@@ -1,40 +1,59 @@
 """Node class
 """
 
-import logging
 import base64
-from google.protobuf.json_format import MessageToJson
-from meshtastic import portnums_pb2, apponly_pb2, admin_pb2, channel_pb2
-from meshtastic.util import pskToString, stripnl, Timeout, our_exit, fromPSK
+import logging
+import time
+
+from typing import Union
+
+from meshtastic import admin_pb2, apponly_pb2, channel_pb2, localonly_pb2, portnums_pb2
+from meshtastic.util import (
+    Timeout,
+    camel_to_snake,
+    fromPSK,
+    our_exit,
+    pskToString,
+    stripnl,
+    message_to_json,
+)
 
 
 class Node:
     """A model of a (local or remote) node in the mesh
 
-    Includes methods for radioConfig and channels
+    Includes methods for localConfig, moduleConfig and channels
     """
 
     def __init__(self, iface, nodeNum, noProto=False):
         """Constructor"""
         self.iface = iface
         self.nodeNum = nodeNum
-        self.radioConfig = None
+        self.localConfig = localonly_pb2.LocalConfig()
+        self.moduleConfig = localonly_pb2.LocalModuleConfig()
         self.channels = None
         self._timeout = Timeout(maxSecs=300)
         self.partialChannels = None
         self.noProto = noProto
+        self.cannedPluginMessage = None
+        self.cannedPluginMessageMessages = None
+        self.ringtone = None
+        self.ringtonePart = None
+
+        self.gotResponse = None
 
     def showChannels(self):
         """Show human readable description of our channels."""
         print("Channels:")
         if self.channels:
-            logging.debug(f'self.channels:{self.channels}')
+            logging.debug(f"self.channels:{self.channels}")
             for c in self.channels:
-                #print('c.settings.psk:', c.settings.psk)
-                cStr = stripnl(MessageToJson(c.settings))
-                # only show if there is no psk (meaning disabled channel)
-                if c.settings.psk:
-                    print(f"  {channel_pb2.Channel.Role.Name(c.role)} psk={pskToString(c.settings.psk)} {cStr}")
+                cStr = message_to_json(c.settings)
+                # don't show disabled channels
+                if channel_pb2.Channel.Role.Name(c.role) != "DISABLED":
+                    print(
+                        f"  Index {c.index}: {channel_pb2.Channel.Role.Name(c.role)} psk={pskToString(c.settings.psk)} {cStr}"
+                    )
         publicURL = self.getURL(includeAll=False)
         adminURL = self.getURL(includeAll=True)
         print(f"\nPrimary channel URL: {publicURL}")
@@ -44,19 +63,81 @@ class Node:
     def showInfo(self):
         """Show human readable description of our node"""
         prefs = ""
-        if self.radioConfig and self.radioConfig.preferences:
-            prefs = stripnl(MessageToJson(self.radioConfig.preferences))
+        if self.localConfig:
+            prefs = message_to_json(self.localConfig, multiline=True)
         print(f"Preferences: {prefs}\n")
+        prefs = ""
+        if self.moduleConfig:
+            prefs = message_to_json(self.moduleConfig, multiline=True)
+        print(f"Module preferences: {prefs}\n")
         self.showChannels()
 
-    def requestConfig(self):
-        """Send regular MeshPackets to ask for settings and channels."""
-        logging.debug(f"requestConfig for nodeNum:{self.nodeNum}")
-        self.radioConfig = None
+    def setChannels(self, channels):
+        """Set the channels for this node"""
+        self.channels = channels
+        self._fixupChannels()
+
+    def requestChannels(self):
+        """Send regular MeshPackets to ask channels."""
+        logging.debug(f"requestChannels for nodeNum:{self.nodeNum}")
         self.channels = None
         self.partialChannels = []  # We keep our channels in a temp array until finished
 
-        self._requestSettings()
+        self._requestChannel(0)
+
+    def onResponseRequestSettings(self, p):
+        """Handle the response packets for requesting settings _requestSettings()"""
+        logging.debug(f"onResponseRequestSetting() p:{p}")
+        if "routing" in p["decoded"]:
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
+                self.iface._acknowledgment.receivedNak = True
+        else:
+            self.iface._acknowledgment.receivedAck = True
+            print("")
+            adminMessage = p["decoded"]["admin"]
+            if "getConfigResponse" in adminMessage:
+                resp = adminMessage["getConfigResponse"]
+                field = list(resp.keys())[0]
+                config_type = self.localConfig.DESCRIPTOR.fields_by_name.get(
+                    camel_to_snake(field)
+                )
+                config_values = getattr(self.localConfig, config_type.name)
+            elif "getModuleConfigResponse" in adminMessage:
+                resp = adminMessage["getModuleConfigResponse"]
+                field = list(resp.keys())[0]
+                config_type = self.moduleConfig.DESCRIPTOR.fields_by_name.get(
+                    camel_to_snake(field)
+                )
+                config_values = getattr(self.moduleConfig, config_type.name)
+            else:
+                print(
+                    "Did not receive a valid response. Make sure to have a shared channel named 'admin'."
+                )
+                return
+            for key, value in resp[field].items():
+                setattr(config_values, camel_to_snake(key), value)
+            print(f"{str(camel_to_snake(field))}:\n{str(config_values)}")
+
+    def requestConfig(self, configType):
+        """Request the config from the node via admin message"""
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onResponseRequestSettings
+            print("Requesting current config from remote node (this can take a while).")
+
+        msgIndex = configType.index
+        if configType.containing_type.full_name in ("meshtastic.LocalConfig", "LocalConfig"):
+            p = admin_pb2.AdminMessage()
+            p.get_config_request = msgIndex
+            self._sendAdmin(p, wantResponse=True, onResponse=onResponse)
+        else:
+            p = admin_pb2.AdminMessage()
+            p.get_module_config_request = msgIndex
+            self._sendAdmin(p, wantResponse=True, onResponse=onResponse)
+        if onResponse:
+            self.iface.waitForAckNak()
 
     def turnOffEncryptionOnPrimaryChannel(self):
         """Turn off encryption on primary channel."""
@@ -64,34 +145,85 @@ class Node:
         print("Writing modified channels to device")
         self.writeChannel(0)
 
-    def waitForConfig(self):
+    def waitForConfig(self, attribute="channels"):
         """Block until radio config is received. Returns True if config has been received."""
-        return self._timeout.waitForSet(self, attrs=('radioConfig', 'channels'))
+        return self._timeout.waitForSet(self, attrs=("localConfig", attribute))
 
-    def writeConfig(self):
-        """Write the current (edited) radioConfig to the device"""
-        if self.radioConfig is None:
-            our_exit("Error: No RadioConfig has been read")
+    def writeConfig(self, config_name):
+        """Write the current (edited) localConfig to the device"""
+        if self.localConfig is None:
+            our_exit("Error: No localConfig has been read")
 
         p = admin_pb2.AdminMessage()
-        p.set_radio.CopyFrom(self.radioConfig)
 
-        self._sendAdmin(p)
-        logging.debug("Wrote config")
+        if config_name == "device":
+            p.set_config.device.CopyFrom(self.localConfig.device)
+        elif config_name == "position":
+            p.set_config.position.CopyFrom(self.localConfig.position)
+        elif config_name == "power":
+            p.set_config.power.CopyFrom(self.localConfig.power)
+        elif config_name == "network":
+            p.set_config.network.CopyFrom(self.localConfig.network)
+        elif config_name == "display":
+            p.set_config.display.CopyFrom(self.localConfig.display)
+        elif config_name == "lora":
+            p.set_config.lora.CopyFrom(self.localConfig.lora)
+        elif config_name == "bluetooth":
+            p.set_config.bluetooth.CopyFrom(self.localConfig.bluetooth)
+        elif config_name == "mqtt":
+            p.set_module_config.mqtt.CopyFrom(self.moduleConfig.mqtt)
+        elif config_name == "serial":
+            p.set_module_config.serial.CopyFrom(self.moduleConfig.serial)
+        elif config_name == "external_notification":
+            p.set_module_config.external_notification.CopyFrom(
+                self.moduleConfig.external_notification
+            )
+        elif config_name == "store_forward":
+            p.set_module_config.store_forward.CopyFrom(self.moduleConfig.store_forward)
+        elif config_name == "range_test":
+            p.set_module_config.range_test.CopyFrom(self.moduleConfig.range_test)
+        elif config_name == "telemetry":
+            p.set_module_config.telemetry.CopyFrom(self.moduleConfig.telemetry)
+        elif config_name == "canned_message":
+            p.set_module_config.canned_message.CopyFrom(
+                self.moduleConfig.canned_message
+            )
+        elif config_name == "audio":
+            p.set_module_config.audio.CopyFrom(self.moduleConfig.audio)
+        elif config_name == "remote_hardware":
+            p.set_module_config.remote_hardware.CopyFrom(
+                self.moduleConfig.remote_hardware
+            )
+        elif config_name == "neighbor_info":
+            p.set_module_config.neighbor_info.CopyFrom(self.moduleConfig.neighbor_info)
+        elif config_name == "detection_sensor":
+            p.set_module_config.detection_sensor.CopyFrom(self.moduleConfig.detection_sensor)
+        elif config_name == "ambient_lighting":
+            p.set_module_config.ambient_lighting.CopyFrom(self.moduleConfig.ambient_lighting)
+        elif config_name == "paxcounter":
+            p.set_module_config.paxcounter.CopyFrom(self.moduleConfig.paxcounter)
+        else:
+            our_exit(f"Error: No valid config with name {config_name}")
+
+        logging.debug(f"Wrote: {config_name}")
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        self._sendAdmin(p, onResponse=onResponse)
 
     def writeChannel(self, channelIndex, adminIndex=0):
         """Write the current (edited) channel to the device"""
 
         p = admin_pb2.AdminMessage()
         p.set_channel.CopyFrom(self.channels[channelIndex])
-
         self._sendAdmin(p, adminIndex=adminIndex)
         logging.debug(f"Wrote channel {channelIndex}")
 
     def getChannelByChannelIndex(self, channelIndex):
         """Get channel by channelIndex
-            channelIndex: number, typically 0-7; based on max number channels
-            returns: None if there is no channel found
+        channelIndex: number, typically 0-7; based on max number channels
+        returns: None if there is no channel found
         """
         ch = None
         if self.channels and 0 <= channelIndex < len(self.channels):
@@ -99,9 +231,12 @@ class Node:
         return ch
 
     def deleteChannel(self, channelIndex):
-        """Delete the specifed channelIndex and shift other channels up"""
+        """Delete the specified channelIndex and shift other channels up"""
         ch = self.channels[channelIndex]
-        if ch.role not in (channel_pb2.Channel.Role.SECONDARY, channel_pb2.Channel.Role.DISABLED):
+        if ch.role not in (
+            channel_pb2.Channel.Role.SECONDARY,
+            channel_pb2.Channel.Role.DISABLED,
+        ):
             our_exit("Warning: Only SECONDARY channels can be deleted")
 
         # we are careful here because if we move the "admin" channel the channelIndex we need to use
@@ -112,7 +247,7 @@ class Node:
         self._fixupChannels()  # expand back to 8 channels
 
         index = channelIndex
-        while index < self.iface.myInfo.max_channels:
+        while index < 8:
             self.writeChannel(index, adminIndex=adminIndex)
             index += 1
 
@@ -125,7 +260,7 @@ class Node:
 
     def getChannelByName(self, name):
         """Try to find the named channel or return None"""
-        for c in (self.channels or []):
+        for c in self.channels or []:
             if c.settings and c.settings.name == name:
                 return c
         return None
@@ -139,50 +274,38 @@ class Node:
 
     def _getAdminChannelIndex(self):
         """Return the channel number of the admin channel, or 0 if no reserved channel"""
-        c = self.getChannelByName("admin")
-        if c:
-            return c.index
-        else:
-            return 0
+        for c in self.channels or []:
+            if c.settings and c.settings.name.lower() == "admin":
+                return c.index
+        return 0
 
-    def setOwner(self, long_name=None, short_name=None, is_licensed=False, team=None):
+    def setOwner(self, long_name=None, short_name=None, is_licensed=False):
         """Set device owner name"""
         logging.debug(f"in setOwner nodeNum:{self.nodeNum}")
-        nChars = 3
-        minChars = 2
-        if long_name is not None:
-            long_name = long_name.strip()
-            if short_name is None:
-                words = long_name.split()
-                if len(long_name) <= nChars:
-                    short_name = long_name
-                elif len(words) >= minChars:
-                    short_name = ''.join(map(lambda word: word[0], words))
-                else:
-                    trans = str.maketrans(dict.fromkeys('aeiouAEIOU'))
-                    short_name = long_name[0] + long_name[1:].translate(trans)
-                    if len(short_name) < nChars:
-                        short_name = long_name[:nChars]
-
         p = admin_pb2.AdminMessage()
 
+        nChars = 4
         if long_name is not None:
+            long_name = long_name.strip()
             p.set_owner.long_name = long_name
+            p.set_owner.is_licensed = is_licensed
         if short_name is not None:
             short_name = short_name.strip()
             if len(short_name) > nChars:
                 short_name = short_name[:nChars]
+                print(f"Maximum is 4 characters, truncated to {short_name}")
             p.set_owner.short_name = short_name
-            p.set_owner.is_licensed = is_licensed
-        if team is not None:
-            p.set_owner.team = team
 
         # Note: These debug lines are used in unit tests
-        logging.debug(f'p.set_owner.long_name:{p.set_owner.long_name}:')
-        logging.debug(f'p.set_owner.short_name:{p.set_owner.short_name}:')
-        logging.debug(f'p.set_owner.is_licensed:{p.set_owner.is_licensed}')
-        logging.debug(f'p.set_owner.team:{p.set_owner.team}')
-        return self._sendAdmin(p)
+        logging.debug(f"p.set_owner.long_name:{p.set_owner.long_name}:")
+        logging.debug(f"p.set_owner.short_name:{p.set_owner.short_name}:")
+        logging.debug(f"p.set_owner.is_licensed:{p.set_owner.is_licensed}")
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
 
     def getURL(self, includeAll: bool = True):
         """The sharable URL that describes the current channel"""
@@ -190,18 +313,25 @@ class Node:
         channelSet = apponly_pb2.ChannelSet()
         if self.channels:
             for c in self.channels:
-                if c.role == channel_pb2.Channel.Role.PRIMARY or (includeAll and c.role == channel_pb2.Channel.Role.SECONDARY):
+                if c.role == channel_pb2.Channel.Role.PRIMARY or (
+                    includeAll and c.role == channel_pb2.Channel.Role.SECONDARY
+                ):
                     channelSet.settings.append(c.settings)
+
+        if len(self.localConfig.ListFields()) == 0:
+            self.requestConfig(self.localConfig.DESCRIPTOR.fields_by_name.get('lora'))
+        channelSet.lora_config.CopyFrom(self.localConfig.lora)
         some_bytes = channelSet.SerializeToString()
-        s = base64.urlsafe_b64encode(some_bytes).decode('ascii')
-        return f"https://www.meshtastic.org/d/#{s}".replace("=", "")
+        s = base64.urlsafe_b64encode(some_bytes).decode("ascii")
+        s = s.replace("=", "").replace("+", "-").replace("/", "_")
+        return f"https://meshtastic.org/e/#{s}"
 
     def setURL(self, url):
         """Set mesh network URL"""
-        if self.radioConfig is None:
-            our_exit("Warning: No RadioConfig has been read")
+        if self.localConfig is None:
+            our_exit("Warning: No Config has been read")
 
-        # URLs are of the form https://www.meshtastic.org/d/#{base64_channel_set}
+        # URLs are of the form https://meshtastic.org/d/#{base64_channel_set}
         # Split on '/#' to find the base64 encoded channel settings
         splitURL = url.split("/#")
         b64 = splitURL[-1]
@@ -211,69 +341,186 @@ class Node:
         # per https://stackoverflow.com/a/9807138
         missing_padding = len(b64) % 4
         if missing_padding:
-            b64 += '=' * (4 - missing_padding)
+            b64 += "=" * (4 - missing_padding)
 
         decodedURL = base64.urlsafe_b64decode(b64)
         channelSet = apponly_pb2.ChannelSet()
         channelSet.ParseFromString(decodedURL)
 
-
         if len(channelSet.settings) == 0:
             our_exit("Warning: There were no settings.")
 
         i = 0
         for chs in channelSet.settings:
             ch = channel_pb2.Channel()
-            ch.role = channel_pb2.Channel.Role.PRIMARY if i == 0 else channel_pb2.Channel.Role.SECONDARY
+            ch.role = (
+                channel_pb2.Channel.Role.PRIMARY
+                if i == 0
+                else channel_pb2.Channel.Role.SECONDARY
+            )
             ch.index = i
             ch.settings.CopyFrom(chs)
             self.channels[ch.index] = ch
-            logging.debug(f'Channel i:{i} ch:{ch}')
+            logging.debug(f"Channel i:{i} ch:{ch}")
             self.writeChannel(ch.index)
             i = i + 1
 
+        p = admin_pb2.AdminMessage()
+        p.set_config.lora.CopyFrom(channelSet.lora_config)
+        self._sendAdmin(p)
 
-    def onResponseRequestSettings(self, p):
-        """Handle the response packet for requesting settings _requestSettings()"""
-        logging.debug(f'onResponseRequestSetting() p:{p}')
+    def onResponseRequestRingtone(self, p):
+        """Handle the response packet for requesting ringtone part 1"""
+        logging.debug(f"onResponseRequestRingtone() p:{p}")
         errorFound = False
-        if 'routing' in p["decoded"]:
+        if "routing" in p["decoded"]:
             if p["decoded"]["routing"]["errorReason"] != "NONE":
                 errorFound = True
                 print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
         if errorFound is False:
-            self.radioConfig = p["decoded"]["admin"]["raw"].get_radio_response
-            logging.debug(f'self.radioConfig:{self.radioConfig}')
-            logging.debug("Received radio config, now fetching channels...")
-            self._timeout.reset()  # We made foreward progress
-            self._requestChannel(0)  # now start fetching channels
+            if "decoded" in p:
+                if "admin" in p["decoded"]:
+                    if "raw" in p["decoded"]["admin"]:
+                        self.ringtonePart = p["decoded"]["admin"][
+                            "raw"
+                        ].get_ringtone_response
+                        logging.debug(f"self.ringtonePart:{self.ringtonePart}")
+                        self.gotResponse = True
 
+    def get_ringtone(self):
+        """Get the ringtone. Concatenate all pieces together and return a single string."""
+        logging.debug(f"in get_ringtone()")
+        if not self.ringtone:
+            p1 = admin_pb2.AdminMessage()
+            p1.get_ringtone_request = True
+            self.gotResponse = False
+            self._sendAdmin(
+                p1, wantResponse=True, onResponse=self.onResponseRequestRingtone
+            )
+            while self.gotResponse is False:
+                time.sleep(0.1)
 
-    def _requestSettings(self):
-        """Done with initial config messages, now send regular
-           MeshPackets to ask for settings."""
-        p = admin_pb2.AdminMessage()
-        p.get_radio_request = True
+            logging.debug(f"self.ringtone:{self.ringtone}")
 
-        # TODO: should we check that localNode has an 'admin' channel?
-        # Show progress message for super slow operations
-        if self != self.iface.localNode:
-            print("Requesting preferences from remote node.")
-            print("Be sure:")
-            print(" 1. There is a SECONDARY channel named 'admin'.")
-            print(" 2. The '--seturl' was used to configure.")
-            print(" 3. All devices have the same modem config. (i.e., '--ch-longfast')")
-            print(" 4. All devices have been rebooted after all of the above. (optional, but recommended)")
-            print("Note: This could take a while (it requests remote channel configs, then writes config)")
+            self.ringtone = ""
+            if self.ringtonePart:
+                self.ringtone += self.ringtonePart
 
-        return self._sendAdmin(p, wantResponse=True, onResponse=self.onResponseRequestSettings)
+        print(f"ringtone:{self.ringtone}")
+        logging.debug(f"ringtone:{self.ringtone}")
+        return self.ringtone
+
+    def set_ringtone(self, ringtone):
+        """Set the ringtone. The ringtone length must be less than 230 character."""
+
+        if len(ringtone) > 230:
+            our_exit("Warning: The ringtone must be less than 230 characters.")
+
+        # split into chunks
+        chunks = []
+        chunks_size = 230
+        for i in range(0, len(ringtone), chunks_size):
+            chunks.append(ringtone[i : i + chunks_size])
+
+        # for each chunk, send a message to set the values
+        # for i in range(0, len(chunks)):
+        for i, chunk in enumerate(chunks):
+            p = admin_pb2.AdminMessage()
+
+            # TODO: should be a way to improve this
+            if i == 0:
+                p.set_ringtone_message = chunk
+
+            logging.debug(f"Setting ringtone '{chunk}' part {i+1}")
+            # If sending to a remote node, wait for ACK/NAK
+            if self == self.iface.localNode:
+                onResponse = None
+            else:
+                onResponse = self.onAckNak
+            return self._sendAdmin(p, onResponse=onResponse)
+
+    def onResponseRequestCannedMessagePluginMessageMessages(self, p):
+        """Handle the response packet for requesting canned message plugin message part 1"""
+        logging.debug(f"onResponseRequestCannedMessagePluginMessageMessages() p:{p}")
+        errorFound = False
+        if "routing" in p["decoded"]:
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                errorFound = True
+                print(f'Error on response: {p["decoded"]["routing"]["errorReason"]}')
+        if errorFound is False:
+            if "decoded" in p:
+                if "admin" in p["decoded"]:
+                    if "raw" in p["decoded"]["admin"]:
+                        self.cannedPluginMessageMessages = p["decoded"]["admin"][
+                            "raw"
+                        ].get_canned_message_module_messages_response
+                        logging.debug(
+                            f"self.cannedPluginMessageMessages:{self.cannedPluginMessageMessages}"
+                        )
+                        self.gotResponse = True
+
+    def get_canned_message(self):
+        """Get the canned message string. Concatenate all pieces together and return a single string."""
+        logging.debug(f"in get_canned_message()")
+        if not self.cannedPluginMessage:
+            p1 = admin_pb2.AdminMessage()
+            p1.get_canned_message_module_messages_request = True
+            self.gotResponse = False
+            self._sendAdmin(
+                p1,
+                wantResponse=True,
+                onResponse=self.onResponseRequestCannedMessagePluginMessageMessages,
+            )
+            while self.gotResponse is False:
+                time.sleep(0.1)
+
+            logging.debug(
+                f"self.cannedPluginMessageMessages:{self.cannedPluginMessageMessages}"
+            )
+
+            self.cannedPluginMessage = ""
+            if self.cannedPluginMessageMessages:
+                self.cannedPluginMessage += self.cannedPluginMessageMessages
+
+        print(f"canned_plugin_message:{self.cannedPluginMessage}")
+        logging.debug(f"canned_plugin_message:{self.cannedPluginMessage}")
+        return self.cannedPluginMessage
+
+    def set_canned_message(self, message):
+        """Set the canned message. The canned messages length must be less than 200 character."""
+
+        if len(message) > 200:
+            our_exit("Warning: The canned message must be less than 200 characters.")
+
+        # split into chunks
+        chunks = []
+        chunks_size = 200
+        for i in range(0, len(message), chunks_size):
+            chunks.append(message[i : i + chunks_size])
+
+        # for each chunk, send a message to set the values
+        # for i in range(0, len(chunks)):
+        for i, chunk in enumerate(chunks):
+            p = admin_pb2.AdminMessage()
+
+            # TODO: should be a way to improve this
+            if i == 0:
+                p.set_canned_message_module_messages = chunk
+
+            logging.debug(f"Setting canned message '{chunk}' part {i+1}")
+            # If sending to a remote node, wait for ACK/NAK
+            if self == self.iface.localNode:
+                onResponse = None
+            else:
+                onResponse = self.onAckNak
+            return self._sendAdmin(p, onResponse=onResponse)
 
     def exitSimulator(self):
         """Tell a simulator node to exit (this message
-           is ignored for other nodes)"""
+        is ignored for other nodes)"""
         p = admin_pb2.AdminMessage()
         p.exit_simulator = True
-        logging.debug('in exitSimulator()')
+        logging.debug("in exitSimulator()")
 
         return self._sendAdmin(p)
 
@@ -283,7 +530,64 @@ class Node:
         p.reboot_seconds = secs
         logging.info(f"Telling node to reboot in {secs} seconds")
 
-        return self._sendAdmin(p)
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
+    def beginSettingsTransaction(self):
+        """Tell the node to open a transaction to edit settings."""
+        p = admin_pb2.AdminMessage()
+        p.begin_edit_settings = True
+        logging.info(f"Telling open a transaction to edit settings")
+
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
+    def commitSettingsTransaction(self):
+        """Tell the node to commit the open transaction for editing settings."""
+        p = admin_pb2.AdminMessage()
+        p.commit_edit_settings = True
+        logging.info(f"Telling node to commit open transaction for editing settings")
+
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
+    def rebootOTA(self, secs: int = 10):
+        """Tell the node to reboot into factory firmware."""
+        p = admin_pb2.AdminMessage()
+        p.reboot_ota_seconds = secs
+        logging.info(f"Telling node to reboot to OTA in {secs} seconds")
+
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
+    def enterDFUMode(self):
+        """Tell the node to enter DFU mode (NRF52)."""
+        p = admin_pb2.AdminMessage()
+        p.enter_dfu_mode_request = True
+        logging.info(f"Telling node to enable DFU mode")
+
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
 
     def shutdown(self, secs: int = 10):
         """Tell the node to shutdown."""
@@ -291,13 +595,71 @@ class Node:
         p.shutdown_seconds = secs
         logging.info(f"Telling node to shutdown in {secs} seconds")
 
-        return self._sendAdmin(p)
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
+    def getMetadata(self):
+        """Get the node's metadata."""
+        p = admin_pb2.AdminMessage()
+        p.get_device_metadata_request = True
+        logging.info(f"Requesting device metadata")
+
+        return self._sendAdmin(
+            p, wantResponse=True, onResponse=self.onRequestGetMetadata
+        )
+
+    def factoryReset(self):
+        """Tell the node to factory reset."""
+        p = admin_pb2.AdminMessage()
+        p.factory_reset = True
+        logging.info(f"Telling node to factory reset")
+
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
+    def removeNode(self, nodeId: Union[int, str]):
+        """Tell the node to remove a specific node by ID"""
+        if isinstance(nodeId, str):
+            if nodeId.startswith("!"):
+                nodeId = int(nodeId[1:], 16)
+            else:
+                nodeId = int(nodeId)
+
+        p = admin_pb2.AdminMessage()
+        p.remove_by_nodenum = nodeId
+
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
+    def resetNodeDb(self):
+        """Tell the node to reset its list of nodes."""
+        p = admin_pb2.AdminMessage()
+        p.nodedb_reset = True
+        logging.info(f"Telling node to reset the NodeDB")
+
+        # If sending to a remote node, wait for ACK/NAK
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
 
     def _fixupChannels(self):
         """Fixup indexes and add disabled channels as needed"""
 
         # Add extra disabled channels as needed
-        # TODO: These 2 lines seem to not do anything.
+        # This is needed because the protobufs will have index **missing** if the channel number is zero
         for index, ch in enumerate(self.channels):
             ch.index = index  # fixup indexes
 
@@ -308,72 +670,135 @@ class Node:
 
         # Add extra disabled channels as needed
         index = len(self.channels)
-        while index < self.iface.myInfo.max_channels:
+        while index < 8:
             ch = channel_pb2.Channel()
             ch.role = channel_pb2.Channel.Role.DISABLED
             ch.index = index
             self.channels.append(ch)
             index += 1
 
+    def onRequestGetMetadata(self, p):
+        """Handle the response packet for requesting device metadata getMetadata()"""
+        logging.debug(f"onRequestGetMetadata() p:{p}")
+
+        if p["decoded"]["portnum"] == portnums_pb2.PortNum.Name(
+            portnums_pb2.PortNum.ROUTING_APP
+        ):
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                logging.warning(
+                    f'Metadata request failed, error reason: {p["decoded"]["routing"]["errorReason"]}'
+                )
+                self._timeout.expireTime = time.time()  # Do not wait any longer
+                return  # Don't try to parse this routing message
+            logging.debug(f"Retrying metadata request.")
+            self.getMetadata()
+            return
+
+        c = p["decoded"]["admin"]["raw"].get_device_metadata_response
+        self._timeout.reset()  # We made forward progress
+        logging.debug(f"Received metadata {stripnl(c)}")
+        print(f"\nfirmware_version: {c.firmware_version}")
+        print(f"device_state_version: {c.device_state_version}")
 
     def onResponseRequestChannel(self, p):
         """Handle the response packet for requesting a channel _requestChannel()"""
-        logging.debug(f'onResponseRequestChannel() p:{p}')
+        logging.debug(f"onResponseRequestChannel() p:{p}")
+
+        if p["decoded"]["portnum"] == portnums_pb2.PortNum.Name(
+            portnums_pb2.PortNum.ROUTING_APP
+        ):
+            if p["decoded"]["routing"]["errorReason"] != "NONE":
+                logging.warning(
+                    f'Channel request failed, error reason: {p["decoded"]["routing"]["errorReason"]}'
+                )
+                self._timeout.expireTime = time.time()  # Do not wait any longer
+                return  # Don't try to parse this routing message
+            lastTried = 0
+            if len(self.partialChannels) > 0:
+                lastTried = self.partialChannels[-1].index
+            logging.debug(f"Retrying previous channel request.")
+            self._requestChannel(lastTried)
+            return
+
         c = p["decoded"]["admin"]["raw"].get_channel_response
         self.partialChannels.append(c)
-        self._timeout.reset()  # We made foreward progress
+        self._timeout.reset()  # We made forward progress
         logging.debug(f"Received channel {stripnl(c)}")
         index = c.index
 
-        # for stress testing, we can always download all channels
-        fastChannelDownload = True
-
-        # Once we see a response that has NO settings, assume
-        # we are at the end of channels and stop fetching
-        quitEarly = (c.role == channel_pb2.Channel.Role.DISABLED) and fastChannelDownload
-
-        if quitEarly or index >= self.iface.myInfo.max_channels - 1:
+        if index >= 8 - 1:
             logging.debug("Finished downloading channels")
 
             self.channels = self.partialChannels
             self._fixupChannels()
-
-            # FIXME, the following should only be called after we have settings and channels
-            self.iface._connected()  # Tell everyone else we are ready to go
         else:
             self._requestChannel(index + 1)
 
+    def onAckNak(self, p):
+        """Informative handler for ACK/NAK responses"""
+        if p["decoded"]["routing"]["errorReason"] != "NONE":
+            print(
+                f'Received a NAK, error reason: {p["decoded"]["routing"]["errorReason"]}'
+            )
+            self.iface._acknowledgment.receivedNak = True
+        else:
+            if int(p["from"]) == self.iface.localNode.nodeNum:
+                print(
+                    f"Received an implicit ACK. Packet will likely arrive, but cannot be guaranteed."
+                )
+                self.iface._acknowledgment.receivedImplAck = True
+            else:
+                print(f"Received an ACK.")
+                self.iface._acknowledgment.receivedAck = True
+
     def _requestChannel(self, channelNum: int):
         """Done with initial config messages, now send regular
-           MeshPackets to ask for settings"""
+        MeshPackets to ask for settings"""
         p = admin_pb2.AdminMessage()
         p.get_channel_request = channelNum + 1
 
         # Show progress message for super slow operations
         if self != self.iface.localNode:
-            print(f"Requesting channel {channelNum} info from remote node (this could take a while)")
-            logging.debug(f"Requesting channel {channelNum} info from remote node (this could take a while)")
+            print(
+                f"Requesting channel {channelNum} info from remote node (this could take a while)"
+            )
+            logging.debug(
+                f"Requesting channel {channelNum} info from remote node (this could take a while)"
+            )
         else:
             logging.debug(f"Requesting channel {channelNum}")
 
-        return self._sendAdmin(p, wantResponse=True, onResponse=self.onResponseRequestChannel)
-
+        return self._sendAdmin(
+            p, wantResponse=True, onResponse=self.onResponseRequestChannel
+        )
 
     # pylint: disable=R1710
-    def _sendAdmin(self, p: admin_pb2.AdminMessage, wantResponse=False,
-                   onResponse=None, adminIndex=0):
+    def _sendAdmin(
+        self,
+        p: admin_pb2.AdminMessage,
+        wantResponse: bool=True,
+        onResponse=None,
+        adminIndex: int=0,
+    ):
         """Send an admin message to the specified node (or the local node if destNodeNum is zero)"""
 
         if self.noProto:
-            logging.warning(f"Not sending packet because protocol use is disabled by noProto")
+            logging.warning(
+                f"Not sending packet because protocol use is disabled by noProto"
+            )
         else:
-            if adminIndex == 0:  # unless a special channel index was used, we want to use the admin index
+            if (
+                adminIndex == 0
+            ):  # unless a special channel index was used, we want to use the admin index
                 adminIndex = self.iface.localNode._getAdminChannelIndex()
-            logging.debug(f'adminIndex:{adminIndex}')
+            logging.debug(f"adminIndex:{adminIndex}")
 
-            return self.iface.sendData(p, self.nodeNum,
-                                       portNum=portnums_pb2.PortNum.ADMIN_APP,
-                                       wantAck=True,
-                                       wantResponse=wantResponse,
-                                       onResponse=onResponse,
-                                       channelIndex=adminIndex)
+            return self.iface.sendData(
+                p,
+                self.nodeNum,
+                portNum=portnums_pb2.PortNum.ADMIN_APP,
+                wantAck=False,
+                wantResponse=wantResponse,
+                onResponse=onResponse,
+                channelIndex=adminIndex,
+            )

meshtastic/paxcount_pb2.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/paxcount.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x19meshtastic/paxcount.proto\x12\nmeshtastic\"5\n\x08Paxcount\x12\x0c\n\x04wifi\x18\x01 \x01(\r\x12\x0b\n\x03\x62le\x18\x02 \x01(\r\x12\x0e\n\x06uptime\x18\x03 \x01(\rBc\n\x13\x63om.geeksville.meshB\x0ePaxcountProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.paxcount_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\016PaxcountProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _PAXCOUNT._serialized_start=41
+  _PAXCOUNT._serialized_end=94
+# @@protoc_insertion_point(module_scope)

meshtastic/paxcount_pb2.pyi

@@ -0,0 +1,49 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import sys
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class Paxcount(google.protobuf.message.Message):
+    """
+    TODO: REPLACE
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    WIFI_FIELD_NUMBER: builtins.int
+    BLE_FIELD_NUMBER: builtins.int
+    UPTIME_FIELD_NUMBER: builtins.int
+    wifi: builtins.int
+    """
+    seen Wifi devices
+    """
+    ble: builtins.int
+    """
+    Seen BLE devices
+    """
+    uptime: builtins.int
+    """
+    Uptime in seconds
+    """
+    def __init__(
+        self,
+        *,
+        wifi: builtins.int = ...,
+        ble: builtins.int = ...,
+        uptime: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["ble", b"ble", "uptime", b"uptime", "wifi", b"wifi"]) -> None: ...
+
+global___Paxcount = Paxcount

meshtastic/portnums_pb2.py

@@ -1,12 +1,10 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: portnums.proto
+# source: meshtastic/portnums.proto
 """Generated protocol buffer code."""
-from google.protobuf.internal import enum_type_wrapper
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
@@ -15,33 +13,14 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0eportnums.proto*\xcb\x02\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x17\n\x13REMOTE_HARDWARE_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x0f\n\x0bROUTING_APP\x10\x05\x12\r\n\tADMIN_APP\x10\x06\x12\r\n\tREPLY_APP\x10 \x12\x11\n\rIP_TUNNEL_APP\x10!\x12\x0e\n\nSERIAL_APP\x10@\x12\x15\n\x11STORE_FORWARD_APP\x10\x41\x12\x12\n\x0eRANGE_TEST_APP\x10\x42\x12!\n\x1d\x45NVIRONMENTAL_MEASUREMENT_APP\x10\x43\x12\x0b\n\x07ZPS_APP\x10\x44\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x13\n\x0e\x41TAK_FORWARDER\x10\x81\x02\x12\x08\n\x03MAX\x10\xff\x03\x42\x44\n\x13\x63om.geeksville.meshB\x08PortnumsH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-_PORTNUM = DESCRIPTOR.enum_types_by_name['PortNum']
-PortNum = enum_type_wrapper.EnumTypeWrapper(_PORTNUM)
-UNKNOWN_APP = 0
-TEXT_MESSAGE_APP = 1
-REMOTE_HARDWARE_APP = 2
-POSITION_APP = 3
-NODEINFO_APP = 4
-ROUTING_APP = 5
-ADMIN_APP = 6
-REPLY_APP = 32
-IP_TUNNEL_APP = 33
-SERIAL_APP = 64
-STORE_FORWARD_APP = 65
-RANGE_TEST_APP = 66
-ENVIRONMENTAL_MEASUREMENT_APP = 67
-ZPS_APP = 68
-PRIVATE_APP = 256
-ATAK_FORWARDER = 257
-MAX = 511
-
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x19meshtastic/portnums.proto\x12\nmeshtastic*\x8d\x04\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x17\n\x13REMOTE_HARDWARE_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x0f\n\x0bROUTING_APP\x10\x05\x12\r\n\tADMIN_APP\x10\x06\x12\x1f\n\x1bTEXT_MESSAGE_COMPRESSED_APP\x10\x07\x12\x10\n\x0cWAYPOINT_APP\x10\x08\x12\r\n\tAUDIO_APP\x10\t\x12\x18\n\x14\x44\x45TECTION_SENSOR_APP\x10\n\x12\r\n\tREPLY_APP\x10 \x12\x11\n\rIP_TUNNEL_APP\x10!\x12\x12\n\x0ePAXCOUNTER_APP\x10\"\x12\x0e\n\nSERIAL_APP\x10@\x12\x15\n\x11STORE_FORWARD_APP\x10\x41\x12\x12\n\x0eRANGE_TEST_APP\x10\x42\x12\x11\n\rTELEMETRY_APP\x10\x43\x12\x0b\n\x07ZPS_APP\x10\x44\x12\x11\n\rSIMULATOR_APP\x10\x45\x12\x12\n\x0eTRACEROUTE_APP\x10\x46\x12\x14\n\x10NEIGHBORINFO_APP\x10G\x12\x0f\n\x0b\x41TAK_PLUGIN\x10H\x12\x12\n\x0eMAP_REPORT_APP\x10I\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x13\n\x0e\x41TAK_FORWARDER\x10\x81\x02\x12\x08\n\x03MAX\x10\xff\x03\x42]\n\x13\x63om.geeksville.meshB\x08PortnumsZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.portnums_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\010PortnumsH\003Z!github.com/meshtastic/gomeshproto'
-  _PORTNUM._serialized_start=19
-  _PORTNUM._serialized_end=350
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\010PortnumsZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _PORTNUM._serialized_start=42
+  _PORTNUM._serialized_end=567
 # @@protoc_insertion_point(module_scope)

meshtastic/portnums_pb2.pyi

@@ -0,0 +1,369 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _PortNum:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _PortNumEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_PortNum.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    UNKNOWN_APP: _PortNum.ValueType  # 0
+    """
+    Deprecated: do not use in new code (formerly called OPAQUE)
+    A message sent from a device outside of the mesh, in a form the mesh does not understand
+    NOTE: This must be 0, because it is documented in IMeshService.aidl to be so
+    ENCODING: binary undefined
+    """
+    TEXT_MESSAGE_APP: _PortNum.ValueType  # 1
+    """
+    A simple UTF-8 text message, which even the little micros in the mesh
+    can understand and show on their screen eventually in some circumstances
+    even signal might send messages in this form (see below)
+    ENCODING: UTF-8 Plaintext (?)
+    """
+    REMOTE_HARDWARE_APP: _PortNum.ValueType  # 2
+    """
+    Reserved for built-in GPIO/example app.
+    See remote_hardware.proto/HardwareMessage for details on the message sent/received to this port number
+    ENCODING: Protobuf
+    """
+    POSITION_APP: _PortNum.ValueType  # 3
+    """
+    The built-in position messaging app.
+    Payload is a Position message.
+    ENCODING: Protobuf
+    """
+    NODEINFO_APP: _PortNum.ValueType  # 4
+    """
+    The built-in user info app.
+    Payload is a User message.
+    ENCODING: Protobuf
+    """
+    ROUTING_APP: _PortNum.ValueType  # 5
+    """
+    Protocol control packets for mesh protocol use.
+    Payload is a Routing message.
+    ENCODING: Protobuf
+    """
+    ADMIN_APP: _PortNum.ValueType  # 6
+    """
+    Admin control packets.
+    Payload is a AdminMessage message.
+    ENCODING: Protobuf
+    """
+    TEXT_MESSAGE_COMPRESSED_APP: _PortNum.ValueType  # 7
+    """
+    Compressed TEXT_MESSAGE payloads.
+    ENCODING: UTF-8 Plaintext (?) with Unishox2 Compression
+    NOTE: The Device Firmware converts a TEXT_MESSAGE_APP to TEXT_MESSAGE_COMPRESSED_APP if the compressed
+    payload is shorter. There's no need for app developers to do this themselves. Also the firmware will decompress
+    any incoming TEXT_MESSAGE_COMPRESSED_APP payload and convert to TEXT_MESSAGE_APP.
+    """
+    WAYPOINT_APP: _PortNum.ValueType  # 8
+    """
+    Waypoint payloads.
+    Payload is a Waypoint message.
+    ENCODING: Protobuf
+    """
+    AUDIO_APP: _PortNum.ValueType  # 9
+    """
+    Audio Payloads.
+    Encapsulated codec2 packets. On 2.4 GHZ Bandwidths only for now
+    ENCODING: codec2 audio frames
+    NOTE: audio frames contain a 3 byte header (0xc0 0xde 0xc2) and a one byte marker for the decompressed bitrate.
+    This marker comes from the 'moduleConfig.audio.bitrate' enum minus one.
+    """
+    DETECTION_SENSOR_APP: _PortNum.ValueType  # 10
+    """
+    Same as Text Message but originating from Detection Sensor Module.
+    NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9
+    """
+    REPLY_APP: _PortNum.ValueType  # 32
+    """
+    Provides a 'ping' service that replies to any packet it receives.
+    Also serves as a small example module.
+    ENCODING: ASCII Plaintext
+    """
+    IP_TUNNEL_APP: _PortNum.ValueType  # 33
+    """
+    Used for the python IP tunnel feature
+    ENCODING: IP Packet. Handled by the python API, firmware ignores this one and pases on.
+    """
+    PAXCOUNTER_APP: _PortNum.ValueType  # 34
+    """
+    Paxcounter lib included in the firmware
+    ENCODING: protobuf
+    """
+    SERIAL_APP: _PortNum.ValueType  # 64
+    """
+    Provides a hardware serial interface to send and receive from the Meshtastic network.
+    Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic
+    network is forwarded to the RX pin while sending a packet to TX will go out to the Mesh network.
+    Maximum packet size of 240 bytes.
+    Module is disabled by default can be turned on by setting SERIAL_MODULE_ENABLED = 1 in SerialPlugh.cpp.
+    ENCODING: binary undefined
+    """
+    STORE_FORWARD_APP: _PortNum.ValueType  # 65
+    """
+    STORE_FORWARD_APP (Work in Progress)
+    Maintained by Jm Casler (MC Hamster) : jm@casler.org
+    ENCODING: Protobuf
+    """
+    RANGE_TEST_APP: _PortNum.ValueType  # 66
+    """
+    Optional port for messages for the range test module.
+    ENCODING: ASCII Plaintext
+    NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9
+    """
+    TELEMETRY_APP: _PortNum.ValueType  # 67
+    """
+    Provides a format to send and receive telemetry data from the Meshtastic network.
+    Maintained by Charles Crossan (crossan007) : crossan007@gmail.com
+    ENCODING: Protobuf
+    """
+    ZPS_APP: _PortNum.ValueType  # 68
+    """
+    Experimental tools for estimating node position without a GPS
+    Maintained by Github user a-f-G-U-C (a Meshtastic contributor)
+    Project files at https://github.com/a-f-G-U-C/Meshtastic-ZPS
+    ENCODING: arrays of int64 fields
+    """
+    SIMULATOR_APP: _PortNum.ValueType  # 69
+    """
+    Used to let multiple instances of Linux native applications communicate
+    as if they did using their LoRa chip.
+    Maintained by GitHub user GUVWAF.
+    Project files at https://github.com/GUVWAF/Meshtasticator
+    ENCODING: Protobuf (?)
+    """
+    TRACEROUTE_APP: _PortNum.ValueType  # 70
+    """
+    Provides a traceroute functionality to show the route a packet towards
+    a certain destination would take on the mesh.
+    ENCODING: Protobuf
+    """
+    NEIGHBORINFO_APP: _PortNum.ValueType  # 71
+    """
+    Aggregates edge info for the network by sending out a list of each node's neighbors
+    ENCODING: Protobuf
+    """
+    ATAK_PLUGIN: _PortNum.ValueType  # 72
+    """
+    ATAK Plugin
+    Portnum for payloads from the official Meshtastic ATAK plugin
+    """
+    MAP_REPORT_APP: _PortNum.ValueType  # 73
+    """
+    Provides unencrypted information about a node for consumption by a map via MQTT
+    """
+    PRIVATE_APP: _PortNum.ValueType  # 256
+    """
+    Private applications should use portnums >= 256.
+    To simplify initial development and testing you can use "PRIVATE_APP"
+    in your code without needing to rebuild protobuf files (via [regen-protos.sh](https://github.com/meshtastic/firmware/blob/master/bin/regen-protos.sh))
+    """
+    ATAK_FORWARDER: _PortNum.ValueType  # 257
+    """
+    ATAK Forwarder Module https://github.com/paulmandal/atak-forwarder
+    ENCODING: libcotshrink
+    """
+    MAX: _PortNum.ValueType  # 511
+    """
+    Currently we limit port nums to no higher than this value
+    """
+
+class PortNum(_PortNum, metaclass=_PortNumEnumTypeWrapper):
+    """
+    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 this
+    master table.
+    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
+    All other values are reserved.
+    Note: This was formerly a Type enum named 'typ' with the same id #
+    We have change to this 'portnum' based scheme for specifying app handlers for particular payloads.
+    This change is backwards compatible by treating the legacy OPAQUE/CLEAR_TEXT values identically.
+    """
+
+UNKNOWN_APP: PortNum.ValueType  # 0
+"""
+Deprecated: do not use in new code (formerly called OPAQUE)
+A message sent from a device outside of the mesh, in a form the mesh does not understand
+NOTE: This must be 0, because it is documented in IMeshService.aidl to be so
+ENCODING: binary undefined
+"""
+TEXT_MESSAGE_APP: PortNum.ValueType  # 1
+"""
+A simple UTF-8 text message, which even the little micros in the mesh
+can understand and show on their screen eventually in some circumstances
+even signal might send messages in this form (see below)
+ENCODING: UTF-8 Plaintext (?)
+"""
+REMOTE_HARDWARE_APP: PortNum.ValueType  # 2
+"""
+Reserved for built-in GPIO/example app.
+See remote_hardware.proto/HardwareMessage for details on the message sent/received to this port number
+ENCODING: Protobuf
+"""
+POSITION_APP: PortNum.ValueType  # 3
+"""
+The built-in position messaging app.
+Payload is a Position message.
+ENCODING: Protobuf
+"""
+NODEINFO_APP: PortNum.ValueType  # 4
+"""
+The built-in user info app.
+Payload is a User message.
+ENCODING: Protobuf
+"""
+ROUTING_APP: PortNum.ValueType  # 5
+"""
+Protocol control packets for mesh protocol use.
+Payload is a Routing message.
+ENCODING: Protobuf
+"""
+ADMIN_APP: PortNum.ValueType  # 6
+"""
+Admin control packets.
+Payload is a AdminMessage message.
+ENCODING: Protobuf
+"""
+TEXT_MESSAGE_COMPRESSED_APP: PortNum.ValueType  # 7
+"""
+Compressed TEXT_MESSAGE payloads.
+ENCODING: UTF-8 Plaintext (?) with Unishox2 Compression
+NOTE: The Device Firmware converts a TEXT_MESSAGE_APP to TEXT_MESSAGE_COMPRESSED_APP if the compressed
+payload is shorter. There's no need for app developers to do this themselves. Also the firmware will decompress
+any incoming TEXT_MESSAGE_COMPRESSED_APP payload and convert to TEXT_MESSAGE_APP.
+"""
+WAYPOINT_APP: PortNum.ValueType  # 8
+"""
+Waypoint payloads.
+Payload is a Waypoint message.
+ENCODING: Protobuf
+"""
+AUDIO_APP: PortNum.ValueType  # 9
+"""
+Audio Payloads.
+Encapsulated codec2 packets. On 2.4 GHZ Bandwidths only for now
+ENCODING: codec2 audio frames
+NOTE: audio frames contain a 3 byte header (0xc0 0xde 0xc2) and a one byte marker for the decompressed bitrate.
+This marker comes from the 'moduleConfig.audio.bitrate' enum minus one.
+"""
+DETECTION_SENSOR_APP: PortNum.ValueType  # 10
+"""
+Same as Text Message but originating from Detection Sensor Module.
+NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9
+"""
+REPLY_APP: PortNum.ValueType  # 32
+"""
+Provides a 'ping' service that replies to any packet it receives.
+Also serves as a small example module.
+ENCODING: ASCII Plaintext
+"""
+IP_TUNNEL_APP: PortNum.ValueType  # 33
+"""
+Used for the python IP tunnel feature
+ENCODING: IP Packet. Handled by the python API, firmware ignores this one and pases on.
+"""
+PAXCOUNTER_APP: PortNum.ValueType  # 34
+"""
+Paxcounter lib included in the firmware
+ENCODING: protobuf
+"""
+SERIAL_APP: PortNum.ValueType  # 64
+"""
+Provides a hardware serial interface to send and receive from the Meshtastic network.
+Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic
+network is forwarded to the RX pin while sending a packet to TX will go out to the Mesh network.
+Maximum packet size of 240 bytes.
+Module is disabled by default can be turned on by setting SERIAL_MODULE_ENABLED = 1 in SerialPlugh.cpp.
+ENCODING: binary undefined
+"""
+STORE_FORWARD_APP: PortNum.ValueType  # 65
+"""
+STORE_FORWARD_APP (Work in Progress)
+Maintained by Jm Casler (MC Hamster) : jm@casler.org
+ENCODING: Protobuf
+"""
+RANGE_TEST_APP: PortNum.ValueType  # 66
+"""
+Optional port for messages for the range test module.
+ENCODING: ASCII Plaintext
+NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9
+"""
+TELEMETRY_APP: PortNum.ValueType  # 67
+"""
+Provides a format to send and receive telemetry data from the Meshtastic network.
+Maintained by Charles Crossan (crossan007) : crossan007@gmail.com
+ENCODING: Protobuf
+"""
+ZPS_APP: PortNum.ValueType  # 68
+"""
+Experimental tools for estimating node position without a GPS
+Maintained by Github user a-f-G-U-C (a Meshtastic contributor)
+Project files at https://github.com/a-f-G-U-C/Meshtastic-ZPS
+ENCODING: arrays of int64 fields
+"""
+SIMULATOR_APP: PortNum.ValueType  # 69
+"""
+Used to let multiple instances of Linux native applications communicate
+as if they did using their LoRa chip.
+Maintained by GitHub user GUVWAF.
+Project files at https://github.com/GUVWAF/Meshtasticator
+ENCODING: Protobuf (?)
+"""
+TRACEROUTE_APP: PortNum.ValueType  # 70
+"""
+Provides a traceroute functionality to show the route a packet towards
+a certain destination would take on the mesh.
+ENCODING: Protobuf
+"""
+NEIGHBORINFO_APP: PortNum.ValueType  # 71
+"""
+Aggregates edge info for the network by sending out a list of each node's neighbors
+ENCODING: Protobuf
+"""
+ATAK_PLUGIN: PortNum.ValueType  # 72
+"""
+ATAK Plugin
+Portnum for payloads from the official Meshtastic ATAK plugin
+"""
+MAP_REPORT_APP: PortNum.ValueType  # 73
+"""
+Provides unencrypted information about a node for consumption by a map via MQTT
+"""
+PRIVATE_APP: PortNum.ValueType  # 256
+"""
+Private applications should use portnums >= 256.
+To simplify initial development and testing you can use "PRIVATE_APP"
+in your code without needing to rebuild protobuf files (via [regen-protos.sh](https://github.com/meshtastic/firmware/blob/master/bin/regen-protos.sh))
+"""
+ATAK_FORWARDER: PortNum.ValueType  # 257
+"""
+ATAK Forwarder Module https://github.com/paulmandal/atak-forwarder
+ENCODING: libcotshrink
+"""
+MAX: PortNum.ValueType  # 511
+"""
+Currently we limit port nums to no higher than this value
+"""
+global___PortNum = PortNum

meshtastic/remote_hardware.py

@@ -1,14 +1,15 @@
 """Remote hardware
 """
 import logging
-from pubsub import pub
+
+from pubsub import pub # type: ignore[import-untyped]
+
 from meshtastic import portnums_pb2, remote_hardware_pb2
 from meshtastic.util import our_exit
 
 
 def onGPIOreceive(packet, interface):
-    """Callback for received GPIO responses
-    """
+    """Callback for received GPIO responses"""
     logging.debug(f"packet:{packet} interface:{interface}")
     gpioValue = 0
     hw = packet["decoded"]["remotehw"]
@@ -21,9 +22,11 @@ def onGPIOreceive(packet, interface):
             # so, we set it here
             gpioValue = 0
 
-    #print(f'mask:{interface.mask}')
+    # print(f'mask:{interface.mask}')
     value = int(gpioValue) & int(interface.mask)
-    print(f'Received RemoteHardware typ={hw["typ"]}, gpio_value={gpioValue} value={value}')
+    print(
+        f'Received RemoteHardware type={hw["type"]}, gpio_value={gpioValue} value={value}'
+    )
     interface.gotResponse = True
 
 
@@ -44,46 +47,55 @@ class RemoteHardwareClient:
         ch = iface.localNode.getChannelByName("gpio")
         if not ch:
             our_exit(
-                "Warning: No channel named 'gpio' was found.\n"\
-                "On the sending and receive nodes create a channel named 'gpio'.\n"\
-                "For example, run '--ch-add gpio' on one device, then '--seturl' on\n"\
-                "the other devices using the url from the device where the channel was added.")
+                "Warning: No channel named 'gpio' was found.\n"
+                "On the sending and receive nodes create a channel named 'gpio'.\n"
+                "For example, run '--ch-add gpio' on one device, then '--seturl' on\n"
+                "the other devices using the url from the device where the channel was added."
+            )
         self.channelIndex = ch.index
 
         pub.subscribe(onGPIOreceive, "meshtastic.receive.remotehw")
 
     def _sendHardware(self, nodeid, r, wantResponse=False, onResponse=None):
         if not nodeid:
-            our_exit(r"Warning: Must use a destination node ID for this operation (use --dest \!xxxxxxxxx)")
-        return self.iface.sendData(r, nodeid, portnums_pb2.REMOTE_HARDWARE_APP,
-                                   wantAck=True, channelIndex=self.channelIndex,
-                                   wantResponse=wantResponse, onResponse=onResponse)
+            our_exit(
+                r"Warning: Must use a destination node ID for this operation (use --dest \!xxxxxxxxx)"
+            )
+        return self.iface.sendData(
+            r,
+            nodeid,
+            portnums_pb2.REMOTE_HARDWARE_APP,
+            wantAck=True,
+            channelIndex=self.channelIndex,
+            wantResponse=wantResponse,
+            onResponse=onResponse,
+        )
 
     def writeGPIOs(self, nodeid, mask, vals):
         """
         Write the specified vals bits to the device GPIOs.  Only bits in mask that
         are 1 will be changed
         """
-        logging.debug(f'writeGPIOs nodeid:{nodeid} mask:{mask} vals:{vals}')
+        logging.debug(f"writeGPIOs nodeid:{nodeid} mask:{mask} vals:{vals}")
         r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.WRITE_GPIOS
+        r.type = remote_hardware_pb2.HardwareMessage.Type.WRITE_GPIOS
         r.gpio_mask = mask
         r.gpio_value = vals
         return self._sendHardware(nodeid, r)
 
-    def readGPIOs(self, nodeid, mask, onResponse = None):
+    def readGPIOs(self, nodeid, mask, onResponse=None):
         """Read the specified bits from GPIO inputs on the device"""
-        logging.debug(f'readGPIOs nodeid:{nodeid} mask:{mask}')
+        logging.debug(f"readGPIOs nodeid:{nodeid} mask:{mask}")
         r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.READ_GPIOS
+        r.type = remote_hardware_pb2.HardwareMessage.Type.READ_GPIOS
         r.gpio_mask = mask
         return self._sendHardware(nodeid, r, wantResponse=True, onResponse=onResponse)
 
     def watchGPIOs(self, nodeid, mask):
         """Watch the specified bits from GPIO inputs on the device for changes"""
-        logging.debug(f'watchGPIOs nodeid:{nodeid} mask:{mask}')
+        logging.debug(f"watchGPIOs nodeid:{nodeid} mask:{mask}")
         r = remote_hardware_pb2.HardwareMessage()
-        r.typ = remote_hardware_pb2.HardwareMessage.Type.WATCH_GPIOS
+        r.type = remote_hardware_pb2.HardwareMessage.Type.WATCH_GPIOS
         r.gpio_mask = mask
         self.iface.mask = mask
         return self._sendHardware(nodeid, r)

meshtastic/remote_hardware_pb2.py

@@ -1,11 +1,10 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: remote_hardware.proto
+# source: meshtastic/remote_hardware.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
@@ -14,25 +13,16 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15remote_hardware.proto\"\xca\x01\n\x0fHardwareMessage\x12\"\n\x03typ\x18\x01 \x01(\x0e\x32\x15.HardwareMessage.Type\x12\x11\n\tgpio_mask\x18\x02 \x01(\x04\x12\x12\n\ngpio_value\x18\x03 \x01(\x04\"l\n\x04Type\x12\t\n\x05UNSET\x10\x00\x12\x0f\n\x0bWRITE_GPIOS\x10\x01\x12\x0f\n\x0bWATCH_GPIOS\x10\x02\x12\x11\n\rGPIOS_CHANGED\x10\x03\x12\x0e\n\nREAD_GPIOS\x10\x04\x12\x14\n\x10READ_GPIOS_REPLY\x10\x05\x42J\n\x13\x63om.geeksville.meshB\x0eRemoteHardwareH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_HARDWAREMESSAGE = DESCRIPTOR.message_types_by_name['HardwareMessage']
-_HARDWAREMESSAGE_TYPE = _HARDWAREMESSAGE.enum_types_by_name['Type']
-HardwareMessage = _reflection.GeneratedProtocolMessageType('HardwareMessage', (_message.Message,), {
-  'DESCRIPTOR' : _HARDWAREMESSAGE,
-  '__module__' : 'remote_hardware_pb2'
-  # @@protoc_insertion_point(class_scope:HardwareMessage)
-  })
-_sym_db.RegisterMessage(HardwareMessage)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n meshtastic/remote_hardware.proto\x12\nmeshtastic\"\xd6\x01\n\x0fHardwareMessage\x12.\n\x04type\x18\x01 \x01(\x0e\x32 .meshtastic.HardwareMessage.Type\x12\x11\n\tgpio_mask\x18\x02 \x01(\x04\x12\x12\n\ngpio_value\x18\x03 \x01(\x04\"l\n\x04Type\x12\t\n\x05UNSET\x10\x00\x12\x0f\n\x0bWRITE_GPIOS\x10\x01\x12\x0f\n\x0bWATCH_GPIOS\x10\x02\x12\x11\n\rGPIOS_CHANGED\x10\x03\x12\x0e\n\nREAD_GPIOS\x10\x04\x12\x14\n\x10READ_GPIOS_REPLY\x10\x05\x42\x63\n\x13\x63om.geeksville.meshB\x0eRemoteHardwareZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.remote_hardware_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\016RemoteHardwareH\003Z!github.com/meshtastic/gomeshproto'
-  _HARDWAREMESSAGE._serialized_start=26
-  _HARDWAREMESSAGE._serialized_end=228
-  _HARDWAREMESSAGE_TYPE._serialized_start=120
-  _HARDWAREMESSAGE_TYPE._serialized_end=228
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\016RemoteHardwareZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _HARDWAREMESSAGE._serialized_start=49
+  _HARDWAREMESSAGE._serialized_end=263
+  _HARDWAREMESSAGE_TYPE._serialized_start=155
+  _HARDWAREMESSAGE_TYPE._serialized_end=263
 # @@protoc_insertion_point(module_scope)

meshtastic/remote_hardware_pb2.pyi

@@ -0,0 +1,125 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class HardwareMessage(google.protobuf.message.Message):
+    """
+    An example app to show off the module system. This message is used for
+    REMOTE_HARDWARE_APP PortNums.
+    Also provides easy remote access to any GPIO.
+    In the future other remote hardware operations can be added based on user interest
+    (i.e. serial output, spi/i2c input/output).
+    FIXME - currently this feature is turned on by default which is dangerous
+    because no security yet (beyond the channel mechanism).
+    It should be off by default and then protected based on some TBD mechanism
+    (a special channel once multichannel support is included?)
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _Type:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _TypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[HardwareMessage._Type.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        UNSET: HardwareMessage._Type.ValueType  # 0
+        """
+        Unset/unused
+        """
+        WRITE_GPIOS: HardwareMessage._Type.ValueType  # 1
+        """
+        Set gpio gpios based on gpio_mask/gpio_value
+        """
+        WATCH_GPIOS: HardwareMessage._Type.ValueType  # 2
+        """
+        We are now interested in watching the gpio_mask gpios.
+        If the selected gpios change, please broadcast GPIOS_CHANGED.
+        Will implicitly change the gpios requested to be INPUT gpios.
+        """
+        GPIOS_CHANGED: HardwareMessage._Type.ValueType  # 3
+        """
+        The gpios listed in gpio_mask have changed, the new values are listed in gpio_value
+        """
+        READ_GPIOS: HardwareMessage._Type.ValueType  # 4
+        """
+        Read the gpios specified in gpio_mask, send back a READ_GPIOS_REPLY reply with gpio_value populated
+        """
+        READ_GPIOS_REPLY: HardwareMessage._Type.ValueType  # 5
+        """
+        A reply to READ_GPIOS. gpio_mask and gpio_value will be populated
+        """
+
+    class Type(_Type, metaclass=_TypeEnumTypeWrapper):
+        """
+        TODO: REPLACE
+        """
+
+    UNSET: HardwareMessage.Type.ValueType  # 0
+    """
+    Unset/unused
+    """
+    WRITE_GPIOS: HardwareMessage.Type.ValueType  # 1
+    """
+    Set gpio gpios based on gpio_mask/gpio_value
+    """
+    WATCH_GPIOS: HardwareMessage.Type.ValueType  # 2
+    """
+    We are now interested in watching the gpio_mask gpios.
+    If the selected gpios change, please broadcast GPIOS_CHANGED.
+    Will implicitly change the gpios requested to be INPUT gpios.
+    """
+    GPIOS_CHANGED: HardwareMessage.Type.ValueType  # 3
+    """
+    The gpios listed in gpio_mask have changed, the new values are listed in gpio_value
+    """
+    READ_GPIOS: HardwareMessage.Type.ValueType  # 4
+    """
+    Read the gpios specified in gpio_mask, send back a READ_GPIOS_REPLY reply with gpio_value populated
+    """
+    READ_GPIOS_REPLY: HardwareMessage.Type.ValueType  # 5
+    """
+    A reply to READ_GPIOS. gpio_mask and gpio_value will be populated
+    """
+
+    TYPE_FIELD_NUMBER: builtins.int
+    GPIO_MASK_FIELD_NUMBER: builtins.int
+    GPIO_VALUE_FIELD_NUMBER: builtins.int
+    type: global___HardwareMessage.Type.ValueType
+    """
+    What type of HardwareMessage is this?
+    """
+    gpio_mask: builtins.int
+    """
+    What gpios are we changing. Not used for all MessageTypes, see MessageType for details
+    """
+    gpio_value: builtins.int
+    """
+    For gpios that were listed in gpio_mask as valid, what are the signal levels for those gpios.
+    Not used for all MessageTypes, see MessageType for details
+    """
+    def __init__(
+        self,
+        *,
+        type: global___HardwareMessage.Type.ValueType = ...,
+        gpio_mask: builtins.int = ...,
+        gpio_value: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["gpio_mask", b"gpio_mask", "gpio_value", b"gpio_value", "type", b"type"]) -> None: ...
+
+global___HardwareMessage = HardwareMessage

meshtastic/rtttl_pb2.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/rtttl.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16meshtastic/rtttl.proto\x12\nmeshtastic\"\x1f\n\x0bRTTTLConfig\x12\x10\n\x08ringtone\x18\x01 \x01(\tBf\n\x13\x63om.geeksville.meshB\x11RTTTLConfigProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.rtttl_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\021RTTTLConfigProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _RTTTLCONFIG._serialized_start=38
+  _RTTTLCONFIG._serialized_end=69
+# @@protoc_insertion_point(module_scope)

meshtastic/rtttl_pb2.pyi

@@ -0,0 +1,37 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import sys
+
+if sys.version_info >= (3, 8):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class RTTTLConfig(google.protobuf.message.Message):
+    """
+    Canned message module configuration.
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    RINGTONE_FIELD_NUMBER: builtins.int
+    ringtone: builtins.str
+    """
+    Ringtone for PWM Buzzer in RTTTL Format.
+    """
+    def __init__(
+        self,
+        *,
+        ringtone: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["ringtone", b"ringtone"]) -> None: ...
+
+global___RTTTLConfig = RTTTLConfig

meshtastic/serial_interface.py

@@ -1,20 +1,24 @@
 """ Serial interface class
 """
 import logging
-import time
 import platform
-import serial
+import time
+
+from typing import Optional
+
+import serial # type: ignore[import-untyped]
 
 import meshtastic.util
 from meshtastic.stream_interface import StreamInterface
 
-if platform.system() != 'Windows':
+if platform.system() != "Windows":
     import termios
 
+
 class SerialInterface(StreamInterface):
     """Interface class for meshtastic devices over a serial link"""
 
-    def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
+    def __init__(self, devPath: Optional[str]=None, debugOut=None, noProto=False, connectNow=True):
         """Constructor, opens a connection to a specified serial port, or if unspecified try to
         find one Meshtastic device by probing
 
@@ -24,13 +28,14 @@ class SerialInterface(StreamInterface):
         """
         self.noProto = noProto
 
-        self.devPath = devPath
+        self.devPath: Optional[str] = devPath
 
         if self.devPath is None:
             ports = meshtastic.util.findPorts(True)
             logging.debug(f"ports:{ports}")
             if len(ports) == 0:
-                meshtastic.util.our_exit("Warning: No Meshtastic devices detected.")
+                print("No Serial Meshtastic device detected, attempting TCP connection on localhost.")
+                return
             elif len(ports) > 1:
                 message = "Warning: Multiple serial ports were detected so one serial port must be specified with the '--port'.\n"
                 message += f"  Ports detected:{ports}"
@@ -42,19 +47,23 @@ class SerialInterface(StreamInterface):
 
         # first we need to set the HUPCL so the device will not reboot based on RTS and/or DTR
         # see https://github.com/pyserial/pyserial/issues/124
-        if platform.system() != 'Windows':
-            with open(self.devPath, encoding='utf8') as f:
+        if platform.system() != "Windows":
+            with open(self.devPath, encoding="utf8") as f:
                 attrs = termios.tcgetattr(f)
                 attrs[2] = attrs[2] & ~termios.HUPCL
                 termios.tcsetattr(f, termios.TCSAFLUSH, attrs)
                 f.close()
             time.sleep(0.1)
 
-        self.stream = serial.Serial(self.devPath, 921600, exclusive=True, timeout=0.5, write_timeout=0)
+        self.stream = serial.Serial(
+            self.devPath, 115200, exclusive=True, timeout=0.5, write_timeout=0
+        )
         self.stream.flush()
         time.sleep(0.1)
 
-        StreamInterface.__init__(self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
+        StreamInterface.__init__(
+            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow
+        )
 
     def close(self):
         """Close a connection to the device"""

meshtastic/storeforward_pb2.py

@@ -1,11 +1,10 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: storeforward.proto
+# source: meshtastic/storeforward.proto
 """Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
 from google.protobuf import descriptor as _descriptor
 from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import message as _message
-from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
 # @@protoc_insertion_point(imports)
 
@@ -14,58 +13,22 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x12storeforward.proto\"\x8a\x06\n\x0fStoreAndForward\x12,\n\x02rr\x18\x01 \x01(\x0e\x32 .StoreAndForward.RequestResponse\x12*\n\x05stats\x18\x02 \x01(\x0b\x32\x1b.StoreAndForward.Statistics\x12)\n\x07history\x18\x03 \x01(\x0b\x32\x18.StoreAndForward.History\x12-\n\theartbeat\x18\x04 \x01(\x0b\x32\x1a.StoreAndForward.Heartbeat\x1a\xcd\x01\n\nStatistics\x12\x16\n\x0emessages_total\x18\x01 \x01(\r\x12\x16\n\x0emessages_saved\x18\x02 \x01(\r\x12\x14\n\x0cmessages_max\x18\x03 \x01(\r\x12\x0f\n\x07up_time\x18\x04 \x01(\r\x12\x10\n\x08requests\x18\x05 \x01(\r\x12\x18\n\x10requests_history\x18\x06 \x01(\r\x12\x11\n\theartbeat\x18\x07 \x01(\x08\x12\x12\n\nreturn_max\x18\x08 \x01(\r\x12\x15\n\rreturn_window\x18\t \x01(\r\x1aI\n\x07History\x12\x18\n\x10history_messages\x18\x01 \x01(\r\x12\x0e\n\x06window\x18\x02 \x01(\r\x12\x14\n\x0clast_request\x18\x03 \x01(\r\x1a.\n\tHeartbeat\x12\x0e\n\x06period\x18\x01 \x01(\r\x12\x11\n\tsecondary\x18\x02 \x01(\r\"\xf7\x01\n\x0fRequestResponse\x12\t\n\x05UNSET\x10\x00\x12\x10\n\x0cROUTER_ERROR\x10\x01\x12\x14\n\x10ROUTER_HEARTBEAT\x10\x02\x12\x0f\n\x0bROUTER_PING\x10\x03\x12\x0f\n\x0bROUTER_PONG\x10\x04\x12\x0f\n\x0bROUTER_BUSY\x10\x05\x12\x12\n\x0eROUTER_HISTORY\x10\x06\x12\x10\n\x0c\x43LIENT_ERROR\x10\x65\x12\x12\n\x0e\x43LIENT_HISTORY\x10\x66\x12\x10\n\x0c\x43LIENT_STATS\x10g\x12\x0f\n\x0b\x43LIENT_PING\x10h\x12\x0f\n\x0b\x43LIENT_PONG\x10i\x12\x10\n\x0c\x43LIENT_ABORT\x10jBQ\n\x13\x63om.geeksville.meshB\x15StoreAndForwardProtosH\x03Z!github.com/meshtastic/gomeshprotob\x06proto3')
-
-
-
-_STOREANDFORWARD = DESCRIPTOR.message_types_by_name['StoreAndForward']
-_STOREANDFORWARD_STATISTICS = _STOREANDFORWARD.nested_types_by_name['Statistics']
-_STOREANDFORWARD_HISTORY = _STOREANDFORWARD.nested_types_by_name['History']
-_STOREANDFORWARD_HEARTBEAT = _STOREANDFORWARD.nested_types_by_name['Heartbeat']
-_STOREANDFORWARD_REQUESTRESPONSE = _STOREANDFORWARD.enum_types_by_name['RequestResponse']
-StoreAndForward = _reflection.GeneratedProtocolMessageType('StoreAndForward', (_message.Message,), {
-
-  'Statistics' : _reflection.GeneratedProtocolMessageType('Statistics', (_message.Message,), {
-    'DESCRIPTOR' : _STOREANDFORWARD_STATISTICS,
-    '__module__' : 'storeforward_pb2'
-    # @@protoc_insertion_point(class_scope:StoreAndForward.Statistics)
-    })
-  ,
-
-  'History' : _reflection.GeneratedProtocolMessageType('History', (_message.Message,), {
-    'DESCRIPTOR' : _STOREANDFORWARD_HISTORY,
-    '__module__' : 'storeforward_pb2'
-    # @@protoc_insertion_point(class_scope:StoreAndForward.History)
-    })
-  ,
-
-  'Heartbeat' : _reflection.GeneratedProtocolMessageType('Heartbeat', (_message.Message,), {
-    'DESCRIPTOR' : _STOREANDFORWARD_HEARTBEAT,
-    '__module__' : 'storeforward_pb2'
-    # @@protoc_insertion_point(class_scope:StoreAndForward.Heartbeat)
-    })
-  ,
-  'DESCRIPTOR' : _STOREANDFORWARD,
-  '__module__' : 'storeforward_pb2'
-  # @@protoc_insertion_point(class_scope:StoreAndForward)
-  })
-_sym_db.RegisterMessage(StoreAndForward)
-_sym_db.RegisterMessage(StoreAndForward.Statistics)
-_sym_db.RegisterMessage(StoreAndForward.History)
-_sym_db.RegisterMessage(StoreAndForward.Heartbeat)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1dmeshtastic/storeforward.proto\x12\nmeshtastic\"\x9c\x07\n\x0fStoreAndForward\x12\x37\n\x02rr\x18\x01 \x01(\x0e\x32+.meshtastic.StoreAndForward.RequestResponse\x12\x37\n\x05stats\x18\x02 \x01(\x0b\x32&.meshtastic.StoreAndForward.StatisticsH\x00\x12\x36\n\x07history\x18\x03 \x01(\x0b\x32#.meshtastic.StoreAndForward.HistoryH\x00\x12:\n\theartbeat\x18\x04 \x01(\x0b\x32%.meshtastic.StoreAndForward.HeartbeatH\x00\x12\x0e\n\x04text\x18\x05 \x01(\x0cH\x00\x1a\xcd\x01\n\nStatistics\x12\x16\n\x0emessages_total\x18\x01 \x01(\r\x12\x16\n\x0emessages_saved\x18\x02 \x01(\r\x12\x14\n\x0cmessages_max\x18\x03 \x01(\r\x12\x0f\n\x07up_time\x18\x04 \x01(\r\x12\x10\n\x08requests\x18\x05 \x01(\r\x12\x18\n\x10requests_history\x18\x06 \x01(\r\x12\x11\n\theartbeat\x18\x07 \x01(\x08\x12\x12\n\nreturn_max\x18\x08 \x01(\r\x12\x15\n\rreturn_window\x18\t \x01(\r\x1aI\n\x07History\x12\x18\n\x10history_messages\x18\x01 \x01(\r\x12\x0e\n\x06window\x18\x02 \x01(\r\x12\x14\n\x0clast_request\x18\x03 \x01(\r\x1a.\n\tHeartbeat\x12\x0e\n\x06period\x18\x01 \x01(\r\x12\x11\n\tsecondary\x18\x02 \x01(\r\"\xbc\x02\n\x0fRequestResponse\x12\t\n\x05UNSET\x10\x00\x12\x10\n\x0cROUTER_ERROR\x10\x01\x12\x14\n\x10ROUTER_HEARTBEAT\x10\x02\x12\x0f\n\x0bROUTER_PING\x10\x03\x12\x0f\n\x0bROUTER_PONG\x10\x04\x12\x0f\n\x0bROUTER_BUSY\x10\x05\x12\x12\n\x0eROUTER_HISTORY\x10\x06\x12\x10\n\x0cROUTER_STATS\x10\x07\x12\x16\n\x12ROUTER_TEXT_DIRECT\x10\x08\x12\x19\n\x15ROUTER_TEXT_BROADCAST\x10\t\x12\x10\n\x0c\x43LIENT_ERROR\x10@\x12\x12\n\x0e\x43LIENT_HISTORY\x10\x41\x12\x10\n\x0c\x43LIENT_STATS\x10\x42\x12\x0f\n\x0b\x43LIENT_PING\x10\x43\x12\x0f\n\x0b\x43LIENT_PONG\x10\x44\x12\x10\n\x0c\x43LIENT_ABORT\x10jB\t\n\x07variantBj\n\x13\x63om.geeksville.meshB\x15StoreAndForwardProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.storeforward_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\025StoreAndForwardProtosH\003Z!github.com/meshtastic/gomeshproto'
-  _STOREANDFORWARD._serialized_start=23
-  _STOREANDFORWARD._serialized_end=801
-  _STOREANDFORWARD_STATISTICS._serialized_start=223
-  _STOREANDFORWARD_STATISTICS._serialized_end=428
-  _STOREANDFORWARD_HISTORY._serialized_start=430
-  _STOREANDFORWARD_HISTORY._serialized_end=503
-  _STOREANDFORWARD_HEARTBEAT._serialized_start=505
-  _STOREANDFORWARD_HEARTBEAT._serialized_end=551
-  _STOREANDFORWARD_REQUESTRESPONSE._serialized_start=554
-  _STOREANDFORWARD_REQUESTRESPONSE._serialized_end=801
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\025StoreAndForwardProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _STOREANDFORWARD._serialized_start=46
+  _STOREANDFORWARD._serialized_end=970
+  _STOREANDFORWARD_STATISTICS._serialized_start=312
+  _STOREANDFORWARD_STATISTICS._serialized_end=517
+  _STOREANDFORWARD_HISTORY._serialized_start=519
+  _STOREANDFORWARD_HISTORY._serialized_end=592
+  _STOREANDFORWARD_HEARTBEAT._serialized_start=594
+  _STOREANDFORWARD_HEARTBEAT._serialized_end=640
+  _STOREANDFORWARD_REQUESTRESPONSE._serialized_start=643
+  _STOREANDFORWARD_REQUESTRESPONSE._serialized_end=959
 # @@protoc_insertion_point(module_scope)

meshtastic/storeforward_pb2.pyi

@@ -0,0 +1,341 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class StoreAndForward(google.protobuf.message.Message):
+    """
+    TODO: REPLACE
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _RequestResponse:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _RequestResponseEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[StoreAndForward._RequestResponse.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        UNSET: StoreAndForward._RequestResponse.ValueType  # 0
+        """
+        Unset/unused
+        """
+        ROUTER_ERROR: StoreAndForward._RequestResponse.ValueType  # 1
+        """
+        Router is an in error state.
+        """
+        ROUTER_HEARTBEAT: StoreAndForward._RequestResponse.ValueType  # 2
+        """
+        Router heartbeat
+        """
+        ROUTER_PING: StoreAndForward._RequestResponse.ValueType  # 3
+        """
+        Router has requested the client respond. This can work as a
+        "are you there" message.
+        """
+        ROUTER_PONG: StoreAndForward._RequestResponse.ValueType  # 4
+        """
+        The response to a "Ping"
+        """
+        ROUTER_BUSY: StoreAndForward._RequestResponse.ValueType  # 5
+        """
+        Router is currently busy. Please try again later.
+        """
+        ROUTER_HISTORY: StoreAndForward._RequestResponse.ValueType  # 6
+        """
+        Router is responding to a request for history.
+        """
+        ROUTER_STATS: StoreAndForward._RequestResponse.ValueType  # 7
+        """
+        Router is responding to a request for stats.
+        """
+        ROUTER_TEXT_DIRECT: StoreAndForward._RequestResponse.ValueType  # 8
+        """
+        Router sends a text message from its history that was a direct message.
+        """
+        ROUTER_TEXT_BROADCAST: StoreAndForward._RequestResponse.ValueType  # 9
+        """
+        Router sends a text message from its history that was a broadcast.
+        """
+        CLIENT_ERROR: StoreAndForward._RequestResponse.ValueType  # 64
+        """
+        Client is an in error state.
+        """
+        CLIENT_HISTORY: StoreAndForward._RequestResponse.ValueType  # 65
+        """
+        Client has requested a replay from the router.
+        """
+        CLIENT_STATS: StoreAndForward._RequestResponse.ValueType  # 66
+        """
+        Client has requested stats from the router.
+        """
+        CLIENT_PING: StoreAndForward._RequestResponse.ValueType  # 67
+        """
+        Client has requested the router respond. This can work as a
+        "are you there" message.
+        """
+        CLIENT_PONG: StoreAndForward._RequestResponse.ValueType  # 68
+        """
+        The response to a "Ping"
+        """
+        CLIENT_ABORT: StoreAndForward._RequestResponse.ValueType  # 106
+        """
+        Client has requested that the router abort processing the client's request
+        """
+
+    class RequestResponse(_RequestResponse, metaclass=_RequestResponseEnumTypeWrapper):
+        """
+        001 - 063 = From Router
+        064 - 127 = From Client
+        """
+
+    UNSET: StoreAndForward.RequestResponse.ValueType  # 0
+    """
+    Unset/unused
+    """
+    ROUTER_ERROR: StoreAndForward.RequestResponse.ValueType  # 1
+    """
+    Router is an in error state.
+    """
+    ROUTER_HEARTBEAT: StoreAndForward.RequestResponse.ValueType  # 2
+    """
+    Router heartbeat
+    """
+    ROUTER_PING: StoreAndForward.RequestResponse.ValueType  # 3
+    """
+    Router has requested the client respond. This can work as a
+    "are you there" message.
+    """
+    ROUTER_PONG: StoreAndForward.RequestResponse.ValueType  # 4
+    """
+    The response to a "Ping"
+    """
+    ROUTER_BUSY: StoreAndForward.RequestResponse.ValueType  # 5
+    """
+    Router is currently busy. Please try again later.
+    """
+    ROUTER_HISTORY: StoreAndForward.RequestResponse.ValueType  # 6
+    """
+    Router is responding to a request for history.
+    """
+    ROUTER_STATS: StoreAndForward.RequestResponse.ValueType  # 7
+    """
+    Router is responding to a request for stats.
+    """
+    ROUTER_TEXT_DIRECT: StoreAndForward.RequestResponse.ValueType  # 8
+    """
+    Router sends a text message from its history that was a direct message.
+    """
+    ROUTER_TEXT_BROADCAST: StoreAndForward.RequestResponse.ValueType  # 9
+    """
+    Router sends a text message from its history that was a broadcast.
+    """
+    CLIENT_ERROR: StoreAndForward.RequestResponse.ValueType  # 64
+    """
+    Client is an in error state.
+    """
+    CLIENT_HISTORY: StoreAndForward.RequestResponse.ValueType  # 65
+    """
+    Client has requested a replay from the router.
+    """
+    CLIENT_STATS: StoreAndForward.RequestResponse.ValueType  # 66
+    """
+    Client has requested stats from the router.
+    """
+    CLIENT_PING: StoreAndForward.RequestResponse.ValueType  # 67
+    """
+    Client has requested the router respond. This can work as a
+    "are you there" message.
+    """
+    CLIENT_PONG: StoreAndForward.RequestResponse.ValueType  # 68
+    """
+    The response to a "Ping"
+    """
+    CLIENT_ABORT: StoreAndForward.RequestResponse.ValueType  # 106
+    """
+    Client has requested that the router abort processing the client's request
+    """
+
+    @typing_extensions.final
+    class Statistics(google.protobuf.message.Message):
+        """
+        TODO: REPLACE
+        """
+
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+        MESSAGES_TOTAL_FIELD_NUMBER: builtins.int
+        MESSAGES_SAVED_FIELD_NUMBER: builtins.int
+        MESSAGES_MAX_FIELD_NUMBER: builtins.int
+        UP_TIME_FIELD_NUMBER: builtins.int
+        REQUESTS_FIELD_NUMBER: builtins.int
+        REQUESTS_HISTORY_FIELD_NUMBER: builtins.int
+        HEARTBEAT_FIELD_NUMBER: builtins.int
+        RETURN_MAX_FIELD_NUMBER: builtins.int
+        RETURN_WINDOW_FIELD_NUMBER: builtins.int
+        messages_total: builtins.int
+        """
+        Number of messages we have ever seen
+        """
+        messages_saved: builtins.int
+        """
+        Number of messages we have currently saved our history.
+        """
+        messages_max: builtins.int
+        """
+        Maximum number of messages we will save
+        """
+        up_time: builtins.int
+        """
+        Router uptime in seconds
+        """
+        requests: builtins.int
+        """
+        Number of times any client sent a request to the S&F.
+        """
+        requests_history: builtins.int
+        """
+        Number of times the history was requested.
+        """
+        heartbeat: builtins.bool
+        """
+        Is the heartbeat enabled on the server?
+        """
+        return_max: builtins.int
+        """
+        Maximum number of messages the server will return.
+        """
+        return_window: builtins.int
+        """
+        Maximum history window in minutes the server will return messages from.
+        """
+        def __init__(
+            self,
+            *,
+            messages_total: builtins.int = ...,
+            messages_saved: builtins.int = ...,
+            messages_max: builtins.int = ...,
+            up_time: builtins.int = ...,
+            requests: builtins.int = ...,
+            requests_history: builtins.int = ...,
+            heartbeat: builtins.bool = ...,
+            return_max: builtins.int = ...,
+            return_window: builtins.int = ...,
+        ) -> None: ...
+        def ClearField(self, field_name: typing_extensions.Literal["heartbeat", b"heartbeat", "messages_max", b"messages_max", "messages_saved", b"messages_saved", "messages_total", b"messages_total", "requests", b"requests", "requests_history", b"requests_history", "return_max", b"return_max", "return_window", b"return_window", "up_time", b"up_time"]) -> None: ...
+
+    @typing_extensions.final
+    class History(google.protobuf.message.Message):
+        """
+        TODO: REPLACE
+        """
+
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+        HISTORY_MESSAGES_FIELD_NUMBER: builtins.int
+        WINDOW_FIELD_NUMBER: builtins.int
+        LAST_REQUEST_FIELD_NUMBER: builtins.int
+        history_messages: builtins.int
+        """
+        Number of that will be sent to the client
+        """
+        window: builtins.int
+        """
+        The window of messages that was used to filter the history client requested
+        """
+        last_request: builtins.int
+        """
+        Index in the packet history of the last message sent in a previous request to the server.
+        Will be sent to the client before sending the history and can be set in a subsequent request to avoid getting packets the server already sent to the client.
+        """
+        def __init__(
+            self,
+            *,
+            history_messages: builtins.int = ...,
+            window: builtins.int = ...,
+            last_request: builtins.int = ...,
+        ) -> None: ...
+        def ClearField(self, field_name: typing_extensions.Literal["history_messages", b"history_messages", "last_request", b"last_request", "window", b"window"]) -> None: ...
+
+    @typing_extensions.final
+    class Heartbeat(google.protobuf.message.Message):
+        """
+        TODO: REPLACE
+        """
+
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+        PERIOD_FIELD_NUMBER: builtins.int
+        SECONDARY_FIELD_NUMBER: builtins.int
+        period: builtins.int
+        """
+        Period in seconds that the heartbeat is sent out that will be sent to the client
+        """
+        secondary: builtins.int
+        """
+        If set, this is not the primary Store & Forward router on the mesh
+        """
+        def __init__(
+            self,
+            *,
+            period: builtins.int = ...,
+            secondary: builtins.int = ...,
+        ) -> None: ...
+        def ClearField(self, field_name: typing_extensions.Literal["period", b"period", "secondary", b"secondary"]) -> None: ...
+
+    RR_FIELD_NUMBER: builtins.int
+    STATS_FIELD_NUMBER: builtins.int
+    HISTORY_FIELD_NUMBER: builtins.int
+    HEARTBEAT_FIELD_NUMBER: builtins.int
+    TEXT_FIELD_NUMBER: builtins.int
+    rr: global___StoreAndForward.RequestResponse.ValueType
+    """
+    TODO: REPLACE
+    """
+    @property
+    def stats(self) -> global___StoreAndForward.Statistics:
+        """
+        TODO: REPLACE
+        """
+    @property
+    def history(self) -> global___StoreAndForward.History:
+        """
+        TODO: REPLACE
+        """
+    @property
+    def heartbeat(self) -> global___StoreAndForward.Heartbeat:
+        """
+        TODO: REPLACE
+        """
+    text: builtins.bytes
+    """
+    Text from history message.
+    """
+    def __init__(
+        self,
+        *,
+        rr: global___StoreAndForward.RequestResponse.ValueType = ...,
+        stats: global___StoreAndForward.Statistics | None = ...,
+        history: global___StoreAndForward.History | None = ...,
+        heartbeat: global___StoreAndForward.Heartbeat | None = ...,
+        text: builtins.bytes = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["heartbeat", b"heartbeat", "history", b"history", "stats", b"stats", "text", b"text", "variant", b"variant"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["heartbeat", b"heartbeat", "history", b"history", "rr", b"rr", "stats", b"stats", "text", b"text", "variant", b"variant"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["variant", b"variant"]) -> typing_extensions.Literal["stats", "history", "heartbeat", "text"] | None: ...
+
+global___StoreAndForward = StoreAndForward

meshtastic/stream_interface.py

@@ -4,15 +4,14 @@ import logging
 import threading
 import time
 import traceback
-import serial
 
+import serial # type: ignore[import-untyped]
 
 from meshtastic.mesh_interface import MeshInterface
-from meshtastic.util import stripnl, is_windows11
-
+from meshtastic.util import is_windows11, stripnl
 
 START1 = 0x94
-START2 = 0xc3
+START2 = 0xC3
 HEADER_LEN = 4
 MAX_TO_FROM_RADIO_SIZE = 512
 
@@ -32,9 +31,10 @@ class StreamInterface(MeshInterface):
             Exception: [description]
         """
 
-        if not hasattr(self, 'stream') and not noProto:
-            raise Exception(
-                "StreamInterface is now abstract (to update existing code create SerialInterface instead)")
+        if not hasattr(self, "stream") and not noProto:
+            raise Exception( # pylint: disable=W0719
+                "StreamInterface is now abstract (to update existing code create SerialInterface instead)"
+            )
         self._rxBuf = bytes()  # empty
         self._wantExit = False
 
@@ -60,7 +60,7 @@ class StreamInterface(MeshInterface):
 
         # Send some bogus UART characters to force a sleeping device to wake, and
         # if the reading statemachine was parsing a bad packet make sure
-        # we write enought start bytes to force it to resync (we don't use START1
+        # we write enough start bytes to force it to resync (we don't use START1
         # because we want to ensure it is looking for START1)
         p = bytearray([START2] * 32)
         self._writeBytes(p)
@@ -110,8 +110,8 @@ class StreamInterface(MeshInterface):
         b = toRadio.SerializeToString()
         bufLen = len(b)
         # We convert into a string, because the TCP code doesn't work with byte arrays
-        header = bytes([START1, START2, (bufLen >> 8) & 0xff,  bufLen & 0xff])
-        logging.debug(f'sending header:{header} b:{b}')
+        header = bytes([START1, START2, (bufLen >> 8) & 0xFF, bufLen & 0xFF])
+        logging.debug(f"sending header:{header} b:{b}")
         self._writeBytes(header + b)
 
     def close(self):
@@ -126,18 +126,18 @@ class StreamInterface(MeshInterface):
 
     def __reader(self):
         """The reader thread that reads bytes from our stream"""
-        logging.debug('in __reader()')
+        logging.debug("in __reader()")
         empty = bytes()
 
         try:
             while not self._wantExit:
-                logging.debug("reading character")
+                # logging.debug("reading character")
                 b = self._readBytes(1)
-                logging.debug("In reader loop")
-                #logging.debug(f"read returned {b}")
+                # logging.debug("In reader loop")
+                # logging.debug(f"read returned {b}")
                 if len(b) > 0:
                     c = b[0]
-                    #logging.debug(f'c:{c}')
+                    # logging.debug(f'c:{c}')
                     ptr = len(self._rxBuf)
 
                     # Assume we want to append this byte, fixme use bytearray instead
@@ -150,38 +150,54 @@ class StreamInterface(MeshInterface):
                                 try:
                                     self.debugOut.write(b.decode("utf-8"))
                                 except:
-                                    self.debugOut.write('?')
+                                    self.debugOut.write("?")
 
                     elif ptr == 1:  # looking for START2
                         if c != START2:
                             self._rxBuf = empty  # failed to find start2
                     elif ptr >= HEADER_LEN - 1:  # we've at least got a header
-                        #logging.debug('at least we received a header')
+                        # logging.debug('at least we received a header')
                         # big endian length follows header
                         packetlen = (self._rxBuf[2] << 8) + self._rxBuf[3]
 
-                        if ptr == HEADER_LEN - 1:  # we _just_ finished reading the header, validate length
+                        if (
+                            ptr == HEADER_LEN - 1
+                        ):  # we _just_ finished reading the header, validate length
                             if packetlen > MAX_TO_FROM_RADIO_SIZE:
-                                self._rxBuf = empty  # length was out out bounds, restart
+                                self._rxBuf = (
+                                    empty  # length was out out bounds, restart
+                                )
 
                         if len(self._rxBuf) != 0 and ptr + 1 >= packetlen + HEADER_LEN:
                             try:
                                 self._handleFromRadio(self._rxBuf[HEADER_LEN:])
                             except Exception as ex:
-                                logging.error(f"Error while handling message from radio {ex}")
+                                logging.error(
+                                    f"Error while handling message from radio {ex}"
+                                )
                                 traceback.print_exc()
                             self._rxBuf = empty
                 else:
                     # logging.debug(f"timeout")
                     pass
         except serial.SerialException as ex:
-            if not self._wantExit:  # We might intentionally get an exception during shutdown
-                logging.warning(f"Meshtastic serial port disconnected, disconnecting... {ex}")
+            if (
+                not self._wantExit
+            ):  # We might intentionally get an exception during shutdown
+                logging.warning(
+                    f"Meshtastic serial port disconnected, disconnecting... {ex}"
+                )
         except OSError as ex:
-            if not self._wantExit:  # We might intentionally get an exception during shutdown
-                logging.error(f"Unexpected OSError, terminating meshtastic reader... {ex}")
+            if (
+                not self._wantExit
+            ):  # We might intentionally get an exception during shutdown
+                logging.error(
+                    f"Unexpected OSError, terminating meshtastic reader... {ex}"
+                )
         except Exception as ex:
-            logging.error(f"Unexpected exception, terminating meshtastic reader... {ex}")
+            logging.error(
+                f"Unexpected exception, terminating meshtastic reader... {ex}"
+            )
         finally:
             logging.debug("reader is exiting")
             self._disconnected()

meshtastic/supported_device.py

@@ -2,195 +2,227 @@
     It is used for auto detection as to which device might be connected.
 """
 
-import platform
-import subprocess
-import re
-
 # Goal is to detect which device and port to use from the supported devices
 # without installing any libraries that are not currently in the python meshtastic library
 
-class SupportedDevice():
+
+class SupportedDevice:
     """Devices supported on Meshtastic"""
 
-    def __init__(self, name, version=None, for_firmware=None, device_class="esp32",
-                 baseport_on_linux=None, baseport_on_mac=None, baseport_on_windows="COM",
-                 usb_vendor_id_in_hex=None, usb_product_id_in_hex=None):
-        """ constructor """
+    def __init__(
+        self,
+        name,
+        version=None,
+        for_firmware=None,
+        device_class="esp32",
+        baseport_on_linux=None,
+        baseport_on_mac=None,
+        baseport_on_windows="COM",
+        usb_vendor_id_in_hex=None,
+        usb_product_id_in_hex=None,
+    ):
+        """constructor"""
         self.name = name
         self.version = version
         self.for_firmware = for_firmware
-        self.device_class = device_class # could be "nrf52"
+        self.device_class = device_class  # could be "nrf52"
 
         # when you run "lsusb -d xxxx:" in linux
-        self.usb_vendor_id_in_hex = usb_vendor_id_in_hex # store in lower case
-        self.usb_product_id_in_hex = usb_product_id_in_hex # store in lower case
+        self.usb_vendor_id_in_hex = usb_vendor_id_in_hex  # store in lower case
+        self.usb_product_id_in_hex = usb_product_id_in_hex  # store in lower case
 
-        self.baseport_on_linux = baseport_on_linux # ex: ttyUSB or ttyACM
+        self.baseport_on_linux = baseport_on_linux  # ex: ttyUSB or ttyACM
         self.baseport_on_mac = baseport_on_mac
         self.baseport_on_windows = baseport_on_windows
 
+
 # supported devices
-tbeam_v0_7 = SupportedDevice(name="T-Beam", version="0.7", for_firmware="tbeam0.7",
-                             baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                             usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="55d4")
-tbeam_v1_1 = SupportedDevice(name="T-Beam", version="1.1", for_firmware="tbeam",
-                             baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                             usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="55d4")
-tbeam_M8N = SupportedDevice(name="T-Beam", version="M8N", for_firmware="tbeam",
-                            baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                            usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="55d4")
-tbeam_M8N_SX1262 = SupportedDevice(name="T-Beam", version="M8N_SX1262", for_firmware="tbeam",
-                                   baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                                   usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="55d4")
-tlora_v1_1 = SupportedDevice(name="T-Lora", version="1.1", for_firmware="tlora-v1",
-                             baseport_on_linux="ttyUSB", baseport_on_mac="cu.usbserial",
-                             usb_vendor_id_in_hex="10c4", usb_product_id_in_hex="ea60")
-tlora_v1_3 = SupportedDevice(name="T-Lora", version="1.3", for_firmware="tlora-v1-3",
-                             baseport_on_linux="ttyUSB", baseport_on_mac="cu.usbserial",
-                             usb_vendor_id_in_hex="10c4", usb_product_id_in_hex="ea60")
-tlora_v2_0 = SupportedDevice(name="T-Lora", version="2.0", for_firmware="tlora-v2-1",
-                             baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                             usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="55d4")
-tlora_v2_1 = SupportedDevice(name="T-Lora", version="2.1", for_firmware="tlora-v2-1",
-                             baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                             usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="55d4")
-tlora_v2_1_1_6 = SupportedDevice(name="T-Lora", version="2.1-1.6", for_firmware="tlora-v2-1-1.6",
-                             baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                             usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="55d4")
-heltec_v1 = SupportedDevice(name="Heltec", version="1", for_firmware="heltec-v1",
-                            baseport_on_linux="ttyUSB", baseport_on_mac="cu.usbserial-",
-                            usb_vendor_id_in_hex="10c4", usb_product_id_in_hex="ea60")
-heltec_v2_0 = SupportedDevice(name="Heltec", version="2.0", for_firmware="heltec-v2.0",
-                              baseport_on_linux="ttyUSB", baseport_on_mac="cu.usbserial-",
-                              usb_vendor_id_in_hex="10c4", usb_product_id_in_hex="ea60")
-heltec_v2_1 = SupportedDevice(name="Heltec", version="2.1", for_firmware="heltec-v2.1",
-                              baseport_on_linux="ttyUSB", baseport_on_mac="cu.usbserial-",
-                              usb_vendor_id_in_hex="10c4", usb_product_id_in_hex="ea60")
-rak11200 = SupportedDevice(name="RAK 11200", version="", for_firmware="rak11200",
-                              baseport_on_linux="ttyUSB", baseport_on_mac="cu.usbserial-",
-                              usb_vendor_id_in_hex="1a86", usb_product_id_in_hex="7523")
-meshtastic_diy_v1 = SupportedDevice(name="Meshtastic DIY", version="1", for_firmware="meshtastic-diy-v1",
-                              baseport_on_linux="ttyUSB", baseport_on_mac="cu.usbserial-",
-                              usb_vendor_id_in_hex="10c4", usb_product_id_in_hex="ea60")
+tbeam_v0_7 = SupportedDevice(
+    name="T-Beam",
+    version="0.7",
+    for_firmware="tbeam0.7",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
+tbeam_v1_1 = SupportedDevice(
+    name="T-Beam",
+    version="1.1",
+    for_firmware="tbeam",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
+tbeam_M8N = SupportedDevice(
+    name="T-Beam",
+    version="M8N",
+    for_firmware="tbeam",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
+tbeam_M8N_SX1262 = SupportedDevice(
+    name="T-Beam",
+    version="M8N_SX1262",
+    for_firmware="tbeam",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
+tlora_v1 = SupportedDevice(
+    name="T-Lora",
+    version="1",
+    for_firmware="tlora-v1",
+    baseport_on_linux="ttyUSB",
+    baseport_on_mac="cu.usbserial",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
+tlora_v1_3 = SupportedDevice(
+    name="T-Lora",
+    version="1.3",
+    for_firmware="tlora-v1-3",
+    baseport_on_linux="ttyUSB",
+    baseport_on_mac="cu.usbserial",
+    usb_vendor_id_in_hex="10c4",
+    usb_product_id_in_hex="ea60",
+)
+tlora_v2 = SupportedDevice(
+    name="T-Lora",
+    version="2",
+    for_firmware="tlora-v2",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
+tlora_v2_1_1_6 = SupportedDevice(
+    name="T-Lora",
+    version="2.1-1.6",
+    for_firmware="tlora-v2-1-1.6",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
+heltec_v1 = SupportedDevice(
+    name="Heltec",
+    version="1",
+    for_firmware="heltec-v1",
+    baseport_on_linux="ttyUSB",
+    baseport_on_mac="cu.usbserial-",
+    usb_vendor_id_in_hex="10c4",
+    usb_product_id_in_hex="ea60",
+)
+heltec_v2_0 = SupportedDevice(
+    name="Heltec",
+    version="2.0",
+    for_firmware="heltec-v2.0",
+    baseport_on_linux="ttyUSB",
+    baseport_on_mac="cu.usbserial-",
+    usb_vendor_id_in_hex="10c4",
+    usb_product_id_in_hex="ea60",
+)
+heltec_v2_1 = SupportedDevice(
+    name="Heltec",
+    version="2.1",
+    for_firmware="heltec-v2.1",
+    baseport_on_linux="ttyUSB",
+    baseport_on_mac="cu.usbserial-",
+    usb_vendor_id_in_hex="10c4",
+    usb_product_id_in_hex="ea60",
+)
+rak11200 = SupportedDevice(
+    name="RAK 11200",
+    version="",
+    for_firmware="rak11200",
+    baseport_on_linux="ttyUSB",
+    baseport_on_mac="cu.usbserial-",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="7523",
+)
+meshtastic_diy_v1 = SupportedDevice(
+    name="Meshtastic DIY",
+    version="1",
+    for_firmware="meshtastic-diy-v1",
+    baseport_on_linux="ttyUSB",
+    baseport_on_mac="cu.usbserial-",
+    usb_vendor_id_in_hex="10c4",
+    usb_product_id_in_hex="ea60",
+)
 # Note: The T-Echo reports product id in boot mode
-techo_1 = SupportedDevice(name="T-Echo", version="1", for_firmware="t-echo-1", device_class="nrf52",
-                              baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                              usb_vendor_id_in_hex="239a", usb_product_id_in_hex="0029")
-rak4631_5005 = SupportedDevice(name="RAK 4631 5005", version="", for_firmware="rak4631_5005",
-                               device_class="nrf52",
-                               baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                               usb_vendor_id_in_hex="239a", usb_product_id_in_hex="0029")
+techo_1 = SupportedDevice(
+    name="T-Echo",
+    version="1",
+    for_firmware="t-echo-1",
+    device_class="nrf52",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="239a",
+    usb_product_id_in_hex="0029",
+)
+rak4631_5005 = SupportedDevice(
+    name="RAK 4631 5005",
+    version="",
+    for_firmware="rak4631_5005",
+    device_class="nrf52",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="239a",
+    usb_product_id_in_hex="0029",
+)
+rak4631_5005_epaper = SupportedDevice(
+    name="RAK 4631 5005 14000 epaper",
+    version="",
+    for_firmware="rak4631_5005_epaper",
+    device_class="nrf52",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="239a",
+    usb_product_id_in_hex="0029",
+)
 # Note: The 19003 reports same product id as 5005 in boot mode
-rak4631_19003 = SupportedDevice(name="RAK 4631 19003", version="", for_firmware="rak4631_19003",
-                                device_class="nrf52",
-                                baseport_on_linux="ttyACM", baseport_on_mac="cu.usbmodem",
-                                usb_vendor_id_in_hex="239a", usb_product_id_in_hex="8029")
+rak4631_19003 = SupportedDevice(
+    name="RAK 4631 19003",
+    version="",
+    for_firmware="rak4631_19003",
+    device_class="nrf52",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="239a",
+    usb_product_id_in_hex="8029",
+)
+nano_g1 = SupportedDevice(
+    name="Nano G1",
+    version="",
+    for_firmware="nano-g1",
+    baseport_on_linux="ttyACM",
+    baseport_on_mac="cu.usbmodem",
+    usb_vendor_id_in_hex="1a86",
+    usb_product_id_in_hex="55d4",
+)
 
-supported_devices = [tbeam_v0_7, tbeam_v1_1, tbeam_M8N, tbeam_M8N_SX1262,
-                     tlora_v1_1, tlora_v1_3, tlora_v2_0, tlora_v2_1, tlora_v2_1_1_6,
-                     heltec_v1, heltec_v2_0, heltec_v2_1,
-                     meshtastic_diy_v1, techo_1, rak4631_5005, rak4631_19003,
-                     rak11200]
-
-
-def get_unique_vendor_ids():
-    """Return a set of unique vendor ids"""
-    vids = set()
-    for d in supported_devices:
-        if d.usb_vendor_id_in_hex:
-            vids.add(d.usb_vendor_id_in_hex)
-    return vids
-
-def get_devices_with_vendor_id(vid):
-    """Return a set of unique devices with the vendor id"""
-    sd = set()
-    for d in supported_devices:
-        if d.usb_vendor_id_in_hex == vid:
-            sd.add(d)
-    return sd
-
-def active_ports_on_supported_devices(sds):
-    """Return a set of active ports based on the supplied supported devices"""
-    ports = set()
-    baseports = set()
-    system = platform.system()
-
-    # figure out what possible base ports there are
-    for d in sds:
-        if system == "Linux":
-            baseports.add(d.baseport_on_linux)
-        elif system == "Darwin":
-            baseports.add(d.baseport_on_mac)
-        elif system == "Windows":
-            baseports.add(d.baseport_on_windows)
-
-    for bp in baseports:
-        if system == "Linux":
-            # see if we have any devices (ignoring any stderr output)
-            command = f'ls -al /dev/{bp}* 2> /dev/null'
-            #print(f'command:{command}')
-            _, ls_output = subprocess.getstatusoutput(command)
-            #print(f'ls_output:{ls_output}')
-            # if we got output, there are ports
-            if len(ls_output) > 0:
-                #print('got output')
-                # for each line of output
-                lines = ls_output.split('\n')
-                #print(f'lines:{lines}')
-                for line in lines:
-                    parts = line.split(' ')
-                    #print(f'parts:{parts}')
-                    port = parts[-1]
-                    #print(f'port:{port}')
-                    ports.add(port)
-        elif system == "Darwin":
-            # see if we have any devices (ignoring any stderr output)
-            command = f'ls -al /dev/{bp}* 2> /dev/null'
-            #print(f'command:{command}')
-            _, ls_output = subprocess.getstatusoutput(command)
-            #print(f'ls_output:{ls_output}')
-            # if we got output, there are ports
-            if len(ls_output) > 0:
-                #print('got output')
-                # for each line of output
-                lines = ls_output.split('\n')
-                #print(f'lines:{lines}')
-                for line in lines:
-                    parts = line.split(' ')
-                    #print(f'parts:{parts}')
-                    port = parts[-1]
-                    #print(f'port:{port}')
-                    ports.add(port)
-        elif system == "Windows":
-            # for each device in supported devices found
-            for d in sds:
-                # find the port(s)
-                com_ports = detect_windows_port(d)
-                #print(f'com_ports:{com_ports}')
-                # add all ports
-                for com_port in com_ports:
-                    ports.add(com_port)
-    return ports
-
-
-def detect_windows_port(sd):
-    """detect if Windows port"""
-    ports = set()
-
-    if sd:
-        system = platform.system()
-
-        if system == "Windows":
-            command = ('powershell.exe "[Console]::OutputEncoding = [Text.UTF8Encoding]::UTF8;'
-                       'Get-PnpDevice -PresentOnly | Where-Object{ ($_.DeviceId -like ')
-            command += f"'*{sd.usb_vendor_id_in_hex.upper()}*'"
-            command += ')} | Format-List"'
-
-            #print(f'command:{command}')
-            _, sp_output = subprocess.getstatusoutput(command)
-            #print(f'sp_output:{sp_output}')
-            p = re.compile(r'\(COM(.*)\)')
-            for x in p.findall(sp_output):
-                #print(f'x:{x}')
-                ports.add(f'COM{x}')
-    return ports
+supported_devices = [
+    tbeam_v0_7,
+    tbeam_v1_1,
+    tbeam_M8N,
+    tbeam_M8N_SX1262,
+    tlora_v1,
+    tlora_v1_3,
+    tlora_v2,
+    tlora_v2_1_1_6,
+    heltec_v1,
+    heltec_v2_0,
+    heltec_v2_1,
+    meshtastic_diy_v1,
+    techo_1,
+    rak4631_5005,
+    rak4631_5005_epaper,
+    rak4631_19003,
+    rak11200,
+    nano_g1,
+]

meshtastic/tcp_interface.py

@@ -2,15 +2,22 @@
 """
 import logging
 import socket
-from typing import AnyStr
+from typing import Optional
 
 from meshtastic.stream_interface import StreamInterface
 
+
 class TCPInterface(StreamInterface):
     """Interface class for meshtastic devices over a TCP link"""
 
-    def __init__(self, hostname: AnyStr, debugOut=None, noProto=False,
-                 connectNow=True, portNumber=4403):
+    def __init__(
+        self,
+        hostname: str,
+        debugOut=None,
+        noProto=False,
+        connectNow=True,
+        portNumber=4403,
+    ):
         """Constructor, opens a connection to a specified IP address/hostname
 
         Keyword Arguments:
@@ -23,19 +30,20 @@ class TCPInterface(StreamInterface):
         self.portNumber = portNumber
 
         if connectNow:
-            logging.debug(f"Connecting to {hostname}")
+            logging.debug(f"Connecting to {hostname}") # type: ignore[str-bytes-safe]
             server_address = (hostname, portNumber)
             sock = socket.create_connection(server_address)
-            self.socket = sock
+            self.socket: Optional[socket.socket] = sock
         else:
             self.socket = None
 
-        StreamInterface.__init__(self, debugOut=debugOut, noProto=noProto,
-                                 connectNow=connectNow)
+        StreamInterface.__init__(
+            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow
+        )
 
     def _socket_shutdown(self):
         """Shutdown the socket.
-           Note: Broke out this line so the exception could be unit tested.
+        Note: Broke out this line so the exception could be unit tested.
         """
         self.socket.shutdown(socket.SHUT_RDWR)
 

meshtastic/telemetry_pb2.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/telemetry.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1ameshtastic/telemetry.proto\x12\nmeshtastic\"\x81\x01\n\rDeviceMetrics\x12\x15\n\rbattery_level\x18\x01 \x01(\r\x12\x0f\n\x07voltage\x18\x02 \x01(\x02\x12\x1b\n\x13\x63hannel_utilization\x18\x03 \x01(\x02\x12\x13\n\x0b\x61ir_util_tx\x18\x04 \x01(\x02\x12\x16\n\x0euptime_seconds\x18\x05 \x01(\r\"\xba\x01\n\x12\x45nvironmentMetrics\x12\x13\n\x0btemperature\x18\x01 \x01(\x02\x12\x19\n\x11relative_humidity\x18\x02 \x01(\x02\x12\x1b\n\x13\x62\x61rometric_pressure\x18\x03 \x01(\x02\x12\x16\n\x0egas_resistance\x18\x04 \x01(\x02\x12\x0f\n\x07voltage\x18\x05 \x01(\x02\x12\x0f\n\x07\x63urrent\x18\x06 \x01(\x02\x12\x0b\n\x03iaq\x18\x07 \x01(\r\x12\x10\n\x08\x64istance\x18\x08 \x01(\x02\"\x8c\x01\n\x0cPowerMetrics\x12\x13\n\x0b\x63h1_voltage\x18\x01 \x01(\x02\x12\x13\n\x0b\x63h1_current\x18\x02 \x01(\x02\x12\x13\n\x0b\x63h2_voltage\x18\x03 \x01(\x02\x12\x13\n\x0b\x63h2_current\x18\x04 \x01(\x02\x12\x13\n\x0b\x63h3_voltage\x18\x05 \x01(\x02\x12\x13\n\x0b\x63h3_current\x18\x06 \x01(\x02\"\xbf\x02\n\x11\x41irQualityMetrics\x12\x15\n\rpm10_standard\x18\x01 \x01(\r\x12\x15\n\rpm25_standard\x18\x02 \x01(\r\x12\x16\n\x0epm100_standard\x18\x03 \x01(\r\x12\x1a\n\x12pm10_environmental\x18\x04 \x01(\r\x12\x1a\n\x12pm25_environmental\x18\x05 \x01(\r\x12\x1b\n\x13pm100_environmental\x18\x06 \x01(\r\x12\x16\n\x0eparticles_03um\x18\x07 \x01(\r\x12\x16\n\x0eparticles_05um\x18\x08 \x01(\r\x12\x16\n\x0eparticles_10um\x18\t \x01(\r\x12\x16\n\x0eparticles_25um\x18\n \x01(\r\x12\x16\n\x0eparticles_50um\x18\x0b \x01(\r\x12\x17\n\x0fparticles_100um\x18\x0c \x01(\r\"\x89\x02\n\tTelemetry\x12\x0c\n\x04time\x18\x01 \x01(\x07\x12\x33\n\x0e\x64\x65vice_metrics\x18\x02 \x01(\x0b\x32\x19.meshtastic.DeviceMetricsH\x00\x12=\n\x13\x65nvironment_metrics\x18\x03 \x01(\x0b\x32\x1e.meshtastic.EnvironmentMetricsH\x00\x12<\n\x13\x61ir_quality_metrics\x18\x04 \x01(\x0b\x32\x1d.meshtastic.AirQualityMetricsH\x00\x12\x31\n\rpower_metrics\x18\x05 \x01(\x0b\x32\x18.meshtastic.PowerMetricsH\x00\x42\t\n\x07variant*\xf9\x01\n\x13TelemetrySensorType\x12\x10\n\x0cSENSOR_UNSET\x10\x00\x12\n\n\x06\x42ME280\x10\x01\x12\n\n\x06\x42ME680\x10\x02\x12\x0b\n\x07MCP9808\x10\x03\x12\n\n\x06INA260\x10\x04\x12\n\n\x06INA219\x10\x05\x12\n\n\x06\x42MP280\x10\x06\x12\t\n\x05SHTC3\x10\x07\x12\t\n\x05LPS22\x10\x08\x12\x0b\n\x07QMC6310\x10\t\x12\x0b\n\x07QMI8658\x10\n\x12\x0c\n\x08QMC5883L\x10\x0b\x12\t\n\x05SHT31\x10\x0c\x12\x0c\n\x08PMSA003I\x10\r\x12\x0b\n\x07INA3221\x10\x0e\x12\n\n\x06\x42MP085\x10\x0f\x12\x0c\n\x08RCWL9620\x10\x10\x12\t\n\x05SHT4X\x10\x11\x42\x64\n\x13\x63om.geeksville.meshB\x0fTelemetryProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.telemetry_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\017TelemetryProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _TELEMETRYSENSORTYPE._serialized_start=1097
+  _TELEMETRYSENSORTYPE._serialized_end=1346
+  _DEVICEMETRICS._serialized_start=43
+  _DEVICEMETRICS._serialized_end=172
+  _ENVIRONMENTMETRICS._serialized_start=175
+  _ENVIRONMENTMETRICS._serialized_end=361
+  _POWERMETRICS._serialized_start=364
+  _POWERMETRICS._serialized_end=504
+  _AIRQUALITYMETRICS._serialized_start=507
+  _AIRQUALITYMETRICS._serialized_end=826
+  _TELEMETRY._serialized_start=829
+  _TELEMETRY._serialized_end=1094
+# @@protoc_insertion_point(module_scope)

meshtastic/telemetry_pb2.pyi

@@ -0,0 +1,478 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _TelemetrySensorType:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _TelemetrySensorTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_TelemetrySensorType.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    SENSOR_UNSET: _TelemetrySensorType.ValueType  # 0
+    """
+    No external telemetry sensor explicitly set
+    """
+    BME280: _TelemetrySensorType.ValueType  # 1
+    """
+    High accuracy temperature, pressure, humidity
+    """
+    BME680: _TelemetrySensorType.ValueType  # 2
+    """
+    High accuracy temperature, pressure, humidity, and air resistance
+    """
+    MCP9808: _TelemetrySensorType.ValueType  # 3
+    """
+    Very high accuracy temperature
+    """
+    INA260: _TelemetrySensorType.ValueType  # 4
+    """
+    Moderate accuracy current and voltage
+    """
+    INA219: _TelemetrySensorType.ValueType  # 5
+    """
+    Moderate accuracy current and voltage
+    """
+    BMP280: _TelemetrySensorType.ValueType  # 6
+    """
+    High accuracy temperature and pressure
+    """
+    SHTC3: _TelemetrySensorType.ValueType  # 7
+    """
+    High accuracy temperature and humidity
+    """
+    LPS22: _TelemetrySensorType.ValueType  # 8
+    """
+    High accuracy pressure
+    """
+    QMC6310: _TelemetrySensorType.ValueType  # 9
+    """
+    3-Axis magnetic sensor
+    """
+    QMI8658: _TelemetrySensorType.ValueType  # 10
+    """
+    6-Axis inertial measurement sensor
+    """
+    QMC5883L: _TelemetrySensorType.ValueType  # 11
+    """
+    3-Axis magnetic sensor
+    """
+    SHT31: _TelemetrySensorType.ValueType  # 12
+    """
+    High accuracy temperature and humidity
+    """
+    PMSA003I: _TelemetrySensorType.ValueType  # 13
+    """
+    PM2.5 air quality sensor
+    """
+    INA3221: _TelemetrySensorType.ValueType  # 14
+    """
+    INA3221 3 Channel Voltage / Current Sensor
+    """
+    BMP085: _TelemetrySensorType.ValueType  # 15
+    """
+    BMP085/BMP180 High accuracy temperature and pressure (older Version of BMP280)
+    """
+    RCWL9620: _TelemetrySensorType.ValueType  # 16
+    """
+    RCWL-9620 Doppler Radar Distance Sensor, used for water level detection
+    """
+    SHT4X: _TelemetrySensorType.ValueType  # 17
+    """
+    Sensirion High accuracy temperature and humidity
+    """
+
+class TelemetrySensorType(_TelemetrySensorType, metaclass=_TelemetrySensorTypeEnumTypeWrapper):
+    """
+    Supported I2C Sensors for telemetry in Meshtastic
+    """
+
+SENSOR_UNSET: TelemetrySensorType.ValueType  # 0
+"""
+No external telemetry sensor explicitly set
+"""
+BME280: TelemetrySensorType.ValueType  # 1
+"""
+High accuracy temperature, pressure, humidity
+"""
+BME680: TelemetrySensorType.ValueType  # 2
+"""
+High accuracy temperature, pressure, humidity, and air resistance
+"""
+MCP9808: TelemetrySensorType.ValueType  # 3
+"""
+Very high accuracy temperature
+"""
+INA260: TelemetrySensorType.ValueType  # 4
+"""
+Moderate accuracy current and voltage
+"""
+INA219: TelemetrySensorType.ValueType  # 5
+"""
+Moderate accuracy current and voltage
+"""
+BMP280: TelemetrySensorType.ValueType  # 6
+"""
+High accuracy temperature and pressure
+"""
+SHTC3: TelemetrySensorType.ValueType  # 7
+"""
+High accuracy temperature and humidity
+"""
+LPS22: TelemetrySensorType.ValueType  # 8
+"""
+High accuracy pressure
+"""
+QMC6310: TelemetrySensorType.ValueType  # 9
+"""
+3-Axis magnetic sensor
+"""
+QMI8658: TelemetrySensorType.ValueType  # 10
+"""
+6-Axis inertial measurement sensor
+"""
+QMC5883L: TelemetrySensorType.ValueType  # 11
+"""
+3-Axis magnetic sensor
+"""
+SHT31: TelemetrySensorType.ValueType  # 12
+"""
+High accuracy temperature and humidity
+"""
+PMSA003I: TelemetrySensorType.ValueType  # 13
+"""
+PM2.5 air quality sensor
+"""
+INA3221: TelemetrySensorType.ValueType  # 14
+"""
+INA3221 3 Channel Voltage / Current Sensor
+"""
+BMP085: TelemetrySensorType.ValueType  # 15
+"""
+BMP085/BMP180 High accuracy temperature and pressure (older Version of BMP280)
+"""
+RCWL9620: TelemetrySensorType.ValueType  # 16
+"""
+RCWL-9620 Doppler Radar Distance Sensor, used for water level detection
+"""
+SHT4X: TelemetrySensorType.ValueType  # 17
+"""
+Sensirion High accuracy temperature and humidity
+"""
+global___TelemetrySensorType = TelemetrySensorType
+
+@typing_extensions.final
+class DeviceMetrics(google.protobuf.message.Message):
+    """
+    Key native device metrics such as battery level
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    BATTERY_LEVEL_FIELD_NUMBER: builtins.int
+    VOLTAGE_FIELD_NUMBER: builtins.int
+    CHANNEL_UTILIZATION_FIELD_NUMBER: builtins.int
+    AIR_UTIL_TX_FIELD_NUMBER: builtins.int
+    UPTIME_SECONDS_FIELD_NUMBER: builtins.int
+    battery_level: builtins.int
+    """
+    0-100 (>100 means powered)
+    """
+    voltage: builtins.float
+    """
+    Voltage measured
+    """
+    channel_utilization: builtins.float
+    """
+    Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise).
+    """
+    air_util_tx: builtins.float
+    """
+    Percent of airtime for transmission used within the last hour.
+    """
+    uptime_seconds: builtins.int
+    """
+    How long the device has been running since the last reboot (in seconds)
+    """
+    def __init__(
+        self,
+        *,
+        battery_level: builtins.int = ...,
+        voltage: builtins.float = ...,
+        channel_utilization: builtins.float = ...,
+        air_util_tx: builtins.float = ...,
+        uptime_seconds: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["air_util_tx", b"air_util_tx", "battery_level", b"battery_level", "channel_utilization", b"channel_utilization", "uptime_seconds", b"uptime_seconds", "voltage", b"voltage"]) -> None: ...
+
+global___DeviceMetrics = DeviceMetrics
+
+@typing_extensions.final
+class EnvironmentMetrics(google.protobuf.message.Message):
+    """
+    Weather station or other environmental metrics
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    TEMPERATURE_FIELD_NUMBER: builtins.int
+    RELATIVE_HUMIDITY_FIELD_NUMBER: builtins.int
+    BAROMETRIC_PRESSURE_FIELD_NUMBER: builtins.int
+    GAS_RESISTANCE_FIELD_NUMBER: builtins.int
+    VOLTAGE_FIELD_NUMBER: builtins.int
+    CURRENT_FIELD_NUMBER: builtins.int
+    IAQ_FIELD_NUMBER: builtins.int
+    DISTANCE_FIELD_NUMBER: builtins.int
+    temperature: builtins.float
+    """
+    Temperature measured
+    """
+    relative_humidity: builtins.float
+    """
+    Relative humidity percent measured
+    """
+    barometric_pressure: builtins.float
+    """
+    Barometric pressure in hPA measured
+    """
+    gas_resistance: builtins.float
+    """
+    Gas resistance in MOhm measured
+    """
+    voltage: builtins.float
+    """
+    Voltage measured (To be depreciated in favor of PowerMetrics in Meshtastic 3.x)
+    """
+    current: builtins.float
+    """
+    Current measured (To be depreciated in favor of PowerMetrics in Meshtastic 3.x)
+    """
+    iaq: builtins.int
+    """
+    relative scale IAQ value as measured by Bosch BME680 . value 0-500.
+    Belongs to Air Quality but is not particle but VOC measurement. Other VOC values can also be put in here.
+    """
+    distance: builtins.float
+    """
+    RCWL9620 Doppler Radar Distance Sensor, used for water level detection. Float value in mm.
+    """
+    def __init__(
+        self,
+        *,
+        temperature: builtins.float = ...,
+        relative_humidity: builtins.float = ...,
+        barometric_pressure: builtins.float = ...,
+        gas_resistance: builtins.float = ...,
+        voltage: builtins.float = ...,
+        current: builtins.float = ...,
+        iaq: builtins.int = ...,
+        distance: builtins.float = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["barometric_pressure", b"barometric_pressure", "current", b"current", "distance", b"distance", "gas_resistance", b"gas_resistance", "iaq", b"iaq", "relative_humidity", b"relative_humidity", "temperature", b"temperature", "voltage", b"voltage"]) -> None: ...
+
+global___EnvironmentMetrics = EnvironmentMetrics
+
+@typing_extensions.final
+class PowerMetrics(google.protobuf.message.Message):
+    """
+    Power Metrics (voltage / current / etc)
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CH1_VOLTAGE_FIELD_NUMBER: builtins.int
+    CH1_CURRENT_FIELD_NUMBER: builtins.int
+    CH2_VOLTAGE_FIELD_NUMBER: builtins.int
+    CH2_CURRENT_FIELD_NUMBER: builtins.int
+    CH3_VOLTAGE_FIELD_NUMBER: builtins.int
+    CH3_CURRENT_FIELD_NUMBER: builtins.int
+    ch1_voltage: builtins.float
+    """
+    Voltage (Ch1)
+    """
+    ch1_current: builtins.float
+    """
+    Current (Ch1)
+    """
+    ch2_voltage: builtins.float
+    """
+    Voltage (Ch2)
+    """
+    ch2_current: builtins.float
+    """
+    Current (Ch2)
+    """
+    ch3_voltage: builtins.float
+    """
+    Voltage (Ch3)
+    """
+    ch3_current: builtins.float
+    """
+    Current (Ch3)
+    """
+    def __init__(
+        self,
+        *,
+        ch1_voltage: builtins.float = ...,
+        ch1_current: builtins.float = ...,
+        ch2_voltage: builtins.float = ...,
+        ch2_current: builtins.float = ...,
+        ch3_voltage: builtins.float = ...,
+        ch3_current: builtins.float = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["ch1_current", b"ch1_current", "ch1_voltage", b"ch1_voltage", "ch2_current", b"ch2_current", "ch2_voltage", b"ch2_voltage", "ch3_current", b"ch3_current", "ch3_voltage", b"ch3_voltage"]) -> None: ...
+
+global___PowerMetrics = PowerMetrics
+
+@typing_extensions.final
+class AirQualityMetrics(google.protobuf.message.Message):
+    """
+    Air quality metrics
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PM10_STANDARD_FIELD_NUMBER: builtins.int
+    PM25_STANDARD_FIELD_NUMBER: builtins.int
+    PM100_STANDARD_FIELD_NUMBER: builtins.int
+    PM10_ENVIRONMENTAL_FIELD_NUMBER: builtins.int
+    PM25_ENVIRONMENTAL_FIELD_NUMBER: builtins.int
+    PM100_ENVIRONMENTAL_FIELD_NUMBER: builtins.int
+    PARTICLES_03UM_FIELD_NUMBER: builtins.int
+    PARTICLES_05UM_FIELD_NUMBER: builtins.int
+    PARTICLES_10UM_FIELD_NUMBER: builtins.int
+    PARTICLES_25UM_FIELD_NUMBER: builtins.int
+    PARTICLES_50UM_FIELD_NUMBER: builtins.int
+    PARTICLES_100UM_FIELD_NUMBER: builtins.int
+    pm10_standard: builtins.int
+    """
+    Concentration Units Standard PM1.0
+    """
+    pm25_standard: builtins.int
+    """
+    Concentration Units Standard PM2.5
+    """
+    pm100_standard: builtins.int
+    """
+    Concentration Units Standard PM10.0
+    """
+    pm10_environmental: builtins.int
+    """
+    Concentration Units Environmental PM1.0
+    """
+    pm25_environmental: builtins.int
+    """
+    Concentration Units Environmental PM2.5
+    """
+    pm100_environmental: builtins.int
+    """
+    Concentration Units Environmental PM10.0
+    """
+    particles_03um: builtins.int
+    """
+    0.3um Particle Count
+    """
+    particles_05um: builtins.int
+    """
+    0.5um Particle Count
+    """
+    particles_10um: builtins.int
+    """
+    1.0um Particle Count
+    """
+    particles_25um: builtins.int
+    """
+    2.5um Particle Count
+    """
+    particles_50um: builtins.int
+    """
+    5.0um Particle Count
+    """
+    particles_100um: builtins.int
+    """
+    10.0um Particle Count
+    """
+    def __init__(
+        self,
+        *,
+        pm10_standard: builtins.int = ...,
+        pm25_standard: builtins.int = ...,
+        pm100_standard: builtins.int = ...,
+        pm10_environmental: builtins.int = ...,
+        pm25_environmental: builtins.int = ...,
+        pm100_environmental: builtins.int = ...,
+        particles_03um: builtins.int = ...,
+        particles_05um: builtins.int = ...,
+        particles_10um: builtins.int = ...,
+        particles_25um: builtins.int = ...,
+        particles_50um: builtins.int = ...,
+        particles_100um: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["particles_03um", b"particles_03um", "particles_05um", b"particles_05um", "particles_100um", b"particles_100um", "particles_10um", b"particles_10um", "particles_25um", b"particles_25um", "particles_50um", b"particles_50um", "pm100_environmental", b"pm100_environmental", "pm100_standard", b"pm100_standard", "pm10_environmental", b"pm10_environmental", "pm10_standard", b"pm10_standard", "pm25_environmental", b"pm25_environmental", "pm25_standard", b"pm25_standard"]) -> None: ...
+
+global___AirQualityMetrics = AirQualityMetrics
+
+@typing_extensions.final
+class Telemetry(google.protobuf.message.Message):
+    """
+    Types of Measurements the telemetry module is equipped to handle
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    TIME_FIELD_NUMBER: builtins.int
+    DEVICE_METRICS_FIELD_NUMBER: builtins.int
+    ENVIRONMENT_METRICS_FIELD_NUMBER: builtins.int
+    AIR_QUALITY_METRICS_FIELD_NUMBER: builtins.int
+    POWER_METRICS_FIELD_NUMBER: builtins.int
+    time: builtins.int
+    """
+    Seconds since 1970 - or 0 for unknown/unset
+    """
+    @property
+    def device_metrics(self) -> global___DeviceMetrics:
+        """
+        Key native device metrics such as battery level
+        """
+    @property
+    def environment_metrics(self) -> global___EnvironmentMetrics:
+        """
+        Weather station or other environmental metrics
+        """
+    @property
+    def air_quality_metrics(self) -> global___AirQualityMetrics:
+        """
+        Air quality metrics
+        """
+    @property
+    def power_metrics(self) -> global___PowerMetrics:
+        """
+        Power Metrics
+        """
+    def __init__(
+        self,
+        *,
+        time: builtins.int = ...,
+        device_metrics: global___DeviceMetrics | None = ...,
+        environment_metrics: global___EnvironmentMetrics | None = ...,
+        air_quality_metrics: global___AirQualityMetrics | None = ...,
+        power_metrics: global___PowerMetrics | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["air_quality_metrics", b"air_quality_metrics", "device_metrics", b"device_metrics", "environment_metrics", b"environment_metrics", "power_metrics", b"power_metrics", "variant", b"variant"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["air_quality_metrics", b"air_quality_metrics", "device_metrics", b"device_metrics", "environment_metrics", b"environment_metrics", "power_metrics", b"power_metrics", "time", b"time", "variant", b"variant"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["variant", b"variant"]) -> typing_extensions.Literal["device_metrics", "environment_metrics", "air_quality_metrics", "power_metrics"] | None: ...
+
+global___Telemetry = Telemetry

meshtastic/test.py

@@ -2,17 +2,18 @@
    messages and report back if successful.
 """
 import logging
-import time
 import sys
+import time
 import traceback
-from dotmap import DotMap
-from pubsub import pub
+
+from dotmap import DotMap # type: ignore[import-untyped]
+from pubsub import pub # type: ignore[import-untyped]
+
 import meshtastic.util
-from meshtastic.__init__ import BROADCAST_NUM
+from meshtastic import BROADCAST_NUM
 from meshtastic.serial_interface import SerialInterface
 from meshtastic.tcp_interface import TCPInterface
 
-
 """The interfaces we are using for our tests"""
 interfaces = None
 
@@ -52,7 +53,9 @@ def subscribe():
     pub.subscribe(onNode, "meshtastic.node")
 
 
-def testSend(fromInterface, toInterface, isBroadcast=False, asBinary=False, wantAck=False):
+def testSend(
+    fromInterface, toInterface, isBroadcast=False, asBinary=False, wantAck=False
+):
     """
     Sends one test packet between two nodes and then returns success or failure
 
@@ -73,19 +76,19 @@ def testSend(fromInterface, toInterface, isBroadcast=False, asBinary=False, want
     else:
         toNode = toInterface.myInfo.my_node_num
 
-    logging.debug(
-        f"Sending test wantAck={wantAck} packet from {fromNode} to {toNode}")
+    logging.debug(f"Sending test wantAck={wantAck} packet from {fromNode} to {toNode}")
     # pylint: disable=W0603
     global sendingInterface
     sendingInterface = fromInterface
     if not asBinary:
         fromInterface.sendText(f"Test {testNumber}", toNode, wantAck=wantAck)
     else:
-        fromInterface.sendData((f"Binary {testNumber}").encode(
-            "utf-8"), toNode, wantAck=wantAck)
+        fromInterface.sendData(
+            (f"Binary {testNumber}").encode("utf-8"), toNode, wantAck=wantAck
+        )
     for _ in range(60):  # max of 60 secs before we timeout
         time.sleep(1)
-        if  len(receivedPackets) >= 1:
+        if len(receivedPackets) >= 1:
             return True
     return False  # Failed to send
 
@@ -102,15 +105,18 @@ def runTests(numTests=50, wantAck=False, maxFailures=0):
         isBroadcast = True
         # asBinary=(i % 2 == 0)
         success = testSend(
-            interfaces[0], interfaces[1], isBroadcast, asBinary=False, wantAck=wantAck)
+            interfaces[0], interfaces[1], isBroadcast, asBinary=False, wantAck=wantAck
+        )
         if not success:
             numFail = numFail + 1
             logging.error(
-                f"Test {testNumber} failed, expected packet not received ({numFail} failures so far)")
+                f"Test {testNumber} failed, expected packet not received ({numFail} failures so far)"
+            )
         else:
             numSuccess = numSuccess + 1
             logging.info(
-                f"Test {testNumber} succeeded {numSuccess} successes {numFail} failures so far")
+                f"Test {testNumber} succeeded {numSuccess} successes {numFail} failures so far"
+            )
 
         time.sleep(1)
 
@@ -140,7 +146,7 @@ def openDebugLog(portName):
     """Open the debug log file"""
     debugname = "log" + portName.replace("/", "_")
     logging.info(f"Writing serial debugging to {debugname}")
-    return open(debugname, 'w+', buffering=1, encoding='utf8')
+    return open(debugname, "w+", buffering=1, encoding="utf8")
 
 
 def testAll(numTests=5):
@@ -151,14 +157,22 @@ def testAll(numTests=5):
     """
     ports = meshtastic.util.findPorts(True)
     if len(ports) < 2:
-        meshtastic.util.our_exit("Warning: Must have at least two devices connected to USB.")
+        meshtastic.util.our_exit(
+            "Warning: Must have at least two devices connected to USB."
+        )
 
     pub.subscribe(onConnection, "meshtastic.connection")
     pub.subscribe(onReceive, "meshtastic.receive")
     # pylint: disable=W0603
     global interfaces
-    interfaces = list(map(lambda port: SerialInterface(
-        port, debugOut=openDebugLog(port), connectNow=True), ports))
+    interfaces = list(
+        map(
+            lambda port: SerialInterface(
+                port, debugOut=openDebugLog(port), connectNow=True
+            ),
+            ports,
+        )
+    )
 
     logging.info("Ports opened, starting test")
     result = testThread(numTests)

meshtastic/tests/conftest.py

@@ -1,57 +1,56 @@
 """Common pytest code (place for fixtures)."""
 
 import argparse
-
 from unittest.mock import MagicMock
+
 import pytest
 
-from meshtastic.__main__ import Globals
+from meshtastic import mt_config
+
 from ..mesh_interface import MeshInterface
 
 
 @pytest.fixture
-def reset_globals():
-    """Fixture to reset globals."""
+def reset_mt_config():
+    """Fixture to reset mt_config."""
     parser = None
-    parser = argparse.ArgumentParser()
-    Globals.getInstance().reset()
-    Globals.getInstance().set_parser(parser)
+    parser = argparse.ArgumentParser(add_help=False)
+    mt_config.reset()
+    mt_config.parser = parser
 
 
 @pytest.fixture
 def iface_with_nodes():
     """Fixture to setup some nodes."""
     nodesById = {
-            '!9388f81c': {
-                'num': 2475227164,
-                'user': {
-                    'id': '!9388f81c',
-                    'longName': 'Unknown f81c',
-                    'shortName': '?1C',
-                    'macaddr': 'RBeTiPgc',
-                    'hwModel': 'TBEAM'
-                    },
-                'position': {},
-                'lastHeard': 1640204888
-                }
-            }
+        "!9388f81c": {
+            "num": 2475227164,
+            "user": {
+                "id": "!9388f81c",
+                "longName": "Unknown f81c",
+                "shortName": "?1C",
+                "macaddr": "RBeTiPgc",
+                "hwModel": "TBEAM",
+            },
+            "position": {},
+            "lastHeard": 1640204888,
+        }
+    }
 
     nodesByNum = {
-            2475227164: {
-                'num': 2475227164,
-                'user': {
-                    'id': '!9388f81c',
-                    'longName': 'Unknown f81c',
-                    'shortName': '?1C',
-                    'macaddr': 'RBeTiPgc',
-                    'hwModel': 'TBEAM'
-                    },
-                'position': {
-                    'time': 1640206266
-                    },
-                'lastHeard': 1640206266
-                }
-            }
+        2475227164: {
+            "num": 2475227164,
+            "user": {
+                "id": "!9388f81c",
+                "longName": "Unknown f81c",
+                "shortName": "?1C",
+                "macaddr": "RBeTiPgc",
+                "hwModel": "TBEAM",
+            },
+            "position": {"time": 1640206266},
+            "lastHeard": 1640206266,
+        }
+    }
     iface = MeshInterface(noProto=True)
     iface.nodes = nodesById
     iface.nodesByNum = nodesByNum

meshtastic/tests/test_ble_interface.py

@@ -1,15 +0,0 @@
-"""Meshtastic unit tests for ble_interface.py"""
-
-
-from unittest.mock import patch
-import pytest
-
-from ..ble_interface import BLEInterface
-
-@pytest.mark.unit
-@patch('platform.system', return_value='Linux')
-def test_BLEInterface(mock_platform):
-    """Test that we can instantiate a BLEInterface"""
-    iface = BLEInterface('foo', debugOut=True, noProto=True)
-    iface.close()
-    mock_platform.assert_called()

meshtastic/tests/test_examples.py

@@ -6,19 +6,24 @@ import subprocess
 
 import pytest
 
+
 @pytest.mark.examples
 def test_examples_hello_world_serial_no_arg():
     """Test hello_world_serial without any args"""
-    return_value, _ = subprocess.getstatusoutput('source venv/bin/activate; python3 examples/hello_world_serial.py')
+    return_value, _ = subprocess.getstatusoutput(
+        "source venv/bin/activate; python3 examples/hello_world_serial.py"
+    )
     assert return_value == 3
 
 
 @pytest.mark.examples
 def test_examples_hello_world_serial_with_arg(capsys):
     """Test hello_world_serial with arg"""
-    return_value, _ = subprocess.getstatusoutput('source venv/bin/activate; python3 examples/hello_world_serial.py hello')
+    return_value, _ = subprocess.getstatusoutput(
+        "source venv/bin/activate; python3 examples/hello_world_serial.py hello"
+    )
     assert return_value == 1
     _, err = capsys.readouterr()
-    assert err == ''
+    assert err == ""
     # TODO: Why does this not work?
     # assert out == 'Warning: No Meshtastic devices detected.'

meshtastic/tests/test_globals.py

@@ -1,25 +0,0 @@
-"""Meshtastic unit tests for globals.py
-"""
-
-import pytest
-
-from ..globals import Globals
-
-
-@pytest.mark.unit
-def test_globals_get_instaance():
-    """Test that we can instantiate a Globals instance"""
-    ourglobals = Globals.getInstance()
-    ourglobals2 = Globals.getInstance()
-    assert ourglobals == ourglobals2
-
-
-@pytest.mark.unit
-def test_globals_there_can_be_only_one():
-    """Test that we can cannot create two Globals instances"""
-    # if we have an instance, delete it
-    Globals.getInstance()
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        # try to create another instance
-        Globals()
-    assert pytest_wrapped_e.type == Exception

meshtastic/tests/test_init.py

@@ -1,61 +1,56 @@
 """Meshtastic unit tests for __init__.py"""
 
-import re
 import logging
-
+import re
 from unittest.mock import MagicMock
+
 import pytest
 
-from meshtastic.__init__ import _onTextReceive, _onPositionReceive, _onNodeInfoReceive
+from meshtastic import _onNodeInfoReceive, _onPositionReceive, _onTextReceive, mt_config
+
 from ..serial_interface import SerialInterface
-from ..globals import Globals
 
 
 @pytest.mark.unit
 def test_init_onTextReceive_with_exception(caplog):
     """Test _onTextReceive"""
     args = MagicMock()
-    Globals.getInstance().set_args(args)
+    mt_config.args = args
     iface = MagicMock(autospec=SerialInterface)
     packet = {}
     with caplog.at_level(logging.DEBUG):
         _onTextReceive(iface, packet)
-    assert re.search(r'in _onTextReceive', caplog.text, re.MULTILINE)
-    assert re.search(r'Malformatted', caplog.text, re.MULTILINE)
+    assert re.search(r"in _onTextReceive", caplog.text, re.MULTILINE)
+    assert re.search(r"Malformatted", caplog.text, re.MULTILINE)
 
 
 @pytest.mark.unit
 def test_init_onPositionReceive(caplog):
     """Test _onPositionReceive"""
     args = MagicMock()
-    Globals.getInstance().set_args(args)
+    mt_config.args = args
     iface = MagicMock(autospec=SerialInterface)
-    packet = {
-            'from': 'foo',
-            'decoded': {
-                'position': {}
-                }
-            }
+    packet = {"from": "foo", "decoded": {"position": {}}}
     with caplog.at_level(logging.DEBUG):
         _onPositionReceive(iface, packet)
-    assert re.search(r'in _onPositionReceive', caplog.text, re.MULTILINE)
+    assert re.search(r"in _onPositionReceive", caplog.text, re.MULTILINE)
 
 
 @pytest.mark.unit
 def test_init_onNodeInfoReceive(caplog, iface_with_nodes):
     """Test _onNodeInfoReceive"""
     args = MagicMock()
-    Globals.getInstance().set_args(args)
+    mt_config.args = args
     iface = iface_with_nodes
     iface.myInfo.my_node_num = 2475227164
     packet = {
-            'from': 'foo',
-            'decoded': {
-                'user': {
-                    'id': 'bar',
-                    },
-                }
-            }
+        "from": "foo",
+        "decoded": {
+            "user": {
+                "id": "bar",
+            },
+        },
+    }
     with caplog.at_level(logging.DEBUG):
         _onNodeInfoReceive(iface, packet)
-    assert re.search(r'in _onNodeInfoReceive', caplog.text, re.MULTILINE)
+    assert re.search(r"in _onNodeInfoReceive", caplog.text, re.MULTILINE)