Feat/bsp ethernet kit a v12#677
Open
guo-max wants to merge 5 commits into
Open
Conversation
guo-max
requested review from
Copilot and
finger563
and removed request for
Copilot
July 24, 2026 20:09
|
✅Static analysis result - no issues found! ✅ |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new ESPP Board Support Package (BSP) component for the Espressif ESP32-Ethernet-Kit A V1.2, including documentation and an example project, to make it easier to bring up Ethernet in DHCP client or DHCP server mode on this commonly used test board.
Changes:
- Introduces the new
components/esp32-ethernet-kitcomponent implementing Ethernet init + DHCP client/server support. - Adds an ESP-IDF example app (with Kconfig options) demonstrating client/server modes.
- Integrates the board/component into the documentation set (Sphinx pages + Doxygen inputs/example paths).
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/en/dev_boards/espressif/index.rst | Adds the new board page to the Espressif dev boards toctree. |
| doc/en/dev_boards/espressif/esp32_ethernet_kit.rst | New board documentation page describing DHCP modes, warnings, and pin mapping. |
| doc/en/dev_boards/espressif/esp32_ethernet_kit_example.md | Adds doc page that includes the example README. |
| doc/Doxyfile | Registers the new component header and example for Doxygen/Sphinx API integration. |
| components/esp32-ethernet-kit/src/esp32-ethernet-kit.cpp | Implements Ethernet bring-up, event handling, and DHCP client/server behavior. |
| components/esp32-ethernet-kit/include/esp32-ethernet-kit.hpp | Public BSP API for initializing Ethernet and receiving link/IP callbacks. |
| components/esp32-ethernet-kit/README.md | Component-level README documenting capabilities and usage snippets. |
| components/esp32-ethernet-kit/idf_component.yml | ESP Component Manager manifest for publishing/consuming the component. |
| components/esp32-ethernet-kit/CMakeLists.txt | Component build registration and dependencies for ESP-IDF. |
| components/esp32-ethernet-kit/example/CMakeLists.txt | Example project CMake configuration wiring in repository components. |
| components/esp32-ethernet-kit/example/sdkconfig.defaults | Example defaults enabling Ethernet + PHY and related settings. |
| components/esp32-ethernet-kit/example/README.md | Example README with build/flash instructions. |
| components/esp32-ethernet-kit/example/main/CMakeLists.txt | Example “main” component registration for ESP-IDF build. |
| components/esp32-ethernet-kit/example/main/Kconfig.projbuild | Kconfig options for selecting DHCP mode and server static IP parameters. |
| components/esp32-ethernet-kit/example/main/esp32_ethernet_kit_example.cpp | Example app demonstrating DHCP client or DHCP server operation. |
Comment on lines
+64
to
+67
| struct ServerConfig { | ||
| esp_netif_ip_info_t ip_info; ///< IP / netmask / gateway; zero → 192.168.4.1/24 | ||
| client_ip_callback_t on_client_assigned; ///< Called each time a client is assigned an IP | ||
| }; |
Comment on lines
+175
to
+179
| ret = esp_netif_init(); | ||
| if (ret != ESP_OK) { | ||
| logger_.error("esp_netif_init failed: {}", esp_err_to_name(ret)); | ||
| return false; | ||
| } |
Comment on lines
106
to
109
| $(PROJECT_PATH)/components/esp32-timer-cam/example/main/esp_timer_cam_example.cpp \ | ||
| $(PROJECT_PATH)/components/esp32-ethernet-kit/example/main/esp32_ethernet_kit_example.cpp \ | ||
| $(PROJECT_PATH)/components/esp32-p4-function-ev-board/example/main/esp32_p4_function_ev_board_example.cpp \ | ||
| $(PROJECT_PATH)/components/esp-box/example/main/esp_box_example.cpp \ |
Comment on lines
258
to
261
| $(PROJECT_PATH)/components/esp32-timer-cam/include/esp32-timer-cam.hpp \ | ||
| $(PROJECT_PATH)/components/esp32-ethernet-kit/include/esp32-ethernet-kit.hpp \ | ||
| $(PROJECT_PATH)/components/esp32-p4-function-ev-board/include/esp32-p4-function-ev-board.hpp \ | ||
| $(PROJECT_PATH)/components/esp-box/include/esp-box.hpp \ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
bsp for Esp32-Ethernet-kit-A-v1.2
Motivation and Context
Lots of rtps_embedded example use this board to test. Better to have a bsp for it.
How has this been tested?
Tested with the esp32-ethernt-kit-A-V1.2 as a DHCP server and connect it to a ethernet switch. Connect another dhcp client to the switch and this dev-kit (dhcp Server) should assign a new ip to the client.
Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):
Types of changes
Checklist:
Software
.github/workflows/build.ymlfile to add my new test to the automated cloud build github action.Hardware