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
34,611 Commits 20 Branches 148 Tags 384 MiB
fe206dab59
Commit Graph

743 Commits

Author SHA1 Message Date
Shang Zhou
913c1722c2 docs: Review and update spi_features 2023-02-16 16:27:42 +08:00
Linda
75df11ccbc docs: fix typo in api-reference/peripherals/gpio/esp32s3 2023-02-16 12:14:30 +08:00
Darian Leung
69433a9660 freertos: Rename SMP changes document to ESP-IDF FreeRTOS 
This commit renames "freertos-smp" docuemnt to "freertos_idf". This fits better
with the current dual FreeRTOS implementation (i.e., IDF FreeRTOS and Amazon
SMP FreeRTOS), both of which are SMP capable.
 2023-02-15 12:42:04 +08:00
Marius Vikhammer
98c55f29d1 docs: fix rst external links with wrong format 2023-02-13 11:51:31 +08:00
Jakob Hasse
4be50db159 Merge branch 'docs/elm_chan_broken_link' into 'master' 
docs: fix broken link in fatfs doc

See merge request espressif/esp-idf!22268
 2023-02-09 11:54:49 +08:00
morris
044a114e66 gptimer: unify clock setting with clk_tree API 2023-02-08 16:30:47 +08:00
Marius Vikhammer
4a0c5991ab docs: fix broken link in fatfs doc 2023-02-08 12:02:17 +08:00
Roland Dobai
4bd5ebb4a1 Merge branch 'tools/monitor_move' into 'master' 
Tools(idf_monitor): Move idf_monitor to separate repo

Closes IDF-4109

See merge request espressif/esp-idf!22050
 2023-02-07 19:47:46 +08:00
Mo Fei Fei
6d4313f414 Docs: update CN trans for idf_monitor.rst 2023-02-03 11:20:18 +01:00
laokaiyao
f27cd67c00 driver: pack peripherals 2023-02-02 18:19:58 +08:00
Dai Zi Yan
b97a98a703 Merge branch 'docs/sync_up_translation_Jan' into 'master' 
docs: sync up translation for api-reference

Closes DOC-4445 and DOC-3673

See merge request espressif/esp-idf!22150
 2023-02-02 18:07:21 +08:00
daiziyan
4667f1b3ef docs: sync up translation for api-reference 2023-02-02 14:44:13 +08:00
laokaiyao
330149f3a6 i2c: support i2c on esp32h2 2023-02-01 11:23:11 +08:00
David Čermák
dba0718f47 Merge branch 'feature/lwip_linux' into 'master' 
lwip: Add support for linux target

Closes IDF-5707, IDF-5647, and IDF-6003

See merge request espressif/esp-idf!19302
 2023-01-31 22:01:50 +08:00
David Cermak
fa97004faf lwip: Support for linux target 
Implement linux port layer and reuse the original FreeRTOS layer
that's compiled and used on linux target as well, by means of FreeRTOS
simulator.
 2023-01-31 08:43:45 +01:00
Song Ruo Jing
ad55230b0a ledc: Add support for esp32h2; Refactor ledc driver clock source selection related code 
LEDC examples and test cases are supported on ESP32H2.
   Switch to use general clock IDs for ledc_clk_cfg_t enum values.
   Deprecate LEDC_USE_RTC8M_CLK.
 2023-01-30 19:19:34 +08:00
Darian Leung
a57496acfe usb_host: Add maintainer's notes (Design, Architecture) 
This commit adds some parts of the USB Host Stack's maintainers notes
(specifically "Design" and "Architecture").
 2023-01-24 02:49:35 +08:00
David Čermák
2f1d30d155 Merge branch 'bugfix/lwip_core_locking' into 'master' 
esp_netif/lwip: Fix core-locking config

Closes IDFGH-8445, IDFGH-9098, and IDFGH-9063

See merge request espressif/esp-idf!20840
 2023-01-18 20:31:25 +08:00
Song Ruo Jing
4c8fdc31f9 gpio: Add support for esp32h2 2023-01-18 11:41:12 +08:00
Wang Zi Yan
9d80d981b5 docs: CN translation for system_time.rst and migration-guides: 5.1/networking.rst 2023-01-17 16:16:03 +01:00
Marius Vikhammer
70d1dbccd8 Merge branch 'docs/enable_h2_build' into 'master' 
docs: add support for building H2 docs

Closes IDF-6259

See merge request espressif/esp-idf!21933
 2023-01-17 12:11:29 +08:00
Marius Vikhammer
7100b7d1ff docs: add support for building H2 docs 2023-01-17 10:04:26 +08:00
Ivan Grokhotkov
8084552722 Merge branch 'bugfix/sntp_docs_time_t_64bit' into 'master' 
docs: remove outdated section on custom toolchain for 64-bit time_t

See merge request espressif/esp-idf!21994
 2023-01-16 17:56:29 +08:00
Wang Zi Yan
1568f9b7ef
docs: remove outdated section on custom toolchain for 64-bit time_t 
Co-authored-by: Ivan Grokhotkov <ivan@espressif.com>
 2023-01-16 14:19:56 +08:00
Darian Leung
a52aff81a8 usb_host: Add maintainer's notes (Introduction and DWC_OTG Controller) 
This commit adds some parts of the USB Host Stack's maintainers notes
(specifically "Introduction" and "DWC_OTG Controller" chapters).
 2023-01-13 20:00:18 +08:00
Krzysztof Budzynski
4b1ea708a3 Merge branch 'docs/update_esp_mqtt' into 'master' 
update ESP-MQTT by including the mqtt5 example

See merge request espressif/esp-idf!21737
 2023-01-10 15:52:10 +08:00
morris
d052ce9240 Merge branch 'contrib/github_pr_10469' into 'master' 
Reference code fixed. (GitHub PR)

Closes IDFGH-9066

See merge request espressif/esp-idf!21961
 2023-01-10 10:12:02 +08:00
archen
ed1b2ba60e
Reference code fixed. 
Merges https://github.com/espressif/esp-idf/pull/10469
 2023-01-09 16:17:35 +05:30
Linda
ff57f243f2 update ESP-MQTT by including the mqtt5 example 2023-01-07 13:39:32 +08:00
Ivan Grokhotkov
61c5fc21e1
docs: fix nvs-related docs build issue 2023-01-05 09:28:57 +01:00
Song Ruo Jing
105fe9f950 Merge branch 'bugfix/ledc_channel_update_usage' into 'master' 
ledc: Fix bug in channel-duty configuration

Closes IDF-6439

See merge request espressif/esp-idf!21635
 2023-01-03 20:11:08 +08:00
Song Ruo Jing
662df0da3b ledc: Channel configuration requires the ledc core clock on to be effective. Therefore, a clock source is selected for the core clock since the peripheral initialization. Additionally, correct the usage of channel para_up and duty_start bits. 2023-01-03 15:16:00 +08:00
Wang Zi Yan
996e564f54 docs: update mqtt wifi coexist 2023-01-03 14:27:58 +08:00
Michael (XIAO Xufeng)
57a9c67c01 index 2022-12-29 01:00:31 +08:00
Michael (XIAO Xufeng)
daa4af1b1f docs: split spi_flash api-reference documents to peripherals folder 2022-12-29 00:59:03 +08:00
Zhang Xiao Yan
93d99eb062 Merge branch 'docs/update_ota_translation' into 'master' 
update CN translation of api-reference/system/ota

See merge request espressif/esp-idf!21741
 2022-12-27 17:03:20 +08:00
Song Ruo Jing
1a6e1aba3d ledc: Add check for whether the registered callback is in iram in ledc_cb_register 2022-12-22 14:38:58 +08:00
Linda
8eeeb895f1 update CN translation of api-reference/system/ota 2022-12-21 16:59:43 +08:00
Mo Fei Fei
689c2f46e2 Docs: update CN trans for sleep_modes.rst, misc_system_api.rst, migration_guides/peripherals.rst 2022-12-20 10:35:49 +08:00
Jiang Jiang Jian
92a4a146a0 Merge branch 'bugfix/fix_max_conn_num_issue' into 'master' 
esp_wifi: change max connection num on ESP32C3 and ESP32S3

Closes WIFI-5114

See merge request espressif/esp-idf!21503
 2022-12-19 11:08:46 +08:00
Shang Zhou
172aca432a docs: Update CN translation for out-of-sync api-reference files 2022-12-16 19:19:39 +08:00
zhangyanjiao
572f117b79 fix typos in docs 2022-12-16 15:52:21 +08:00
zhangyanjiao
590481d531 esp_wifi: change max connection num on ESP32C3 and ESP32S3 
Closes WIFI-5114
 2022-12-15 15:23:32 +08:00
morris
8277a8e8df doc: gpio glitch filter 2022-12-09 11:33:42 +08:00
morris
bc56ae4a63 Merge branch 'docs/translate_uart' into 'master' 
docs: translate uart

