Skip to content

mpremote: Improve ESPxx board detection and user configuration. #17800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
+54 −7
Draft

mpremote: Improve ESPxx board detection and user configuration. #17800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e84269
mpremote: Identify ESP boards using VIDs&PIDs.
Josverl Jul 31, 2025
8aa4844
mpremote: Allow user-configurable ESP detection.
Josverl Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tools/mpremote/mpremote/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
)
from .mip import do_mip
from .repl import do_repl
from .transport_serial import add_user_esp_detection

_PROG = "mpremote"

Expand Down Expand Up @@ -560,6 +561,7 @@ def ensure_friendly_repl(self):
def main():
config = load_user_config()
prepare_command_expansions(config)
add_user_esp_detection(config)

remaining_args = sys.argv[1:]
state = State()
Expand Down
59 changes: 52 additions & 7 deletions tools/mpremote/mpremote/transport_serial.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,57 @@
from .console import VT_ENABLED
from .transport import TransportError, TransportExecError, Transport

VID_ESPRESSIF = 0x303A # Espressif Incorporated
esp_detection = [
# chipset , VID, PID, Vendor
# partial source http://www.linux-usb.org/usb.ids
("USB-CDC", 0x303A, None, "Espressif Incorporated"),
("Pycom", 0x04D8, None, "Pycom"),
# 0x04D8/0xEF99 / COM6 [Pytrack] [USB VID:PID=04D8:F013 SER=Py343434 LOCATION=20-2]
("CP2102 / CP2104", 0x10C4, 0xEA60, "Silicon Labs"),
("FT232R / FTDI", 0x0403, 0x6001, "Future Technology Devices Intl Ltd"),
("CH340", 0x1A86, 0x7522, "QinHeng Electronics"), # ESP32-C3 UART
("CH340 / CH341", 0x1A86, 0x7523, "QinHeng Electronics"),
("CH343", 0x1A86, 0x55D3, "QinHeng Electronics"), # ESP32-C6 UART
("Prolific PL2303", 0x067B, 0x2303, "Prolific Technology Inc."),
("Microchip MCP2200", 0x04D8, 0x00DF, "Microchip Technology Inc."),
("CH9102 / CH9102F", 0x1A86, 0x55D4, "QinHeng Electronics"),
]


def is_esp_device(device):
"""
Check if the device is an ESP device by checking the VID.
This is used to set DTR/RTS correctly for ESP devices.
"""
import serial.tools.list_ports

portinfo = list(serial.tools.list_ports.grep(device)) # type: ignore
if not portinfo or len(portinfo) != 1:
raise TransportError("No port info found for device: {}".format(device))
for chipset, vid, pid, vendor in esp_detection:
if portinfo[0].vid == vid and (pid is None or portinfo[0].pid == pid): # type: ignore
return True
return False


def add_user_esp_detection(config):
"""
Integrate the ESP detection list from the user config.
"""
if not config or not hasattr(config, 'esp_detection'):
return
esp_user_detection = config.esp_detection
if esp_user_detection is None or not isinstance(esp_user_detection, list):
raise ValueError("esp_detection must be a list of 4-tuples")
for chipset, vid, pid, vendor in esp_user_detection:
if (
# isinstance(chipset, str) and
# isinstance(vendor, str) and
isinstance(vid, int)
and (0 <= vid <= 0xFFFF)
and (pid is None or (isinstance(pid, int) and 0 <= pid <= 0xFFFF))
):
esp_detection.append((chipset, vid, pid, vendor))


class SerialTransport(Transport):
Expand All @@ -53,7 +103,6 @@ def __init__(self, device, baudrate=115200, wait=0, exclusive=True, timeout=None
self.mounted = False

import serial
import serial.tools.list_ports

# Set options, and exclusive if pyserial supports it
serial_kwargs = {
Expand All @@ -72,11 +121,7 @@ def __init__(self, device, baudrate=115200, wait=0, exclusive=True, timeout=None
elif os.name == "nt":
self.serial = serial.Serial(**serial_kwargs)
self.serial.port = device
portinfo = list(serial.tools.list_ports.grep(device)) # type: ignore
if portinfo and (
getattr(portinfo[0], "vid", 0) == VID_ESPRESSIF
or getattr(portinfo[0], "manufacturer", "") != "Microsoft"
):
if is_esp_device(device):
# ESP8266/ESP32 boards use RTS/CTS for flashing and boot mode selection.
# DTR False: to avoid using the reset button will hang the MCU in bootloader mode
# RTS False: to prevent pulses on rts on serial.close() that would POWERON_RESET an ESPxx
Expand Down
Loading