protobufs: v2.7.15

Add a bunch more detail to --device-metadata output, from fields we weren't formerly using in the output.

.coveragerc

@@ -1,5 +1,5 @@
 [run]
-omit = meshtastic/*_pb2.py,meshtastic/tests/*.py,meshtastic/test.py
+omit = meshtastic/protobuf/*_pb2.py,meshtastic/tests/*.py,meshtastic/test.py
 
 [report]
 exclude_lines =

.gitattributes

@@ -0,0 +1,5 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
+*.{sh,[sS][hH]} text eol=lf
+meshtastic/protobuf/* linguist-generated=true

.github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to Meshtastic Python
+
+## Development resources
+- [API Documentation](https://python.meshtastic.org/)
+- [Meshtastic Python Development](https://meshtastic.org/docs/development/python/)
+- [Building Meshtastic Python](https://meshtastic.org/docs/development/python/building/)
+- [Using the Meshtastic Python Library](https://meshtastic.org/docs/development/python/library/)
+
+## How to check your code (pytest/pylint) before a PR
+- [Pre-requisites](https://meshtastic.org/docs/development/python/building/#pre-requisites)
+- also execute `poetry install --all-extras --with dev,powermon` for all optional dependencies
+- check your code with github ci actions locally
+    - You need to have act installed. You can get it at https://nektosact.com/ 
+    - on linux: `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
+    - on windows:
+      - linux checks (linux docker): `act --matrix "python-version:3.12"`
+      - windows checks (windows host): `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
+- or run all locally:
+    - run `poetry run pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"`
+    - run `poetry run mypy meshtastic/`
+    - run `poetry run pytest`
+    - more commands see [CI workflow](https://github.com/meshtastic/python/blob/master/.github/workflows/ci.yml)

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Linting and Tests
+name: CI
 on:
   push:
     branches:
@@ -13,59 +13,60 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.6"
-          - "3.7"
-          - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
+          - "3.12"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install Python 3
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
       - name: Uninstall meshtastic
         run: |
-          pip3 uninstall meshtastic
+          pip3 uninstall -y meshtastic
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip3 install -r requirements.txt
+          pip3 install poetry
       - name: Install meshtastic from local
         run: |
-          pip3 install .
+          poetry install --all-extras --with dev,powermon
-          which meshtastic
+          poetry run meshtastic --version
-          meshtastic --version
       - name: Run pylint
-        run: pylint meshtastic
+        run: poetry run pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"
+      - name: Check types with mypy
+        run: poetry run mypy meshtastic/
       - name: Run tests with pytest
-        run: pytest --cov=meshtastic
+        run: poetry run pytest --cov=meshtastic
       - name: Generate coverage report
         run: |
-          pytest --cov=meshtastic --cov-report=xml
+          poetry 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"
+          - "3.12"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install Python 3
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
       - name: Install meshtastic from local
         run: |
-          pip3 install .
+          python -m pip install --upgrade pip
-          which meshtastic
+          pip3 install poetry
-          meshtastic --version
+          poetry install
+          poetry run meshtastic --version

.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,60 +1,66 @@
 name: Make Release
-on:
+on: workflow_dispatch
-  workflow_dispatch:
-    inputs:
-      version:
-        description: "Release version (Example: 1.0.0, must match 'version' in setup.py)"
-        required: true
-        default: '1.0.0'
 
 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
+        uses: actions/checkout@v4
 
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.9"
 
-      - name: Install pypa/build
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip3 install poetry
+
+      - name: Bump version
         run: >-
-          python -m
+          poetry version patch
-          pip install
+
-          build
+      - name: Get version
-          --user
+        id: get_version
+        run: >-
+          poetry version --short | sed 's/^/::set-output name=version::/'
+
+      - name: Commit updated version.
+        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 pyproject.toml
+          git commit -m "bump version to ${{ steps.get_version.outputs.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: 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 }}
+          commitish: ${{ steps.commit_updated.outputs.sha }}
+          body: |
+            Autogenerated by github action, developer should edit as required before publishing...
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build a binary wheel and a source tarball
         run: >-
-          python -m
+          poetry build
-          build
-          --sdist
-          --wheel
-          --outdir dist/
-          .
 
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@master
@@ -62,71 +68,70 @@ 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@v4
+  #       with:
+  #         ref: ${{ needs.release_create.outputs.new_sha }}
 
-  build-and-publish-mac:
+  #     - name: Set up Python 3.9
-    runs-on: macos-latest
+  #       uses: actions/setup-python@v5
-    needs: release_create
+  #       with:
-    steps:
+  #         python-version: "3.9"
 
-      - name: Checkout
+  #     - name: Setup code signing
-        uses: actions/checkout@v2
+  #       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
+  #     - name: Build
-        uses: actions/setup-python@v2
+  #       env:
-        with:
+  #         MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
-          python-version: 3.9
+  #       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
+  #     - name: Add mac to release
-        env:
+  #       uses: actions/upload-release-asset@v1
-          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
+  #       env:
-          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
+  #       with:
-        run: |
+  #         upload_url: ${{ needs.release_create.outputs.upload_url }}
-          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
+  #         asset_path: dist/meshtastic
-          security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+  #         asset_name: meshtastic_mac
-          security default-keychain -s meshtastic.keychain
+  #         asset_content_type: application/zip
-          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
 
   build-and-publish-ubuntu:
     runs-on: ubuntu-latest
     needs: release_create
     steps:
-
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.release_create.outputs.new_sha }}
 
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.9"
 
       - name: Build
         run: |
-          pip install pyinstaller
+          pip install poetry
-          pip install -r requirements.txt
+          bin/build-bin.sh
-          pip install .
-          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
 
       - name: Add ubuntu to release
         uses: actions/upload-release-asset@v1
@@ -148,32 +153,31 @@ jobs:
           asset_name: readme.txt
           asset_content_type: text/plain
 
-  build-and-publish-windows:
+  # build-and-publish-windows:
-    runs-on: windows-latest
+  #   runs-on: windows-latest
-    needs: release_create
+  #   needs: release_create
-    steps:
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v4
+  #       with:
+  #         ref: ${{ needs.release_create.outputs.new_sha }}
 
-      - name: Checkout
+  #     - name: Set up Python 3.9
-        uses: actions/checkout@v2
+  #       uses: actions/setup-python@v5
+  #       with:
+  #         python-version: "3.9"
 
-      - name: Set up Python 3.9
+  #     - name: Build
-        uses: actions/setup-python@v2
+  #       run: |
-        with:
+  #         pip install poetry
-          python-version: 3.9
+  #         bin/build-bin.sh
 
-      - name: Build
+  #     - name: Add windows to release
-        run: |
+  #       uses: actions/upload-release-asset@v1
-          pip install pyinstaller
+  #       env:
-          pip install -r requirements.txt
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          pip install .
+  #       with:
-          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
+  #         upload_url: ${{ needs.release_create.outputs.upload_url }}
-
+  #         asset_path: dist/meshtastic.exe
-      - name: Add windows to release
+  #         asset_name: meshtastic_windows
-        uses: actions/upload-release-asset@v1
+  #         asset_content_type: application/zip
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.release_create.outputs.upload_url }}
-          asset_path: dist/meshtastic.exe
-          asset_name: meshtastic_windows
-          asset_content_type: application/zip

.github/workflows/update_protobufs.yml

@@ -7,7 +7,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           submodules: true
 
@@ -18,18 +18,24 @@ jobs:
 
       - name: Download nanopb
         run: |
-          wget https://jpa.kapsi.fi/nanopb/download/nanopb-0.4.4-linux-x86.tar.gz
+          wget https://jpa.kapsi.fi/nanopb/download/nanopb-0.4.8-linux-x86.tar.gz
-          tar xvzf nanopb-0.4.4-linux-x86.tar.gz
+          tar xvzf nanopb-0.4.8-linux-x86.tar.gz
-          mv nanopb-0.4.4-linux-x86 nanopb-0.4.4
+          mv nanopb-0.4.8-linux-x86 nanopb-0.4.8
+
+      - name: Install poetry (needed by regen-protobufs.sh)
+        run: |
+          python -m pip install --upgrade pip
+          pip3 install poetry
 
       - 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/protobuf
           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
@@ -15,3 +15,7 @@ venv/
 __pycache__
 examples/__pycache__
 meshtastic.spec
+.hypothesis/
+coverage.xml
+.ipynb_checkpoints
+.cursor/

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "proto"]
+[submodule "protobufs"]
-	path = proto
+	path = protobufs
-	url = https://github.com/meshtastic/Meshtastic-protobufs.git
+	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,nested-min-max
-
 
 [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
 
 
 

.reuse/dep5

@@ -0,0 +1,64 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: Meshtastic Python
+Upstream-Contact: Various Authors
+Source: https://github.com/meshtastic/python
+
+Files: *
+Copyright:
+ 2020-2020 Nils Werner <nils@hey.com>
+ 2020-2020 Paul Vivier <github@vivier.net>
+ 2020-2020 Tim Gunter <tgunter+github@gmail.com>
+ 2020-2021 Charles Crossan <crossan007@gmail.com>
+ 2020-2021 IZ1IVA
+ 2020-2022 Jm Casler <jm@casler.org>
+ 2020-2024 geeksville <kevinh@geeksville.com>
+ 2021-2021 Andrew Cabey <me@acabey.xyz>
+ 2021-2021 dylan <eris.has.a.dad+github@gmail.com>
+ 2021-2021 Fabian Affolter <mail@fabian-affolter.ch>
+ 2021-2021 Foster Irwin <foster@jfirwin.com>
+ 2021-2021 Manuel Giolo <iz1kga@gmail.com>
+ 2021-2021 meehow <michal@ert.pl>
+ 2021-2021 srichs
+ 2021-2021 ChuckNorrison
+ 2021-2021 Aivaras-s
+ 2021-2021 a-f-G-U-C
+ 2021-2021 <Beiri22ny@googlemail.com>
+ 2021-2021 jdstroy
+ 2021-2021 linagee
+ 2021-2021 Simonas <simonas@5grupe.lt>
+ 2021-2022 <mike.kinney@gmail.com>
+ 2021-2023 Sacha Weatherstone <sachaw100@hotmail.com>
+ 2021-2024 Ben Meadors <benmmeadors@gmail.com>
+ 2022-2022 Balázs Kelemen <10376327+prampec
+ 2022-2022 <akadd8@gmail.com>
+ 2022-2022 <a.merino.jimenez@gmail.com>
+ 2022-2022 <ghostop14@gmail.com>
+ 2022-2022 <git@schiraldi.org>
+ 2022-2022 <pavel.b@techspark.engineering>
+ 2022-2022 Rohan King <king.rohan.ja@gmail.com>
+ 2022-2022 Tom Douile
+ 2022-2023 Thomas Göttgens <tgoettgens@gmail.com>
+ 2022-2024 thijs@havinga.eu>
+ 2023-2023 Eli Schleifer <eli@trunk.io>
+ 2023-2023 Manuel <manuel.verch@gmx.de>
+ 2023-2023 Marek Küthe <m.k@mk16.de>
+ 2023-2023 <benlipsey@gmail.com>
+ 2023-2023 <dwelch@structuralcomponents.net>
+ 2023-2023 <henrichhartzer@tuta.io>
+ 2023-2023 luzpaz
+ 2023-2023 <sb@liztv.net>
+ 2023-2023 Toby Murray <toby.murray@protonmail.com>
+ 2023-2024 Brad Midgley <bmidgley@gmail.com>
+ 2024-2024 Ian McEwen <ianmcorvidae@ianmcorvidae.net>
+ 2024-2024 John Hollowell <jhollowe@johnhollowell.com>
+ 2024-2024 Jonathan Bennett <jbennett@incomsystems.biz>
+ 2024-2024 <danwelch3@gmail.com>
+ 2024-2024 <god@yahoo.com>
+ 2024-2024 <herbert.todd@gmail.com>
+ 2024-2024 <jorropo.pgm@gmail.com>
+ 2024-2024 rc14193 <emdort@gmail.com>
+ 2024-2024 Steve Holden <steve@holdenweb.com>
+ 2024-2024 Thomas Herrmann <mail@thoherr.de>
+ 2024-2024 Timothy Harder <harder.timothy.j@gmail.com>
+ 2024-2024 Wolfgang Nagele <mail@wnagele.com>
+License: GPL-3.0-only

.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

@@ -4,17 +4,26 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+
     {
       "name": "meshtastic BLE",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": false,
+      "args": ["--ble", "--info", "--seriallog", "stdout"]
+    },
+     {
+      "name": "meshtastic BLE scan",
       "type": "python",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": false,
-      "args": ["--debug", "--ble", "--device", "24:62:AB:DD:DF:3A"]
+      "args": ["--debug", "--ble-scan"]
     },
     {
       "name": "meshtastic admin",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
@@ -22,15 +31,23 @@
     },
     {
       "name": "meshtastic tunnel",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
       "args": ["--tunnel", "--debug"]
     },
+    {
+      "name": "meshtastic analysis",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic.analysis",
+      "justMyCode": false,
+      "args": []
+    },
     {
       "name": "meshtastic set chan",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
@@ -38,23 +55,128 @@
     },
     {
       "name": "meshtastic debug",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug"]
+    },
+    {
+      "name": "meshtastic listen",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--listen", "--debug"]
+    },
+    {
+      "name": "meshtastic debug getPref",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--get", "power.is_power_saving"]
+    },
+    {
+      "name": "meshtastic debug getPref telemetry",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--get", "telemetry.environment_update_interval"]
+    },
+    {
+      "name": "meshtastic debug info",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--info"]
+    },
+    {
+      "name": "meshtastic debug BLE",
       "type": "python",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
-      "args": ["--debug" ]
+      "args": ["--debug", "--ble", "--info"]
+    },
+    {
+      "name": "meshtastic debug set region",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "lora.region", "TW"]
+    },
+    {
+      "name": "meshtastic debug set bluetooth fixed pin",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "bluetooth.fixed_pin", "555555"]
+    },
+    {
+      "name": "meshtastic debug get bluetooth fixed pin",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--get", "bluetooth.fixed_pin"]
+    },
+    {
+      "name": "meshtastic debug setPref",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--set", "power.powermon_enables", "65527"]
+    },
+    {
+      "name": "meshtastic debug setPref telemetry.environment_measurement_enabled",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "telemetry.environment_measurement_enabled", "1"]
+    },
+    {
+      "name": "meshtastic debug setPref telemetry.environment_screen_enabled",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "telemetry.environment_screen_enabled", "1"]
+    },
+    {
+      "name": "meshtastic debug setPref telemetry",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--set", "telemetry.environment_measurement_enabled", "1"]
     },
     {
       "name": "meshtastic setpref",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
       "args": ["--debug", "--setchan", "psk", ""]
     },
+    {
+      "name": "meshtastic --ch-set",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--ch-set", "channel_num", "0", "--ch-index", "0"]
+    },
+    
     {
       "name": "meshtastic seturl",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
@@ -63,15 +185,39 @@
     },
     {
       "name": "meshtastic shell",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
-      "justMyCode": true,
+      "justMyCode": false,
-      "args": ["--debug", "--seriallog", "stdout"]
+      "args": ["--noproto", "--seriallog", "stdout"]
+    },
+    {
+      "name": "meshtastic powermon sim",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": false,
+      "args": ["--slog-out", "default", "--power-sim", "--power-voltage", "3.3", "--port", "/dev/ttyUSB0", "--noproto", "--seriallog", "stdout"]
+    },
+    {
+      "name": "meshtastic powermon ppk2",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": false,
+      "args": ["--slog-out", "default", "--power-ppk2-meter", "--power-wait", "--power-voltage", "3.3", "--noproto", "--seriallog", "stdout"]
+    },
+    {
+      "name": "meshtastic stress ppk2",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": false,
+      "args": ["--slog", "--power-ppk2-supply", "--power-stress", "--power-voltage", "3.3", "--ble"]
     },
     {
       "name": "meshtastic test",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
@@ -79,7 +225,7 @@
     },
     {
       "name": "meshtastic settime",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
@@ -87,19 +233,43 @@
     },
     {
       "name": "meshtastic sendtext",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
       "args": ["--debug", "--sendtext", "pytest"]
-    }
+    },
     {
       "name": "meshtastic showNodes",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "module": "meshtastic",
       "justMyCode": true,
       "args": ["--debug", "--nodes"]
-    }
+    },
+    {
+      "name": "meshtastic nodes table",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--nodes"]
+    },
+        {
+      "name": "meshtastic nodes table with show-fields",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--nodes", "--show-fields", "AKA,Pubkey,Role,Role,Role,Latitude,Latitude,deviceMetrics.voltage"]
+    },
+    {
+      "name": "meshtastic --export-config",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--export-config", "config.json"]
+    },
   ]
 }

.vscode/settings.json

@@ -1,8 +1,22 @@
 {
     "cSpell.words": [
+        "bitmask",
+        "boardid",
+        "DEEPSLEEP",
         "Meshtastic",
+        "milliwatt",
+        "portnums",
+        "powermon",
+        "POWERSTRESS",
+        "pyarrow",
         "TORADIO",
         "Vids"
     ],
-    "python.pythonPath": "/usr/bin/python3"
+    "python.pythonPath": "/usr/bin/python3",
+    "flake8.enabled": false,
+    "python.testing.pytestArgs": [
+        "meshtastic/tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true // we are using trunk for formatting/linting rules, don't yell at us about line length
 }

LICENSE.md

@@ -0,0 +1,232 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+
+The GNU General Public License is a free, copyleft license for software and other kinds of works.
+
+The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
+
+To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
+
+For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
+
+Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
+
+For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
+
+Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
+
+Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
+
+The precise terms and conditions for copying, distribution and modification follow.
+
+TERMS AND CONDITIONS
+
+0. Definitions.
+
+“This License” refers to version 3 of the GNU General Public License.
+
+“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
+
+“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
+
+To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
+
+A “covered work” means either the unmodified Program or a work based on the Program.
+
+To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
+
+To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
+
+An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
+
+1. Source Code.
+The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
+
+A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
+
+The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
+
+The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same work.
+
+2. Basic Permissions.
+All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
+
+When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
+
+4. Conveying Verbatim Copies.
+You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
+
+     a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
+
+     b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
+
+     c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
+
+     d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
+
+A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
+
+     a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
+
+     b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
+
+     c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
+
+     d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
+
+     e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
+
+A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
+
+“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
+
+The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
+
+Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
+
+7. Additional Terms.
+“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
+
+     a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
+
+     b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
+
+     c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
+
+     d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
+
+     e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
+
+     f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
+
+All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
+
+8. Termination.
+You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
+
+However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
+
+Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
+
+10. Automatic Licensing of Downstream Recipients.
+Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
+
+An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
+
+11. Patents.
+A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
+
+A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
+
+In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
+
+A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
+
+13. Use with the GNU Affero General Public License.
+Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
+
+14. Revised Versions of this License.
+The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
+
+Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
+
+15. Disclaimer of Warranty.
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
+
+     <one line to give the program's name and a brief idea of what it does.>
+     Copyright (C) <year>  <name of author>
+
+     This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+     This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+     You should have received a copy of the GNU General Public License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
+
+     <program>  Copyright (C) <year>  <name of author>
+     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+     This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
+
+You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
+
+The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.

LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

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 .
@@ -16,12 +20,18 @@ docs:
 
 # lint the codebase
 lint:
-	pylint meshtastic
+	pylint meshtastic examples
 
 # show the slowest unit tests
 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,60 @@
-# Meshtastic-python
+<div align="center" markdown="1">
 
-[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/meshtastic/Meshtastic-python)
+<img src=".github/meshtastic_logo.png" alt="Meshtastic Logo" width="80"/>
-![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)
+  <h1 align="center"> Meshtastic Python
+</h1>
+  <p style="font-size:15px;" align="center">A Python library and client for use with Meshtastic devices. </p>
+
+[![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/)
+![GPL-3.0](https://img.shields.io/badge/License-GPL%20v3-blue.svg)
 
-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.
+</div>
 
-Full documentation including examples [here](https://meshtastic.org/docs/software/python/python-installation).
+<div align="center">
+	<a href="https://meshtastic.org/docs/software/python/cli/installation">Getting Started Guide</a>
+	-
+	<a href="https://python.meshtastic.org">API Documentation</a>
+</div>
 
-The library api is documented [here](https://meshtastic-python.vercel.app/meshtastic/index.html)
+## Overview
 
+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.
 
-[![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)
+- ./bin/run.sh --ble-scan # To look for Meshtastic devices
-
+- ./bin/run.sh --ble 24:62:AB:DD:DF:3A --info
-- 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
 
 ## 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/build-bin.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -e
+
+echo Building ubuntu binary
+poetry install
+source $(poetry env info --path)/bin/activate
+pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
+

bin/git-resolve-poetry-lock.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -e
+
+# This is a little helper you can use to resolve git merge conflicts in poetry.lock
+# with minimal changes vs the requested lib versions
+# Based on this article with a good description of best practices:
+# https://www.peterbe.com/plog/how-to-resolve-a-git-conflict-in-poetry.lock
+
+echo "Resolving poetry.lock merge conflicts, you'll need to run git commit yourself..."
+
+# Get poetry.lock to look like it does in master
+git checkout --theirs poetry.lock
+# Rewrite the lock file
+poetry lock --no-update
+git add poetry.lock
+
+# Update your poetry env to match the new merged lock file
+poetry install

bin/prerelease-tests.sh

@@ -2,21 +2,31 @@ set -e
 
 # You may consider running: "pytest -m smoke1" instead of this test.
 
+echo "Linting"
+poetry run pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"
+
+echo "Checking types"
+poetry run mypy meshtastic/
+
 echo "Running (crude) prerelease tests to verify sanity"
+
+# Use the python environment created by poetry
+source $(poetry env info --path)/bin/activate
+
 echo running hello
 python3 tests/hello_world.py
-# bin/run.sh --help
+# meshtastic --help
 echo toggling router
-bin/run.sh --set is_router true
+meshtastic --set is_router true
-bin/run.sh --set is_router false
+meshtastic --set is_router false
 # TODO: This does not seem to work.
 echo setting channel
-bin/run.sh --seturl "https://www.meshtastic.org/c/#GAMiENTxuzogKQdZ8Lz_q89Oab8qB0RlZmF1bHQ="
+meshtastic --seturl "https://www.meshtastic.org/c/#GAMiENTxuzogKQdZ8Lz_q89Oab8qB0RlZmF1bHQ="
 echo setting owner
-bin/run.sh --set-owner "Test Build"
+meshtastic --set-owner "Test Build"
 echo setting position
-bin/run.sh --setlat 32.7767 --setlon -96.7970 --setalt 1337
+meshtastic --setlat 32.7767 --setlon -96.7970 --setalt 1337
 echo dumping info
-bin/run.sh --info
+meshtastic run meshtastic --info
 echo sending closing message
-bin/run.sh --sendtext "Sanity complete"
+meshtastic --sendtext "Sanity complete"

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,62 @@
+#!/bin/bash
+
+set -e
+
+#Uncomment to run hack
+#gsed -i 's/import "\//import ".\//g' ./protobufs/meshtastic/*
+#gsed -i 's/package meshtastic;//g' ./protobufs/meshtastic/*
+
+POETRYDIR=$(poetry env info --path)
+
+if [[ -z "${POETRYDIR}" ]]; then
+	poetry install
+fi
+
+# protoc looks for mypy plugin in the python path
+source $(poetry env info --path)/bin/activate
+
+# Put our temp files in the poetry build directory
+TMPDIR=./build/meshtastic/protofixup
+echo "Fixing up protobuf paths in ${TMPDIR} temp directory"
+
+
+# Ensure a clean build
+[ -e "${TMPDIR}" ] && rm -r "${TMPDIR}"
+
+INDIR=${TMPDIR}/in/meshtastic/protobuf
+OUTDIR=${TMPDIR}/out
+PYIDIR=${TMPDIR}/out
+mkdir -p "${OUTDIR}" "${INDIR}" "${PYIDIR}"
+cp ./protobufs/meshtastic/*.proto "${INDIR}"
+cp ./protobufs/nanopb.proto "${INDIR}"
+
+# OS-X sed is apparently a little different and expects an arg for -i
+if [[ $OSTYPE == 'darwin'* ]]; then
+	SEDCMD="sed -i '' -E"
+else
+	SEDCMD="sed -i -E"
+fi
+
+
+# change the package names to meshtastic.protobuf
+$SEDCMD 's/^package meshtastic;/package meshtastic.protobuf;/' "${INDIR}/"*.proto
+# fix the imports to match
+$SEDCMD 's/^import "meshtastic\//import "meshtastic\/protobuf\//' "${INDIR}/"*.proto
+
+$SEDCMD 's/^import "nanopb.proto"/import "meshtastic\/protobuf\/nanopb.proto"/' "${INDIR}/"*.proto
+
+# Generate the python files
+./nanopb-0.4.8/generator-bin/protoc -I=$TMPDIR/in --python_out "${OUTDIR}" "--mypy_out=${PYIDIR}" $INDIR/*.proto
+
+# Change "from meshtastic.protobuf import" to "from . import"
+$SEDCMD 's/^from meshtastic.protobuf import/from . import/' "${OUTDIR}"/meshtastic/protobuf/*pb2*.py[i]
+
+# Create a __init__.py in the out directory
+touch "${OUTDIR}/meshtastic/protobuf/__init__.py"
+
+# Copy to the source controlled tree
+mkdir -p meshtastic/protobuf
+rm -rf meshtastic/protobuf/*pb2*.py
+cp "${OUTDIR}/meshtastic/protobuf"/* meshtastic/protobuf
+
+exit 0

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/run-ci-local.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# This script lets you run github ci actions locally
+# You need to have act installed.  You can get it at https://nektosact.com/
+
+# by default it simulates a push event
+# other useful options
+# -j build-and-publish-ubuntu
+
+# also: we only run one of the 4 matrix tests, because otherwise it absolutely hammers the CPU (so many containers and threads)
+act -P ubuntu-latest=-self-hosted --matrix "python-version:3.8" "$@"

bin/run.sh

@@ -1,2 +0,0 @@
-rm log_*
-python3 -m meshtastic "$@"

bin/test-release.sh

@@ -3,8 +3,6 @@ set -e
 
 bin/regen-docs.sh
 pandoc --from=markdown --to=rst --output=README README.md
-python3 setup.py sdist bdist_wheel
+
-python3 -m twine check dist/*
+poetry publish -r test-pypi --build
-# 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"

bin/upload-release.sh

@@ -1,5 +1,8 @@
 rm dist/*
 set -e
 
-python3 setup.py sdist bdist_wheel
+poetry build
-python3 -m twine upload dist/*
+poetry run pytest
+poetry publish 
+#python3 setup.py sdist bdist_wheel
+#python3 -m twine upload dist/*

exampleConfig.yaml

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

example_config.yaml

@@ -2,17 +2,45 @@
 owner: Bob TBeam
 owner_short: BOB
 
-channel_url: https://www.meshtastic.org/d/#CgUYAyIBAQ
+channel_url: https://www.meshtastic.org/e/#CgMSAQESCDgBQANIAVAe
+
+canned_messages: Hi|Bye|Yes|No|Ok
+ringtone: 24:d=32,o=5,b=565:f6,p,f6,4p,p,f6,p,f6,2p,p,b6,p,b6,p,b6,p,b6,p,b,p,b,p,b,p,b,p,b,p,b,p,b,p,b,1p.,2p.,p
 
 location:
   lat: 35.88888
   lon: -93.88888
   alt: 304
 
-user_prefs:
+config:
-  region: 1
+  bluetooth:
-  is_always_powered: 'true'
+    enabled: true
-  send_owner_interval: 2
+    fixedPin: 123456
-  screen_on_secs: 31536000
+  device:
-  wait_bluetooth_secs: 31536000
+    serialEnabled: true
-  location_share: 'LocEnabled'
+  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:
+        if n["num"] == iface.myInfo.my_node_num:
-            print(n['user']['hwModel'])
+            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

@@ -0,0 +1,20 @@
+"""Simple program to demo how to use meshtastic library.
+   To run: python examples/info.py
+"""
+
+import meshtastic
+import meshtastic.serial_interface
+
+iface = meshtastic.serial_interface.SerialInterface()
+
+# call showInfo() just to ensure values are populated
+# info = iface.showInfo()
+
+
+if iface.nodes:
+    for n in iface.nodes.values():
+        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):
+
+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):
+
+def onReceive(packet, interface):  # pylint: disable=unused-argument
     """called when a packet arrives"""
     print(f"Received: {packet}")
 
-def onConnection(interface, topic=pub.AUTO_TOPIC):
+
+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,9 +3,12 @@
 """
 
 import sys
-import meshtastic
+
-from meshtastic.supported_device import get_unique_vendor_ids, active_ports_on_supported_devices
+from meshtastic.util import (
-from meshtastic.util import detect_supported_devices
+    active_ports_on_supported_devices,
+    detect_supported_devices,
+    get_unique_vendor_ids,
+)
 
 # simple arg check
 if len(sys.argv) != 1:
@@ -14,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()

examples/waypoint.py

@@ -0,0 +1,57 @@
+"""Program to create and delete waypoint
+   To run:
+   python3 examples/waypoint.py --port /dev/ttyUSB0 create 45 test the_desc_2 '2024-12-18T23:05:23' 48.74 7.35
+   python3 examples/waypoint.py delete 45
+"""
+
+import argparse
+import datetime
+import sys
+
+import meshtastic
+import meshtastic.serial_interface
+
+parser = argparse.ArgumentParser(
+                    prog='waypoint',
+                    description='Create and delete Meshtastic waypoint')
+parser.add_argument('--port', default=None)
+parser.add_argument('--debug', default=False, action='store_true')
+
+subparsers = parser.add_subparsers(dest='cmd')
+parser_delete = subparsers.add_parser('delete', help='Delete a waypoint')
+parser_delete.add_argument('id', help="id of the waypoint")
+
+parser_create = subparsers.add_parser('create', help='Create a new waypoint')
+parser_create.add_argument('id', help="id of the waypoint")
+parser_create.add_argument('name', help="name of the waypoint")
+parser_create.add_argument('description', help="description of the waypoint")
+parser_create.add_argument('icon', help="icon of the waypoint")
+parser_create.add_argument('expire', help="expiration date of the waypoint as interpreted by datetime.fromisoformat")
+parser_create.add_argument('latitude', help="latitude of the waypoint")
+parser_create.add_argument('longitude', help="longitude of the waypoint")
+
+args = parser.parse_args()
+print(args)
+
+# By default will try to find a meshtastic device,
+# otherwise provide a device path like /dev/ttyUSB0
+if args.debug:
+    d = sys.stderr
+else:
+    d = None
+with meshtastic.serial_interface.SerialInterface(args.port, debugOut=d) as iface:
+    if args.cmd == 'create':
+        p = iface.sendWaypoint(
+            waypoint_id=int(args.id),
+            name=args.name,
+            description=args.description,
+            icon=args.icon,
+            expire=int(datetime.datetime.fromisoformat(args.expire).timestamp()),
+            latitude=float(args.latitude),
+            longitude=float(args.longitude),
+        )
+    else:
+        p = iface.deleteWaypoint(int(args.id))
+    print(p)
+
+# 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/mac/rak11200.txt

@@ -0,0 +1,52 @@
+
+
+% ioreg -p IOUSB > /tmp/a
+# only a solid red light (pins GRND and BOOT0 jumpered)
+
+% ioreg -p IOUSB > /tmp/b
+# solid red light and solid green light
+
+% ioreg -p IOUSB > /tmp/c
+# nothing plugged in
+
+
+
+% diff /tmp/a /tmp/c
+13c13
+<   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 11>
+---
+>   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 10>
+18d17
+<     +-o USB Serial@14300000  <class AppleUSBDevice, id 0x100004ca4, registered, matched, active, busy 0 (10 ms), retain 12>
+
+
+% diff /tmp/b /tmp/c
+13c13
+<   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 11>
+---
+>   +-o AppleUSBXHCI Root Hub Simulation@14000000  <class AppleUSBRootHubDevice, id 0x100000589, registered, matched, active, busy 0 (15 ms), retain 10>
+18d17
+<     +-o USB Serial@14300000  <class AppleUSBDevice, id 0x100004ce5, registered, matched, active, busy 0 (11 ms), retain 12>
+
+
+
+system_profiler SPUSBDataType > /tmp/d
+# red solid
+
+
+system_profiler SPUSBDataType > /tmp/e
+# nothing
+
+
+% diff /tmp/d /tmp/e
+38,48d37
+<         USB Serial:
+<
+<           Product ID: 0x7523
+<           Vendor ID: 0x1a86
+<           Version: 2.64
+<           Speed: Up to 12 Mb/s
+<           Location ID: 0x14300000 / 33
+<           Current Available (mA): 500
+<           Current Required (mA): 98
+<           Extra Operating Current (mA): 0

info/mac/techo.txt

@@ -30,3 +30,11 @@ drwxrwxrwx  1 bob         staff      512 Feb  1 16:47 .fseventsd
 % diff /tmp/a /tmp/c
 <snip>
 >   | +-o T-Echo v1@14300000  <class AppleUSBDevice, id 0x100061000, registered, matched, active, busy 0 (25 ms), retain 16>
+
+contents of: INFO_UF2.TXT
+
+UF2 Bootloader 0.6.1-2-g1224915 lib/nrfx (v2.0.0) lib/tinyusb (0.10.1-293-gaf8e5a90) lib/uf2 (remotes/origin/configupdate-9-gadbb8c7)
+Model: LilyGo T-Echo
+Board-ID: nRF52840-TEcho-v1
+SoftDevice: S140 version 6.1.1
+Date: Oct 13 2021

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

@@ -1,37 +1,46 @@
 """
-# an API for Meshtastic devices
+# A library for the Meshtastic Client API
+
+Primary interfaces: SerialInterface, TCPInterface, BLEInterface
 
-Primary class: SerialInterface
 Install with pip: "[pip3 install meshtastic](https://pypi.org/project/meshtastic/)"
-Source code on [github](https://github.com/meshtastic/Meshtastic-python)
 
-properties of SerialInterface:
+Source code on [github](https://github.com/meshtastic/python)
 
-- radioConfig - Current radio configuration and device settings, if you write to this the new settings will be applied to
+notable properties of interface classes:
-the device.
+
-- nodes - The database of received nodes.  Includes always up-to-date location and username information for each
+- `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.
-- nodesByNum - like "nodes" but keyed by nodeNum instead of nodeId
+- `nodesByNum` - like "nodes" but keyed by nodeNum instead of nodeId. As such, includes "unknown" nodes which haven't seen a User packet yet
-- myInfo - Contains read-only information about the local radio device (software version, hardware version, etc)
+- `myInfo` & `metadata` - Contain read-only information about the local radio device (software version, hardware version, etc)
+- `localNode` - Pointer to a node object for the local node
+
+notable properties of nodes:
+
+- `localConfig` - Current radio settings, can be written to the radio with the `writeConfig` method.
+- `moduleConfig` - Current module settings, can be written to the radio with the `writeConfig` method.
+- `channels` - The node's channels, keyed by index.
 
 # Published PubSub topics
 
 We use a [publish-subscribe](https://pypubsub.readthedocs.io/en/v4.0.3/) model to communicate asynchronous events.  Available
 topics:
 
-- meshtastic.connection.established - published once we've successfully connected to the radio and downloaded the node DB
+- `meshtastic.connection.established` - published once we've successfully connected to the radio and downloaded the node DB
-- meshtastic.connection.lost - published once we've lost our link to the radio
+- `meshtastic.connection.lost` - published once we've lost our link to the radio
-- meshtastic.receive.text(packet) - delivers a received packet as a dictionary, if you only care about a particular
+- `meshtastic.receive.text(packet)` - delivers a received packet as a dictionary, if you only care about a particular
 type of packet, you should subscribe to the full topic name.  If you want to see all packets, simply subscribe to "meshtastic.receive".
-- meshtastic.receive.position(packet)
+- `meshtastic.receive.position(packet)`
-- meshtastic.receive.user(packet)
+- `meshtastic.receive.user(packet)`
-- meshtastic.receive.data.portnum(packet) (where portnum is an integer or well known PortNum enum)
+- `meshtastic.receive.data.portnum(packet)` (where portnum is an integer or well known PortNum enum)
-- meshtastic.node.updated(node = NodeInfo) - published when a node in the DB changes (appears, location changed, username changed, etc...)
+- `meshtastic.node.updated(node = NodeInfo)` - published when a node in the DB changes (appears, location changed, username changed, etc...)
+- `meshtastic.log.line(line)` - a raw unparsed log line from the radio
+- `meshtastic.clientNotification(notification, interface) - a ClientNotification sent from the radio
 
-We receive position, user, or data packets from the mesh.  You probably only care about meshtastic.receive.data.  The first argument for
+We receive position, user, or data packets from the mesh.  You probably only care about `meshtastic.receive.data`.  The first argument for
-that publish will be the packet.  Text or binary data packets (from sendData or sendText) will both arrive this way.  If you print packet
+that publish will be the packet.  Text or binary data packets (from `sendData` or `sendText`) will both arrive this way.  If you print packet
-you'll see the fields in the dictionary.  decoded.data.payload will contain the raw bytes that were sent.  If the packet was sent with
+you'll see the fields in the dictionary.  `decoded.data.payload` will contain the raw bytes that were sent.  If the packet was sent with
-sendText, decoded.data.text will **also** be populated with the decoded string.  For ASCII these two strings will be the same, but for
+`sendText`, `decoded.data.text` will **also** be populated with the decoded string.  For ASCII these two strings will be the same, but for
 unicode scripts they can be different.
 
 # Example Usage
@@ -62,63 +71,86 @@ 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]
+from google.protobuf.json_format import MessageToJson
+from pubsub import pub # type: ignore[import-untyped]
+from tabulate import tabulate
+
+from meshtastic.node import Node
+from meshtastic.util import DeferredExecution, Timeout, catchAndIgnore, fixme, stripnl
+
+from .protobuf import (
+    admin_pb2,
+    apponly_pb2,
+    channel_pb2,
+    config_pb2,
+    mesh_pb2,
+    mqtt_pb2,
+    paxcount_pb2,
+    portnums_pb2,
+    remote_hardware_pb2,
+    storeforward_pb2,
+    telemetry_pb2,
+    powermon_pb2
+)
+from . import (
+    util,
+)
 
 # 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
+BROADCAST_NUM: int = 0xFFFFFFFF
-"""if using 8 bit nodenums this will be shortend on the target"""
+"""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: int = 20300
 """The numeric buildnumber (shared with android apps) specifying the
    level of device code we are guaranteed to understand
 
    format is Mmmss (where M is 1+the numeric major number. i.e. 20120 means 1.1.20
 """
 
+NODELESS_WANT_CONFIG_ID = 69420
+"""A special thing to pass for want_config_id that instructs nodes to skip sending nodeinfos other than its own."""
+
 publishingThread = DeferredExecution("publishing")
 
+logger = logging.getLogger(__name__)
 
 class ResponseHandler(NamedTuple):
     """A pending response callback, waiting for a response to one of our messages"""
+
     # requestId: int - used only as a key
+    #: a callable to call when a response is received
     callback: Callable
+    #: Whether ACKs and NAKs should be passed to this handler
+    ackPermitted: bool = False
     # FIXME, add timestamp and age out old requests
 
 
 class KnownProtocol(NamedTuple):
     """Used to automatically decode known protocol payloads"""
+
+    #: A descriptive name (e.g. "text", "user", "admin")
     name: str
-    # portnum: int, now a key
+    #: If set, will be called to parse as a protocol buffer
-    # If set, will be called to prase as a protocol buffer
+    protobufFactory: Optional[Callable] = None
-    protobufFactory: Callable = None
+    #: If set, invoked as onReceive(interface, packet)
-    # If set, invoked as onReceive(interface, packet)
+    onReceive: Optional[Callable] = None
-    onReceive: Callable = None
 
 
 def _onTextReceive(iface, asDict):
@@ -129,42 +161,70 @@ 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}')
+    logger.debug(f"in _onTextReceive() asDict:{asDict}")
     try:
         asBytes = asDict["decoded"]["payload"]
         asDict["decoded"]["text"] = asBytes.decode("utf-8")
     except Exception as ex:
-        logging.error(f"Malformatted utf8 in text message: {ex}")
+        logger.error(f"Malformatted utf8 in text message: {ex}")
     _receiveInfoUpdate(iface, asDict)
 
 
 def _onPositionReceive(iface, asDict):
     """Special auto parsing for received messages"""
-    logging.debug(f'in _onPositionReceive() asDict:{asDict}')
+    logger.debug(f"in _onPositionReceive() asDict:{asDict}")
-    if 'decoded' in asDict:
+    if "decoded" in asDict:
-        if 'position' in asDict['decoded'] and 'from' in asDict:
+        if "position" in asDict["decoded"] and "from" in asDict:
             p = asDict["decoded"]["position"]
-            logging.debug(f'p:{p}')
+            logger.debug(f"p:{p}")
             p = iface._fixupPosition(p)
-            logging.debug(f'after fixup p:{p}')
+            logger.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}')
+    logger.debug(f"in _onNodeInfoReceive() asDict:{asDict}")
-    if 'decoded' in asDict:
+    if "decoded" in asDict:
-        if 'user' in asDict['decoded'] and 'from' 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)
 
+def _onTelemetryReceive(iface, asDict):
+    """Automatically update device metrics on received packets"""
+    logger.debug(f"in _onTelemetryReceive() asDict:{asDict}")
+    if "from" not in asDict:
+        return
+
+    toUpdate = None
+
+    telemetry = asDict.get("decoded", {}).get("telemetry", {})
+    node = iface._getOrCreateByNum(asDict["from"])
+    if "deviceMetrics" in telemetry:
+        toUpdate = "deviceMetrics"
+    elif "environmentMetrics" in telemetry:
+        toUpdate = "environmentMetrics"
+    elif "airQualityMetrics" in telemetry:
+        toUpdate = "airQualityMetrics"
+    elif "powerMetrics" in telemetry:
+        toUpdate = "powerMetrics"
+    elif "localStats" in telemetry:
+        toUpdate = "localStats"
+    else:
+        return
+
+    updateObj = telemetry.get(toUpdate)
+    newMetrics = node.get(toUpdate, {})
+    newMetrics.update(updateObj)
+    logger.debug(f"updating {toUpdate} metrics for {asDict['from']} to {newMetrics}")
+    node[toUpdate] = newMetrics
 
 def _receiveInfoUpdate(iface, asDict):
     if "from" in asDict:
@@ -173,15 +233,51 @@ def _receiveInfoUpdate(iface, asDict):
         iface._getOrCreateByNum(asDict["from"])["snr"] = asDict.get("rxSnr")
         iface._getOrCreateByNum(asDict["from"])["hopLimit"] = asDict.get("hopLimit")
 
+def _onAdminReceive(iface, asDict):
+    """Special auto parsing for received messages"""
+    logger.debug(f"in _onAdminReceive() asDict:{asDict}")
+    if "decoded" in asDict and "from" in asDict and "admin" in asDict["decoded"]:
+        adminMessage = asDict["decoded"]["admin"]["raw"]
+        iface._getOrCreateByNum(asDict["from"])["adminSessionPassKey"] = adminMessage.session_passkey
 
 """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.TEXT_MESSAGE_APP: KnownProtocol(
-    portnums_pb2.PortNum.POSITION_APP: KnownProtocol("position", mesh_pb2.Position, _onPositionReceive),
+        "text", onReceive=_onTextReceive
-    portnums_pb2.PortNum.NODEINFO_APP: KnownProtocol("user", mesh_pb2.User, _onNodeInfoReceive),
+    ),
-    portnums_pb2.PortNum.ADMIN_APP: KnownProtocol("admin", admin_pb2.AdminMessage),
+    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, _onAdminReceive
+    ),
     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, _onTelemetryReceive
+    ),
     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.POWERSTRESS_APP: KnownProtocol(
+        "powerstress", powermon_pb2.PowerStressMessage
+    ),
+    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 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: admin.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()
-
-
-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
-
-
-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)
-
-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
-# @@protoc_insertion_point(module_scope)

meshtastic/analysis/__init__.py

@@ -0,0 +1 @@
+"""Post-run analysis tools for meshtastic."""

meshtastic/analysis/__main__.py

@@ -0,0 +1,207 @@
+"""Post-run analysis tools for meshtastic."""
+
+import argparse
+import logging
+import os
+from typing import cast, List
+
+import dash_bootstrap_components as dbc  # type: ignore[import-untyped]
+import numpy as np
+import pandas as pd
+import plotly.express as px  # type: ignore[import-untyped]
+import plotly.graph_objects as go  # type: ignore[import-untyped]
+import pyarrow as pa
+from dash import Dash, dcc, html  # type: ignore[import-untyped]
+from pyarrow import feather
+
+from .. import mesh_pb2, powermon_pb2
+from ..slog import root_dir
+
+# Configure panda options
+pd.options.mode.copy_on_write = True
+
+
+def to_pmon_names(arr) -> List[str]:
+    """Convert the power monitor state numbers to their corresponding names.
+
+    arr (list): List of power monitor state numbers.
+
+    Returns the List of corresponding power monitor state names.
+    """
+
+    def to_pmon_name(n):
+        try:
+            s = powermon_pb2.PowerMon.State.Name(int(n))
+            return s if s != "None" else None
+        except ValueError:
+            return None
+
+    return [to_pmon_name(x) for x in arr]
+
+
+def read_pandas(filepath: str) -> pd.DataFrame:
+    """Read a feather file and convert it to a pandas DataFrame.
+
+    filepath (str): Path to the feather file.
+
+    Returns the pandas DataFrame.
+    """
+    # per https://arrow.apache.org/docs/python/pandas.html#reducing-memory-use-in-table-to-pandas
+    # use this to get nullable int fields treated as ints rather than floats in pandas
+    dtype_mapping = {
+        pa.int8(): pd.Int8Dtype(),
+        pa.int16(): pd.Int16Dtype(),
+        pa.int32(): pd.Int32Dtype(),
+        pa.int64(): pd.Int64Dtype(),
+        pa.uint8(): pd.UInt8Dtype(),
+        pa.uint16(): pd.UInt16Dtype(),
+        pa.uint32(): pd.UInt32Dtype(),
+        pa.uint64(): pd.UInt64Dtype(),
+        pa.bool_(): pd.BooleanDtype(),
+        pa.float32(): pd.Float32Dtype(),
+        pa.float64(): pd.Float64Dtype(),
+        pa.string(): pd.StringDtype(),
+    }
+
+    return cast(pd.DataFrame, feather.read_table(filepath).to_pandas(types_mapper=dtype_mapping.get))  # type: ignore[arg-type]
+
+
+def get_pmon_raises(dslog: pd.DataFrame) -> pd.DataFrame:
+    """Get the power monitor raises from the slog DataFrame.
+
+        dslog (pd.DataFrame): The slog DataFrame.
+
+    Returns the DataFrame containing the power monitor raises.
+    """
+    pmon_events = dslog[dslog["pm_mask"].notnull()]
+
+    pm_masks = pd.Series(pmon_events["pm_mask"]).to_numpy()
+
+    # possible to do this with pandas rolling windows if I was smarter?
+    pm_changes = [
+        (pm_masks[i - 1] ^ x if i != 0 else x) for i, x in enumerate(pm_masks)
+    ]
+    pm_raises = [(pm_masks[i] & x) for i, x in enumerate(pm_changes)]
+    pm_falls = [(~pm_masks[i] & x if i != 0 else 0) for i, x in enumerate(pm_changes)]
+
+    pmon_events["pm_raises"] = to_pmon_names(pm_raises)
+    pmon_events["pm_falls"] = to_pmon_names(pm_falls)
+
+    pmon_raises = pmon_events[pmon_events["pm_raises"].notnull()][["time", "pm_raises"]]
+    pmon_falls = pmon_events[pmon_events["pm_falls"].notnull()]
+
+    # pylint: disable=unused-variable
+    def get_endtime(row):
+        """Find the corresponding fall event."""
+        following = pmon_falls[
+            (pmon_falls["pm_falls"] == row["pm_raises"])
+            & (pmon_falls["time"] > row["time"])
+        ]
+        return following.iloc[0] if not following.empty else None
+
+    # HMM - setting end_time doesn't work yet - leave off for now
+    # pmon_raises['end_time'] = pmon_raises.apply(get_endtime, axis=1)
+
+    return pmon_raises
+
+
+def get_board_info(dslog: pd.DataFrame) -> tuple:
+    """Get the board information from the slog DataFrame.
+
+    dslog (pd.DataFrame): The slog DataFrame.
+
+    Returns a tuple containing the board ID and software version.
+    """
+    board_info = dslog[dslog["sw_version"].notnull()]
+    sw_version = board_info.iloc[0]["sw_version"]
+    board_id = mesh_pb2.HardwareModel.Name(board_info.iloc[0]["board_id"])
+    return (board_id, sw_version)
+
+
+def create_argparser() -> argparse.ArgumentParser:
+    """Create the argument parser for the script."""
+    parser = argparse.ArgumentParser(description="Meshtastic power analysis tools")
+    group = parser
+    group.add_argument(
+        "--slog",
+        help="Specify the structured-logs directory (defaults to latest log directory)",
+    )
+    group.add_argument(
+        "--no-server",
+        action="store_true",
+        help="Exit immediately, without running the visualization web server",
+    )
+
+    return parser
+
+
+def create_dash(slog_path: str) -> Dash:
+    """Create a Dash application for visualizing power consumption data.
+
+    slog_path (str): Path to the slog directory.
+
+    Returns the Dash application.
+    """
+    app = Dash(external_stylesheets=[dbc.themes.BOOTSTRAP])
+
+    dpwr = read_pandas(os.path.join(slog_path, "power.feather"))
+    dslog = read_pandas(os.path.join(slog_path, "slog.feather"))
+
+    pmon_raises = get_pmon_raises(dslog)
+
+    def set_legend(f, name):
+        f["data"][0]["showlegend"] = True
+        f["data"][0]["name"] = name
+        return f
+
+    avg_pwr_lines = px.line(dpwr, x="time", y="average_mW").update_traces(
+        line_color="red"
+    )
+    set_legend(avg_pwr_lines, "avg power")
+    max_pwr_points = px.scatter(dpwr, x="time", y="max_mW").update_traces(
+        marker_color="blue"
+    )
+    set_legend(max_pwr_points, "max power")
+    min_pwr_points = px.scatter(dpwr, x="time", y="min_mW").update_traces(
+        marker_color="green"
+    )
+    set_legend(min_pwr_points, "min power")
+
+    fake_y = np.full(len(pmon_raises), 10.0)
+    pmon_points = px.scatter(pmon_raises, x="time", y=fake_y, text="pm_raises")
+
+    fig = go.Figure(data=max_pwr_points.data + avg_pwr_lines.data + pmon_points.data)
+
+    fig.update_layout(
+        legend={"yanchor": "top", "y": 0.99, "xanchor": "left", "x": 0.01}
+    )
+
+    # App layout
+    app.layout = [
+        html.Div(children="Meshtastic power analysis tool testing..."),
+        dcc.Graph(figure=fig),
+    ]
+
+    return app
+
+
+def main():
+    """Entry point of the script."""
+
+    parser = create_argparser()
+    args = parser.parse_args()
+    if not args.slog:
+        args.slog = os.path.join(root_dir(), "latest")
+
+    app = create_dash(slog_path=args.slog)
+    port = 8051
+    logging.info(f"Running Dash visualization of {args.slog} (publicly accessible)")
+
+    if not args.no_server:
+        app.run_server(debug=True, host="0.0.0.0", port=port)
+    else:
+        logging.info("Exiting without running visualization server")
+
+
+if __name__ == "__main__":
+    main()

meshtastic/apponly_pb2.py

@@ -1,36 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: apponly.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()
-
-
-from . import channel_pb2 as channel__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)
-
-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
-# @@protoc_insertion_point(module_scope)

meshtastic/ble_interface.py

@@ -1,67 +1,321 @@
 """Bluetooth interface
 """
+import asyncio
+import atexit
 import logging
-import platform
+import struct
+import time
+import io
+from threading import Thread
+from typing import List, Optional
+
+import google.protobuf
+from bleak import BleakClient, BleakScanner, BLEDevice
+from bleak.exc import BleakDBusError, BleakError
 
 from meshtastic.mesh_interface import MeshInterface
-from meshtastic.util import our_exit
 
-if platform.system() == 'Linux':
+from .protobuf import mesh_pb2
-    # pylint: disable=E0401
-    import pygatt
 
-
+SERVICE_UUID = "6ba1b218-15a8-461f-9fa8-5dcae273eafd"
-
-# Our standard BLE characteristics
 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"
+LEGACY_LOGRADIO_UUID = "6c6fd238-78fa-436b-aacf-15c5be1ef2e2"
+LOGRADIO_UUID = "5a3d6e49-06e6-4423-9944-e9de8cdf9547"
+logger = logging.getLogger(__name__)
 
 
 class BLEInterface(MeshInterface):
-    """A not quite ready - FIXME - BLE interface to devices"""
+    """MeshInterface using BLE to connect to devices."""
 
-    def __init__(self, address, noProto=False, debugOut=None):
+    class BLEError(Exception):
-        if platform.system() != 'Linux':
+        """An exception class for BLE errors."""
-            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)
 
-        self._readFromRadio()  # read the initial responses
+    def __init__( # pylint: disable=R0917
+        self,
+        address: Optional[str],
+        noProto: bool = False,
+        debugOut: Optional[io.TextIOWrapper]=None,
+        noNodes: bool = False,
+        timeout: int = 300,
+    ) -> None:
+        MeshInterface.__init__(
+            self, debugOut=debugOut, noProto=noProto, noNodes=noNodes, timeout=timeout
+        )
 
-        def handle_data(handle, data): # pylint: disable=W0613
+        self.should_read = False
-            self._handleFromRadio(data)
 
-        if self.device:
+        logger.debug("Threads starting")
-            self.device.subscribe(FROMNUM_UUID, callback=handle_data)
+        self._want_receive = True
+        self._receiveThread: Optional[Thread] = Thread(
+            target=self._receiveFromRadioImpl, name="BLEReceive", daemon=True
+        )
+        self._receiveThread.start()
+        logger.debug("Threads running")
 
-    def _sendToRadioImpl(self, toRadio):
+        self.client: Optional[BLEClient] = None
-        """Send a ToRadio protobuf to the device"""
+        try:
-        #logging.debug(f"Sending: {stripnl(toRadio)}")
+            logger.debug(f"BLE connecting to: {address if address else 'any'}")
-        b = toRadio.SerializeToString()
+            self.client = self.connect(address)
-        self.device.char_write(TORADIO_UUID, b)
+            logger.debug("BLE connected")
+        except BLEInterface.BLEError as e:
+            self.close()
+            raise e
 
-    def close(self):
+        if self.client.has_characteristic(LEGACY_LOGRADIO_UUID):
-        MeshInterface.close(self)
+            self.client.start_notify(
-        if self.adapter:
+                LEGACY_LOGRADIO_UUID, self.legacy_log_radio_handler
-            self.adapter.stop()
+            )
 
-    def _readFromRadio(self):
+        if self.client.has_characteristic(LOGRADIO_UUID):
+            self.client.start_notify(LOGRADIO_UUID, self.log_radio_handler)
+
+        logger.debug("Mesh configure starting")
+        self._startConfig()
         if not self.noProto:
-            wasEmpty = False
+            self._waitConnected(timeout=60.0)
-            while not wasEmpty:
+            self.waitForConfig()
-                if self.device:
+
-                    b = self.device.char_read(FROMRADIO_UUID)
+        logger.debug("Register FROMNUM notify callback")
-                    wasEmpty = len(b) == 0
+        self.client.start_notify(FROMNUM_UUID, self.from_num_handler)
-                    if not wasEmpty:
+
-                        self._handleFromRadio(b)
+        # We MUST run atexit (if we can) because otherwise (at least on linux) the BLE device is not disconnected
+        # and future connection attempts will fail.  (BlueZ kinda sucks)
+        # Note: the on disconnected callback will call our self.close which will make us nicely wait for threads to exit
+        self._exit_handler = atexit.register(self.client.disconnect)
+
+    def __repr__(self):
+        rep = f"BLEInterface(address={self.client.address if self.client else None!r}"
+        if self.debugOut is not None:
+            rep += f", debugOut={self.debugOut!r}"
+        if self.noProto:
+            rep += ", noProto=True"
+        if self.noNodes:
+            rep += ", noNodes=True"
+        rep += ")"
+        return rep
+
+    def from_num_handler(self, _, b: bytes) -> None:  # pylint: disable=C0116
+        """Handle callbacks for fromnum notify.
+        Note: this method does not need to be async because it is just setting a bool.
+        """
+        from_num = struct.unpack("<I", bytes(b))[0]
+        logger.debug(f"FROMNUM notify: {from_num}")
+        self.should_read = True
+
+    async def log_radio_handler(self, _, b):  # pylint: disable=C0116
+        log_record = mesh_pb2.LogRecord()
+        try:
+            log_record.ParseFromString(bytes(b))
+
+            message = (
+                f"[{log_record.source}] {log_record.message}"
+                if log_record.source
+                else log_record.message
+            )
+            self._handleLogLine(message)
+        except google.protobuf.message.DecodeError:
+            logger.warning("Malformed LogRecord received. Skipping.")
+
+    async def legacy_log_radio_handler(self, _, b):  # pylint: disable=C0116
+        log_radio = b.decode("utf-8").replace("\n", "")
+        self._handleLogLine(log_radio)
+
+    @staticmethod
+    def scan() -> List[BLEDevice]:
+        """Scan for available BLE devices."""
+        with BLEClient() as client:
+            logger.info("Scanning for BLE devices (takes 10 seconds)...")
+            response = client.discover(
+                timeout=10, return_adv=True, service_uuids=[SERVICE_UUID]
+            )
+
+            devices = response.values()
+
+            # bleak sometimes returns devices we didn't ask for, so filter the response
+            # to only return true meshtastic devices
+            # d[0] is the device. d[1] is the advertisement data
+            devices = list(
+                filter(lambda d: SERVICE_UUID in d[1].service_uuids, devices)
+            )
+            return list(map(lambda d: d[0], devices))
+
+    def find_device(self, address: Optional[str]) -> BLEDevice:
+        """Find a device by address."""
+
+        addressed_devices = BLEInterface.scan()
+
+        if address:
+            addressed_devices = list(
+                filter(
+                    lambda x: address in (x.name, x.address),
+                    addressed_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]
+
+    def _sanitize_address(self, address: Optional[str]) -> Optional[str]:  # pylint: disable=E0213
+        "Standardize BLE address by removing extraneous characters and lowercasing."
+        if address is None:
+            return None
+        else:
+            return address.replace("-", "").replace("_", "").replace(":", "").lower()
+
+    def connect(self, address: Optional[str] = None) -> "BLEClient":
+        "Connect to a device by address."
+
+        # Bleak docs recommend always doing a scan before connecting (even if we know addr)
+        device = self.find_device(address)
+        client = BLEClient(device.address, disconnected_callback=lambda _: self.close())
+        client.connect()
+        client.discover()
+        return client
+
+    def _receiveFromRadioImpl(self) -> None:
+        while self._want_receive:
+            if self.should_read:
+                self.should_read = False
+                retries: int = 0
+                while self._want_receive:
+                    if self.client is None:
+                        logger.debug(f"BLE client is None, shutting down")
+                        self._want_receive = False
+                        continue
+                    try:
+                        b = bytes(self.client.read_gatt_char(FROMRADIO_UUID))
+                    except BleakDBusError as e:
+                        # Device disconnected probably, so end our read loop immediately
+                        logger.debug(f"Device disconnected, shutting down {e}")
+                        self._want_receive = False
+                    except BleakError as e:
+                        # We were definitely disconnected
+                        if "Not connected" in str(e):
+                            logger.debug(f"Device disconnected, shutting down {e}")
+                            self._want_receive = False
+                        else:
+                            raise BLEInterface.BLEError("Error reading BLE") from e
+                    if not b:
+                        if retries < 5:
+                            time.sleep(0.1)
+                            retries += 1
+                            continue
+                        break
+                    logger.debug(f"FROMRADIO read: {b.hex()}")
+                    self._handleFromRadio(b)
+            else:
+                time.sleep(0.01)
+
+    def _sendToRadioImpl(self, toRadio) -> None:
+        b: bytes = toRadio.SerializeToString()
+        if b and self.client:  # we silently ignore writes while we are shutting down
+            logger.debug(f"TORADIO write: {b.hex()}")
+            try:
+                self.client.write_gatt_char(
+                    TORADIO_UUID, b, response=True
+                )  # FIXME: or False?
+                # search Bleak src for org.bluez.Error.InProgress
+            except Exception as e:
+                raise BLEInterface.BLEError(
+                    "Error writing BLE (are you in the 'bluetooth' user group? did you enter the pairing PIN on your computer?)"
+                ) from e
+            # Allow to propagate and then make sure we read
+            time.sleep(0.01)
+            self.should_read = True
+
+    def close(self) -> None:
+        try:
+            MeshInterface.close(self)
+        except Exception as e:
+            logger.error(f"Error closing mesh interface: {e}")
+
+        if self._want_receive:
+            self._want_receive = False  # Tell the thread we want it to stop
+            if self._receiveThread:
+                self._receiveThread.join(
+                    timeout=2
+                )  # If bleak is hung, don't wait for the thread to exit (it is critical we disconnect)
+                self._receiveThread = None
+
+        if self.client:
+            atexit.unregister(self._exit_handler)
+            self.client.disconnect()
+            self.client.close()
+            self.client = None
+        self._disconnected() # send the disconnected indicator up to clients
+
+
+class BLEClient:
+    """Client for managing connection to a BLE device"""
+
+    def __init__(self, address=None, **kwargs) -> None:
+        self._eventLoop = asyncio.new_event_loop()
+        self._eventThread = Thread(
+            target=self._run_event_loop, name="BLEClient", daemon=True
+        )
+        self._eventThread.start()
+
+        if not address:
+            logger.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 has_characteristic(self, specifier):
+        """Check if the connected node supports a specified characteristic."""
+        return bool(self.bleak_client.services.get_characteristic(specifier))
+
+    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.join()
+
+    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):
+        try:
+            self._eventLoop.run_forever()
+        finally:
+            self._eventLoop.close()
+
+    async def _stop_event_loop(self):
+        self._eventLoop.stop()

meshtastic/cannedmessages_pb2.py

@@ -1,75 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: cannedmessages.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\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)
-
-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
-# @@protoc_insertion_point(module_scope)

meshtastic/channel_pb2.py

@@ -1,51 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: channel.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\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)
-
-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
-# @@protoc_insertion_point(module_scope)

meshtastic/deviceonly_pb2.py

@@ -1,69 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: deviceonly.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()
-
-
-from . import channel_pb2 as channel__pb2
-from . import mesh_pb2 as mesh__pb2
-from . import radioconfig_pb2 as radioconfig__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)
-
-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
-# @@protoc_insertion_point(module_scope)

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/mqtt_pb2.py

@@ -1,36 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: mqtt.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()
-
-
-from . import mesh_pb2 as 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)
-
-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
-# @@protoc_insertion_point(module_scope)

meshtastic/mt_config.py

@@ -0,0 +1,39 @@
+"""
+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.
+
+"""
+
+from typing import Any, Optional
+
+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: Optional[Any] = None
+camel_case = False

meshtastic/portnums_pb2.py

@@ -1,47 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: portnums.proto
-"""Generated protocol buffer code."""
-from google.protobuf.internal import enum_type_wrapper
-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\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
-
-
-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
-# @@protoc_insertion_point(module_scope)

meshtastic/powermon/__init__.py

@@ -0,0 +1,7 @@
+"""Support for logging from power meters/supplies."""
+
+from .power_supply import PowerError, PowerMeter, PowerSupply
+from .ppk2 import PPK2PowerSupply
+from .riden import RidenPowerSupply
+from .sim import SimPowerSupply
+from .stress import PowerStress

meshtastic/powermon/power_supply.py

@@ -0,0 +1,52 @@
+"""code logging power consumption of meshtastic devices."""
+
+import math
+from datetime import datetime
+
+
+class PowerError(Exception):
+    """An exception class for powermon errors"""
+
+    def __init__(self, message):
+        self.message = message
+        super().__init__(self.message)
+
+
+class PowerMeter:
+    """Abstract class for power meters."""
+
+    def __init__(self):
+        """Initialize the PowerMeter object."""
+        self.prevPowerTime = datetime.now()
+
+    def close(self) -> None:
+        """Close the power meter."""
+
+    def get_average_current_mA(self) -> float:
+        """Returns average current of last measurement in mA (since last call to this method)"""
+        return math.nan
+
+    def get_min_current_mA(self):
+        """Returns max current in mA (since last call to this method)."""
+        # Subclasses must override for a better implementation
+        return self.get_average_current_mA()
+
+    def get_max_current_mA(self):
+        """Returns max current in mA (since last call to this method)."""
+        # Subclasses must override for a better implementation
+        return self.get_average_current_mA()
+
+    def reset_measurements(self):
+        """Reset current measurements."""
+
+
+class PowerSupply(PowerMeter):
+    """Abstract class for power supplies."""
+
+    def __init__(self):
+        """Initialize the PowerSupply object."""
+        super().__init__()
+        self.v = 0.0
+
+    def powerOn(self):
+        """Turn on the power supply (using the voltage set in self.v)."""

meshtastic/powermon/ppk2.py

@@ -0,0 +1,182 @@
+"""Classes for logging power consumption of meshtastic devices."""
+
+import logging
+import threading
+import time
+from typing import Optional
+
+from ppk2_api import ppk2_api  # type: ignore[import-untyped]
+
+from .power_supply import PowerError, PowerSupply
+
+
+class PPK2PowerSupply(PowerSupply):
+    """Interface for talking with the NRF PPK2 high-resolution micro-power supply.
+    Power Profiler Kit II is what you should google to find it for purchase.
+    """
+
+    def __init__(self, portName: Optional[str] = None):
+        """Initialize the PowerSupply object.
+
+        portName (str, optional): The port name of the power supply. Defaults to "/dev/ttyACM0".
+        """
+        if not portName:
+            devs = ppk2_api.PPK2_API.list_devices()
+            if not devs or len(devs) == 0:
+                raise PowerError("No PPK2 devices found")
+            elif len(devs) > 1:
+                raise PowerError(
+                    "Multiple PPK2 devices found, please specify the portName"
+                )
+            else:
+                portName = devs[0]
+
+        self.measuring = False
+        self.current_max = 0
+        self.current_min = 0
+        self.current_sum = 0
+        self.current_num_samples = 0
+        self.current_average = 0
+
+        # for tracking avera data read length (to determine if we are sleeping efficiently in measurement_loop)
+        self.total_data_len = 0
+        self.num_data_reads = 0
+        self.max_data_len = 0
+
+        # Normally we just sleep with a timeout on this condition (polling the power measurement data repeatedly)
+        # but any time our measurements have been fully consumed (via reset_measurements) we notify() this condition
+        # to trigger a new reading ASAP.
+        self._want_measurement = threading.Condition()
+
+        # To guard against a brief window while updating measured values
+        self._result_lock = threading.Condition()
+
+        self.r = r = ppk2_api.PPK2_API(
+            portName
+        )  # serial port will be different for you
+        r.get_modifiers()
+
+        self.measurement_thread = threading.Thread(
+            target=self.measurement_loop, daemon=True, name="ppk2 measurement"
+        )
+        logging.info("Connected to Power Profiler Kit II (PPK2)")
+        super().__init__()  # we call this late so that the port is already open and _getRawWattHour callback works
+
+    def measurement_loop(self):
+        """Endless measurement loop will run in a thread."""
+        while self.measuring:
+            with self._want_measurement:
+                self._want_measurement.wait(
+                    0.0001 if self.num_data_reads == 0 else 0.001
+                )
+                # normally we poll using this timeout, but sometimes
+                # reset_measurement() will notify us to read immediately
+
+                # always reads 4096 bytes, even if there is no new samples - or possibly the python single thread (because of global interpreter lock)
+                # is always behind and thefore we are inherently dropping samples semi randomly!!!
+                read_data = self.r.get_data()
+                if read_data != b"":
+                    samples, _ = self.r.get_samples(read_data)
+
+                    # update invariants
+                    if len(samples) > 0:
+                        if self.current_num_samples == 0:
+                            # First set of new reads, reset min/max
+                            self.current_max = 0
+                            self.current_min = samples[0]
+                            # we need at least one sample to get an initial min
+
+                        # The following operations could be expensive, so do outside of the lock
+                        # FIXME - change all these lists into numpy arrays to use lots less CPU
+                        self.current_max = max(self.current_max, max(samples))
+                        self.current_min = min(self.current_min, min(samples))
+                        latest_sum = sum(samples)
+                        with self._result_lock:
+                            self.current_sum += latest_sum
+                            self.current_num_samples += len(samples)
+                        # logging.debug(f"PPK2 data_len={len(read_data)}, sample_len={len(samples)}")
+
+                self.num_data_reads += 1
+                self.total_data_len += len(read_data)
+                self.max_data_len = max(self.max_data_len, len(read_data))
+
+    def get_min_current_mA(self):
+        """Return the min current in mA."""
+        return self.current_min / 1000
+
+    def get_max_current_mA(self):
+        """Return the max current in mA."""
+        return self.current_max / 1000
+
+    def get_average_current_mA(self):
+        """Return the average current in mA."""
+        with self._result_lock:
+            if self.current_num_samples != 0:
+                # If we have new samples, calculate a new average
+                self.current_average = self.current_sum / self.current_num_samples
+
+            # Even if we don't have new samples, return the last calculated average
+            # measurements are in microamperes, divide by 1000
+            return self.current_average / 1000
+
+    def reset_measurements(self):
+        """Reset current measurements."""
+        # Use the last reading as the new only reading (to ensure we always have a valid current reading)
+        self.current_sum = 0
+        self.current_num_samples = 0
+
+        # if self.num_data_reads:
+        #    logging.debug(f"max data len = {self.max_data_len},avg {self.total_data_len/self.num_data_reads}, num reads={self.num_data_reads}")
+        # Summary stats for performance monitoring
+        self.num_data_reads = 0
+        self.total_data_len = 0
+        self.max_data_len = 0
+
+        with self._want_measurement:
+            self._want_measurement.notify()  # notify the measurement loop to read immediately
+
+    def close(self) -> None:
+        """Close the power meter."""
+        self.measuring = False
+        self.r.stop_measuring()  # send command to ppk2
+        self.measurement_thread.join()  # wait for our thread to finish
+        super().close()
+
+    def setIsSupply(self, is_supply: bool):
+        """If in supply mode we will provide power ourself, otherwise we are just an amp meter."""
+
+        assert self.v > 0.8  # We must set a valid voltage before calling this method
+
+        self.r.set_source_voltage(
+            int(self.v * 1000)
+        )  # set source voltage in mV BEFORE setting source mode
+        # Note: source voltage must be set even if we are using the amp meter mode
+
+        # must be after setting source voltage and before setting mode
+        self.r.start_measuring()  # send command to ppk2
+
+        if (
+            not is_supply
+        ):  # min power outpuf of PPK2.  If less than this assume we want just meter mode.
+            self.r.use_ampere_meter()
+        else:
+            self.r.use_source_meter()  # set source meter mode
+
+        if not self.measurement_thread.is_alive():
+            self.measuring = True
+            self.reset_measurements()
+
+            # We can't start reading from the thread until vdd is set, so start running the thread now
+            self.measurement_thread.start()
+            time.sleep(
+                0.2
+            )  # FIXME - crufty way to ensure we do one set of reads to discard bogus fake power readings in the FIFO
+            self.reset_measurements()
+
+    def powerOn(self):
+        """Power on the supply."""
+        self.r.toggle_DUT_power("ON")
+
+    def powerOff(self):
+        """Power off the supply."""
+        self.r.toggle_DUT_power("OFF")

meshtastic/powermon/riden.py

@@ -0,0 +1,57 @@
+"""code logging power consumption of meshtastic devices."""
+
+import logging
+from datetime import datetime
+
+from riden import Riden
+
+from .power_supply import PowerSupply
+
+
+class RidenPowerSupply(PowerSupply):
+    """Interface for talking to Riden programmable bench-top power supplies.
+    Only RD6006 tested but others should be similar.
+    """
+
+    def __init__(self, portName: str = "/dev/ttyUSB0"):
+        """Initialize the RidenPowerSupply object.
+
+        portName (str, optional): The port name of the power supply. Defaults to "/dev/ttyUSB0".
+        """
+        self.r = r = Riden(port=portName, baudrate=115200, address=1)
+        logging.info(
+            f"Connected to Riden power supply: model {r.type}, sn {r.sn}, firmware {r.fw}. Date/time updated."
+        )
+        r.set_date_time(datetime.now())
+        self.prevWattHour = self._getRawWattHour()
+        self.nowWattHour = self.prevWattHour
+        super().__init__()  # we call this late so that the port is already open and _getRawWattHour callback works
+
+    def setMaxCurrent(self, i: float):
+        """Set the maximum current the supply will provide."""
+        self.r.set_i_set(i)
+
+    def powerOn(self):
+        """Power on the supply, with reasonable defaults for meshtastic devices."""
+        self.r.set_v_set(
+            self.v
+        )  # my WM1110 devboard header is directly connected to the 3.3V rail
+        self.r.set_output(1)
+
+    def get_average_current_mA(self) -> float:
+        """Returns average current of last measurement in mA (since last call to this method)"""
+        now = datetime.now()
+        nowWattHour = self._getRawWattHour()
+        watts = (
+            (nowWattHour - self.prevWattHour)
+            / (now - self.prevPowerTime).total_seconds()
+            * 3600
+        )
+        self.prevPowerTime = now
+        self.prevWattHour = nowWattHour
+        return watts / 1000
+
+    def _getRawWattHour(self) -> float:
+        """Get the current watt-hour reading."""
+        self.r.update()
+        return self.r.wh

meshtastic/powermon/sim.py

@@ -0,0 +1,16 @@
+"""code logging power consumption of meshtastic devices."""
+
+import math
+import time
+
+from .power_supply import PowerSupply
+
+
+class SimPowerSupply(PowerSupply):
+    """A simulated power supply for testing."""
+
+    def get_average_current_mA(self) -> float:
+        """Returns average current of last measurement in mA (since last call to this method)"""
+
+        # Sim a 20mW load that varies sinusoidally
+        return (20.0 + 5 * math.sin(time.time()))

meshtastic/powermon/stress.py

@@ -0,0 +1,117 @@
+"""Power stress testing support.
+"""
+import logging
+import time
+
+from ..protobuf import portnums_pb2, powermon_pb2
+
+
+def onPowerStressResponse(packet, interface):
+    """Delete me? FIXME"""
+    logging.debug(f"packet:{packet} interface:{interface}")
+    # interface.gotResponse = True
+
+
+class PowerStressClient:
+    """
+    The client stub for talking to the firmware PowerStress module.
+    """
+
+    def __init__(self, iface, node_id=None):
+        """
+        Create a new PowerStressClient instance.
+
+        iface is the already open MeshInterface instance
+        """
+        self.iface = iface
+
+        if not node_id:
+            node_id = iface.myInfo.my_node_num
+
+        self.node_id = node_id
+        # No need to subscribe - because we
+        # pub.subscribe(onGPIOreceive, "meshtastic.receive.powerstress")
+
+    def sendPowerStress(
+        self,
+        cmd: powermon_pb2.PowerStressMessage.Opcode.ValueType,
+        num_seconds: float = 0.0,
+        onResponse=None,
+    ):
+        """Client goo for talking with the device side agent."""
+        r = powermon_pb2.PowerStressMessage()
+        r.cmd = cmd
+        r.num_seconds = num_seconds
+
+        return self.iface.sendData(
+            r,
+            self.node_id,
+            portnums_pb2.POWERSTRESS_APP,
+            wantAck=True,
+            wantResponse=True,
+            onResponse=onResponse,
+            onResponseAckPermitted=True,
+        )
+
+    def syncPowerStress(
+        self,
+        cmd: powermon_pb2.PowerStressMessage.Opcode.ValueType,
+        num_seconds: float = 0.0,
+    ):
+        """Send a power stress command and wait for the ack."""
+        gotAck = False
+
+        def onResponse(packet: dict):  # pylint: disable=unused-argument
+            nonlocal gotAck
+            gotAck = True
+
+        logging.info(
+            f"Sending power stress command {powermon_pb2.PowerStressMessage.Opcode.Name(cmd)}"
+        )
+        self.sendPowerStress(cmd, onResponse=onResponse, num_seconds=num_seconds)
+
+        if num_seconds == 0.0:
+            # Wait for the response and then continue
+            while not gotAck:
+                time.sleep(0.1)
+        else:
+            # we wait a little bit longer than the time the UUT would be waiting (to make sure all of its messages are handled first)
+            time.sleep(
+                num_seconds + 0.2
+            )  # completely block our thread for the duration of the test
+            if not gotAck:
+                logging.error("Did not receive ack for power stress command!")
+
+
+class PowerStress:
+    """Walk the UUT through a set of power states so we can capture repeatable power consumption measurements."""
+
+    def __init__(self, iface):
+        self.client = PowerStressClient(iface)
+
+    def run(self):
+        """Run the power stress test."""
+        try:
+            self.client.syncPowerStress(powermon_pb2.PowerStressMessage.PRINT_INFO)
+
+            num_seconds = 5.0
+            states = [
+                powermon_pb2.PowerStressMessage.LED_ON,
+                powermon_pb2.PowerStressMessage.LED_OFF,
+                powermon_pb2.PowerStressMessage.BT_OFF,
+                powermon_pb2.PowerStressMessage.BT_ON,
+                powermon_pb2.PowerStressMessage.CPU_FULLON,
+                powermon_pb2.PowerStressMessage.CPU_IDLE,
+                # FIXME - can't test deepsleep yet because the ttyACM device disappears.  Fix the python code to retry connections
+                # powermon_pb2.PowerStressMessage.CPU_DEEPSLEEP,
+            ]
+            for s in states:
+                s_name = powermon_pb2.PowerStressMessage.Opcode.Name(s)
+                logging.info(
+                    f"Running power stress test {s_name} for {num_seconds} seconds"
+                )
+                self.client.syncPowerStress(s, num_seconds)
+
+            logging.info("Power stress test complete.")
+        except KeyboardInterrupt as e:
+            logging.warning(f"Power stress interrupted: {e}")

meshtastic/protobuf/admin_pb2.pyi

@@ -0,0 +1,890 @@
+"""
+@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.protobuf.channel_pb2
+import meshtastic.protobuf.config_pb2
+import meshtastic.protobuf.connection_status_pb2
+import meshtastic.protobuf.device_ui_pb2
+import meshtastic.protobuf.mesh_pb2
+import meshtastic.protobuf.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.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
+        """
+        SECURITY_CONFIG: AdminMessage._ConfigType.ValueType  # 7
+        """
+        TODO: REPLACE
+        """
+        SESSIONKEY_CONFIG: AdminMessage._ConfigType.ValueType  # 8
+        """
+        Session key config
+        """
+        DEVICEUI_CONFIG: AdminMessage._ConfigType.ValueType  # 9
+        """
+        device-ui config
+        """
+
+    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
+    """
+    SECURITY_CONFIG: AdminMessage.ConfigType.ValueType  # 7
+    """
+    TODO: REPLACE
+    """
+    SESSIONKEY_CONFIG: AdminMessage.ConfigType.ValueType  # 8
+    """
+    Session key config
+    """
+    DEVICEUI_CONFIG: AdminMessage.ConfigType.ValueType  # 9
+    """
+    device-ui config
+    """
+
+    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
+    """
+
+    class _BackupLocation:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _BackupLocationEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[AdminMessage._BackupLocation.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        FLASH: AdminMessage._BackupLocation.ValueType  # 0
+        """
+        Backup to the internal flash
+        """
+        SD: AdminMessage._BackupLocation.ValueType  # 1
+        """
+        Backup to the SD card
+        """
+
+    class BackupLocation(_BackupLocation, metaclass=_BackupLocationEnumTypeWrapper): ...
+    FLASH: AdminMessage.BackupLocation.ValueType  # 0
+    """
+    Backup to the internal flash
+    """
+    SD: AdminMessage.BackupLocation.ValueType  # 1
+    """
+    Backup to the SD card
+    """
+
+    @typing.final
+    class InputEvent(google.protobuf.message.Message):
+        """
+        Input event message to be sent to the node.
+        """
+
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+        EVENT_CODE_FIELD_NUMBER: builtins.int
+        KB_CHAR_FIELD_NUMBER: builtins.int
+        TOUCH_X_FIELD_NUMBER: builtins.int
+        TOUCH_Y_FIELD_NUMBER: builtins.int
+        event_code: builtins.int
+        """
+        The input event code
+        """
+        kb_char: builtins.int
+        """
+        Keyboard character code
+        """
+        touch_x: builtins.int
+        """
+        The touch X coordinate
+        """
+        touch_y: builtins.int
+        """
+        The touch Y coordinate
+        """
+        def __init__(
+            self,
+            *,
+            event_code: builtins.int = ...,
+            kb_char: builtins.int = ...,
+            touch_x: builtins.int = ...,
+            touch_y: builtins.int = ...,
+        ) -> None: ...
+        def ClearField(self, field_name: typing.Literal["event_code", b"event_code", "kb_char", b"kb_char", "touch_x", b"touch_x", "touch_y", b"touch_y"]) -> None: ...
+
+    SESSION_PASSKEY_FIELD_NUMBER: builtins.int
+    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_SCALE_FIELD_NUMBER: builtins.int
+    BACKUP_PREFERENCES_FIELD_NUMBER: builtins.int
+    RESTORE_PREFERENCES_FIELD_NUMBER: builtins.int
+    REMOVE_BACKUP_PREFERENCES_FIELD_NUMBER: builtins.int
+    SEND_INPUT_EVENT_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
+    SET_TIME_ONLY_FIELD_NUMBER: builtins.int
+    GET_UI_CONFIG_REQUEST_FIELD_NUMBER: builtins.int
+    GET_UI_CONFIG_RESPONSE_FIELD_NUMBER: builtins.int
+    STORE_UI_CONFIG_FIELD_NUMBER: builtins.int
+    SET_IGNORED_NODE_FIELD_NUMBER: builtins.int
+    REMOVE_IGNORED_NODE_FIELD_NUMBER: builtins.int
+    BEGIN_EDIT_SETTINGS_FIELD_NUMBER: builtins.int
+    COMMIT_EDIT_SETTINGS_FIELD_NUMBER: builtins.int
+    ADD_CONTACT_FIELD_NUMBER: builtins.int
+    KEY_VERIFICATION_FIELD_NUMBER: builtins.int
+    FACTORY_RESET_DEVICE_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_CONFIG_FIELD_NUMBER: builtins.int
+    NODEDB_RESET_FIELD_NUMBER: builtins.int
+    session_passkey: builtins.bytes
+    """
+    The node generates this key and sends it with any get_x_response packets.
+    The client MUST include the same key with any set_x commands. Key expires after 300 seconds.
+    Prevents replay attacks for admin messages.
+    """
+    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)
+    """
+    get_owner_request: builtins.bool
+    """
+    Send the current owner data in the response to this message.
+    """
+    get_config_request: global___AdminMessage.ConfigType.ValueType
+    """
+    Ask for the following config data to be sent
+    """
+    get_module_config_request: global___AdminMessage.ModuleConfigType.ValueType
+    """
+    Ask for the following config data to be sent
+    """
+    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)
+    """
+    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
+    """
+    get_node_remote_hardware_pins_request: builtins.bool
+    """
+    Get 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
+    """
+    set_scale: builtins.int
+    """
+    Set zero and offset for scale chips
+    """
+    backup_preferences: global___AdminMessage.BackupLocation.ValueType
+    """
+    Backup the node's preferences
+    """
+    restore_preferences: global___AdminMessage.BackupLocation.ValueType
+    """
+    Restore the node's preferences
+    """
+    remove_backup_preferences: global___AdminMessage.BackupLocation.ValueType
+    """
+    Remove backups of the node's preferences
+    """
+    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
+    """
+    remove_fixed_position: builtins.bool
+    """
+    Clear fixed position coordinates and then set position.fixed_position = false
+    """
+    set_time_only: builtins.int
+    """
+    Set time only on the node
+    Convenience method to set the time on the node (as Net quality) without any other position data
+    """
+    get_ui_config_request: builtins.bool
+    """
+    Tell the node to send the stored ui data.
+    """
+    set_ignored_node: builtins.int
+    """
+    Set specified node-num to be ignored on the NodeDB on the device
+    """
+    remove_ignored_node: builtins.int
+    """
+    Set specified node-num to be un-ignored on the NodeDB on the device
+    """
+    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
+    """
+    factory_reset_device: builtins.int
+    """
+    Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.
+    """
+    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_config: builtins.int
+    """
+    Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.
+    """
+    nodedb_reset: builtins.bool
+    """
+    Tell the node to reset the nodedb.
+    When true, favorites are preserved through reset.
+    """
+    @property
+    def get_channel_response(self) -> meshtastic.protobuf.channel_pb2.Channel:
+        """
+        TODO: REPLACE
+        """
+
+    @property
+    def get_owner_response(self) -> meshtastic.protobuf.mesh_pb2.User:
+        """
+        TODO: REPLACE
+        """
+
+    @property
+    def get_config_response(self) -> meshtastic.protobuf.config_pb2.Config:
+        """
+        Send the current Config in the response to this message.
+        """
+
+    @property
+    def get_module_config_response(self) -> meshtastic.protobuf.module_config_pb2.ModuleConfig:
+        """
+        Send the current Config in the response to this message.
+        """
+
+    @property
+    def get_device_metadata_response(self) -> meshtastic.protobuf.mesh_pb2.DeviceMetadata:
+        """
+        Device metadata response
+        """
+
+    @property
+    def get_device_connection_status_response(self) -> meshtastic.protobuf.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
+        """
+
+    @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
+        """
+
+    @property
+    def send_input_event(self) -> global___AdminMessage.InputEvent:
+        """
+        Send an input event to the node.
+        This is used to trigger physical input events like button presses, touch events, etc.
+        """
+
+    @property
+    def set_owner(self) -> meshtastic.protobuf.mesh_pb2.User:
+        """
+        Set the owner for this node
+        """
+
+    @property
+    def set_channel(self) -> meshtastic.protobuf.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.protobuf.config_pb2.Config:
+        """
+        Set the current Config
+        """
+
+    @property
+    def set_module_config(self) -> meshtastic.protobuf.module_config_pb2.ModuleConfig:
+        """
+        Set the current Config
+        """
+
+    @property
+    def set_fixed_position(self) -> meshtastic.protobuf.mesh_pb2.Position:
+        """
+        Set fixed position data on the node and then set the position.fixed_position = true
+        """
+
+    @property
+    def get_ui_config_response(self) -> meshtastic.protobuf.device_ui_pb2.DeviceUIConfig:
+        """
+        Reply stored device ui data.
+        """
+
+    @property
+    def store_ui_config(self) -> meshtastic.protobuf.device_ui_pb2.DeviceUIConfig:
+        """
+        Tell the node to store UI data persistently.
+        """
+
+    @property
+    def add_contact(self) -> global___SharedContact:
+        """
+        Add a contact (User) to the nodedb
+        """
+
+    @property
+    def key_verification(self) -> global___KeyVerificationAdmin:
+        """
+        Initiate or respond to a key verification request
+        """
+
+    def __init__(
+        self,
+        *,
+        session_passkey: builtins.bytes = ...,
+        get_channel_request: builtins.int = ...,
+        get_channel_response: meshtastic.protobuf.channel_pb2.Channel | None = ...,
+        get_owner_request: builtins.bool = ...,
+        get_owner_response: meshtastic.protobuf.mesh_pb2.User | None = ...,
+        get_config_request: global___AdminMessage.ConfigType.ValueType = ...,
+        get_config_response: meshtastic.protobuf.config_pb2.Config | None = ...,
+        get_module_config_request: global___AdminMessage.ModuleConfigType.ValueType = ...,
+        get_module_config_response: meshtastic.protobuf.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.protobuf.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.protobuf.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_scale: builtins.int = ...,
+        backup_preferences: global___AdminMessage.BackupLocation.ValueType = ...,
+        restore_preferences: global___AdminMessage.BackupLocation.ValueType = ...,
+        remove_backup_preferences: global___AdminMessage.BackupLocation.ValueType = ...,
+        send_input_event: global___AdminMessage.InputEvent | None = ...,
+        set_owner: meshtastic.protobuf.mesh_pb2.User | None = ...,
+        set_channel: meshtastic.protobuf.channel_pb2.Channel | None = ...,
+        set_config: meshtastic.protobuf.config_pb2.Config | None = ...,
+        set_module_config: meshtastic.protobuf.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.protobuf.mesh_pb2.Position | None = ...,
+        remove_fixed_position: builtins.bool = ...,
+        set_time_only: builtins.int = ...,
+        get_ui_config_request: builtins.bool = ...,
+        get_ui_config_response: meshtastic.protobuf.device_ui_pb2.DeviceUIConfig | None = ...,
+        store_ui_config: meshtastic.protobuf.device_ui_pb2.DeviceUIConfig | None = ...,
+        set_ignored_node: builtins.int = ...,
+        remove_ignored_node: builtins.int = ...,
+        begin_edit_settings: builtins.bool = ...,
+        commit_edit_settings: builtins.bool = ...,
+        add_contact: global___SharedContact | None = ...,
+        key_verification: global___KeyVerificationAdmin | None = ...,
+        factory_reset_device: builtins.int = ...,
+        reboot_ota_seconds: builtins.int = ...,
+        exit_simulator: builtins.bool = ...,
+        reboot_seconds: builtins.int = ...,
+        shutdown_seconds: builtins.int = ...,
+        factory_reset_config: builtins.int = ...,
+        nodedb_reset: builtins.bool = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["add_contact", b"add_contact", "backup_preferences", b"backup_preferences", "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_config", b"factory_reset_config", "factory_reset_device", b"factory_reset_device", "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", "get_ui_config_request", b"get_ui_config_request", "get_ui_config_response", b"get_ui_config_response", "key_verification", b"key_verification", "nodedb_reset", b"nodedb_reset", "payload_variant", b"payload_variant", "reboot_ota_seconds", b"reboot_ota_seconds", "reboot_seconds", b"reboot_seconds", "remove_backup_preferences", b"remove_backup_preferences", "remove_by_nodenum", b"remove_by_nodenum", "remove_favorite_node", b"remove_favorite_node", "remove_fixed_position", b"remove_fixed_position", "remove_ignored_node", b"remove_ignored_node", "restore_preferences", b"restore_preferences", "send_input_event", b"send_input_event", "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_ignored_node", b"set_ignored_node", "set_module_config", b"set_module_config", "set_owner", b"set_owner", "set_ringtone_message", b"set_ringtone_message", "set_scale", b"set_scale", "set_time_only", b"set_time_only", "shutdown_seconds", b"shutdown_seconds", "store_ui_config", b"store_ui_config"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["add_contact", b"add_contact", "backup_preferences", b"backup_preferences", "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_config", b"factory_reset_config", "factory_reset_device", b"factory_reset_device", "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", "get_ui_config_request", b"get_ui_config_request", "get_ui_config_response", b"get_ui_config_response", "key_verification", b"key_verification", "nodedb_reset", b"nodedb_reset", "payload_variant", b"payload_variant", "reboot_ota_seconds", b"reboot_ota_seconds", "reboot_seconds", b"reboot_seconds", "remove_backup_preferences", b"remove_backup_preferences", "remove_by_nodenum", b"remove_by_nodenum", "remove_favorite_node", b"remove_favorite_node", "remove_fixed_position", b"remove_fixed_position", "remove_ignored_node", b"remove_ignored_node", "restore_preferences", b"restore_preferences", "send_input_event", b"send_input_event", "session_passkey", b"session_passkey", "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_ignored_node", b"set_ignored_node", "set_module_config", b"set_module_config", "set_owner", b"set_owner", "set_ringtone_message", b"set_ringtone_message", "set_scale", b"set_scale", "set_time_only", b"set_time_only", "shutdown_seconds", b"shutdown_seconds", "store_ui_config", b"store_ui_config"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["payload_variant", b"payload_variant"]) -> typing.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_scale", "backup_preferences", "restore_preferences", "remove_backup_preferences", "send_input_event", "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", "set_time_only", "get_ui_config_request", "get_ui_config_response", "store_ui_config", "set_ignored_node", "remove_ignored_node", "begin_edit_settings", "commit_edit_settings", "add_contact", "key_verification", "factory_reset_device", "reboot_ota_seconds", "exit_simulator", "reboot_seconds", "shutdown_seconds", "factory_reset_config", "nodedb_reset"] | None: ...
+
+global___AdminMessage = AdminMessage
+
+@typing.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.Literal["call_sign", b"call_sign", "frequency", b"frequency", "short_name", b"short_name", "tx_power", b"tx_power"]) -> None: ...
+
+global___HamParameters = HamParameters
+
+@typing.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.protobuf.mesh_pb2.NodeRemoteHardwarePin]:
+        """
+        Nodes and their respective remote hardware GPIO pins
+        """
+
+    def __init__(
+        self,
+        *,
+        node_remote_hardware_pins: collections.abc.Iterable[meshtastic.protobuf.mesh_pb2.NodeRemoteHardwarePin] | None = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["node_remote_hardware_pins", b"node_remote_hardware_pins"]) -> None: ...
+
+global___NodeRemoteHardwarePinsResponse = NodeRemoteHardwarePinsResponse
+
+@typing.final
+class SharedContact(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    NODE_NUM_FIELD_NUMBER: builtins.int
+    USER_FIELD_NUMBER: builtins.int
+    SHOULD_IGNORE_FIELD_NUMBER: builtins.int
+    MANUALLY_VERIFIED_FIELD_NUMBER: builtins.int
+    node_num: builtins.int
+    """
+    The node number of the contact
+    """
+    should_ignore: builtins.bool
+    """
+    Add this contact to the blocked / ignored list
+    """
+    manually_verified: builtins.bool
+    """
+    Set the IS_KEY_MANUALLY_VERIFIED bit
+    """
+    @property
+    def user(self) -> meshtastic.protobuf.mesh_pb2.User:
+        """
+        The User of the contact
+        """
+
+    def __init__(
+        self,
+        *,
+        node_num: builtins.int = ...,
+        user: meshtastic.protobuf.mesh_pb2.User | None = ...,
+        should_ignore: builtins.bool = ...,
+        manually_verified: builtins.bool = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["user", b"user"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["manually_verified", b"manually_verified", "node_num", b"node_num", "should_ignore", b"should_ignore", "user", b"user"]) -> None: ...
+
+global___SharedContact = SharedContact
+
+@typing.final
+class KeyVerificationAdmin(google.protobuf.message.Message):
+    """
+    This message is used by a client to initiate or complete a key verification
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _MessageType:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _MessageTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[KeyVerificationAdmin._MessageType.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        INITIATE_VERIFICATION: KeyVerificationAdmin._MessageType.ValueType  # 0
+        """
+        This is the first stage, where a client initiates
+        """
+        PROVIDE_SECURITY_NUMBER: KeyVerificationAdmin._MessageType.ValueType  # 1
+        """
+        After the nonce has been returned over the mesh, the client prompts for the security number
+        And uses this message to provide it to the node.
+        """
+        DO_VERIFY: KeyVerificationAdmin._MessageType.ValueType  # 2
+        """
+        Once the user has compared the verification message, this message notifies the node.
+        """
+        DO_NOT_VERIFY: KeyVerificationAdmin._MessageType.ValueType  # 3
+        """
+        This is the cancel path, can be taken at any point
+        """
+
+    class MessageType(_MessageType, metaclass=_MessageTypeEnumTypeWrapper):
+        """
+        Three stages of this request.
+        """
+
+    INITIATE_VERIFICATION: KeyVerificationAdmin.MessageType.ValueType  # 0
+    """
+    This is the first stage, where a client initiates
+    """
+    PROVIDE_SECURITY_NUMBER: KeyVerificationAdmin.MessageType.ValueType  # 1
+    """
+    After the nonce has been returned over the mesh, the client prompts for the security number
+    And uses this message to provide it to the node.
+    """
+    DO_VERIFY: KeyVerificationAdmin.MessageType.ValueType  # 2
+    """
+    Once the user has compared the verification message, this message notifies the node.
+    """
+    DO_NOT_VERIFY: KeyVerificationAdmin.MessageType.ValueType  # 3
+    """
+    This is the cancel path, can be taken at any point
+    """
+
+    MESSAGE_TYPE_FIELD_NUMBER: builtins.int
+    REMOTE_NODENUM_FIELD_NUMBER: builtins.int
+    NONCE_FIELD_NUMBER: builtins.int
+    SECURITY_NUMBER_FIELD_NUMBER: builtins.int
+    message_type: global___KeyVerificationAdmin.MessageType.ValueType
+    remote_nodenum: builtins.int
+    """
+    The nodenum we're requesting
+    """
+    nonce: builtins.int
+    """
+    The nonce is used to track the connection
+    """
+    security_number: builtins.int
+    """
+    The 4 digit code generated by the remote node, and communicated outside the mesh
+    """
+    def __init__(
+        self,
+        *,
+        message_type: global___KeyVerificationAdmin.MessageType.ValueType = ...,
+        remote_nodenum: builtins.int = ...,
+        nonce: builtins.int = ...,
+        security_number: builtins.int | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_security_number", b"_security_number", "security_number", b"security_number"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_security_number", b"_security_number", "message_type", b"message_type", "nonce", b"nonce", "remote_nodenum", b"remote_nodenum", "security_number", b"security_number"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["_security_number", b"_security_number"]) -> typing.Literal["security_number"] | None: ...
+
+global___KeyVerificationAdmin = KeyVerificationAdmin

meshtastic/protobuf/apponly_pb2.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/apponly.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from meshtastic.protobuf import channel_pb2 as meshtastic_dot_protobuf_dot_channel__pb2
+from meshtastic.protobuf import config_pb2 as meshtastic_dot_protobuf_dot_config__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n!meshtastic/protobuf/apponly.proto\x12\x13meshtastic.protobuf\x1a!meshtastic/protobuf/channel.proto\x1a meshtastic/protobuf/config.proto\"\x81\x01\n\nChannelSet\x12\x36\n\x08settings\x18\x01 \x03(\x0b\x32$.meshtastic.protobuf.ChannelSettings\x12;\n\x0blora_config\x18\x02 \x01(\x0b\x32&.meshtastic.protobuf.Config.LoRaConfigBc\n\x14org.meshtastic.protoB\rAppOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.apponly_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\rAppOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _globals['_CHANNELSET']._serialized_start=128
+  _globals['_CHANNELSET']._serialized_end=257
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/apponly_pb2.pyi

@@ -0,0 +1,52 @@
+"""
+@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.protobuf.channel_pb2
+import meshtastic.protobuf.config_pb2
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.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.protobuf.channel_pb2.ChannelSettings]:
+        """
+        Channel list with settings
+        """
+
+    @property
+    def lora_config(self) -> meshtastic.protobuf.config_pb2.Config.LoRaConfig:
+        """
+        LoRa config
+        """
+
+    def __init__(
+        self,
+        *,
+        settings: collections.abc.Iterable[meshtastic.protobuf.channel_pb2.ChannelSettings] | None = ...,
+        lora_config: meshtastic.protobuf.config_pb2.Config.LoRaConfig | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["lora_config", b"lora_config"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["lora_config", b"lora_config", "settings", b"settings"]) -> None: ...
+
+global___ChannelSet = ChannelSet

meshtastic/protobuf/atak_pb2.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/atak.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1emeshtastic/protobuf/atak.proto\x12\x13meshtastic.protobuf\"\xa5\x02\n\tTAKPacket\x12\x15\n\ris_compressed\x18\x01 \x01(\x08\x12-\n\x07\x63ontact\x18\x02 \x01(\x0b\x32\x1c.meshtastic.protobuf.Contact\x12)\n\x05group\x18\x03 \x01(\x0b\x32\x1a.meshtastic.protobuf.Group\x12+\n\x06status\x18\x04 \x01(\x0b\x32\x1b.meshtastic.protobuf.Status\x12\'\n\x03pli\x18\x05 \x01(\x0b\x32\x18.meshtastic.protobuf.PLIH\x00\x12,\n\x04\x63hat\x18\x06 \x01(\x0b\x32\x1c.meshtastic.protobuf.GeoChatH\x00\x12\x10\n\x06\x64\x65tail\x18\x07 \x01(\x0cH\x00\x42\x11\n\x0fpayload_variant\"\\\n\x07GeoChat\x12\x0f\n\x07message\x18\x01 \x01(\t\x12\x0f\n\x02to\x18\x02 \x01(\tH\x00\x88\x01\x01\x12\x18\n\x0bto_callsign\x18\x03 \x01(\tH\x01\x88\x01\x01\x42\x05\n\x03_toB\x0e\n\x0c_to_callsign\"_\n\x05Group\x12-\n\x04role\x18\x01 \x01(\x0e\x32\x1f.meshtastic.protobuf.MemberRole\x12\'\n\x04team\x18\x02 \x01(\x0e\x32\x19.meshtastic.protobuf.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\x14org.meshtastic.protoB\nATAKProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.atak_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\nATAKProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _globals['_TEAM']._serialized_start=721
+  _globals['_TEAM']._serialized_end=913
+  _globals['_MEMBERROLE']._serialized_start=915
+  _globals['_MEMBERROLE']._serialized_end=1042
+  _globals['_TAKPACKET']._serialized_start=56
+  _globals['_TAKPACKET']._serialized_end=349
+  _globals['_GEOCHAT']._serialized_start=351
+  _globals['_GEOCHAT']._serialized_end=443
+  _globals['_GROUP']._serialized_start=445
+  _globals['_GROUP']._serialized_end=540
+  _globals['_STATUS']._serialized_start=542
+  _globals['_STATUS']._serialized_end=567
+  _globals['_CONTACT']._serialized_start=569
+  _globals['_CONTACT']._serialized_end=621
+  _globals['_PLI']._serialized_start=623
+  _globals['_PLI']._serialized_end=718
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/atak_pb2.pyi

@@ -0,0 +1,477 @@
+"""
+@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.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
+    DETAIL_FIELD_NUMBER: builtins.int
+    is_compressed: builtins.bool
+    """
+    Are the payloads strings compressed for LoRA transport?
+    """
+    detail: builtins.bytes
+    """
+    Generic CoT detail XML
+    May be compressed / truncated by the sender (EUD)
+    """
+    @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 = ...,
+        detail: builtins.bytes = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["chat", b"chat", "contact", b"contact", "detail", b"detail", "group", b"group", "payload_variant", b"payload_variant", "pli", b"pli", "status", b"status"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["chat", b"chat", "contact", b"contact", "detail", b"detail", "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.Literal["payload_variant", b"payload_variant"]) -> typing.Literal["pli", "chat", "detail"] | None: ...
+
+global___TAKPacket = TAKPacket
+
+@typing.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
+    TO_CALLSIGN_FIELD_NUMBER: builtins.int
+    message: builtins.str
+    """
+    The text message
+    """
+    to: builtins.str
+    """
+    Uid recipient of the message
+    """
+    to_callsign: builtins.str
+    """
+    Callsign of the recipient for the message
+    """
+    def __init__(
+        self,
+        *,
+        message: builtins.str = ...,
+        to: builtins.str | None = ...,
+        to_callsign: builtins.str | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_to", b"_to", "_to_callsign", b"_to_callsign", "to", b"to", "to_callsign", b"to_callsign"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_to", b"_to", "_to_callsign", b"_to_callsign", "message", b"message", "to", b"to", "to_callsign", b"to_callsign"]) -> None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_to", b"_to"]) -> typing.Literal["to"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_to_callsign", b"_to_callsign"]) -> typing.Literal["to_callsign"] | None: ...
+
+global___GeoChat = GeoChat
+
+@typing.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.Literal["role", b"role", "team", b"team"]) -> None: ...
+
+global___Group = Group
+
+@typing.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.Literal["battery", b"battery"]) -> None: ...
+
+global___Status = Status
+
+@typing.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.Literal["callsign", b"callsign", "device_callsign", b"device_callsign"]) -> None: ...
+
+global___Contact = Contact
+
+@typing.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.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/protobuf/cannedmessages_pb2.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/cannedmessages.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n(meshtastic/protobuf/cannedmessages.proto\x12\x13meshtastic.protobuf\"-\n\x19\x43\x61nnedMessageModuleConfig\x12\x10\n\x08messages\x18\x01 \x01(\tBo\n\x14org.meshtastic.protoB\x19\x43\x61nnedMessageConfigProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.cannedmessages_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\031CannedMessageConfigProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _globals['_CANNEDMESSAGEMODULECONFIG']._serialized_start=65
+  _globals['_CANNEDMESSAGEMODULECONFIG']._serialized_end=110
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/cannedmessages_pb2.pyi

@@ -0,0 +1,33 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.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.Literal["messages", b"messages"]) -> None: ...
+
+global___CannedMessageModuleConfig = CannedMessageModuleConfig

meshtastic/protobuf/channel_pb2.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/channel.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n!meshtastic/protobuf/channel.proto\x12\x13meshtastic.protobuf\"\xc1\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<\n\x0fmodule_settings\x18\x07 \x01(\x0b\x32#.meshtastic.protobuf.ModuleSettings\">\n\x0eModuleSettings\x12\x1a\n\x12position_precision\x18\x01 \x01(\r\x12\x10\n\x08is_muted\x18\x02 \x01(\x08\"\xb3\x01\n\x07\x43hannel\x12\r\n\x05index\x18\x01 \x01(\x05\x12\x36\n\x08settings\x18\x02 \x01(\x0b\x32$.meshtastic.protobuf.ChannelSettings\x12/\n\x04role\x18\x03 \x01(\x0e\x32!.meshtastic.protobuf.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\x63\n\x14org.meshtastic.protoB\rChannelProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.channel_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\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'
+  _globals['_CHANNELSETTINGS']._serialized_start=59
+  _globals['_CHANNELSETTINGS']._serialized_end=252
+  _globals['_MODULESETTINGS']._serialized_start=254
+  _globals['_MODULESETTINGS']._serialized_end=316
+  _globals['_CHANNEL']._serialized_start=319
+  _globals['_CHANNEL']._serialized_end=498
+  _globals['_CHANNEL_ROLE']._serialized_start=450
+  _globals['_CHANNEL_ROLE']._serialized_end=498
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/channel_pb2.pyi

@@ -0,0 +1,234 @@
+"""
+@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.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.Literal["module_settings", b"module_settings"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.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.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_MUTED_FIELD_NUMBER: builtins.int
+    position_precision: builtins.int
+    """
+    Bits of precision for the location sent in position packets.
+    """
+    is_muted: builtins.bool
+    """
+    Controls whether or not the client / device 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_muted: builtins.bool = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["is_muted", b"is_muted", "position_precision", b"position_precision"]) -> None: ...
+
+global___ModuleSettings = ModuleSettings
+
+@typing.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.
+    """
+    role: global___Channel.Role.ValueType
+    """
+    TODO: REPLACE
+    """
+    @property
+    def settings(self) -> global___ChannelSettings:
+        """
+        The new settings, or NULL to disable that channel
+        """
+
+    def __init__(
+        self,
+        *,
+        index: builtins.int = ...,
+        settings: global___ChannelSettings | None = ...,
+        role: global___Channel.Role.ValueType = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["settings", b"settings"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["index", b"index", "role", b"role", "settings", b"settings"]) -> None: ...
+
+global___Channel = Channel

meshtastic/protobuf/clientonly_pb2.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/clientonly.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from meshtastic.protobuf import localonly_pb2 as meshtastic_dot_protobuf_dot_localonly__pb2
+from meshtastic.protobuf import mesh_pb2 as meshtastic_dot_protobuf_dot_mesh__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n$meshtastic/protobuf/clientonly.proto\x12\x13meshtastic.protobuf\x1a#meshtastic/protobuf/localonly.proto\x1a\x1emeshtastic/protobuf/mesh.proto\"\xc4\x03\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\x35\n\x06\x63onfig\x18\x04 \x01(\x0b\x32 .meshtastic.protobuf.LocalConfigH\x03\x88\x01\x01\x12\x42\n\rmodule_config\x18\x05 \x01(\x0b\x32&.meshtastic.protobuf.LocalModuleConfigH\x04\x88\x01\x01\x12:\n\x0e\x66ixed_position\x18\x06 \x01(\x0b\x32\x1d.meshtastic.protobuf.PositionH\x05\x88\x01\x01\x12\x15\n\x08ringtone\x18\x07 \x01(\tH\x06\x88\x01\x01\x12\x1c\n\x0f\x63\x61nned_messages\x18\x08 \x01(\tH\x07\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_configB\x11\n\x0f_fixed_positionB\x0b\n\t_ringtoneB\x12\n\x10_canned_messagesBf\n\x14org.meshtastic.protoB\x10\x43lientOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.clientonly_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\020ClientOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _globals['_DEVICEPROFILE']._serialized_start=131
+  _globals['_DEVICEPROFILE']._serialized_end=583
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/clientonly_pb2.pyi

@@ -0,0 +1,101 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import meshtastic.protobuf.localonly_pb2
+import meshtastic.protobuf.mesh_pb2
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.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
+    FIXED_POSITION_FIELD_NUMBER: builtins.int
+    RINGTONE_FIELD_NUMBER: builtins.int
+    CANNED_MESSAGES_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
+    """
+    ringtone: builtins.str
+    """
+    Ringtone for ExternalNotification
+    """
+    canned_messages: builtins.str
+    """
+    Predefined messages for CannedMessage
+    """
+    @property
+    def config(self) -> meshtastic.protobuf.localonly_pb2.LocalConfig:
+        """
+        The Config of the node
+        """
+
+    @property
+    def module_config(self) -> meshtastic.protobuf.localonly_pb2.LocalModuleConfig:
+        """
+        The ModuleConfig of the node
+        """
+
+    @property
+    def fixed_position(self) -> meshtastic.protobuf.mesh_pb2.Position:
+        """
+        Fixed position data
+        """
+
+    def __init__(
+        self,
+        *,
+        long_name: builtins.str | None = ...,
+        short_name: builtins.str | None = ...,
+        channel_url: builtins.str | None = ...,
+        config: meshtastic.protobuf.localonly_pb2.LocalConfig | None = ...,
+        module_config: meshtastic.protobuf.localonly_pb2.LocalModuleConfig | None = ...,
+        fixed_position: meshtastic.protobuf.mesh_pb2.Position | None = ...,
+        ringtone: builtins.str | None = ...,
+        canned_messages: builtins.str | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_canned_messages", b"_canned_messages", "_channel_url", b"_channel_url", "_config", b"_config", "_fixed_position", b"_fixed_position", "_long_name", b"_long_name", "_module_config", b"_module_config", "_ringtone", b"_ringtone", "_short_name", b"_short_name", "canned_messages", b"canned_messages", "channel_url", b"channel_url", "config", b"config", "fixed_position", b"fixed_position", "long_name", b"long_name", "module_config", b"module_config", "ringtone", b"ringtone", "short_name", b"short_name"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_canned_messages", b"_canned_messages", "_channel_url", b"_channel_url", "_config", b"_config", "_fixed_position", b"_fixed_position", "_long_name", b"_long_name", "_module_config", b"_module_config", "_ringtone", b"_ringtone", "_short_name", b"_short_name", "canned_messages", b"canned_messages", "channel_url", b"channel_url", "config", b"config", "fixed_position", b"fixed_position", "long_name", b"long_name", "module_config", b"module_config", "ringtone", b"ringtone", "short_name", b"short_name"]) -> None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_canned_messages", b"_canned_messages"]) -> typing.Literal["canned_messages"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_channel_url", b"_channel_url"]) -> typing.Literal["channel_url"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_config", b"_config"]) -> typing.Literal["config"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_fixed_position", b"_fixed_position"]) -> typing.Literal["fixed_position"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_long_name", b"_long_name"]) -> typing.Literal["long_name"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_module_config", b"_module_config"]) -> typing.Literal["module_config"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_ringtone", b"_ringtone"]) -> typing.Literal["ringtone"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_short_name", b"_short_name"]) -> typing.Literal["short_name"] | None: ...
+
+global___DeviceProfile = DeviceProfile

meshtastic/protobuf/connection_status_pb2.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/connection_status.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n+meshtastic/protobuf/connection_status.proto\x12\x13meshtastic.protobuf\"\xd5\x02\n\x16\x44\x65viceConnectionStatus\x12<\n\x04wifi\x18\x01 \x01(\x0b\x32).meshtastic.protobuf.WifiConnectionStatusH\x00\x88\x01\x01\x12\x44\n\x08\x65thernet\x18\x02 \x01(\x0b\x32-.meshtastic.protobuf.EthernetConnectionStatusH\x01\x88\x01\x01\x12\x46\n\tbluetooth\x18\x03 \x01(\x0b\x32..meshtastic.protobuf.BluetoothConnectionStatusH\x02\x88\x01\x01\x12@\n\x06serial\x18\x04 \x01(\x0b\x32+.meshtastic.protobuf.SerialConnectionStatusH\x03\x88\x01\x01\x42\x07\n\x05_wifiB\x0b\n\t_ethernetB\x0c\n\n_bluetoothB\t\n\x07_serial\"p\n\x14WifiConnectionStatus\x12<\n\x06status\x18\x01 \x01(\x0b\x32,.meshtastic.protobuf.NetworkConnectionStatus\x12\x0c\n\x04ssid\x18\x02 \x01(\t\x12\x0c\n\x04rssi\x18\x03 \x01(\x05\"X\n\x18\x45thernetConnectionStatus\x12<\n\x06status\x18\x01 \x01(\x0b\x32,.meshtastic.protobuf.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\x66\n\x14org.meshtastic.protoB\x10\x43onnStatusProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.connection_status_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\020ConnStatusProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _globals['_DEVICECONNECTIONSTATUS']._serialized_start=69
+  _globals['_DEVICECONNECTIONSTATUS']._serialized_end=410
+  _globals['_WIFICONNECTIONSTATUS']._serialized_start=412
+  _globals['_WIFICONNECTIONSTATUS']._serialized_end=524
+  _globals['_ETHERNETCONNECTIONSTATUS']._serialized_start=526
+  _globals['_ETHERNETCONNECTIONSTATUS']._serialized_end=614
+  _globals['_NETWORKCONNECTIONSTATUS']._serialized_start=616
+  _globals['_NETWORKCONNECTIONSTATUS']._serialized_end=739
+  _globals['_BLUETOOTHCONNECTIONSTATUS']._serialized_start=741
+  _globals['_BLUETOOTHCONNECTIONSTATUS']._serialized_end=817
+  _globals['_SERIALCONNECTIONSTATUS']._serialized_start=819
+  _globals['_SERIALCONNECTIONSTATUS']._serialized_end=879
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/connection_status_pb2.pyi

@@ -0,0 +1,228 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.message
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.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.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.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.Literal["_bluetooth", b"_bluetooth"]) -> typing.Literal["bluetooth"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_ethernet", b"_ethernet"]) -> typing.Literal["ethernet"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_serial", b"_serial"]) -> typing.Literal["serial"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_wifi", b"_wifi"]) -> typing.Literal["wifi"] | None: ...
+
+global___DeviceConnectionStatus = DeviceConnectionStatus
+
+@typing.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
+    ssid: builtins.str
+    """
+    WiFi access point SSID
+    """
+    rssi: builtins.int
+    """
+    RSSI of wireless connection
+    """
+    @property
+    def status(self) -> global___NetworkConnectionStatus:
+        """
+        Connection status
+        """
+
+    def __init__(
+        self,
+        *,
+        status: global___NetworkConnectionStatus | None = ...,
+        ssid: builtins.str = ...,
+        rssi: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["status", b"status"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["rssi", b"rssi", "ssid", b"ssid", "status", b"status"]) -> None: ...
+
+global___WifiConnectionStatus = WifiConnectionStatus
+
+@typing.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.Literal["status", b"status"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["status", b"status"]) -> None: ...
+
+global___EthernetConnectionStatus = EthernetConnectionStatus
+
+@typing.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.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.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.Literal["is_connected", b"is_connected", "pin", b"pin", "rssi", b"rssi"]) -> None: ...
+
+global___BluetoothConnectionStatus = BluetoothConnectionStatus
+
+@typing.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.Literal["baud", b"baud", "is_connected", b"is_connected"]) -> None: ...
+
+global___SerialConnectionStatus = SerialConnectionStatus

meshtastic/protobuf/device_ui_pb2.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/device_ui.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n#meshtastic/protobuf/device_ui.proto\x12\x13meshtastic.protobuf\"\xff\x05\n\x0e\x44\x65viceUIConfig\x12\x0f\n\x07version\x18\x01 \x01(\r\x12\x19\n\x11screen_brightness\x18\x02 \x01(\r\x12\x16\n\x0escreen_timeout\x18\x03 \x01(\r\x12\x13\n\x0bscreen_lock\x18\x04 \x01(\x08\x12\x15\n\rsettings_lock\x18\x05 \x01(\x08\x12\x10\n\x08pin_code\x18\x06 \x01(\r\x12)\n\x05theme\x18\x07 \x01(\x0e\x32\x1a.meshtastic.protobuf.Theme\x12\x15\n\ralert_enabled\x18\x08 \x01(\x08\x12\x16\n\x0e\x62\x61nner_enabled\x18\t \x01(\x08\x12\x14\n\x0cring_tone_id\x18\n \x01(\r\x12/\n\x08language\x18\x0b \x01(\x0e\x32\x1d.meshtastic.protobuf.Language\x12\x34\n\x0bnode_filter\x18\x0c \x01(\x0b\x32\x1f.meshtastic.protobuf.NodeFilter\x12:\n\x0enode_highlight\x18\r \x01(\x0b\x32\".meshtastic.protobuf.NodeHighlight\x12\x18\n\x10\x63\x61libration_data\x18\x0e \x01(\x0c\x12*\n\x08map_data\x18\x0f \x01(\x0b\x32\x18.meshtastic.protobuf.Map\x12\x36\n\x0c\x63ompass_mode\x18\x10 \x01(\x0e\x32 .meshtastic.protobuf.CompassMode\x12\x18\n\x10screen_rgb_color\x18\x11 \x01(\r\x12\x1b\n\x13is_clockface_analog\x18\x12 \x01(\x08\x12K\n\ngps_format\x18\x13 \x01(\x0e\x32\x37.meshtastic.protobuf.DeviceUIConfig.GpsCoordinateFormat\"V\n\x13GpsCoordinateFormat\x12\x07\n\x03\x44\x45\x43\x10\x00\x12\x07\n\x03\x44MS\x10\x01\x12\x07\n\x03UTM\x10\x02\x12\x08\n\x04MGRS\x10\x03\x12\x07\n\x03OLC\x10\x04\x12\x08\n\x04OSGR\x10\x05\x12\x07\n\x03MLS\x10\x06\"\xa7\x01\n\nNodeFilter\x12\x16\n\x0eunknown_switch\x18\x01 \x01(\x08\x12\x16\n\x0eoffline_switch\x18\x02 \x01(\x08\x12\x19\n\x11public_key_switch\x18\x03 \x01(\x08\x12\x11\n\thops_away\x18\x04 \x01(\x05\x12\x17\n\x0fposition_switch\x18\x05 \x01(\x08\x12\x11\n\tnode_name\x18\x06 \x01(\t\x12\x0f\n\x07\x63hannel\x18\x07 \x01(\x05\"~\n\rNodeHighlight\x12\x13\n\x0b\x63hat_switch\x18\x01 \x01(\x08\x12\x17\n\x0fposition_switch\x18\x02 \x01(\x08\x12\x18\n\x10telemetry_switch\x18\x03 \x01(\x08\x12\x12\n\niaq_switch\x18\x04 \x01(\x08\x12\x11\n\tnode_name\x18\x05 \x01(\t\"=\n\x08GeoPoint\x12\x0c\n\x04zoom\x18\x01 \x01(\x05\x12\x10\n\x08latitude\x18\x02 \x01(\x05\x12\x11\n\tlongitude\x18\x03 \x01(\x05\"U\n\x03Map\x12+\n\x04home\x18\x01 \x01(\x0b\x32\x1d.meshtastic.protobuf.GeoPoint\x12\r\n\x05style\x18\x02 \x01(\t\x12\x12\n\nfollow_gps\x18\x03 \x01(\x08*>\n\x0b\x43ompassMode\x12\x0b\n\x07\x44YNAMIC\x10\x00\x12\x0e\n\nFIXED_RING\x10\x01\x12\x12\n\x0e\x46REEZE_HEADING\x10\x02*%\n\x05Theme\x12\x08\n\x04\x44\x41RK\x10\x00\x12\t\n\x05LIGHT\x10\x01\x12\x07\n\x03RED\x10\x02*\xc0\x02\n\x08Language\x12\x0b\n\x07\x45NGLISH\x10\x00\x12\n\n\x06\x46RENCH\x10\x01\x12\n\n\x06GERMAN\x10\x02\x12\x0b\n\x07ITALIAN\x10\x03\x12\x0e\n\nPORTUGUESE\x10\x04\x12\x0b\n\x07SPANISH\x10\x05\x12\x0b\n\x07SWEDISH\x10\x06\x12\x0b\n\x07\x46INNISH\x10\x07\x12\n\n\x06POLISH\x10\x08\x12\x0b\n\x07TURKISH\x10\t\x12\x0b\n\x07SERBIAN\x10\n\x12\x0b\n\x07RUSSIAN\x10\x0b\x12\t\n\x05\x44UTCH\x10\x0c\x12\t\n\x05GREEK\x10\r\x12\r\n\tNORWEGIAN\x10\x0e\x12\r\n\tSLOVENIAN\x10\x0f\x12\r\n\tUKRAINIAN\x10\x10\x12\r\n\tBULGARIAN\x10\x11\x12\t\n\x05\x43ZECH\x10\x12\x12\n\n\x06\x44\x41NISH\x10\x13\x12\x16\n\x12SIMPLIFIED_CHINESE\x10\x1e\x12\x17\n\x13TRADITIONAL_CHINESE\x10\x1f\x42\x64\n\x14org.meshtastic.protoB\x0e\x44\x65viceUIProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.device_ui_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\016DeviceUIProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _globals['_COMPASSMODE']._serialized_start=1278
+  _globals['_COMPASSMODE']._serialized_end=1340
+  _globals['_THEME']._serialized_start=1342
+  _globals['_THEME']._serialized_end=1379
+  _globals['_LANGUAGE']._serialized_start=1382
+  _globals['_LANGUAGE']._serialized_end=1702
+  _globals['_DEVICEUICONFIG']._serialized_start=61
+  _globals['_DEVICEUICONFIG']._serialized_end=828
+  _globals['_DEVICEUICONFIG_GPSCOORDINATEFORMAT']._serialized_start=742
+  _globals['_DEVICEUICONFIG_GPSCOORDINATEFORMAT']._serialized_end=828
+  _globals['_NODEFILTER']._serialized_start=831
+  _globals['_NODEFILTER']._serialized_end=998
+  _globals['_NODEHIGHLIGHT']._serialized_start=1000
+  _globals['_NODEHIGHLIGHT']._serialized_end=1126
+  _globals['_GEOPOINT']._serialized_start=1128
+  _globals['_GEOPOINT']._serialized_end=1189
+  _globals['_MAP']._serialized_start=1191
+  _globals['_MAP']._serialized_end=1276
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/device_ui_pb2.pyi

@@ -0,0 +1,649 @@
+"""
+@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 _CompassMode:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _CompassModeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_CompassMode.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    DYNAMIC: _CompassMode.ValueType  # 0
+    """
+    Compass with dynamic ring and heading
+    """
+    FIXED_RING: _CompassMode.ValueType  # 1
+    """
+    Compass with fixed ring and heading
+    """
+    FREEZE_HEADING: _CompassMode.ValueType  # 2
+    """
+    Compass with heading and freeze option
+    """
+
+class CompassMode(_CompassMode, metaclass=_CompassModeEnumTypeWrapper): ...
+
+DYNAMIC: CompassMode.ValueType  # 0
+"""
+Compass with dynamic ring and heading
+"""
+FIXED_RING: CompassMode.ValueType  # 1
+"""
+Compass with fixed ring and heading
+"""
+FREEZE_HEADING: CompassMode.ValueType  # 2
+"""
+Compass with heading and freeze option
+"""
+global___CompassMode = CompassMode
+
+class _Theme:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _ThemeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_Theme.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    DARK: _Theme.ValueType  # 0
+    """
+    Dark
+    """
+    LIGHT: _Theme.ValueType  # 1
+    """
+    Light
+    """
+    RED: _Theme.ValueType  # 2
+    """
+    Red
+    """
+
+class Theme(_Theme, metaclass=_ThemeEnumTypeWrapper): ...
+
+DARK: Theme.ValueType  # 0
+"""
+Dark
+"""
+LIGHT: Theme.ValueType  # 1
+"""
+Light
+"""
+RED: Theme.ValueType  # 2
+"""
+Red
+"""
+global___Theme = Theme
+
+class _Language:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _LanguageEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_Language.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    ENGLISH: _Language.ValueType  # 0
+    """
+    English
+    """
+    FRENCH: _Language.ValueType  # 1
+    """
+    French
+    """
+    GERMAN: _Language.ValueType  # 2
+    """
+    German
+    """
+    ITALIAN: _Language.ValueType  # 3
+    """
+    Italian
+    """
+    PORTUGUESE: _Language.ValueType  # 4
+    """
+    Portuguese
+    """
+    SPANISH: _Language.ValueType  # 5
+    """
+    Spanish
+    """
+    SWEDISH: _Language.ValueType  # 6
+    """
+    Swedish
+    """
+    FINNISH: _Language.ValueType  # 7
+    """
+    Finnish
+    """
+    POLISH: _Language.ValueType  # 8
+    """
+    Polish
+    """
+    TURKISH: _Language.ValueType  # 9
+    """
+    Turkish
+    """
+    SERBIAN: _Language.ValueType  # 10
+    """
+    Serbian
+    """
+    RUSSIAN: _Language.ValueType  # 11
+    """
+    Russian
+    """
+    DUTCH: _Language.ValueType  # 12
+    """
+    Dutch
+    """
+    GREEK: _Language.ValueType  # 13
+    """
+    Greek
+    """
+    NORWEGIAN: _Language.ValueType  # 14
+    """
+    Norwegian
+    """
+    SLOVENIAN: _Language.ValueType  # 15
+    """
+    Slovenian
+    """
+    UKRAINIAN: _Language.ValueType  # 16
+    """
+    Ukrainian
+    """
+    BULGARIAN: _Language.ValueType  # 17
+    """
+    Bulgarian
+    """
+    CZECH: _Language.ValueType  # 18
+    """
+    Czech
+    """
+    DANISH: _Language.ValueType  # 19
+    """
+    Danish
+    """
+    SIMPLIFIED_CHINESE: _Language.ValueType  # 30
+    """
+    Simplified Chinese (experimental)
+    """
+    TRADITIONAL_CHINESE: _Language.ValueType  # 31
+    """
+    Traditional Chinese (experimental)
+    """
+
+class Language(_Language, metaclass=_LanguageEnumTypeWrapper):
+    """
+    Localization
+    """
+
+ENGLISH: Language.ValueType  # 0
+"""
+English
+"""
+FRENCH: Language.ValueType  # 1
+"""
+French
+"""
+GERMAN: Language.ValueType  # 2
+"""
+German
+"""
+ITALIAN: Language.ValueType  # 3
+"""
+Italian
+"""
+PORTUGUESE: Language.ValueType  # 4
+"""
+Portuguese
+"""
+SPANISH: Language.ValueType  # 5
+"""
+Spanish
+"""
+SWEDISH: Language.ValueType  # 6
+"""
+Swedish
+"""
+FINNISH: Language.ValueType  # 7
+"""
+Finnish
+"""
+POLISH: Language.ValueType  # 8
+"""
+Polish
+"""
+TURKISH: Language.ValueType  # 9
+"""
+Turkish
+"""
+SERBIAN: Language.ValueType  # 10
+"""
+Serbian
+"""
+RUSSIAN: Language.ValueType  # 11
+"""
+Russian
+"""
+DUTCH: Language.ValueType  # 12
+"""
+Dutch
+"""
+GREEK: Language.ValueType  # 13
+"""
+Greek
+"""
+NORWEGIAN: Language.ValueType  # 14
+"""
+Norwegian
+"""
+SLOVENIAN: Language.ValueType  # 15
+"""
+Slovenian
+"""
+UKRAINIAN: Language.ValueType  # 16
+"""
+Ukrainian
+"""
+BULGARIAN: Language.ValueType  # 17
+"""
+Bulgarian
+"""
+CZECH: Language.ValueType  # 18
+"""
+Czech
+"""
+DANISH: Language.ValueType  # 19
+"""
+Danish
+"""
+SIMPLIFIED_CHINESE: Language.ValueType  # 30
+"""
+Simplified Chinese (experimental)
+"""
+TRADITIONAL_CHINESE: Language.ValueType  # 31
+"""
+Traditional Chinese (experimental)
+"""
+global___Language = Language
+
+@typing.final
+class DeviceUIConfig(google.protobuf.message.Message):
+    """
+    Protobuf structures for device-ui persistency
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _GpsCoordinateFormat:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _GpsCoordinateFormatEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[DeviceUIConfig._GpsCoordinateFormat.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        DEC: DeviceUIConfig._GpsCoordinateFormat.ValueType  # 0
+        """
+        GPS coordinates are displayed in the normal decimal degrees format:
+        DD.DDDDDD DDD.DDDDDD
+        """
+        DMS: DeviceUIConfig._GpsCoordinateFormat.ValueType  # 1
+        """
+        GPS coordinates are displayed in the degrees minutes seconds format:
+        DD°MM'SS"C DDD°MM'SS"C, where C is the compass point representing the locations quadrant
+        """
+        UTM: DeviceUIConfig._GpsCoordinateFormat.ValueType  # 2
+        """
+        Universal Transverse Mercator format:
+        ZZB EEEEEE NNNNNNN, where Z is zone, B is band, E is easting, N is northing
+        """
+        MGRS: DeviceUIConfig._GpsCoordinateFormat.ValueType  # 3
+        """
+        Military Grid Reference System format:
+        ZZB CD EEEEE NNNNN, where Z is zone, B is band, C is the east 100k square, D is the north 100k square,
+        E is easting, N is northing
+        """
+        OLC: DeviceUIConfig._GpsCoordinateFormat.ValueType  # 4
+        """
+        Open Location Code (aka Plus Codes).
+        """
+        OSGR: DeviceUIConfig._GpsCoordinateFormat.ValueType  # 5
+        """
+        Ordnance Survey Grid Reference (the National Grid System of the UK).
+        Format: AB EEEEE NNNNN, where A is the east 100k square, B is the north 100k square,
+        E is the easting, N is the northing
+        """
+        MLS: DeviceUIConfig._GpsCoordinateFormat.ValueType  # 6
+        """
+        Maidenhead Locator System
+        Described here: https://en.wikipedia.org/wiki/Maidenhead_Locator_System
+        """
+
+    class GpsCoordinateFormat(_GpsCoordinateFormat, metaclass=_GpsCoordinateFormatEnumTypeWrapper):
+        """
+        How the GPS coordinates are displayed on the OLED screen.
+        """
+
+    DEC: DeviceUIConfig.GpsCoordinateFormat.ValueType  # 0
+    """
+    GPS coordinates are displayed in the normal decimal degrees format:
+    DD.DDDDDD DDD.DDDDDD
+    """
+    DMS: DeviceUIConfig.GpsCoordinateFormat.ValueType  # 1
+    """
+    GPS coordinates are displayed in the degrees minutes seconds format:
+    DD°MM'SS"C DDD°MM'SS"C, where C is the compass point representing the locations quadrant
+    """
+    UTM: DeviceUIConfig.GpsCoordinateFormat.ValueType  # 2
+    """
+    Universal Transverse Mercator format:
+    ZZB EEEEEE NNNNNNN, where Z is zone, B is band, E is easting, N is northing
+    """
+    MGRS: DeviceUIConfig.GpsCoordinateFormat.ValueType  # 3
+    """
+    Military Grid Reference System format:
+    ZZB CD EEEEE NNNNN, where Z is zone, B is band, C is the east 100k square, D is the north 100k square,
+    E is easting, N is northing
+    """
+    OLC: DeviceUIConfig.GpsCoordinateFormat.ValueType  # 4
+    """
+    Open Location Code (aka Plus Codes).
+    """
+    OSGR: DeviceUIConfig.GpsCoordinateFormat.ValueType  # 5
+    """
+    Ordnance Survey Grid Reference (the National Grid System of the UK).
+    Format: AB EEEEE NNNNN, where A is the east 100k square, B is the north 100k square,
+    E is the easting, N is the northing
+    """
+    MLS: DeviceUIConfig.GpsCoordinateFormat.ValueType  # 6
+    """
+    Maidenhead Locator System
+    Described here: https://en.wikipedia.org/wiki/Maidenhead_Locator_System
+    """
+
+    VERSION_FIELD_NUMBER: builtins.int
+    SCREEN_BRIGHTNESS_FIELD_NUMBER: builtins.int
+    SCREEN_TIMEOUT_FIELD_NUMBER: builtins.int
+    SCREEN_LOCK_FIELD_NUMBER: builtins.int
+    SETTINGS_LOCK_FIELD_NUMBER: builtins.int
+    PIN_CODE_FIELD_NUMBER: builtins.int
+    THEME_FIELD_NUMBER: builtins.int
+    ALERT_ENABLED_FIELD_NUMBER: builtins.int
+    BANNER_ENABLED_FIELD_NUMBER: builtins.int
+    RING_TONE_ID_FIELD_NUMBER: builtins.int
+    LANGUAGE_FIELD_NUMBER: builtins.int
+    NODE_FILTER_FIELD_NUMBER: builtins.int
+    NODE_HIGHLIGHT_FIELD_NUMBER: builtins.int
+    CALIBRATION_DATA_FIELD_NUMBER: builtins.int
+    MAP_DATA_FIELD_NUMBER: builtins.int
+    COMPASS_MODE_FIELD_NUMBER: builtins.int
+    SCREEN_RGB_COLOR_FIELD_NUMBER: builtins.int
+    IS_CLOCKFACE_ANALOG_FIELD_NUMBER: builtins.int
+    GPS_FORMAT_FIELD_NUMBER: builtins.int
+    version: builtins.int
+    """
+    A version integer used to invalidate saved files when we make incompatible changes.
+    """
+    screen_brightness: builtins.int
+    """
+    TFT display brightness 1..255
+    """
+    screen_timeout: builtins.int
+    """
+    Screen timeout 0..900
+    """
+    screen_lock: builtins.bool
+    """
+    Screen/Settings lock enabled
+    """
+    settings_lock: builtins.bool
+    pin_code: builtins.int
+    theme: global___Theme.ValueType
+    """
+    Color theme
+    """
+    alert_enabled: builtins.bool
+    """
+    Audible message, banner and ring tone
+    """
+    banner_enabled: builtins.bool
+    ring_tone_id: builtins.int
+    language: global___Language.ValueType
+    """
+    Localization
+    """
+    calibration_data: builtins.bytes
+    """
+    8 integers for screen calibration data
+    """
+    compass_mode: global___CompassMode.ValueType
+    """
+    Compass mode
+    """
+    screen_rgb_color: builtins.int
+    """
+    RGB color for BaseUI
+    0xRRGGBB format, e.g. 0xFF0000 for red
+    """
+    is_clockface_analog: builtins.bool
+    """
+    Clockface analog style
+    true for analog clockface, false for digital clockface
+    """
+    gps_format: global___DeviceUIConfig.GpsCoordinateFormat.ValueType
+    """
+    How the GPS coordinates are formatted on the OLED screen.
+    """
+    @property
+    def node_filter(self) -> global___NodeFilter:
+        """
+        Node list filter
+        """
+
+    @property
+    def node_highlight(self) -> global___NodeHighlight:
+        """
+        Node list highlightening
+        """
+
+    @property
+    def map_data(self) -> global___Map:
+        """
+        Map related data
+        """
+
+    def __init__(
+        self,
+        *,
+        version: builtins.int = ...,
+        screen_brightness: builtins.int = ...,
+        screen_timeout: builtins.int = ...,
+        screen_lock: builtins.bool = ...,
+        settings_lock: builtins.bool = ...,
+        pin_code: builtins.int = ...,
+        theme: global___Theme.ValueType = ...,
+        alert_enabled: builtins.bool = ...,
+        banner_enabled: builtins.bool = ...,
+        ring_tone_id: builtins.int = ...,
+        language: global___Language.ValueType = ...,
+        node_filter: global___NodeFilter | None = ...,
+        node_highlight: global___NodeHighlight | None = ...,
+        calibration_data: builtins.bytes = ...,
+        map_data: global___Map | None = ...,
+        compass_mode: global___CompassMode.ValueType = ...,
+        screen_rgb_color: builtins.int = ...,
+        is_clockface_analog: builtins.bool = ...,
+        gps_format: global___DeviceUIConfig.GpsCoordinateFormat.ValueType = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["map_data", b"map_data", "node_filter", b"node_filter", "node_highlight", b"node_highlight"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["alert_enabled", b"alert_enabled", "banner_enabled", b"banner_enabled", "calibration_data", b"calibration_data", "compass_mode", b"compass_mode", "gps_format", b"gps_format", "is_clockface_analog", b"is_clockface_analog", "language", b"language", "map_data", b"map_data", "node_filter", b"node_filter", "node_highlight", b"node_highlight", "pin_code", b"pin_code", "ring_tone_id", b"ring_tone_id", "screen_brightness", b"screen_brightness", "screen_lock", b"screen_lock", "screen_rgb_color", b"screen_rgb_color", "screen_timeout", b"screen_timeout", "settings_lock", b"settings_lock", "theme", b"theme", "version", b"version"]) -> None: ...
+
+global___DeviceUIConfig = DeviceUIConfig
+
+@typing.final
+class NodeFilter(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    UNKNOWN_SWITCH_FIELD_NUMBER: builtins.int
+    OFFLINE_SWITCH_FIELD_NUMBER: builtins.int
+    PUBLIC_KEY_SWITCH_FIELD_NUMBER: builtins.int
+    HOPS_AWAY_FIELD_NUMBER: builtins.int
+    POSITION_SWITCH_FIELD_NUMBER: builtins.int
+    NODE_NAME_FIELD_NUMBER: builtins.int
+    CHANNEL_FIELD_NUMBER: builtins.int
+    unknown_switch: builtins.bool
+    """
+    Filter unknown nodes
+    """
+    offline_switch: builtins.bool
+    """
+    Filter offline nodes
+    """
+    public_key_switch: builtins.bool
+    """
+    Filter nodes w/o public key
+    """
+    hops_away: builtins.int
+    """
+    Filter based on hops away
+    """
+    position_switch: builtins.bool
+    """
+    Filter nodes w/o position
+    """
+    node_name: builtins.str
+    """
+    Filter nodes by matching name string
+    """
+    channel: builtins.int
+    """
+    Filter based on channel
+    """
+    def __init__(
+        self,
+        *,
+        unknown_switch: builtins.bool = ...,
+        offline_switch: builtins.bool = ...,
+        public_key_switch: builtins.bool = ...,
+        hops_away: builtins.int = ...,
+        position_switch: builtins.bool = ...,
+        node_name: builtins.str = ...,
+        channel: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["channel", b"channel", "hops_away", b"hops_away", "node_name", b"node_name", "offline_switch", b"offline_switch", "position_switch", b"position_switch", "public_key_switch", b"public_key_switch", "unknown_switch", b"unknown_switch"]) -> None: ...
+
+global___NodeFilter = NodeFilter
+
+@typing.final
+class NodeHighlight(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    CHAT_SWITCH_FIELD_NUMBER: builtins.int
+    POSITION_SWITCH_FIELD_NUMBER: builtins.int
+    TELEMETRY_SWITCH_FIELD_NUMBER: builtins.int
+    IAQ_SWITCH_FIELD_NUMBER: builtins.int
+    NODE_NAME_FIELD_NUMBER: builtins.int
+    chat_switch: builtins.bool
+    """
+    Hightlight nodes w/ active chat
+    """
+    position_switch: builtins.bool
+    """
+    Highlight nodes w/ position
+    """
+    telemetry_switch: builtins.bool
+    """
+    Highlight nodes w/ telemetry data
+    """
+    iaq_switch: builtins.bool
+    """
+    Highlight nodes w/ iaq data
+    """
+    node_name: builtins.str
+    """
+    Highlight nodes by matching name string
+    """
+    def __init__(
+        self,
+        *,
+        chat_switch: builtins.bool = ...,
+        position_switch: builtins.bool = ...,
+        telemetry_switch: builtins.bool = ...,
+        iaq_switch: builtins.bool = ...,
+        node_name: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["chat_switch", b"chat_switch", "iaq_switch", b"iaq_switch", "node_name", b"node_name", "position_switch", b"position_switch", "telemetry_switch", b"telemetry_switch"]) -> None: ...
+
+global___NodeHighlight = NodeHighlight
+
+@typing.final
+class GeoPoint(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    ZOOM_FIELD_NUMBER: builtins.int
+    LATITUDE_FIELD_NUMBER: builtins.int
+    LONGITUDE_FIELD_NUMBER: builtins.int
+    zoom: builtins.int
+    """
+    Zoom level
+    """
+    latitude: builtins.int
+    """
+    Coordinate: latitude
+    """
+    longitude: builtins.int
+    """
+    Coordinate: longitude
+    """
+    def __init__(
+        self,
+        *,
+        zoom: builtins.int = ...,
+        latitude: builtins.int = ...,
+        longitude: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["latitude", b"latitude", "longitude", b"longitude", "zoom", b"zoom"]) -> None: ...
+
+global___GeoPoint = GeoPoint
+
+@typing.final
+class Map(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    HOME_FIELD_NUMBER: builtins.int
+    STYLE_FIELD_NUMBER: builtins.int
+    FOLLOW_GPS_FIELD_NUMBER: builtins.int
+    style: builtins.str
+    """
+    Map tile style
+    """
+    follow_gps: builtins.bool
+    """
+    Map scroll follows GPS
+    """
+    @property
+    def home(self) -> global___GeoPoint:
+        """
+        Home coordinates
+        """
+
+    def __init__(
+        self,
+        *,
+        home: global___GeoPoint | None = ...,
+        style: builtins.str = ...,
+        follow_gps: builtins.bool = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["home", b"home"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["follow_gps", b"follow_gps", "home", b"home", "style", b"style"]) -> None: ...
+
+global___Map = Map

meshtastic/protobuf/deviceonly_pb2.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/deviceonly.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from meshtastic.protobuf import channel_pb2 as meshtastic_dot_protobuf_dot_channel__pb2
+from meshtastic.protobuf import config_pb2 as meshtastic_dot_protobuf_dot_config__pb2
+from meshtastic.protobuf import localonly_pb2 as meshtastic_dot_protobuf_dot_localonly__pb2
+from meshtastic.protobuf import mesh_pb2 as meshtastic_dot_protobuf_dot_mesh__pb2
+from meshtastic.protobuf import telemetry_pb2 as meshtastic_dot_protobuf_dot_telemetry__pb2
+from meshtastic.protobuf import nanopb_pb2 as meshtastic_dot_protobuf_dot_nanopb__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n$meshtastic/protobuf/deviceonly.proto\x12\x13meshtastic.protobuf\x1a!meshtastic/protobuf/channel.proto\x1a meshtastic/protobuf/config.proto\x1a#meshtastic/protobuf/localonly.proto\x1a\x1emeshtastic/protobuf/mesh.proto\x1a#meshtastic/protobuf/telemetry.proto\x1a meshtastic/protobuf/nanopb.proto\"\x99\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@\n\x0flocation_source\x18\x05 \x01(\x0e\x32\'.meshtastic.protobuf.Position.LocSource\"\x94\x02\n\x08UserLite\x12\x13\n\x07macaddr\x18\x01 \x01(\x0c\x42\x02\x18\x01\x12\x11\n\tlong_name\x18\x02 \x01(\t\x12\x12\n\nshort_name\x18\x03 \x01(\t\x12\x34\n\x08hw_model\x18\x04 \x01(\x0e\x32\".meshtastic.protobuf.HardwareModel\x12\x13\n\x0bis_licensed\x18\x05 \x01(\x08\x12;\n\x04role\x18\x06 \x01(\x0e\x32-.meshtastic.protobuf.Config.DeviceConfig.Role\x12\x12\n\npublic_key\x18\x07 \x01(\x0c\x12\x1c\n\x0fis_unmessagable\x18\t \x01(\x08H\x00\x88\x01\x01\x42\x12\n\x10_is_unmessagable\"\xf0\x02\n\x0cNodeInfoLite\x12\x0b\n\x03num\x18\x01 \x01(\r\x12+\n\x04user\x18\x02 \x01(\x0b\x32\x1d.meshtastic.protobuf.UserLite\x12\x33\n\x08position\x18\x03 \x01(\x0b\x32!.meshtastic.protobuf.PositionLite\x12\x0b\n\x03snr\x18\x04 \x01(\x02\x12\x12\n\nlast_heard\x18\x05 \x01(\x07\x12:\n\x0e\x64\x65vice_metrics\x18\x06 \x01(\x0b\x32\".meshtastic.protobuf.DeviceMetrics\x12\x0f\n\x07\x63hannel\x18\x07 \x01(\r\x12\x10\n\x08via_mqtt\x18\x08 \x01(\x08\x12\x16\n\thops_away\x18\t \x01(\rH\x00\x88\x01\x01\x12\x13\n\x0bis_favorite\x18\n \x01(\x08\x12\x12\n\nis_ignored\x18\x0b \x01(\x08\x12\x10\n\x08next_hop\x18\x0c \x01(\r\x12\x10\n\x08\x62itfield\x18\r \x01(\rB\x0c\n\n_hops_away\"\xa1\x03\n\x0b\x44\x65viceState\x12\x30\n\x07my_node\x18\x02 \x01(\x0b\x32\x1f.meshtastic.protobuf.MyNodeInfo\x12(\n\x05owner\x18\x03 \x01(\x0b\x32\x19.meshtastic.protobuf.User\x12\x36\n\rreceive_queue\x18\x05 \x03(\x0b\x32\x1f.meshtastic.protobuf.MeshPacket\x12\x0f\n\x07version\x18\x08 \x01(\r\x12\x38\n\x0frx_text_message\x18\x07 \x01(\x0b\x32\x1f.meshtastic.protobuf.MeshPacket\x12\x13\n\x07no_save\x18\t \x01(\x08\x42\x02\x18\x01\x12\x19\n\rdid_gps_reset\x18\x0b \x01(\x08\x42\x02\x18\x01\x12\x34\n\x0brx_waypoint\x18\x0c \x01(\x0b\x32\x1f.meshtastic.protobuf.MeshPacket\x12M\n\x19node_remote_hardware_pins\x18\r \x03(\x0b\x32*.meshtastic.protobuf.NodeRemoteHardwarePin\"}\n\x0cNodeDatabase\x12\x0f\n\x07version\x18\x01 \x01(\r\x12\\\n\x05nodes\x18\x02 \x03(\x0b\x32!.meshtastic.protobuf.NodeInfoLiteB*\x92?\'\x92\x01$std::vector<meshtastic_NodeInfoLite>\"N\n\x0b\x43hannelFile\x12.\n\x08\x63hannels\x18\x01 \x03(\x0b\x32\x1c.meshtastic.protobuf.Channel\x12\x0f\n\x07version\x18\x02 \x01(\r\"\x86\x02\n\x11\x42\x61\x63kupPreferences\x12\x0f\n\x07version\x18\x01 \x01(\r\x12\x11\n\ttimestamp\x18\x02 \x01(\x07\x12\x30\n\x06\x63onfig\x18\x03 \x01(\x0b\x32 .meshtastic.protobuf.LocalConfig\x12=\n\rmodule_config\x18\x04 \x01(\x0b\x32&.meshtastic.protobuf.LocalModuleConfig\x12\x32\n\x08\x63hannels\x18\x05 \x01(\x0b\x32 .meshtastic.protobuf.ChannelFile\x12(\n\x05owner\x18\x06 \x01(\x0b\x32\x19.meshtastic.protobuf.UserBn\n\x14org.meshtastic.protoB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x92?\x0b\xc2\x01\x08<vector>b\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.deviceonly_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000\222?\013\302\001\010<vector>'
+  _USERLITE.fields_by_name['macaddr']._options = None
+  _USERLITE.fields_by_name['macaddr']._serialized_options = b'\030\001'
+  _DEVICESTATE.fields_by_name['no_save']._options = None
+  _DEVICESTATE.fields_by_name['no_save']._serialized_options = b'\030\001'
+  _DEVICESTATE.fields_by_name['did_gps_reset']._options = None
+  _DEVICESTATE.fields_by_name['did_gps_reset']._serialized_options = b'\030\001'
+  _NODEDATABASE.fields_by_name['nodes']._options = None
+  _NODEDATABASE.fields_by_name['nodes']._serialized_options = b'\222?\'\222\001$std::vector<meshtastic_NodeInfoLite>'
+  _globals['_POSITIONLITE']._serialized_start=271
+  _globals['_POSITIONLITE']._serialized_end=424
+  _globals['_USERLITE']._serialized_start=427
+  _globals['_USERLITE']._serialized_end=703
+  _globals['_NODEINFOLITE']._serialized_start=706
+  _globals['_NODEINFOLITE']._serialized_end=1074
+  _globals['_DEVICESTATE']._serialized_start=1077
+  _globals['_DEVICESTATE']._serialized_end=1494
+  _globals['_NODEDATABASE']._serialized_start=1496
+  _globals['_NODEDATABASE']._serialized_end=1621
+  _globals['_CHANNELFILE']._serialized_start=1623
+  _globals['_CHANNELFILE']._serialized_end=1701
+  _globals['_BACKUPPREFERENCES']._serialized_start=1704
+  _globals['_BACKUPPREFERENCES']._serialized_end=1966
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/deviceonly_pb2.pyi

@@ -0,0 +1,458 @@
+"""
+@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.protobuf.channel_pb2
+import meshtastic.protobuf.config_pb2
+import meshtastic.protobuf.localonly_pb2
+import meshtastic.protobuf.mesh_pb2
+import meshtastic.protobuf.telemetry_pb2
+import typing
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing.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.protobuf.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.protobuf.mesh_pb2.Position.LocSource.ValueType = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.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.final
+class UserLite(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    MACADDR_FIELD_NUMBER: builtins.int
+    LONG_NAME_FIELD_NUMBER: builtins.int
+    SHORT_NAME_FIELD_NUMBER: builtins.int
+    HW_MODEL_FIELD_NUMBER: builtins.int
+    IS_LICENSED_FIELD_NUMBER: builtins.int
+    ROLE_FIELD_NUMBER: builtins.int
+    PUBLIC_KEY_FIELD_NUMBER: builtins.int
+    IS_UNMESSAGABLE_FIELD_NUMBER: builtins.int
+    macaddr: builtins.bytes
+    """
+    This is the addr of the radio.
+    """
+    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
+    """
+    hw_model: meshtastic.protobuf.mesh_pb2.HardwareModel.ValueType
+    """
+    TBEAM, HELTEC, etc...
+    Starting in 1.2.11 moved to hw_model enum in the NodeInfo object.
+    Apps will still need the string here for older builds
+    (so OTA update can find the right image), but if the enum is available it will be used instead.
+    """
+    is_licensed: builtins.bool
+    """
+    In some regions Ham radio operators have different bandwidth limitations than others.
+    If this user is a licensed operator, set this flag.
+    Also, "long_name" should be their licence number.
+    """
+    role: meshtastic.protobuf.config_pb2.Config.DeviceConfig.Role.ValueType
+    """
+    Indicates that the user's role in the mesh
+    """
+    public_key: builtins.bytes
+    """
+    The public key of the user's device.
+    This is sent out to other nodes on the mesh to allow them to compute a shared secret key.
+    """
+    is_unmessagable: builtins.bool
+    """
+    Whether or not the node can be messaged
+    """
+    def __init__(
+        self,
+        *,
+        macaddr: builtins.bytes = ...,
+        long_name: builtins.str = ...,
+        short_name: builtins.str = ...,
+        hw_model: meshtastic.protobuf.mesh_pb2.HardwareModel.ValueType = ...,
+        is_licensed: builtins.bool = ...,
+        role: meshtastic.protobuf.config_pb2.Config.DeviceConfig.Role.ValueType = ...,
+        public_key: builtins.bytes = ...,
+        is_unmessagable: builtins.bool | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_is_unmessagable", b"_is_unmessagable", "is_unmessagable", b"is_unmessagable"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_is_unmessagable", b"_is_unmessagable", "hw_model", b"hw_model", "is_licensed", b"is_licensed", "is_unmessagable", b"is_unmessagable", "long_name", b"long_name", "macaddr", b"macaddr", "public_key", b"public_key", "role", b"role", "short_name", b"short_name"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["_is_unmessagable", b"_is_unmessagable"]) -> typing.Literal["is_unmessagable"] | None: ...
+
+global___UserLite = UserLite
+
+@typing.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
+    IS_IGNORED_FIELD_NUMBER: builtins.int
+    NEXT_HOP_FIELD_NUMBER: builtins.int
+    BITFIELD_FIELD_NUMBER: builtins.int
+    num: builtins.int
+    """
+    The node number
+    """
+    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
+    """
+    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 direct neighbor)
+    """
+    is_favorite: builtins.bool
+    """
+    True if node is in our favorites list
+    Persists between NodeDB internal clean ups
+    """
+    is_ignored: builtins.bool
+    """
+    True if node is in our ignored list
+    Persists between NodeDB internal clean ups
+    """
+    next_hop: builtins.int
+    """
+    Last byte of the node number of the node that should be used as the next hop to reach this node.
+    """
+    bitfield: builtins.int
+    """
+    Bitfield for storing booleans.
+    LSB 0 is_key_manually_verified
+    """
+    @property
+    def user(self) -> global___UserLite:
+        """
+        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.
+        """
+
+    @property
+    def device_metrics(self) -> meshtastic.protobuf.telemetry_pb2.DeviceMetrics:
+        """
+        The latest device metrics for the node.
+        """
+
+    def __init__(
+        self,
+        *,
+        num: builtins.int = ...,
+        user: global___UserLite | None = ...,
+        position: global___PositionLite | None = ...,
+        snr: builtins.float = ...,
+        last_heard: builtins.int = ...,
+        device_metrics: meshtastic.protobuf.telemetry_pb2.DeviceMetrics | None = ...,
+        channel: builtins.int = ...,
+        via_mqtt: builtins.bool = ...,
+        hops_away: builtins.int | None = ...,
+        is_favorite: builtins.bool = ...,
+        is_ignored: builtins.bool = ...,
+        next_hop: builtins.int = ...,
+        bitfield: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_hops_away", b"_hops_away", "device_metrics", b"device_metrics", "hops_away", b"hops_away", "position", b"position", "user", b"user"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_hops_away", b"_hops_away", "bitfield", b"bitfield", "channel", b"channel", "device_metrics", b"device_metrics", "hops_away", b"hops_away", "is_favorite", b"is_favorite", "is_ignored", b"is_ignored", "last_heard", b"last_heard", "next_hop", b"next_hop", "num", b"num", "position", b"position", "snr", b"snr", "user", b"user", "via_mqtt", b"via_mqtt"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["_hops_away", b"_hops_away"]) -> typing.Literal["hops_away"] | None: ...
+
+global___NodeInfoLite = NodeInfoLite
+
+@typing.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
+    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.
+    """
+    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
+    """
+    Previously used to manage GPS factory resets.
+    Deprecated in 2.5.23
+    """
+    @property
+    def my_node(self) -> meshtastic.protobuf.mesh_pb2.MyNodeInfo:
+        """
+        Read only settings/info about this node
+        """
+
+    @property
+    def owner(self) -> meshtastic.protobuf.mesh_pb2.User:
+        """
+        My owner info
+        """
+
+    @property
+    def receive_queue(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[meshtastic.protobuf.mesh_pb2.MeshPacket]:
+        """
+        Received packets saved for delivery to the phone
+        """
+
+    @property
+    def rx_text_message(self) -> meshtastic.protobuf.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
+        """
+
+    @property
+    def rx_waypoint(self) -> meshtastic.protobuf.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.protobuf.mesh_pb2.NodeRemoteHardwarePin]:
+        """
+        The mesh's nodes with their available gpio pins for RemoteHardware module
+        """
+
+    def __init__(
+        self,
+        *,
+        my_node: meshtastic.protobuf.mesh_pb2.MyNodeInfo | None = ...,
+        owner: meshtastic.protobuf.mesh_pb2.User | None = ...,
+        receive_queue: collections.abc.Iterable[meshtastic.protobuf.mesh_pb2.MeshPacket] | None = ...,
+        version: builtins.int = ...,
+        rx_text_message: meshtastic.protobuf.mesh_pb2.MeshPacket | None = ...,
+        no_save: builtins.bool = ...,
+        did_gps_reset: builtins.bool = ...,
+        rx_waypoint: meshtastic.protobuf.mesh_pb2.MeshPacket | None = ...,
+        node_remote_hardware_pins: collections.abc.Iterable[meshtastic.protobuf.mesh_pb2.NodeRemoteHardwarePin] | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.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.Literal["did_gps_reset", b"did_gps_reset", "my_node", b"my_node", "no_save", b"no_save", "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.final
+class NodeDatabase(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    VERSION_FIELD_NUMBER: builtins.int
+    NODES_FIELD_NUMBER: builtins.int
+    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 nodes(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___NodeInfoLite]:
+        """
+        New lite version of NodeDB to decrease memory footprint
+        """
+
+    def __init__(
+        self,
+        *,
+        version: builtins.int = ...,
+        nodes: collections.abc.Iterable[global___NodeInfoLite] | None = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["nodes", b"nodes", "version", b"version"]) -> None: ...
+
+global___NodeDatabase = NodeDatabase
+
+@typing.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
+    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 channels(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[meshtastic.protobuf.channel_pb2.Channel]:
+        """
+        The channels our node knows about
+        """
+
+    def __init__(
+        self,
+        *,
+        channels: collections.abc.Iterable[meshtastic.protobuf.channel_pb2.Channel] | None = ...,
+        version: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["channels", b"channels", "version", b"version"]) -> None: ...
+
+global___ChannelFile = ChannelFile
+
+@typing.final
+class BackupPreferences(google.protobuf.message.Message):
+    """
+    The on-disk backup of the node's preferences
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    VERSION_FIELD_NUMBER: builtins.int
+    TIMESTAMP_FIELD_NUMBER: builtins.int
+    CONFIG_FIELD_NUMBER: builtins.int
+    MODULE_CONFIG_FIELD_NUMBER: builtins.int
+    CHANNELS_FIELD_NUMBER: builtins.int
+    OWNER_FIELD_NUMBER: builtins.int
+    version: builtins.int
+    """
+    The version of the backup
+    """
+    timestamp: builtins.int
+    """
+    The timestamp of the backup (if node has time)
+    """
+    @property
+    def config(self) -> meshtastic.protobuf.localonly_pb2.LocalConfig:
+        """
+        The node's configuration
+        """
+
+    @property
+    def module_config(self) -> meshtastic.protobuf.localonly_pb2.LocalModuleConfig:
+        """
+        The node's module configuration
+        """
+
+    @property
+    def channels(self) -> global___ChannelFile:
+        """
+        The node's channels
+        """
+
+    @property
+    def owner(self) -> meshtastic.protobuf.mesh_pb2.User:
+        """
+        The node's user (owner) information
+        """
+
+    def __init__(
+        self,
+        *,
+        version: builtins.int = ...,
+        timestamp: builtins.int = ...,
+        config: meshtastic.protobuf.localonly_pb2.LocalConfig | None = ...,
+        module_config: meshtastic.protobuf.localonly_pb2.LocalModuleConfig | None = ...,
+        channels: global___ChannelFile | None = ...,
+        owner: meshtastic.protobuf.mesh_pb2.User | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["channels", b"channels", "config", b"config", "module_config", b"module_config", "owner", b"owner"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["channels", b"channels", "config", b"config", "module_config", b"module_config", "owner", b"owner", "timestamp", b"timestamp", "version", b"version"]) -> None: ...
+
+global___BackupPreferences = BackupPreferences

meshtastic/protobuf/interdevice_pb2.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: meshtastic/protobuf/interdevice.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 symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n%meshtastic/protobuf/interdevice.proto\x12\x13meshtastic.protobuf\"s\n\nSensorData\x12.\n\x04type\x18\x01 \x01(\x0e\x32 .meshtastic.protobuf.MessageType\x12\x15\n\x0b\x66loat_value\x18\x02 \x01(\x02H\x00\x12\x16\n\x0cuint32_value\x18\x03 \x01(\rH\x00\x42\x06\n\x04\x64\x61ta\"_\n\x12InterdeviceMessage\x12\x0e\n\x04nmea\x18\x01 \x01(\tH\x00\x12\x31\n\x06sensor\x18\x02 \x01(\x0b\x32\x1f.meshtastic.protobuf.SensorDataH\x00\x42\x06\n\x04\x64\x61ta*\xd5\x01\n\x0bMessageType\x12\x07\n\x03\x41\x43K\x10\x00\x12\x15\n\x10\x43OLLECT_INTERVAL\x10\xa0\x01\x12\x0c\n\x07\x42\x45\x45P_ON\x10\xa1\x01\x12\r\n\x08\x42\x45\x45P_OFF\x10\xa2\x01\x12\r\n\x08SHUTDOWN\x10\xa3\x01\x12\r\n\x08POWER_ON\x10\xa4\x01\x12\x0f\n\nSCD41_TEMP\x10\xb0\x01\x12\x13\n\x0eSCD41_HUMIDITY\x10\xb1\x01\x12\x0e\n\tSCD41_CO2\x10\xb2\x01\x12\x0f\n\nAHT20_TEMP\x10\xb3\x01\x12\x13\n\x0e\x41HT20_HUMIDITY\x10\xb4\x01\x12\x0f\n\nTVOC_INDEX\x10\xb5\x01\x42g\n\x14org.meshtastic.protoB\x11InterdeviceProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.protobuf.interdevice_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n\024org.meshtastic.protoB\021InterdeviceProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
+  _globals['_MESSAGETYPE']._serialized_start=277
+  _globals['_MESSAGETYPE']._serialized_end=490
+  _globals['_SENSORDATA']._serialized_start=62
+  _globals['_SENSORDATA']._serialized_end=177
+  _globals['_INTERDEVICEMESSAGE']._serialized_start=179
+  _globals['_INTERDEVICEMESSAGE']._serialized_end=274
+# @@protoc_insertion_point(module_scope)

meshtastic/protobuf/interdevice_pb2.pyi

@@ -0,0 +1,105 @@
+"""
+@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 _MessageType:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _MessageTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_MessageType.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    ACK: _MessageType.ValueType  # 0
+    COLLECT_INTERVAL: _MessageType.ValueType  # 160
+    """in ms"""
+    BEEP_ON: _MessageType.ValueType  # 161
+    """duration ms"""
+    BEEP_OFF: _MessageType.ValueType  # 162
+    """cancel prematurely"""
+    SHUTDOWN: _MessageType.ValueType  # 163
+    POWER_ON: _MessageType.ValueType  # 164
+    SCD41_TEMP: _MessageType.ValueType  # 176
+    SCD41_HUMIDITY: _MessageType.ValueType  # 177
+    SCD41_CO2: _MessageType.ValueType  # 178
+    AHT20_TEMP: _MessageType.ValueType  # 179
+    AHT20_HUMIDITY: _MessageType.ValueType  # 180
+    TVOC_INDEX: _MessageType.ValueType  # 181
+
+class MessageType(_MessageType, metaclass=_MessageTypeEnumTypeWrapper):
+    """encapsulate up to 1k of NMEA string data"""
+
+ACK: MessageType.ValueType  # 0
+COLLECT_INTERVAL: MessageType.ValueType  # 160
+"""in ms"""
+BEEP_ON: MessageType.ValueType  # 161
+"""duration ms"""
+BEEP_OFF: MessageType.ValueType  # 162
+"""cancel prematurely"""
+SHUTDOWN: MessageType.ValueType  # 163
+POWER_ON: MessageType.ValueType  # 164
+SCD41_TEMP: MessageType.ValueType  # 176
+SCD41_HUMIDITY: MessageType.ValueType  # 177
+SCD41_CO2: MessageType.ValueType  # 178
+AHT20_TEMP: MessageType.ValueType  # 179
+AHT20_HUMIDITY: MessageType.ValueType  # 180
+TVOC_INDEX: MessageType.ValueType  # 181
+global___MessageType = MessageType
+
+@typing.final
+class SensorData(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    TYPE_FIELD_NUMBER: builtins.int
+    FLOAT_VALUE_FIELD_NUMBER: builtins.int
+    UINT32_VALUE_FIELD_NUMBER: builtins.int
+    type: global___MessageType.ValueType
+    """The message type"""
+    float_value: builtins.float
+    uint32_value: builtins.int
+    def __init__(
+        self,
+        *,
+        type: global___MessageType.ValueType = ...,
+        float_value: builtins.float = ...,
+        uint32_value: builtins.int = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["data", b"data", "float_value", b"float_value", "uint32_value", b"uint32_value"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["data", b"data", "float_value", b"float_value", "type", b"type", "uint32_value", b"uint32_value"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["data", b"data"]) -> typing.Literal["float_value", "uint32_value"] | None: ...
+
+global___SensorData = SensorData
+
+@typing.final
+class InterdeviceMessage(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    NMEA_FIELD_NUMBER: builtins.int
+    SENSOR_FIELD_NUMBER: builtins.int
+    nmea: builtins.str
+    @property
+    def sensor(self) -> global___SensorData: ...
+    def __init__(
+        self,
+        *,
+        nmea: builtins.str = ...,
+        sensor: global___SensorData | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["data", b"data", "nmea", b"nmea", "sensor", b"sensor"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["data", b"data", "nmea", b"nmea", "sensor", b"sensor"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["data", b"data"]) -> typing.Literal["nmea", "sensor"] | None: ...
+
+global___InterdeviceMessage = InterdeviceMessage