You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/installation.rst
+19
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,25 @@ Creating a virtual environment (venv) is a good practice. This is particularly h
46
46
- When you're done using ``esptool.py``, deactivate the virtual environment: ``deactivate``. The environment can be reused by activating it again.
47
47
- If you no longer need the virtual environment, you can remove it by deleting the ``esptoolenv`` directory.
48
48
49
+
Binary Releases
50
+
^^^^^^^^^^^^^^^^
51
+
52
+
If you do not want to install Python and all the dependencies, you can use the pre-built binaries from the `GitHub Releases <https://github.com/espressif/esptool/releases>`_.
53
+
54
+
Please note that the binaries might have some limitations:
55
+
56
+
- The binaries might rely on some system libraries that are not available on all systems.
57
+
- The binaries are available only for selected operating systems - currently macOS (x86_64, arm64), Linux (x86_64, armv7,aarch64) and Windows (x86_64).
58
+
- The binaries might get reported as malware by your antivirus software.
59
+
- The application is larger in size compared to the Python package installation, as it includes all dependencies.
60
+
- The application has slower startup time compared to running the Python script directly.
61
+
- The application cannot be imported as a Python module in other Python applications.
62
+
63
+
.. note::
64
+
65
+
For Linux, the binaries are built using Ubuntu 22.04 as the base image. That means any version older than Ubuntu 22.04 (or any other distribution that uses ``glibc<2.35``) might not work.
66
+
For using on Ubuntu 20.04, please use the Python package installation or ``v4.*`` release.
Copy file name to clipboardExpand all lines: docs/en/migration-guide.rst
+9
Original file line number
Diff line number
Diff line change
@@ -180,3 +180,12 @@ The ``make_image`` command for the ESP8266 has been **removed in v5**. This comm
180
180
**Migration Steps:**
181
181
182
182
1. Replace any ``make_image`` workflows with the recommended way of assembling firmware images using **objcopy** and ``elf2image``.
183
+
184
+
Using Binary from GitHub Releases on Linux
185
+
******************************************
186
+
187
+
The ``esptool.py`` binary from GitHub Releases on Linux is now using Ubuntu 22.04 as the base image. That means the image is using ``glibc`` 2.35, which is not fully compatible with the ``glibc`` 2.28 from Ubuntu 20.04 (the base image for ``v4.*``).
188
+
189
+
**Migration Steps:**
190
+
191
+
1. Update your operating system to a newer version which bundles ``glibc`` 2.35 or later
0 commit comments