Merge branch 'feature/docs_dedicated_language_folders' into 'master'
Move docs into dedicated folders for 'en' and 'zn_CN' language versions See merge request idf/esp-idf!1901
This commit is contained in:
Angus Gratton
commit
7fd74c5eaa
17
.gitignore
vendored
17
.gitignore
vendored
|
|
@ -26,15 +26,14 @@ examples/**/sdkconfig
|
|||
examples/**/sdkconfig.old
|
||||
examples/**/build
|
||||
|
||||
#Doc build artifacts
|
||||
docs/_build/
|
||||
docs/doxygen-warning-log.txt
|
||||
docs/sphinx-warning-log.txt
|
||||
docs/sphinx-warning-log-sanitized.txt
|
||||
docs/xml/
|
||||
docs/xml_in/
|
||||
docs/man/
|
||||
docs/doxygen_sqlite3.db
|
||||
# Doc build artifacts
|
||||
docs/*/_build/
|
||||
docs/*/doxygen-warning-log.txt
|
||||
docs/*/sphinx-warning-log.txt
|
||||
docs/*/sphinx-warning-log-sanitized.txt
|
||||
docs/*/xml/
|
||||
docs/*/xml_in/
|
||||
docs/*/man/
|
||||
|
||||
# Unit test app files
|
||||
tools/unit-test-app/sdkconfig
|
||||
|
|
|
|||
|
|
@ -196,19 +196,26 @@ build_docs:
|
|||
artifacts:
|
||||
when: always
|
||||
paths:
|
||||
- docs/doxygen-warning-log.txt
|
||||
- docs/sphinx-warning-log.txt
|
||||
- docs/sphinx-warning-log-sanitized.txt
|
||||
- docs/_build/html
|
||||
# English version of documentation
|
||||
- docs/en/doxygen-warning-log.txt
|
||||
- docs/en/sphinx-warning-log.txt
|
||||
- docs/en/sphinx-warning-log-sanitized.txt
|
||||
- docs/en/_build/html
|
||||
# Chinese version of documentation
|
||||
- docs/zh_CN/doxygen-warning-log.txt
|
||||
- docs/zh_CN/sphinx-warning-log.txt
|
||||
- docs/zh_CN/sphinx-warning-log-sanitized.txt
|
||||
- docs/zh_CN/_build/html
|
||||
expire_in: 1 mos
|
||||
script:
|
||||
- cd docs
|
||||
- doxygen
|
||||
# If there are Doxygen warnings, print them and bail out
|
||||
- test $(cat doxygen-warning-log.txt | wc -l) -eq 0 || ( echo "Doxygen pass had some warnings:" && cat doxygen-warning-log.txt && false )
|
||||
- cd docs/en
|
||||
- make gh-linkcheck
|
||||
- make html
|
||||
- ./check_doc_warnings.sh
|
||||
- ../check_doc_warnings.sh
|
||||
- cd ../zh_CN
|
||||
- make gh-linkcheck
|
||||
- make html
|
||||
- ../check_doc_warnings.sh
|
||||
|
||||
test_nvs_on_host:
|
||||
stage: test
|
||||
|
|
@ -361,7 +368,7 @@ push_master_to_github:
|
|||
|
||||
|
||||
deploy_docs:
|
||||
stage: deploy
|
||||
stage: assign_test
|
||||
image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
|
||||
tags:
|
||||
- deploy
|
||||
|
|
@ -381,11 +388,19 @@ deploy_docs:
|
|||
- chmod 600 ~/.ssh/id_rsa
|
||||
- echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
|
||||
- export GIT_VER=$(git describe --always)
|
||||
- cd docs/_build/
|
||||
- cd docs/en/_build/
|
||||
- mv html $GIT_VER
|
||||
- tar czvf $GIT_VER.tar.gz $GIT_VER
|
||||
- scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH
|
||||
- ssh $DOCS_SERVER -x "cd $DOCS_PATH && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
|
||||
- scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
|
||||
- ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
|
||||
- cd ../../zh_CN/_build/
|
||||
- mv html $GIT_VER
|
||||
- tar czvf $GIT_VER.tar.gz $GIT_VER
|
||||
- scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
|
||||
- ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
|
||||
# add link to preview doc
|
||||
- echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
|
||||
- echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
|
||||
|
||||
check_doc_links:
|
||||
stage: test
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ The simplest way to use the partition table is to `make menuconfig` and choose o
|
|||
|
||||
In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table.
|
||||
|
||||
For more details about partition tables and how to create custom variations, view the [`docs/api-guides/partition-tables.rst`](docs/api-guides/partition-tables.rst) file.
|
||||
For more details about partition tables and how to create custom variations, view the [`docs/en/api-guides/partition-tables.rst`](docs/en/api-guides/partition-tables.rst) file.
|
||||
|
||||
## Erasing Flash
|
||||
|
||||
|
|
|
|||
168
docs/Doxyfile
168
docs/Doxyfile
|
|
@ -24,146 +24,146 @@ INPUT = \
|
|||
##
|
||||
## Wi-Fi - API Reference
|
||||
##
|
||||
../components/esp32/include/esp_wifi.h \
|
||||
../components/esp32/include/esp_wifi_types.h \
|
||||
../components/esp32/include/esp_smartconfig.h \
|
||||
../components/esp32/include/esp_now.h \
|
||||
../../components/esp32/include/esp_wifi.h \
|
||||
../../components/esp32/include/esp_wifi_types.h \
|
||||
../../components/esp32/include/esp_smartconfig.h \
|
||||
../../components/esp32/include/esp_now.h \
|
||||
## Bluetooth - API Reference
|
||||
## Controller && VHCI
|
||||
../components/bt/include/bt.h \
|
||||
../../components/bt/include/bt.h \
|
||||
## Bluetooth COMMON
|
||||
## Issue with __attribute__
|
||||
../components/bt/bluedroid/api/include/esp_bt_defs.h \
|
||||
../components/bt/bluedroid/api/include/esp_bt_main.h \
|
||||
../components/bt/bluedroid/api/include/esp_bt_device.h \
|
||||
../../components/bt/bluedroid/api/include/esp_bt_defs.h \
|
||||
../../components/bt/bluedroid/api/include/esp_bt_main.h \
|
||||
../../components/bt/bluedroid/api/include/esp_bt_device.h \
|
||||
## Bluetooth LE
|
||||
../components/bt/bluedroid/api/include/esp_gap_ble_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_gap_ble_api.h \
|
||||
## Issue with __attribute__
|
||||
../components/bt/bluedroid/api/include/esp_gatt_defs.h \
|
||||
../components/bt/bluedroid/api/include/esp_gatts_api.h \
|
||||
../components/bt/bluedroid/api/include/esp_gattc_api.h \
|
||||
../components/bt/bluedroid/api/include/esp_blufi_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_gatt_defs.h \
|
||||
../../components/bt/bluedroid/api/include/esp_gatts_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_gattc_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_blufi_api.h \
|
||||
## Bluetooth Classic
|
||||
../components/bt/bluedroid/api/include/esp_gap_bt_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_gap_bt_api.h \
|
||||
## Issue with __attribute__
|
||||
../components/bt/bluedroid/api/include/esp_a2dp_api.h \
|
||||
../components/bt/bluedroid/api/include/esp_avrc_api.h \
|
||||
../components/bt/bluedroid/api/include/esp_spp_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_a2dp_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_avrc_api.h \
|
||||
../../components/bt/bluedroid/api/include/esp_spp_api.h \
|
||||
##
|
||||
## Ethernet - API Reference
|
||||
##
|
||||
../components/ethernet/include/esp_eth.h \
|
||||
../components/ethernet/include/eth_phy/phy.h \
|
||||
../components/ethernet/include/eth_phy/phy_tlk110.h \
|
||||
../components/ethernet/include/eth_phy/phy_lan8720.h \
|
||||
../../components/ethernet/include/esp_eth.h \
|
||||
../../components/ethernet/include/eth_phy/phy.h \
|
||||
../../components/ethernet/include/eth_phy/phy_tlk110.h \
|
||||
../../components/ethernet/include/eth_phy/phy_lan8720.h \
|
||||
##
|
||||
## Peripherals - API Reference
|
||||
##
|
||||
../components/driver/include/driver/adc.h \
|
||||
../components/driver/include/driver/dac.h \
|
||||
../components/driver/include/driver/gpio.h \
|
||||
../components/driver/include/driver/rtc_io.h \
|
||||
../components/driver/include/driver/i2c.h \
|
||||
../components/driver/include/driver/i2s.h \
|
||||
../components/driver/include/driver/ledc.h \
|
||||
../components/driver/include/driver/mcpwm.h \
|
||||
../components/driver/include/driver/pcnt.h \
|
||||
../components/driver/include/driver/rmt.h \
|
||||
../components/driver/include/driver/sigmadelta.h \
|
||||
../components/driver/include/driver/spi_common.h \
|
||||
../components/driver/include/driver/spi_master.h \
|
||||
../components/driver/include/driver/spi_slave.h \
|
||||
../components/driver/include/driver/timer.h \
|
||||
../components/driver/include/driver/touch_pad.h \
|
||||
../components/driver/include/driver/uart.h \
|
||||
../components/esp_adc_cal/include/esp_adc_cal.h \
|
||||
../components/soc/esp32/include/soc/adc_channel.h \
|
||||
../components/soc/esp32/include/soc/dac_channel.h \
|
||||
../components/soc/esp32/include/soc/touch_channel.h \
|
||||
../components/soc/esp32/include/soc/uart_channel.h \
|
||||
../components/soc/esp32/include/soc/rtc_gpio_channel.h \
|
||||
../../components/driver/include/driver/adc.h \
|
||||
../../components/driver/include/driver/dac.h \
|
||||
../../components/driver/include/driver/gpio.h \
|
||||
../../components/driver/include/driver/rtc_io.h \
|
||||
../../components/driver/include/driver/i2c.h \
|
||||
../../components/driver/include/driver/i2s.h \
|
||||
../../components/driver/include/driver/ledc.h \
|
||||
../../components/driver/include/driver/mcpwm.h \
|
||||
../../components/driver/include/driver/pcnt.h \
|
||||
../../components/driver/include/driver/rmt.h \
|
||||
../../components/driver/include/driver/sigmadelta.h \
|
||||
../../components/driver/include/driver/spi_common.h \
|
||||
../../components/driver/include/driver/spi_master.h \
|
||||
../../components/driver/include/driver/spi_slave.h \
|
||||
../../components/driver/include/driver/timer.h \
|
||||
../../components/driver/include/driver/touch_pad.h \
|
||||
../../components/driver/include/driver/uart.h \
|
||||
../../components/esp_adc_cal/include/esp_adc_cal.h \
|
||||
../../components/soc/esp32/include/soc/adc_channel.h \
|
||||
../../components/soc/esp32/include/soc/dac_channel.h \
|
||||
../../components/soc/esp32/include/soc/touch_channel.h \
|
||||
../../components/soc/esp32/include/soc/uart_channel.h \
|
||||
../../components/soc/esp32/include/soc/rtc_gpio_channel.h \
|
||||
##
|
||||
## Protocols - API Reference
|
||||
##
|
||||
../components/mdns/include/mdns.h \
|
||||
../../components/mdns/include/mdns.h \
|
||||
##
|
||||
## Storage - API Reference
|
||||
##
|
||||
## SPI Flash and Partition APIs
|
||||
../components/spi_flash/include/esp_spi_flash.h \
|
||||
../components/spi_flash/include/esp_partition.h \
|
||||
../components/bootloader_support/include/esp_flash_encrypt.h \
|
||||
../../components/spi_flash/include/esp_spi_flash.h \
|
||||
../../components/spi_flash/include/esp_partition.h \
|
||||
../../components/bootloader_support/include/esp_flash_encrypt.h \
|
||||
## SPIFFS
|
||||
../components/spiffs/include/esp_spiffs.h \
|
||||
../../components/spiffs/include/esp_spiffs.h \
|
||||
## SD/MMC Card Host
|
||||
## NOTE: for three lines below header_file.inc is not used
|
||||
../components/sdmmc/include/sdmmc_cmd.h \
|
||||
../components/driver/include/driver/sdmmc_host.h \
|
||||
../components/driver/include/driver/sdmmc_types.h \
|
||||
../components/driver/include/driver/sdspi_host.h \
|
||||
../../components/sdmmc/include/sdmmc_cmd.h \
|
||||
../../components/driver/include/driver/sdmmc_host.h \
|
||||
../../components/driver/include/driver/sdmmc_types.h \
|
||||
../../components/driver/include/driver/sdspi_host.h \
|
||||
## Non-Volatile Storage
|
||||
../components/nvs_flash/include/nvs.h \
|
||||
../components/nvs_flash/include/nvs_flash.h \
|
||||
../../components/nvs_flash/include/nvs.h \
|
||||
../../components/nvs_flash/include/nvs_flash.h \
|
||||
## Virtual Filesystem
|
||||
../components/vfs/include/esp_vfs.h \
|
||||
../components/vfs/include/esp_vfs_dev.h \
|
||||
../../components/vfs/include/esp_vfs.h \
|
||||
../../components/vfs/include/esp_vfs_dev.h \
|
||||
## FAT Filesystem
|
||||
## NOTE: for two lines below header_file.inc is not used
|
||||
../components/fatfs/src/esp_vfs_fat.h \
|
||||
../components/fatfs/src/diskio.h \
|
||||
../../components/fatfs/src/esp_vfs_fat.h \
|
||||
../../components/fatfs/src/diskio.h \
|
||||
## Wear Levelling
|
||||
../components/wear_levelling/include/wear_levelling.h \
|
||||
../../components/wear_levelling/include/wear_levelling.h \
|
||||
##
|
||||
## System - API Reference
|
||||
##
|
||||
## Memory Allocation #
|
||||
../components/heap/include/esp_heap_caps.h \
|
||||
../components/heap/include/esp_heap_trace.h \
|
||||
../components/heap/include/esp_heap_caps_init.h \
|
||||
../components/heap/include/multi_heap.h \
|
||||
../../components/heap/include/esp_heap_caps.h \
|
||||
../../components/heap/include/esp_heap_trace.h \
|
||||
../../components/heap/include/esp_heap_caps_init.h \
|
||||
../../components/heap/include/multi_heap.h \
|
||||
## Interrupt Allocation
|
||||
../components/esp32/include/esp_intr_alloc.h \
|
||||
../../components/esp32/include/esp_intr_alloc.h \
|
||||
## Watchdogs
|
||||
## NOTE: for two lines below header_file.inc is not used
|
||||
../components/esp32/include/esp_int_wdt.h \
|
||||
../components/esp32/include/esp_task_wdt.h \
|
||||
../../components/esp32/include/esp_int_wdt.h \
|
||||
../../components/esp32/include/esp_task_wdt.h \
|
||||
## Hooks
|
||||
../components/esp32/include/esp_freertos_hooks.h \
|
||||
../../components/esp32/include/esp_freertos_hooks.h \
|
||||
## Inter-Processor Call
|
||||
../components/esp32/include/esp_ipc.h \
|
||||
../../components/esp32/include/esp_ipc.h \
|
||||
## Over The Air Updates (OTA)
|
||||
../components/app_update/include/esp_ota_ops.h \
|
||||
../../components/app_update/include/esp_ota_ops.h \
|
||||
## Sleep
|
||||
## NOTE: for line below header_file.inc is not used
|
||||
../components/esp32/include/esp_sleep.h \
|
||||
../../components/esp32/include/esp_sleep.h \
|
||||
## Logging
|
||||
../components/log/include/esp_log.h \
|
||||
../../components/log/include/esp_log.h \
|
||||
## Base MAC address
|
||||
## NOTE: for line below header_file.inc is not used
|
||||
../components/esp32/include/esp_system.h \
|
||||
../../components/esp32/include/esp_system.h \
|
||||
##
|
||||
## ULP Coprocessor - API Guides
|
||||
##
|
||||
## NOTE: for line below header_file.inc is not used
|
||||
../components/ulp/include/esp32/ulp.h \
|
||||
../../components/ulp/include/esp32/ulp.h \
|
||||
##
|
||||
## Application Level Tracing - API Reference
|
||||
##
|
||||
../components/app_trace/include/esp_app_trace.h \
|
||||
../../components/app_trace/include/esp_app_trace.h \
|
||||
### Power management
|
||||
../components/esp32/include/esp_pm.h \
|
||||
../components/esp32/include/esp32/pm.h \
|
||||
../../components/esp32/include/esp_pm.h \
|
||||
../../components/esp32/include/esp32/pm.h \
|
||||
### esp_timer, High Resolution Timer
|
||||
../components/esp32/include/esp_timer.h \
|
||||
../../components/esp32/include/esp_timer.h \
|
||||
###
|
||||
### FreeRTOS
|
||||
###
|
||||
../components/freertos/include/freertos/task.h \
|
||||
../components/freertos/include/freertos/queue.h \
|
||||
../components/freertos/include/freertos/semphr.h \
|
||||
../components/freertos/include/freertos/timers.h \
|
||||
../components/freertos/include/freertos/event_groups.h \
|
||||
../components/freertos/include/freertos/ringbuf.h
|
||||
../../components/freertos/include/freertos/task.h \
|
||||
../../components/freertos/include/freertos/queue.h \
|
||||
../../components/freertos/include/freertos/semphr.h \
|
||||
../../components/freertos/include/freertos/timers.h \
|
||||
../../components/freertos/include/freertos/event_groups.h \
|
||||
../../components/freertos/include/freertos/ringbuf.h
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,18 @@
|
|||
# Documentation Source Folder
|
||||
|
||||
This folder contains source files of [ESP-IDF documentation](https://esp-idf.readthedocs.io/).
|
||||
This folder contains source files of **ESP-IDF documentation** avialable in [English](https://esp-idf.readthedocs.io/en/latest/) and [中文](https://esp-idf.readthedocs.io/zh_CN/latest/).
|
||||
|
||||
The sources do not render well in GitHub and some information is not visible at all.
|
||||
|
||||
Use actual documentation generated instantly on each commit:
|
||||
Use actual documentation generated within about 20 minutes on each commit:
|
||||
|
||||
* Main server: https://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
|
||||
* Mirror: https://dl.espressif.com/doc/esp-idf/latest/
|
||||
## English
|
||||
|
||||
* Main server: https://esp-idf.readthedocs.io/en/latest/ or http://esp-idf.readthedocs.io/en/latest/
|
||||
* Mirror: https://espressif-docs.readthedocs-hosted.com/projects/esp-idf/en/latest/
|
||||
* Latest docs mirror: https://dl.espressif.com/doc/esp-idf/latest/
|
||||
|
||||
## 中文
|
||||
|
||||
* Main server: https://esp-idf.readthedocs.io/zh_CN/latest/ or http://esp-idf.readthedocs.io/zh_CN/latest/
|
||||
* Mirror: https://espressif-docs.readthedocs-hosted.com/projects/esp-idf/zh_CN/latest/
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../components/ulp/README.rst
|
||||
|
|
@ -2,8 +2,7 @@
|
|||
#
|
||||
# Check for Documentation warnings:
|
||||
# doxygen-warning-log.txt should be an empty file
|
||||
# sphinx-warning-log.txt should only contain (fuzzy) matches to sphinx-known-warnings.txt
|
||||
cd "$(dirname $0)"
|
||||
# sphinx-warning-log.txt should only contain (fuzzy) matches to ../sphinx-known-warnings.txt
|
||||
RESULT=0
|
||||
STARS='***************************************************'
|
||||
|
||||
|
|
@ -22,19 +21,19 @@ sed -r 's:\x1B\[[0-9;]*[mK]::g' sphinx-warning-log.txt | \
|
|||
sed -E "s~${IDF_PATH}~\${IDF_PATH}~" | \
|
||||
sed -E "s/:[0-9]+:/:line:/" > sphinx-warning-log-sanitized.txt
|
||||
|
||||
# diff sanitized warnings, ignoring lines which only appear in sphinx-known-warnings.txt
|
||||
# diff sanitized warnings, ignoring lines which only appear in ../sphinx-known-warnings.txt
|
||||
|
||||
# format is to display only lines new or changed in second argument
|
||||
DIFF_FORMAT="--unchanged-line-format= --old-line-format= --new-line-format=%L"
|
||||
|
||||
SPHINX_WARNINGS=$(diff $DIFF_FORMAT sphinx-known-warnings.txt sphinx-warning-log-sanitized.txt)
|
||||
SPHINX_WARNINGS=$(diff $DIFF_FORMAT ../sphinx-known-warnings.txt sphinx-warning-log-sanitized.txt)
|
||||
if ! [ -z "$SPHINX_WARNINGS" ]; then
|
||||
echo "$STARS"
|
||||
echo "Build failed due to new/different Sphinx warnings:"
|
||||
echo "$SPHINX_WARNINGS"
|
||||
echo "$STARS"
|
||||
RESULT=1
|
||||
echo "(Check files sphinx-known-warnings.txt and sphinx-warning-log.txt for full details.)"
|
||||
echo "(Check files ../sphinx-known-warnings.txt and sphinx-warning-log.txt for full details.)"
|
||||
fi
|
||||
|
||||
exit $RESULT
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../CONTRIBUTING.rst
|
||||
|
|
@ -5,7 +5,7 @@ This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the
|
|||
|
||||
The ESP32 is 2.4 GHz Wi-Fi and Bluetooth combo, 32 bit dual core chip with 600 DMIPS processing power.
|
||||
|
||||
.. figure:: _static/about-doc.png
|
||||
.. figure:: ../_static/about-doc.png
|
||||
:align: center
|
||||
:alt: Espressif IoT Integrated Development Framework
|
||||
:figclass: align-center
|
||||
|
|
@ -15,7 +15,7 @@ Developers can use this library to send application specific state of execution
|
|||
|
||||
Tracing components when working over JTAG interface are shown in the figure below.
|
||||
|
||||
.. figure:: ../_static/app_trace-overview.jpg
|
||||
.. figure:: ../../_static/app_trace-overview.jpg
|
||||
:align: center
|
||||
:alt: Tracing Components when Working Over JTAG
|
||||
:figclass: align-center
|
||||
|
|
@ -208,7 +208,7 @@ where each element of the array is a linked list. Each linked list is of type
|
|||
Ready state. The following diagram illustrates the ``pxReadyTasksList``
|
||||
structure.
|
||||
|
||||
.. figure:: ../_static/freertos-ready-task-list.png
|
||||
.. figure:: ../../_static/freertos-ready-task-list.png
|
||||
:align: center
|
||||
:alt: Vanilla FreeRTOS Ready Task List Structure
|
||||
|
||||
|
|
@ -226,7 +226,7 @@ calls the scheduler, it is able to look at the ``xCoreID`` member of each TCB
|
|||
in the list to determine if a task is allowed to run on calling the core. The
|
||||
ESP-IDF FreeRTOS ``pxReadyTasksList`` is illustrated below.
|
||||
|
||||
.. figure:: ../_static/freertos-ready-task-list-smp.png
|
||||
.. figure:: ../../_static/freertos-ready-task-list-smp.png
|
||||
:align: center
|
||||
:alt: ESP-IDF FreeRTOS Ready Task List Structure
|
||||
|
||||
|
|
@ -246,7 +246,7 @@ the previous scheduler call from the other core would not be considered on the
|
|||
current scheduler call. This issue is demonstrated in the following
|
||||
illustration.
|
||||
|
||||
.. figure:: ../_static/freertos-ready-task-list-smp-pxIndex.png
|
||||
.. figure:: ../../_static/freertos-ready-task-list-smp-pxIndex.png
|
||||
:align: center
|
||||
:alt: ESP-IDF pxIndex Behavior
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ Windows
|
|||
|
||||
5. Check the list of devices that should contain two WROVER specific USB entries: "Dual RS232-HS (Interface 0)" and "Dual RS232-HS (Interface 1)". The driver name would be "FTDIBUS (vxxxx)" and USB ID: 0403 6010.
|
||||
|
||||
.. figure:: ../../_static/jtag-usb-configuration-zadig.jpg
|
||||
.. figure:: ../../../_static/jtag-usb-configuration-zadig.jpg
|
||||
:align: center
|
||||
:alt: Configuration of JTAG USB driver in Zadig tool
|
||||
:figclass: align-center
|
||||
|
|
@ -12,7 +12,7 @@ Eclipse
|
|||
|
||||
Verify if your target is ready and loaded with :example:`get-started/blink` example. Configure and start debugger following steps in section :ref:`jtag-debugging-using-debugger-eclipse`. Pick up where target was left by debugger, i.e. having the application halted at breakpoint established at ``app_main()``.
|
||||
|
||||
.. figure:: ../../_static/debug-perspective.jpg
|
||||
.. figure:: ../../../_static/debug-perspective.jpg
|
||||
:align: center
|
||||
:alt: Debug Perspective in Eclipse
|
||||
:figclass: align-center
|
||||
|
|
@ -39,7 +39,7 @@ Navigating though the code, call stack and threads
|
|||
|
||||
When the target is halted, debugger shows the list of threads in "Debug" window. The line of code where program halted is highlighted in another window below, as shown on the following picture. The LED stops blinking.
|
||||
|
||||
.. figure:: ../../_static/debugging-target-halted.jpg
|
||||
.. figure:: ../../../_static/debugging-target-halted.jpg
|
||||
:align: center
|
||||
:alt: Target halted during debugging
|
||||
:figclass: align-center
|
||||
|
|
@ -50,7 +50,7 @@ Specific thread where the program halted is expanded showing the call stack. It
|
|||
|
||||
By expanding threads you can navigate throughout the application. Expand Thread #5 that contains much longer call stack. You will see there, besides function calls, numbers like ``0x4000000c``. They represent addresses of binary code not provided in source form.
|
||||
|
||||
.. figure:: ../../_static/debugging-navigate-through-the-stack.jpg
|
||||
.. figure:: ../../../_static/debugging-navigate-through-the-stack.jpg
|
||||
:align: center
|
||||
:alt: Navigate through the call stack
|
||||
:figclass: align-center
|
||||
|
|
@ -71,7 +71,7 @@ When debugging, we would like to be able to stop the application at critical lin
|
|||
|
||||
Let's establish two breakpoints when the state of LED changes. Basing on code listing above, this happens at lines 33 and 36. To do so, hold the "Control" on the keyboard and double clink on number ``33`` in file ``blink.c`` file. A dialog will open where you can confirm your selection by pressing "OK" button. If you do not like to see the dialog just double click the line number. Set another breakpoint in line 36.
|
||||
|
||||
.. figure:: ../../_static/debugging-setting-breakpoint.jpg
|
||||
.. figure:: ../../../_static/debugging-setting-breakpoint.jpg
|
||||
:align: center
|
||||
:alt: Setting a breakpoint
|
||||
:figclass: align-center
|
||||
|
|
@ -80,7 +80,7 @@ Let's establish two breakpoints when the state of LED changes. Basing on code li
|
|||
|
||||
Information how many breakpoints are set and where is shown in window "Breakpoints" on top right. Click "Show Breakpoints Supported by Selected Target" to refresh this list. Besides the two just set breakpoints the list may contain temporary breakpoint at function ``app_main()`` established at debugger start. As maximum two breakpoints are allowed (see :ref:`jtag-debugging-tip-breakpoints`), you need to delete it, or debugging will fail.
|
||||
|
||||
.. figure:: ../../_static/debugging-three-breakpoints-set.jpg
|
||||
.. figure:: ../../../_static/debugging-three-breakpoints-set.jpg
|
||||
:align: center
|
||||
:alt: Three breakpoints are set / maximum two are allowed
|
||||
:figclass: align-center
|
||||
|
|
@ -103,7 +103,7 @@ When debugging, you may resume application and enter code waiting for some event
|
|||
|
||||
To check it, delete all breakpoints and click "Resume". Then click "Suspend". Application will be halted at some random point and LED will stop blinking. Debugger will expand tread and highlight the line of code where application halted.
|
||||
|
||||
.. figure:: ../../_static/debugging-target-halted-manually.jpg
|
||||
.. figure:: ../../../_static/debugging-target-halted-manually.jpg
|
||||
:align: center
|
||||
:alt: Target halted manually
|
||||
:figclass: align-center
|
||||
|
|
@ -124,7 +124,7 @@ Before being able to demonstrate this functionality, using information discussed
|
|||
|
||||
Resume program by entering pressing F8 and let it halt. Now press "Step Over (F6)", one by one couple of times, to see how debugger is stepping one program line at a time.
|
||||
|
||||
.. figure:: ../../_static/debugging-step-over.jpg
|
||||
.. figure:: ../../../_static/debugging-step-over.jpg
|
||||
:align: center
|
||||
:alt: Stepping through the code with "Step Over (F6)"
|
||||
:figclass: align-center
|
||||
|
|
@ -133,7 +133,7 @@ Resume program by entering pressing F8 and let it halt. Now press "Step Over (F6
|
|||
|
||||
If you press "Step Into (F5)" instead, then debugger will step inside subroutine calls.
|
||||
|
||||
.. figure:: ../../_static/debugging-step-into.jpg
|
||||
.. figure:: ../../../_static/debugging-step-into.jpg
|
||||
:align: center
|
||||
:alt: Stepping through the code with "Step Into (F5)"
|
||||
:figclass: align-center
|
||||
|
|
@ -158,7 +158,7 @@ Being in the same ``blink.c`` project as before, set two breakpoints right after
|
|||
|
||||
Now resume program by pressing F8 and observe "Monitor" tab.
|
||||
|
||||
.. figure:: ../../_static/debugging-memory-location-on.jpg
|
||||
.. figure:: ../../../_static/debugging-memory-location-on.jpg
|
||||
:align: center
|
||||
:alt: Observing memory location 0x3FF44004 changing one bit to ON"
|
||||
:figclass: align-center
|
||||
|
|
@ -167,7 +167,7 @@ Now resume program by pressing F8 and observe "Monitor" tab.
|
|||
|
||||
You should see one bit being flipped over at memory location ``0x3FF44004`` (and LED changing the state) each time F8 is pressed.
|
||||
|
||||
.. figure:: ../../_static/debugging-memory-location-off.jpg
|
||||
.. figure:: ../../../_static/debugging-memory-location-off.jpg
|
||||
:align: center
|
||||
:alt: Observing memory location 0x3FF44004 changing one bit to ON"
|
||||
:figclass: align-center
|
||||
|
|
@ -192,7 +192,7 @@ In next step, in the window with "Breakpoints", click the "Expressions" tab. If
|
|||
|
||||
Resume program execution by pressing F8. Each time the program is halted you will see ``i`` value being incremented.
|
||||
|
||||
.. figure:: ../../_static/debugging-watch-variable.jpg
|
||||
.. figure:: ../../../_static/debugging-watch-variable.jpg
|
||||
:align: center
|
||||
:alt: Watching program variable "i"
|
||||
:figclass: align-center
|
||||
|
|
@ -210,7 +210,7 @@ Setting conditional breakpoints
|
|||
|
||||
Here comes more interesting part. You may set a breakpoint to halt the program execution, if certain condition is satisfied. Right click on the breakpoint to open a context menu and select "Breakpoint Properties". Change the selection under "Type:" to "Hardware" and enter a "Condition:" like ``i == 2``.
|
||||
|
||||
.. figure:: ../../_static/debugging-setting-conditional-breakpoint.jpg
|
||||
.. figure:: ../../../_static/debugging-setting-conditional-breakpoint.jpg
|
||||
:align: center
|
||||
:alt: Setting a conditional breakpoint
|
||||
:figclass: align-center
|
||||
|
|
@ -48,7 +48,7 @@ How it Works?
|
|||
|
||||
The key software and hardware to perform debugging of ESP32 with OpenOCD over JTAG (Joint Test Action Group) interface is presented below and includes **xtensa-esp32-elf-gdb debugger**, **OpenOCD on chip debugger** and **JTAG adapter** connected to **ESP32** target.
|
||||
|
||||
.. figure:: ../../_static/jtag-debugging-overview.jpg
|
||||
.. figure:: ../../../_static/jtag-debugging-overview.jpg
|
||||
:align: center
|
||||
:alt: JTAG debugging - overview diagram
|
||||
:figclass: align-center
|
||||
|
|
@ -100,13 +100,13 @@ Pick up your OS below and follow provided instructions to setup OpenOCD.
|
|||
| `Windows`_ | `Linux`_ | `Mac OS`_ |
|
||||
+-------------------+-------------------+-------------------+
|
||||
|
||||
.. |windows-logo| image:: ../../_static/windows-logo.png
|
||||
.. |windows-logo| image:: ../../../_static/windows-logo.png
|
||||
:target: ../jtag-debugging/setup-openocd-windows.html
|
||||
|
||||
.. |linux-logo| image:: ../../_static/linux-logo.png
|
||||
.. |linux-logo| image:: ../../../_static/linux-logo.png
|
||||
:target: ../jtag-debugging/setup-openocd-linux.html
|
||||
|
||||
.. |macos-logo| image:: ../../_static/macos-logo.png
|
||||
.. |macos-logo| image:: ../../../_static/macos-logo.png
|
||||
:target: ../jtag-debugging/setup-openocd-macos.html
|
||||
|
||||
.. _Windows: ../jtag-debugging/setup-openocd-windows.html
|
||||
|
|
@ -28,7 +28,7 @@ Once installation is complete, configure debugging session following steps below
|
|||
|
||||
A sample window with settings entered in points 1 - 5 is shown below.
|
||||
|
||||
.. figure:: ../../_static/hw-debugging-main-tab.jpg
|
||||
.. figure:: ../../../_static/hw-debugging-main-tab.jpg
|
||||
:align: center
|
||||
:alt: Configuration of GDB Hardware Debugging - Main tab
|
||||
:figclass: align-center
|
||||
|
|
@ -41,7 +41,7 @@ Once installation is complete, configure debugging session following steps below
|
|||
|
||||
Configuration entered in points 6 and 7 is shown on the following picture.
|
||||
|
||||
.. figure:: ../../_static/hw-debugging-debugger-tab.jpg
|
||||
.. figure:: ../../../_static/hw-debugging-debugger-tab.jpg
|
||||
:align: center
|
||||
:alt: Configuration of GDB Hardware Debugging - Debugger tab
|
||||
:figclass: align-center
|
||||
|
|
@ -67,7 +67,7 @@ Once installation is complete, configure debugging session following steps below
|
|||
|
||||
Configuration described in points 8 - 11 is shown below.
|
||||
|
||||
.. figure:: ../../_static/hw-debugging-startup-tab.jpg
|
||||
.. figure:: ../../../_static/hw-debugging-startup-tab.jpg
|
||||
:align: center
|
||||
:alt: Configuration of GDB Hardware Debugging - Startup tab
|
||||
:figclass: align-center
|
||||
|
|
@ -80,7 +80,7 @@ Once installation is complete, configure debugging session following steps below
|
|||
|
||||
Once all 1 - 12 configuration steps are satisfied, the new Eclipse perspective called "Debug" will open as shown on example picture below.
|
||||
|
||||
.. figure:: ../../_static/debug-perspective.jpg
|
||||
.. figure:: ../../../_static/debug-perspective.jpg
|
||||
:align: center
|
||||
:alt: Debug Perspective in Eclipse
|
||||
:figclass: align-center
|
||||
1
docs/en/api-guides/ulp_macros.rst
Normal file
1
docs/en/api-guides/ulp_macros.rst
Normal file
|
|
@ -0,0 +1 @@
|
|||
.. include:: ../../../components/ulp/README.rst
|
||||
|
|
@ -90,7 +90,7 @@ Minimizing Noise
|
|||
|
||||
The ESP32 ADC can be sensitive to noise leading to large discrepancies in ADC readings. To minimize noise, users may connect a 0.1uF capacitor to the ADC input pad in use. Multisampling may also be used to further mitigate the effects of noise.
|
||||
|
||||
.. figure:: ../../_static/adc-noise-graph.jpg
|
||||
.. figure:: ../../../_static/adc-noise-graph.jpg
|
||||
:align: center
|
||||
:alt: ADC noise mitigation
|
||||
|
||||
|
|
@ -101,7 +101,7 @@ ADC Calibration
|
|||
|
||||
The :component_file:`esp_adc_cal/include/esp_adc_cal.h` API provides functions to correct for differences in measured voltages caused by variation of ADC reference voltages (Vref) between chips. Per design the ADC reference voltage is 1100mV, however the true reference voltage can range from 1000mV to 1200mV amongst different ESP32s.
|
||||
|
||||
.. figure:: ../../_static/adc-vref-graph.jpg
|
||||
.. figure:: ../../../_static/adc-vref-graph.jpg
|
||||
:align: center
|
||||
:alt: ADC reference voltage comparison
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ Getting LEDC to work on specific channel in either :ref:`high or low speed mode
|
|||
|
||||
In an optional step it is also possible to set up an interrupt on the fade end.
|
||||
|
||||
.. figure:: ../../_static/ledc-api-settings.jpg
|
||||
.. figure:: ../../../_static/ledc-api-settings.jpg
|
||||
:align: center
|
||||
:alt: Key Settings of LED PWM Controller's API
|
||||
:figclass: align-center
|
||||
|
|
@ -23,13 +23,13 @@ The signal, which consists of a series of pulses, is generated by RMT's transmit
|
|||
|
||||
a [style=none, width=100, label="{11,high,7,low},\n{5,high,5,low},\n..."]
|
||||
b [label="Waveform\nGenerator"]
|
||||
c [style=none, label="", background="_static/rmt-waveform.png"]
|
||||
c [style=none, label="", background="../_static/rmt-waveform.png"]
|
||||
d [shape=beginpoint, label="mod"]
|
||||
e [style=none, width=60, height=40, label="Carrier\nenable"]
|
||||
f [label="Carrier\nGenerator"]
|
||||
g [style=none, label="", background="_static/rmt-carrier.png"]
|
||||
g [style=none, label="", background="../_static/rmt-carrier.png"]
|
||||
h [shape=none]
|
||||
o [style=none, label="", background="_static/rmt-waveform-modulated.png"]
|
||||
o [style=none, label="", background="../_static/rmt-waveform-modulated.png"]
|
||||
|
||||
group {
|
||||
label = Input
|
||||
|
|
@ -63,7 +63,7 @@ The reverse operation is performed by the receiver, where a series of pulses is
|
|||
e -- f;
|
||||
f -> b [folded];
|
||||
|
||||
a [style=none, label="", background="_static/rmt-waveform.png"]
|
||||
a [style=none, label="", background="../_static/rmt-waveform.png"]
|
||||
b [label=Filter]
|
||||
c [label="Edge\nDetect"]
|
||||
d [style=none, width=100, label="{11,high,7,low},\n{5,high,5,low},\n..."]
|
||||
|
|
@ -77,7 +77,7 @@ The following summarizes available measurement parameters and corresponding 'set
|
|||
|
||||
Relationship between voltage range (high / low reference voltages), speed (slope) and measure time is shown on figure below.
|
||||
|
||||
.. figure:: ../../_static/touch_pad-measurement-parameters.jpg
|
||||
.. figure:: ../../../_static/touch_pad-measurement-parameters.jpg
|
||||
:align: center
|
||||
:alt: Touch Pad - relationship between measurement parameters
|
||||
:figclass: align-center
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.. include:: ../../../components/nvs_flash/README.rst
|
||||
.. include:: ../../../../components/nvs_flash/README.rst
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.. include:: ../../../components/spi_flash/README.rst
|
||||
.. include:: ../../../../components/spi_flash/README.rst
|
||||
|
||||
See also
|
||||
--------
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
.. include:: ../../../components/vfs/README.rst
|
||||
.. include:: ../../../../components/vfs/README.rst
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
.. _Instructions: ../../template.html
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.. include:: ../../../components/wear_levelling/README.rst
|
||||
.. include:: ../../../../components/wear_levelling/README.rst
|
||||
|
||||
See also
|
||||
--------
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.. include:: ../../../components/log/README.rst
|
||||
.. include:: ../../../../components/log/README.rst
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue