jepler/circuitpython
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

tools/mpremote: Introduce timeout_overall for read_until().

Browse source 
And use it in `enter_raw_repl()`.  This prevents waiting forever for a
serial device that does not respond to the Ctrl-C/Ctrl-D/etc commands and
is constantly outputting data.

Signed-off-by: Hans Maerki <buhtig.hans.maerki@ergoinfo.ch>
This commit is contained in:
Hans Maerki 2025-01-27 07:29:44 +01:00 committed by Damien George
parent 0d46e45a1f
commit 03fe9c55ea
1 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
tools/mpremote/mpremote/transport_serial.py
View file

@ -98,11 +98,14 @@ class SerialTransport(Transport):
def close(self):
self.serial.close()
def read_until(self, min_num_bytes, ending, timeout=10, data_consumer=None):
def read_until(
self, min_num_bytes, ending, timeout=10, data_consumer=None, timeout_overall=None
):
"""
min_num_bytes: Obsolete.
ending: Return if 'ending' matches.
timeout [s]: Return if timeout between characters. None: Infinite timeout.
timeout_overall [s]: Return not later than timeout_overall. None: Infinite timeout.
data_consumer: Use callback for incoming characters.
If data_consumer is used then data is not accumulated and the ending must be 1 byte long
@ -110,9 +113,10 @@ class SerialTransport(Transport):
"""
assert data_consumer is None or len(ending) == 1
assert isinstance(timeout, (type(None), int, float))
assert isinstance(timeout_overall, (type(None), int, float))
data = b""
begin_char_s = time.monotonic()
begin_overall_s = begin_char_s = time.monotonic()
while True:
if data.endswith(ending):
break
@ -127,10 +131,15 @@ class SerialTransport(Transport):
else:
if timeout is not None and time.monotonic() >= begin_char_s + timeout:
break
if (
timeout_overall is not None
and time.monotonic() >= begin_overall_s + timeout_overall
):
break
time.sleep(0.01)
return data
def enter_raw_repl(self, soft_reset=True):
def enter_raw_repl(self, soft_reset=True, timeout_overall=10):
self.serial.write(b"\r\x03") # ctrl-C: interrupt any running program
# flush input (without relying on serial.flushInput())
@ -142,7 +151,9 @@ class SerialTransport(Transport):
self.serial.write(b"\r\x01") # ctrl-A: enter raw REPL
if soft_reset:
data = self.read_until(1, b"raw REPL; CTRL-B to exit\r\n>")
data = self.read_until(
1, b"raw REPL; CTRL-B to exit\r\n>", timeout_overall=timeout_overall
)
if not data.endswith(b"raw REPL; CTRL-B to exit\r\n>"):
print(data)
raise TransportError("could not enter raw repl")
@ -152,12 +163,12 @@ class SerialTransport(Transport):
# Waiting for "soft reboot" independently to "raw REPL" (done below)
# allows boot.py to print, which will show up after "soft reboot"
# and before "raw REPL".
data = self.read_until(1, b"soft reboot\r\n")
data = self.read_until(1, b"soft reboot\r\n", timeout_overall=timeout_overall)
if not data.endswith(b"soft reboot\r\n"):
print(data)
raise TransportError("could not enter raw repl")
data = self.read_until(1, b"raw REPL; CTRL-B to exit\r\n")
data = self.read_until(1, b"raw REPL; CTRL-B to exit\r\n", timeout_overall=timeout_overall)
if not data.endswith(b"raw REPL; CTRL-B to exit\r\n"):
print(data)
raise TransportError("could not enter raw repl")