Closes DOC-3037

See merge request espressif/esp-idf!21184
 2022-12-08 19:34:40 +08:00
Wang Zi Yan
828fed333e docs: translate uart 2022-12-08 19:34:40 +08:00
Song Ruo Jing
9402ab427b ledc: Add basic support for esp32c6 2022-12-07 18:40:50 +08:00
Mo Fei Fei
f0060a7a76 Docs: add CN trans for esp_http_client.rst 2022-12-05 14:16:56 +08:00
Mahavir Jain
11f2683c27 docs: add chapter about overall "security" area guide 
List down considerations for the following areas:

- Hardware security
- Network security
- Product security

Also added brief explanation about "Security Policy" for ESP-IDF.

Closes IDF-1565
 2022-11-25 03:17:05 +00:00
morris
2f29408f3f Merge branch 'docs/provide_translation_for_esp_eth' into 'master' 
docs: Provide CN translation for esp_eth

Closes DOC-3901

See merge request espressif/esp-idf!21029
 2022-11-23 19:05:39 +08:00
morris
4019e307f1 doc: add api reference for etm driver 2022-11-23 15:32:34 +08:00
Shang Zhou
3efc3a0665 docs: Provide CN translation for esp-eth 2022-11-22 16:20:10 +08:00
Jiang Jiang Jian
d89a51299d Merge branch 'bugfix/modify_wifi_max_conn_num' into 'master' 
esp_wifi: modify wifi max conn num

Closes IDFGH-7960, WIFI-4176, IDFGH-8431, and WIFI-5004

See merge request espressif/esp-idf!19367
 2022-11-22 15:51:08 +08:00
morris
5bd99deb48 pcnt: support accumulate count value 
Closes https://github.com/espressif/esp-idf/issues/10167
 2022-11-21 10:15:19 +08:00
zhangyanjiao
8683a2622e update doc for espnow max encryped connection 2022-11-17 15:07:49 +08:00
Liu Ning
6bb28c4cdc Merge branch 'bugfix/publish_wifi_connectionless_feature' into 'master' 
esp_wifi: fix connectionless issues and add connectionless power-save documenation

Closes BT-2595 和 WIFI-4822

See merge request espressif/esp-idf!20600
 2022-11-11 19:40:15 +08:00
liuning
b153469841 esp_wifi: fix some connectionless related issue and add connectionless power save guide 2022-11-11 15:59:19 +08:00
morris
01a253afaf doc: split gpio summary by target name 2022-11-10 10:37:59 +08:00
laokaiyao
8677216576 esp32h2: renaming esp32h2 to esp32h4 2022-11-08 17:05:33 +08:00
morris
aeaef08f0e doc: update twai api reference for esp32c6 2022-11-04 17:40:29 +08:00
Michael (XIAO Xufeng)
c546de8d82 Merge branch 'feature/apply_new_version_logic' into 'master' 
all: Apply new version logic (major * 100 + minor)

Closes IDF-4932 and IDF-4939

See merge request espressif/esp-idf!18787
 2022-11-04 16:01:32 +08:00
Wang Zi Yan
ff6844f885 docs: add a blank line in ble-mesh-index and translate mqtt 2022-11-04 11:44:42 +08:00
KonstantinKondrashov
1f9260d790 all: Apply new version logic (major * 100 + minor) 2022-11-03 08:36:23 +00:00
Mo Fei Fei
49c38f16e8 Docs: Update cn trans for nvs_flash and spi_flash_concurrency 2022-11-01 16:39:54 +08:00
Marius Vikhammer
418efe09f6 docs: remove link to i2c specs 2022-10-31 02:21:31 +00:00
morris
e6e1d696d2 doc: clarify the meaning of overflow in pcnt driver 
Closes https://github.com/espressif/esp-idf/issues/10039
 2022-10-26 16:13:04 +08:00
Linda
92e005ba0e docs: add pin information of touch sensor 2022-10-24 17:38:02 +08:00
Song Ruo Jing
a3d0a0bdc6 docs: Add esp32c6 GPIO/IO_MUX content 2022-10-18 14:26:11 +08:00
Marius Vikhammer
099b0b6421 Merge branch 'feature/c6_doc_build' into 'master' 
docs: add support for building C6 docs

Closes IDF-5829

See merge request espressif/esp-idf!19721
 2022-10-18 09:37:30 +08:00
Marius Vikhammer
ca4ad3ce7c docs: add support for building C6 docs 2022-10-13 04:39:16 +00:00
gaoxu
2cb2ff99af docs: add description about flash content moved to psram feature 2022-10-11 15:15:04 +08:00
Matus Fabo
1c6edff560 add: data classes for parsing NVS binary data 
add: functions to print formatted NVS data
add: color support via ANSI escape sequences
add: documentation
 2022-09-20 14:02:23 +00:00
wangjialiang
6e79d05814 ble_mesh: docs: Remove BLE Mesh related reference for C2 2022-09-16 19:39:51 +08:00
Martin Gaňo
30dd0fbf30 fatfsparse.py: enable automatic WL detection 2022-09-15 10:51:48 +00:00
Mo Fei Fei
7edf5090ab Docs: Update cn trans for migration-guides/system.rst and api-reference/system/ulp-risc-v.rst 2022-09-14 21:33:50 +08:00
Alexey Lapshin
a9bd454529 tools: update esp32ulp-elf to v2.35_20220830 
Closes https://github.com/espressif/esp-idf/issues/6432
Closes https://github.com/espressif/binutils-esp32ulp/issues/23
 2022-09-13 12:55:48 +04:00
daiziyan
49aaea7509 docs: updated gpio and sync up line numbers 2022-09-09 02:39:35 +00:00
Martin Gaňo
72acbeb921 fatfsparse.py: enable automatic detection of lfn 2022-09-08 10:53:04 +02:00
Mo Fei Fei
a6e92beda3 Docs: Update CN trans for nvs_flash.rst 2022-09-01 17:45:11 +08:00
morris
c7696fb8ef Merge branch 'docs/update_touch_sensor_esp32s2s3' into 'master' 
docs: update touch sensor of esp32s2 and esp32s3

Closes DOC-3193

See merge request espressif/esp-idf!19696
 2022-08-30 17:08:06 +08:00
morris
995b89fbb6 gptimer: add API to get captured count value 2022-08-25 17:55:19 +08:00
Linda
0fa32f2f41 docs: update touch sensor of esp32s2 and esp32s3 2022-08-24 16:34:13 +08:00
wangziyan
7637d24d50 docs: update wifi application examples 2022-08-24 16:21:56 +08:00
Marius Vikhammer
8bf4af572b Merge branch 'docs/c2_storage_update' into 'master' 
docs: update storage and sleep docs for C2

Closes IDF-4207

See merge request espressif/esp-idf!19453
 2022-08-23 23:56:56 +08:00
Laukik Hase
ae932c8c4e
docs: Added migration guide for app_update 
- Deprecated functions and alternatives
 2022-08-17 10:59:31 +05:30
Shang Zhou
ea26e6a635 docs: Update CN version for MR19453 2022-08-15 16:14:14 +08:00
Marius Vikhammer
26dc5fe188 docs: update storage and sleep docs for C2 2022-08-15 07:04:28 +00:00
Island
fd8101498b Merge branch 'bugfix/fix_bluetooth_cap_define_and_doc' into 'master' 
Bugfix/fix bluetooth cap define and doc

Closes BC-1298 and BC-1297

See merge request espressif/esp-idf!19149
 2022-08-11 16:51:08 +08:00
daiziyan
d422e2e7fa docs: updated trans for ulp-risc-v,fatfs and sleep_modes 2022-08-10 16:53:51 +08:00
Shang Zhou
a17b207e4f docs: Sync up EN and CN lines of ble-mesh, wifi, and i2c 2022-08-09 11:45:34 +08:00
Geng Yuchao
0a1d8c1e09 Fix soc caps define for all chips 2022-08-08 20:50:28 +08:00
Martin Gaňo
a542e9424c fatfsparse.py/docs: Added missing cmd parameter to the docs 2022-07-29 15:29:23 +02:00
morris
e4868548c7 doc: update MCPWM api reference with new driver API 2022-07-27 15:22:24 +08:00
morris
741b031e83 soc: added SOC_TOUCH_SENSE_SUPPORTED macro 2022-07-22 00:12:36 +00:00
Jiang Jiang Jian
cf5b097c88 Merge branch 'bugfix/further_fix_for_mspi_current_leakage' into 'master' 
system/sleep: further fix spi flash/ram current leakage

Closes IDF-4720

See merge request espressif/esp-idf!18566
 2022-07-21 19:14:26 +08:00
