Commit Graph

611 Commits

Author SHA1 Message Date
Angus Gratton
e6d15a0975 docs: Rename esp_pthread docs to pthread, expand details of supported APIs
- Move the code that was in the document out to an example
2021-05-14 10:03:11 +10:00
Krzysztof Budzynski
cc22768863 Merge branch 'docs/remove_c3_not_updated_warning' into 'master'
docs: remove front page C3 docs not updated warning

See merge request espressif/esp-idf!13442
2021-05-13 02:25:38 +00:00
Marius Vikhammer
fd477fa60e docs: remove front page C3 docs not updated warning 2021-05-13 09:58:20 +08:00
Alex Henrie
22964d2065 docs: Change ESP_ERR_CHECK to ESP_ERROR_CHECK in provisioning examples
Closes IDFGH-5222
Closes IDFGH-5221
Closes https://github.com/espressif/esp-idf/pull/6995
Closes https://github.com/espressif/esp-idf/issues/6994
2021-05-09 16:18:50 +05:30
David Cermak
c4870f4d9e esp_netif/wifi: Add API to destroy default wifi-netif for sta/ap
Partially addresses https://github.com/espressif/esp-idf/issues/6950
2021-05-07 11:56:41 +00:00
Cao Sen Miao
8e3a4c2351 doc: update gpio api guide reference on c3 2021-05-06 14:19:18 +08:00
a2800276
bef80909a8 Typo pthread doc: create->get
I believe that:

    esp_create_default_pthread_config

is a typo (no such function exists), the intention was almost certainly to use:

     esp_pthread_get_default_config

Closes https://github.com/espressif/esp-idf/pull/6869/
2021-05-04 17:30:17 +10:00
Michael (XIAO Xufeng)
1f95403596 Merge branch 'feature/emmc_doc_ut_4bit_sdr' into 'master'
sdmmc_host: add unit tests and improve documents about using eMMC in 4-line SDR mode

See merge request espressif/esp-idf!13334
2021-05-02 13:58:13 +00:00
Krzysztof Budzynski
bd5b14fd81 Merge branch 'bugfix/uart_api_reference_examples' into 'master'
docs: Update type of uart_num in UART API Reference examples

See merge request espressif/esp-idf!13385
2021-04-30 06:08:46 +00:00
Krzysztof
7b9b489968 docs: Update type of uart_num in UART API Reference examples 2021-04-28 13:11:41 +02:00
pedro.minatel
a6798eac98 Added LEDC basic PWM example
Changes on the ledc_init function
Review on the README, docs and example functions
Added how to set freq and duty on README
Fix on the ledc.rst docs in the App Example
Added new example reference in the Chinese docs
2021-04-28 11:11:07 +01:00
Michael (XIAO Xufeng)
26585b4b4b esp_flash: support override default chip driver list 2021-04-26 16:05:42 +08:00
Michael (XIAO Xufeng)
02970813b8 sdmmc_host: add unit tests and improve documents about using eMMC in 4-line SDR mode 2021-04-25 18:34:37 +08:00
Michael (XIAO Xufeng)
5997fcd45d Merge branch 'feature/update_adc_programming_guide_on_c3' into 'master'
adc: update esp32c3 programming guide

Closes IDF-2333

See merge request espressif/esp-idf!12563
2021-04-23 12:52:07 +00:00
Angus Gratton
2f70a76572 Merge branch 'bugfix/mac_addr_target_support' into 'master'
system: Restructure MAC address support documentation

See merge request espressif/esp-idf!13298
2021-04-23 10:56:42 +00:00
Michael (XIAO Xufeng)
fdb8736a95 Merge branch 'feature/spi_slave_hd_segment_example' into 'master'
spi_slave_halfduplex: add an example for segment mode

Closes IDF-1699

See merge request espressif/esp-idf!10043
2021-04-23 03:23:25 +00:00
Armando
6930d6aa1e spi_slave_hd: add segment mode example 2021-04-22 19:24:59 +08:00
Dai Zi Yan
4aa52da0c1 update CN translation for I2C 2021-04-22 16:05:01 +08:00
Angus Gratton
7cb83c8787 system doc: Re-structure description of MAC addresses, especially on newer chip targets
Includes a note about calculating the Ethernet MAC on platforms with no built-in
Ethernet, and removes documentation for esp_efuse_mac_get_custom() on targets
other than ESP32
2021-04-22 16:08:55 +10:00
Armando
3177130256 adc: add adc programming guide on c3 2021-04-21 10:40:55 +08:00
Ivan Grokhotkov
fa72ef6bd8 Merge branch 'feature/add-eventfd' into 'master'
vfs: add eventfd support

