docs: Describe --chip option, fix small typos

This commit is contained in:
radim.karnis
2022-08-29 16:01:36 +02:00
parent 8b3825c136
commit 2eff1be0f7
6 changed files with 29 additions and 19 deletions

View File

@@ -120,23 +120,21 @@ A second option ``--non-volatile`` can be used in order to send a ``WREN`` (06h)
Setting status bits (particularly non-volatile ones) can have permanent side effects for some flash chips, so check carefully before using this command to set any bits!
.. _chip-id:
.. only:: esp8266
Read the Chip ID: chip_id
-------------------------
.. _chip-id:
The ``chip_id`` command allows you to read a 4 byte ID which forms part of the MAC address. It is usually better to use ``read_mac`` to identify a chip.
Read the Chip ID: chip_id
-------------------------
::
The ``chip_id`` command allows you to read a 4 byte ID which forms part of the MAC address. It is usually better to use ``read_mac`` to identify a chip.
On {IDF_TARGET_NAME}, output is the same as the ``system_get_chip_id()`` SDK function. The chip ID is four bytes long, the lower three bytes are the final bytes of the MAC address. The upper byte is zero.
::
esptool.py chip_id
On ESP8266, output is the same as the ``system_get_chip_id()`` SDK function. The chip ID is four bytes long, the lower three bytes are the final bytes of the MAC address. The upper byte is zero.
On ESP32, there is no ``system_get_chip_id()`` function and this command is the same as ``esptool.py read_mac``.
.. only:: esp8266
.. _make-image:
Assemble a Firmware Image: make_image

View File

@@ -138,6 +138,8 @@ Example output:
Refer to `flashrom source code <https://review.coreboot.org/plugins/gitiles/flashrom/+/refs/heads/master/flashchips.h>`__ for flash chip manufacturer name and part number.
.. _elf-2-image:
Convert ELF to Binary: elf2image
--------------------------------
@@ -234,6 +236,6 @@ The following commands are less commonly used, or only of interest to advanced u
* :ref:`read-mem-write-mem`
* :ref:`read-flash-status`
* :ref:`write-flash-status`
* :ref:`chip-id`
:esp8266: * :ref:`chip-id`
:esp8266: * :ref:`make-image`
:esp8266: * :ref:`run`

View File

@@ -5,6 +5,16 @@ Basic Options
These are the basic/fundamental esptool options needed to define the communication with an ESP target. For advanced configuration options, see the :ref:`advanced-options` page.
.. _chip-type:
Chip Type
---------
* The target chip type can be selected using the ``--chip``/ ``-c`` option, e.g. ``esptool.py --chip {IDF_TARGET_PATH_NAME} <command>``.
* A default chip type can be specified by setting the ``ESPTOOL_CHIP`` environment variable.
* If no ``-c`` option or ``ESPTOOL_CHIP`` value is specified, ``esptool.py`` automatically detects the chip type when connecting.
* Binary image generation commands, such as :ref:`elf2image <elf-2-image>` or :ref:`merge_bin <merge-bin>`, require the chip type to be specified.
.. _serial-port:
Serial Port

View File

@@ -50,7 +50,7 @@ On client:
::
esptool -p socket://localhost:4000 flash_id
esptool.py -p socket://localhost:4000 flash_id
.. note::

View File

@@ -16,7 +16,7 @@ With some Python installations this may not work and youll receive an error,
`Setuptools <https://setuptools.pypa.io/en/latest/userguide/quickstart.html>`_ is also a requirement which is not available on all systems by default. You can install it by a package manager of your operating system, or by ``pip install setuptools``.
After installing, you will have ``esptool.py`` installed into the default Python executables directory and you should be able to run it with the command ``esptool`` or ``python -m esptool``. Please note that probably only ``python -m esptool`` will work for Pythons installed from Windows Store.
After installing, you will have ``esptool.py`` installed into the default Python executables directory and you should be able to run it with the command ``esptool.py`` or ``python -m esptool``. Please note that probably only ``python -m esptool`` will work for Pythons installed from Windows Store.
.. note::