protobufs: v2.3.5

Add --remove-node (fixes #514)

.github/workflows/ci.yml

@@ -34,16 +34,19 @@ jobs:
           which meshtastic
           meshtastic --version
       - name: Run pylint
-        run: pylint meshtastic examples/ --ignore-patterns ".*_pb2.py$"
+        run: pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"
+      - name: Check types with mypy
+        run: mypy meshtastic/
       - name: Run tests with pytest
         run: pytest --cov=meshtastic
       - name: Generate coverage report
         run: |
           pytest --cov=meshtastic --cov-report=xml
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+          env_vars: OS, PYTHON
           files: ./coverage.xml
           flags: unittests
           name: codecov-umbrella

.github/workflows/release.yml

@@ -74,51 +74,51 @@ jobs:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
 
-  build-and-publish-mac:
-    runs-on: macos-latest
-    needs: release_create
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          ref: ${{ needs.release_create.outputs.new_sha }}
+  # build-and-publish-mac:
+  #   runs-on: macos-latest
+  #   needs: release_create
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+  #       with:
+  #         ref: ${{ needs.release_create.outputs.new_sha }}
 
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
+  #     - name: Set up Python 3.9
+  #       uses: actions/setup-python@v2
+  #       with:
+  #         python-version: 3.9
 
-      - name: Setup code signing
-        env:
-          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
-          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
-          MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
-        run: |
-          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
-          security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-          security default-keychain -s meshtastic.keychain
-          security unlock-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-          security import certificate.p12 -k meshtastic.keychain -P "$MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
-          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+  #     - name: Setup code signing
+  #       env:
+  #         MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
+  #         MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
+  #         MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
+  #       run: |
+  #         echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
+  #         security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+  #         security default-keychain -s meshtastic.keychain
+  #         security unlock-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+  #         security import certificate.p12 -k meshtastic.keychain -P "$MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
+  #         security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
 
-      - name: Build
-        env:
-          MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
-        run: |
-          pip install pyinstaller
-          pip install -r requirements.txt
-          pip install .
-          pyinstaller -F -n meshtastic --collect-all meshtastic --codesign-identity "$MACOS_SIGNING_IDENTITY" meshtastic/__main__.py
+  #     - name: Build
+  #       env:
+  #         MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
+  #       run: |
+  #         pip install pyinstaller
+  #         pip install -r requirements.txt
+  #         pip install .
+  #         pyinstaller -F -n meshtastic --collect-all meshtastic --codesign-identity "$MACOS_SIGNING_IDENTITY" meshtastic/__main__.py
 
-      - name: Add mac to release
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.release_create.outputs.upload_url }}
-          asset_path: dist/meshtastic
-          asset_name: meshtastic_mac
-          asset_content_type: application/zip
+  #     - name: Add mac to release
+  #       uses: actions/upload-release-asset@v1
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #       with:
+  #         upload_url: ${{ needs.release_create.outputs.upload_url }}
+  #         asset_path: dist/meshtastic
+  #         asset_name: meshtastic_mac
+  #         asset_content_type: application/zip
 
   build-and-publish-ubuntu:
     runs-on: ubuntu-latest

.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,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
+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
 
 
 

.vscode/launch.json

@@ -44,6 +44,14 @@
       "justMyCode": true,
       "args": ["--debug"]
     },
