From f73e8b2320d75fa849763c7eb0ea38d753209b26 Mon Sep 17 00:00:00 2001 From: zhangyanjiao Date: Wed, 26 Mar 2025 11:34:32 +0800 Subject: [PATCH] fix(docs): update the migration-guides for espnow change --- docs/en/migration-guides/release-5.x/5.5/index.rst | 1 + docs/en/migration-guides/release-5.x/5.5/wifi.rst | 10 ++++++++++ docs/zh_CN/migration-guides/release-5.x/5.5/index.rst | 1 + docs/zh_CN/migration-guides/release-5.x/5.5/wifi.rst | 11 +++++++++++ 4 files changed, 23 insertions(+) create mode 100644 docs/en/migration-guides/release-5.x/5.5/wifi.rst create mode 100644 docs/zh_CN/migration-guides/release-5.x/5.5/wifi.rst diff --git a/docs/en/migration-guides/release-5.x/5.5/index.rst b/docs/en/migration-guides/release-5.x/5.5/index.rst index ac24442018..dedee8fed4 100644 --- a/docs/en/migration-guides/release-5.x/5.5/index.rst +++ b/docs/en/migration-guides/release-5.x/5.5/index.rst @@ -9,3 +9,4 @@ Migration from 5.4 to 5.5 system peripherals protocols + wifi diff --git a/docs/en/migration-guides/release-5.x/5.5/wifi.rst b/docs/en/migration-guides/release-5.x/5.5/wifi.rst new file mode 100644 index 0000000000..cdc8c27991 --- /dev/null +++ b/docs/en/migration-guides/release-5.x/5.5/wifi.rst @@ -0,0 +1,10 @@ +Wi-Fi +====== + +:link_to_translation:`zh_CN:[中文]` + + +Breaking Changes +~~~~~~~~~~~~~~~~ + +The parameters for the ESP-NOW sending data callback function has changed from ``uint8_t *mac_addr`` to ``esp_now_send_info_t *tx_info``. diff --git a/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst index c6dfda0abb..695fb35269 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst @@ -9,3 +9,4 @@ system peripherals protocols + wifi diff --git a/docs/zh_CN/migration-guides/release-5.x/5.5/wifi.rst b/docs/zh_CN/migration-guides/release-5.x/5.5/wifi.rst new file mode 100644 index 0000000000..53389e5f2f --- /dev/null +++ b/docs/zh_CN/migration-guides/release-5.x/5.5/wifi.rst @@ -0,0 +1,11 @@ +Wi-Fi +===== + +:link_to_translation:`en:[English]` + + +重大更新 +~~~~~~~~ + +ESP-NOW 的发包回调函数的参数从 ``uint8_t *mac_addr`` 变为 ``esp_now_send_info_t *tx_info``。 +