Jing Li
66395a5c00 system/sleep: further fix spi flash/ram current leakage 2022-07-21 19:14:26 +08:00
morris
75d411a003 doc: update sdm api reference 2022-07-20 14:59:50 +08:00
morris
9e532696f4 pcnt: add const qualifier to event data 2022-07-20 14:59:50 +08:00
Armando (Dou Yiwen)
9f6f61345b Merge branch 'feature/adc_driver_ng' into 'master' 
ADC Driver NG

Closes IDF-4560, IDF-3908, IDF-4225, IDF-2482, IDF-4111, IDF-3610, IDF-4058, IDF-3801, IDF-3636, IDF-2537, IDF-4310, IDF-5150, IDF-5151, and IDF-4979

See merge request espressif/esp-idf!17960
 2022-07-19 21:28:31 +08:00
intern
4866e91398 docs: update nvs encryption cn trans 2022-07-18 14:40:56 +08:00
Armando
5b523a3313 esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
Linda
bf950f1c04 docs:provide translation for pcnt 2022-07-13 13:27:04 +08:00
Mu Hai Dong
eb4421bf33 doc: esp32c2 wifi programming guide doc. 2022-07-07 14:13:11 +08:00
morris
a92cce9861 Merge branch 'bugfix/calib_i2c_clk' into 'master' 
I2C: Make I2C clock frequency accurate

Closes IDF-5363

See merge request espressif/esp-idf!18686
 2022-07-06 20:52:31 +08:00
Wang Zi Yan
5e768f7f2d docs: provide translation for gptimer 2022-07-06 17:39:23 +08:00
Cao Sen Miao
e218723e0e I2C: Make I2C clock frequency accurate 2022-07-06 11:58:08 +08:00
Jing Li
9fd5e15b83 Merge branch 'docs/improve_docs_for_flash_power_down' into 'master' 
docs: improve docs about flash power-down

Closes IDF-5258

See merge request espressif/esp-idf!18696
 2022-07-06 11:02:54 +08:00
jingli
d3c6fff25a improve docs about flash power-down 2022-07-05 19:25:21 +08:00
gabsuren
79d3655106 ASIO: Remove internal component, examples, test and docs 2022-07-04 22:15:24 +04:00
David Čermák
46fe7dbc8c Merge branch 'component/mdns_migration' into 'master' 
mdns: Remove internal component, examples, test and docs

Closes IDF-4074

See merge request espressif/esp-idf!17683
 2022-07-04 17:45:27 +08:00
Cao Sen Miao
d9b4b82edc spi_flash: Modify documentations 2022-07-01 10:59:34 +08:00
daiziyan
f9f43b1860 docs: updated mdns 
(cherry picked from commit 6737095bfb205867e096da8cf6cdf1f144800ee7)
 2022-06-29 21:46:12 +08:00
gabsuren
d413a71f61 mdns: Remove internal component, examples, test and docs 2022-06-29 17:30:34 +04:00
Ondrej Kosta
ed7afd8b73 Merge branch 'feature/eth_phy_common' into 'master' 
ESP PHY structure refactor

Closes IDF-5149

See merge request espressif/esp-idf!18158
 2022-06-28 23:25:12 +08:00
laokaiyao
d5e55e0563 touch_sensor: add description to distinguish the API on different target 
Closes https://github.com/espressif/esp-idf/issues/9067
 2022-06-28 02:20:43 +00:00
Ondrej Kosta
43f3904304 esp_eth: IEEE 802.3 PHY MII Management Interface functionality grouped to one common file 2022-06-24 05:51:44 +00:00
Darian
e213e66ba3 Merge branch 'refactor/esp_hw_support_cpu' into 'master' 
esp_hw_support: Add new esp_cpu.h abstraction

Closes IDF-4769

See merge request espressif/esp-idf!17091
 2022-06-14 21:11:30 +08:00
Darian Leung
149872131a hal: Move dedicated GPIO LL and HAL 
This commit moves the dedicated GPIO LL and HAL functions from
cpu_ll.h to dedic_gpio_cpu_ll.h.

- cpu_ll_enable_cycle_count() has also been removed due to lack of feasible usage scenarios
 2022-06-14 14:38:29 +08:00
Shang Zhou
2cfce11fb8 docs: provide CN translation for spi_slave and spi_features 2022-06-14 14:31:42 +08:00
morris
066289fbd0 Merge branch 'feature/doc_update_efuse' into 'master' 
doc(efuse): Updates efuse article

Closes IDF-4223, IDF-4895, IDFGH-7228, and IDFGH-7216

See merge request espressif/esp-idf!18349
 2022-06-14 10:50:51 +08:00
daiziyan
3a2da53e2a docs: add translation for dedic_gpio 2022-06-13 15:14:25 +08:00
Shang Zhou
6b9d92c1d6 docs: provide CN translation for fatfsparse.py 2022-06-09 15:51:03 +02:00
KonstantinKondrashov
7b9d1eaf31 doc(efuse): Updates efuse article 2022-06-07 20:44:27 +08:00
Dai Zi Yan
e94435df22 Merge branch 'docs/update_idf_monitor' into 'master' 
docs: update CN translation for idf-monitor.rst

Closes DOC-3082

See merge request espressif/esp-idf!18248
 2022-06-06 15:45:24 +08:00
morris
fa6bce6c21 Merge branch 'docs/translate_gpio' into 'master' 
Docs/translate gpio

Closes DOC-2857

See merge request espressif/esp-idf!18090
 2022-05-31 12:19:35 +08:00
Dai Zi Yan
e2b87e668b Docs/translate gpio 2022-05-31 12:19:34 +08:00
Jakob Hasse
97c149f73d Merge branch 'refactor/nvs_iterator_api' into 'master' 
NVS: New interface for iterator functions

Closes IDFGH-6149

See merge request espressif/esp-idf!18081
 2022-05-31 07:47:26 +08:00
daiziyan
59453d0e78 docs: update CN translation for idf-monitor.rst 2022-05-30 20:55:37 +08:00
mofeifei
0cce36f0ec docs:add cn trans for esp-https-server.rst 2022-05-30 13:38:01 +08:00
Jakob Hasse
ad184e979a refactor (nvs)!: New interface for iterator functions 
Closes https://github.com/espressif/esp-idf/issues/7826

* nvs_entry_find(), nvs_entry_next() and nvs_entry_info()
  return error codes now
* nvs_entry_find() and nvs_entry_next() access/modify iterator via
  parameters, instead of returning an new iterator.

Added appropriate documentation in Chinese and English
 2022-05-30 09:28:42 +08:00
wangmengyang
1423d02cb0 Added BT_SDP API reference document 2022-05-28 23:34:21 +00:00
xiongweichao
b2987c1e94 Added BT_L2CAP API reference document 2022-05-28 23:34:21 +00:00
Song Ruo Jing
cf32e49aeb Merge branch 'refactor/cleanup_rtc_h' into 'master' 
clk_tree: Prework2 of introducing clock subsystem control

Closes IDF-4934

See merge request espressif/esp-idf!17861
 2022-05-26 09:16:47 +08:00
songruojing
729d70129a clk_tree: add initial docs for clock tree 2022-05-24 22:59:51 +08:00
morris
b26cd91537 doc: added clk_tree definitions to doc 2022-05-24 22:59:51 +08:00
unknown
5a1c257f96 docs: sync up line number for api reference 2022-05-23 20:30:29 +08:00
Shang Zhou
4ad048f05f Merge branch 'docs/update_cn_translation_of_16452_and_16658' into 'master' 
docs: updated CN translation for !16452 and !16658

Closes DOC-2828 and DOC-2827

See merge request espressif/esp-idf!18007
 2022-05-20 03:57:52 +08:00
Shang Zhou
ed1bf1d056 docs: updated CN translation for !16452 and !16658 2022-05-20 03:57:51 +08:00
Martin Vychodil
dea461d481 Merge branch 'docs/update_cn_trans_for_fatfs.rst' into 'master' 
Docs: update cn trans for fatfs.rst

Closes DOC-3083

See merge request espressif/esp-idf!18124
 2022-05-19 19:40:24 +08:00
Marius Vikhammer
030e52f5d4 Merge branch 'feature/improve_doc_link_check' into 'master' 
docs: fix broken links and re-enable linkchecker

Closes IDF-2640

See merge request espressif/esp-idf!17919
 2022-05-19 15:52:17 +08:00
morris
8138f8bb02 driver: remove deprecated code 
that declared as deprecated in the previous release
 2022-05-19 11:31:53 +08:00
mofeifei
4d0724984c docs: update cn trans for fatfs.rst 2022-05-17 11:36:03 +08:00
mofeifei
4be8497391 docs: add cn trans for system_time 2022-05-13 14:10:35 +08:00
Marius Vikhammer
030cb77597 docs: update redirected links 2022-05-07 13:09:41 +08:00
Marius Vikhammer
d7053c38cc docs: fix broken links 2022-05-07 13:09:41 +08:00
Jiang Jiang Jian
34211f898c Merge branch 'docs/update_esp_hid_device' into 'master' 
[docs] fix documents for Bluetooth HID Device API reference and example

