From 1c818620480b18f236fbd9f5475f1b5f4639a386 Mon Sep 17 00:00:00 2001 From: Linda Date: Fri, 20 Sep 2024 17:00:26 +0800 Subject: [PATCH] docs: update application examples for hmac.rst and wifi_provisioning.rst --- docs/en/api-reference/peripherals/hmac.rst | 2 +- docs/en/api-reference/provisioning/wifi_provisioning.rst | 2 +- docs/zh_CN/api-reference/peripherals/hmac.rst | 2 +- docs/zh_CN/api-reference/provisioning/wifi_provisioning.rst | 6 +++--- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/en/api-reference/peripherals/hmac.rst b/docs/en/api-reference/peripherals/hmac.rst index b000899947..641eb161b2 100644 --- a/docs/en/api-reference/peripherals/hmac.rst +++ b/docs/en/api-reference/peripherals/hmac.rst @@ -132,7 +132,7 @@ JTAG enables 2. Pass this key value when calling the :cpp:func:`esp_hmac_jtag_enable` function from the firmware. 3. To re-disable JTAG in the firmware, reset the system or call :cpp:func:`esp_hmac_jtag_disable`. -End-to-end example of soft disable and re-enable JTAG workflow: :example:`security/hmac_soft_jtag`. +For a complete workflow of soft-disabling and re-enabling JTAG, refer to :example:`security/hmac_soft_jtag`. This example demonstrates how to use HMAC to re-enable a soft-disabled JTAG interface, covering steps like generating an HMAC key, burning it to eFuse, and creating token data from the key. For more details, see **{IDF_TARGET_NAME} Technical Reference Manual** > **HMAC Accelerator (HMAC)** [`PDF <{IDF_TARGET_TRM_EN_URL}#hmac>`__]. diff --git a/docs/en/api-reference/provisioning/wifi_provisioning.rst b/docs/en/api-reference/provisioning/wifi_provisioning.rst index e9c4364177..d1e2a81f45 100644 --- a/docs/en/api-reference/provisioning/wifi_provisioning.rst +++ b/docs/en/api-reference/provisioning/wifi_provisioning.rst @@ -292,7 +292,7 @@ The customized behavior is useful for applications which want the provisioning s Application Examples -------------------- -For complete example implementation see :example:`provisioning/wifi_prov_mgr`. +- :example:`provisioning/wifi_prov_mgr` demonstrates how to use the `wifi_provisioning` manager component to configure {IDF_TARGET_NAME} as a Wi-Fi station with specified credentials, using Bluetooth LE as the default transport for provisioning. Provisioning Tools -------------------- diff --git a/docs/zh_CN/api-reference/peripherals/hmac.rst b/docs/zh_CN/api-reference/peripherals/hmac.rst index dfa39222ac..4ac7d1551b 100644 --- a/docs/zh_CN/api-reference/peripherals/hmac.rst +++ b/docs/zh_CN/api-reference/peripherals/hmac.rst @@ -132,7 +132,7 @@ HMAC 的第三种应用场景是将其作为密钥，启用软禁用的 JTAG 接 2. 从固件调用 :cpp:func:`esp_hmac_jtag_enable` 函数时，传递上一步获取的密钥值。 3. 要在固件中重新禁用 JTAG，可以重置系统，或调用 :cpp:func:`esp_hmac_jtag_disable`。 -关于如何暂时禁用以及重新启用 JTAG 的完整示例，请参考 :example:`security/hmac_soft_jtag`。 +关于如何软禁用以及重新启用 JTAG 的完整示例，请参考 :example:`security/hmac_soft_jtag`。该示例演示了如何使用 HMAC 重新启用已软禁用的 JTAG 接口，包括生成 HMAC 密钥、将其烧录到 eFuse 中以及根据密钥创建令牌数据等步骤。 更多有关详情，请参阅 **{IDF_TARGET_NAME} 技术参考手册** > **HMAC 加速器 (HMAC)** [`PDF <{IDF_TARGET_TRM_CN_URL}#hmac>`__]。 diff --git a/docs/zh_CN/api-reference/provisioning/wifi_provisioning.rst b/docs/zh_CN/api-reference/provisioning/wifi_provisioning.rst index 29caa00810..46bc7a6c7c 100644 --- a/docs/zh_CN/api-reference/provisioning/wifi_provisioning.rst +++ b/docs/zh_CN/api-reference/provisioning/wifi_provisioning.rst @@ -289,10 +289,10 @@ Wi-Fi 配网 如果需要在成功建立 Wi-Fi 连接后的某个时间再停止配网服务，应用程序可以采取定制行为。例如，如果应用程序需要设备连接到某个云服务并获取另一组凭证，继而通过自定义 protocomm 端点交换凭证，那么成功完成此操作后，可以在 protocomm 处理程序中调用 :cpp:func:`wifi_prov_mgr_stop_provisioning()` 来停止配网服务。设定适当的延迟时间可以确保 protocomm 处理程序的响应到达客户端应用程序后，才释放传输资源。 -应用程序示例 ---------------------- +应用示例 +------------------ -关于完整实现示例，请参阅 :example:`provisioning/wifi_prov_mgr`。 +- :example:`provisioning/wifi_prov_mgr` 演示了如何使用 ``wifi_provisioning`` 组件将 {IDF_TARGET_NAME} 配置为带有凭证的 Wi-Fi station，使用低功耗蓝牙作为默认传输方式。 配网工具 --------------------