Update protos and remove old max_channels check

Fix various source comment typos

.github/workflows/ci.yml

@@ -13,11 +13,10 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.6"
-          - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
     steps:
       - uses: actions/checkout@v2
       - name: Install Python 3
@@ -55,11 +54,10 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.6"
-          - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
     steps:
       - uses: actions/checkout@v2
       - name: Install Python 3

bin/regen-docs.sh

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

meshtastic/__init__.py

@@ -98,7 +98,7 @@ LOCAL_ADDR = "^local"
 """A special ID that means the local node"""
 
 BROADCAST_NUM = 0xFFFFFFFF
-"""if using 8 bit nodenums this will be shortend on the target"""
+"""if using 8 bit nodenums this will be shortened on the target"""
 
 BROADCAST_ADDR = "^all"
 """A special ID that means broadcast"""
@@ -172,7 +172,7 @@ def _onNodeInfoReceive(iface, asDict):
             # update node DB as needed
             n = iface._getOrCreateByNum(asDict["from"])
             n["user"] = p
-            # We now have a node ID, make sure it is uptodate in that table
+            # We now have a node ID, make sure it is up-to-date in that table
             iface.nodes[p["id"]] = n
             _receiveInfoUpdate(iface, asDict)
 

meshtastic/deviceonly_pb2.py

@@ -16,10 +16,11 @@ _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
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bmeshtastic/deviceonly.proto\x1a\x18meshtastic/channel.proto\x1a\x1ameshtastic/localonly.proto\x1a\x15meshtastic/mesh.proto\x1a\x1emeshtastic/module_config.proto\"\xbd\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\x1a\n\x07node_db\x18\x04 \x03(\x0b\x32\t.NodeInfo\x12\"\n\rreceive_queue\x18\x05 \x03(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07version\x18\x08 \x01(\r\x12$\n\x0frx_text_message\x18\x07 \x01(\x0b\x32\x0b.MeshPacket\x12\x0f\n\x07no_save\x18\t \x01(\x08\x12\x15\n\rdid_gps_reset\x18\x0b \x01(\x08\x12 \n\x0brx_waypoint\x18\x0c \x01(\x0b\x32\x0b.MeshPacket\x12\x39\n\x19node_remote_hardware_pins\x18\r \x03(\x0b\x32\x16.NodeRemoteHardwarePin\":\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\x1a\x18meshtastic/channel.proto\x1a\x1ameshtastic/localonly.proto\x1a\x15meshtastic/mesh.proto\x1a\x1ameshtastic/telemetry.proto\x1a\x1emeshtastic/module_config.proto\"\xe6\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\x1e\n\x07node_db\x18\x04 \x03(\x0b\x32\t.NodeInfoB\x02\x18\x01\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')
 
 _SCREENFONTS = DESCRIPTOR.enum_types_by_name['ScreenFonts']
 ScreenFonts = enum_type_wrapper.EnumTypeWrapper(_SCREENFONTS)
@@ -29,6 +30,8 @@ FONT_LARGE = 2
 
 
 _DEVICESTATE = DESCRIPTOR.message_types_by_name['DeviceState']
+_NODEINFOLITE = DESCRIPTOR.message_types_by_name['NodeInfoLite']
+_POSITIONLITE = DESCRIPTOR.message_types_by_name['PositionLite']
 _CHANNELFILE = DESCRIPTOR.message_types_by_name['ChannelFile']
 _OEMSTORE = DESCRIPTOR.message_types_by_name['OEMStore']
 _NODEREMOTEHARDWAREPIN = DESCRIPTOR.message_types_by_name['NodeRemoteHardwarePin']
@@ -39,6 +42,20 @@ DeviceState = _reflection.GeneratedProtocolMessageType('DeviceState', (_message.
   })
 _sym_db.RegisterMessage(DeviceState)
 