See merge request espressif/esp-idf!17558
 2022-05-05 23:58:07 +08:00
zhangyanjiao
7e0090b029 modify API-reference using Sphinx directives 2022-04-26 10:18:41 +08:00
zhangyanjiao
e3b8f59867 update wifi api docs 2022-04-24 23:55:54 +08:00
xueyunfei
26fa8260b1 Doc:update wifi api docs 
* Add documents related to espnow config rate

* Optimization set dns server api description
 2022-04-24 21:20:54 +08:00
Marius Vikhammer
45c1d1cba2 Merge branch 'feature/move_target_kconfig_2' into 'master' 
system: move kconfig options out of target component

See merge request espressif/esp-idf!17321
 2022-04-24 13:29:43 +08:00
Marius Vikhammer
d2872095f9 soc: moved kconfig options out of the target component. 
Moved the following kconfig options out of the target component:
 * CONFIG_ESP*_DEFAULT_CPU_FREQ* -> esp_system
 * ESP*_REV_MIN -> esp_hw_support
 * ESP*_TIME_SYSCALL -> newlib
 * ESP*_RTC_* -> esp_hw_support

Where applicable these target specific konfig names were merged into
a single common config, e.g;
CONFIG_ESP*_DEFAULT_CPU_FREQ -> CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ
 2022-04-21 12:09:43 +08:00
mofeifei
3a35ed7cfa docs:change system.rst name 2022-04-20 13:11:02 +08:00
mofeifei
485cdd9a74 docs: add cn trans for system.rst 2022-04-20 13:07:38 +08:00
songruojing
534346f4bb ledc: Provide support for esp32c2 and esp32h2 
LEDC examples, unit test, and programming guide are all updated.
 2022-04-14 08:15:14 +00:00
mofeifei
6b2d551ecc docs: add cn trans for sleep-modes 2022-04-13 10:37:59 +00:00
Matus Fabo
24268d47a2 change: renamed FATFS convenience mounting functions 
change: renamed every instance of these functions
add: deprecation notice with old functions
change: CC0 licence to CC0-1.0 in fatfsgen_example_main.c
 2022-04-11 08:44:40 +00:00
wangmengyang
0760a969a8 component/docs: enable generation of API-reference documents for Bluetooth HID device 2022-04-11 02:50:50 +00:00
Adam Múdry
36db6a6681 spiffs: Add esp_spiffs_check() function 
esp_spiffs_check() exposes SPIFFS_check() functionality to the user
 2022-04-08 19:40:56 +00:00
Marius Vikhammer
a6543f0d21 docs: fix broken references to misc API functions and types. 2022-03-27 16:46:57 +08:00
Laukik Hase
660134b1a3
docs: Add documentation for mbedtls 2022-03-16 17:22:33 +05:30
Martin Gaňo
fea2b5b64e fatfsgen.py: enabled long names support 
Closes https://github.com/espressif/esp-idf/issues/8171
 2022-03-11 11:20:31 +01:00
Shang Zhou
83fcf44e65 docs: provide CN translation for MR17066 2022-03-10 08:26:12 +01:00
David Cermak
795b7ed993 esp_netif: Remove tcpip_adapter compatibility layer 2022-03-10 08:19:43 +01:00
Jiang Jiang Jian
7c7e8a83b9 Merge branch 'refactor/wifi_remove_legacy_evts' into 'master' 
Remove legacy system event framework.

Closes IDF-3608

See merge request espressif/esp-idf!16240
 2022-03-10 10:30:10 +08:00
Simon
fb4ee8e31f Merge branch 'feature/support_hpm_on_flash' into 'master' 
spi_flash: Building a framework to enable HPM when flash works under high speed mode, take GD as an example.

Closes IDF-4537

See merge request espressif/esp-idf!16660
 2022-03-10 03:04:21 +08:00
morris
b841332aa5 Merge branch 'component/esp_websocket_migration' into 'master' 
websocket: Remove internal component, examples and test

Closes IDF-4076

See merge request espressif/esp-idf!17273
 2022-03-09 19:12:55 +08:00
Cao Sen Miao
a0bd06af54 spi_flash: Add documents for flash optional features 2022-03-09 18:49:34 +08:00
Sagar Bijwe
6501eff7f5 Remove legacy system event framework. 2022-03-09 15:53:45 +05:30
intern
e43bf8510b docs: update readme and power management cn trans 2022-03-09 14:22:36 +08:00
gabsuren
f3c7215565 websocket: Remove internal component, examples and test 2022-03-07 11:07:40 +04:00
intern
6151cc8b68 docs: update cn trans for upl docs 2022-03-02 19:03:20 +08:00
Sudeep Mohanty
4067bc40fc docs: Updated ULP documentation 
This commit updates documentation for ULP.
 2022-03-01 09:02:41 +05:30
Dai Zi Yan
7c8c7e8b83 Merge branch 'docs/updated_CN_Trans_api-guides' into 'master' 
Docs/updated CN trans for api-guides

See merge request espressif/esp-idf!17224
 2022-02-28 16:00:37 +08:00
Kevin (Lao Kaiyao)
cc1d89ebba Merge branch 'feature/i2c_support_on_esp8684_esp32h2' into 'master' 
i2c: support i2c on esp32c2 and esp32h2

Closes IDF-3918

See merge request espressif/esp-idf!16444
 2022-02-28 13:59:02 +08:00
daiziyan
6b8420e877 docs: updated CN translation for using-debugger, windows-setup, resources and index 2022-02-25 10:44:22 +00:00
David Cermak
0630834bc3 openssl: Remove deprecated component 2022-02-23 13:08:12 +01:00
laokaiyao
cf353c505a i2c: support esp32h2 2022-02-23 15:19:37 +08:00
Shang Zhou
33a00cf197 docs: Updated CN translation for index files in api-guides and api-reference 2022-02-23 14:48:26 +08:00
Marius Vikhammer
6d50a8dd7a docs: remove peripherals that are not supported from C2 docs 2022-02-16 10:22:46 +08:00
songruojing
31f9a69454 ledc: Update LEDC programming guide 
Add source clock in timer config
Add fade end callback and ledc_fade_stop usage
Explain ledc_fade_mode_t difference and limitation
 2022-01-27 19:13:53 +08:00
Omar Chebib
08b1d7544b Merge branch 'breaking/remove_custom_uart_isr' into 'master' 
UART & I2C: remove custom ISR registration function

See merge request espressif/esp-idf!16798
 2022-01-26 03:54:14 +00:00
Zim Kalinowski
67f51a4ce5 Merge branch 'bugfix/riscv_i2c_description' into 'master' 
i2c: fix the controller count in the header description

Closes IDFGH-6476

See merge request espressif/esp-idf!16718
 2022-01-26 03:13:07 +00:00
Omar Chebib
473974c8f6 UART & I2C: remove custom ISR registration function 
Breaking change for v5.0: custom UART ISR and I2C ISR cannot be installed anymore.
 2022-01-25 14:46:43 +08:00
Armando (Dou Yiwen)
7967a317d6 Merge branch 'feature/add_flash_suspend_example' into 'master' 
system: add an example showing how to run non-iram ISR when operating Flash

Closes IDF-4501

See merge request espressif/esp-idf!16658
 2022-01-24 07:40:00 +00:00
Armando
49658faaf0 doc: add flash suspend feature to iram usage doc 2022-01-24 12:59:29 +08:00
laokaiyao
cf049e15ed esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
David Cermak
10dc8543c5 vfs/lwip: Fix docs on select() referencing wrong config 
CONFIG_LWIP_USE_ONLY_LWIP_SELECT was deprecated long time ago and removed (~ in v4.x).
Used CONFIG_VFS_SUPPORT_SELECT instead (and reverted the logic as this
is ON by default and needs to be explicitly turned off for socket only
select)
 2022-01-14 16:41:38 +01:00
Omar Chebib
bb730292d4 i2c: fix the controller count in the header description 
Closes https://github.com/espressif/esp-idf/issues/8133
 2022-01-13 18:25:41 +08:00
morris
5145183947 Merge branch 'refactor/timer_group_new_api' into 'master' 
⛵ GPTimer driver (previous Timer Group)

Closes IDF-2082 and IDF-2883

See merge request espressif/esp-idf!8317
 2022-01-07 10:54:32 +00:00
daiziyan
20374161a6 docs: Updated CN translation for esp-ble-mesh, wifi, spi_flash and fata-errors; And keep line number consistency for en/index and versions 2022-01-07 16:05:16 +08:00
morris
e36f47a153 doc: API reference for GPTimer 2022-01-07 14:59:09 +08:00
Darian Leung
3b29030e10 docs: Update Power Management and Sleep Modes docs for ESP32-S3 2022-01-06 10:04:29 +08:00
intern
b0a2dda075 docs: add application example for esp-now 2022-01-05 16:17:28 +08:00
Jakob Hasse
39f3e082e1 Merge branch 'docs/update_CN_trans_get_started' into 'master' 
docs:update CN transalation for get-started section and sdmmc

