alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/misc_broken_link_fixes' into 'master'

Browse Source 
docs: fixed misc broken links

See merge request espressif/esp-idf!20208
This commit is contained in:
Marius Vikhammer 2022-09-19 10:58:58 +08:00
commit 29830f609d
6 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
components/esp_lcd/include/esp_lcd_panel_rgb.h
View File

@ -89,6 +89,7 @@ typedef bool (*esp_lcd_rgb_panel_vsync_cb_t)(esp_lcd_panel_handle_t panel, const
/**
* @brief Prototype for function to re-fill a bounce buffer, rather than copying from the frame buffer
*
* @param[in] panel LCD panel handle, returned from `esp_lcd_new_rgb_panel()`
* @param[in] bounce_buf Bounce buffer to write data into
* @param[in] pos_px How many pixels already were sent to the display in this frame, in other words,
* at what pixel the routine should start putting data into bounce_buf

4
docs/en/api-guides/esp-ble-mesh/ble-mesh-feature-list.rst
View File

@ -123,11 +123,11 @@ Mesh Applications
* :example_file:`Fast Provisioning Client Model Tutorial <bluetooth/esp_ble_mesh/ble_mesh_fast_provision/fast_prov_client/tutorial/BLE_Mesh_Fast_Prov_Client_Example_Walkthrough.md>`
* :example_file:`Fast Provisioning Server Model Tutorial <bluetooth/esp_ble_mesh/ble_mesh_fast_provision/fast_prov_server/tutorial/BLE_Mesh_Fast_Prov_Server_Example_Walkthrough.md>`
* :example:`Example <bluetooth/esp_ble_mesh/ble_mesh_fast_provision>`
* `Demo Video <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`__
* `Demo Video <https://dl.espressif.com/BLE/public/ESP32_BLE_Mesh_Fast_Provision.mp4>`__
* ESP-BLE-MESH and Wi-Fi Coexistence
* :example_file:`Tutorial <bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/tutorial/BLE_Mesh_WiFi_Coexist_Example_Walkthrough.md>`
* :example:`Example <bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist>`
* `Demo Video <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`__
* `Demo Video <https://dl.espressif.com/BLE/public/ESP_BLE_MESH_WIFI_Coexistence.mp4>`__
* ESP-BLE-MESH Console Commands
* :example:`Example <bluetooth/esp_ble_mesh/ble_mesh_console>`

2
docs/en/api-reference/peripherals/mcpwm.rst
View File

@ -33,7 +33,7 @@ Description of the MCPWM functionality is divided into the following sections:
- `Resource Allocation and Initialization <#resource-allocation-and-initialization>`__ - covers how to allocate various MCPWM objects, like timers, operators, comparators, generators and so on. These objects are the basis of the following IO setting and control functions.
- `Timer Operations and Events <#timer-operations-and-events>`__ - describes control functions and event callbacks that supported by the MCPWM timer.
- `Comparator Operations and Events <comparator-operations-and-events>`__ - describes control functions and event callbacks that supported by the MCPWM comparator.
- `Comparator Operations and Events <#comparator-operations-and-events>`__ - describes control functions and event callbacks that supported by the MCPWM comparator.
- `Generator Actions on Events <#generator-actions-on-events>`__ - describes how to set actions for MCPWM generators on particular events that generated by the MCPWM timer and comparators.
- `Classical PWM Waveforms and Generator Configurations <#classical-pwm-waveforms-and-generator-configurations>`__ - demonstrates some classical PWM waveforms that can be achieved by configuring generator actions.
- `Dead Time <#dead-time>`__ - describes how to set dead time for MCPWM generators.

18
docs/en/get-started/start-project.rst
View File

@ -381,31 +381,31 @@ ESP-IDF supports Python 3.7 or newer. It is recommended to upgrade your operatin
A BSP typically supports all of the hardware components provided on development board. Apart from the pinout definition and initialization functions, a BSP ships with drivers for the external components such as sensors, displays, audio codecs etc.
The BSPs are distributed via `IDF Component Manager <../api-guides/tools/idf-component-manager>`_, so they can be found in `IDF Component Registry <https://components.espressif.com>`_.
The BSPs are distributed via :doc:`IDF Component Manager </api-guides/tools/idf-component-manager>`, so they can be found in `IDF Component Registry <https://components.espressif.com>`_.
.. only:: esp32
**Here's an example of how to add ESP-WROVER-KIT BSP to your project:**
.. code-block:: bash
idf.py add-dependency esp_wrover_kit
idf.py add-dependency esp_wrover_kit
.. only:: esp32s2
**Here's an example of how to add ESP32-S2-Kaluga-Kit BSP to your project:**
.. code-block:: bash
idf.py add-dependency esp32_s2_kaluga_kit
.. only:: esp32s3
**Here's an example of how to add ESP-BOX BSP to your project:**
.. code-block:: bash
idf.py add-dependency esp-box
idf.py add-dependency esp-box
More examples of BSP usage can be found in `BSP examples folder <https://github.com/espressif/esp-bsp/tree/master/examples>`_.

4
docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-index.rst
View File

@ -231,8 +231,8 @@ ESP-BLE-MESH 演示视频
======================
* `Provisioning of ESP-BLE-MESH nodes using Smartphone App <https://download.espressif.com/BLE_MESH/Docs4Customers/esp-ble-mesh-demo.mp4>`_
* `Espressif Fast Provisioning using ESP-BLE-MESH App <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.4_Demo_Fast_Provision/ESP32_BLE_Mesh_Fast_Provision.mp4>`_
* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence <https://download.espressif.com/BLE_MESH/BLE_Mesh_Demo/V0.5_Demo_Coexistence/ESP_BLE_MESH_%26_WIFI_Coexistence.mp4>`_
* `Espressif Fast Provisioning using ESP-BLE-MESH App <https://dl.espressif.com/BLE/public/ESP32_BLE_Mesh_Fast_Provision.mp4>`_
* `Espressif ESP-BLE-MESH and Wi-Fi Coexistence <https://dl.espressif.com/BLE/public/ESP_BLE_MESH_WIFI_Coexistence.mp4>`_
ESP-BLE-MESH 常见问题手册

18
docs/zh_CN/get-started/start-project.rst
View File

@ -381,31 +381,31 @@ ESP-IDF 支持 Python 3.7 及以上版本，建议升级操作系统到最新版
一般来说，BSP 支持开发板上所有硬件组件。除了管脚定义和初始化功能外，BSP 还附带如传感器、显示器、音频编解码器等外部元件的驱动程序。
BSP 通过 `IDF 组件管理器 <../api-guides/tools/idf-component-manager>`_ 发布，您可以前往 `IDF 组件注册器 <https://components.espressif.com>`_ 进行下载。
BSP 通过 :doc:`IDF 组件管理器 </api-guides/tools/idf-component-manager>` 发布，您可以前往 `IDF 组件注册器 <https://components.espressif.com>`_ 进行下载。
.. only:: esp32
**以下示例演示了如何将 ESP-WROVER-KIT BSP 添加到项目中：**
.. code-block:: bash
idf.py add-dependency esp_wrover_kit
idf.py add-dependency esp_wrover_kit
.. only:: esp32s2
**以下示例演示了如何将 ESP32-S2-Kaluga-Kit BSP 添加到项目中：**
.. code-block:: bash
idf.py add-dependency esp32_s2_kaluga_kit
.. only:: esp32s3
**以下示例演示了如何将 ESP-BOX BSP 添加到项目中：**
.. code-block:: bash
idf.py add-dependency esp-box
idf.py add-dependency esp-box
更多有关使用 BSP 的示例，请前往 `BSP 示例文件夹 <https://github.com/espressif/esp-bsp/tree/master/examples>`_。