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