mirror of
https://github.com/meshtastic/python.git
synced 2025-12-27 09:57:53 -05:00
bc1664dade
Some devices (e.g. Heltec V3.1) are reset when the RTS or DTR pins are messed with, which means that without workarounds, Meshtastic CLI will cause a reset with any operation that opens the serial port. This behavior is documented in this PySerial issue: https://github.com/pyserial/pyserial/issues/124 On Linux, we already handle this by disabling the HUPCL termios flag, which has the effect of preventing the offending lines being toggled. On Windows, setting the initial state of RTS and DTR before opening the port has a similar effect. Implement this workaround so that Meshtastic CLI can be used on Windows with these devices.
87 lines
3.3 KiB
Python
87 lines
3.3 KiB
Python
""" Serial interface class
|
|
"""
|
|
# pylint: disable=R0917
|
|
import logging
|
|
import platform
|
|
import time
|
|
|
|
from typing import List, Optional
|
|
|
|
import serial # type: ignore[import-untyped]
|
|
|
|
import meshtastic.util
|
|
from meshtastic.stream_interface import StreamInterface
|
|
|
|
if platform.system() != "Windows":
|
|
import termios
|
|
|
|
|
|
class SerialInterface(StreamInterface):
|
|
"""Interface class for meshtastic devices over a serial link"""
|
|
|
|
def __init__(self, devPath: Optional[str]=None, debugOut=None, noProto: bool=False, connectNow: bool=True, noNodes: bool=False) -> None:
|
|
"""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})
|
|
"""
|
|
self.noProto = noProto
|
|
|
|
self.devPath: Optional[str] = devPath
|
|
|
|
if self.devPath is None:
|
|
ports: List[str] = meshtastic.util.findPorts(True)
|
|
logging.debug(f"ports:{ports}")
|
|
if len(ports) == 0:
|
|
print("No Serial Meshtastic device detected, attempting TCP connection on localhost.")
|
|
return
|
|
elif len(ports) > 1:
|
|
message: str = "Warning: Multiple serial ports were detected so one serial port must be specified with the '--port'.\n"
|
|
message += f" Ports detected:{ports}"
|
|
meshtastic.util.our_exit(message)
|
|
else:
|
|
self.devPath = ports[0]
|
|
|
|
logging.debug(f"Connecting to {self.devPath}")
|
|
|
|
# set port to None to prevent automatically opening
|
|
self.stream = serial.Serial(
|
|
port=None, baudrate=115200, exclusive=True, timeout=0.5, write_timeout=0
|
|
)
|
|
|
|
# first we need to clear HUPCL (UNIX) or clear RTS/DTR (Windows) so the device will not reboot based on RTS and/or DTR
|
|
# see https://github.com/pyserial/pyserial/issues/124
|
|
if platform.system() != "Windows":
|
|
with open(self.devPath, encoding="utf8") as f:
|
|
attrs = termios.tcgetattr(f)
|
|
attrs[2] = attrs[2] & ~termios.HUPCL
|
|
termios.tcsetattr(f, termios.TCSAFLUSH, attrs)
|
|
f.close()
|
|
time.sleep(0.1)
|
|
else:
|
|
self.stream.rts = 0
|
|
self.stream.dtr = 0
|
|
|
|
# set proper port and open now that we've worked-around RTS/DTR issues
|
|
self.stream.port = self.devPath
|
|
self.stream.open()
|
|
|
|
self.stream.flush() # type: ignore[attr-defined]
|
|
time.sleep(0.1)
|
|
|
|
StreamInterface.__init__(
|
|
self, debugOut=debugOut, noProto=noProto, connectNow=connectNow, noNodes=noNodes
|
|
)
|
|
|
|
def close(self) -> None:
|
|
"""Close a connection to the device"""
|
|
if self.stream: # Stream can be null if we were already closed
|
|
self.stream.flush() # FIXME: why are there these two flushes with 100ms sleeps? This shouldn't be necessary
|
|
time.sleep(0.1)
|
|
self.stream.flush()
|
|
time.sleep(0.1)
|
|
logging.debug("Closing Serial stream")
|
|
StreamInterface.close(self)
|