espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2026-05-05 12:25:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/update_application_examples_ethernet_network' into 'master'

Browse Source 
docs: update application examples for esp_eth.rst

See merge request espressif/esp-idf!33688
This commit is contained in:
Zhang Xiao Yan
2024-09-24 18:26:56 +08:00
parent c092de665a 89d7bbdee6
commit 370a735e46
2 changed files with 33 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/network/esp_eth.rst
+17 -5
View File
@@ -534,11 +534,23 @@ One thing that should be kept in mind is that the pause frame ability is adverti
Application Examples
--------------------
* Ethernet basic example: :example:`ethernet/basic`
* Ethernet iperf example: :example:`ethernet/iperf`
* Ethernet to Wi-Fi AP "router": :example:`network/eth2ap`
* Wi-Fi station to Ethernet "bridge": :example:`network/sta2eth`
* Most protocol examples should also work for Ethernet: :example:`protocols`
* :example:`ethernet/basic` demonstrates how to use the Ethernet driver, covering driver installation, attaching it to `esp_netif`, sending DHCP requests, and obtaining a pingable IP address.
* :example:`ethernet/iperf` demonstrates how to use the Ethernet capabilities to measure the throughput/bandwidth using iPerf.
* :example:`ethernet/enc28j60` demonstrates how to use the ENC28J60 Ethernet controller by integrating a new Ethernet MAC driver into the `esp_eth` component and attaching it to the TCP/IP stack.
* :example:`network/vlan_support` demonstrates how to create virtual network interfaces over Ethernet, including VLAN and non-VLAN interfaces.
* :example:`network/sta2eth` demonstrates how to create a 1-to-1 bridge using a Wi-Fi station and a wired interface such as Ethernet or USB.
* :example:`network/simple_sniffer` demonstrates how to use Wi-Fi and Ethernet in sniffer mode to capture packets and save them in PCAP format.
* :example:`network/eth2ap` demonstrates how to implement a bridge that forwards packets between an Ethernet port and a Wi-Fi AP interface. It uses {IDF_TARGET_NAME} to create a 1-to-many connection between Ethernet and Wi-Fi without initializing the TCP/IP stack.
* :example:`network/bridge` demonstrates how to use the LwIP IEEE 802.1D bridge to forward Ethernet frames between multiple network segments based on MAC addresses.
* Most protocol examples should also work for Ethernet: :example:`protocols`.
.. ------------------------------ Advanced Topics -------------------------------