Skip to content

Commit

Permalink
update docs to include auto attach param
Browse files Browse the repository at this point in the history
  • Loading branch information
brianignacio5 committed Oct 25, 2024
1 parent 3eef294 commit 6f07f01
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs_espressif/en/additionalfeatures/docker-container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,11 @@ for a list of USB serial devices.
.. note::
this command needs to be used only one time,unless the computer has restarted. **1-1** is the device's bus id ``<BUSID>`` I would like to bind.

5. After binding, please attach the specified device to WSL with this command in the Powershell command prompt.
5. After binding, please attach the specified device to WSL with this command in the Powershell command prompt. The ``--auto-attach`` parameter allows the device to be visible in the container after unplug and plug.

.. code-block::
usbipd attach --wsl --busid <BUSID>
usbipd attach --wsl --busid <BUSID> --auto-attach
6. At last, let us check if it works well on both side and type this command on WSL side.

Expand Down Expand Up @@ -231,6 +231,9 @@ Create a Container

At this moment, you can start to use the ``Blink`` example project for building, flashing, monitoring, debugging, etc.

.. warning::
* In order to have access to the serial port from the Docker container, make sure you have attached the device with ``usbipd attach --wsl --busid <BUSID> --auto-attach`` **BEFORE** opening the folder in container in VS Code otherwise it won't be visible. If you want to be able to plug and unplug the device and still see it in the docker container don't forget the ``--auto-attach`` usbipd parameter.

3. Here taking the esp32-c3 as an example, users only need to change the target device from ``esp32`` to ``esp32-c3``, as below:

.. image:: ../../../media/tutorials/using_docker_container/device_target_esp32_c3.png
Expand Down

0 comments on commit 6f07f01

Please sign in to comment.