-
-
Notifications
You must be signed in to change notification settings - Fork 799
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automatically reconnect device monitor if a connection fails // Resolve
- Loading branch information
1 parent
c42fe32
commit 7f351bc
Showing
7 changed files
with
242 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| # Copyright (c) 2014-present PlatformIO <[email protected]> | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import signal | ||
| import threading | ||
|
|
||
| import click | ||
| import serial | ||
| from serial.tools import miniterm | ||
|
|
||
| from platformio.exception import UserSideException | ||
|
|
||
|
|
||
| class Terminal(miniterm.Miniterm): | ||
| def __init__(self, *args, **kwargs): | ||
| super().__init__(*args, **kwargs) | ||
| self.pio_unexpected_exception = None | ||
|
|
||
| def reader(self): | ||
| try: | ||
| super().reader() | ||
| except Exception as exc: # pylint: disable=broad-except | ||
| self.pio_unexpected_exception = exc | ||
|
|
||
| def writer(self): | ||
| try: | ||
| super().writer() | ||
| except Exception as exc: # pylint: disable=broad-except | ||
| self.pio_unexpected_exception = exc | ||
|
|
||
|
|
||
| def start_terminal(options): | ||
| retries = 0 | ||
| is_port_valid = False | ||
| while True: | ||
| term = None | ||
| try: | ||
| term = new_terminal(options) | ||
| is_port_valid = True | ||
| options["port"] = term.serial.name | ||
| if retries: | ||
| click.echo("\t Connected!", err=True) | ||
| elif not options["quiet"]: | ||
| print_terminal_settings(term) | ||
| retries = 0 # reset | ||
| term.start() | ||
| try: | ||
| term.join(True) | ||
| except KeyboardInterrupt: | ||
| pass | ||
| term.join() | ||
| term.console.cleanup() | ||
| term.close() | ||
| if term.pio_unexpected_exception: | ||
| click.secho( | ||
| "Disconnected (%s)" % term.pio_unexpected_exception, | ||
| fg="red", | ||
| err=True, | ||
| ) | ||
| if options["reconnect"]: | ||
| raise UserSideException(term.pio_unexpected_exception) | ||
| return | ||
| except UserSideException as exc: | ||
| if not is_port_valid: | ||
| raise exc | ||
| if not retries: | ||
| click.echo("Reconnecting to %s " % options["port"], err=True, nl=False) | ||
| signal.signal(signal.SIGINT, signal.SIG_DFL) | ||
| else: | ||
| click.echo(".", err=True, nl=False) | ||
| retries += 1 | ||
| threading.Event().wait(retries / 2) | ||
|
|
||
|
|
||
| def new_terminal(options): | ||
| term = Terminal( | ||
| new_serial_instance(options), | ||
| echo=options["echo"], | ||
| eol=options["eol"].lower(), | ||
| filters=options["filters"] or ["default"], | ||
| ) | ||
| term.exit_character = chr(options["exit_char"]) | ||
| term.menu_character = chr(options["menu_char"]) | ||
| term.raw = options["raw"] | ||
| term.set_rx_encoding(options["encoding"]) | ||
| term.set_tx_encoding(options["encoding"]) | ||
| return term | ||
|
|
||
|
|
||
| def print_terminal_settings(terminal): | ||
| click.echo( | ||
| "--- Terminal on {p.name} | " | ||
| "{p.baudrate} {p.bytesize}-{p.parity}-{p.stopbits}".format(p=terminal.serial) | ||
| ) | ||
| click.echo( | ||
| "--- Available filters and text transformations: %s" | ||
| % ", ".join(sorted(miniterm.TRANSFORMATIONS.keys())) | ||
| ) | ||
| click.echo("--- More details at https://bit.ly/pio-monitor-filters") | ||
| click.echo( | ||
| "--- Quit: {} | Menu: {} | Help: {} followed by {}".format( | ||
| miniterm.key_description(terminal.exit_character), | ||
| miniterm.key_description(terminal.menu_character), | ||
| miniterm.key_description(terminal.menu_character), | ||
| miniterm.key_description("\x08"), | ||
| ) | ||
| ) | ||
|
|
||
|
|
||
| def new_serial_instance(options): # pylint: disable=too-many-branches | ||
| serial_instance = None | ||
| port = options["port"] | ||
| while serial_instance is None: | ||
| # no port given on command line -> ask user now | ||
| if port is None or port == "-": | ||
| try: | ||
| port = miniterm.ask_for_port() | ||
| except KeyboardInterrupt: | ||
| click.echo("", err=True) | ||
| raise UserSideException("User aborted and port is not given") | ||
| else: | ||
| if not port: | ||
| raise UserSideException("Port is not given") | ||
| try: | ||
| serial_instance = serial.serial_for_url( | ||
| port, | ||
| options["baud"], | ||
| parity=options["parity"], | ||
| rtscts=options["rtscts"], | ||
| xonxoff=options["xonxoff"], | ||
| do_not_open=True, | ||
| ) | ||
|
|
||
| if not hasattr(serial_instance, "cancel_read"): | ||
| # enable timeout for alive flag polling if cancel_read is not available | ||
| serial_instance.timeout = 1 | ||
|
|
||
| if options["dtr"] is not None: | ||
| if not options["quiet"]: | ||
| click.echo( | ||
| "--- forcing DTR {}".format( | ||
| "active" if options["dtr"] else "inactive" | ||
| ) | ||
| ) | ||
| serial_instance.dtr = options["dtr"] | ||
|
|
||
| if options["rts"] is not None: | ||
| if not options["quiet"]: | ||
| click.echo( | ||
| "--- forcing RTS {}".format( | ||
| "active" if options["rts"] else "inactive" | ||
| ) | ||
| ) | ||
| serial_instance.rts = options["rts"] | ||
|
|
||
| if isinstance(serial_instance, serial.Serial): | ||
| serial_instance.exclusive = True | ||
|
|
||
| serial_instance.open() | ||
| except serial.SerialException as exc: | ||
| raise UserSideException(exc) | ||
|
|
||
| return serial_instance |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.