Commit Graph
100 Commits
Author SHA1 Message Date
Linda 9655032d2b docs: update the API description for esp-wifi_scan_get_ap_records 2025-02-27 15:12:01 +08:00
Linda 6ba7a20e9f docs: add esp_wifi_types_generic.h to esp_wifi.rst 2024-11-15 16:35:50 +08:00
Linda 419b646d17 docs: fix a typo in gpio.rst 2024-09-24 15:56:21 +08:00
Linda 4e4f23dde0 This is a combination of 2 commits.
docs: update startup.rst description for single-core chip support
2024-09-11 10:44:04 +08:00
Linda 2bb7b51449 docs: delete unavailable document links for ESP32-P4 2024-08-28 15:57:42 +08:00
Linda 234a1371b1 docs: fix a typo in adc_oneshot 2024-08-22 10:18:59 +08:00
Linda 124c7192b8 docs: delete user guides of ESP32-DevKitC, ESP-WROVER-KIT and ESP32-PICO-DevKitM-2 2024-08-20 14:48:43 +08:00
Linda c60e627bba docs: Migrate user guides of ESP32-C3-DevKitM and ESP32-C3-DevKitC to esp-dev-kits 2024-07-01 15:26:49 +08:00
Zhang Xiao Yan 36c860a588 Merge branch 'docs/add_description_configure_usb_pins_to_gpio' into 'master'
docs: add code snippet showing how to configure usb pins to gpio

See merge request espressif/esp-idf!30236
2024-04-17 14:03:07 +08:00
Linda 3b7e16f182 docs: add code snippet showing how to configure usb pins to gpio 2024-04-16 14:53:12 +08:00
Zhang Xiao Yan 69972b2a1e Merge branch 'docs/update_deep_sleep_stub' into 'master'
docs: update api-guides/deep-sleep-stub

See merge request espressif/esp-idf!25258
2024-04-15 12:45:35 +08:00
Linda 2dc0be81fb docs: update api-guides/deep-sleep-stub 2024-04-15 11:43:19 +08:00
Zhang Xiao Yan 4018c719e9 Merge branch 'docs/add_example_code_snippet_ota' into 'master'
docs: add code snippet for checking OTA state

See merge request espressif/esp-idf!30157
2024-04-11 18:23:20 +08:00
Linda b4be134ca3 docs: add code snippet for checking OTA state 2024-04-11 16:04:07 +08:00
Zhang Xiao Yan ee2fbbc7aa Merge branch 'docs/update_usb_jtag_gpio_description' into 'master'
docs: update description of USB-JTAG GPIOs

See merge request espressif/esp-idf!30159
2024-04-10 18:08:55 +08:00
Linda 28f12230ae docs: update description of USB-JTAG GPIOs 2024-04-10 15:58:01 +08:00
Zhang Xiao Yan 96c81c87bf Merge branch 'docs/add_two_terms_flash_psram_config' into 'master'
docs: add two terms to api-guides/flash_psram_config

See merge request espressif/esp-idf!30100
2024-04-09 18:45:06 +08:00
Zhang Xiao Yan d7de67bd36 Merge branch 'docs/update_description_uart_interrupt' into 'master'
docs: update the description of UART interrupt

See merge request espressif/esp-idf!30118
2024-04-09 16:34:55 +08:00
Linda 8d36c6257e docs: add two terms to api-guides/flash_psram_config 2024-04-09 11:09:28 +08:00
Linda 544b655a40 docs: update the description of UART interrupt 2024-04-09 10:52:53 +08:00
Zhang Xiao Yan 72c492bdee Merge branch 'docs/fix_typo_freertos_idf' into 'master'
docs: fix a typo in api-reference/system/freertos_idf

See merge request espressif/esp-idf!30088
2024-04-08 18:21:56 +08:00
Linda 0866b63aa9 docs: fix a typo in api-reference/system/freertos_idf 2024-04-08 16:11:39 +08:00
Zhang Xiao Yan c6268b7b6a Merge branch 'docs/add_command_example_get_started' into 'master'
docs: add command example to get-started/establish-serial-connection