Closes DOC-2383 and DOC-2380

See merge request espressif/esp-idf!16369
 2021-12-27 07:11:40 +00:00
Michael (XIAO Xufeng)
54dcd4d4d6 docs/sdspi: add documentation about sharing SPI bus among SD card and other devices 2021-12-27 04:39:32 +00:00
daiziyan
a98212015f docs:update CN transalation for get-started section and sdmmc 2021-12-21 18:43:56 +08:00
Marius Vikhammer
82325f6037 docs: update docs to be able to build with esp8684 2021-12-20 10:32:49 +08:00
daiziyan
c82881eaee docs: update CN translation for vfs and nvs_flash 2021-12-10 17:02:47 +08:00
daiziyan
c642661411 docs: update CN translation for esp_wifi and jtag-dubugging/index, and fix typos in esp_spi_slave_protocol 2021-12-07 15:36:50 +08:00
daiziyan
c34ccb1bdf docs: update CN translation for fatfs.rst 2021-12-02 11:47:06 +08:00
Simon
fc14d3f9aa Merge branch 'doc/update_usj_docs' into 'master' 
docs: update usb_serial_jtag documents

Closes IDF-3202 and DOC-2301

See merge request espressif/esp-idf!15922
 2021-11-23 07:41:53 +00:00
Dai Zi Yan
1ca83a5bc9 Update CN trans for timers.rst and ota.rst 2021-11-23 07:16:11 +00:00
Cao Sen Miao
4ae714c43c docs: update using usb_serial_jtag documents 2021-11-23 14:12:13 +08:00
Marius Vikhammer
b6a06b7533 docs: remove invalid symbol from ota.rst file 2021-11-18 11:37:09 +08:00
daiziyan
0ff2776b1e docs: update CN translation for ota.rst and console.rst 2021-11-16 19:23:09 +08:00
Roland Dobai
9c1d4f5b54 Build & config: Remove the "make" build system 
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
 2021-11-10 09:53:53 +01:00
weitianhua
497eaca1a3 Make ESP32 Bluetooth stack architecture Doc only visible for ESP32 2021-10-27 20:47:50 +08:00
weitianhua
64aa94d823 Make Classic BT related document links only visible for ESP32 2021-10-27 15:28:47 +08:00
Ivan Grokhotkov
c77950e9fe Merge branch 'doc/api_stability' into 'master' 
docs: add a section about API conventions and stability

Closes IDFGH-2658

See merge request espressif/esp-idf!14449
 2021-10-18 14:19:12 +00:00
Shang Zhou
3ffc5f0c67 docs:update CN translation for API reference storage(fatfs and index) 2021-10-15 18:59:22 +08:00
Marek Fiala
ff18a96f7d tools: replace _ with - in idf.py 
Closes https://github.com/espressif/esp-idf/issues/5126
 2021-10-13 17:30:38 +08:00
Kevin (Lao Kaiyao)
a9faafee3c Merge branch 'feature/touch_sensor_driver_support_for_esp32s3' into 'master' 
driver(touch): support touch sensor for esp32s3 platform

Closes IDF-1784 and IDF-3302

See merge request espressif/esp-idf!14102
 2021-10-12 05:50:58 +00:00
laokaiyao
a1cadba191 touch_sensor: apply general check 2021-10-08 11:32:12 +08:00
laokaiyao
fc73e2b7bd doc/touch: update touch sensor doc for S3 2021-10-08 10:39:46 +08:00
suda-morris
aa73e423d4 lcd: initial build of API docs 2021-10-02 14:23:31 +08:00
daiziyan
aca4a18c50 docs:update CN translation for bootloader, partition-tables, i2c, and ledc 2021-09-18 19:25:38 +08:00
Ivan Grokhotkov
19a75177a8 docs: fix syntax errors in only:: blocks 2021-09-07 14:00:53 +08:00
Shang Zhou
be189b1cfd updated the TOC of ESP-IDF API Reference to make it consistet with the real section title 2021-09-03 16:27:14 +08:00
Darian Leung
963836f491 Add USB Host Library API docs 
- This commit adds the API documentation for the USB Host Library.
- Warnings about the beta API are also added.
- usb_host_misc.h renamed to usb_helpers.h
 2021-09-02 18:40:24 +08:00
Ivan Grokhotkov
c8640d38a7 docs: add a section about API conventions and stability 
Closes https://github.com/espressif/esp-idf/issues/4732
 2021-08-31 14:41:48 +02:00
intern
45925c28fd docs: update translation for jtag-debugging/index.rst and power_management.rst 2021-08-26 12:21:19 +08:00
Ivan Grokhotkov
a005e9bfbc docs: move VFS documentation into the component directory 
These files were added into the component directory back when we
didn't have the documentation directory, and weren't moved once the
documentation directory was created.
 2021-08-23 07:02:19 +02:00
Nachiket Kukade
f38b18f046 docs: Separate Doc on WiFi security, added DPP Doc 
1. Add new Doc on WiFi security
2. Add DPP related Doc under WiFi
3. Add Supplicant public headers in Doxyfile
 2021-08-10 12:35:43 +05:30
Wang Fang
59aa60d52a Merge branch 'docs/provide_apb_clock_frequency_in_api-reference_timers' into 'master' 
docs: provide APB clock frequency in api-reference/timers

Closes DOC-1689

See merge request espressif/esp-idf!14593
 2021-08-06 06:50:26 +00:00
Wang Fang
0ba73ee7e2 docs: provide APB clock frequency in api-reference/timers 2021-08-06 11:05:32 +08:00
Shu Chen
ee6b1736c6 Merge branch 'feature/add-openthread-docs' into 'master' 
docs: add OpenThread docs

See merge request espressif/esp-idf!14488
 2021-08-05 03:56:43 +00:00
Jiacheng Guo
ba5b7ddded docs: add OpenThread docs 2021-08-02 17:17:38 +08:00
morris
2218204aa7 doc: update tinyusb document to support esp32s3 
1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of
   another USB related peripheral: USB_JTAG_SERIAL
2. correct related document
 2021-07-22 10:43:10 +08:00
Cao Sen Miao
69ad24c943 temp_sensor: add docs for esp32c3 2021-07-21 13:34:52 +08:00
Dai Zi Yan
a68fd59b02 Merge branch 'docs/rename_ESP-MESH_to_ESP-WIFI-MESH' into 'master' 
docs: rename ESP-MESH to ESP-WIFI-MESH

Closes DOC-7

See merge request espressif/esp-idf!14252
 2021-07-13 02:23:43 +00:00
daiziyan
e95893bb1b docs: rename ESP-MESH to ESP-WIFI-MESH 2021-07-12 19:25:18 +08:00
Cao Sen Miao
fecf27e54c spi_flash: add support for 32Mbit address GD flash, for GD25Q256 2021-07-02 17:13:51 +08:00
Dai Zi Yan
5e5ddb1ffb docs:fixthe number of general purpose timers for ESP32-C3 2021-06-29 14:33:06 +08:00
daiziyan
e1ad9a1d20 docs:update CN translation for fatal-errors, external-ram, and idf-monitor 2021-06-21 18:05:18 +08:00
Wang Ning
2c31ac24c1 docs/add_how_to_debug_ota_failure_to_api_references 2021-06-16 19:28:01 +08:00
Ivan Grokhotkov
228fc04646 Merge branch 'example/ledc_pwm_basic' into 'master' 
Example: Added LEDC basic PWM example

Closes DO-70

See merge request espressif/esp-idf!13114
 2021-06-15 11:12:46 +00:00
Marius Vikhammer
bdfda351bd build docs: enable building of S3 docs 
* Added suport for building esp32s3 docs
 * Fixed all related warnings
 * Activated building of S3 docs for build HTML fast CI job
 2021-06-09 09:30:36 +08:00
Wang Fang
71141a326d docs: clarified esp32 timer clk source, updated the flash encryption table and esptrace doc 2021-05-24 03:46:40 +00:00
Angus Gratton
e14edecf5f docs: Add random number generation to the API Reference System section 2021-05-18 16:05:42 +10:00
Angus Gratton
b7ad39f694 Merge branch 'bugfix/pthread_docs' into 'master' 
Fix and improve pthread docs, create pthread example

Closes IDF-731 and IDFGH-5085

See merge request espressif/esp-idf!13314
 2021-05-14 01:19:02 +00:00
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
Marius Vikhammer
fd477fa60e docs: remove front page C3 docs not updated warning 2021-05-13 09:58:20 +08: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
Dai Zi Yan
4aa52da0c1 update CN translation for I2C 2021-04-22 16:05:01 +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
Angus Gratton
cef3b26a91 Merge branch 'refactor/move_from_esp_system' into 'master' 
Movements from esp_system