+NodeInfoLite = _reflection.GeneratedProtocolMessageType('NodeInfoLite', (_message.Message,), {
+  'DESCRIPTOR' : _NODEINFOLITE,
+  '__module__' : 'meshtastic.deviceonly_pb2'
+  # @@protoc_insertion_point(class_scope:NodeInfoLite)
+  })
+_sym_db.RegisterMessage(NodeInfoLite)
+
+PositionLite = _reflection.GeneratedProtocolMessageType('PositionLite', (_message.Message,), {
+  'DESCRIPTOR' : _POSITIONLITE,
+  '__module__' : 'meshtastic.deviceonly_pb2'
+  # @@protoc_insertion_point(class_scope:PositionLite)
+  })
+_sym_db.RegisterMessage(PositionLite)
+
 ChannelFile = _reflection.GeneratedProtocolMessageType('ChannelFile', (_message.Message,), {
   'DESCRIPTOR' : _CHANNELFILE,
   '__module__' : 'meshtastic.deviceonly_pb2'
@@ -64,14 +81,20 @@ 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=845
-  _SCREENFONTS._serialized_end=907
-  _DEVICESTATE._serialized_start=141
-  _DEVICESTATE._serialized_end=458
-  _CHANNELFILE._serialized_start=460
-  _CHANNELFILE._serialized_end=518
-  _OEMSTORE._serialized_start=521
-  _OEMSTORE._serialized_end=767
-  _NODEREMOTEHARDWAREPIN._serialized_start=769
-  _NODEREMOTEHARDWAREPIN._serialized_end=843
+  _DEVICESTATE.fields_by_name['node_db']._options = None
+  _DEVICESTATE.fields_by_name['node_db']._serialized_options = b'\030\001'
+  _SCREENFONTS._serialized_start=1224
+  _SCREENFONTS._serialized_end=1286
+  _DEVICESTATE._serialized_start=169
+  _DEVICESTATE._serialized_end=527
+  _NODEINFOLITE._serialized_start=530
+  _NODEINFOLITE._serialized_end=701
+  _POSITIONLITE._serialized_start=704
+  _POSITIONLITE._serialized_end=837
+  _CHANNELFILE._serialized_start=839
+  _CHANNELFILE._serialized_end=897
+  _OEMSTORE._serialized_start=900
+  _OEMSTORE._serialized_end=1146
+  _NODEREMOTEHARDWAREPIN._serialized_start=1148
+  _NODEREMOTEHARDWAREPIN._serialized_end=1222
 # @@protoc_insertion_point(module_scope)

meshtastic/localonly_pb2.py

@@ -16,7 +16,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\"\x81\x04\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\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\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\"\xba\x04\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\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')
 
 
 
@@ -43,5 +43,5 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _LOCALCONFIG._serialized_start=88
   _LOCALCONFIG._serialized_end=392
   _LOCALMODULECONFIG._serialized_start=395
-  _LOCALMODULECONFIG._serialized_end=908
+  _LOCALMODULECONFIG._serialized_end=965
 # @@protoc_insertion_point(module_scope)

meshtastic/mesh_interface.py

@@ -130,7 +130,7 @@ class MeshInterface:
         """Show table summary of nodes in mesh"""
 
         def formatFloat(value, precision=2, unit=""):
-            """Format a float value with precsion."""
+            """Format a float value with precision."""
             return f"{value:.{precision}f}{unit}" if value else None
 
         def getLH(ts):
@@ -704,13 +704,6 @@ class MeshInterface:
                     "For more information see https://tinyurl.com/5bjsxu32"
                 )
 
-            # check for firmware too old
-            if self.myInfo.max_channels == 0:
-                failmsg = (
-                    "This version of meshtastic-python requires device firmware version 1.2 or later. "
-                    "For more information see https://tinyurl.com/5bjsxu32"
-                )
-
             if failmsg:
                 self.failure = Exception(failmsg)
                 self.isConnected.set()  # let waitConnected return this exception
@@ -843,7 +836,7 @@ class MeshInterface:
         if nodeNum in self.nodesByNum:
             return self.nodesByNum[nodeNum]
         else:
-            n = {"num": nodeNum}  # Create a minimial node db entry
+            n = {"num": nodeNum}  # Create a minimal node db entry
             self.nodesByNum[nodeNum] = n
             return n
 

meshtastic/node.py

@@ -49,8 +49,8 @@ class Node:
             for c in self.channels:
                 # print('c.settings.psk:', c.settings.psk)
                 cStr = stripnl(MessageToJson(c.settings))
-                # only show if there is no psk (meaning disabled channel)
-                if c.settings.psk:
+                # 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}"
                     )
@@ -188,6 +188,10 @@ class Node:
             p.set_module_config.remote_hardware.CopyFrom(
                 self.moduleConfig.remote_hardware
             )
+        elif config_name == "neighbor_info":
+            p.set_module_config.neighbor_info.CopyFrom(
+                self.moduleConfig.neighbor_info
+            )
         else:
             our_exit(f"Error: No valid config with name {config_name}")
 
@@ -217,7 +221,7 @@ class Node:
         return ch
 
     def deleteChannel(self, channelIndex):
-        """Delete the specifed channelIndex and shift other channels up"""
+        """Delete the specified channelIndex and shift other channels up"""
         ch = self.channels[channelIndex]
         if ch.role not in (
             channel_pb2.Channel.Role.SECONDARY,
@@ -650,7 +654,7 @@ class Node:
             return
 
         c = p["decoded"]["admin"]["raw"].get_device_metadata_response
-        self._timeout.reset()  # We made foreward progress
+        self._timeout.reset()  # We made forward progress
         logging.debug(f"Received metadata {stripnl(c)}")
         print(f"\nfirmware_version: {c.firmware_version}")
         print(f"device_state_version: {c.device_state_version}")
@@ -677,7 +681,7 @@ class Node:
 
         c = p["decoded"]["admin"]["raw"].get_channel_response
         self.partialChannels.append(c)
-        self._timeout.reset()  # We made foreward progress
+        self._timeout.reset()  # We made forward progress
         logging.debug(f"Received channel {stripnl(c)}")
         index = c.index
 

meshtastic/stream_interface.py

@@ -60,7 +60,7 @@ class StreamInterface(MeshInterface):
 
         # Send some bogus UART characters to force a sleeping device to wake, and
         # if the reading statemachine was parsing a bad packet make sure
-        # we write enought start bytes to force it to resync (we don't use START1
+        # we write enough start bytes to force it to resync (we don't use START1
         # because we want to ensure it is looking for START1)
         p = bytearray([START2] * 32)
         self._writeBytes(p)

meshtastic/tests/test_smoke1.py

@@ -6,7 +6,7 @@ import subprocess
 import time
 
 # Do not like using hard coded sleeps, but it probably makes
-# sense to pause for the radio at apprpriate times
+# sense to pause for the radio at appropriate times
 import pytest
 
 from ..util import findPorts

meshtastic/tests/test_smokevirt.py

@@ -14,7 +14,7 @@ import subprocess
 import time
 
 # Do not like using hard coded sleeps, but it probably makes
-# sense to pause for the radio at apprpriate times
+# sense to pause for the radio at appropriate times
 import pytest
 
 from ..util import findPorts

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.1.7",
+    version="2.1.10",
     description="Python API & client shell for talking to Meshtastic devices",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -28,6 +28,7 @@ setup(
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
     ],
     packages=["meshtastic"],
     include_package_data=True,