See merge request espressif/esp-idf!29125
2024-03-01 15:21:04 +08:00
Linda ecddca6582 docs: add command example to get-started/establish-serial-connection 2024-02-27 11:28:40 +08:00
Zhang Xiao Yan bef0b16dba Merge branch 'docs/add_windows_link_to_jtag_debugging' into 'master'
docs: add a link for Windows users to JTAG debugging

See merge request espressif/esp-idf!29104
2024-02-23 14:26:07 +08:00
Linda f288a81723 docs: add a link for Windows users to JTAG debugging 2024-02-19 17:33:24 +08:00
Zhang Xiao Yan ae31dfe4b8 Merge branch 'docs/add_gpio_dump_io_configuration_example' into 'master'
docs: Add an example for the function gpio_dump_io_configuration()

See merge request espressif/esp-idf!28873
2024-02-08 09:31:47 +08:00
Linda 2c8975b2a7 docs: Add an example for the function gpio_dump_io_configuration() 2024-02-05 18:42:52 +08:00
Zhang Xiao Yan 389cf54d52 Merge branch 'docs/format_table_for_generated_pdf' into 'master'
docs: format table for generated pdf document

See merge request espressif/esp-idf!28705
2024-01-31 10:17:19 +08:00
Linda 6af8643d06 docs: format table for generated pdf document 2024-01-29 14:36:04 +08:00
Zhang Xiao Yan dd1c1279ef Merge branch 'docs/fix_typo_in_low_power_mode' into 'master'
docs: fix some typos in api-guides/low-power-mode

See merge request espressif/esp-idf!28584
2024-01-23 16:16:09 +08:00
Linda 042b5a0102 docs: fix some typos in api-guides/low-power-mode 2024-01-22 16:57:39 +08:00
Zhang Xiao Yan bba48f1e1e Merge branch 'docs/add_cn_trans_for_bootloader_image_format_and_random.rst' into 'master'
docs: Provide Chinese translation for bootloader_image_format, log, random, and internal-unstable.rst

Closes DOC-6419

See merge request espressif/esp-idf!26224
2023-12-11 11:02:31 +08:00
Zhang Xiao Yan 4cd0a6a4b1 Merge branch 'docs/remove_wifi_related_documentation_for_esp32h2' into 'master'
docs: remove WiFi related documentation for ESP32-H2

See merge request espressif/esp-idf!27026
2023-12-05 09:58:06 +08:00
Linda bd1825f9b1 docs: remove WiFi related documentation for ESP32-H2 2023-12-04 11:12:39 +08:00
Zhang Xiao Yan 2c5e876a31 Merge branch 'docs/move_output_log_to_inc_files' into 'master'
docs: move the output log of targets to .inc files

See merge request espressif/esp-idf!27444
2023-12-01 14:19:49 +08:00
Linda acf5cc636a docs: move the output log of targets to .inc files 2023-11-28 18:27:55 +08:00
Zhang Xiao Yan 9489e8a984 Merge branch 'docs/add_ethernet_update_to_migration_4.4_to_5.0' into 'master'
docs: add Ethernet driver update to migration from 4.4 to 5.0

See merge request espressif/esp-idf!26650
2023-11-06 10:53:22 +08:00
Linda ddb82f7ac9 docs: add Ethernet driver update to migration from 4.4 to 5.0 2023-10-30 17:24:37 +08:00
Zhang Xiao Yan dffe28b787 Merge branch 'docs/add_parameter_description_to_esp_netif' into 'master'
docs: add parameter description to esp_netif.h

See merge request espressif/esp-idf!26487
2023-10-19 10:52:51 +08:00
Zhang Xiao Yan 1685dbc985 Merge branch 'docs/update_front_page_for_esp32p4' into 'master'
docs: update front page for esp32p4

