OVMS3-idf/docs/en/api-reference/network/index.rst
David Cermak ac47c74ec4 esp_netif, docs: Added programmer's manual section
Also added guide for creating a custom network capable I/O driver
And added notes about default wifi interfaces and implications of using
default short-hand creation functions.
2019-12-17 09:02:51 +01:00

55 lines
1.3 KiB
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Networking APIs
***************
:link_to_translation:`zh_CN:[中文]`
Wi-Fi
=====
.. toctree::
:maxdepth: 1
Wi-Fi <esp_wifi>
Smart Config <esp_smartconfig>
ESP-NOW <esp_now>
ESP Mesh <esp_mesh>
Code examples for the Wi-Fi API are provided in the :example:`wifi` directory of ESP-IDF examples.
Code examples for ESP-MESH are provided in the :example:`mesh` directory of ESP-IDF examples.
Ethernet
========
.. toctree::
:maxdepth: 1
Ethernet <esp_eth>
Code examples for the Ethernet API are provided in the :example:`ethernet` directory of ESP-IDF examples.
IP Network Layer
================
.. toctree::
:maxdepth: 1
ESP-NETIF <esp_netif.rst>
.. toctree::
:hidden:
TCP/IP Adapter Migration Guide <tcpip_adapter_migration.rst>
ESP-NETIF Custom I/O Driver <esp_netif_driver.rst>
Code examples for TCP/IP socket APIs are provided in the :example:`protocols/sockets` directory of ESP-IDF examples.
The TCP/IP Adapter (legacy network interface library) has been deprecated, please consult the :doc:`/api-reference/network/tcpip_adapter_migration`
to update existing IDF applications.
Application Layer 
=================
Documentation for Application layer network protocols (above the IP Network layer) are provided in :doc:`../protocols/index`.