mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/esp_protocols_docs_migration_v5.1' into 'release/v5.1'
docs: migrated documentation from github.io to docs.espressif.com (v5.1) See merge request espressif/esp-idf!23319
This commit is contained in:
Jiang Jiang Jian
commit
959f92e744
@ -83,7 +83,7 @@ The default stack sizes for these tasks are usually set conservatively high, to
|
||||
- The Ethernet driver creates a task for the MAC to receive Ethernet frames. If using the default config ``ETH_MAC_DEFAULT_CONFIG`` then the task stack size is 4 KB. This setting can be changed by passing a custom :cpp:class:`eth_mac_config_t` struct when initializing the Ethernet MAC.
|
||||
- FreeRTOS idle task stack size is configured by :ref:`CONFIG_FREERTOS_IDLE_TASK_STACKSIZE`.
|
||||
- If using the :doc:`MQTT </api-reference/protocols/mqtt>` component, it creates a task with stack size configured by :ref:`CONFIG_MQTT_TASK_STACK_SIZE`. MQTT stack size can also be configured using ``task_stack`` field of :cpp:class:`esp_mqtt_client_config_t`.
|
||||
- To see how to optimize RAM usage when using ``mDNS``, please check `Performance Optimization <https://espressif.github.io/esp-protocols/mdns/en/index.html#minimizing-ram-usage>`__.
|
||||
- To see how to optimize RAM usage when using ``mDNS``, please check `Performance Optimization <https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html#minimizing-ram-usage>`__.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@ -170,7 +170,7 @@ Common priorities are:
|
||||
:SOC_BT_SUPPORTED: - :doc:`NimBLE Bluetooth Host </api-reference/bluetooth/nimble/index>` host task has high priority (21).
|
||||
- The Ethernet driver creates a task for the MAC to receive Ethernet frames. If using the default config ``ETH_MAC_DEFAULT_CONFIG`` then the priority is medium-high (15). This setting can be changed by passing a custom :cpp:class:`eth_mac_config_t` struct when initializing the Ethernet MAC.
|
||||
- If using the :doc:`MQTT </api-reference/protocols/mqtt>` component, it creates a task with default priority 5 (:ref:`configurable<CONFIG_MQTT_TASK_PRIORITY>`, depends on :ref:`CONFIG_MQTT_USE_CUSTOM_CONFIG` (also configurable runtime by ``task_prio`` field in the :cpp:class:`esp_mqtt_client_config_t`)
|
||||
- To see what is the task priority for ``mDNS`` service, please check `Performance Optimization <https://espressif.github.io/esp-protocols/mdns/en/index.html#execution-speed>`__.
|
||||
- To see what is the task priority for ``mDNS`` service, please check `Performance Optimization <https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html#execution-speed>`__.
|
||||
|
||||
.. only :: not CONFIG_FREERTOS_UNICORE
|
||||
|
||||
|
||||
@ -7,9 +7,11 @@ The ESP-IDF component `ASIO` has been moved from ESP-IDF since version v5.0 to a
|
||||
|
||||
* `ASIO component on GitHub <https://github.com/espressif/esp-protocols/tree/master/components/asio>`__
|
||||
|
||||
To add ASIO component in your project, please run `idf.py add-dependency espressif/asio`
|
||||
|
||||
Hosted Documentation
|
||||
--------------------
|
||||
|
||||
The documentation can be found on the link below:
|
||||
|
||||
* `ASIO documentation (English) <https://espressif.github.io/esp-protocols/asio/index.html>`__
|
||||
* `ASIO documentation (English) <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`__
|
||||
|
||||
@ -8,9 +8,11 @@ The ESP-IDF component `mDNS` has been moved from ESP-IDF since version v5.0 to a
|
||||
|
||||
* `mDNS component on GitHub <https://github.com/espressif/esp-protocols/tree/master/components/mdns>`__
|
||||
|
||||
To add mDNS component in your project, please run `idf.py add-dependency espressif/mdns`
|
||||
|
||||
Hosted Documentation
|
||||
--------------------
|
||||
|
||||
The documentation can be found on the link below:
|
||||
|
||||
* `mDNS documentation <https://espressif.github.io/esp-protocols/mdns/en/index.html>`__
|
||||
* `mDNS documentation <https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html>`__
|
||||
|
||||
@ -88,13 +88,13 @@ ESP-Protocols
|
||||
|
||||
ESP-Protocols components:
|
||||
|
||||
* `esp_modem <https://components.espressif.com/component/espressif/esp_modem>`_ enables connectivity with GSM/LTE modems using AT commands or PPP protocol, see the `esp_modem documentation <https://espressif.github.io/esp-protocols/esp_modem/index.html>`_.
|
||||
* `esp_modem <https://components.espressif.com/component/espressif/esp_modem>`_ enables connectivity with GSM/LTE modems using AT commands or PPP protocol, see the `esp_modem documentation <https://docs.espressif.com/projects/esp-protocols/esp_modem/docs/latest/index.html>`_.
|
||||
|
||||
* `mdns <https://components.espressif.com/component/espressif/mdns>`_ (mDNS) is a multicast UDP service that is used to provide local network service and host discovery, see the `mdns documentation <https://espressif.github.io/esp-protocols/mdns/en/index.html>`_.
|
||||
* `mdns <https://components.espressif.com/component/espressif/mdns>`_ (mDNS) is a multicast UDP service that is used to provide local network service and host discovery, see the `mdns documentation <https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/en/index.html>`_.
|
||||
|
||||
* `esp_websocket_client <https://components.espressif.com/component/espressif/esp_websocket_client>`_ is a managed component for `esp-idf` that contains implementation of [WebSocket protocol client](https://datatracker.ietf.org/doc/html/rfc6455) for ESP32, see the `esp_websocket_client documentation <https://espressif.github.io/esp-protocols/esp_websocket_client/index.html>`_.
|
||||
* `esp_websocket_client <https://components.espressif.com/component/espressif/esp_websocket_client>`_ is a managed component for `esp-idf` that contains implementation of [WebSocket protocol client](https://datatracker.ietf.org/doc/html/rfc6455) for ESP32, see the `esp_websocket_client documentation <https://docs.espressif.com/projects/esp-protocols/esp_websocket_client/docs/latest/index.html>`_.
|
||||
|
||||
* `asio <https://components.espressif.com/component/espressif/asio>`_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. , see the `asio documentation <https://espressif.github.io/esp-protocols/asio/index.html>`_.
|
||||
* `asio <https://components.espressif.com/component/espressif/asio>`_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. , see the `asio documentation <https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html>`_.
|
||||
|
||||
ESP-BSP
|
||||
-------
|
||||
|
||||
@ -13,4 +13,4 @@ mDNS 是一种组播 UDP 服务，用来提供本地网络服务和主机发现
|
||||
|
||||
请点击如下链接，查看 mDNS 的相关文档：
|
||||
|
||||
* `mDNS 文档 <https://espressif.github.io/esp-protocols/mdns/zh_CN/index.html>`__
|
||||
* `mDNS 文档 <https://docs.espressif.com/projects/esp-protocols/mdns/docs/latest/zh_CN/index.html>`__
|
||||
|
||||
Loading…
Reference in New Issue
Block a user