See merge request espressif/esp-idf!26479
2023-10-18 19:18:19 +08:00
Linda 6c86424772 docs: add parameter description to esp_netif.h 2023-10-17 10:35:39 +08:00
Linda c1c4424fa2 docs: update front page for esp32p4 2023-10-16 14:06:25 +08:00
Zhang Xiao Yan 4466561dab Merge branch 'docs/update_command_to_exit_screen_session' into 'master'
docs: update the command to exit the screen session

See merge request espressif/esp-idf!26186
2023-10-10 16:26:36 +08:00
Zhang Xiao Yan d33ee17dee Merge branch 'docs/update_arguments_reg_set_bits' into 'master'
docs: update arguments of REG_SET_BITS

See merge request espressif/esp-idf!26145
2023-09-26 18:06:43 +08:00
Linda 6c96e58228 docs: update the command to exit the screen session 2023-09-25 15:34:48 +08:00
Linda 40cfacabab docs: update arguments of REG_SET_BITS 2023-09-25 15:21:32 +08:00
Linda 64940ad1d2 docs: update the file of defining FD_SETSIZE in vfs.rst 2023-09-13 14:16:35 +08:00
Zhang Xiao Yan 6bb7cb8c25 Merge branch 'docs/add_troubleshooting_notes_to_establish_serial_connection' into 'master'
docs: add troubleshooting notes to establish-serial-connection.rst

See merge request espressif/esp-idf!25534
2023-09-13 02:27:38 +08:00
Linda cfd84269e7 docs: add troubleshooting notes to establish-serial-connection.rst 2023-09-12 17:53:36 +08:00
Zhang Xiao Yan ddcb5f663c Merge branch 'docs/organize_third_party_ide' into 'master'
docs: added third-party tools visualgdb and clion

See merge request espressif/esp-idf!24146
2023-09-11 14:31:00 +08:00
Zhang Xiao Yan 58775f868d Merge branch 'docs/organize_header_files_bluetooth_controller' into 'master'
docs: organize header files of Bluetooth Controller

See merge request espressif/esp-idf!24848
2023-09-08 16:07:26 +08:00
Linda ab1bb317ea docs: added third-party tools visualgdb and clion 2023-08-11 16:15:56 +08:00
Zhang Xiao Yan 948a8aa66c Merge branch 'docs/update_term_1/4-line_in_sdmmc_host' into 'master'
update the term 1/4-line to 1-line or 4-line

See merge request espressif/esp-idf!25220
2023-08-09 14:57:42 +08:00
Zhang Xiao Yan 078d9a9a0b Merge branch 'docs/add_how_to_add_component_command_to_usb_device' into 'master'
docs: add a command about how to add the tinyusb component as a dependency

See merge request espressif/esp-idf!25260
2023-08-09 14:56:31 +08:00
Zhang Xiao Yan 30983a25d5 Merge branch 'docs/fix_typos_adc_continuous.h' into 'master'
docs: fix typos in esp_adc/include/esp_adc/adc_continuous.h

See merge request espressif/esp-idf!25241
2023-08-09 14:20:51 +08:00
Linda 54a99df775 docs: add a command about how to add the tinyusb component as a dependency 2023-08-08 16:21:33 +08:00
Zhang Xiao Yan b59c1e2e9d Merge branch 'docs/add_release_notes_for_versions' into 'master'
docs: add release notes to versions

See merge request espressif/esp-idf!24944
2023-08-08 14:49:01 +08:00
Linda df85758c7e docs: fix typos in esp_adc/include/esp_adc/adc_continuous.h 2023-08-08 06:11:30 +00:00
Linda c09595a831 docs: organize header files of Bluetooth Controller 2023-08-07 14:13:24 +08:00
Linda ce1b12520c docs: add release notes to versions 2023-08-07 09:13:35 +08:00
Linda 6ea12fec18 update the term 1/4-line to 1-line or 4-line 2023-08-04 18:12:20 +08:00
Zhang Xiao Yan 0fc252bc1f Merge branch 'docs/fix_Doxygen_syntax_in_adc_continuous' into 'master'
fix(adc_continuous.h): Fix Doxygen syntax error

