esptool 5.3.dev2__tar.gz → 5.3.1__tar.gz

{esptool-5.3.dev2/esptool.egg-info → esptool-5.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esptool
-Version: 5.3.dev2
+Version: 5.3.1
 Summary: A serial utility for flashing, provisioning, and interacting with Espressif SoCs.
 Author: Fredrik Ahlberg (themadinventor), Angus Gratton (projectgus), Espressif Systems
 License: GPLv2+
@@ -28,6 +28,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bitstring!=4.2.0,>=3.1.6
 Requires-Dist: cryptography>=43.0.0
+Requires-Dist: cryptography<49.0.0; platform_system == "Darwin" and platform_machine == "x86_64"
 Requires-Dist: pyserial>=3.3
 Requires-Dist: reedsolo<1.8,>=1.5.3
 Requires-Dist: PyYAML>=5.1
@@ -60,6 +61,10 @@ A Python-based, open-source, platform-independent serial utility for flashing, p
 
 Visit the [documentation](https://docs.espressif.com/projects/esptool/) or run `esptool -h`.
 
+## Flasher Stub
+
+esptool uploads a small [flasher stub](https://docs.espressif.com/projects/esptool/en/latest/esptool/flasher-stub.html) program to the chip to improve flashing performance and work around ROM bootloader limitations. The stub is developed in the [esp-flasher-stub](https://github.com/espressif/esp-flasher-stub) repository. Prebuilt binaries are bundled with esptool releases.
+
 ## Contribute
 
 If you're interested in contributing to esptool, please check the [contributions guide](https://docs.espressif.com/projects/esptool/en/latest/contributing.html).

{esptool-5.3.dev2 → esptool-5.3.1}/README.md

@@ -9,6 +9,10 @@ A Python-based, open-source, platform-independent serial utility for flashing, p
 
 Visit the [documentation](https://docs.espressif.com/projects/esptool/) or run `esptool -h`.
 
+## Flasher Stub
+
+esptool uploads a small [flasher stub](https://docs.espressif.com/projects/esptool/en/latest/esptool/flasher-stub.html) program to the chip to improve flashing performance and work around ROM bootloader limitations. The stub is developed in the [esp-flasher-stub](https://github.com/espressif/esp-flasher-stub) repository. Prebuilt binaries are bundled with esptool releases.
+
 ## Contribute
 
 If you're interested in contributing to esptool, please check the [contributions guide](https://docs.espressif.com/projects/esptool/en/latest/contributing.html).

{esptool-5.3.dev2 → esptool-5.3.1}/esp_rfc2217_server/__init__.py

@@ -1,149 +1,150 @@
-# SPDX-FileCopyrightText: 2009-2015 Chris Liechti
-# SPDX-FileContributor: 2020-2024 Espressif Systems (Shanghai) CO LTD
-# SPDX-License-Identifier: BSD-3-Clause
-#
-# Redirect data from a TCP/IP connection to a serial port and vice versa using RFC 2217.
-
-###################################################################################
-# redirect data from a TCP/IP connection to a serial port and vice versa
-# using RFC 2217
-#
-# (C) 2009-2015 Chris Liechti <cliechti@gmx.net>
-#
-# SPDX-License-Identifier: BSD-3-Clause
-
-import logging
-import socket
-import sys
-import serial
-
-from esp_rfc2217_server.redirector import Redirector
-from esptool.util import check_deprecated_py_suffix
-
-
-def main():
-    check_deprecated_py_suffix("esp_rfc2217_server")
-    import argparse
-
-    parser = argparse.ArgumentParser(
-        description="RFC 2217 Serial to Network (TCP/IP) redirector.",
-        epilog="NOTE: no security measures are implemented. "
-        "Anyone can remotely connect to this service over the network.\n"
-        "Only one connection at once is supported. "
-        "When the connection is terminated it waits for the next connect.",
-    )
-
-    parser.add_argument("SERIALPORT")
-
-    parser.add_argument(
-        "-p",
-        "--localport",
-        type=int,
-        help="local TCP port, default: %(default)s",
-        metavar="TCPPORT",
-        default=2217,
-    )
-
-    parser.add_argument(
-        "-v",
-        "--verbose",
-        dest="verbosity",
-        action="count",
-        help="print more diagnostic messages (option can be given multiple times)",
-        default=0,
-    )
-
-    parser.add_argument(
-        "--r0",
-        help="Use delays necessary for ESP32 revision 0 chips",
-        action="store_true",
-    )
-
-    args = parser.parse_args()
-
-    if args.verbosity > 3:
-        args.verbosity = 3
-    level = (logging.WARNING, logging.INFO, logging.DEBUG, logging.NOTSET)[
-        args.verbosity
-    ]
-    logging.basicConfig(format="%(levelname)s: %(message)s", level=logging.INFO)
-    logging.getLogger("rfc2217").setLevel(level)
-
-    # connect to serial port
-    ser = serial.serial_for_url(args.SERIALPORT, do_not_open=True, exclusive=True)
-    ser.timeout = 3  # required so that the reader thread can exit
-    # reset control line as no _remote_ "terminal" has been connected yet
-    ser.dtr = False
-    ser.rts = False
-
-    logging.info("RFC 2217 TCP/IP to Serial redirector - type Ctrl-C / BREAK to quit")
-
-    try:
-        ser.open()
-    except serial.SerialException as e:
-        logging.error(f"Could not open serial port {ser.name}: {e}")
-        sys.exit(1)
-
-    logging.info(f"Serving serial port: {ser.name}")
-    settings = ser.get_settings()
-
-    srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-    srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-    srv.bind(("", args.localport))
-    srv.listen(1)
-    logging.info(f"TCP/IP port: {args.localport}")
-
-    try:
-        host_ip = socket.gethostbyname(socket.gethostname())
-    except OSError:
-        # CI/minimal containers often have no DNS for gethostname(); the server
-        # is still reachable on loopback.
-        host_ip = "127.0.0.1"
-    wait_msg = (
-        "Waiting for connection ... use the 'rfc2217://"
-        f"{host_ip}:{args.localport}?ign_set_control' as a PORT"
-    )
-    logging.info(wait_msg)
-
-    while True:
-        srv.settimeout(5)
-        client_socket = None
-        try:
-            while client_socket is None:
-                try:
-                    client_socket, addr = srv.accept()
-                except TimeoutError:
-                    print(".", end="", flush=True)
-        except KeyboardInterrupt:
-            print("")  # resetting inline print
-            logging.info("Exited with keyboard interrupt")
-            break
-        try:
-            logging.info(f"Connected by {addr[0]}:{addr[1]}")
-            client_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
-            ser.rts = True
-            ser.dtr = True
-            # enter network <-> serial loop
-            r = Redirector(ser, client_socket, args.verbosity > 0, args.r0)
-            try:
-                r.shortcircuit()
-            finally:
-                logging.info("Disconnected")
-                r.stop()
-                client_socket.close()
-                ser.dtr = False
-                ser.rts = False
-                # Restore port settings (may have been changed by RFC 2217
-                # capable client)
-                ser.apply_settings(settings)
-        except KeyboardInterrupt:
-            print(flush=True)
-            break
-        except OSError as msg:
-            logging.error(str(msg))
-
-    logging.info("--- exit ---")
-
-
-if __name__ == "__main__":
-    main()
+# SPDX-FileCopyrightText: 2009-2015 Chris Liechti
+# SPDX-FileContributor: 2020-2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: BSD-3-Clause
+#
+# Redirect data from a TCP/IP connection to a serial port and vice versa using RFC 2217.
+
+###################################################################################
+# redirect data from a TCP/IP connection to a serial port and vice versa
+# using RFC 2217
+#
+# (C) 2009-2015 Chris Liechti <cliechti@gmx.net>
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+import logging
+import socket
+import sys
+
+import serial
+
+from esp_rfc2217_server.redirector import Redirector
+from esptool.util import check_deprecated_py_suffix
+
+
+def main():
+    check_deprecated_py_suffix("esp_rfc2217_server")
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        description="RFC 2217 Serial to Network (TCP/IP) redirector.",
+        epilog="NOTE: no security measures are implemented. "
+        "Anyone can remotely connect to this service over the network.\n"
+        "Only one connection at once is supported. "
+        "When the connection is terminated it waits for the next connect.",
+    )
+
+    parser.add_argument("SERIALPORT")
+
+    parser.add_argument(
+        "-p",
+        "--localport",
+        type=int,
+        help="local TCP port, default: %(default)s",
+        metavar="TCPPORT",
+        default=2217,
+    )
+
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        dest="verbosity",
+        action="count",
+        help="print more diagnostic messages (option can be given multiple times)",
+        default=0,
+    )
+
+    parser.add_argument(
+        "--r0",
+        help="Use delays necessary for ESP32 revision 0 chips",
+        action="store_true",
+    )
+
+    args = parser.parse_args()
+
+    if args.verbosity > 3:
+        args.verbosity = 3
+    level = (logging.WARNING, logging.INFO, logging.DEBUG, logging.NOTSET)[
+        args.verbosity
+    ]
+    logging.basicConfig(format="%(levelname)s: %(message)s", level=logging.INFO)
+    logging.getLogger("rfc2217").setLevel(level)
+
+    # connect to serial port
+    ser = serial.serial_for_url(args.SERIALPORT, do_not_open=True, exclusive=True)
+    ser.timeout = 3  # required so that the reader thread can exit
+    # reset control line as no _remote_ "terminal" has been connected yet
+    ser.dtr = False
+    ser.rts = False
+
+    logging.info("RFC 2217 TCP/IP to Serial redirector - type Ctrl-C / BREAK to quit")
+
+    try:
+        ser.open()
+    except serial.SerialException as e:
+        logging.error(f"Could not open serial port {ser.name}: {e}")
+        sys.exit(1)
+
+    logging.info(f"Serving serial port: {ser.name}")
+    settings = ser.get_settings()
+
+    srv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    srv.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+    srv.bind(("", args.localport))
+    srv.listen(1)
+    logging.info(f"TCP/IP port: {args.localport}")
+
+    try:
+        host_ip = socket.gethostbyname(socket.gethostname())
+    except OSError:
+        # CI/minimal containers often have no DNS for gethostname(); the server
+        # is still reachable on loopback.
+        host_ip = "127.0.0.1"
+    wait_msg = (
+        "Waiting for connection ... use the 'rfc2217://"
+        f"{host_ip}:{args.localport}?ign_set_control' as a PORT"
+    )
+    logging.info(wait_msg)
+
+    while True:
+        srv.settimeout(5)
+        client_socket = None
+        try:
+            while client_socket is None:
+                try:
+                    client_socket, addr = srv.accept()
+                except TimeoutError:
+                    print(".", end="", flush=True)
+        except KeyboardInterrupt:
+            print("")  # resetting inline print
+            logging.info("Exited with keyboard interrupt")
+            break
+        try:
+            logging.info(f"Connected by {addr[0]}:{addr[1]}")
+            client_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
+            ser.rts = True
+            ser.dtr = True
+            # enter network <-> serial loop
+            r = Redirector(ser, client_socket, args.verbosity > 0, args.r0)
+            try:
+                r.shortcircuit()
+            finally:
+                logging.info("Disconnected")
+                r.stop()
+                client_socket.close()
+                ser.dtr = False
+                ser.rts = False
+                # Restore port settings (may have been changed by RFC 2217
+                # capable client)
+                ser.apply_settings(settings)
+        except KeyboardInterrupt:
+            print(flush=True)
+            break
+        except OSError as msg:
+            logging.error(str(msg))
+
+    logging.info("--- exit ---")
+
+
+if __name__ == "__main__":
+    main()

{esptool-5.3.dev2 → esptool-5.3.1}/esp_rfc2217_server/__main__.py

@@ -1,9 +1,9 @@
-# SPDX-FileCopyrightText: 2014-2024 Fredrik Ahlberg, Angus Gratton,
-# Espressif Systems (Shanghai) CO LTD, other contributors as noted.
-#
-# SPDX-License-Identifier: BSD-3-Clause
-
-import esp_rfc2217_server
-
-if __name__ == "__main__":
-    esp_rfc2217_server.main()
+# SPDX-FileCopyrightText: 2014-2024 Fredrik Ahlberg, Angus Gratton,
+# Espressif Systems (Shanghai) CO LTD, other contributors as noted.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+import esp_rfc2217_server
+
+if __name__ == "__main__":
+    esp_rfc2217_server.main()

{esptool-5.3.dev2 → esptool-5.3.1}/esp_rfc2217_server/esp_port_manager.py

@@ -1,101 +1,102 @@
-# SPDX-FileCopyrightText: 2014-2024 Fredrik Ahlberg, Angus Gratton,
-# Espressif Systems (Shanghai) CO LTD, other contributors as noted.
-#
-# SPDX-License-Identifier: BSD-3-Clause
-import os
-import threading
-from esptool.reset import (
-    ClassicReset,
-    CustomReset,
-    DEFAULT_RESET_DELAY,
-    HardReset,
-    UnixTightReset,
-)
-import serial
-import serial.rfc2217
-from serial.rfc2217 import (
-    COM_PORT_OPTION,
-    SET_CONTROL,
-    SET_CONTROL_DTR_OFF,
-    SET_CONTROL_DTR_ON,
-    SET_CONTROL_RTS_OFF,
-    SET_CONTROL_RTS_ON,
-)
-
-from esptool.config import load_config_file
-
-cfg, _ = load_config_file(verbose=True)
-cfg = cfg["esptool"]
-
-
-class EspPortManager(serial.rfc2217.PortManager):
-    """
-    The beginning of the reset sequence is detected and the proper reset sequence
-    is applied in a thread. The rest of the reset sequence received is just ignored
-    and not sent to the serial port.
-    """
-
-    def __init__(self, serial_port, connection, esp32r0_delay, logger=None):
-        self.esp32r0_delay = esp32r0_delay
-        self.is_download_mode = False
-        super().__init__(serial_port, connection, logger)
-
-    def _telnet_process_subnegotiation(self, suboption):
-        if suboption[0:1] == COM_PORT_OPTION and suboption[1:2] == SET_CONTROL:
-            if suboption[2:3] == SET_CONTROL_DTR_OFF:
-                self.is_download_mode = False
-                self.serial.dtr = False
-                return
-            elif suboption[2:3] == SET_CONTROL_RTS_OFF and not self.is_download_mode:
-                reset_thread = threading.Thread(target=self._hard_reset_thread)
-                reset_thread.daemon = True
-                reset_thread.name = "hard_reset_thread"
-                reset_thread.start()
-                return
-            elif suboption[2:3] == SET_CONTROL_DTR_ON and not self.is_download_mode:
-                self.is_download_mode = True
-                reset_thread = threading.Thread(target=self._reset_thread)
-                reset_thread.daemon = True
-                reset_thread.name = "reset_thread"
-                reset_thread.start()
-                return
-            elif suboption[2:3] in [
-                SET_CONTROL_DTR_ON,
-                SET_CONTROL_RTS_ON,
-                SET_CONTROL_RTS_OFF,
-            ]:
-                return
-        # only in cases not handled above do the original implementation in PortManager
-        super()._telnet_process_subnegotiation(suboption)
-
-    def _hard_reset_thread(self):
-        """
-        The reset logic used for hard resetting the chip.
-        """
-        if self.logger:
-            self.logger.info("Activating hard reset in thread")
-        cfg_custom_hard_reset_sequence = cfg.get("custom_hard_reset_sequence")
-        if cfg_custom_hard_reset_sequence is not None:
-            CustomReset(self.serial, cfg_custom_hard_reset_sequence)()
-        else:
-            HardReset(self.serial)()
-
-    def _reset_thread(self):
-        """
-        The reset logic is used from esptool because the RTS and DTR signals
-        cannot be retransmitted through RFC 2217 with proper timing.
-        """
-        if self.logger:
-            self.logger.info("Activating reset in thread")
-
-        delay = DEFAULT_RESET_DELAY
-        if self.esp32r0_delay:
-            delay += 0.5
-
-        cfg_custom_reset_sequence = cfg.get("custom_reset_sequence")
-        if cfg_custom_reset_sequence is not None:
-            CustomReset(self.serial, cfg_custom_reset_sequence)()
-        elif os.name != "nt":
-            UnixTightReset(self.serial, delay)()
-        else:
-            ClassicReset(self.serial, delay)()
+# SPDX-FileCopyrightText: 2014-2024 Fredrik Ahlberg, Angus Gratton,
+# Espressif Systems (Shanghai) CO LTD, other contributors as noted.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+import os
+import threading
+
+import serial
+import serial.rfc2217
+from serial.rfc2217 import (
+    COM_PORT_OPTION,
+    SET_CONTROL,
+    SET_CONTROL_DTR_OFF,
+    SET_CONTROL_DTR_ON,
+    SET_CONTROL_RTS_OFF,
+    SET_CONTROL_RTS_ON,
+)
+
+from esptool.config import load_config_file
+from esptool.reset import (
+    DEFAULT_RESET_DELAY,
+    ClassicReset,
+    CustomReset,
+    HardReset,
+    UnixTightReset,
+)
+
+cfg, _ = load_config_file(verbose=True)
+cfg = cfg["esptool"]
+
+
+class EspPortManager(serial.rfc2217.PortManager):
+    """
+    The beginning of the reset sequence is detected and the proper reset sequence
+    is applied in a thread. The rest of the reset sequence received is just ignored
+    and not sent to the serial port.
+    """
+
+    def __init__(self, serial_port, connection, esp32r0_delay, logger=None):
+        self.esp32r0_delay = esp32r0_delay
+        self.is_download_mode = False
+        super().__init__(serial_port, connection, logger)
+
+    def _telnet_process_subnegotiation(self, suboption):
+        if suboption[0:1] == COM_PORT_OPTION and suboption[1:2] == SET_CONTROL:
+            if suboption[2:3] == SET_CONTROL_DTR_OFF:
+                self.is_download_mode = False
+                self.serial.dtr = False
+                return
+            elif suboption[2:3] == SET_CONTROL_RTS_OFF and not self.is_download_mode:
+                reset_thread = threading.Thread(target=self._hard_reset_thread)
+                reset_thread.daemon = True
+                reset_thread.name = "hard_reset_thread"
+                reset_thread.start()
+                return
+            elif suboption[2:3] == SET_CONTROL_DTR_ON and not self.is_download_mode:
+                self.is_download_mode = True
+                reset_thread = threading.Thread(target=self._reset_thread)
+                reset_thread.daemon = True
+                reset_thread.name = "reset_thread"
+                reset_thread.start()
+                return
+            elif suboption[2:3] in [
+                SET_CONTROL_DTR_ON,
+                SET_CONTROL_RTS_ON,
+                SET_CONTROL_RTS_OFF,
+            ]:
+                return
+        # only in cases not handled above do the original implementation in PortManager
+        super()._telnet_process_subnegotiation(suboption)
+
+    def _hard_reset_thread(self):
+        """
+        The reset logic used for hard resetting the chip.
+        """
+        if self.logger:
+            self.logger.info("Activating hard reset in thread")
+        cfg_custom_hard_reset_sequence = cfg.get("custom_hard_reset_sequence")
+        if cfg_custom_hard_reset_sequence is not None:
+            CustomReset(self.serial, cfg_custom_hard_reset_sequence)()
+        else:
+            HardReset(self.serial)()
+
+    def _reset_thread(self):
+        """
+        The reset logic is used from esptool because the RTS and DTR signals
+        cannot be retransmitted through RFC 2217 with proper timing.
+        """
+        if self.logger:
+            self.logger.info("Activating reset in thread")
+
+        delay = DEFAULT_RESET_DELAY
+        if self.esp32r0_delay:
+            delay += 0.5
+
+        cfg_custom_reset_sequence = cfg.get("custom_reset_sequence")
+        if cfg_custom_reset_sequence is not None:
+            CustomReset(self.serial, cfg_custom_reset_sequence)()
+        elif os.name != "nt":
+            UnixTightReset(self.serial, delay)()
+        else:
+            ClassicReset(self.serial, delay)()

{esptool-5.3.dev2 → esptool-5.3.1}/espefuse/__init__.py

@@ -7,20 +7,19 @@ import sys
 import rich_click as click
 
 import esptool
-from esptool.cli_util import BaudRateType, ChipType, ResetModeType, SerialPortType
-from esptool.logger import log
-
 from espefuse.cli_util import Group
 from espefuse.efuse.base_operations import BaseCommands
 from espefuse.efuse_interface import (
     DEPRECATED_COMMANDS,
-    get_esp,
-    init_commands,
-    SUPPORTED_COMMANDS,
     SUPPORTED_BURN_COMMANDS,
-    SUPPORTED_READ_COMMANDS,
     SUPPORTED_CHIPS,
+    SUPPORTED_COMMANDS,
+    SUPPORTED_READ_COMMANDS,
+    get_esp,
+    init_commands,
 )
+from esptool.cli_util import BaudRateType, ChipType, ResetModeType, SerialPortType
+from esptool.logger import log
 from esptool.util import check_deprecated_py_suffix
 
 __all__ = [

{esptool-5.3.dev2 → esptool-5.3.1}/espefuse/cli_util.py

@@ -6,17 +6,16 @@ from typing import Any
 
 import rich_click as click
 from click.parser import OptionParser, ParsingState, _unpack_args
-from esptool.cli_util import Group as EsptoolGroup
-from esptool.logger import log
 
 from espefuse.efuse_interface import (
     DEPRECATED_COMMANDS,
-    init_commands,
     SUPPORTED_BURN_COMMANDS,
-    SUPPORTED_READ_COMMANDS,
     SUPPORTED_COMMANDS,
+    SUPPORTED_READ_COMMANDS,
+    init_commands,
 )
-
+from esptool.cli_util import Group as EsptoolGroup
+from esptool.logger import log
 
 click.rich_click.USE_CLICK_SHORT_HELP = True
 click.rich_click.COMMAND_GROUPS = {