-class StreamInterface
+
+class SerialInterface
(devPath=None, debugOut=None, noProto=False, connectNow=True)
-Interface class for meshtastic devices over a stream link (serial, TCP, etc)
+Interface class for meshtastic devices over a serial link
Constructor, opens a connection to a specified serial port, or if unspecified try to
find one Meshtastic device by probing
Keyword Arguments:
devPath {string} – A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
+debugOut {stream} – If a stream is provided, any debug serial output from the device will be emitted to that stream. (default: {None})
+
+
+Expand source code
+
+class SerialInterface(StreamInterface):
+ """Interface class for meshtastic devices over a serial link"""
+
+ def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
+ """Constructor, opens a connection to a specified serial port, or if unspecified try to
+ find one Meshtastic device by probing
+
+ Keyword Arguments:
+ devPath {string} -- A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
+ debugOut {stream} -- If a stream is provided, any debug serial output from the device will be emitted to that stream. (default: {None})
+ """
+
+ if devPath is None:
+ ports = util.findPorts()
+ if len(ports) == 0:
+ raise Exception("No Meshtastic devices detected")
+ elif len(ports) > 1:
+ raise Exception(
+ f"Multiple ports detected, you must specify a device, such as {ports[0].device}")
+ else:
+ devPath = ports[0]
+
+ logging.debug(f"Connecting to {devPath}")
+
+ # Note: we provide None for port here, because we will be opening it later
+ self.stream = serial.Serial(
+ None, 921600, exclusive=True, timeout=0.5)
+
+ # rts=False Needed to prevent TBEAMs resetting on OSX, because rts is connected to reset
+ self.stream.port = devPath
+ # OS-X seems to have a bug in its serial driver. It ignores that we asked for no RTSCTS
+ # control and will always drive RTS either high or low (rather than letting the CP102 leave
+ # it as an open-collector floating pin). Since it is going to drive it anyways we want to make
+ # sure it is driven low, so that the TBEAM won't reset
+ if platform.system() == 'Darwin':
+ self.stream.rts = False
+ self.stream.open()
+
+ StreamInterface.__init__(
+ self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
+
+ def _disconnected(self):
+ """We override the superclass implementation to close our port"""
+
+ if platform.system() == 'Darwin':
+ self.stream.rts = True # Return RTS high, so that the reset button still works
+
+ StreamInterface._disconnected(self)
+
+Ancestors
+
+Inherited members
+
+StreamInterface:
+
+
+
+
+class StreamInterface
+(debugOut=None, noProto=False, connectNow=True)
+
+Interface class for meshtastic devices over a stream link (serial, TCP, etc)
+Constructor, opens a connection to self.stream
+Keyword Arguments:
+devPath {string} – A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
debugOut {stream} – If a stream is provided, any debug serial output from the device will be emitted to that stream. (default: {None})
Raises
@@ -1269,9 +1436,8 @@ debugOut {stream} – If a stream is provided, any debug serial output from
class StreamInterface(MeshInterface):
"""Interface class for meshtastic devices over a stream link (serial, TCP, etc)"""
- def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
- """Constructor, opens a connection to a specified serial port, or if unspecified try to
- find one Meshtastic device by probing
+ def __init__(self, debugOut=None, noProto=False, connectNow=True):
+ """Constructor, opens a connection to self.stream
Keyword Arguments:
devPath {string} -- A filepath to a device, i.e. /dev/ttyUSB0 (default: {None})
@@ -1282,35 +1448,12 @@ debugOut {stream} – If a stream is provided, any debug serial output from
Exception: [description]
"""
- if devPath is None:
- ports = util.findPorts()
- if len(ports) == 0:
- raise Exception("No Meshtastic devices detected")
- elif len(ports) > 1:
- raise Exception(
- f"Multiple ports detected, you must specify a device, such as {ports[0].device}")
- else:
- devPath = ports[0]
-
- logging.debug(f"Connecting to {devPath}")
- self.devPath = devPath
+ if not hasattr(self, 'stream'):
+ raise Exception(
+ "StreamInterface is now abstract (to update existing code create SerialInterface instead)")
self._rxBuf = bytes() # empty
self._wantExit = False
- # Note: we provide None for port here, because we will be opening it later
- self.stream = serial.Serial(
- None, 921600, exclusive=True, timeout=0.5)
-
- # rts=False Needed to prevent TBEAMs resetting on OSX, because rts is connected to reset
- self.stream.port = devPath
- # OS-X seems to have a bug in its serial driver. It ignores that we asked for no RTSCTS
- # control and will always drive RTS either high or low (rather than letting the CP102 leave
- # it as an open-collector floating pin). Since it is going to drive it anyways we want to make
- # sure it is driven low, so that the TBEAM won't reset
- if platform.system() == 'Darwin':
- self.stream.rts = False
- self.stream.open()
-
self._rxThread = threading.Thread(target=self.__reader, args=())
MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto)
@@ -1327,21 +1470,36 @@ debugOut {stream} – If a stream is provided, any debug serial output from
"""
# Send some bogus UART characters to force a sleeping device to wake
- self.stream.write(bytes([START1, START1, START1, START1]))
- self.stream.flush()
+ self._writeBytes(bytes([START1, START1, START1, START1]))
time.sleep(0.1) # wait 100ms to give device time to start running
self._rxThread.start()
+ def _disconnected(self):
+ """We override the superclass implementation to close our port"""
+ MeshInterface._disconnected(self)
+
+ logging.debug("Closing our port")
+ if not self.stream is None:
+ self.stream.close()
+
+ def _writeBytes(self, b):
+ """Write an array of bytes to our stream and flush"""
+ self.stream.write(b)
+ self.stream.flush()
+
+ def _readBytes(self, len):
+ """Read an array of bytes from our stream"""
+ return self.stream.read(len)
+
def _sendToRadio(self, toRadio):
"""Send a ToRadio protobuf to the device"""
logging.debug(f"Sending: {toRadio}")
b = toRadio.SerializeToString()
bufLen = len(b)
+ # We convert into a string, because the TCP code doesn't work with byte arrays
header = bytes([START1, START2, (bufLen >> 8) & 0xff, bufLen & 0xff])
- self.stream.write(header)
- self.stream.write(b)
- self.stream.flush()
+ self._writeBytes(header + b)
def close(self):
"""Close a connection to the device"""
@@ -1357,7 +1515,7 @@ debugOut {stream} – If a stream is provided, any debug serial output from
try:
while not self._wantExit:
- b = self.stream.read(1)
+ b = self._readBytes(1)
if len(b) > 0:
# logging.debug(f"read returned {b}")
c = b[0]
@@ -1395,22 +1553,24 @@ debugOut {stream} – If a stream is provided, any debug serial output from
traceback.print_exc()
self._rxBuf = empty
else:
- # logging.debug(f"timeout on {self.devPath}")
+ # logging.debug(f"timeout")
pass
except serial.SerialException as ex:
logging.warn(
f"Meshtastic serial port disconnected, disconnecting... {ex}")
finally:
logging.debug("reader is exiting")
- if platform.system() == 'Darwin':
- self.stream.rts = True # Return RTS high, so that the reset button still works
- self.stream.close()
self._disconnected()
Ancestors
+Subclasses
+
Methods
@@ -1450,8 +1610,7 @@ start the reading thread later.
"""
# Send some bogus UART characters to force a sleeping device to wake
- self.stream.write(bytes([START1, START1, START1, START1]))
- self.stream.flush()
+ self._writeBytes(bytes([START1, START1, START1, START1]))
time.sleep(0.1) # wait 100ms to give device time to start running
self._rxThread.start()
@@ -1472,6 +1631,79 @@ start the reading thread later.
+
+class TCPInterface
+(hostname, debugOut=None, noProto=False, connectNow=True, portNumber=4403)
+
+Interface class for meshtastic devices over a TCP link
+Constructor, opens a connection to a specified IP address/hostname
+Keyword Arguments:
+hostname {string} – Hostname/IP address of the device to connect to
+
+
+Expand source code
+
+class TCPInterface(StreamInterface):
+ """Interface class for meshtastic devices over a TCP link"""
+
+ def __init__(self, hostname, debugOut=None, noProto=False, connectNow=True, portNumber=4403):
+ """Constructor, opens a connection to a specified IP address/hostname
+
+ Keyword Arguments:
+ hostname {string} -- Hostname/IP address of the device to connect to
+ """
+
+ logging.debug(f"Connecting to {hostname}")
+
+ server_address = (hostname, portNumber)
+ sock = socket.create_connection(server_address)
+
+ # Instead of wrapping as a stream, we use the native socket API
+ # self.stream = sock.makefile('rw')
+ self.stream = None
+ self.socket = sock
+
+ StreamInterface.__init__(
+ self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
+
+ def _disconnected(self):
+ """We override the superclass implementation to close our port"""
+ StreamInterface._disconnected(self)
+
+ logging.debug("Closing our socket")
+ if not self.socket is None:
+ self.socket.close()
+
+ def _writeBytes(self, b):
+ """Write an array of bytes to our stream and flush"""
+ self.socket.send(b)
+
+ def _readBytes(self, len):
+ """Read an array of bytes from our stream"""
+ return self.socket.recv(len)
+
+Ancestors
+
+Inherited members
+
+StreamInterface:
+
+
+
SerialInterfaceStreamInterfaceTCPInterfaceimport logging
from . import util
-from . import StreamInterface, BROADCAST_NUM
+from . import SerialInterface, BROADCAST_NUM
from pubsub import pub
import time
import sys
@@ -154,7 +154,7 @@ def testAll():
pub.subscribe(onConnection, "meshtastic.connection")
pub.subscribe(onReceive, "meshtastic.receive")
global interfaces
- interfaces = list(map(lambda port: StreamInterface(
+ interfaces = list(map(lambda port: SerialInterface(
port, debugOut=openDebugLog(port), connectNow=False), ports))
for i in interfaces:
i.connect()
@@ -288,7 +288,7 @@ def testAll():
pub.subscribe(onConnection, "meshtastic.connection")
pub.subscribe(onReceive, "meshtastic.receive")
global interfaces
- interfaces = list(map(lambda port: StreamInterface(
+ interfaces = list(map(lambda port: SerialInterface(
port, debugOut=openDebugLog(port), connectNow=False), ports))
for i in interfaces:
i.connect()
diff --git a/meshtastic/__init__.py b/meshtastic/__init__.py
index 437b76a..43aa496 100644
--- a/meshtastic/__init__.py
+++ b/meshtastic/__init__.py
@@ -276,7 +276,9 @@ class MeshInterface:
elif fromRadio.HasField("packet"):
self._handlePacketFromRadio(fromRadio.packet)
elif fromRadio.rebooted:
- self._disconnected()
+ # Tell clients the device went away. Careful not to call the overridden subclass version that closes the serial port
+ MeshInterface._disconnected(self)
+
self._startConfig() # redownload the node db etc...
else:
logging.debug("Unexpected FromRadio payload")
diff --git a/setup.py b/setup.py
index ddf920e..54e889d 100644
--- a/setup.py
+++ b/setup.py
@@ -12,7 +12,7 @@ with open("README.md", "r") as fh:
# This call to setup() does all the work
setup(
name="meshtastic",
- version="1.0.11",
+ version="1.0.13",
description="Python API & client shell for talking to Meshtastic devices",
long_description=long_description,
long_description_content_type="text/markdown",