Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge branch 'bugfix/doc_fix_dfu' into 'master'

Browse source 
docs: Fix and extend the DFU documentation page

See merge request espressif/esp-idf!8602
This commit is contained in:
Krzysztof Budzynski 2020-05-06 05:17:12 +08:00
commit 9b309a0a97
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/en/api-guides/dfu.rst
View file

@ -13,15 +13,20 @@ DFU is supported by ESP32-S2 chips. The necessary connections for the USB periph
+------+-------------+ +------+-------------+
| GPIO | USB | | GPIO | USB |
+======+=============+ +======+=============+
| 19 | D- (green) | | 20 | D- (green) |
+------+-------------+ +------+-------------+
| 20 | D+ (white) | | 19 | D+ (white) |
+------+-------------+ +------+-------------+
| GND | GND (black) | | GND | GND (black) |
+------+-------------+ +------+-------------+
| | +5V (red) | | +5V | +5V (red) |
+------+-------------+ +------+-------------+
.. note::
The ESP32-S2 chip needs to be in bootloader mode for the detection as a DFU device and flashing. This can be
achieved by pulling GPIO0 down (e.g. pressing the BOOT button), pulsing RESET down for a moment and releasing
GPIO0.
The software requirements of DFU are included in :ref:`get-started-get-prerequisites` of the Getting Started Guide. The software requirements of DFU are included in :ref:`get-started-get-prerequisites` of the Getting Started Guide.
Section :ref:`api_guide_dfu_build` describes how to build firmware for DFU with ESP-IDF and Section :ref:`api_guide_dfu_build` describes how to build firmware for DFU with ESP-IDF and
@ -95,5 +100,5 @@ Common errors
An easy way of checking the tool is running ``dfu-util --version``. Please see :ref:`get-started-get-prerequisites` for An easy way of checking the tool is running ``dfu-util --version``. Please see :ref:`get-started-get-prerequisites` for
installing ``dfu-util``. installing ``dfu-util``.
- The reason for ``No DFU capable USB device available`` could be that the USB driver wasn't properly installed on - The reason for ``No DFU capable USB device available`` could be that the USB driver wasn't properly installed on
Windows (see :ref:`api_guide_dfu_flash_win`) or udev rule was not setup on Linux Windows (see :ref:`api_guide_dfu_flash_win`), udev rule was not setup on Linux
(see :ref:`api_guide_dfu_flash_udev`). (see :ref:`api_guide_dfu_flash_udev`) or the device isn't in bootloader mode.