Closes IDF-2165

See merge request espressif/esp-idf!12695
 2021-04-08 10:16:08 +00:00
Michael (XIAO Xufeng)
925dacd7fb Merge branch 'bugfix/remove_HSPI_macro_on_c3' into 'master' 
spi: remove HSPI macros on esp32c3 and esp32s3

Closes IDF-2535

See merge request espressif/esp-idf!12637
 2021-04-08 09:33:18 +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
Armando
9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 13:42:49 +08:00
daiziyan
540e9c57e4 docs:update CN translation for spiffs and touch_pad 2021-03-31 20:08:22 +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
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
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
Dai Zi Yan
8ae944e26c docs:update CN translation for documenting-code and LEDC 2021-03-23 10:52:50 +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
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
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
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
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
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
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
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
daiziyan
3d2d0e2247 update CN translation for ulp-risc-v partition-table tips-and-quirks and idf-monitor for api-guides 2021-01-28 19:42:54 +08:00
Marius Vikhammer
da947d736f Docs: Add C3 support to build_docs 2020-12-28 12:25:03 +08:00
morris
1be923acb4 rmt: rename always_on to aware_dfs 2020-11-05 19:00:55 +08:00
Renz Bagaporo
79887fdc6c soc: descriptive part occupy whole component 2020-10-28 07:21:29 +08:00
morris
91cf7cc58d doc: dedicated gpio api reference 2020-10-20 21:06:10 +08:00
Ivan Grokhotkov
840efc2f54 docs: describe power management logic for ESP32-S2, fix translation 2020-10-14 09:05:10 +02:00
Krzysztof Budzynski
e0261f18ce Merge branch 'feature/add_esp_rom_printf_to_api_reference' into 'master' 
docs: Add esp_rom_printf to API Reference

Closes DOC-454

See merge request espressif/esp-idf!10251
 2020-10-09 04:06:10 +08:00
Felipe Neves
2e826b7a8f intr_alloc: split interrupt allocator into common-code and platform-code 
esp_system: removed repeated interrupt allocator code and moved common code to esp_system

xtens: moved xtensa specific code from freertos to the xtensa component

hal/interrupt_controller: added interrupt controller hal and ll files

docs: update the doxyfile with new location of esp_itr_alloc.h file

xtensa: fixed dangerous relocation problem after moving xtensa interrupt files out of freertos

docs: removed Xtensa reference from intr_allocator api-reference

xtensa: pushed the interrupt function that manages non iram interrupts to the xtensa layer

esp_system/test: fixed platform dependent setting for intr_allocator tests

hal: rename the functions used to manage non iram interrupt mask.
 2020-09-30 07:44:12 +08:00
Krzysztof
db0c6d7921 docs: Add esp_rom_printf to API Reference 2020-09-10 22:55:43 +08:00
Andrei Gramakov
c863b4c777 docs: tinyusb documentation 2020-08-27 13:49:33 +02:00
Dai Zi Yan
7bc6662184 Add Chinese translation to I2C.rst 2020-08-26 22:08:50 +08:00
morris
b30bd7a2ef esp32s2: add CP_DMA driver 2020-08-04 15:28:32 +08:00
Felipe Neves
938a73756c esp_common/shared_stack: modifed the stack switch procedure to a simpler way 
esp_common/shared_stack: refactored the implemenation of shared stack function (still not working properly)

esp_expression_with_stack: refactored the shared stack function calling mechanism and updated the documentation
 2020-07-14 12:56:02 +00:00
sU8U7SfkcwTJVH7PjaVmej7D
6673407f98 httpd_resp_send: use HTTPD_RESP_USE_STRLEN when possible 2020-07-13 05:34:56 +00:00
Michael (XIAO Xufeng)
f6dd63d03d spi_slave_hd: new driver for spi slave in half duplex mode 2020-07-11 00:00:50 +08:00
morris
29f8aecfc0 console_repl: change config structure to support different devices 2020-07-02 07:39:46 +00:00
Darian Leung
97721d469c TWAI: Add ESP32-S2 support 
This commit adds TWAI driver support for the
ESP32-S2. The following features were added:

- Expanded BRP support
- Expanded CLKOUT Divider Support
- Updated example READMEs
 2020-06-30 16:56:03 +08:00
Jakob Hasse
516680a4ff Doc: DS documentation for S2 2020-06-04 10:49:22 +08:00
Krzysztof Budzynski
56635f22b8 Merge branch 'doc/add_types_api_ref' into 'master' 
doc: add peripheral_types.h as API reference for peripheral docs

Closes DOC-136 and IDF-1673

See merge request espressif/esp-idf!8528
 2020-05-25 03:22:22 +08:00
Aditya Patwardhan
423e600d46 secure_element: atecc608_ecdsa example 
* Replaced crypotoauthlib with esp-cryptoauthlib
* Added menuconfig option for esp-tls about using HSM
* Added error codes for HSM in esp-tls,
* Added support to select different type of ATECC608A chips
* Added README, updated docs
* tcp_transport: Added option to enable secure_element for ssl

Closes https://github.com/espressif/esp-idf/issues/4432
 2020-05-21 13:08:30 +05:30
Krzysztof Budzynski
7099c2b444 Merge branch 'doc/generate_idf_project_tags' into 'master' 
doc: add generation of tags from sdkconfig and x_caps.h headers

Closes IDF-1484

See merge request espressif/esp-idf!8577
 2020-05-20 23:46:47 +08:00
Krzysztof Budzynski
e58c0ac3e7 Provide a brief description of SmartConfig and add link to example 2020-05-18 01:02:04 +08:00
Marius Vikhammer
fbb54184ef doc: add generation of tags from sdkconfig and x_caps.h headers 
Also updates the way we handle exclude_patterns to use the new tags

Closes IDF-1484
 2020-05-13 07:09:01 +00:00
Marius Vikhammer
27fa1dc0dd doc: add peripheral_types.h as API reference for peripheral docs 
Closes DOC-136
Closes IDF-1673
 2020-05-11 11:20:39 +08:00
Krzysztof Budzynski
c5c026557e Merge branch 'doc/hmac_S2' into 'master' 
Doc: Documentation for HMAC module

See merge request espressif/esp-idf!8383
 2020-04-27 19:03:01 +08:00
Jakob Hasse
2da7e65646 Doc: S2 HMAC documentation 2020-04-27 12:25:46 +08:00
Michael (XIAO Xufeng)
7ec4d64b80 spi: Update documents about the bus lock and how to use SPI Master on SPI1 bus 2020-04-23 12:27:25 +08:00
Wang Ning
6d3f35f651 Fix a typo error based on DOC-111 2020-04-15 09:08:43 +00:00
morsisko
9759aa4ad2 Fixed syntax error in esp_http_server.rst 
Merges: https://github.com/espressif/esp-idf/pull/5021
 2020-03-31 14:59:27 +00:00
Wang Ning
3784d499af Add translation for ota tool and partation tool 2020-03-25 21:44:33 +08:00
Angus Gratton
a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master' 
rmt: support ref tick && refactor unit test && re-enable unit test on ESP32-S2

Closes IDFGH-1715

See merge request espressif/esp-idf!7614
 2020-03-06 15:03:52 +08:00
Angus Gratton
b393203b27 Merge branch 'feature/x509_cert_management' into 'master' 
X509 certificate management

Closes IDF-296

See merge request espressif/esp-idf!5346
 2020-03-06 14:29:53 +08:00
Marius Vikhammer
947e3e94ed Add ESP certificate bundle feature 
Adds the ESP certificate bundle feature that enables users to bundle a
root certificate bundle together with their application.

Default bundle includes all Mozilla root certificates

Closes IDF-296
 2020-03-04 10:51:43 +08:00
morris
0e4d82bc55 rmt: support REF_TICK as channel clock source 
Closes https://github.com/espressif/esp-idf/pull/3952
 2020-03-03 20:14:46 +08:00
Marius Vikhammer
c26a765a37 doc: remove uncessary .. only:: dirs 
Removed some only directives that are no longer needed with include being processed correctly
 2020-03-03 11:37:42 +08:00
Angus Gratton
99cdddeb63 docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-18 10:34:11 +11:00
suda-morris
75cadc2e41 console: simplify examples 
1. simplify console examples
2. add "quit" command
3. support console command overwrite
4. add API reference
 2020-02-07 20:15:06 +08:00
Angus Gratton
11fac8637a docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
Marius Vikhammer
268816649c Replace all TRM urls will generic template variable and remove duplicate sections 
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
 2020-02-07 16:37:45 +11:00