See merge request espressif/esp-idf!12573
2021-04-16 10:33:06 +00:00
Michael (XIAO Xufeng)
cf457d412a Merge branch 'feature/update_spi_programming_guide_on_c3' into 'master'
spi: update esp32c3 programming guide

Closes IDF-2343

See merge request espressif/esp-idf!12490
2021-04-16 04:22:57 +00:00
Armando
370fedf967 spi_master: enable spi speed test on c3 and update the programming guide
accordingly
2021-04-15 21:20:19 +08:00
Armando
9aa9939406 spi: update esp32c3 programming guide 2021-04-15 21:20:19 +08:00
Jiacheng Guo
40035edcac vfs: add doc links 2021-04-15 15:19:00 +08:00
Darian Leung
7087f80b1e Update TWAI driver docs and registers for esp32c3
This commit updates the documentation and register struct
of the TWAI driver for the ESP32-C3. Note that the register
fields for ESP32-S3 have also been updated.
2021-04-14 15:00:07 +08:00
morris
75dfd970b4 dac: added DAC support macro
Remove DAC support on ESP32-S3
2021-04-12 12:04:46 +08:00
Krzysztof Budzynski
cb7de3659a Merge branch 'bugfix/fix_timergroup_doc_unparsed_variable' into 'master'
doc: fix uninterpreted variables in timer.rst

Closes IDF-3064

See merge request espressif/esp-idf!13047
2021-04-12 00:38:53 +00:00
Michael (XIAO Xufeng)
cb179fe105 Merge branch 'doc/update_i2c_on_esp32c3' into 'master'
i2c: update api reference and example pin definition

Closes IDF-2746 and IDF-2336

See merge request espressif/esp-idf!12407
2021-04-11 17:57:30 +00:00
Renz Bagaporo
c112bd8b57 esp_system: move intr_alloc 2021-04-07 17:53:37 +08:00
morris
4980a764fe doc: fix uninterpreted variables in timer.rst 2021-04-07 13:49:57 +08:00
Cao Sen Miao
372584d1de i2c: update api reference and example pin defination 2021-04-06 13:47:02 +08:00
Angus Gratton
94ac251091 Merge branch 'doc/general_notes' into 'master'
doc: Update docs about startup sequence and memory types

Closes IDF-2321, IDF-2409, and IDFGH-1540

See merge request espressif/esp-idf!12636
2021-04-05 23:51:25 +00:00
Krzysztof Budzynski
7702060967 Merge branch 'docs/update_CN_trans_spiffs_touchpad' into 'master'
docs:update CN translation for spiffs and touch_pad

See merge request espressif/esp-idf!12914
2021-04-02 09:29:18 +00:00
daiziyan
540e9c57e4 docs:update CN translation for spiffs and touch_pad 2021-03-31 20:08:22 +08:00
Angus Gratton
bd7591b848 Merge branch 'doc/guide_uart_esp32c3' into 'master'
doc: update programming guide to include ESP32-C3 updates

Closes IDF-2350

See merge request espressif/esp-idf!12926
2021-03-31 02:52:36 +00:00
Angus Gratton
492b061cbc doc: update the memory types and startup docs 2021-03-31 09:37:28 +11:00
Wang Fang
c303333f52 docs: Correct uart default pin names and provid more information about ESP-Prog board 2021-03-29 14:04:13 +08:00
Michael (XIAO Xufeng)
78090d24e4 Merge branch 'bugfix/flash_suspend_restriction' into 'master'
spi_flash: make suspend off by default and add more information for using suspend

See merge request espressif/esp-idf!12812
2021-03-29 04:47:34 +00:00
Krzysztof Budzynski
d25d3789e9 Merge branch 'doc/update_dead_url_links_to_iot_solution_repo' into 'master'
fix dead links directed to ESP-IoT-Solution repo

Closes DOC-1101 and IDFCI-472

