esp-idf/docs/en/migration-guides/removed-components.rst
Marius Vikhammer cf1b222cac build system: removed target component
After refactoring the target components (e.g. esp32) no longer contained any real functionality.
What remained in these components have been moved elsewhere and the component itself deleted from the
build system.
2022-05-24 09:12:59 +08:00

47 lines
2.4 KiB
ReStructuredText

Removed or deprecated components
================================
Components moved to IDF Component Registry
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Following components are removed from ESP-IDF and moved to `IDF Component Registry <https://components.espressif.com/>`_:
* `libsodium <https://components.espressif.com/component/espressif/libsodium>`_
* `cbor <https://components.espressif.com/component/espressif/cbor>`_
* `jsmn <https://components.espressif.com/component/espressif/jsmn>`_
* `esp_modem <https://components.espressif.com/component/espressif/esp_modem>`_
* `nghttp <https://components.espressif.com/component/espressif/nghttp>`_
* `esp_websocket_client <https://components.espressif.com/component/espressif/esp_websocket_client>`_
* `freemodbus <https://components.espressif.com/component/espressif/esp-modbus>`_
.. note:: Please note that http parser functionality which was previously part of ``nghttp`` component is now part of :component:`http_parser <http_parser>` component.
* `sh2lib <https://components.espressif.com/component/espressif/sh2lib>`_
* `expat <https://components.espressif.com/component/espressif/expat>`_
* `coap <https://components.espressif.com/component/espressif/coap>`_
These components can be installed using ``idf.py add-dependency`` command.
For example, to install libsodium component with exact version X.Y, run: ``idf.py add-dependency libsodium==X.Y``.
To install libsodium component with the latest version compatible to X.Y according to `semver <https://semver.org/>`_ rules, run: ``idf.py add-dependency libsodium~X.Y``.
To find out which versions of each component are available, open https://components.espressif.com, search for the component by its name and check the versions listed on the component page.
Deprecated Components
^^^^^^^^^^^^^^^^^^^^^
Following components are removed since they were deprecated in IDF v4.x
* ``tcpip_adapter`` Please use the :doc:`ESP-NETIF </api-reference/network/esp_netif>` component instead; you can follow the `Migration guide to ESP-NETIF<tcpip-adapter>`
.. note:: OpenSSL-API component is no longer supported. It is not available in the IDF Component Registry, either. Please use :doc:`ESP-TLS </api-reference/protocols/esp_tls>` or :component:`mbedtls` API directly.
The targets components are no longer necessary after refactoring and have been removed:
* ``esp32``
* ``esp32s2``
* ``esp32s3``
* ``esp32c2``
* ``esp32c3``
* ``esp32h2``