See merge request espressif/esp-idf!25077
2023-08-01 15:50:23 +08:00
Linda 3c1e129ac3 fix(adc_continuous.h): Fix Doxygen syntax error 2023-07-31 12:11:00 +08:00
Zhang Xiao Yan b5bc96693e Merge branch 'docs/fix_typo_in_get_started_start_project' into 'master'
docs: fix a typo in get-started/start-project

See merge request espressif/esp-idf!24526
2023-07-04 10:14:29 +08:00
Linda b730910a9c docs: fix a typo in get-started/start-project 2023-06-30 17:48:50 +08:00
Zhang Xiao Yan 4a545a5a0f Merge branch 'docs/format_ap_basic_configuration_tables' into 'master'
docs: format AP basic configuration tables in wifi.rst

See merge request espressif/esp-idf!23945
2023-06-19 10:27:19 +08:00
Linda ab14c1dd80 docs: update comment of member idle_core_mask 2023-06-12 14:09:02 +08:00
Linda 29f68ae5aa docs: format AP basic configuration tables in wifi.rst 2023-06-09 15:04:47 +08:00
Zhang Xiao Yan 3d110437b9 Merge branch 'docs/update_interrupt_number_esp32h2' into 'master'
docs: update the number of interrupts for esp32h2

See merge request espressif/esp-idf!24081
2023-06-09 14:07:11 +08:00
Linda b7a6655bdc docs: update the number of interrupts for esp32h2 2023-06-07 19:12:27 +08:00
Zhang Xiao Yan 60441881a5 Merge branch 'docs/add_power_measure_module_deep_sleep_mode' into 'master'
docs: add a chapter to describe how to measure current of modules in deep sleep mode

Closes DOC-517

See merge request espressif/esp-idf!21438
2023-06-06 18:29:41 +08:00
Zhang Xiao Yan 9421cca938 Merge branch 'docs/fix_typo_in_components_esp_common_include_esp_err' into 'master'
docs: fix typo in components/esp_common/include/esp_err.h

See merge request espressif/esp-idf!23573
2023-06-02 15:56:54 +08:00
Linda 7bf3105105 docs: fix typo in components/esp_common/include/esp_err.h 2023-06-01 10:17:19 +08:00
Linda af65960d1c docs: add a chapter to describe how to measure current of modules in deep sleep mode 2023-05-30 18:11:53 +08:00
Zhang Xiao Yan 056a2593f5 Merge branch 'docs/update_code_how_to_configure_multiple_antennas_of_wifi' into 'master'
docs: update code of how to configure multiple antennas of wifi

See merge request espressif/esp-idf!23960
2023-05-30 16:19:32 +08:00
Linda e6c3ac2511 docs: update code of how to configure multiple antennas of wifi 2023-05-29 17:01:41 +08:00
Zhang Xiao Yan 81558fb77d Merge branch 'docs/update_algorithm_and_key_from_aes-xts_to_xts-aes' into 'master'
docs: update the algorithm and key name from AES-XTS to XTS-AES

See merge request espressif/esp-idf!23742
2023-05-16 17:39:58 +08:00
Zhang Xiao Yan 69d152fd89 Merge branch 'docs/fix_typo_in_api_guides_usb_otg_console' into 'master'
docs: fix a typo in api-guides/usb-otg-console

See merge request espressif/esp-idf!23751
2023-05-15 18:05:43 +08:00
Linda 65ee4992ce docs: update the algorithm and key name from AES-XTS to XTS-AES 2023-05-15 17:54:50 +08:00
Linda 7113190067 docs: fix a typo in api-guides/usb-otg-console 2023-05-15 14:14:20 +08:00
Zhang Xiao Yan 7e5d3fb172 Merge branch 'docs/update_installation_prerequisites_for_ubuntu_debian' into 'master'
docs: update installation prerequisites for Ubuntu and Debian system

