WIP for new cleaned up device API

bin/regen-protos.sh

@@ -1,4 +1,8 @@
 #!/bin/bash
 
 
-protoc -I=proto --python_out meshtastic mesh.proto
+protoc -I=proto --python_out meshtastic mesh.proto portnums.proto
+
+# workaround for import bug in protoc https://github.com/protocolbuffers/protobuf/issues/1491#issuecomment-690618628
+
+sed -i -E 's/^import.*_pb2/from . \0/' meshtastic/*.py

meshtastic/__init__.py

@@ -66,8 +66,7 @@ import traceback
 import time
 import base64
 import platform
-from . import mesh_pb2
-from . import util
+from . import mesh_pb2, portnums_pb2, util
 from pubsub import pub
 from dotmap import DotMap
 
@@ -125,25 +124,27 @@ class MeshInterface:
 
         Keyword Arguments:
             destinationId {nodeId or nodeNum} -- where to send this message (default: {BROADCAST_ADDR})
+            portNum -- the application portnum (similar to IP port numbers) of the destination, see portnums.proto for a list
             wantAck -- True if you want the message sent in a reliable manner (with retries and ack/nak provided for delivery)
 
         Returns the sent packet. The id field will be populated in this packet and can be used to track future message acks/naks.
         """
         return self.sendData(text.encode("utf-8"), destinationId,
-                             dataType=mesh_pb2.Data.CLEAR_TEXT, wantAck=wantAck, wantResponse=wantResponse)
+                             portNum=portnums_pb2.PortNum.TEXT_MESSAGE_APP, wantAck=wantAck, wantResponse=wantResponse)
 
-    def sendData(self, byteData, destinationId=BROADCAST_ADDR, dataType=mesh_pb2.Data.OPAQUE, wantAck=False, wantResponse=False):
+    def sendData(self, byteData, destinationId=BROADCAST_ADDR, portNum=portnums_pb2.PortNum.PRIVATE_APP, wantAck=False, wantResponse=False):
         """Send a data packet to some other node
 
         Keyword Arguments:
             destinationId {nodeId or nodeNum} -- where to send this message (default: {BROADCAST_ADDR})
+            portNum -- the application portnum (similar to IP port numbers) of the destination, see portnums.proto for a list
             wantAck -- True if you want the message sent in a reliable manner (with retries and ack/nak provided for delivery)
 
         Returns the sent packet. The id field will be populated in this packet and can be used to track future message acks/naks.
         """
         meshPacket = mesh_pb2.MeshPacket()
         meshPacket.decoded.data.payload = byteData
-        meshPacket.decoded.data.typ = dataType
+        meshPacket.decoded.data.portnum = portNum
         meshPacket.decoded.want_response = wantResponse
         return self.sendPacket(meshPacket, destinationId, wantAck=wantAck)
 
@@ -447,11 +448,11 @@ class MeshInterface:
 
             # OPAQUE is the default protobuf typ value, and therefore if not set it will not be populated at all
             # to make API usage easier, set it to prevent confusion
-            if not "typ" in asDict["decoded"]["data"]:
-                asDict["decoded"]["data"]["typ"] = "OPAQUE"
+            if not "portnum" in asDict["decoded"]["data"]:
+                asDict["decoded"]["data"]["portnum"] = portnums_pb2.PortNum.UNKNOWN_APP
 
             # For text messages, we go ahead and decode the text to ascii for our users
-            if asDict["decoded"]["data"]["typ"] == "CLEAR_TEXT":
+            if asDict["decoded"]["data"]["portnum"] == portnums_pb2.PortNum.TEXT_MESSAGE_APP:
                 topic = "meshtastic.receive.text"
 
                 # We don't throw if the utf8 is invalid in the text message.  Instead we just don't populate

meshtastic/portnums_pb2.py

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: portnums.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor.FileDescriptor(
+  name='portnums.proto',
+  package='',
+  syntax='proto3',
+  serialized_options=None,
+  create_key=_descriptor._internal_create_key,
+  serialized_pb=b'\n\x0eportnums.proto*\x88\x01\n\x07PortNum\x12\x0f\n\x0bUNKNOWN_APP\x10\x00\x12\x14\n\x10TEXT_MESSAGE_APP\x10\x01\x12\x0c\n\x08GPIO_APP\x10\x02\x12\x10\n\x0cPOSITION_APP\x10\x03\x12\x10\n\x0cNODEINFO_APP\x10\x04\x12\x10\n\x0bPRIVATE_APP\x10\x80\x02\x12\x12\n\rIP_TUNNEL_APP\x10\x80\x08\x62\x06proto3'
+)
+
+_PORTNUM = _descriptor.EnumDescriptor(
+  name='PortNum',
+  full_name='PortNum',
+  filename=None,
+  file=DESCRIPTOR,
+  create_key=_descriptor._internal_create_key,
+  values=[
+    _descriptor.EnumValueDescriptor(
+      name='UNKNOWN_APP', index=0, number=0,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='TEXT_MESSAGE_APP', index=1, number=1,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='GPIO_APP', index=2, number=2,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='POSITION_APP', index=3, number=3,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='NODEINFO_APP', index=4, number=4,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='PRIVATE_APP', index=5, number=256,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='IP_TUNNEL_APP', index=6, number=1024,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+  ],
+  containing_type=None,
+  serialized_options=None,
+  serialized_start=19,
+  serialized_end=155,
+)
+_sym_db.RegisterEnumDescriptor(_PORTNUM)
+
+PortNum = enum_type_wrapper.EnumTypeWrapper(_PORTNUM)
+UNKNOWN_APP = 0
+TEXT_MESSAGE_APP = 1
+GPIO_APP = 2
+POSITION_APP = 3
+NODEINFO_APP = 4
+PRIVATE_APP = 256
+IP_TUNNEL_APP = 1024
+
+
+DESCRIPTOR.enum_types_by_name['PortNum'] = _PORTNUM
+_sym_db.RegisterFileDescriptor(DESCRIPTOR)
+
+
+# @@protoc_insertion_point(module_scope)