See merge request espressif/esp-idf!12535
2021-03-26 14:23:06 +00:00
Krzysztof Budzynski
c140e8b547 Merge branch 'doc/update_openssl_docs' into 'master'
docs: Migrated OpenSSL APIs from components/openssl/* to the API reference

Closes IDF-2541

See merge request espressif/esp-idf!12515
2021-03-26 11:49:57 +00:00
Angus Gratton
1dfa0e0aa1 Merge branch 'feature/vdd_sdio_pd_configurable' into 'master'
system: add VDD_SDIO power domain configuration for light sleep

Closes IDFGH-2893

See merge request espressif/esp-idf!12481
2021-03-26 08:23:41 +00:00
Omar Chebib
1b994c81da doc: update programming guide to include ESP32-C3 updates 2021-03-26 15:20:36 +08:00
Hao Ning
80da446be7 fix dead links directed to iot solution repo
resolve confilcts

modify a board name

rebase master

fix ota example link in readme
2021-03-26 15:19:10 +08:00
Cao Sen Miao
c54ea54d98 spi_flash: make suspend off by default and add more information for using suspend 2021-03-26 13:57:14 +08:00
Armando
2bb9bd5fb2 adc: update adc programming guide to avoid build fail 2021-03-26 12:04:46 +08:00
Krzysztof Budzynski
1953af4fb2 Merge branch 'doc/c3_system_api' into 'master'
docs: update system api reference chapters for C3

Closes IDF-2327 and IDF-2320

See merge request espressif/esp-idf!12730
2021-03-24 10:28:19 +00:00
Omar Chebib
49f5fb5112 esp_system: add VDD_SDIO power domain configuration to documentation
Add a warning in `sleep_modes` doc page to explain how to keep
VDD_SDIO power domain ON.
2021-03-24 12:04:57 +08:00
Roman Alexeev
7d07efb7b5 Fixed a missed last argument (void *__arg) for pthread_create
Closes https://github.com/espressif/esp-idf/pull/6479
Close IDFGH-4666
2021-03-23 17:35:35 +05:30
Dai Zi Yan
8ae944e26c docs:update CN translation for documenting-code and LEDC 2021-03-23 10:52:50 +08:00
Angus Gratton
54edd4fc58 Merge branch 'feature/wdt_c3' into 'master'
wdt: Fix RTC_SLOW_CLK for chips, corrects WDT timeout.

Closes IDF-2118 and IDF-2332

See merge request espressif/esp-idf!12796
2021-03-22 06:48:58 +00:00
KonstantinKondrashov
aa1338bf23 wdt: Fix timeout and RTC_SLOW_CLK
RTC_SLOW_CLK
ESP32:    150kHz
ESP32-S2:  90kHz
ESP32-S3: 150kHz
ESP32-C3: 150kHz
2021-03-19 00:15:18 +08:00
suren.gabrielyan
cc78923d23 docs: Update OpenSSL API documents
Closes IDF-2541
2021-03-18 10:42:29 +04:00
morris
fe70d18bb5 doc: update doc of general purpose timer 2021-03-16 17:56:37 +08:00
Marius Vikhammer
91439e3818 docs: updated system api-reference chapters for C3 2021-03-15 18:51:12 +08:00
Krzysztof Budzynski
4e06cbb1b3 Merge branch 'doc/c3_ledc_programming_guide' into 'master'
[doc]: Adjusted LEDC docs for C3

See merge request espressif/esp-idf!12509
2021-03-12 03:24:14 +00:00
Angus Gratton
fd164b82b6 Merge branch 'refactor/move_from_xtensa' into 'master'
Movements from xtensa

Closes IDF-2164

See merge request espressif/esp-idf!10556
2021-03-11 00:24:25 +00:00
Angus Gratton
4f406d7a35 Merge branch 'bugfix/read_ota_partition_required_output_arg' into 'master'
otatool: Fixes read_ota_partition cmd, required output arg

Closes IDFGH-4756

See merge request espressif/esp-idf!12601
2021-03-09 06:29:34 +00:00
Angus Gratton
70e13752ae Merge branch 'feature/rtc_time_get' into 'master'
rtc: Clean up for S2,S3,C3

Closes IDF-2569

See merge request espressif/esp-idf!12336
2021-03-05 01:16:15 +00:00
KonstantinKondrashov
b7155a161b otatool: Fixes read_ota_partition cmd, required output arg
Closes: https://github.com/espressif/esp-idf/issues/6559
2021-03-04 06:02:54 +00:00
Jakob Hasse
5e5e5c8753 [doc]: Corrected C3 LEDC docs 2021-03-03 16:49:05 +08:00
Shubham Kulkarni
7f8541ff47 esp_https_ota: Add support for partial image download
Fix issue where binary_file_length field is greater than original image length
2021-03-01 14:00:27 +00:00
KonstantinKondrashov
b31bf01484 rtc: Clean up for S2,S3,C3 2021-03-01 16:51:15 +08:00
Marius Vikhammer
6334b5e56f docs: update api-reference chapters for C3
Checked and updated the following chapters:
 * api-reference/network
 * api-reference/protocols
 * api-reference/provisioning
 * api-reference/storage
 * api-reference/peripherals/ds
 * api-reference/peripherals/hmac
 * api-reference/peripherals/secure_element
2021-03-01 14:58:08 +08:00
David Čermák
00432fa2c3 Merge branch 'feature/update_mqtt_test_url' into 'master'
Feature/update mqtt test url

See merge request espressif/esp-idf!12473
2021-02-26 16:09:38 +00:00
Renz Bagaporo
0f03f450ff esp_hw_support: create esp_cpu
Create a esp_cpu header that contains CPU-related functions and
utilities.
2021-02-26 13:34:29 +08:00
Michael (XIAO Xufeng)
eb29d8dbda Merge branch 'feature/support_invert_rmt_signal_in_gpio_matrix' into 'master'
rmt: support inverting signal in gpio matrix

Closes IDF-2762

See merge request espressif/esp-idf!12420
2021-02-25 11:14:19 +00:00
Michael (XIAO Xufeng)
268289eade Merge branch 'docs/spi_flash_auto_suspend' into 'master'
spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND

See merge request espressif/esp-idf!12290
2021-02-25 09:16:10 +00:00
morris
efa92cb204 rmt: support invert RMT signal by GPIO matrix 2021-02-25 12:42:23 +08:00
Angus Gratton
a0eb455ec3 Merge branch 'refactor/misc_move_from_esp_common' into 'master'
Movements from esp_common

Closes IDF-1947

See merge request espressif/esp-idf!9692
2021-02-24 23:16:52 +00:00
Angus Gratton
84b33b9dba Merge branch 'feature/update_efuse_doc' into 'master'
doc/efuse: Adds efuse doc for ESP32-C3

Closes IDF-2328

See merge request espressif/esp-idf!12365
2021-02-24 22:30:18 +00:00
Michael (XIAO Xufeng)
476fdcba68 spi_flash: update docs after adding CONFIG_SPI_FLASH_AUTO_SUSPEND 2021-02-24 20:20:18 +08:00
Renz Bagaporo
813044c6db docs, ci: update docs and ci with movements from esp_common 2021-02-24 12:16:37 +08:00
Michael (XIAO Xufeng)
db1c635db4 Merge branch 'feature/esp32c3_rtc_temp_calibration' into 'master'
temperature_sensor: calibration for esp32c3

Closes IDF-2502

See merge request espressif/esp-idf!12158
2021-02-24 03:27:49 +00:00
Michael (XIAO Xufeng)
26be097431 Merge branch 'feature/touch_sense_api_reference' into 'master'
touch_element: add touch element lib api-reference doc

Closes IDF-2666

See merge request espressif/esp-idf!11827
2021-02-24 03:00:10 +00:00
yuanjm
6019c22092 doc: Update mqtt open source test server address 2021-02-23 15:30:06 +08:00
Angus Gratton
fb1488abba Merge branch 'feature/esp_timer_isr_dispatch_method_restore' into 'master'
esp timer: Add ISR dispatch method

Closes IDF-1172 and IDF-1173

See merge request espressif/esp-idf!11572
2021-02-23 06:21:14 +00:00
Cao Sen Miao
85855ad8a6 temp_sensor: add calibration for esp32c3 2021-02-23 10:48:17 +08:00
KonstantinKondrashov
5a5f5ad031 doc/efuse: Adds efuse doc for ESP32-C3 2021-02-22 15:51:45 +08:00
Kang Zuoling
78a1cd3643 touch_element: add touch element api-reference doc 2021-02-22 12:16:49 +08:00
Krzysztof Budzynski
6fc1a7e5e9 Merge branch 'doc/twai_time_quatum' into 'master'
TWAI: Fix doc grammar of time quantum

Closes IDFGH-4748

See merge request espressif/esp-idf!12406
2021-02-19 02:10:44 +00:00
Krzysztof Budzynski
9274abf5c9 Merge branch 'doc/nvs_get_used_entry_count__clarify' into 'master'
[doc]: NVS documentation updates

Closes IDF-1563, DOC-165, and IDF-859

See merge request espressif/esp-idf!12056
2021-02-18 10:36:16 +00:00
Christoph Rackwitz
c2e940e04c
singular form of quanta is quantum
it's like bacteria/bacterium, phenomena/phenomenon
2021-02-16 18:02:30 +01:00
Angus Gratton
8c195a7a17 Merge branch 'feature/ulp_c3_not_exists_update_doc' into 'master'
doc/ulp(esp32c3): Excludes ulp and some RTC features from ESP32C3 doc

Closes IDF-2318 and IDF-2331

See merge request espressif/esp-idf!12347
2021-02-15 23:09:54 +00:00
David Cermak
4051922885 esp_netif: Update documentation on deinitialization of wifi default netif
Closes https://github.com/espressif/esp-idf/issues/6504
2021-02-10 13:28:36 +00:00
KonstantinKondrashov
aa581aba0f doc/ulp(esp32c3): Excludes ulp and some RTC features from ESP32C3 doc 2021-02-10 18:15:04 +08:00
KonstantinKondrashov
63d4911cdb esp_timer: Add ESP_TIMER_ISR dispatch method
Using own spinlock for each list (TASK and ISR disp method)
Reduced the dependency of ISR on the TASK dispatch method
2021-02-08 19:10:11 +08:00
Jakob Hasse
916f02164e [doc]: NVS documentation updates
* Move nvs flash README to common doc directory
* correct markup of functions and types in text
  from old README
* Better comment of nvs_get_used_entry_count()
* Mention C++ example in API reference
* Used target instead of hard code ESP32
* Note that strings can only span one page
* Reflect that item types have been moved
* Some clarification about nvs_commit()
* Improved reference to the ESP Partition API
* fixed little mistake in documenting-code.rst
* Change of nvs_open_from_part() to
  nvs_open_from_partition() reflected in docs
* Corrected documentation of
  NVSHandle::get_string(), NVSHandle::get_blob()
  and NVSHandle::get_item_size().

* Closes DOC-165
* Closes IDF-1563
* Closes IDF-859
* Closes https://github.com/espressif/esp-idf/issues/6123
2021-02-08 09:31:23 +08:00
Jiang Jiang Jian
27100cc50e Merge branch 'docs/wifi_doc_update' into 'master'
update wifi docs

See merge request espressif/esp-idf!12232
2021-02-04 16:37:31 +08:00
dongyou
fe76c53fec update wifi docs 2021-02-02 11:42:00 +08:00
Marius Vikhammer
548fd02d10 docs: initial update of programming guide for C3
Updates "front page" content, get-started, and api-guides with C3 content

Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
Michael (XIAO Xufeng)
9ff04b2e79 Merge branch 'feature/musical_buzzer' into 'master'
RMT example: musical buzzer

See merge request espressif/esp-idf!10346
2021-01-28 01:04:24 +08:00
Krzysztof Budzynski
9a5bd86d54 Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master'
docs: update documents based on doc-855, doc-885, doc-889, doc-897

See merge request espressif/esp-idf!12124
2021-01-26 16:21:26 +08:00
Krzysztof Budzynski
5ca85248e3 Merge branch 'docs/update_docs_based_on_several_customer_feedbacks' into 'master'
docs: update documents based on doc-881, doc-856, doc-902, and doc-943

See merge request espressif/esp-idf!12118
2021-01-26 16:18:13 +08:00
Krzysztof Budzynski
6df0b98b8e Merge branch 'doc/api-guides-add-hypertargets' into 'master'
Add hypertargets to all TRM references

Closes DOC-713

See merge request espressif/esp-idf!11952
2021-01-26 16:15:29 +08:00
Krzysztof Budzynski
c9a4604fe2 Merge branch 'feature/update_esp32c3_rmt_doc' into 'master'
Update RMT/Sigma-Delta doc for ESP32-C3

Closes IDF-2341 and IDF-2345

See merge request espressif/esp-idf!12091
2021-01-26 14:29:33 +08:00
kirill.chalov
f634c59289 Add hypertargets to all TRM references 2021-01-26 05:51:52 +00:00
Wang Fang
4c31cf9804 docs: Update FreeRTOS version, add tips to set up instructions for Windows 2021-01-26 03:46:25 +00:00
Wang Fang
7df1cad1d6 docs: This MR does the following updates:
1. Provided more information regarding I2S_COMM_FORMAT_STAND_PCM_SHORT and I2S_COMM_FORMAT_STAND_PCM_LONG
2. Added --output flag for partition table read instructions
3. Reordered the header files for esp-ble-mesh
4. Reordered the setup instructions for Ubuntu and CentOS
2021-01-25 11:10:08 +00:00
Marius Vikhammer
3fd37d0b59 adc: change the way data is formattted in adc_dma_demo
The way the adc_dma_demo data was formatted caused it go get parsed as markdown syntax.

Changed it be more "human" readable as well as put all ADC examples in a common folder
2021-01-25 04:51:40 +00:00