See merge request espressif/esp-idf!23618
2023-05-10 14:07:08 +08:00
Linda 97ba0d2426 docs: update installation prerequisites for Ubuntu and Debian system 2023-05-08 18:59:41 +08:00
Zhang Xiao Yan a154a93430 Merge branch 'docs/update_connection_description_in_ESP32-S2-DevKitC-1_user_guide' into 'master'
docs/update connection description in ESP32-S2-DevKitC-1 user guide

See merge request espressif/esp-idf!23161
2023-04-26 14:33:35 +08:00
Linda 0ef75bbb64 docs/update connection description in ESP32-S2-DevKitC-1 user guide 2023-04-26 10:29:16 +08:00
Zhang Xiao Yan 2c24513d86 Merge branch 'docs/update_components_log_readme' into 'master'
add description related to thread safety to component/log/readme

See merge request espressif/esp-idf!23162
2023-04-23 11:11:25 +08:00
Zhang Xiao Yan 9ba5004dab add description related to thread safety to component/log/readme 2023-04-23 11:11:24 +08:00
Zhang Xiao Yan 8a7ce4596b Merge branch 'docs/fix_typos_in_esp32_devkitc_v4_getting_started_guide' into 'master'
fix typos in ESP32 DevKitC V4 Getting Started Guide

See merge request espressif/esp-idf!23282
2023-04-20 10:04:28 +08:00
Zhang Xiao Yan c151e1509f fix typos in ESP32 DevKitC V4 Getting Started Guide 2023-04-20 10:04:27 +08:00
Zhang Xiao Yan d98d168cd2 Merge branch 'docs/fix_typo_in_api-reference_system_ota' into 'master'
fix a typo in api-reference/system/ota

See merge request espressif/esp-idf!23212
2023-04-18 14:01:42 +08:00
Linda 528bc7b35a fix a typo in api-reference/system/ota 2023-04-14 17:21:36 +08:00
Zhang Xiao Yan 86b8ef4587 Merge branch 'docs/update_mdns_link' into 'master'
Update link in mDNS.rst

See merge request espressif/esp-idf!22039
2023-04-06 10:09:15 +08:00
Zhang Xiao Yan 5d70620956 Merge branch 'docs/update_brief_of_uart_set_wakeup_threshold' into 'master'
update brief of uart_set_wakeup_threshold

See merge request espressif/esp-idf!22886
2023-03-31 17:28:16 +08:00
Linda cafd3ab4c1 update brief of uart_set_wakeup_threshold 2023-03-31 10:58:02 +08:00
Zhang Xiao Yan 268a662e6c Merge branch 'docs/add_link_to_vscode_debug_configuration' into 'master'
docs: add link to configuration of VSCode debug

See merge request espressif/esp-idf!22526
2023-03-01 10:33:55 +08:00
Linda 414a5c0410 docs: add link to configuration of VSCode debug 2023-02-27 16:31:48 +08:00
Zhang Xiao Yan 778aeae99e Merge branch 'docs/remove_incorrect_note_from_esp32s3_get_started' into 'master'
docs: remove incorrect note from get started of esp32s3

See merge request espressif/esp-idf!22389
2023-02-22 09:58:57 +08:00
Linda 7a9676db16 Update link in mDNS.rst 2023-02-20 18:51:44 +08:00
Zhang Xiao Yan 6642009074 Merge branch 'docs/fix_typo_spi_flash' into 'master'
docs: fix typo in api-reference/peripherals/spi_flash

See merge request espressif/esp-idf!22402
2023-02-20 17:49:37 +08:00
Linda b08017f599 docs: fix typo in api-reference/peripherals/spi_flash 2023-02-20 14:26:47 +08:00