Skip to content

Commit

Permalink
Merge branch 'esp_rfc2217_server_pkg' into 'master'
Browse files Browse the repository at this point in the history
docs(docker): simplify instructions for esp_rfc2217_server, now part of esptool package

Closes IDF-6949

See merge request espressif/esp-idf!22765
  • Loading branch information
dobairoland committed Mar 21, 2023
2 parents 409e788 + 64be67e commit 86f83e0
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/en/api-guides/tools/idf-docker-image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,19 @@ Using remote serial port
~~~~~~~~~~~~~~~~~~~~~~~~
The `RFC2217`_ (Telnet) protocol can be used to remotely connect to a serial port. For more information please see the `remote serial ports`_ documentation in the esptool project. This method can also be used to access the serial port inside a Docker container if it cannot be accessed directly. Following is an example how to use the flash command from within a Docker container.

On host start ``esp_rfc2217_server``. It is available as a one-file bundled executable created by pyinstaller and it can be downloaded from the `esptool releases`_ page in a zip archive along with other esptool utilities::
On host install and start ``esp_rfc2217_server``:

esp_rfc2217_server -v -p 4000 COM3
* On Windows, package is available as a one-file bundled executable created by pyinstaller and it can be downloaded from the `esptool releases`_ page in a zip archive along with other esptool utilities::

esp_rfc2217_server -v -p 4000 COM3

* On Linux/MacOS, package is available as part of `esptool` which can be found in ESP-IDF environment or by installing using pip::

pip install esptool

And then starting the server by executing::

esp_rfc2217_server.py -v -p 4000 /dev/ttyUSB0

Now the device attached to the host can be flashed from inside a Docker container by using::

Expand Down

0 comments on commit 86f83e0

Please sign in to comment.