+    {
+      "name": "meshtastic listen",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--listen", "--debug"]
+    },
     {
       "name": "meshtastic debug getPref",
       "type": "python",

README.md

@@ -1,11 +1,10 @@
 # Meshtastic Python
 
-[![codecov](https://codecov.io/gh/meshtastic/Meshtastic-python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/Meshtastic-python)
+[![codecov](https://codecov.io/gh/meshtastic/python/branch/master/graph/badge.svg?token=TIWPJL73KV)](https://codecov.io/gh/meshtastic/python)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/meshtastic)
 [![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/python/ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic/python/actions/workflows/ci.yml)
 [![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/python)](https://cla-assistant.io/meshtastic/python)
 [![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
-[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
 
 ## Overview
 
@@ -16,7 +15,36 @@ Events are delivered using a publish-subscribe model, and you can subscribe to o
 
 **[Getting Started Guide](https://meshtastic.org/docs/software/python/cli/installation)**
 
-**[Documentation/API Reference](https://python.meshtastic.org/)**
+(Documentation/API Reference is currently offline)
+
+## 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
+  * mypy running in CI to type-check new code
+* 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
+* interactive client
+* data storage & processing
+  * there should be a standardized way of recording packets for later use, debugging, etc.
+  * a sqlite database schema and tools for writing to it may be a good starting point
+  * enable maps, charts, visualizations
 
 ## Stats
 

bin/regen-protobufs.sh

@@ -4,7 +4,8 @@
 #gsed -i 's/import "\//import ".\//g' ./protobufs/meshtastic/*
 #gsed -i 's/package meshtastic;//g' ./protobufs/meshtastic/*
 
-./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./ ./protobufs/meshtastic/*.proto
+./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./ --mypy_out ./ ./protobufs/meshtastic/*.proto
+./nanopb-0.4.7/generator-bin/protoc -I=protobufs --python_out ./meshtastic/ --mypy_out ./meshtastic/ ./protobufs/nanopb.proto
 
 # workaround for import bug in protoc https://github.com/protocolbuffers/protobuf/issues/1491#issuecomment-690618628
 

meshtastic/__init__.py

@@ -71,11 +71,11 @@ from datetime import datetime
 from typing import *
 
 import google.protobuf.json_format
-import serial
-import timeago
-from dotmap import DotMap
+import serial # type: ignore[import-untyped]
+import timeago # type: ignore[import-untyped]
+from dotmap import DotMap # type: ignore[import-untyped]
 from google.protobuf.json_format import MessageToJson
-from pubsub import pub
+from pubsub import pub # type: ignore[import-untyped]
 from tabulate import tabulate
 
 from meshtastic import (
@@ -84,8 +84,11 @@ from meshtastic import (
     channel_pb2,
     config_pb2,
     mesh_pb2,
+    mqtt_pb2,
+    paxcount_pb2,
     portnums_pb2,
     remote_hardware_pb2,
+    storeforward_pb2,
     telemetry_pb2,
     util,
 )
@@ -127,9 +130,9 @@ class KnownProtocol(NamedTuple):
     name: str
     # portnum: int, now a key
     # If set, will be called to prase as a protocol buffer
-    protobufFactory: Callable = None
+    protobufFactory: Optional[Callable] = None
     # If set, invoked as onReceive(interface, packet)
-    onReceive: Callable = None
+    onReceive: Optional[Callable] = None
 
 
 def _onTextReceive(iface, asDict):
@@ -190,6 +193,13 @@ protocols = {
     portnums_pb2.PortNum.TEXT_MESSAGE_APP: KnownProtocol(
         "text", onReceive=_onTextReceive
     ),
+    portnums_pb2.PortNum.RANGE_TEST_APP: KnownProtocol(
+        "rangetest", onReceive=_onTextReceive
+    ),
+    portnums_pb2.PortNum.DETECTION_SENSOR_APP: KnownProtocol(
+        "detectionsensor", onReceive=_onTextReceive
+    ),
+
     portnums_pb2.PortNum.POSITION_APP: KnownProtocol(
         "position", mesh_pb2.Position, _onPositionReceive
     ),
@@ -208,4 +218,9 @@ protocols = {
     portnums_pb2.PortNum.TRACEROUTE_APP: KnownProtocol(
         "traceroute", mesh_pb2.RouteDiscovery
     ),
+    portnums_pb2.PortNum.WAYPOINT_APP: KnownProtocol("waypoint", mesh_pb2.Waypoint),
+    portnums_pb2.PortNum.PAXCOUNTER_APP: KnownProtocol("paxcounter", paxcount_pb2.Paxcount),
+    portnums_pb2.PortNum.STORE_FORWARD_APP: KnownProtocol("storeforward", storeforward_pb2.StoreAndForward),
+    portnums_pb2.PortNum.NEIGHBORINFO_APP: KnownProtocol("neighborinfo", mesh_pb2.NeighborInfo),
+    portnums_pb2.PortNum.MAP_REPORT_APP: KnownProtocol("mapreport", mqtt_pb2.MapReport),
 }

meshtastic/__main__.py

@@ -9,16 +9,15 @@ import platform
 import sys
 import time
 
-import pkg_resources
-import pyqrcode
+import pyqrcode # type: ignore[import-untyped]
 import yaml
 from google.protobuf.json_format import MessageToDict
-from pubsub import pub
+from pubsub import pub # type: ignore[import-untyped]
 
 import meshtastic.test
 import meshtastic.util
-from meshtastic import channel_pb2, config_pb2, portnums_pb2, remote_hardware
-from meshtastic.__init__ import BROADCAST_ADDR
+from meshtastic import channel_pb2, config_pb2, portnums_pb2, remote_hardware, BROADCAST_ADDR
+from meshtastic.version import get_active_version
 from meshtastic.ble_interface import BLEInterface
 from meshtastic.globals import Globals
 
@@ -41,7 +40,7 @@ def onReceive(packet, interface):
             interface.close()  # after running command then exit
 
         # Reply to every received message with some stats
-        if args and args.reply:
+        if d is not None and args and args.reply:
             msg = d.get("text")
             if msg:
                 rxSnr = packet["rxSnr"]
@@ -135,7 +134,7 @@ def splitCompoundName(comp_name):
     return name
 
 
-def setPref(config, comp_name, valStr):
+def setPref(config, comp_name, valStr) -> bool:
     """Set a channel or preferences value"""
 
     name = splitCompoundName(comp_name)
@@ -147,7 +146,7 @@ def setPref(config, comp_name, valStr):
 
     objDesc = config.DESCRIPTOR
     config_type = objDesc.fields_by_name.get(name[0])
-    pref = False
+    pref = None
     if config_type and config_type.message_type is not None:
         pref = config_type.message_type.fields_by_name.get(snake_name)
     # Others like ChannelSettings are standalone
@@ -160,8 +159,8 @@ def setPref(config, comp_name, valStr):
     val = meshtastic.util.fromStr(valStr)
     logging.debug(f"valStr:{valStr} val:{val}")
 
-    if snake_name == "psk" and len(valStr) < 8:
-        print(f"Warning: wifi.psk must be 8 or more characters.")
+    if snake_name == "wifi_psk" and len(valStr) < 8:
+        print(f"Warning: network.wifi_psk must be 8 or more characters.")
         return False
 
     enumType = pref.enum_type
@@ -366,6 +365,11 @@ def onConnected(interface):
             waitForAckNak = True
             interface.getNode(args.dest, False).factoryReset()
 
+        if args.remove_node:
+            closeNow = True
+            waitForAckNak = True
+            interface.getNode(args.dest, False).removeNode(args.remove_node)
+
         if args.reset_nodedb:
             closeNow = True
             waitForAckNak = True
@@ -394,17 +398,6 @@ def onConnected(interface):
                     f"Warning: {channelIndex} is not a valid channel. Channel must not be DISABLED."
                 )
 
-        if args.sendping:
-            payload = str.encode("test string")
-            print(f"Sending ping message to {args.dest}")
-            interface.sendData(
-                payload,
-                args.dest,
-                portNum=portnums_pb2.PortNum.REPLY_APP,
-                wantAck=True,
-                wantResponse=True,
-            )
-
         if args.traceroute:
             loraConfig = getattr(interface.localNode.localConfig, "lora")
             hopLimit = getattr(loraConfig, "hop_limit")
@@ -597,6 +590,12 @@ def onConnected(interface):
         # handle changing channels
 
         if args.ch_add:
+            channelIndex = our_globals.get_channel_index()
+            if channelIndex is not None:
+                # Since we set the channel index after adding a channel, don't allow --ch-index
+                meshtastic.util.our_exit(
+                    "Warning: '--ch-add' and '--ch-index' are incompatible. Channel not added."
+                )
             closeNow = True
             if len(args.ch_add) > 10:
                 meshtastic.util.our_exit(
@@ -620,6 +619,9 @@ def onConnected(interface):
                 ch.role = channel_pb2.Channel.Role.SECONDARY
                 print(f"Writing modified channels to device")
                 n.writeChannel(ch.index)
+                if channelIndex is None:
+                    print(f"Setting newly-added channel's {ch.index} as '--ch-index' for further modifications")
+                    our_globals.set_channel_index(ch.index)
 
         if args.ch_del:
             closeNow = True
@@ -640,6 +642,11 @@ def onConnected(interface):
 
         def setSimpleConfig(modem_preset):
             """Set one of the simple modem_config"""
+            channelIndex = our_globals.get_channel_index()
+            if channelIndex is not None and channelIndex > 0:
+                meshtastic.util.our_exit(
+                    "Warning: Cannot set modem preset for non-primary channel", 1
+                )
             # Overwrite modem_preset
             prefs = interface.getNode(args.dest).localConfig
             prefs.lora.modem_preset = modem_preset
@@ -690,9 +697,29 @@ def onConnected(interface):
             # Handle the channel settings
             for pref in args.ch_set or []:
                 if pref[0] == "psk":
+                    found = True
                     ch.settings.psk = meshtastic.util.fromPSK(pref[1])
                 else:
-                    setPref(ch.settings, pref[0], pref[1])
+                    found = setPref(ch.settings, pref[0], pref[1])
+                if not found:
+                    category_settings = ['module_settings']
+                    print(
+                        f"{ch.settings.__class__.__name__} does not have an attribute {pref[0]}."
+                    )
+                    print("Choices are...")
+                    for field in ch.settings.DESCRIPTOR.fields:
+                        if field.name not in category_settings:
+                            print(f"{field.name}")
+                        else:
+                            print(f"{field.name}:")
+                            config = ch.settings.DESCRIPTOR.fields_by_name.get(field.name)
+                            names = []
+                            for sub_field in config.message_type.fields:
+                                tmp_name = f"{field.name}.{sub_field.name}"
+                                names.append(tmp_name)
+                            for temp_name in sorted(names):
+                                print(f"    {temp_name}")
+
                 enable = True  # If we set any pref, assume the user wants to enable the channel
 
             if enable:
@@ -761,6 +788,9 @@ def onConnected(interface):
             qr = pyqrcode.create(url)
             print(qr.terminal())
 
+        if args.listen:
+            closeNow = False
+
         have_tunnel = platform.system() == "Linux"
         if have_tunnel and args.tunnel:
             # pylint: disable=C0415
@@ -826,7 +856,7 @@ def subscribe():
 
 
 def export_config(interface):
-    """used in--export-config"""
+    """used in --export-config"""
     configObj = {}
 
     owner = interface.getLongName()
@@ -893,7 +923,7 @@ def common():
     args = our_globals.get_args()
     parser = our_globals.get_parser()
     logging.basicConfig(
-        level=logging.DEBUG if args.debug else logging.INFO,
+        level=logging.DEBUG if (args.debug or args.listen) else logging.INFO,
         format="%(levelname)s file:%(filename)s %(funcName)s line:%(lineno)s %(message)s",
     )
 
@@ -981,13 +1011,23 @@ def common():
                     message += "  After running that command, log out and re-login for it to take effect.\n"
                     message += f"Error was:{ex}"
                     meshtastic.util.our_exit(message)
+                if client.devPath is None:
+                    try:
+                        client = meshtastic.tcp_interface.TCPInterface(
+                            "localhost", debugOut=logfile, noProto=args.noproto
+                        )
+                    except Exception as ex:
+                        meshtastic.util.our_exit(
+                            f"Error connecting to localhost:{ex}", 1
+                        )
+
 
             # We assume client is fully connected now
             onConnected(client)
 
             have_tunnel = platform.system() == "Linux"
             if (
-                args.noproto or args.reply or (have_tunnel and args.tunnel)
+                args.noproto or args.reply or (have_tunnel and args.tunnel) or args.listen
             ):  # loop until someone presses ctrlc
                 while True:
                     time.sleep(1000)
@@ -995,6 +1035,31 @@ def common():
         # don't call exit, background threads might be running still
         # sys.exit(0)
 
+def addConnectionArgs(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
+    """Add connection specifiation arguments"""
+
+    outer = parser.add_argument_group('Connection', 'Optional arguments that specify how to connect to a Meshtastic device.')
+    group = outer.add_mutually_exclusive_group()
+    group.add_argument(
+        "--port",
+        help="The port of the device to connect to using serial, e.g. /dev/ttyUSB0.",
+        default=None,
+    )
+
+    group.add_argument(
+        "--host",
+        help="The hostname or IP address of the device to connect to using TCP",
+        default=None,
+    )
+
+    group.add_argument(
+        "--ble",
+        help="The BLE device address or name to connect to",
+        default=None,
+    )
+
+    return parser
+
 
 def initParser():
     """Initialize the command line argument parsing."""
@@ -1002,64 +1067,77 @@ def initParser():
     parser = our_globals.get_parser()
     args = our_globals.get_args()
 
-    parser.add_argument(
+    # The "Help" group includes the help option and other informational stuff about the CLI itself
+    outerHelpGroup = parser.add_argument_group('Help')
+    helpGroup = outerHelpGroup.add_mutually_exclusive_group()
+    helpGroup.add_argument("-h", "--help", action="help", help="show this help message and exit")
+
+    the_version = get_active_version()
+    helpGroup.add_argument("--version", action="version", version=f"{the_version}")
+
+    helpGroup.add_argument(
+        "--support",
+        action="store_true",
+        help="Show support info (useful when troubleshooting an issue)",
+    )
+
+    # Connection arguments to indicate a device to connect to
+    parser = addConnectionArgs(parser)
+
+    # Arguments concerning viewing and setting configuration
+
+    # Arguments for sending or requesting things from the local device
+
+    # Arguments for sending or requesting things from the mesh
+
+    # All the rest of the arguments
+    group = parser.add_argument_group("optional arguments")
+    group.add_argument(
         "--configure",
         help="Specify a path to a yaml(.yml) file containing the desired settings for the connected device.",
         action="append",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--export-config",
         help="Export the configuration in yaml(.yml) format.",
         action="store_true",
     )
 
-    parser.add_argument(
-        "--port",
-        help="The port the Meshtastic device is connected to, i.e. /dev/ttyUSB0. If unspecified, we'll try to find it.",
-        default=None,
-    )
-
-    parser.add_argument(
-        "--host",
-        help="The hostname/ipaddr of the device to connect to (over TCP)",
-        default=None,
-    )
-
-    parser.add_argument(
+    group.add_argument(
         "--seriallog",
         help="Log device serial output to either 'stdout', 'none' or a filename to append to.",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--info",
         help="Read and display the radio config information",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--get-canned-message",
         help="Show the canned message plugin message",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--get-ringtone", help="Show the stored ringtone", action="store_true"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--nodes",
         help="Print Node List in a pretty formatted table",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--qr",
         help="Display the QR code that corresponds to the current channel",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--get",
         help=(
             "Get a preferences field. Use an invalid field such as '0' to get a list of all fields."
@@ -1069,32 +1147,32 @@ def initParser():
         action="append",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--set",
         help="Set a preferences field. Can use either snake_case or camelCase format. (ex: 'ls_secs' or 'lsSecs')",
         nargs=2,
         action="append",
     )
 
-    parser.add_argument("--seturl", help="Set a channel URL", action="store")
+    group.add_argument("--seturl", help="Set a channel URL", action="store")
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-index",
         help="Set the specified channel index. Channels start at 0 (0 is the PRIMARY channel).",
         action="store",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-add",
         help="Add a secondary channel, you must specify a channel name",
         default=None,
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-del", help="Delete the ch-index channel", action="store_true"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-enable",
         help="Enable the specified channel",
         action="store_true",
@@ -1103,7 +1181,7 @@ def initParser():
     )
 
     # Note: We are doing a double negative here (Do we want to disable? If ch_disable==True, then disable.)
-    parser.add_argument(
+    group.add_argument(
         "--ch-disable",
         help="Disable the specified channel",
         action="store_true",
@@ -1111,7 +1189,7 @@ def initParser():
         default=False,
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-set",
         help=(
             "Set a channel parameter. To see channel settings available:'--ch-set all all --ch-index 0'. "
@@ -1124,88 +1202,82 @@ def initParser():
         action="append",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-vlongslow",
         help="Change to the very long-range and slow channel",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-longslow",
         help="Change to the long-range and slow channel",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-longfast",
         help="Change to the long-range and fast channel",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-medslow",
         help="Change to the med-range and slow channel",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-medfast",
         help="Change to the med-range and fast channel",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-shortslow",
         help="Change to the short-range and slow channel",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ch-shortfast",
         help="Change to the short-range and fast channel",
         action="store_true",
     )
 
-    parser.add_argument("--set-owner", help="Set device owner name", action="store")
+    group.add_argument("--set-owner", help="Set device owner name", action="store")
 
-    parser.add_argument(
+    group.add_argument(
         "--set-canned-message",
         help="Set the canned messages plugin message (up to 200 characters).",
         action="store",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--set-ringtone",
         help="Set the Notification Ringtone (up to 230 characters).",
         action="store",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--set-owner-short", help="Set device owner short name", action="store"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--set-ham", help="Set licensed Ham ID and turn off encryption", action="store"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--dest",
         help="The destination node id for any sent commands, if not set '^all' or '^local' is assumed as appropriate",
         default=None,
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--sendtext",
         help="Send a text message. Can specify a destination '--dest' and/or channel index '--ch-index'.",
     )
 
-    parser.add_argument(
-        "--sendping",
-        help="Send a ping message (which requests a reply)",
-        action="store_true",
-    )
-
-    parser.add_argument(
+    group.add_argument(
         "--traceroute",
         help="Traceroute from connected node to a destination. "
         "You need pass the destination ID as argument, like "
@@ -1213,93 +1285,97 @@ def initParser():
         "Only nodes that have the encryption key can be traced.",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--request-telemetry", 
         help="Request telemetry from a node. "
         "You need pass the destination ID as argument with '--dest'. "
         "For repeaters, the nodeNum is required.",
-        action="store_true", 
+        action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--ack",
         help="Use in combination with --sendtext to wait for an acknowledgment.",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--reboot", help="Tell the destination node to reboot", action="store_true"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--reboot-ota",
         help="Tell the destination node to reboot into factory firmware",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--shutdown", help="Tell the destination node to shutdown", action="store_true"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--device-metadata",
         help="Get the device metadata from the node",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--begin-edit",
         help="Tell the node to open a transaction to edit settings",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--commit-edit",
         help="Tell the node to commit open settings transaction",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--factory-reset",
         help="Tell the destination node to install the default config",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
+        "--remove-node",
+        help="Tell the destination node to remove a specific node from its DB, by node number or ID"
+    )
+    group.add_argument(
         "--reset-nodedb",
-        help="Tell the destination node clear its list of nodes",
+        help="Tell the destination node to clear its list of nodes",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--reply", help="Reply to received messages", action="store_true"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--gpio-wrb", nargs=2, help="Set a particular GPIO # to 1 or 0", action="append"
     )
 
-    parser.add_argument("--gpio-rd", help="Read from a GPIO mask (ex: '0x10')")
+    group.add_argument("--gpio-rd", help="Read from a GPIO mask (ex: '0x10')")
 
-    parser.add_argument(
+    group.add_argument(
         "--gpio-watch", help="Start watching a GPIO mask for changes (ex: '0x10')"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--no-time",
         help="Suppress sending the current time to the mesh",
         action="store_true",
     )
 
-    parser.add_argument("--setalt", help="Set device altitude (allows use without GPS)")
+    group.add_argument("--setalt", help="Set device altitude in meters (allows use without GPS)")
 
-    parser.add_argument("--setlat", help="Set device latitude (allows use without GPS)")
+    group.add_argument("--setlat", help="Set device latitude (allows use without GPS)")
 
-    parser.add_argument(
+    group.add_argument(
         "--setlon", help="Set device longitude (allows use without GPS)"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--pos-fields",
         help="Specify fields to send when sending a position. Use no argument for a list of valid values. "
         "Can pass multiple values as a space separated list like "
@@ -1308,41 +1384,43 @@ def initParser():
         action="store",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--debug", help="Show API library debug log messages", action="store_true"
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--test",
         help="Run stress test against all connected Meshtastic devices",
         action="store_true",
     )
 
-    parser.add_argument(
-        "--ble",
-        help="BLE device address or name to connect to",
-        default=None,
-    )
-    parser.add_argument(
+    group.add_argument(
         "--ble-scan",
         help="Scan for Meshtastic BLE devices",
         action="store_true",
     )
 
-    parser.add_argument(
+    group.add_argument(
         "--noproto",
         help="Don't start the API, just function as a dumb serial terminal.",
         action="store_true",
     )
 
+    group.add_argument(
+        "--listen",
+        help="Just stay open and listen to the protobuf stream. Enables debug logging.",
+        action="store_true",
+    )
+
     have_tunnel = platform.system() == "Linux"
     if have_tunnel:
-        parser.add_argument(
+        tunnelArgs = parser.add_argument_group('Tunnel', 'Arguments related to establishing a tunnel device over the mesh.')
+        tunnelArgs.add_argument(
             "--tunnel",
             action="store_true",
             help="Create a TUN tunnel device for forwarding IP packets over the mesh",
         )
-        parser.add_argument(
+        tunnelArgs.add_argument(
             "--subnet",
             dest="tunnel_net",
             help="Sets the local-end subnet address for the TUN IP bridge. (ex: 10.115' which is the default)",
@@ -1351,14 +1429,6 @@ def initParser():
 
     parser.set_defaults(deprecated=None)
 
-    the_version = pkg_resources.get_distribution("meshtastic").version
-    parser.add_argument("--version", action="version", version=f"{the_version}")
-
-    parser.add_argument(
-        "--support",
-        action="store_true",
-        help="Show support info (useful when troubleshooting an issue)",
-    )
 
     args = parser.parse_args()
     our_globals.set_args(args)
@@ -1368,7 +1438,10 @@ def initParser():
 def main():
     """Perform command line meshtastic operations"""
     our_globals = Globals.getInstance()
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        add_help=False,
+        epilog="If no connection arguments are specified, we search for a compatible serial device, "
+               "and if none is found, then attempt a TCP connection to localhost.")
     our_globals.set_parser(parser)
     initParser()
     common()
@@ -1380,7 +1453,7 @@ def main():
 def tunnelMain():
     """Run a meshtastic IP tunnel"""
     our_globals = Globals.getInstance()
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(add_help=False)
     our_globals.set_parser(parser)
     initParser()
     args = our_globals.get_args()

meshtastic/admin_pb2.py

@@ -14,12 +14,11 @@ _sym_db = _symbol_database.Default()
 from meshtastic import channel_pb2 as meshtastic_dot_channel__pb2
 from meshtastic import config_pb2 as meshtastic_dot_config__pb2
 from meshtastic import connection_status_pb2 as meshtastic_dot_connection__status__pb2
-from meshtastic import deviceonly_pb2 as meshtastic_dot_deviceonly__pb2
 from meshtastic import mesh_pb2 as meshtastic_dot_mesh__pb2
 from meshtastic import module_config_pb2 as meshtastic_dot_module__config__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16meshtastic/admin.proto\x1a\x18meshtastic/channel.proto\x1a\x17meshtastic/config.proto\x1a\"meshtastic/connection_status.proto\x1a\x1bmeshtastic/deviceonly.proto\x1a\x15meshtastic/mesh.proto\x1a\x1emeshtastic/module_config.proto\"\x83\x0f\n\x0c\x41\x64minMessage\x12\x1d\n\x13get_channel_request\x18\x01 \x01(\rH\x00\x12(\n\x14get_channel_response\x18\x02 \x01(\x0b\x32\x08.ChannelH\x00\x12\x1b\n\x11get_owner_request\x18\x03 \x01(\x08H\x00\x12#\n\x12get_owner_response\x18\x04 \x01(\x0b\x32\x05.UserH\x00\x12\x36\n\x12get_config_request\x18\x05 \x01(\x0e\x32\x18.AdminMessage.ConfigTypeH\x00\x12&\n\x13get_config_response\x18\x06 \x01(\x0b\x32\x07.ConfigH\x00\x12\x43\n\x19get_module_config_request\x18\x07 \x01(\x0e\x32\x1e.AdminMessage.ModuleConfigTypeH\x00\x12\x33\n\x1aget_module_config_response\x18\x08 \x01(\x0b\x32\r.ModuleConfigH\x00\x12\x34\n*get_canned_message_module_messages_request\x18\n \x01(\x08H\x00\x12\x35\n+get_canned_message_module_messages_response\x18\x0b \x01(\tH\x00\x12%\n\x1bget_device_metadata_request\x18\x0c \x01(\x08H\x00\x12\x37\n\x1cget_device_metadata_response\x18\r \x01(\x0b\x32\x0f.DeviceMetadataH\x00\x12\x1e\n\x14get_ringtone_request\x18\x0e \x01(\x08H\x00\x12\x1f\n\x15get_ringtone_response\x18\x0f \x01(\tH\x00\x12.\n$get_device_connection_status_request\x18\x10 \x01(\x08H\x00\x12H\n%get_device_connection_status_response\x18\x11 \x01(\x0b\x32\x17.DeviceConnectionStatusH\x00\x12&\n\x0cset_ham_mode\x18\x12 \x01(\x0b\x32\x0e.HamParametersH\x00\x12/\n%get_node_remote_hardware_pins_request\x18\x13 \x01(\x08H\x00\x12Q\n&get_node_remote_hardware_pins_response\x18\x14 \x01(\x0b\x32\x1f.NodeRemoteHardwarePinsResponseH\x00\x12 \n\x16\x65nter_dfu_mode_request\x18\x15 \x01(\x08H\x00\x12\x1a\n\tset_owner\x18  \x01(\x0b\x32\x05.UserH\x00\x12\x1f\n\x0bset_channel\x18! \x01(\x0b\x32\x08.ChannelH\x00\x12\x1d\n\nset_config\x18\" \x01(\x0b\x32\x07.ConfigH\x00\x12*\n\x11set_module_config\x18# \x01(\x0b\x32\r.ModuleConfigH\x00\x12,\n\"set_canned_message_module_messages\x18$ \x01(\tH\x00\x12\x1e\n\x14set_ringtone_message\x18% \x01(\tH\x00\x12\x1b\n\x11remove_by_nodenum\x18& \x01(\rH\x00\x12\x1d\n\x13\x62\x65gin_edit_settings\x18@ \x01(\x08H\x00\x12\x1e\n\x14\x63ommit_edit_settings\x18\x41 \x01(\x08H\x00\x12\x1c\n\x12reboot_ota_seconds\x18_ \x01(\x05H\x00\x12\x18\n\x0e\x65xit_simulator\x18` \x01(\x08H\x00\x12\x18\n\x0ereboot_seconds\x18\x61 \x01(\x05H\x00\x12\x1a\n\x10shutdown_seconds\x18\x62 \x01(\x05H\x00\x12\x17\n\rfactory_reset\x18\x63 \x01(\x05H\x00\x12\x16\n\x0cnodedb_reset\x18\x64 \x01(\x05H\x00\"\x95\x01\n\nConfigType\x12\x11\n\rDEVICE_CONFIG\x10\x00\x12\x13\n\x0fPOSITION_CONFIG\x10\x01\x12\x10\n\x0cPOWER_CONFIG\x10\x02\x12\x12\n\x0eNETWORK_CONFIG\x10\x03\x12\x12\n\x0e\x44ISPLAY_CONFIG\x10\x04\x12\x0f\n\x0bLORA_CONFIG\x10\x05\x12\x14\n\x10\x42LUETOOTH_CONFIG\x10\x06\"\xbb\x02\n\x10ModuleConfigType\x12\x0f\n\x0bMQTT_CONFIG\x10\x00\x12\x11\n\rSERIAL_CONFIG\x10\x01\x12\x13\n\x0f\x45XTNOTIF_CONFIG\x10\x02\x12\x17\n\x13STOREFORWARD_CONFIG\x10\x03\x12\x14\n\x10RANGETEST_CONFIG\x10\x04\x12\x14\n\x10TELEMETRY_CONFIG\x10\x05\x12\x14\n\x10\x43\x41NNEDMSG_CONFIG\x10\x06\x12\x10\n\x0c\x41UDIO_CONFIG\x10\x07\x12\x19\n\x15REMOTEHARDWARE_CONFIG\x10\x08\x12\x17\n\x13NEIGHBORINFO_CONFIG\x10\t\x12\x1a\n\x16\x41MBIENTLIGHTING_CONFIG\x10\n\x12\x1a\n\x16\x44\x45TECTIONSENSOR_CONFIG\x10\x0b\x12\x15\n\x11PAXCOUNTER_CONFIG\x10\x0c\x42\x11\n\x0fpayload_variant\"[\n\rHamParameters\x12\x11\n\tcall_sign\x18\x01 \x01(\t\x12\x10\n\x08tx_power\x18\x02 \x01(\x05\x12\x11\n\tfrequency\x18\x03 \x01(\x02\x12\x12\n\nshort_name\x18\x04 \x01(\t\"[\n\x1eNodeRemoteHardwarePinsResponse\x12\x39\n\x19node_remote_hardware_pins\x18\x01 \x03(\x0b\x32\x16.NodeRemoteHardwarePinB`\n\x13\x63om.geeksville.meshB\x0b\x41\x64minProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16meshtastic/admin.proto\x12\nmeshtastic\x1a\x18meshtastic/channel.proto\x1a\x17meshtastic/config.proto\x1a\"meshtastic/connection_status.proto\x1a\x15meshtastic/mesh.proto\x1a\x1emeshtastic/module_config.proto\"\xce\x11\n\x0c\x41\x64minMessage\x12\x1d\n\x13get_channel_request\x18\x01 \x01(\rH\x00\x12\x33\n\x14get_channel_response\x18\x02 \x01(\x0b\x32\x13.meshtastic.ChannelH\x00\x12\x1b\n\x11get_owner_request\x18\x03 \x01(\x08H\x00\x12.\n\x12get_owner_response\x18\x04 \x01(\x0b\x32\x10.meshtastic.UserH\x00\x12\x41\n\x12get_config_request\x18\x05 \x01(\x0e\x32#.meshtastic.AdminMessage.ConfigTypeH\x00\x12\x31\n\x13get_config_response\x18\x06 \x01(\x0b\x32\x12.meshtastic.ConfigH\x00\x12N\n\x19get_module_config_request\x18\x07 \x01(\x0e\x32).meshtastic.AdminMessage.ModuleConfigTypeH\x00\x12>\n\x1aget_module_config_response\x18\x08 \x01(\x0b\x32\x18.meshtastic.ModuleConfigH\x00\x12\x34\n*get_canned_message_module_messages_request\x18\n \x01(\x08H\x00\x12\x35\n+get_canned_message_module_messages_response\x18\x0b \x01(\tH\x00\x12%\n\x1bget_device_metadata_request\x18\x0c \x01(\x08H\x00\x12\x42\n\x1cget_device_metadata_response\x18\r \x01(\x0b\x32\x1a.meshtastic.DeviceMetadataH\x00\x12\x1e\n\x14get_ringtone_request\x18\x0e \x01(\x08H\x00\x12\x1f\n\x15get_ringtone_response\x18\x0f \x01(\tH\x00\x12.\n$get_device_connection_status_request\x18\x10 \x01(\x08H\x00\x12S\n%get_device_connection_status_response\x18\x11 \x01(\x0b\x32\".meshtastic.DeviceConnectionStatusH\x00\x12\x31\n\x0cset_ham_mode\x18\x12 \x01(\x0b\x32\x19.meshtastic.HamParametersH\x00\x12/\n%get_node_remote_hardware_pins_request\x18\x13 \x01(\x08H\x00\x12\\\n&get_node_remote_hardware_pins_response\x18\x14 \x01(\x0b\x32*.meshtastic.NodeRemoteHardwarePinsResponseH\x00\x12 \n\x16\x65nter_dfu_mode_request\x18\x15 \x01(\x08H\x00\x12\x1d\n\x13\x64\x65lete_file_request\x18\x16 \x01(\tH\x00\x12%\n\tset_owner\x18  \x01(\x0b\x32\x10.meshtastic.UserH\x00\x12*\n\x0bset_channel\x18! \x01(\x0b\x32\x13.meshtastic.ChannelH\x00\x12(\n\nset_config\x18\" \x01(\x0b\x32\x12.meshtastic.ConfigH\x00\x12\x35\n\x11set_module_config\x18# \x01(\x0b\x32\x18.meshtastic.ModuleConfigH\x00\x12,\n\"set_canned_message_module_messages\x18$ \x01(\tH\x00\x12\x1e\n\x14set_ringtone_message\x18% \x01(\tH\x00\x12\x1b\n\x11remove_by_nodenum\x18& \x01(\rH\x00\x12\x1b\n\x11set_favorite_node\x18\' \x01(\rH\x00\x12\x1e\n\x14remove_favorite_node\x18( \x01(\rH\x00\x12\x32\n\x12set_fixed_position\x18) \x01(\x0b\x32\x14.meshtastic.PositionH\x00\x12\x1f\n\x15remove_fixed_position\x18* \x01(\x08H\x00\x12\x1d\n\x13\x62\x65gin_edit_settings\x18@ \x01(\x08H\x00\x12\x1e\n\x14\x63ommit_edit_settings\x18\x41 \x01(\x08H\x00\x12\x1c\n\x12reboot_ota_seconds\x18_ \x01(\x05H\x00\x12\x18\n\x0e\x65xit_simulator\x18` \x01(\x08H\x00\x12\x18\n\x0ereboot_seconds\x18\x61 \x01(\x05H\x00\x12\x1a\n\x10shutdown_seconds\x18\x62 \x01(\x05H\x00\x12\x17\n\rfactory_reset\x18\x63 \x01(\x05H\x00\x12\x16\n\x0cnodedb_reset\x18\x64 \x01(\x05H\x00\"\x95\x01\n\nConfigType\x12\x11\n\rDEVICE_CONFIG\x10\x00\x12\x13\n\x0fPOSITION_CONFIG\x10\x01\x12\x10\n\x0cPOWER_CONFIG\x10\x02\x12\x12\n\x0eNETWORK_CONFIG\x10\x03\x12\x12\n\x0e\x44ISPLAY_CONFIG\x10\x04\x12\x0f\n\x0bLORA_CONFIG\x10\x05\x12\x14\n\x10\x42LUETOOTH_CONFIG\x10\x06\"\xbb\x02\n\x10ModuleConfigType\x12\x0f\n\x0bMQTT_CONFIG\x10\x00\x12\x11\n\rSERIAL_CONFIG\x10\x01\x12\x13\n\x0f\x45XTNOTIF_CONFIG\x10\x02\x12\x17\n\x13STOREFORWARD_CONFIG\x10\x03\x12\x14\n\x10RANGETEST_CONFIG\x10\x04\x12\x14\n\x10TELEMETRY_CONFIG\x10\x05\x12\x14\n\x10\x43\x41NNEDMSG_CONFIG\x10\x06\x12\x10\n\x0c\x41UDIO_CONFIG\x10\x07\x12\x19\n\x15REMOTEHARDWARE_CONFIG\x10\x08\x12\x17\n\x13NEIGHBORINFO_CONFIG\x10\t\x12\x1a\n\x16\x41MBIENTLIGHTING_CONFIG\x10\n\x12\x1a\n\x16\x44\x45TECTIONSENSOR_CONFIG\x10\x0b\x12\x15\n\x11PAXCOUNTER_CONFIG\x10\x0c\x42\x11\n\x0fpayload_variant\"[\n\rHamParameters\x12\x11\n\tcall_sign\x18\x01 \x01(\t\x12\x10\n\x08tx_power\x18\x02 \x01(\x05\x12\x11\n\tfrequency\x18\x03 \x01(\x02\x12\x12\n\nshort_name\x18\x04 \x01(\t\"f\n\x1eNodeRemoteHardwarePinsResponse\x12\x44\n\x19node_remote_hardware_pins\x18\x01 \x03(\x0b\x32!.meshtastic.NodeRemoteHardwarePinB`\n\x13\x63om.geeksville.meshB\x0b\x41\x64minProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.admin_pb2', globals())
@@ -27,14 +26,14 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\013AdminProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _ADMINMESSAGE._serialized_start=198
-  _ADMINMESSAGE._serialized_end=2121
-  _ADMINMESSAGE_CONFIGTYPE._serialized_start=1635
-  _ADMINMESSAGE_CONFIGTYPE._serialized_end=1784
-  _ADMINMESSAGE_MODULECONFIGTYPE._serialized_start=1787
-  _ADMINMESSAGE_MODULECONFIGTYPE._serialized_end=2102
-  _HAMPARAMETERS._serialized_start=2123
-  _HAMPARAMETERS._serialized_end=2214
-  _NODEREMOTEHARDWAREPINSRESPONSE._serialized_start=2216
-  _NODEREMOTEHARDWAREPINSRESPONSE._serialized_end=2307
+  _ADMINMESSAGE._serialized_start=181
+  _ADMINMESSAGE._serialized_end=2435
+  _ADMINMESSAGE_CONFIGTYPE._serialized_start=1949
+  _ADMINMESSAGE_CONFIGTYPE._serialized_end=2098
+  _ADMINMESSAGE_MODULECONFIGTYPE._serialized_start=2101
+  _ADMINMESSAGE_MODULECONFIGTYPE._serialized_end=2416
+  _HAMPARAMETERS._serialized_start=2437
+  _HAMPARAMETERS._serialized_end=2528
+  _NODEREMOTEHARDWAREPINSRESPONSE._serialized_start=2530
+  _NODEREMOTEHARDWAREPINSRESPONSE._serialized_end=2632
 # @@protoc_insertion_point(module_scope)

meshtastic/admin_pb2.pyi

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

meshtastic/apponly_pb2.py

@@ -15,7 +15,7 @@ from meshtastic import channel_pb2 as meshtastic_dot_channel__pb2
 from meshtastic import config_pb2 as meshtastic_dot_config__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18meshtastic/apponly.proto\x1a\x18meshtastic/channel.proto\x1a\x17meshtastic/config.proto\"Y\n\nChannelSet\x12\"\n\x08settings\x18\x01 \x03(\x0b\x32\x10.ChannelSettings\x12\'\n\x0blora_config\x18\x02 \x01(\x0b\x32\x12.Config.LoRaConfigBb\n\x13\x63om.geeksville.meshB\rAppOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18meshtastic/apponly.proto\x12\nmeshtastic\x1a\x18meshtastic/channel.proto\x1a\x17meshtastic/config.proto\"o\n\nChannelSet\x12-\n\x08settings\x18\x01 \x03(\x0b\x32\x1b.meshtastic.ChannelSettings\x12\x32\n\x0blora_config\x18\x02 \x01(\x0b\x32\x1d.meshtastic.Config.LoRaConfigBb\n\x13\x63om.geeksville.meshB\rAppOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.apponly_pb2', globals())
@@ -23,6 +23,6 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\rAppOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _CHANNELSET._serialized_start=79
-  _CHANNELSET._serialized_end=168
+  _CHANNELSET._serialized_start=91
+  _CHANNELSET._serialized_end=202
 # @@protoc_insertion_point(module_scope)

meshtastic/apponly_pb2.pyi

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

meshtastic/atak_pb2.py

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

meshtastic/atak_pb2.pyi

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

meshtastic/ble_interface.py

@@ -3,12 +3,12 @@
 import logging
 import time
 import struct
+import asyncio
 from threading import Thread, Event
+from bleak import BleakScanner, BleakClient
+
 from meshtastic.mesh_interface import MeshInterface
 from meshtastic.util import our_exit
-from bleak import BleakScanner, BleakClient
-import asyncio
-
 
 SERVICE_UUID = "6ba1b218-15a8-461f-9fa8-5dcae273eafd"
 TORADIO_UUID = "f75c76d2-129e-4dad-a1dd-7866124401e7"
@@ -17,13 +17,14 @@ FROMNUM_UUID = "ed9da18c-a800-4f66-a670-aa7547e34453"
 
 
 class BLEInterface(MeshInterface):
+    """MeshInterface using BLE to connect to devices"""
     class BLEError(Exception):
+        """An exception class for BLE errors"""
         def __init__(self, message):
             self.message = message
             super().__init__(self.message)
 
-
-    class BLEState():
+    class BLEState(): # pylint: disable=C0115
         THREADS = False
         BLE = False
         MESH = False
@@ -60,7 +61,7 @@ class BLEInterface(MeshInterface):
         MeshInterface.__init__(self, debugOut = debugOut, noProto = noProto)
         self._startConfig()
         if not self.noProto:
-            self._waitConnected()
+            self._waitConnected(timeout = 60.0)
             self.waitForConfig()
         self.state.MESH = True
         logging.debug("Mesh init finished")
@@ -69,13 +70,14 @@ class BLEInterface(MeshInterface):
         self.client.start_notify(FROMNUM_UUID, self.from_num_handler)
 
 
-    async def from_num_handler(self, _, b):
+    async def from_num_handler(self, _, b): # pylint: disable=C0116
         from_num = struct.unpack('<I', bytes(b))[0]
         logging.debug(f"FROMNUM notify: {from_num}")
         self.should_read = True
 
 
     def scan(self):
+        "Scan for available BLE devices"
         with BLEClient() as client:
             return [
                 (x[0], x[1]) for x in (client.discover(
@@ -86,12 +88,15 @@ class BLEInterface(MeshInterface):
 
 
     def find_device(self, address):
+        "Find a device by address"
         meshtastic_devices = self.scan()
 
-        addressed_devices = list(filter(lambda x: address == x[1].local_name or address == x[0].name, meshtastic_devices))
+        addressed_devices = list(filter(lambda x: address in (x[1].local_name, x[0].name), meshtastic_devices))
         # If nothing is found try on the address
         if len(addressed_devices) == 0:
-            addressed_devices = list(filter(lambda x: BLEInterface._sanitize_address(address) == BLEInterface._sanitize_address(x[0].address), meshtastic_devices))
+            addressed_devices = list(filter(
+                lambda x: BLEInterface._sanitize_address(address) == BLEInterface._sanitize_address(x[0].address),
+                meshtastic_devices))
 
         if len(addressed_devices) == 0:
             raise BLEInterface.BLEError(f"No Meshtastic BLE peripheral with identifier or address '{address}' found. Try --ble-scan to find it.")
@@ -99,7 +104,8 @@ class BLEInterface(MeshInterface):
             raise BLEInterface.BLEError(f"More than one Meshtastic BLE peripheral with identifier or address '{address}' found.")
         return addressed_devices[0][0]
 
-    def _sanitize_address(address):
+    def _sanitize_address(address): # pylint: disable=E0213
+        "Standardize BLE address by removing extraneous characters and lowercasing"
         return address \
             .replace("-", "") \
             .replace("_", "") \
@@ -107,6 +113,7 @@ class BLEInterface(MeshInterface):
             .lower()
 
     def connect(self, address):
+        "Connect to a device by address"
         device = self.find_device(address)
         client = BLEClient(device.address)
         client.connect()
@@ -124,9 +131,14 @@ class BLEInterface(MeshInterface):
         while self._receiveThread_started.is_set():
             if self.should_read:
                 self.should_read = False
+                retries = 0
                 while True:
                     b = bytes(self.client.read_gatt_char(FROMRADIO_UUID))
                     if not b:
+                        if retries < 5:
+                            time.sleep(0.1)
+                            retries += 1
+                            continue
                         break
                     logging.debug(f"FROMRADIO read: {b.hex()}")
                     self._handleFromRadio(b)
@@ -151,13 +163,14 @@ class BLEInterface(MeshInterface):
         if self.state.THREADS:
             self._receiveThread_started.clear()
             self._receiveThread_stopped.wait(5)
-        
+
         if self.state.BLE:
             self.client.disconnect()
             self.client.close()
 
 
 class BLEClient():
+    """Client for managing connection to a BLE device"""
     def __init__(self, address = None, **kwargs):
         self._eventThread = Thread(target = self._run_event_loop)
         self._eventThread_started = Event()
@@ -172,47 +185,46 @@ class BLEClient():
         self.bleak_client = BleakClient(address, **kwargs)
 
 
-    def discover(self, **kwargs):
+    def discover(self, **kwargs): # pylint: disable=C0116
         return self.async_await(BleakScanner.discover(**kwargs))
 
-    def pair(self, **kwargs):
+    def pair(self, **kwargs): # pylint: disable=C0116
         return self.async_await(self.bleak_client.pair(**kwargs))
 
-    def connect(self, **kwargs):
+    def connect(self, **kwargs): # pylint: disable=C0116
         return self.async_await(self.bleak_client.connect(**kwargs))
 
-    def disconnect(self, **kwargs):
+    def disconnect(self, **kwargs): # pylint: disable=C0116
         self.async_await(self.bleak_client.disconnect(**kwargs))
 
-    def read_gatt_char(self, *args, **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):
+    def write_gatt_char(self, *args, **kwargs): # pylint: disable=C0116
         self.async_await(self.bleak_client.write_gatt_char(*args, **kwargs))
 
-    def start_notify(self, *args, **kwargs):
+    def start_notify(self, *args, **kwargs): # pylint: disable=C0116
         self.async_await(self.bleak_client.start_notify(*args, **kwargs))
 
-
-    def close(self):
+    def close(self): # pylint: disable=C0116
         self.async_run(self._stop_event_loop())
         self._eventThread_stopped.wait(5)
 
     def __enter__(self):
         return self
 
-    def __exit__(self, type, value, traceback):
+    def __exit__(self, _type, _value, _traceback):
         self.close()
 
-
-    def async_await(self, coro, timeout = None):
+    def async_await(self, coro, timeout = None): # pylint: disable=C0116
         return self.async_run(coro).result(timeout)
 
-    def async_run(self, coro):
+    def async_run(self, coro): # pylint: disable=C0116
         return asyncio.run_coroutine_threadsafe(coro, self._eventLoop)
 
     def _run_event_loop(self):
-        self._eventLoop = asyncio.new_event_loop()
+        # I don't know if the event loop can be initialized in __init__ so silencing pylint
+        self._eventLoop = asyncio.new_event_loop() # pylint: disable=W0201
         self._eventThread_started.set()
         try:
             self._eventLoop.run_forever()

meshtastic/cannedmessages_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1fmeshtastic/cannedmessages.proto\"-\n\x19\x43\x61nnedMessageModuleConfig\x12\x10\n\x08messages\x18\x01 \x01(\tBn\n\x13\x63om.geeksville.meshB\x19\x43\x61nnedMessageConfigProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1fmeshtastic/cannedmessages.proto\x12\nmeshtastic\"-\n\x19\x43\x61nnedMessageModuleConfig\x12\x10\n\x08messages\x18\x01 \x01(\tBn\n\x13\x63om.geeksville.meshB\x19\x43\x61nnedMessageConfigProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.cannedmessages_pb2', globals())
@@ -21,6 +21,6 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\031CannedMessageConfigProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _CANNEDMESSAGEMODULECONFIG._serialized_start=35
-  _CANNEDMESSAGEMODULECONFIG._serialized_end=80
+  _CANNEDMESSAGEMODULECONFIG._serialized_start=47
+  _CANNEDMESSAGEMODULECONFIG._serialized_end=92
 # @@protoc_insertion_point(module_scope)

meshtastic/cannedmessages_pb2.pyi

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

meshtastic/channel_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18meshtastic/channel.proto\"\x83\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\"\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\x42\x62\n\x13\x63om.geeksville.meshB\rChannelProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18meshtastic/channel.proto\x12\nmeshtastic\"\xb8\x01\n\x0f\x43hannelSettings\x12\x17\n\x0b\x63hannel_num\x18\x01 \x01(\rB\x02\x18\x01\x12\x0b\n\x03psk\x18\x02 \x01(\x0c\x12\x0c\n\x04name\x18\x03 \x01(\t\x12\n\n\x02id\x18\x04 \x01(\x07\x12\x16\n\x0euplink_enabled\x18\x05 \x01(\x08\x12\x18\n\x10\x64ownlink_enabled\x18\x06 \x01(\x08\x12\x33\n\x0fmodule_settings\x18\x07 \x01(\x0b\x32\x1a.meshtastic.ModuleSettings\",\n\x0eModuleSettings\x12\x1a\n\x12position_precision\x18\x01 \x01(\r\"\xa1\x01\n\x07\x43hannel\x12\r\n\x05index\x18\x01 \x01(\x05\x12-\n\x08settings\x18\x02 \x01(\x0b\x32\x1b.meshtastic.ChannelSettings\x12&\n\x04role\x18\x03 \x01(\x0e\x32\x18.meshtastic.Channel.Role\"0\n\x04Role\x12\x0c\n\x08\x44ISABLED\x10\x00\x12\x0b\n\x07PRIMARY\x10\x01\x12\r\n\tSECONDARY\x10\x02\x42\x62\n\x13\x63om.geeksville.meshB\rChannelProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.channel_pb2', globals())
@@ -23,10 +23,12 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\rChannelProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
   _CHANNELSETTINGS.fields_by_name['channel_num']._options = None
   _CHANNELSETTINGS.fields_by_name['channel_num']._serialized_options = b'\030\001'
-  _CHANNELSETTINGS._serialized_start=29
-  _CHANNELSETTINGS._serialized_end=160
-  _CHANNEL._serialized_start=163
-  _CHANNEL._serialized_end=302
-  _CHANNEL_ROLE._serialized_start=254
-  _CHANNEL_ROLE._serialized_end=302
+  _CHANNELSETTINGS._serialized_start=41
+  _CHANNELSETTINGS._serialized_end=225
+  _MODULESETTINGS._serialized_start=227
+  _MODULESETTINGS._serialized_end=271
+  _CHANNEL._serialized_start=274
+  _CHANNEL._serialized_end=435
+  _CHANNEL_ROLE._serialized_start=387
+  _CHANNEL_ROLE._serialized_end=435
 # @@protoc_insertion_point(module_scope)

meshtastic/channel_pb2.pyi

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

meshtastic/clientonly_pb2.py

@@ -14,7 +14,7 @@ _sym_db = _symbol_database.Default()
 from meshtastic import localonly_pb2 as meshtastic_dot_localonly__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bmeshtastic/clientonly.proto\x1a\x1ameshtastic/localonly.proto\"\xf7\x01\n\rDeviceProfile\x12\x16\n\tlong_name\x18\x01 \x01(\tH\x00\x88\x01\x01\x12\x17\n\nshort_name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x18\n\x0b\x63hannel_url\x18\x03 \x01(\tH\x02\x88\x01\x01\x12!\n\x06\x63onfig\x18\x04 \x01(\x0b\x32\x0c.LocalConfigH\x03\x88\x01\x01\x12.\n\rmodule_config\x18\x05 \x01(\x0b\x32\x12.LocalModuleConfigH\x04\x88\x01\x01\x42\x0c\n\n_long_nameB\r\n\x0b_short_nameB\x0e\n\x0c_channel_urlB\t\n\x07_configB\x10\n\x0e_module_configBe\n\x13\x63om.geeksville.meshB\x10\x43lientOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bmeshtastic/clientonly.proto\x12\nmeshtastic\x1a\x1ameshtastic/localonly.proto\"\x8d\x02\n\rDeviceProfile\x12\x16\n\tlong_name\x18\x01 \x01(\tH\x00\x88\x01\x01\x12\x17\n\nshort_name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x18\n\x0b\x63hannel_url\x18\x03 \x01(\tH\x02\x88\x01\x01\x12,\n\x06\x63onfig\x18\x04 \x01(\x0b\x32\x17.meshtastic.LocalConfigH\x03\x88\x01\x01\x12\x39\n\rmodule_config\x18\x05 \x01(\x0b\x32\x1d.meshtastic.LocalModuleConfigH\x04\x88\x01\x01\x42\x0c\n\n_long_nameB\r\n\x0b_short_nameB\x0e\n\x0c_channel_urlB\t\n\x07_configB\x10\n\x0e_module_configBe\n\x13\x63om.geeksville.meshB\x10\x43lientOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.clientonly_pb2', globals())
@@ -22,6 +22,6 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\020ClientOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _DEVICEPROFILE._serialized_start=60
-  _DEVICEPROFILE._serialized_end=307
+  _DEVICEPROFILE._serialized_start=72
+  _DEVICEPROFILE._serialized_end=341
 # @@protoc_insertion_point(module_scope)

meshtastic/clientonly_pb2.pyi

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

meshtastic/connection_status_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\"meshtastic/connection_status.proto\"\x85\x02\n\x16\x44\x65viceConnectionStatus\x12(\n\x04wifi\x18\x01 \x01(\x0b\x32\x15.WifiConnectionStatusH\x00\x88\x01\x01\x12\x30\n\x08\x65thernet\x18\x02 \x01(\x0b\x32\x19.EthernetConnectionStatusH\x01\x88\x01\x01\x12\x32\n\tbluetooth\x18\x03 \x01(\x0b\x32\x1a.BluetoothConnectionStatusH\x02\x88\x01\x01\x12,\n\x06serial\x18\x04 \x01(\x0b\x32\x17.SerialConnectionStatusH\x03\x88\x01\x01\x42\x07\n\x05_wifiB\x0b\n\t_ethernetB\x0c\n\n_bluetoothB\t\n\x07_serial\"\\\n\x14WifiConnectionStatus\x12(\n\x06status\x18\x01 \x01(\x0b\x32\x18.NetworkConnectionStatus\x12\x0c\n\x04ssid\x18\x02 \x01(\t\x12\x0c\n\x04rssi\x18\x03 \x01(\x05\"D\n\x18\x45thernetConnectionStatus\x12(\n\x06status\x18\x01 \x01(\x0b\x32\x18.NetworkConnectionStatus\"{\n\x17NetworkConnectionStatus\x12\x12\n\nip_address\x18\x01 \x01(\x07\x12\x14\n\x0cis_connected\x18\x02 \x01(\x08\x12\x19\n\x11is_mqtt_connected\x18\x03 \x01(\x08\x12\x1b\n\x13is_syslog_connected\x18\x04 \x01(\x08\"L\n\x19\x42luetoothConnectionStatus\x12\x0b\n\x03pin\x18\x01 \x01(\r\x12\x0c\n\x04rssi\x18\x02 \x01(\x05\x12\x14\n\x0cis_connected\x18\x03 \x01(\x08\"<\n\x16SerialConnectionStatus\x12\x0c\n\x04\x62\x61ud\x18\x01 \x01(\r\x12\x14\n\x0cis_connected\x18\x02 \x01(\x08\x42\x65\n\x13\x63om.geeksville.meshB\x10\x43onnStatusProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\"meshtastic/connection_status.proto\x12\nmeshtastic\"\xb1\x02\n\x16\x44\x65viceConnectionStatus\x12\x33\n\x04wifi\x18\x01 \x01(\x0b\x32 .meshtastic.WifiConnectionStatusH\x00\x88\x01\x01\x12;\n\x08\x65thernet\x18\x02 \x01(\x0b\x32$.meshtastic.EthernetConnectionStatusH\x01\x88\x01\x01\x12=\n\tbluetooth\x18\x03 \x01(\x0b\x32%.meshtastic.BluetoothConnectionStatusH\x02\x88\x01\x01\x12\x37\n\x06serial\x18\x04 \x01(\x0b\x32\".meshtastic.SerialConnectionStatusH\x03\x88\x01\x01\x42\x07\n\x05_wifiB\x0b\n\t_ethernetB\x0c\n\n_bluetoothB\t\n\x07_serial\"g\n\x14WifiConnectionStatus\x12\x33\n\x06status\x18\x01 \x01(\x0b\x32#.meshtastic.NetworkConnectionStatus\x12\x0c\n\x04ssid\x18\x02 \x01(\t\x12\x0c\n\x04rssi\x18\x03 \x01(\x05\"O\n\x18\x45thernetConnectionStatus\x12\x33\n\x06status\x18\x01 \x01(\x0b\x32#.meshtastic.NetworkConnectionStatus\"{\n\x17NetworkConnectionStatus\x12\x12\n\nip_address\x18\x01 \x01(\x07\x12\x14\n\x0cis_connected\x18\x02 \x01(\x08\x12\x19\n\x11is_mqtt_connected\x18\x03 \x01(\x08\x12\x1b\n\x13is_syslog_connected\x18\x04 \x01(\x08\"L\n\x19\x42luetoothConnectionStatus\x12\x0b\n\x03pin\x18\x01 \x01(\r\x12\x0c\n\x04rssi\x18\x02 \x01(\x05\x12\x14\n\x0cis_connected\x18\x03 \x01(\x08\"<\n\x16SerialConnectionStatus\x12\x0c\n\x04\x62\x61ud\x18\x01 \x01(\r\x12\x14\n\x0cis_connected\x18\x02 \x01(\x08\x42\x65\n\x13\x63om.geeksville.meshB\x10\x43onnStatusProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.connection_status_pb2', globals())
@@ -21,16 +21,16 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\020ConnStatusProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _DEVICECONNECTIONSTATUS._serialized_start=39
-  _DEVICECONNECTIONSTATUS._serialized_end=300
-  _WIFICONNECTIONSTATUS._serialized_start=302
-  _WIFICONNECTIONSTATUS._serialized_end=394
-  _ETHERNETCONNECTIONSTATUS._serialized_start=396
-  _ETHERNETCONNECTIONSTATUS._serialized_end=464
-  _NETWORKCONNECTIONSTATUS._serialized_start=466
-  _NETWORKCONNECTIONSTATUS._serialized_end=589
-  _BLUETOOTHCONNECTIONSTATUS._serialized_start=591
-  _BLUETOOTHCONNECTIONSTATUS._serialized_end=667
-  _SERIALCONNECTIONSTATUS._serialized_start=669
-  _SERIALCONNECTIONSTATUS._serialized_end=729
+  _DEVICECONNECTIONSTATUS._serialized_start=51
+  _DEVICECONNECTIONSTATUS._serialized_end=356
+  _WIFICONNECTIONSTATUS._serialized_start=358
+  _WIFICONNECTIONSTATUS._serialized_end=461
+  _ETHERNETCONNECTIONSTATUS._serialized_start=463
+  _ETHERNETCONNECTIONSTATUS._serialized_end=542
+  _NETWORKCONNECTIONSTATUS._serialized_start=544
+  _NETWORKCONNECTIONSTATUS._serialized_end=667
+  _BLUETOOTHCONNECTIONSTATUS._serialized_start=669
+  _BLUETOOTHCONNECTIONSTATUS._serialized_end=745
+  _SERIALCONNECTIONSTATUS._serialized_start=747
+  _SERIALCONNECTIONSTATUS._serialized_end=807
 # @@protoc_insertion_point(module_scope)

meshtastic/connection_status_pb2.pyi

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

meshtastic/device_metadata_pb2.py

@@ -1,37 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: meshtastic/device_metadata.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 meshtastic import config_pb2 as meshtastic_dot_config__pb2
-from meshtastic import mesh_pb2 as meshtastic_dot_mesh__pb2
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n meshtastic/device_metadata.proto\x1a\x17meshtastic/config.proto\x1a\x15meshtastic/mesh.proto\"\xfc\x01\n\x0e\x44\x65viceMetadata\x12\x18\n\x10\x66irmware_version\x18\x01 \x01(\t\x12\x1c\n\x14\x64\x65vice_state_version\x18\x02 \x01(\r\x12\x13\n\x0b\x63\x61nShutdown\x18\x03 \x01(\x08\x12\x0f\n\x07hasWifi\x18\x04 \x01(\x08\x12\x14\n\x0chasBluetooth\x18\x05 \x01(\x08\x12\x13\n\x0bhasEthernet\x18\x06 \x01(\x08\x12\'\n\x04role\x18\x07 \x01(\x0e\x32\x19.Config.DeviceConfig.Role\x12\x16\n\x0eposition_flags\x18\x08 \x01(\r\x12 \n\x08hw_model\x18\t \x01(\x0e\x32\x0e.HardwareModelBi\n\x13\x63om.geeksville.meshB\x14\x44\x65viceMetadataProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
-
-
-
-_DEVICEMETADATA = DESCRIPTOR.message_types_by_name['DeviceMetadata']
-DeviceMetadata = _reflection.GeneratedProtocolMessageType('DeviceMetadata', (_message.Message,), {
-  'DESCRIPTOR' : _DEVICEMETADATA,
-  '__module__' : 'meshtastic.device_metadata_pb2'
-  # @@protoc_insertion_point(class_scope:DeviceMetadata)
-  })
-_sym_db.RegisterMessage(DeviceMetadata)
-
-if _descriptor._USE_C_DESCRIPTORS == False:
-
-  DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\024DeviceMetadataProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _DEVICEMETADATA._serialized_start=85
-  _DEVICEMETADATA._serialized_end=337
-# @@protoc_insertion_point(module_scope)

meshtastic/deviceonly_pb2.py

@@ -14,30 +14,33 @@ _sym_db = _symbol_database.Default()
 from meshtastic import channel_pb2 as meshtastic_dot_channel__pb2
 from meshtastic import localonly_pb2 as meshtastic_dot_localonly__pb2
 from meshtastic import mesh_pb2 as meshtastic_dot_mesh__pb2
-from meshtastic import telemetry_pb2 as meshtastic_dot_telemetry__pb2
 from meshtastic import module_config_pb2 as meshtastic_dot_module__config__pb2
+from meshtastic import telemetry_pb2 as meshtastic_dot_telemetry__pb2
+from . import nanopb_pb2 as nanopb__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bmeshtastic/deviceonly.proto\x1a\x18meshtastic/channel.proto\x1a\x1ameshtastic/localonly.proto\x1a\x15meshtastic/mesh.proto\x1a\x1ameshtastic/telemetry.proto\x1a\x1emeshtastic/module_config.proto\"\xc6\x02\n\x0b\x44\x65viceState\x12\x1c\n\x07my_node\x18\x02 \x01(\x0b\x32\x0b.MyNodeInfo\x12\x14\n\x05owner\x18\x03 \x01(\x0b\x32\x05.User\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\x0brx_waypoint\x18\x0c \x01(\x0b\x32\x0b.MeshPacket\x12\x39\n\x19node_remote_hardware_pins\x18\r \x03(\x0b\x32\x16.NodeRemoteHardwarePin\x12#\n\x0cnode_db_lite\x18\x0e \x03(\x0b\x32\r.NodeInfoLite\"\xab\x01\n\x0cNodeInfoLite\x12\x0b\n\x03num\x18\x01 \x01(\r\x12\x13\n\x04user\x18\x02 \x01(\x0b\x32\x05.User\x12\x1f\n\x08position\x18\x03 \x01(\x0b\x32\r.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\x0e.DeviceMetrics\x12\x0f\n\x07\x63hannel\x18\x07 \x01(\r\"\x85\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\x13.Position.LocSource\":\n\x0b\x43hannelFile\x12\x1a\n\x08\x63hannels\x18\x01 \x03(\x0b\x32\x08.Channel\x12\x0f\n\x07version\x18\x02 \x01(\r\"\xf6\x01\n\x08OEMStore\x12\x16\n\x0eoem_icon_width\x18\x01 \x01(\r\x12\x17\n\x0foem_icon_height\x18\x02 \x01(\r\x12\x15\n\roem_icon_bits\x18\x03 \x01(\x0c\x12\x1e\n\x08oem_font\x18\x04 \x01(\x0e\x32\x0c.ScreenFonts\x12\x10\n\x08oem_text\x18\x05 \x01(\t\x12\x13\n\x0boem_aes_key\x18\x06 \x01(\x0c\x12&\n\x10oem_local_config\x18\x07 \x01(\x0b\x32\x0c.LocalConfig\x12\x33\n\x17oem_local_module_config\x18\x08 \x01(\x0b\x32\x12.LocalModuleConfig\"J\n\x15NodeRemoteHardwarePin\x12\x10\n\x08node_num\x18\x01 \x01(\r\x12\x1f\n\x03pin\x18\x02 \x01(\x0b\x32\x12.RemoteHardwarePin*>\n\x0bScreenFonts\x12\x0e\n\nFONT_SMALL\x10\x00\x12\x0f\n\x0b\x46ONT_MEDIUM\x10\x01\x12\x0e\n\nFONT_LARGE\x10\x02\x42_\n\x13\x63om.geeksville.meshB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bmeshtastic/deviceonly.proto\x12\nmeshtastic\x1a\x18meshtastic/channel.proto\x1a\x1ameshtastic/localonly.proto\x1a\x15meshtastic/mesh.proto\x1a\x1emeshtastic/module_config.proto\x1a\x1ameshtastic/telemetry.proto\x1a\x0cnanopb.proto\"\x90\x01\n\x0cPositionLite\x12\x12\n\nlatitude_i\x18\x01 \x01(\x0f\x12\x13\n\x0blongitude_i\x18\x02 \x01(\x0f\x12\x10\n\x08\x61ltitude\x18\x03 \x01(\x05\x12\x0c\n\x04time\x18\x04 \x01(\x07\x12\x37\n\x0flocation_source\x18\x05 \x01(\x0e\x32\x1e.meshtastic.Position.LocSource\"\x86\x02\n\x0cNodeInfoLite\x12\x0b\n\x03num\x18\x01 \x01(\r\x12\x1e\n\x04user\x18\x02 \x01(\x0b\x32\x10.meshtastic.User\x12*\n\x08position\x18\x03 \x01(\x0b\x32\x18.meshtastic.PositionLite\x12\x0b\n\x03snr\x18\x04 \x01(\x02\x12\x12\n\nlast_heard\x18\x05 \x01(\x07\x12\x31\n\x0e\x64\x65vice_metrics\x18\x06 \x01(\x0b\x32\x19.meshtastic.DeviceMetrics\x12\x0f\n\x07\x63hannel\x18\x07 \x01(\r\x12\x10\n\x08via_mqtt\x18\x08 \x01(\x08\x12\x11\n\thops_away\x18\t \x01(\r\x12\x13\n\x0bis_favorite\x18\n \x01(\x08\"\xc3\x03\n\x0b\x44\x65viceState\x12\'\n\x07my_node\x18\x02 \x01(\x0b\x32\x16.meshtastic.MyNodeInfo\x12\x1f\n\x05owner\x18\x03 \x01(\x0b\x32\x10.meshtastic.User\x12-\n\rreceive_queue\x18\x05 \x03(\x0b\x32\x16.meshtastic.MeshPacket\x12\x0f\n\x07version\x18\x08 \x01(\r\x12/\n\x0frx_text_message\x18\x07 \x01(\x0b\x32\x16.meshtastic.MeshPacket\x12\x13\n\x07no_save\x18\t \x01(\x08\x42\x02\x18\x01\x12\x15\n\rdid_gps_reset\x18\x0b \x01(\x08\x12+\n\x0brx_waypoint\x18\x0c \x01(\x0b\x32\x16.meshtastic.MeshPacket\x12\x44\n\x19node_remote_hardware_pins\x18\r \x03(\x0b\x32!.meshtastic.NodeRemoteHardwarePin\x12Z\n\x0cnode_db_lite\x18\x0e \x03(\x0b\x32\x18.meshtastic.NodeInfoLiteB*\x92?\'\x92\x01$std::vector<meshtastic_NodeInfoLite>\"E\n\x0b\x43hannelFile\x12%\n\x08\x63hannels\x18\x01 \x03(\x0b\x32\x13.meshtastic.Channel\x12\x0f\n\x07version\x18\x02 \x01(\r\"\x97\x02\n\x08OEMStore\x12\x16\n\x0eoem_icon_width\x18\x01 \x01(\r\x12\x17\n\x0foem_icon_height\x18\x02 \x01(\r\x12\x15\n\roem_icon_bits\x18\x03 \x01(\x0c\x12)\n\x08oem_font\x18\x04 \x01(\x0e\x32\x17.meshtastic.ScreenFonts\x12\x10\n\x08oem_text\x18\x05 \x01(\t\x12\x13\n\x0boem_aes_key\x18\x06 \x01(\x0c\x12\x31\n\x10oem_local_config\x18\x07 \x01(\x0b\x32\x17.meshtastic.LocalConfig\x12>\n\x17oem_local_module_config\x18\x08 \x01(\x0b\x32\x1d.meshtastic.LocalModuleConfig*>\n\x0bScreenFonts\x12\x0e\n\nFONT_SMALL\x10\x00\x12\x0f\n\x0b\x46ONT_MEDIUM\x10\x01\x12\x0e\n\nFONT_LARGE\x10\x02\x42m\n\x13\x63om.geeksville.meshB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x92?\x0b\xc2\x01\x08<vector>b\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.deviceonly_pb2', globals())
 if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
-  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _SCREENFONTS._serialized_start=1192
-  _SCREENFONTS._serialized_end=1254
-  _DEVICESTATE._serialized_start=169
-  _DEVICESTATE._serialized_end=495
-  _NODEINFOLITE._serialized_start=498
-  _NODEINFOLITE._serialized_end=669
-  _POSITIONLITE._serialized_start=672
-  _POSITIONLITE._serialized_end=805
-  _CHANNELFILE._serialized_start=807
-  _CHANNELFILE._serialized_end=865
-  _OEMSTORE._serialized_start=868
-  _OEMSTORE._serialized_end=1114
-  _NODEREMOTEHARDWAREPIN._serialized_start=1116
-  _NODEREMOTEHARDWAREPIN._serialized_end=1190
+  DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nDeviceOnlyZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000\222?\013\302\001\010<vector>'
+  _DEVICESTATE.fields_by_name['no_save']._options = None
+  _DEVICESTATE.fields_by_name['no_save']._serialized_options = b'\030\001'
+  _DEVICESTATE.fields_by_name['node_db_lite']._options = None
+  _DEVICESTATE.fields_by_name['node_db_lite']._serialized_options = b'\222?\'\222\001$std::vector<meshtastic_NodeInfoLite>'
+  _SCREENFONTS._serialized_start=1413
+  _SCREENFONTS._serialized_end=1475
+  _POSITIONLITE._serialized_start=195
+  _POSITIONLITE._serialized_end=339
+  _NODEINFOLITE._serialized_start=342
+  _NODEINFOLITE._serialized_end=604
+  _DEVICESTATE._serialized_start=607
+  _DEVICESTATE._serialized_end=1058
+  _CHANNELFILE._serialized_start=1060
+  _CHANNELFILE._serialized_end=1129
+  _OEMSTORE._serialized_start=1132
+  _OEMSTORE._serialized_end=1411
 # @@protoc_insertion_point(module_scope)

meshtastic/deviceonly_pb2.pyi

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

meshtastic/globals.py

@@ -24,7 +24,7 @@ class Globals:
     def __init__(self):
         """Constructor for the Globals CLass"""
         if Globals.__instance is not None:
-            raise Exception("This class is a singleton")
+            raise Exception("This class is a singleton") # pylint: disable=W0719
         else:
             Globals.__instance = self
         self.args = None

meshtastic/localonly_pb2.py

@@ -15,7 +15,7 @@ from meshtastic import config_pb2 as meshtastic_dot_config__pb2
 from meshtastic import module_config_pb2 as meshtastic_dot_module__config__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1ameshtastic/localonly.proto\x1a\x17meshtastic/config.proto\x1a\x1emeshtastic/module_config.proto\"\xb0\x02\n\x0bLocalConfig\x12$\n\x06\x64\x65vice\x18\x01 \x01(\x0b\x32\x14.Config.DeviceConfig\x12(\n\x08position\x18\x02 \x01(\x0b\x32\x16.Config.PositionConfig\x12\"\n\x05power\x18\x03 \x01(\x0b\x32\x13.Config.PowerConfig\x12&\n\x07network\x18\x04 \x01(\x0b\x32\x15.Config.NetworkConfig\x12&\n\x07\x64isplay\x18\x05 \x01(\x0b\x32\x15.Config.DisplayConfig\x12 \n\x04lora\x18\x06 \x01(\x0b\x32\x12.Config.LoRaConfig\x12*\n\tbluetooth\x18\x07 \x01(\x0b\x32\x17.Config.BluetoothConfig\x12\x0f\n\x07version\x18\x08 \x01(\r\"\xec\x05\n\x11LocalModuleConfig\x12&\n\x04mqtt\x18\x01 \x01(\x0b\x32\x18.ModuleConfig.MQTTConfig\x12*\n\x06serial\x18\x02 \x01(\x0b\x32\x1a.ModuleConfig.SerialConfig\x12G\n\x15\x65xternal_notification\x18\x03 \x01(\x0b\x32(.ModuleConfig.ExternalNotificationConfig\x12\x37\n\rstore_forward\x18\x04 \x01(\x0b\x32 .ModuleConfig.StoreForwardConfig\x12\x31\n\nrange_test\x18\x05 \x01(\x0b\x32\x1d.ModuleConfig.RangeTestConfig\x12\x30\n\ttelemetry\x18\x06 \x01(\x0b\x32\x1d.ModuleConfig.TelemetryConfig\x12\x39\n\x0e\x63\x61nned_message\x18\x07 \x01(\x0b\x32!.ModuleConfig.CannedMessageConfig\x12(\n\x05\x61udio\x18\t \x01(\x0b\x32\x19.ModuleConfig.AudioConfig\x12;\n\x0fremote_hardware\x18\n \x01(\x0b\x32\".ModuleConfig.RemoteHardwareConfig\x12\x37\n\rneighbor_info\x18\x0b \x01(\x0b\x32 .ModuleConfig.NeighborInfoConfig\x12=\n\x10\x61mbient_lighting\x18\x0c \x01(\x0b\x32#.ModuleConfig.AmbientLightingConfig\x12=\n\x10\x64\x65tection_sensor\x18\r \x01(\x0b\x32#.ModuleConfig.DetectionSensorConfig\x12\x32\n\npaxcounter\x18\x0e \x01(\x0b\x32\x1e.ModuleConfig.PaxcounterConfig\x12\x0f\n\x07version\x18\x08 \x01(\rBd\n\x13\x63om.geeksville.meshB\x0fLocalOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1ameshtastic/localonly.proto\x12\nmeshtastic\x1a\x17meshtastic/config.proto\x1a\x1emeshtastic/module_config.proto\"\xfd\x02\n\x0bLocalConfig\x12/\n\x06\x64\x65vice\x18\x01 \x01(\x0b\x32\x1f.meshtastic.Config.DeviceConfig\x12\x33\n\x08position\x18\x02 \x01(\x0b\x32!.meshtastic.Config.PositionConfig\x12-\n\x05power\x18\x03 \x01(\x0b\x32\x1e.meshtastic.Config.PowerConfig\x12\x31\n\x07network\x18\x04 \x01(\x0b\x32 .meshtastic.Config.NetworkConfig\x12\x31\n\x07\x64isplay\x18\x05 \x01(\x0b\x32 .meshtastic.Config.DisplayConfig\x12+\n\x04lora\x18\x06 \x01(\x0b\x32\x1d.meshtastic.Config.LoRaConfig\x12\x35\n\tbluetooth\x18\x07 \x01(\x0b\x32\".meshtastic.Config.BluetoothConfig\x12\x0f\n\x07version\x18\x08 \x01(\r\"\xfb\x06\n\x11LocalModuleConfig\x12\x31\n\x04mqtt\x18\x01 \x01(\x0b\x32#.meshtastic.ModuleConfig.MQTTConfig\x12\x35\n\x06serial\x18\x02 \x01(\x0b\x32%.meshtastic.ModuleConfig.SerialConfig\x12R\n\x15\x65xternal_notification\x18\x03 \x01(\x0b\x32\x33.meshtastic.ModuleConfig.ExternalNotificationConfig\x12\x42\n\rstore_forward\x18\x04 \x01(\x0b\x32+.meshtastic.ModuleConfig.StoreForwardConfig\x12<\n\nrange_test\x18\x05 \x01(\x0b\x32(.meshtastic.ModuleConfig.RangeTestConfig\x12;\n\ttelemetry\x18\x06 \x01(\x0b\x32(.meshtastic.ModuleConfig.TelemetryConfig\x12\x44\n\x0e\x63\x61nned_message\x18\x07 \x01(\x0b\x32,.meshtastic.ModuleConfig.CannedMessageConfig\x12\x33\n\x05\x61udio\x18\t \x01(\x0b\x32$.meshtastic.ModuleConfig.AudioConfig\x12\x46\n\x0fremote_hardware\x18\n \x01(\x0b\x32-.meshtastic.ModuleConfig.RemoteHardwareConfig\x12\x42\n\rneighbor_info\x18\x0b \x01(\x0b\x32+.meshtastic.ModuleConfig.NeighborInfoConfig\x12H\n\x10\x61mbient_lighting\x18\x0c \x01(\x0b\x32..meshtastic.ModuleConfig.AmbientLightingConfig\x12H\n\x10\x64\x65tection_sensor\x18\r \x01(\x0b\x32..meshtastic.ModuleConfig.DetectionSensorConfig\x12=\n\npaxcounter\x18\x0e \x01(\x0b\x32).meshtastic.ModuleConfig.PaxcounterConfig\x12\x0f\n\x07version\x18\x08 \x01(\rBd\n\x13\x63om.geeksville.meshB\x0fLocalOnlyProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.localonly_pb2', globals())
@@ -23,8 +23,8 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\017LocalOnlyProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _LOCALCONFIG._serialized_start=88
-  _LOCALCONFIG._serialized_end=392
-  _LOCALMODULECONFIG._serialized_start=395
-  _LOCALMODULECONFIG._serialized_end=1143
+  _LOCALCONFIG._serialized_start=100
+  _LOCALCONFIG._serialized_end=481
+  _LOCALMODULECONFIG._serialized_start=484
+  _LOCALMODULECONFIG._serialized_end=1375
 # @@protoc_insertion_point(module_scope)

meshtastic/localonly_pb2.pyi

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

meshtastic/mesh_interface.py

@@ -9,21 +9,22 @@ import sys
 import threading
 import time
 from datetime import datetime
-from typing import AnyStr
+
+from typing import Any, Callable, Dict, List, Optional, Union
 
 import google.protobuf.json_format
-import timeago
-from google.protobuf.json_format import MessageToJson
-from pubsub import pub
+import timeago # type: ignore[import-untyped]
+from pubsub import pub # type: ignore[import-untyped]
 from tabulate import tabulate
 
 import meshtastic.node
-from meshtastic import mesh_pb2, portnums_pb2, telemetry_pb2
-from meshtastic.__init__ import (
+from meshtastic import (
+    mesh_pb2,
+    portnums_pb2,
+    telemetry_pb2,
     BROADCAST_ADDR,
     BROADCAST_NUM,
     LOCAL_ADDR,
-    OUR_APP_VERSION,
     ResponseHandler,
     protocols,
     publishingThread,
@@ -35,6 +36,7 @@ from meshtastic.util import (
     our_exit,
     remove_keys_from_dict,
     stripnl,
+    message_to_json,
 )
 
 
@@ -48,7 +50,13 @@ class MeshInterface:
     debugOut
     """
 
-    def __init__(self, debugOut=None, noProto=False):
+    class MeshInterfaceError(Exception):
+        """An exception class for general mesh interface errors"""
+        def __init__(self, message):
+            self.message = message
+            super().__init__(self.message)
+
+    def __init__(self, debugOut=None, noProto: bool=False) -> None:
         """Constructor
 
         Keyword Arguments:
@@ -56,27 +64,27 @@ class MeshInterface:
                        link - just be a dumb serial client.
         """
         self.debugOut = debugOut
-        self.nodes = None  # FIXME
-        self.isConnected = threading.Event()
-        self.noProto = noProto
-        self.localNode = meshtastic.node.Node(self, -1)  # We fixup nodenum later
-        self.myInfo = None  # We don't have device info yet
-        self.metadata = None  # We don't have device metadata yet
-        self.responseHandlers = {}  # A map from request ID to the handler
+        self.nodes: Optional[Dict[str,Dict]] = None  # FIXME
+        self.isConnected: threading.Event = threading.Event()
+        self.noProto: bool = noProto
+        self.localNode: meshtastic.node.Node = meshtastic.node.Node(self, -1)  # We fixup nodenum later
+        self.myInfo: Optional[mesh_pb2.MyNodeInfo] = None  # We don't have device info yet
+        self.metadata: Optional[mesh_pb2.DeviceMetadata] = None  # We don't have device metadata yet
+        self.responseHandlers: Dict[int,ResponseHandler] = {}  # A map from request ID to the handler
         self.failure = (
             None  # If we've encountered a fatal exception it will be kept here
         )
-        self._timeout = Timeout()
-        self._acknowledgment = Acknowledgment()
-        self.heartbeatTimer = None
+        self._timeout: Timeout = Timeout()
+        self._acknowledgment: Acknowledgment = Acknowledgment()
+        self.heartbeatTimer: Optional[threading.Timer] = None
         random.seed()  # FIXME, we should not clobber the random seedval here, instead tell user they must call it
-        self.currentPacketId = random.randint(0, 0xFFFFFFFF)
-        self.nodesByNum = None
-        self.configId = None
-        self.gotResponse = False  # used in gpio read
-        self.mask = None  # used in gpio read and gpio watch
-        self.queueStatus = None
-        self.queue = collections.OrderedDict()
+        self.currentPacketId: int = random.randint(0, 0xFFFFFFFF)
+        self.nodesByNum: Optional[Dict[int, Dict]] = None
+        self.configId: Optional[int] = None
+        self.gotResponse: bool = False  # used in gpio read
+        self.mask: Optional[int] = None  # used in gpio read and gpio watch
+        self.queueStatus: Optional[mesh_pb2.QueueStatus] = None
+        self.queue: collections.OrderedDict = collections.OrderedDict()
 
     def close(self):
         """Shutdown this interface"""
@@ -97,15 +105,15 @@ class MeshInterface:
             logging.error(f"Traceback: {traceback}")
         self.close()
 
-    def showInfo(self, file=sys.stdout):  # pylint: disable=W0613
+    def showInfo(self, file=sys.stdout) -> str:  # pylint: disable=W0613
         """Show human readable summary about this object"""
         owner = f"Owner: {self.getLongName()} ({self.getShortName()})"
         myinfo = ""
         if self.myInfo:
-            myinfo = f"\nMy info: {stripnl(MessageToJson(self.myInfo))}"
+            myinfo = f"\nMy info: {message_to_json(self.myInfo)}"
         metadata = ""
         if self.metadata:
-            metadata = f"\nMetadata: {stripnl(MessageToJson(self.metadata))}"
+            metadata = f"\nMetadata: {message_to_json(self.metadata)}"
         mesh = "\n\nNodes in mesh: "
         nodes = {}
         if self.nodes:
@@ -124,26 +132,25 @@ class MeshInterface:
 
                 # use id as dictionary key for correct json format in list of nodes
                 nodeid = n2["user"]["id"]
-                n2["user"].pop("id")
                 nodes[nodeid] = n2
         infos = owner + myinfo + metadata + mesh + json.dumps(nodes)
         print(infos)
         return infos
 
-    def showNodes(self, includeSelf=True, file=sys.stdout):  # pylint: disable=W0613
+    def showNodes(self, includeSelf: bool=True, file=sys.stdout) -> str:  # pylint: disable=W0613
         """Show table summary of nodes in mesh"""
 
-        def formatFloat(value, precision=2, unit=""):
+        def formatFloat(value, precision=2, unit="") -> Optional[str]:
             """Format a float value with precision."""
             return f"{value:.{precision}f}{unit}" if value else None
 
-        def getLH(ts):
+        def getLH(ts) -> Optional[str]:
             """Format last heard"""
             return (
                 datetime.fromtimestamp(ts).strftime("%Y-%m-%d %H:%M:%S") if ts else None
             )
 
-        def getTimeAgo(ts):
+        def getTimeAgo(ts) -> Optional[str]:
             """Format how long ago have we heard from this node (aka timeago)."""
             return (
                 timeago.format(datetime.fromtimestamp(ts), datetime.now())
@@ -151,14 +158,14 @@ class MeshInterface:
                 else None
             )
 
-        rows = []
-        if self.nodes:
+        rows: List[Dict[str, Any]] = []
+        if self.nodesByNum:
             logging.debug(f"self.nodes:{self.nodes}")
-            for node in self.nodes.values():
+            for node in self.nodesByNum.values():
                 if not includeSelf and node["num"] == self.localNode.nodeNum:
                     continue
 
-                row = {"N": 0}
+                row = {"N": 0, "User": f"UNK: {node['num']}", "ID": f"!{node['num']:08x}"}
 
                 user = node.get("user")
                 if user:
@@ -203,6 +210,7 @@ class MeshInterface:
                 row.update(
                     {
                         "SNR": formatFloat(node.get("snr"), 2, " dB"),
+                        "Hops Away": node.get("hopsAway", "unknown"),
                         "Channel": node.get("channel"),
                         "LastHeard": getLH(node.get("lastHeard")),
                         "Since": getTimeAgo(node.get("lastHeard")),
@@ -219,7 +227,7 @@ class MeshInterface:
         print(table)
         return table
 
-    def getNode(self, nodeId, requestChannels=True):
+    def getNode(self, nodeId: str, requestChannels: bool=True) -> meshtastic.node.Node:
         """Return a node object which contains device settings and channel info"""
         if nodeId in (LOCAL_ADDR, BROADCAST_ADDR):
             return self.localNode
@@ -235,12 +243,12 @@ class MeshInterface:
 
     def sendText(
         self,
-        text: AnyStr,
-        destinationId=BROADCAST_ADDR,
-        wantAck=False,
-        wantResponse=False,
-        onResponse=None,
-        channelIndex=0,
+        text: str,
+        destinationId: Union[int, str]=BROADCAST_ADDR,
+        wantAck: bool=False,
+        wantResponse: bool=False,
+        onResponse: Optional[Callable[[mesh_pb2.MeshPacket], Any]]=None,
+        channelIndex: int=0,
     ):
         """Send a utf8 string to some other node, if the node has a display it
            will also be shown on the device.
@@ -275,12 +283,12 @@ class MeshInterface:
     def sendData(
         self,
         data,
-        destinationId=BROADCAST_ADDR,
-        portNum=portnums_pb2.PortNum.PRIVATE_APP,
-        wantAck=False,
-        wantResponse=False,
-        onResponse=None,
-        channelIndex=0,
+        destinationId: Union[int, str]=BROADCAST_ADDR,
+        portNum: portnums_pb2.PortNum.ValueType=portnums_pb2.PortNum.PRIVATE_APP,
+        wantAck: bool=False,
+        wantResponse: bool=False,
+        onResponse: Optional[Callable[[mesh_pb2.MeshPacket], Any]]=None,
+        channelIndex: int=0,
     ):
         """Send a data packet to some other node
 
@@ -314,7 +322,7 @@ class MeshInterface:
             f"mesh_pb2.Constants.DATA_PAYLOAD_LEN: {mesh_pb2.Constants.DATA_PAYLOAD_LEN}"
         )
         if len(data) > mesh_pb2.Constants.DATA_PAYLOAD_LEN:
-            raise Exception("Data payload too big")
+            raise MeshInterface.MeshInterfaceError("Data payload too big")
 
         if (
             portNum == portnums_pb2.PortNum.UNKNOWN_APP
@@ -335,13 +343,13 @@ class MeshInterface:
 
     def sendPosition(
         self,
-        latitude=0.0,
-        longitude=0.0,
-        altitude=0,
-        timeSec=0,
-        destinationId=BROADCAST_ADDR,
-        wantAck=False,
-        wantResponse=False,
+        latitude: float=0.0,
+        longitude: float=0.0,
+        altitude: int=0,
+        timeSec: int=0,
+        destinationId: Union[int, str]=BROADCAST_ADDR,
+        wantAck: bool=False,
+        wantResponse: bool=False,
     ):
         """
         Send a position packet to some other node (normally a broadcast)
@@ -368,8 +376,8 @@ class MeshInterface:
             logging.debug(f"p.altitude:{p.altitude}")
 
         if timeSec == 0:
-            timeSec = time.time()  # returns unix timestamp in seconds
-        p.time = int(timeSec)
+            timeSec = int(time.time())  # returns unix timestamp in seconds
+        p.time = timeSec
         logging.debug(f"p.time:{p.time}")
 
         return self.sendData(
@@ -380,7 +388,7 @@ class MeshInterface:
             wantResponse=wantResponse,
         )
 
-    def sendTraceRoute(self, dest, hopLimit):
+    def sendTraceRoute(self, dest: Union[int, str], hopLimit: int):
         """Send the trace route"""
         r = mesh_pb2.RouteDiscovery()
         self.sendData(
@@ -391,7 +399,7 @@ class MeshInterface:
             onResponse=self.onResponseTraceRoute,
         )
         # extend timeout based on number of nodes, limit by configured hopLimit
-        waitFactor = min(len(self.nodes) - 1, hopLimit)
+        waitFactor = min(len(self.nodes) - 1 if self.nodes else 0, hopLimit)
         self.waitForTraceRoute(waitFactor)
 
     def onResponseTraceRoute(self, p):
@@ -440,7 +448,7 @@ class MeshInterface:
             destinationId = int(destinationId[1:], 16)
         else:
             destinationId = int(destinationId)
-        
+
         self.sendData(
             r,
             destinationId=destinationId,
@@ -469,15 +477,15 @@ class MeshInterface:
                 )
             if telemetry.device_metrics.air_util_tx is not None:
                 print(f"Transmit air utilization: {telemetry.device_metrics.air_util_tx:.2f}%")
-            
+
         elif p["decoded"]["portnum"] == 'ROUTING_APP':
             if p["decoded"]["routing"]["errorReason"] == 'NO_RESPONSE':
                 our_exit("No response from node. At least firmware 2.1.22 is required on the destination node.")
 
-    def _addResponseHandler(self, requestId, callback):
+    def _addResponseHandler(self, requestId: int, callback: Callable):
         self.responseHandlers[requestId] = ResponseHandler(callback)
 
-    def _sendPacket(self, meshPacket, destinationId=BROADCAST_ADDR, wantAck=False):
+    def _sendPacket(self, meshPacket: mesh_pb2.MeshPacket, destinationId: Union[int,str]=BROADCAST_ADDR, wantAck: bool=False):
         """Send a MeshPacket to the specified node (or if unspecified, broadcast).
         You probably don't want this - use sendData instead.
 
@@ -491,7 +499,7 @@ class MeshInterface:
 
         toRadio = mesh_pb2.ToRadio()
 
-        nodeNum = 0
+        nodeNum: int = 0
         if destinationId is None:
             our_exit("Warning: destinationId must not be None")
         elif isinstance(destinationId, int):
@@ -509,9 +517,10 @@ class MeshInterface:
         else:
             if self.nodes:
                 node = self.nodes.get(destinationId)
-                if not node:
+                if node is None:
                     our_exit(f"Warning: NodeId {destinationId} not found in DB")
-                nodeNum = node["num"]
+                else:
+                    nodeNum = node["num"]
             else:
                 logging.warning("Warning: There were no self.nodes.")
 
@@ -543,29 +552,29 @@ class MeshInterface:
             and self.localNode.waitForConfig()
         )
         if not success:
-            raise Exception("Timed out waiting for interface config")
+            raise MeshInterface.MeshInterfaceError("Timed out waiting for interface config")
 
     def waitForAckNak(self):
         """Wait for the ack/nak"""
         success = self._timeout.waitForAckNak(self._acknowledgment)
         if not success:
-            raise Exception("Timed out waiting for an acknowledgment")
+            raise MeshInterface.MeshInterfaceError("Timed out waiting for an acknowledgment")
 
     def waitForTraceRoute(self, waitFactor):
         """Wait for trace route"""
         success = self._timeout.waitForTraceRoute(waitFactor, self._acknowledgment)
         if not success:
-            raise Exception("Timed out waiting for traceroute")
-        
+            raise MeshInterface.MeshInterfaceError("Timed out waiting for traceroute")
+
     def waitForTelemetry(self):
         """Wait for telemetry"""
         success = self._timeout.waitForTelemetry(self._acknowledgment)
         if not success:
-            raise Exception("Timed out waiting for telemetry")
+            raise MeshInterface.MeshInterfaceError("Timed out waiting for telemetry")
 
-    def getMyNodeInfo(self):
+    def getMyNodeInfo(self) -> Optional[Dict]:
         """Get info about my node."""
-        if self.myInfo is None:
+        if self.myInfo is None or self.nodesByNum is None:
             return None
         logging.debug(f"self.nodesByNum:{self.nodesByNum}")
         return self.nodesByNum.get(self.myInfo.my_node_num)
@@ -591,21 +600,21 @@ class MeshInterface:
             return user.get("shortName", None)
         return None
 
-    def _waitConnected(self, timeout=15.0):
+    def _waitConnected(self, timeout=30.0):
         """Block until the initial node db download is complete, or timeout
         and raise an exception"""
         if not self.noProto:
             if not self.isConnected.wait(timeout):  # timeout after x seconds
-                raise Exception("Timed out waiting for connection completion")
+                raise MeshInterface.MeshInterfaceError("Timed out waiting for connection completion")
 
         # If we failed while connecting, raise the connection to the client
         if self.failure:
             raise self.failure
 
-    def _generatePacketId(self):
+    def _generatePacketId(self) -> int:
         """Get a new unique packet ID"""
         if self.currentPacketId is None:
-            raise Exception("Not connected yet, can not generate packet")
+            raise MeshInterface.MeshInterfaceError("Not connected yet, can not generate packet")
         else:
             self.currentPacketId = (self.currentPacketId + 1) & 0xFFFFFFFF
             return self.currentPacketId
@@ -664,18 +673,18 @@ class MeshInterface:
         m.disconnect = True
         self._sendToRadio(m)
 
-    def _queueHasFreeSpace(self):
+    def _queueHasFreeSpace(self) -> bool:
         # We never got queueStatus, maybe the firmware is old
         if self.queueStatus is None:
             return True
         return self.queueStatus.free > 0
 
-    def _queueClaim(self):
+    def _queueClaim(self) -> None:
         if self.queueStatus is None:
             return
         self.queueStatus.free -= 1
 
-    def _sendToRadio(self, toRadio):
+    def _sendToRadio(self, toRadio: mesh_pb2.ToRadio) -> None:
         """Send a ToRadio protobuf to the device"""
         if self.noProto:
             logging.warning(
@@ -724,18 +733,18 @@ class MeshInterface:
                     self.queue[packetId] = packet
             # logging.warn("queue + resentQueue: " + " ".join(f'{k:08x}' for k in self.queue))
 
-    def _sendToRadioImpl(self, toRadio):
+    def _sendToRadioImpl(self, toRadio: mesh_pb2.ToRadio) -> None:
         """Send a ToRadio protobuf to the device"""
         logging.error(f"Subclass must provide toradio: {toRadio}")
 
-    def _handleConfigComplete(self):
+    def _handleConfigComplete(self) -> None:
         """
         Done with initial config messages, now send regular MeshPackets
         to ask for settings and channels
         """
         self.localNode.requestChannels()
 
-    def _handleQueueStatusFromRadio(self, queueStatus):
+    def _handleQueueStatusFromRadio(self, queueStatus) -> None:
         self.queueStatus = queueStatus
         logging.debug(
             f"TX QUEUE free {queueStatus.free} of {queueStatus.maxlen}, res = {queueStatus.res}, id = {queueStatus.mesh_packet_id:08x} "
@@ -774,7 +783,7 @@ class MeshInterface:
             failmsg = None
 
             if failmsg:
-                self.failure = Exception(failmsg)
+                self.failure = MeshInterface.MeshInterfaceError(failmsg)
                 self.isConnected.set()  # let waitConnected return this exception
                 self.close()
 
@@ -878,11 +887,15 @@ class MeshInterface:
                 self.localNode.moduleConfig.ambient_lighting.CopyFrom(
                     fromRadio.moduleConfig.ambient_lighting
                 )
+            elif fromRadio.moduleConfig.HasField("paxcounter"):
+                self.localNode.moduleConfig.paxcounter.CopyFrom(
+                    fromRadio.moduleConfig.paxcounter
+                )
 
         else:
             logging.debug("Unexpected FromRadio payload")
 
-    def _fixupPosition(self, position):
+    def _fixupPosition(self, position: Dict) -> Dict:
         """Convert integer lat/lon into floats
 
         Arguments:
@@ -916,7 +929,7 @@ class MeshInterface:
     def _getOrCreateByNum(self, nodeNum):
         """Given a nodenum find the NodeInfo in the DB (or create if necessary)"""
         if nodeNum == BROADCAST_NUM:
-            raise Exception("Can not create/find nodenum by the broadcast num")
+            raise MeshInterface.MeshInterfaceError("Can not create/find nodenum by the broadcast num")
 
         if nodeNum in self.nodesByNum:
             return self.nodesByNum[nodeNum]

meshtastic/mqtt_pb2.py

@@ -11,10 +11,11 @@ from google.protobuf import symbol_database as _symbol_database
 _sym_db = _symbol_database.Default()
 
 
+from meshtastic import config_pb2 as meshtastic_dot_config__pb2
 from meshtastic import mesh_pb2 as meshtastic_dot_mesh__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15meshtastic/mqtt.proto\x1a\x15meshtastic/mesh.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(\tB_\n\x13\x63om.geeksville.meshB\nMQTTProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15meshtastic/mqtt.proto\x12\nmeshtastic\x1a\x17meshtastic/config.proto\x1a\x15meshtastic/mesh.proto\"a\n\x0fServiceEnvelope\x12&\n\x06packet\x18\x01 \x01(\x0b\x32\x16.meshtastic.MeshPacket\x12\x12\n\nchannel_id\x18\x02 \x01(\t\x12\x12\n\ngateway_id\x18\x03 \x01(\t\"\xbc\x03\n\tMapReport\x12\x11\n\tlong_name\x18\x01 \x01(\t\x12\x12\n\nshort_name\x18\x02 \x01(\t\x12\x32\n\x04role\x18\x03 \x01(\x0e\x32$.meshtastic.Config.DeviceConfig.Role\x12+\n\x08hw_model\x18\x04 \x01(\x0e\x32\x19.meshtastic.HardwareModel\x12\x18\n\x10\x66irmware_version\x18\x05 \x01(\t\x12\x38\n\x06region\x18\x06 \x01(\x0e\x32(.meshtastic.Config.LoRaConfig.RegionCode\x12?\n\x0cmodem_preset\x18\x07 \x01(\x0e\x32).meshtastic.Config.LoRaConfig.ModemPreset\x12\x1b\n\x13has_default_channel\x18\x08 \x01(\x08\x12\x12\n\nlatitude_i\x18\t \x01(\x0f\x12\x13\n\x0blongitude_i\x18\n \x01(\x0f\x12\x10\n\x08\x61ltitude\x18\x0b \x01(\x05\x12\x1a\n\x12position_precision\x18\x0c \x01(\r\x12\x1e\n\x16num_online_local_nodes\x18\r \x01(\rB_\n\x13\x63om.geeksville.meshB\nMQTTProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.mqtt_pb2', globals())
@@ -22,6 +23,8 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\nMQTTProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _SERVICEENVELOPE._serialized_start=48
-  _SERVICEENVELOPE._serialized_end=134
+  _SERVICEENVELOPE._serialized_start=85
+  _SERVICEENVELOPE._serialized_end=182
+  _MAPREPORT._serialized_start=185
+  _MAPREPORT._serialized_end=629
 # @@protoc_insertion_point(module_scope)

meshtastic/mqtt_pb2.pyi

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

meshtastic/nanopb_pb2.py

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

meshtastic/nanopb_pb2.pyi

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

meshtastic/node.py

@@ -5,7 +5,7 @@ import base64
 import logging
 import time
 
-from google.protobuf.json_format import MessageToJson
+from typing import Union
 
 from meshtastic import admin_pb2, apponly_pb2, channel_pb2, localonly_pb2, portnums_pb2
 from meshtastic.util import (
@@ -15,6 +15,7 @@ from meshtastic.util import (
     our_exit,
     pskToString,
     stripnl,
+    message_to_json,
 )
 
 
@@ -47,12 +48,11 @@ class Node:
         if self.channels:
             logging.debug(f"self.channels:{self.channels}")
             for c in self.channels:
-                # print('c.settings.psk:', c.settings.psk)
-                cStr = stripnl(MessageToJson(c.settings))
+                cStr = message_to_json(c.settings)
                 # don't show disabled channels
                 if channel_pb2.Channel.Role.Name(c.role) != "DISABLED":
                     print(
-                        f"  {channel_pb2.Channel.Role.Name(c.role)} psk={pskToString(c.settings.psk)} {cStr}"
+                        f"  Index {c.index}: {channel_pb2.Channel.Role.Name(c.role)} psk={pskToString(c.settings.psk)} {cStr}"
                     )
         publicURL = self.getURL(includeAll=False)
         adminURL = self.getURL(includeAll=True)
@@ -64,11 +64,11 @@ class Node:
         """Show human readable description of our node"""
         prefs = ""
         if self.localConfig:
-            prefs = stripnl(MessageToJson(self.localConfig))
+            prefs = message_to_json(self.localConfig)
         print(f"Preferences: {prefs}\n")
         prefs = ""
         if self.moduleConfig:
-            prefs = stripnl(MessageToJson(self.moduleConfig))
+            prefs = message_to_json(self.moduleConfig)
         print(f"Module preferences: {prefs}\n")
         self.showChannels()
 
@@ -115,6 +115,7 @@ class Node:
             print(f"{str(camel_to_snake(field))}:\n{str(config_values)}")
 
     def requestConfig(self, configType):
+        """Request the config from the node via admin message"""
         if self == self.iface.localNode:
             onResponse = None
         else:
@@ -122,7 +123,7 @@ class Node:
             print("Requesting current config from remote node (this can take a while).")
 
         msgIndex = configType.index
-        if configType.containing_type.full_name == "LocalConfig":
+        if configType.containing_type.full_name in ("meshtastic.LocalConfig", "LocalConfig"):
             p = admin_pb2.AdminMessage()
             p.get_config_request = msgIndex
             self._sendAdmin(p, wantResponse=True, onResponse=onResponse)
@@ -194,6 +195,8 @@ class Node:
             p.set_module_config.detection_sensor.CopyFrom(self.moduleConfig.detection_sensor)
         elif config_name == "ambient_lighting":
             p.set_module_config.ambient_lighting.CopyFrom(self.moduleConfig.ambient_lighting)
+        elif config_name == "paxcounter":
+            p.set_module_config.paxcounter.CopyFrom(self.moduleConfig.paxcounter)
         else:
             our_exit(f"Error: No valid config with name {config_name}")
 
@@ -602,6 +605,23 @@ class Node:
             onResponse = self.onAckNak
         return self._sendAdmin(p, onResponse=onResponse)
 
+    def removeNode(self, nodeId: Union[int, str]):
+        """Tell the node to remove a specific node by ID"""
+        if isinstance(nodeId, str):
+            if nodeId.startswith("!"):
+                nodeId = int(nodeId[1:], 16)
+            else:
+                nodeId = int(nodeId)
+
+        p = admin_pb2.AdminMessage()
+        p.remove_by_nodenum = nodeId
+
+        if self == self.iface.localNode:
+            onResponse = None
+        else:
+            onResponse = self.onAckNak
+        return self._sendAdmin(p, onResponse=onResponse)
+
     def resetNodeDb(self):
         """Tell the node to reset its list of nodes."""
         p = admin_pb2.AdminMessage()
@@ -686,16 +706,7 @@ class Node:
         logging.debug(f"Received channel {stripnl(c)}")
         index = c.index
 
-        # for stress testing, we can always download all channels
-        fastChannelDownload = True
-
-        # Once we see a response that has NO settings, assume
-        # we are at the end of channels and stop fetching
-        quitEarly = (
-            c.role == channel_pb2.Channel.Role.DISABLED
-        ) and fastChannelDownload
-
-        if quitEarly or index >= 8 - 1:
+        if index >= 8 - 1:
             logging.debug("Finished downloading channels")
 
             self.channels = self.partialChannels
@@ -707,6 +718,7 @@ class Node:
             self._requestChannel(index + 1)
 
     def onAckNak(self, p):
+        """Informative handler for ACK/NAK responses"""
         if p["decoded"]["routing"]["errorReason"] != "NONE":
             print(
                 f'Received a NAK, error reason: {p["decoded"]["routing"]["errorReason"]}'
@@ -747,9 +759,9 @@ class Node:
     def _sendAdmin(
         self,
         p: admin_pb2.AdminMessage,
-        wantResponse=True,
+        wantResponse: bool=True,
         onResponse=None,
-        adminIndex=0,
+        adminIndex: int=0,
     ):
         """Send an admin message to the specified node (or the local node if destNodeNum is zero)"""
 

meshtastic/paxcount_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x19meshtastic/paxcount.proto\"5\n\x08Paxcount\x12\x0c\n\x04wifi\x18\x01 \x01(\r\x12\x0b\n\x03\x62le\x18\x02 \x01(\r\x12\x0e\n\x06uptime\x18\x03 \x01(\rBc\n\x13\x63om.geeksville.meshB\x0ePaxcountProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x19meshtastic/paxcount.proto\x12\nmeshtastic\"5\n\x08Paxcount\x12\x0c\n\x04wifi\x18\x01 \x01(\r\x12\x0b\n\x03\x62le\x18\x02 \x01(\r\x12\x0e\n\x06uptime\x18\x03 \x01(\rBc\n\x13\x63om.geeksville.meshB\x0ePaxcountProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.paxcount_pb2', globals())
@@ -21,6 +21,6 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\016PaxcountProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _PAXCOUNT._serialized_start=29
-  _PAXCOUNT._serialized_end=82
+  _PAXCOUNT._serialized_start=41
+  _PAXCOUNT._serialized_end=94
 # @@protoc_insertion_point(module_scope)

meshtastic/paxcount_pb2.pyi

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

meshtastic/portnums_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x19meshtastic/portnums.proto*\xe8\x03\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x17\n\x13REMOTE_HARDWARE_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x0f\n\x0bROUTING_APP\x10\x05\x12\r\n\tADMIN_APP\x10\x06\x12\x1f\n\x1bTEXT_MESSAGE_COMPRESSED_APP\x10\x07\x12\x10\n\x0cWAYPOINT_APP\x10\x08\x12\r\n\tAUDIO_APP\x10\t\x12\x18\n\x14\x44\x45TECTION_SENSOR_APP\x10\n\x12\r\n\tREPLY_APP\x10 \x12\x11\n\rIP_TUNNEL_APP\x10!\x12\x12\n\x0ePAXCOUNTER_APP\x10\"\x12\x0e\n\nSERIAL_APP\x10@\x12\x15\n\x11STORE_FORWARD_APP\x10\x41\x12\x12\n\x0eRANGE_TEST_APP\x10\x42\x12\x11\n\rTELEMETRY_APP\x10\x43\x12\x0b\n\x07ZPS_APP\x10\x44\x12\x11\n\rSIMULATOR_APP\x10\x45\x12\x12\n\x0eTRACEROUTE_APP\x10\x46\x12\x14\n\x10NEIGHBORINFO_APP\x10G\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x13\n\x0e\x41TAK_FORWARDER\x10\x81\x02\x12\x08\n\x03MAX\x10\xff\x03\x42]\n\x13\x63om.geeksville.meshB\x08PortnumsZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x19meshtastic/portnums.proto\x12\nmeshtastic*\x8d\x04\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x17\n\x13REMOTE_HARDWARE_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x0f\n\x0bROUTING_APP\x10\x05\x12\r\n\tADMIN_APP\x10\x06\x12\x1f\n\x1bTEXT_MESSAGE_COMPRESSED_APP\x10\x07\x12\x10\n\x0cWAYPOINT_APP\x10\x08\x12\r\n\tAUDIO_APP\x10\t\x12\x18\n\x14\x44\x45TECTION_SENSOR_APP\x10\n\x12\r\n\tREPLY_APP\x10 \x12\x11\n\rIP_TUNNEL_APP\x10!\x12\x12\n\x0ePAXCOUNTER_APP\x10\"\x12\x0e\n\nSERIAL_APP\x10@\x12\x15\n\x11STORE_FORWARD_APP\x10\x41\x12\x12\n\x0eRANGE_TEST_APP\x10\x42\x12\x11\n\rTELEMETRY_APP\x10\x43\x12\x0b\n\x07ZPS_APP\x10\x44\x12\x11\n\rSIMULATOR_APP\x10\x45\x12\x12\n\x0eTRACEROUTE_APP\x10\x46\x12\x14\n\x10NEIGHBORINFO_APP\x10G\x12\x0f\n\x0b\x41TAK_PLUGIN\x10H\x12\x12\n\x0eMAP_REPORT_APP\x10I\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x13\n\x0e\x41TAK_FORWARDER\x10\x81\x02\x12\x08\n\x03MAX\x10\xff\x03\x42]\n\x13\x63om.geeksville.meshB\x08PortnumsZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.portnums_pb2', globals())
@@ -21,6 +21,6 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\010PortnumsZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _PORTNUM._serialized_start=30
-  _PORTNUM._serialized_end=518
+  _PORTNUM._serialized_start=42
+  _PORTNUM._serialized_end=567
 # @@protoc_insertion_point(module_scope)

meshtastic/portnums_pb2.pyi

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

meshtastic/remote_hardware.py

@@ -2,7 +2,7 @@
 """
 import logging
 
-from pubsub import pub
+from pubsub import pub # type: ignore[import-untyped]
 
 from meshtastic import portnums_pb2, remote_hardware_pb2
 from meshtastic.util import our_exit

meshtastic/remote_hardware_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n meshtastic/remote_hardware.proto\"\xcb\x01\n\x0fHardwareMessage\x12#\n\x04type\x18\x01 \x01(\x0e\x32\x15.HardwareMessage.Type\x12\x11\n\tgpio_mask\x18\x02 \x01(\x04\x12\x12\n\ngpio_value\x18\x03 \x01(\x04\"l\n\x04Type\x12\t\n\x05UNSET\x10\x00\x12\x0f\n\x0bWRITE_GPIOS\x10\x01\x12\x0f\n\x0bWATCH_GPIOS\x10\x02\x12\x11\n\rGPIOS_CHANGED\x10\x03\x12\x0e\n\nREAD_GPIOS\x10\x04\x12\x14\n\x10READ_GPIOS_REPLY\x10\x05\x42\x63\n\x13\x63om.geeksville.meshB\x0eRemoteHardwareZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n meshtastic/remote_hardware.proto\x12\nmeshtastic\"\xd6\x01\n\x0fHardwareMessage\x12.\n\x04type\x18\x01 \x01(\x0e\x32 .meshtastic.HardwareMessage.Type\x12\x11\n\tgpio_mask\x18\x02 \x01(\x04\x12\x12\n\ngpio_value\x18\x03 \x01(\x04\"l\n\x04Type\x12\t\n\x05UNSET\x10\x00\x12\x0f\n\x0bWRITE_GPIOS\x10\x01\x12\x0f\n\x0bWATCH_GPIOS\x10\x02\x12\x11\n\rGPIOS_CHANGED\x10\x03\x12\x0e\n\nREAD_GPIOS\x10\x04\x12\x14\n\x10READ_GPIOS_REPLY\x10\x05\x42\x63\n\x13\x63om.geeksville.meshB\x0eRemoteHardwareZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.remote_hardware_pb2', globals())
@@ -21,8 +21,8 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\016RemoteHardwareZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _HARDWAREMESSAGE._serialized_start=37
-  _HARDWAREMESSAGE._serialized_end=240
-  _HARDWAREMESSAGE_TYPE._serialized_start=132
-  _HARDWAREMESSAGE_TYPE._serialized_end=240
+  _HARDWAREMESSAGE._serialized_start=49
+  _HARDWAREMESSAGE._serialized_end=263
+  _HARDWAREMESSAGE_TYPE._serialized_start=155
+  _HARDWAREMESSAGE_TYPE._serialized_end=263
 # @@protoc_insertion_point(module_scope)

meshtastic/remote_hardware_pb2.pyi

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

meshtastic/rtttl_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16meshtastic/rtttl.proto\"\x1f\n\x0bRTTTLConfig\x12\x10\n\x08ringtone\x18\x01 \x01(\tBf\n\x13\x63om.geeksville.meshB\x11RTTTLConfigProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16meshtastic/rtttl.proto\x12\nmeshtastic\"\x1f\n\x0bRTTTLConfig\x12\x10\n\x08ringtone\x18\x01 \x01(\tBf\n\x13\x63om.geeksville.meshB\x11RTTTLConfigProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.rtttl_pb2', globals())
@@ -21,6 +21,6 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\021RTTTLConfigProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _RTTTLCONFIG._serialized_start=26
-  _RTTTLCONFIG._serialized_end=57
+  _RTTTLCONFIG._serialized_start=38
+  _RTTTLCONFIG._serialized_end=69
 # @@protoc_insertion_point(module_scope)

meshtastic/rtttl_pb2.pyi

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

meshtastic/serial_interface.py

@@ -4,7 +4,7 @@ import logging
 import platform
 import time
 
-import serial
+import serial # type: ignore[import-untyped]
 
 import meshtastic.util
 from meshtastic.stream_interface import StreamInterface
@@ -32,7 +32,8 @@ class SerialInterface(StreamInterface):
             ports = meshtastic.util.findPorts(True)
             logging.debug(f"ports:{ports}")
             if len(ports) == 0:
-                meshtastic.util.our_exit("Warning: No Meshtastic devices detected.")
+                print("No Serial Meshtastic device detected, attempting TCP connection on localhost.")
+                return
             elif len(ports) > 1:
                 message = "Warning: Multiple serial ports were detected so one serial port must be specified with the '--port'.\n"
                 message += f"  Ports detected:{ports}"

meshtastic/storeforward_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1dmeshtastic/storeforward.proto\"\xbe\x06\n\x0fStoreAndForward\x12,\n\x02rr\x18\x01 \x01(\x0e\x32 .StoreAndForward.RequestResponse\x12,\n\x05stats\x18\x02 \x01(\x0b\x32\x1b.StoreAndForward.StatisticsH\x00\x12+\n\x07history\x18\x03 \x01(\x0b\x32\x18.StoreAndForward.HistoryH\x00\x12/\n\theartbeat\x18\x04 \x01(\x0b\x32\x1a.StoreAndForward.HeartbeatH\x00\x12\x0f\n\x05\x65mpty\x18\x05 \x01(\x08H\x00\x1a\xcd\x01\n\nStatistics\x12\x16\n\x0emessages_total\x18\x01 \x01(\r\x12\x16\n\x0emessages_saved\x18\x02 \x01(\r\x12\x14\n\x0cmessages_max\x18\x03 \x01(\r\x12\x0f\n\x07up_time\x18\x04 \x01(\r\x12\x10\n\x08requests\x18\x05 \x01(\r\x12\x18\n\x10requests_history\x18\x06 \x01(\r\x12\x11\n\theartbeat\x18\x07 \x01(\x08\x12\x12\n\nreturn_max\x18\x08 \x01(\r\x12\x15\n\rreturn_window\x18\t \x01(\r\x1aI\n\x07History\x12\x18\n\x10history_messages\x18\x01 \x01(\r\x12\x0e\n\x06window\x18\x02 \x01(\r\x12\x14\n\x0clast_request\x18\x03 \x01(\r\x1a.\n\tHeartbeat\x12\x0e\n\x06period\x18\x01 \x01(\r\x12\x11\n\tsecondary\x18\x02 \x01(\r\"\x89\x02\n\x0fRequestResponse\x12\t\n\x05UNSET\x10\x00\x12\x10\n\x0cROUTER_ERROR\x10\x01\x12\x14\n\x10ROUTER_HEARTBEAT\x10\x02\x12\x0f\n\x0bROUTER_PING\x10\x03\x12\x0f\n\x0bROUTER_PONG\x10\x04\x12\x0f\n\x0bROUTER_BUSY\x10\x05\x12\x12\n\x0eROUTER_HISTORY\x10\x06\x12\x10\n\x0cROUTER_STATS\x10\x07\x12\x10\n\x0c\x43LIENT_ERROR\x10@\x12\x12\n\x0e\x43LIENT_HISTORY\x10\x41\x12\x10\n\x0c\x43LIENT_STATS\x10\x42\x12\x0f\n\x0b\x43LIENT_PING\x10\x43\x12\x0f\n\x0b\x43LIENT_PONG\x10\x44\x12\x10\n\x0c\x43LIENT_ABORT\x10jB\t\n\x07variantBj\n\x13\x63om.geeksville.meshB\x15StoreAndForwardProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1dmeshtastic/storeforward.proto\x12\nmeshtastic\"\x9c\x07\n\x0fStoreAndForward\x12\x37\n\x02rr\x18\x01 \x01(\x0e\x32+.meshtastic.StoreAndForward.RequestResponse\x12\x37\n\x05stats\x18\x02 \x01(\x0b\x32&.meshtastic.StoreAndForward.StatisticsH\x00\x12\x36\n\x07history\x18\x03 \x01(\x0b\x32#.meshtastic.StoreAndForward.HistoryH\x00\x12:\n\theartbeat\x18\x04 \x01(\x0b\x32%.meshtastic.StoreAndForward.HeartbeatH\x00\x12\x0e\n\x04text\x18\x05 \x01(\x0cH\x00\x1a\xcd\x01\n\nStatistics\x12\x16\n\x0emessages_total\x18\x01 \x01(\r\x12\x16\n\x0emessages_saved\x18\x02 \x01(\r\x12\x14\n\x0cmessages_max\x18\x03 \x01(\r\x12\x0f\n\x07up_time\x18\x04 \x01(\r\x12\x10\n\x08requests\x18\x05 \x01(\r\x12\x18\n\x10requests_history\x18\x06 \x01(\r\x12\x11\n\theartbeat\x18\x07 \x01(\x08\x12\x12\n\nreturn_max\x18\x08 \x01(\r\x12\x15\n\rreturn_window\x18\t \x01(\r\x1aI\n\x07History\x12\x18\n\x10history_messages\x18\x01 \x01(\r\x12\x0e\n\x06window\x18\x02 \x01(\r\x12\x14\n\x0clast_request\x18\x03 \x01(\r\x1a.\n\tHeartbeat\x12\x0e\n\x06period\x18\x01 \x01(\r\x12\x11\n\tsecondary\x18\x02 \x01(\r\"\xbc\x02\n\x0fRequestResponse\x12\t\n\x05UNSET\x10\x00\x12\x10\n\x0cROUTER_ERROR\x10\x01\x12\x14\n\x10ROUTER_HEARTBEAT\x10\x02\x12\x0f\n\x0bROUTER_PING\x10\x03\x12\x0f\n\x0bROUTER_PONG\x10\x04\x12\x0f\n\x0bROUTER_BUSY\x10\x05\x12\x12\n\x0eROUTER_HISTORY\x10\x06\x12\x10\n\x0cROUTER_STATS\x10\x07\x12\x16\n\x12ROUTER_TEXT_DIRECT\x10\x08\x12\x19\n\x15ROUTER_TEXT_BROADCAST\x10\t\x12\x10\n\x0c\x43LIENT_ERROR\x10@\x12\x12\n\x0e\x43LIENT_HISTORY\x10\x41\x12\x10\n\x0c\x43LIENT_STATS\x10\x42\x12\x0f\n\x0b\x43LIENT_PING\x10\x43\x12\x0f\n\x0b\x43LIENT_PONG\x10\x44\x12\x10\n\x0c\x43LIENT_ABORT\x10jB\t\n\x07variantBj\n\x13\x63om.geeksville.meshB\x15StoreAndForwardProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.storeforward_pb2', globals())
@@ -21,14 +21,14 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\025StoreAndForwardProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _STOREANDFORWARD._serialized_start=34
-  _STOREANDFORWARD._serialized_end=864
-  _STOREANDFORWARD_STATISTICS._serialized_start=257
-  _STOREANDFORWARD_STATISTICS._serialized_end=462
-  _STOREANDFORWARD_HISTORY._serialized_start=464
-  _STOREANDFORWARD_HISTORY._serialized_end=537
-  _STOREANDFORWARD_HEARTBEAT._serialized_start=539
-  _STOREANDFORWARD_HEARTBEAT._serialized_end=585
-  _STOREANDFORWARD_REQUESTRESPONSE._serialized_start=588
-  _STOREANDFORWARD_REQUESTRESPONSE._serialized_end=853
+  _STOREANDFORWARD._serialized_start=46
+  _STOREANDFORWARD._serialized_end=970
+  _STOREANDFORWARD_STATISTICS._serialized_start=312
+  _STOREANDFORWARD_STATISTICS._serialized_end=517
+  _STOREANDFORWARD_HISTORY._serialized_start=519
+  _STOREANDFORWARD_HISTORY._serialized_end=592
+  _STOREANDFORWARD_HEARTBEAT._serialized_start=594
+  _STOREANDFORWARD_HEARTBEAT._serialized_end=640
+  _STOREANDFORWARD_REQUESTRESPONSE._serialized_start=643
+  _STOREANDFORWARD_REQUESTRESPONSE._serialized_end=959
 # @@protoc_insertion_point(module_scope)

meshtastic/storeforward_pb2.pyi

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

meshtastic/stream_interface.py

@@ -5,7 +5,7 @@ import threading
 import time
 import traceback
 
-import serial
+import serial # type: ignore[import-untyped]
 
 from meshtastic.mesh_interface import MeshInterface
 from meshtastic.util import is_windows11, stripnl
@@ -32,7 +32,7 @@ class StreamInterface(MeshInterface):
         """
 
         if not hasattr(self, "stream") and not noProto:
-            raise Exception(
+            raise Exception( # pylint: disable=W0719
                 "StreamInterface is now abstract (to update existing code create SerialInterface instead)"
             )
         self._rxBuf = bytes()  # empty

meshtastic/tcp_interface.py

@@ -2,7 +2,7 @@
 """
 import logging
 import socket
-from typing import AnyStr
+from typing import Optional
 
 from meshtastic.stream_interface import StreamInterface
 
@@ -12,7 +12,7 @@ class TCPInterface(StreamInterface):
 
     def __init__(
         self,
-        hostname: AnyStr,
+        hostname: str,
         debugOut=None,
         noProto=False,
         connectNow=True,
@@ -30,10 +30,10 @@ class TCPInterface(StreamInterface):
         self.portNumber = portNumber
 
         if connectNow:
-            logging.debug(f"Connecting to {hostname}")
+            logging.debug(f"Connecting to {hostname}") # type: ignore[str-bytes-safe]
             server_address = (hostname, portNumber)
             sock = socket.create_connection(server_address)
-            self.socket = sock
+            self.socket: Optional[socket.socket] = sock
         else:
             self.socket = None
 

meshtastic/telemetry_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1ameshtastic/telemetry.proto\"i\n\rDeviceMetrics\x12\x15\n\rbattery_level\x18\x01 \x01(\r\x12\x0f\n\x07voltage\x18\x02 \x01(\x02\x12\x1b\n\x13\x63hannel_utilization\x18\x03 \x01(\x02\x12\x13\n\x0b\x61ir_util_tx\x18\x04 \x01(\x02\"\x9b\x01\n\x12\x45nvironmentMetrics\x12\x13\n\x0btemperature\x18\x01 \x01(\x02\x12\x19\n\x11relative_humidity\x18\x02 \x01(\x02\x12\x1b\n\x13\x62\x61rometric_pressure\x18\x03 \x01(\x02\x12\x16\n\x0egas_resistance\x18\x04 \x01(\x02\x12\x0f\n\x07voltage\x18\x05 \x01(\x02\x12\x0f\n\x07\x63urrent\x18\x06 \x01(\x02\"\x8c\x01\n\x0cPowerMetrics\x12\x13\n\x0b\x63h1_voltage\x18\x01 \x01(\x02\x12\x13\n\x0b\x63h1_current\x18\x02 \x01(\x02\x12\x13\n\x0b\x63h2_voltage\x18\x03 \x01(\x02\x12\x13\n\x0b\x63h2_current\x18\x04 \x01(\x02\x12\x13\n\x0b\x63h3_voltage\x18\x05 \x01(\x02\x12\x13\n\x0b\x63h3_current\x18\x06 \x01(\x02\"\xbf\x02\n\x11\x41irQualityMetrics\x12\x15\n\rpm10_standard\x18\x01 \x01(\r\x12\x15\n\rpm25_standard\x18\x02 \x01(\r\x12\x16\n\x0epm100_standard\x18\x03 \x01(\r\x12\x1a\n\x12pm10_environmental\x18\x04 \x01(\r\x12\x1a\n\x12pm25_environmental\x18\x05 \x01(\r\x12\x1b\n\x13pm100_environmental\x18\x06 \x01(\r\x12\x16\n\x0eparticles_03um\x18\x07 \x01(\r\x12\x16\n\x0eparticles_05um\x18\x08 \x01(\r\x12\x16\n\x0eparticles_10um\x18\t \x01(\r\x12\x16\n\x0eparticles_25um\x18\n \x01(\r\x12\x16\n\x0eparticles_50um\x18\x0b \x01(\r\x12\x17\n\x0fparticles_100um\x18\x0c \x01(\r\"\xdd\x01\n\tTelemetry\x12\x0c\n\x04time\x18\x01 \x01(\x07\x12(\n\x0e\x64\x65vice_metrics\x18\x02 \x01(\x0b\x32\x0e.DeviceMetricsH\x00\x12\x32\n\x13\x65nvironment_metrics\x18\x03 \x01(\x0b\x32\x13.EnvironmentMetricsH\x00\x12\x31\n\x13\x61ir_quality_metrics\x18\x04 \x01(\x0b\x32\x12.AirQualityMetricsH\x00\x12&\n\rpower_metrics\x18\x05 \x01(\x0b\x32\r.PowerMetricsH\x00\x42\t\n\x07variant*\xd4\x01\n\x13TelemetrySensorType\x12\x10\n\x0cSENSOR_UNSET\x10\x00\x12\n\n\x06\x42ME280\x10\x01\x12\n\n\x06\x42ME680\x10\x02\x12\x0b\n\x07MCP9808\x10\x03\x12\n\n\x06INA260\x10\x04\x12\n\n\x06INA219\x10\x05\x12\n\n\x06\x42MP280\x10\x06\x12\t\n\x05SHTC3\x10\x07\x12\t\n\x05LPS22\x10\x08\x12\x0b\n\x07QMC6310\x10\t\x12\x0b\n\x07QMI8658\x10\n\x12\x0c\n\x08QMC5883L\x10\x0b\x12\t\n\x05SHT31\x10\x0c\x12\x0c\n\x08PMSA003I\x10\r\x12\x0b\n\x07INA3221\x10\x0e\x42\x64\n\x13\x63om.geeksville.meshB\x0fTelemetryProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1ameshtastic/telemetry.proto\x12\nmeshtastic\"\x81\x01\n\rDeviceMetrics\x12\x15\n\rbattery_level\x18\x01 \x01(\r\x12\x0f\n\x07voltage\x18\x02 \x01(\x02\x12\x1b\n\x13\x63hannel_utilization\x18\x03 \x01(\x02\x12\x13\n\x0b\x61ir_util_tx\x18\x04 \x01(\x02\x12\x16\n\x0euptime_seconds\x18\x05 \x01(\r\"\xa8\x01\n\x12\x45nvironmentMetrics\x12\x13\n\x0btemperature\x18\x01 \x01(\x02\x12\x19\n\x11relative_humidity\x18\x02 \x01(\x02\x12\x1b\n\x13\x62\x61rometric_pressure\x18\x03 \x01(\x02\x12\x16\n\x0egas_resistance\x18\x04 \x01(\x02\x12\x0f\n\x07voltage\x18\x05 \x01(\x02\x12\x0f\n\x07\x63urrent\x18\x06 \x01(\x02\x12\x0b\n\x03iaq\x18\x07 \x01(\r\"\x8c\x01\n\x0cPowerMetrics\x12\x13\n\x0b\x63h1_voltage\x18\x01 \x01(\x02\x12\x13\n\x0b\x63h1_current\x18\x02 \x01(\x02\x12\x13\n\x0b\x63h2_voltage\x18\x03 \x01(\x02\x12\x13\n\x0b\x63h2_current\x18\x04 \x01(\x02\x12\x13\n\x0b\x63h3_voltage\x18\x05 \x01(\x02\x12\x13\n\x0b\x63h3_current\x18\x06 \x01(\x02\"\xbf\x02\n\x11\x41irQualityMetrics\x12\x15\n\rpm10_standard\x18\x01 \x01(\r\x12\x15\n\rpm25_standard\x18\x02 \x01(\r\x12\x16\n\x0epm100_standard\x18\x03 \x01(\r\x12\x1a\n\x12pm10_environmental\x18\x04 \x01(\r\x12\x1a\n\x12pm25_environmental\x18\x05 \x01(\r\x12\x1b\n\x13pm100_environmental\x18\x06 \x01(\r\x12\x16\n\x0eparticles_03um\x18\x07 \x01(\r\x12\x16\n\x0eparticles_05um\x18\x08 \x01(\r\x12\x16\n\x0eparticles_10um\x18\t \x01(\r\x12\x16\n\x0eparticles_25um\x18\n \x01(\r\x12\x16\n\x0eparticles_50um\x18\x0b \x01(\r\x12\x17\n\x0fparticles_100um\x18\x0c \x01(\r\"\x89\x02\n\tTelemetry\x12\x0c\n\x04time\x18\x01 \x01(\x07\x12\x33\n\x0e\x64\x65vice_metrics\x18\x02 \x01(\x0b\x32\x19.meshtastic.DeviceMetricsH\x00\x12=\n\x13\x65nvironment_metrics\x18\x03 \x01(\x0b\x32\x1e.meshtastic.EnvironmentMetricsH\x00\x12<\n\x13\x61ir_quality_metrics\x18\x04 \x01(\x0b\x32\x1d.meshtastic.AirQualityMetricsH\x00\x12\x31\n\rpower_metrics\x18\x05 \x01(\x0b\x32\x18.meshtastic.PowerMetricsH\x00\x42\t\n\x07variant*\xe0\x01\n\x13TelemetrySensorType\x12\x10\n\x0cSENSOR_UNSET\x10\x00\x12\n\n\x06\x42ME280\x10\x01\x12\n\n\x06\x42ME680\x10\x02\x12\x0b\n\x07MCP9808\x10\x03\x12\n\n\x06INA260\x10\x04\x12\n\n\x06INA219\x10\x05\x12\n\n\x06\x42MP280\x10\x06\x12\t\n\x05SHTC3\x10\x07\x12\t\n\x05LPS22\x10\x08\x12\x0b\n\x07QMC6310\x10\t\x12\x0b\n\x07QMI8658\x10\n\x12\x0c\n\x08QMC5883L\x10\x0b\x12\t\n\x05SHT31\x10\x0c\x12\x0c\n\x08PMSA003I\x10\r\x12\x0b\n\x07INA3221\x10\x0e\x12\n\n\x06\x42MP085\x10\x0f\x42\x64\n\x13\x63om.geeksville.meshB\x0fTelemetryProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.telemetry_pb2', globals())
@@ -21,16 +21,16 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\017TelemetryProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _TELEMETRYSENSORTYPE._serialized_start=985
-  _TELEMETRYSENSORTYPE._serialized_end=1197
-  _DEVICEMETRICS._serialized_start=30
-  _DEVICEMETRICS._serialized_end=135
-  _ENVIRONMENTMETRICS._serialized_start=138
-  _ENVIRONMENTMETRICS._serialized_end=293
-  _POWERMETRICS._serialized_start=296
-  _POWERMETRICS._serialized_end=436
-  _AIRQUALITYMETRICS._serialized_start=439
-  _AIRQUALITYMETRICS._serialized_end=758
-  _TELEMETRY._serialized_start=761
-  _TELEMETRY._serialized_end=982
+  _TELEMETRYSENSORTYPE._serialized_start=1079
+  _TELEMETRYSENSORTYPE._serialized_end=1303
+  _DEVICEMETRICS._serialized_start=43
+  _DEVICEMETRICS._serialized_end=172
+  _ENVIRONMENTMETRICS._serialized_start=175
+  _ENVIRONMENTMETRICS._serialized_end=343
+  _POWERMETRICS._serialized_start=346
+  _POWERMETRICS._serialized_end=486
+  _AIRQUALITYMETRICS._serialized_start=489
+  _AIRQUALITYMETRICS._serialized_end=808
+  _TELEMETRY._serialized_start=811
+  _TELEMETRY._serialized_end=1076
 # @@protoc_insertion_point(module_scope)

meshtastic/telemetry_pb2.pyi

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

meshtastic/test.py

@@ -6,11 +6,11 @@ import sys
 import time
 import traceback
 
-from dotmap import DotMap
-from pubsub import pub
+from dotmap import DotMap # type: ignore[import-untyped]
+from pubsub import pub # type: ignore[import-untyped]
 
 import meshtastic.util
-from meshtastic.__init__ import BROADCAST_NUM
+from meshtastic import BROADCAST_NUM
 from meshtastic.serial_interface import SerialInterface
 from meshtastic.tcp_interface import TCPInterface
 

meshtastic/tests/conftest.py

@@ -14,7 +14,7 @@ from ..mesh_interface import MeshInterface
 def reset_globals():
     """Fixture to reset globals."""
     parser = None
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(add_help=False)
     Globals.getInstance().reset()
     Globals.getInstance().set_parser(parser)
 

meshtastic/tests/test_init.py

@@ -6,7 +6,7 @@ from unittest.mock import MagicMock
 
 import pytest
 
-from meshtastic.__init__ import _onNodeInfoReceive, _onPositionReceive, _onTextReceive
+from meshtastic import _onNodeInfoReceive, _onPositionReceive, _onTextReceive
 
 from ..globals import Globals
 from ..serial_interface import SerialInterface

meshtastic/tests/test_mesh_interface.py

@@ -6,8 +6,7 @@ from unittest.mock import MagicMock, patch
 
 import pytest
 
-from .. import mesh_pb2
-from ..__init__ import BROADCAST_ADDR, LOCAL_ADDR
+from .. import mesh_pb2, BROADCAST_ADDR, LOCAL_ADDR
 from ..mesh_interface import MeshInterface
 from ..node import Node
 
@@ -21,7 +20,6 @@ from ..util import Timeout
 def test_MeshInterface(capsys):
     """Test that we can instantiate a MeshInterface"""
     iface = MeshInterface(noProto=True)
-    anode = Node("foo", "bar")
 
     nodes = {
         "!9388f81c": {
@@ -38,7 +36,7 @@ def test_MeshInterface(capsys):
         }
     }
 
-    iface.nodesByNum = {1: anode}
+    iface.nodesByNum = {2475227164: nodes["!9388f81c"]}
     iface.nodes = nodes
 
     myInfo = MagicMock()
@@ -148,7 +146,7 @@ def test_getNode_not_local(caplog):
         with patch("meshtastic.node.Node", return_value=anode):
             another_node = iface.getNode("bar2")
             assert another_node != iface.localNode
-    assert re.search(r"About to requestConfig", caplog.text, re.MULTILINE)
+    assert re.search(r"About to requestChannels", caplog.text, re.MULTILINE)
 
 
 @pytest.mark.unit
@@ -164,7 +162,7 @@ def test_getNode_not_local_timeout(capsys):
         assert pytest_wrapped_e.type == SystemExit
         assert pytest_wrapped_e.value.code == 1
         out, err = capsys.readouterr()
-        assert re.match(r"Error: Timed out waiting for node config", out)
+        assert re.match(r"Error: Timed out waiting for channels", out)
         assert err == ""
 
 
@@ -230,8 +228,8 @@ def test_handleFromRadio_with_my_info(caplog):
     with caplog.at_level(logging.DEBUG):
         iface._handleFromRadio(from_radio_bytes)
     iface.close()
-    assert re.search(r"Received myinfo", caplog.text, re.MULTILINE)
-    assert re.search(r"max_channels: 8", caplog.text, re.MULTILINE)
+    assert re.search(r"Received from radio: my_info {", caplog.text, re.MULTILINE)
+    assert re.search(r"my_node_num: 682584012", caplog.text, re.MULTILINE)
 
 
 @pytest.mark.unit
@@ -258,15 +256,14 @@ def test_handleFromRadio_with_node_info(caplog, capsys):
     with caplog.at_level(logging.DEBUG):
         iface._startConfig()
         iface._handleFromRadio(from_radio_bytes)
-        assert re.search(r"Received nodeinfo", caplog.text, re.MULTILINE)
+        assert re.search(r"Received from radio: node_info {", caplog.text, re.MULTILINE)
         assert re.search(r"682584012", caplog.text, re.MULTILINE)
-        assert re.search(r"HELTEC_V2_1", caplog.text, re.MULTILINE)
         # validate some of showNodes() output
         iface.showNodes()
         out, err = capsys.readouterr()
         assert re.search(r" 1 ", out, re.MULTILINE)
         assert re.search(r"│ Unknown 67cc │ ", out, re.MULTILINE)
-        assert re.search(r"│ !28af67cc │ N/A   │ N/A         │ N/A", out, re.MULTILINE)
+        assert re.search(r"│\s+!28af67cc\s+│\s+67cc\s+|", out, re.MULTILINE)
         assert err == ""
         iface.close()
 
@@ -347,10 +344,10 @@ def test_sendData_too_long(caplog):
     some_large_text += b"This is a long text that will be too long for send text."
     some_large_text += b"This is a long text that will be too long for send text."
     with caplog.at_level(logging.DEBUG):
-        with pytest.raises(Exception) as pytest_wrapped_e:
+        with pytest.raises(MeshInterface.MeshInterfaceError) as pytest_wrapped_e:
             iface.sendData(some_large_text)
             assert re.search("Data payload too big", caplog.text, re.MULTILINE)
-        assert pytest_wrapped_e.type == Exception
+        assert pytest_wrapped_e.type == MeshInterface.MeshInterfaceError
     iface.close()
 
 
@@ -506,14 +503,14 @@ def test_generatePacketId(capsys):
     # not sure when this condition would ever happen... but we can simulate it
     iface.currentPacketId = None
     assert iface.currentPacketId is None
-    with pytest.raises(Exception) as pytest_wrapped_e:
+    with pytest.raises(MeshInterface.MeshInterfaceError) as pytest_wrapped_e:
         iface._generatePacketId()
         out, err = capsys.readouterr()
         assert re.search(
             r"Not connected yet, can not generate packet", out, re.MULTILINE
         )
         assert err == ""
-    assert pytest_wrapped_e.type == Exception
+    assert pytest_wrapped_e.type == MeshInterface.MeshInterfaceError
 
 
 @pytest.mark.unit
@@ -597,9 +594,9 @@ def test_getOrCreateByNum_not_found(iface_with_nodes):
     """Test _getOrCreateByNum()"""
     iface = iface_with_nodes
     iface.myInfo.my_node_num = 2475227164
-    with pytest.raises(Exception) as pytest_wrapped_e:
+    with pytest.raises(MeshInterface.MeshInterfaceError) as pytest_wrapped_e:
         iface._getOrCreateByNum(0xFFFFFFFF)
-    assert pytest_wrapped_e.type == Exception
+    assert pytest_wrapped_e.type == MeshInterface.MeshInterfaceError
 
 
 @pytest.mark.unit
@@ -651,9 +648,9 @@ def test_waitForConfig(capsys):
     iface = MeshInterface(noProto=True)
     # override how long to wait
     iface._timeout = Timeout(0.01)
-    with pytest.raises(Exception) as pytest_wrapped_e:
+    with pytest.raises(MeshInterface.MeshInterfaceError) as pytest_wrapped_e:
         iface.waitForConfig()
-        assert pytest_wrapped_e.type == Exception
+        assert pytest_wrapped_e.type == MeshInterface.MeshInterfaceError
         out, err = capsys.readouterr()
         assert re.search(
             r"Exception: Timed out waiting for interface config", err, re.MULTILINE
@@ -665,10 +662,10 @@ def test_waitForConfig(capsys):
 def test_waitConnected_raises_an_exception(capsys):
     """Test waitConnected()"""
     iface = MeshInterface(noProto=True)
-    with pytest.raises(Exception) as pytest_wrapped_e:
-        iface.failure = "warn about something"
+    with pytest.raises(MeshInterface.MeshInterfaceError) as pytest_wrapped_e:
+        iface.failure = MeshInterface.MeshInterfaceError("warn about something")
         iface._waitConnected(0.01)
-        assert pytest_wrapped_e.type == Exception
+        assert pytest_wrapped_e.type == MeshInterface.MeshInterfaceError
         out, err = capsys.readouterr()
         assert re.search(r"warn about something", err, re.MULTILINE)
         assert out == ""
@@ -677,10 +674,10 @@ def test_waitConnected_raises_an_exception(capsys):
 @pytest.mark.unit
 def test_waitConnected_isConnected_timeout(capsys):
     """Test waitConnected()"""
-    with pytest.raises(Exception) as pytest_wrapped_e:
+    with pytest.raises(MeshInterface.MeshInterfaceError) as pytest_wrapped_e:
         iface = MeshInterface()
         iface._waitConnected(0.01)
-        assert pytest_wrapped_e.type == Exception
+        assert pytest_wrapped_e.type == MeshInterface.MeshInterfaceError
         out, err = capsys.readouterr()
         assert re.search(r"warn about something", err, re.MULTILINE)
         assert out == ""

meshtastic/tests/test_node.py

@@ -7,9 +7,10 @@ from unittest.mock import MagicMock, patch
 import pytest
 
 # from ..admin_pb2 import AdminMessage
-from ..channel_pb2 import Channel
+from ..channel_pb2 import Channel # pylint: disable=E0611
 from ..node import Node
 from ..serial_interface import SerialInterface
+from ..mesh_interface import MeshInterface
 
 # from ..config_pb2 import Config
 # from ..cannedmessages_pb2 import (CannedMessagePluginMessagePart1, CannedMessagePluginMessagePart2,
@@ -234,7 +235,7 @@ def test_exitSimulator(caplog):
 @pytest.mark.unit
 def test_reboot(caplog):
     """Test reboot"""
-    anode = Node("foo", "bar", noProto=True)
+    anode = Node(MeshInterface(), 1234567890, noProto=True)
     with caplog.at_level(logging.DEBUG):
         anode.reboot()
     assert re.search(r"Telling node to reboot", caplog.text, re.MULTILINE)
@@ -243,7 +244,7 @@ def test_reboot(caplog):
 @pytest.mark.unit
 def test_shutdown(caplog):
     """Test shutdown"""
-    anode = Node("foo", "bar", noProto=True)
+    anode = Node(MeshInterface(), 1234567890, noProto=True)
     with caplog.at_level(logging.DEBUG):
         anode.shutdown()
     assert re.search(r"Telling node to shutdown", caplog.text, re.MULTILINE)
@@ -258,7 +259,7 @@ def test_setURL_empty_url(capsys):
     assert pytest_wrapped_e.type == SystemExit
     assert pytest_wrapped_e.value.code == 1
     out, err = capsys.readouterr()
-    assert re.search(r"Warning: No RadioConfig has been read", out, re.MULTILINE)
+    assert re.search(r"Warning: There were no settings.", out, re.MULTILINE)
     assert err == ""
 
 
@@ -777,7 +778,8 @@ def test_writeConfig_with_no_radioConfig(capsys):
     assert pytest_wrapped_e.type == SystemExit
     assert pytest_wrapped_e.value.code == 1
     out, err = capsys.readouterr()
-    assert re.search(r"Error: No RadioConfig has been read", out)
+    print(out)
+    assert re.search(r"Error: No valid config with name foo", out)
     assert err == ""
 
 

meshtastic/tests/test_serial_interface.py

@@ -41,13 +41,11 @@ def test_SerialInterface_single_port(
 @patch("meshtastic.util.findPorts", return_value=[])
 def test_SerialInterface_no_ports(mocked_findPorts, capsys):
     """Test that we can instantiate a SerialInterface with no ports"""
-    with pytest.raises(SystemExit) as pytest_wrapped_e:
-        SerialInterface(noProto=True)
+    serialInterface = SerialInterface(noProto=True)
     mocked_findPorts.assert_called()
-    assert pytest_wrapped_e.type == SystemExit
-    assert pytest_wrapped_e.value.code == 1
+    assert serialInterface.devPath is None
     out, err = capsys.readouterr()
-    assert re.search(r"Warning: No Meshtastic devices detected", out, re.MULTILINE)
+    assert re.search(r"No.*Meshtastic.*device.*detected", out, re.MULTILINE)
     assert err == ""
 
 

meshtastic/tests/test_smoke1.py

@@ -40,15 +40,6 @@ def test_smoke1_info():
     assert return_value == 0
 
 
-@pytest.mark.smoke1
-def test_smoke1_sendping():
-    """Test --sendping"""
-    return_value, out = subprocess.getstatusoutput("meshtastic --sendping")
-    assert re.match(r"Connected to radio", out)
-    assert re.search(r"^Sending ping message", out, re.MULTILINE)
-    assert return_value == 0
-
-
 @pytest.mark.smoke1
 def test_get_with_invalid_setting():
     """Test '--get a_bad_setting'."""

meshtastic/tests/test_smokevirt.py

@@ -50,17 +50,6 @@ def test_smokevirt_info():
     assert return_value == 0
 
 
-@pytest.mark.smokevirt
-def test_smokevirt_sendping():
-    """Test --sendping"""
-    return_value, out = subprocess.getstatusoutput(
-        "meshtastic --host localhost --sendping"
-    )
-    assert re.match(r"Connected to radio", out)
-    assert re.search(r"^Sending ping message", out, re.MULTILINE)
-    assert return_value == 0
-
-
 @pytest.mark.smokevirt
 def test_get_with_invalid_setting():
     """Test '--get a_bad_setting'."""

meshtastic/tests/test_tunnel.py

@@ -20,10 +20,10 @@ def test_Tunnel_on_non_linux_system(mock_platform_system):
     a_mock.return_value = "notLinux"
     mock_platform_system.side_effect = a_mock
     with patch("socket.socket") as mock_socket:
-        with pytest.raises(Exception) as pytest_wrapped_e:
+        with pytest.raises(Tunnel.TunnelError) as pytest_wrapped_e:
             iface = TCPInterface(hostname="localhost", noProto=True)
             Tunnel(iface)
-        assert pytest_wrapped_e.type == Exception
+        assert pytest_wrapped_e.type == Tunnel.TunnelError
         assert mock_socket.called
 
 
@@ -34,9 +34,9 @@ def test_Tunnel_without_interface(mock_platform_system):
     a_mock = MagicMock()
     a_mock.return_value = "Linux"
     mock_platform_system.side_effect = a_mock
-    with pytest.raises(Exception) as pytest_wrapped_e:
+    with pytest.raises(Tunnel.TunnelError) as pytest_wrapped_e:
         Tunnel(None)
-    assert pytest_wrapped_e.type == Exception
+    assert pytest_wrapped_e.type == Tunnel.TunnelError
 
 
 @pytest.mark.unitslow

meshtastic/tests/test_util.py

@@ -1,5 +1,6 @@
 """Meshtastic unit tests for util.py"""
 
+import json
 import logging
 import re
 from unittest.mock import patch
@@ -7,6 +8,7 @@ from unittest.mock import patch
 import pytest
 
 from meshtastic.supported_device import SupportedDevice
+from meshtastic.mesh_pb2 import MyNodeInfo
 from meshtastic.util import (
     Timeout,
     active_ports_on_supported_devices,
@@ -30,6 +32,7 @@ from meshtastic.util import (
     snake_to_camel,
     stripnl,
     support_info,
+    message_to_json,
 )
 
 
@@ -177,7 +180,7 @@ def test_catchAndIgnore(caplog):
     """Test catchAndIgnore() does not actually throw an exception, but just logs"""
 
     def some_closure():
-        raise Exception("foo")
+        raise Exception("foo") # pylint: disable=W0719
 
     with caplog.at_level(logging.DEBUG):
         catchAndIgnore("something", some_closure)
@@ -545,3 +548,10 @@ def test_active_ports_on_supported_devices_mac_duplicates_check(mock_platform, m
     }
     mock_platform.assert_called()
     mock_sp.assert_called()
+
+@pytest.mark.unit
+def test_message_to_json_shows_all():
+    """Test that message_to_json prints fields that aren't included in data passed in"""
+    actual = json.loads(message_to_json(MyNodeInfo()))
+    expected = { "myNodeNum": 0, "rebootCount": 0, "minAppVersion": 0 }
+    assert actual == expected

meshtastic/tunnel.py

@@ -19,7 +19,7 @@ import logging
 import platform
 import threading
 
-from pubsub import pub
+from pubsub import pub # type: ignore[import-untyped]
 from pytap2 import TapDevice
 
 from meshtastic import portnums_pb2
@@ -38,6 +38,12 @@ def onTunnelReceive(packet, interface):  # pylint: disable=W0613
 class Tunnel:
     """A TUN based IP tunnel over meshtastic"""
 
+    class TunnelError(Exception):
+        """An exception class for general tunnel errors"""
+        def __init__(self, message):
+            self.message = message
+            super().__init__(self.message)
+
     def __init__(self, iface, subnet="10.115", netmask="255.255.0.0"):
         """
         Constructor
@@ -47,19 +53,19 @@ class Tunnel:
         """
 
         if not iface:
-            raise Exception("Tunnel() must have a interface")
+            raise Tunnel.TunnelError("Tunnel() must have a interface")
 
         if not subnet:
-            raise Exception("Tunnel() must have a subnet")
+            raise Tunnel.TunnelError("Tunnel() must have a subnet")
 
         if not netmask:
-            raise Exception("Tunnel() must have a netmask")
+            raise Tunnel.TunnelError("Tunnel() must have a netmask")
 
         self.iface = iface
         self.subnetPrefix = subnet
 
         if platform.system() != "Linux":
-            raise Exception("Tunnel() can only be run instantiated on a Linux system")
+            raise Tunnel.TunnelError("Tunnel() can only be run instantiated on a Linux system")
 
         our_globals = Globals.getInstance()
         our_globals.set_tunnelInstance(self)

meshtastic/util.py

@@ -11,18 +11,21 @@ import threading
 import time
 import traceback
 from queue import Queue
+from typing import Union
 
-import pkg_resources
+from google.protobuf.json_format import MessageToJson
+
+import packaging.version as pkg_version
 import requests
-import serial
-import serial.tools.list_ports
+import serial # type: ignore[import-untyped]
+import serial.tools.list_ports # type: ignore[import-untyped]
 
 from meshtastic.supported_device import supported_devices
+from meshtastic.version import get_active_version
 
 """Some devices such as a seger jlink we never want to accidentally open"""
 blacklistVids = dict.fromkeys([0x1366])
 
-
 def quoteBooleans(a_string):
     """Quote booleans
     given a string that contains ": true", replace with ": 'true'" (or false)
@@ -108,7 +111,7 @@ def stripnl(s):
 
 def fixme(message):
     """Raise an exception for things that needs to be fixed"""
-    raise Exception(f"FIXME: {message}")
+    raise Exception(f"FIXME: {message}") # pylint: disable=W0719
 
 
 def catchAndIgnore(reason, closure):
@@ -145,23 +148,23 @@ class dotdict(dict):
     """dot.notation access to dictionary attributes"""
 
     __getattr__ = dict.get
-    __setattr__ = dict.__setitem__
-    __delattr__ = dict.__delitem__
+    __setattr__ = dict.__setitem__ # type: ignore[assignment]
+    __delattr__ = dict.__delitem__ # type: ignore[assignment]
 
 
 class Timeout:
     """Timeout class"""
 
-    def __init__(self, maxSecs=20):
-        self.expireTime = 0
-        self.sleepInterval = 0.1
-        self.expireTimeout = maxSecs
+    def __init__(self, maxSecs: int=20):
+        self.expireTime: Union[int, float] = 0
+        self.sleepInterval: float = 0.1
+        self.expireTimeout: int = maxSecs
 
     def reset(self):
         """Restart the waitForSet timer"""
         self.expireTime = time.time() + self.expireTimeout
 
-    def waitForSet(self, target, attrs=()):
+    def waitForSet(self, target, attrs=()) -> bool:
         """Block until the specified attributes are set. Returns True if config has been received."""
         self.reset()
         while time.time() < self.expireTime:
@@ -172,7 +175,7 @@ class Timeout:
 
     def waitForAckNak(
         self, acknowledgment, attrs=("receivedAck", "receivedNak", "receivedImplAck")
-    ):
+    ) -> bool:
         """Block until an ACK or NAK has been received. Returns True if ACK or NAK has been received."""
         self.reset()
         while time.time() < self.expireTime:
@@ -182,7 +185,7 @@ class Timeout:
             time.sleep(self.sleepInterval)
         return False
 
-    def waitForTraceRoute(self, waitFactor, acknowledgment, attr="receivedTraceRoute"):
+    def waitForTraceRoute(self, waitFactor, acknowledgment, attr="receivedTraceRoute") -> bool:
         """Block until traceroute response is received. Returns True if traceroute response has been received."""
         self.expireTimeout *= waitFactor
         self.reset()
@@ -192,8 +195,8 @@ class Timeout:
                 return True
             time.sleep(self.sleepInterval)
         return False
-    
-    def waitForTelemetry(self, acknowledgment):
+
+    def waitForTelemetry(self, acknowledgment) -> bool:
         """Block until telemetry response is received. Returns True if telemetry response has been received."""
         self.reset()
         while time.time() < self.expireTime:
@@ -269,7 +272,7 @@ def support_info():
     print(f"   Machine: {platform.uname().machine}")
     print(f"   Encoding (stdin): {sys.stdin.encoding}")
     print(f"   Encoding (stdout): {sys.stdout.encoding}")
-    the_version = pkg_resources.get_distribution("meshtastic").version
+    the_version = get_active_version()
     pypi_version = check_if_newer_version()
     if pypi_version:
         print(
@@ -599,9 +602,19 @@ def check_if_newer_version():
         pypi_version = data["info"]["version"]
     except Exception:
         pass
-    act_version = pkg_resources.get_distribution("meshtastic").version
-    if pypi_version and pkg_resources.parse_version(
-        pypi_version
-    ) <= pkg_resources.parse_version(act_version):
+    act_version = get_active_version()
+
+    try:
+        parsed_act_version = pkg_version.parse(act_version)
+        parsed_pypi_version = pkg_version.parse(pypi_version)
+    except pkg_version.InvalidVersion:
+        return pypi_version
+
+    if parsed_pypi_version <= parsed_act_version:
         return None
+
     return pypi_version
+
+def message_to_json(message):
+    "Return protobuf message as JSON. Always print all fields, even when not present in data."
+    return stripnl(MessageToJson(message, always_print_fields_with_no_presence=True))

meshtastic/version.py

@@ -0,0 +1,13 @@
+"""Version lookup utilities, isolated for cleanliness"""
+import sys
+try:
+    from importlib.metadata import version
+except:
+    import pkg_resources
+
+def get_active_version():
+    """Get the currently active version using importlib, or pkg_resources if we must"""
+    if "importlib.metadata" in sys.modules:
+        return version("meshtastic")
+    else:
+        return pkg_resources.get_distribution("meshtastic").version # pylint: disable=E0601

meshtastic/xmodem_pb2.py

@@ -13,7 +13,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x17meshtastic/xmodem.proto\"\xab\x01\n\x06XModem\x12 \n\x07\x63ontrol\x18\x01 \x01(\x0e\x32\x0f.XModem.Control\x12\x0b\n\x03seq\x18\x02 \x01(\r\x12\r\n\x05\x63rc16\x18\x03 \x01(\r\x12\x0e\n\x06\x62uffer\x18\x04 \x01(\x0c\"S\n\x07\x43ontrol\x12\x07\n\x03NUL\x10\x00\x12\x07\n\x03SOH\x10\x01\x12\x07\n\x03STX\x10\x02\x12\x07\n\x03\x45OT\x10\x04\x12\x07\n\x03\x41\x43K\x10\x06\x12\x07\n\x03NAK\x10\x15\x12\x07\n\x03\x43\x41N\x10\x18\x12\t\n\x05\x43TRLZ\x10\x1a\x42\x61\n\x13\x63om.geeksville.meshB\x0cXmodemProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x17meshtastic/xmodem.proto\x12\nmeshtastic\"\xb6\x01\n\x06XModem\x12+\n\x07\x63ontrol\x18\x01 \x01(\x0e\x32\x1a.meshtastic.XModem.Control\x12\x0b\n\x03seq\x18\x02 \x01(\r\x12\r\n\x05\x63rc16\x18\x03 \x01(\r\x12\x0e\n\x06\x62uffer\x18\x04 \x01(\x0c\"S\n\x07\x43ontrol\x12\x07\n\x03NUL\x10\x00\x12\x07\n\x03SOH\x10\x01\x12\x07\n\x03STX\x10\x02\x12\x07\n\x03\x45OT\x10\x04\x12\x07\n\x03\x41\x43K\x10\x06\x12\x07\n\x03NAK\x10\x15\x12\x07\n\x03\x43\x41N\x10\x18\x12\t\n\x05\x43TRLZ\x10\x1a\x42\x61\n\x13\x63om.geeksville.meshB\x0cXmodemProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3')
 
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'meshtastic.xmodem_pb2', globals())
@@ -21,8 +21,8 @@ if _descriptor._USE_C_DESCRIPTORS == False:
 
   DESCRIPTOR._options = None
   DESCRIPTOR._serialized_options = b'\n\023com.geeksville.meshB\014XmodemProtosZ\"github.com/meshtastic/go/generated\252\002\024Meshtastic.Protobufs\272\002\000'
-  _XMODEM._serialized_start=28
-  _XMODEM._serialized_end=199
-  _XMODEM_CONTROL._serialized_start=116
-  _XMODEM_CONTROL._serialized_end=199
+  _XMODEM._serialized_start=40
+  _XMODEM._serialized_end=222
+  _XMODEM_CONTROL._serialized_start=139
+  _XMODEM_CONTROL._serialized_end=222
 # @@protoc_insertion_point(module_scope)

meshtastic/xmodem_pb2.pyi

@@ -0,0 +1,66 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+@typing_extensions.final
+class XModem(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    class _Control:
+        ValueType = typing.NewType("ValueType", builtins.int)
+        V: typing_extensions.TypeAlias = ValueType
+
+    class _ControlEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[XModem._Control.ValueType], builtins.type):
+        DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+        NUL: XModem._Control.ValueType  # 0
+        SOH: XModem._Control.ValueType  # 1
+        STX: XModem._Control.ValueType  # 2
+        EOT: XModem._Control.ValueType  # 4
+        ACK: XModem._Control.ValueType  # 6
+        NAK: XModem._Control.ValueType  # 21
+        CAN: XModem._Control.ValueType  # 24
+        CTRLZ: XModem._Control.ValueType  # 26
+
+    class Control(_Control, metaclass=_ControlEnumTypeWrapper): ...
+    NUL: XModem.Control.ValueType  # 0
+    SOH: XModem.Control.ValueType  # 1
+    STX: XModem.Control.ValueType  # 2
+    EOT: XModem.Control.ValueType  # 4
+    ACK: XModem.Control.ValueType  # 6
+    NAK: XModem.Control.ValueType  # 21
+    CAN: XModem.Control.ValueType  # 24
+    CTRLZ: XModem.Control.ValueType  # 26
+
+    CONTROL_FIELD_NUMBER: builtins.int
+    SEQ_FIELD_NUMBER: builtins.int
+    CRC16_FIELD_NUMBER: builtins.int
+    BUFFER_FIELD_NUMBER: builtins.int
+    control: global___XModem.Control.ValueType
+    seq: builtins.int
+    crc16: builtins.int
+    buffer: builtins.bytes
+    def __init__(
+        self,
+        *,
+        control: global___XModem.Control.ValueType = ...,
+        seq: builtins.int = ...,
+        crc16: builtins.int = ...,
+        buffer: builtins.bytes = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["buffer", b"buffer", "control", b"control", "crc16", b"crc16", "seq", b"seq"]) -> None: ...
+
+global___XModem = XModem

requirements.txt

@@ -1,6 +1,6 @@
 markdown
 pyserial
-protobuf
+protobuf>=5.26.0
 dotmap
 pexpect
 pyqrcode
@@ -19,3 +19,11 @@ pytap2
 pdoc3
 pypubsub
 bleak
+packaging
+mypy
+mypy-protobuf
+types-protobuf
+types-tabulate
+types-requests
+types-setuptools
+types-PyYAML

setup.py

@@ -13,7 +13,7 @@ with open("README.md", "r") as fh:
 # This call to setup() does all the work
 setup(
     name="meshtastic",
-    version="2.2.18",
+    version="2.3.4",
     description="Python API & client shell for talking to Meshtastic devices",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -34,7 +34,7 @@ setup(
     include_package_data=True,
     install_requires=[
         "pyserial>=3.4",
-        "protobuf>=3.13.0",
+        "protobuf>=5.26.0",
         "requests>=2.25.0",
         "pypubsub>=4.0.3",
         "dotmap>=1.3.14",
@@ -44,6 +44,7 @@ setup(
         "timeago>=1.0.15",
         "pyyaml",
         "bleak>=0.21.1",
+        "packaging",
     ],
     extras_require={"tunnel": ["pytap2>=2.0.0"]},
     python_requires=">=3.7",

standalone_readme.txt

@@ -4,4 +4,4 @@ downloaded from https://github.com/meshtastic/python/releases
 If you do not want to install python and/or the python libraries, you can download one of these
 files to run the Meshtastic command line interface (CLI) as a standalone executable.
 
-See https://meshtastic.org/docs/software/python/python-standalone for more info.
+See https://meshtastic.org/docs/software/python/cli/installation/#standalone-installation-ubuntu-only for more info.