Anton Maklakov
a2516c6188 doc: Add a link to CN translation for power_management_esp32 2020-02-07 16:37:44 +11:00
Marius Vikhammer
1a90470f02 doc: Split HW-Reference into seperate files/folders for different chips 2020-02-07 16:37:44 +11:00
Marius Vikhammer
cfeb9e68cb doc: Changed Chinese doc to use dynamic chip name 2020-02-07 16:37:43 +11:00
Angus Gratton
66462ca26f docs: Apply the same basic ESP32/ESP32-S2 warning filters to Chinese docs 2020-02-07 16:37:43 +11:00
Angus Gratton
e6211c7864 docs: add new top-level docs builder that builds docs for a single chip 2020-02-07 16:37:43 +11:00
morris
f2cb6bd4b6 doc: fix broken example links 2020-01-21 12:11:24 +08:00
Wang Ning
0093f50214 Add Chinese translation to LEDC. 
Need technical and language review.
 2020-01-16 10:13:40 +08:00
KonstantinKondrashov
c23549c04f docs: Add System time chapter and for sntp a description about using CONFIG_LWIP_SNTP_UPDATE_DELAY option 
Closes: https://github.com/espressif/esp-idf/issues/4386
Closes: IDFGH-2237
Closes: IDF-1199
 2020-01-10 14:49:07 +11:00
Angus Gratton
17b5df4d72 Merge branch 'feature/function_call_with_stack' into 'master' 
esp_common: added a macro to allow call functions using user allocated stack

Closes IDF-535

See merge request espressif/esp-idf!6709
 2019-12-31 15:08:27 +08:00
Natasha
1b740c55a3 Add translation for Network files 2019-12-31 14:53:55 +08:00
Felipe Neves
88dd15c806 docs: synchronized the contents of en with cn folders adding the esp-expression-with-stack documentation 2019-12-20 13:18:13 -03:00
Natasha
0c444c06a7 add translation for esp_mesh doc 2019-12-19 15:16:50 +08:00
David Cermak
ac47c74ec4 esp_netif, docs: Added programmer's manual section 
Also added guide for creating a custom network capable I/O driver
And added notes about default wifi interfaces and implications of using
default short-hand creation functions.
 2019-12-17 09:02:51 +01:00
Angus Gratton
70cfd7e24c Merge branch 'bugfix/ethernet_pm_lock' into 'master' 
ethernet: add pm lock

Closes IDF-1053

See merge request espressif/esp-idf!6881
 2019-12-04 15:06:12 +08:00
Michael (XIAO Xufeng)
087c8f6065 essl: new component to communicate with esp serial slave devices 2019-12-03 22:58:41 +08:00
morris
57ef88a91f ethernet: add pm lock 2019-12-03 16:10:20 +08:00
weitianhua
7c18299571 Add AG component API_REFERENCE 
Expose esp_hf_indchange_notification to this example.
 2019-11-27 13:35:35 +00:00
Fu Zhi Bo
3a468a1ffd Refactor the touch sensor driver 2019-11-27 20:08:44 +08:00
David Cermak
1a012b7ad2 esp_netif: docs update to include tcpip_adapter migration guide 
added migration guide link to the esp-netif page and network page
added redirects from tcpip_adapter to new esp_netif
 2019-11-25 08:32:11 +01:00
Krzysztof Budzynski
29b2235506 Merge branch 'doc/mdns_zh_CN' into 'master' 
zh_CN translation of mdns service

See merge request espressif/esp-idf!4590
 2019-11-18 16:42:20 +08:00
morris
9691a755f6 zh_CN translation of mdns service 2019-11-14 13:28:04 +08:00
David Cermak
d471266b46 esp_netif: documentation udpated and grouped the esp-netif API 
structure. Updated rst documenentation and diagram of esp-netif
cooperation with other components.
 2019-11-13 12:36:25 +01:00
Angus Gratton
c5ef1cae04 Merge branch 'feature/perfmon' into 'master' 
Performance monitor component

See merge request espressif/esp-idf!4705
 2019-11-04 18:25:14 +08:00
lly
7fde866d8c doc: fix wrong title of ble mesh terminology 2019-10-31 17:06:17 +08:00
Krzysztof Budzynski
2c3548b65e Provide BLE Mesh documentation 2019-10-30 17:01:18 +08:00
Angus Gratton
7ce75a42c7 Merge branch 'master' into feature/esp32s2beta_merge 2019-10-25 15:13:52 +11:00
suda-morris
7bdd5f639b doc: add api reference for icmp_echo 2019-10-22 04:38:09 +00:00
Ivan Grokhotkov
5830f529d8 Merge branch 'master' into feature/esp32s2beta_merge 2019-10-02 19:01:39 +02:00
Wang Fang
32adfdc307 Add Chinese translation for the 2nd batch of the files in storage folder in api-reference. 
1. The translation should be first reviewed by technical reviewers;
2. and then by language reviewers.

For the translation for the first batch of files, please see !MR5620 and !MR5613
 2019-09-20 12:32:55 +08:00
Angus Gratton
adfc06a530 Merge branch 'master' into feature/esp32s2beta_merge 2019-09-20 10:28:37 +10:00
Wang Fang
412a766a2a Add Chinese transaltion to sdmmc in storage folder 
The translation should be first reviewed by technical reviewer Xiao Xufeng and then by Carrie

The translation for the other documents in storage folder can be found in MR5613, MR5620 and MR5737.
 2019-09-18 13:28:16 +08:00
Wang Fang
fb0bf099a3 Add Chinese translation for touch_pad.rst in api-reference: 
1. Add link to en/api-reference/peripherals/touch_pad.rst
2. Add Chinese translation to zh_CN/api-reference/peripherals/touch_pad.rst
 2019-09-17 11:22:30 +08:00
Angus Gratton
438d513a95 Merge branch 'master' into feature/esp32s2beta_merge 2019-09-16 16:18:48 +10:00
Wang Fang
bea507378e Add Chinese translation for README files in components and tools folders, including: 
1. components/nvs_flash/nvs_partition_generator/README_CN.rst
2. components/wear_levelling/README_CN.rst
3. tools/mass_mfg/docs/README_CN.rst
 2019-09-06 20:18:19 +08:00
Wang Fang
758abe6e01 Add Chinese translation for the rst documents in storage folder, including: 
1. docs/zh_CN/api-reference/storage/fatfs.rst
2. docs/zh_CN/api-reference/storage/index.rst
3. docs/zh_CN/api-reference/storage/sdmmc.rst
4. docs/zh_CN/api-reference/storage/spiffs.rst
5. docs/zh_CN/api-reference/storage/wear-levelling.rst
 2019-09-06 19:12:36 +08:00
Hao Ning
eb2ddbfe48 add chinese translation for timer.rst in api-reference folder 2019-09-04 17:09:13 +08:00
Dmitry
a0730fec2a Performance monitor component. The component contains APIs, example and 
documentation.
 2019-08-23 11:20:12 +03:00
Angus Gratton
24d26fccde Merge branch 'master' into feature/esp32s2beta_update 2019-08-08 13:44:24 +10:00
fuzhibo
572084821b add Comment for touchpad 2019-08-07 11:39:17 +08:00
Wang Ning
d767e0edc7 Add Chinese translation to api-reference/network/esp_smartconfig.rst 2019-07-19 19:04:44 +08:00
Anurag Kar
b75f8b1b20 ESP Local Control Feature Added 
List of changes:
* New component esp_local_ctrl added
* Example added under examples/protocols/esp_local_ctrl
* Documentation added under protocols/esp_local_ctrl
* Demo client side app esp_local_ctrl.py added under examples/protocols/esp_local_ctrl/scripts
* protocomm_ble : protocomm_ble_config_t given struct name for allowing forward declaration
* esp_prov/transport_softap renamed to transport_http
* transport_http module supports verification of server certificate
* transport_http module performs name resolution before connection
 2019-07-03 21:31:04 +05:30
Hrishikesh Dhayagude
cba69dd088 Bluetooth examples restructuring 
The existing Bluetooth examples are split as:

1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples
   a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples
   b. examples/bluetooth/bluedroid/ble - BLE examples
   c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples
   d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples
      i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder
2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples
3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples
4. Update documentation references
 2019-07-01 19:21:57 +08:00
Wang Fang
32954e5f90 Add Chinese translation to api-reference/system/power-management.rst 
1. Add translation to docs/zh_CN/api-reference/system/power_management.rst
2. Add a link to docs/en/api-reference/system/power_management.rst
 2019-06-26 20:42:56 +08:00
Hrishikesh Dhayagude
342f6a7829 Port NimBLE Host Stack on ESP-IDF 2019-06-25 09:03:58 +08:00
Angus Gratton
5cb71b5213 Merge branch 'feature/add_doc_about_app_desc_t' into 'master' 
docs: Add description about the app image

Closes IDF-597

See merge request idf/esp-idf!4912
 2019-06-24 18:40:02 +08:00
Konstantin Kondrashov
12a7d39ed6 docs: Add description 2019-06-24 12:33:33 +08:00
Tuan
2a2d932cfe esp_websocket_client: Add websocket client component 
Closes https://github.com/espressif/esp-idf/issues/2829
 2019-06-20 15:37:40 +08:00
Wang Fang
2864d6deb3 Add Chinese translation for index.rst files and esp_wifi.rst file in api-reference following Kirill's English review, including: 
-network/index.rst
-network/esp_wifi.rst
-peripherals/index.rst
-provisioning/index.rst
 2019-05-15 21:05:44 +08:00
Ivan Grokhotkov
6890ea09cd docs: add event handling API guide 2019-04-11 12:04:58 +08:00
morris
9efd7d3d34 zh_CN translation of HTTP Server API reference 2019-03-20 16:45:16 +08:00
Konstantin Kondrashov
ba903e7618 docs: Add efuse 2019-02-28 07:31:29 +00:00
Angus Gratton
ede47ed33a tcpip_adapter: Update header descriptions, constify some parameters 2018-12-18 14:07:43 +11:00
Angus Gratton
6a4955ef74 doc: Rearrange wifi & ethernet docs into a common "network" doc 2018-12-17 14:18:09 +11:00
Anurag Kar
aa6066a197 esp_https_server : Docs and API references fixed 2018-11-19 04:00:21 +00:00
Renz Christian Bagaporo
5a83347bec event: Implement event loop library 2018-10-26 13:14:19 +08:00
Anurag Kar
12b60c51be HTTP Server Docs : Replace http_server with esp_http_server 2018-10-24 17:32:43 +05:30
Alex Lisitsyn
f0eb9985b9 examples: freemodbus port slave basic implementation 
This example adds functionality to support basic communication in RS485 networks using Modbus protocol.
This example uses FreeModbus stack and regular UART driver API to communicate in RS485 half duplex mode.
Added initial support of modbus controller pure C api to access device parameters over Modbus transport.
Move freemodbus stack and port files into components folder
Move the modbus_controller interface into components idf folder
Source files updated after review.
Add modbus interface documentation docs/en/api-reference/protocols/modbus.rst
porttimer.c: fix bug with timer1 selected in the Kconfig
Add support of cmake system (added cmake files)

Closes https://github.com/espressif/esp-idf/issues/858
 2018-10-17 12:47:12 +02:00
Jeroen Domburg
81e35a142a Spiram: Add option to reserve MMU banks; add himem API to make use of those banks 2018-10-15 14:32:58 +08:00
Anurag Kar
2d199dc521 Docs : Added Provisioning and Protocomm related docs 
Co-Authored-By: Amey Inamdar <amey@espressif.com>
Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
 2018-10-02 19:07:28 +05:30
David Cermak
23345d2021 MQTT: Integrate esp-mqtt library into idf 
added docs and tests for mqtt library, small fixes (removed warnings, option for custom outbox, websocket bug fixed for longer transports). refactored to use common tcp_transport component, support for CMake build system.
Closes #2108
 2018-09-12 08:00:59 +02:00
Ivan Grokhotkov
8403adf4e0 docs: add API reference section for esp_system.h 2018-08-20 16:49:20 +08:00
Jitin George
1fecdc3891 esp_https_ota: Add support for HTTPS based ota feature 2018-08-03 16:47:07 +05:30
David Cermak
1ef13c524c asio: initial idf port of asio library without ssl 2018-07-30 06:28:43 +00:00
Angus Gratton
5f2f84c220 Merge branch 'feature/http_server_finalize' into 'master' 
Feature add HTTP Web Server component

See merge request idf/esp-idf!2606
 2018-07-23 13:11:04 +08:00
Anurg Kar
656bef7bb7 Http Server : Add a simple light weight HTTP Server Component. 
Also add examples, docs and test apps for the HTTP Server.
 2018-07-20 15:49:17 +05:30
Shivani Tipnis
35205d8513 Add files and docs for mass mfg 2018-07-20 10:41:11 +05:30
Darian Leung
1d2727f4c8 CAN Driver 
The following commit contains the first version of the ESP32 CAN Driver.

closes #544
 2018-07-04 14:01:57 +08:00
Ivan Grokhotkov
4b91c82cc4 Merge branch 'feat/sdio_pullup' into 'master' 
feature(sdio): add features to make SDIO slave compatible with more devkits

See merge request idf/esp-idf!2454
 2018-06-20 13:58:56 +08:00
Ivan Grokhotkov
d9f8311b9d docs: add error codes reference 2018-06-15 15:49:24 +08:00
michael
85b08684e3 doc(sdio_slave): add descriptions about conflicts on MTDI pin 2018-06-14 12:04:23 +08:00
Angus Gratton
21e085d235 Merge branch 'feature/xRingBufferCanRead_pr1672' into 'master' 
freeRTOS/Re-factor ring buffers and add xRingbufferCanRead, xRingbufferCanWrite

See merge request idf/esp-idf!2214
 2018-05-23 15:09:40 +08:00
Jiang Jiang Jian
72c2a6f1c6 Merge branch 'feature/proto-client' into 'master' 
HTTP Client

See merge request idf/esp-idf!1521
 2018-05-22 21:06:46 +08:00
michael
1b45e1117b doc(sdio_slave): documentation for SDIO slave driver 2018-05-21 23:48:56 +08:00
wangmengyang
4c4e143a2f component/bt: implement HFP Hands Free Unit Role 2018-05-21 11:33:30 +08:00
Tuan PM
ff528d13c7 Add esp_http_client 
Add error handling for http client

set ssid password correct with Example_WIFI test, and clear password before free

Fixed the CI failure due to HTTP errror names
 2018-05-21 09:35:07 +07:00
Darian Leung
4bfa30967f freeRTOS/Re-factor ring buffers 
This fixes multiple bugs with ring buffers and re-factors the code. The public
API has not changed, however the underlying implementation have various private
functions have been changed. The following behavioral changes have been made

-   Size of ring buffers for No-Split/Allow-Split buffers will not be rounded
    up to the nearest 32-bit aligned size. This was done to simplify the
    implementation

-   Item size for No-Split/Allow-Split buffers will also be rounded up to the
    nearest 32-bit aligned size.

The following bugs have been fixed

-   In copyItemToRingbufAllowSplit(), when copying an item where the aligned
    size is smaller than the remaining length, the function does not consider
    the case where the true size of the item is less than 4 bytes.

-   The copy functions will automatically wrap around the write pointers when
    the remaining length of the buffer is not large enough to fit a header, but
    does not consider if wrapping around will cause an overlap with the read
    pointer. This will make a full buffer be mistaken for an empty buffer

closes #1711
-   xRingbufferSend() can get stuck in a infinite loop when the size of the
    free memory is larger than the needed_size, but too small to fit in the ring
    buffer due to alignment and extra overhead of wrapping around.

closes #1846
-   Fixed documentation with ring buffer queue set API

-   Adding and removing from queue set does not consider the case where the
    read/write semaphores actually hold a value.

The following functions have been deprecated
    - xRingbufferIsNextItemWrapped() due to lack of thread safety
    - xRingbufferAddToQueueSetWrite() and xRingbufferRemoveFromQueueSetWrite()
    as adding the queue sets only work under receive operations.

The following functions have been added
    - xRingbufferReceiveSplit() and xRingbufferReceiveSplitFromISR() as a thread
    safe way to receive from allow-split buffers
    - vRingbufferGetInfo()

Documentation for ring buffers has also been added.
 2018-05-21 01:04:58 +00:00
Amit Sheth
aa357a32bc nvs_flash: Add binary creation support for NVS partition. 
Ideally suited for generating a binary externally, containing key-value pairs specific
to device manufacturers. Utility allows creation of a binary, compatible
with NVS structure, which can be separately flashed onto a new
partition. This helps device manufacturers set different values for
different devices, e.g. serial numbers, but using a single firmaware
image.
 2018-04-23 00:27:29 +05:30
Ivan Grokhotkov
e148c2a12c docs: update SDMMC and SDSPI documentation 
- Split SDMMC page into pages about SDMMC/SDSPI hosts and a page about
   the protocol layer.
- Use autogenerated API reference instead of manually generated one.
- Add information about SDIO APIs.
 2018-04-11 11:07:13 +08:00
Jitin George
254212b02b changes to accomodate new Doc structure 2018-04-06 17:16:27 +05:30
qiyueixa
2984cdbbe3 add mesh feature 2018-04-04 22:57:45 +08:00
Kedar Sovani
7a0cab0a5b pthread: Allow configuration of priority and stacksize 
The expected usage is:
  esp_pthread_set_cfg(cfg);
  pthread_create()

If the inherit flag is set, then all subsequent threads forked by this
thread will also inherit this configuration. This avoids having to
change/prefix this for each and every pthread_create() call.
 2018-03-20 18:06:32 +05:30
krzychb
097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00