Wang Fang
ba09586a24
docs: replace the module on esp32-devkitc from esp32-wrover to esp32-wroom
2021-10-28 17:29:17 +08:00
Wang Ning
5b339fefdc
docs/update_esp32-s2_devkit_user_guides
2021-09-22 14:59:06 +08:00
Wang Ning
769a9fa28f
docs/update_two_esp32-c3_devkit_user_guides
2021-09-18 18:46:42 +08:00
aleks
b9b2cab8f9
freemodbus: update the modbus documentation doc-1641
2021-09-05 21:01:07 +02:00
Juraj Sadel
85f9aa1062
docs: Instructions for Windows download optimization
2021-08-16 12:32:21 +02:00
Wang Ning
baebf74342
docs/add_esp32-s2-devkitc-1_user_guide
2021-07-30 14:00:45 +08:00
morris
f907009056
Merge branch 'refactor/cleanup_mcpwm_examples' into 'master'
...
mcpwm: more clean up (example + LL + doc)
Closes IDF-3295
See merge request espressif/esp-idf!12798
2021-07-29 10:41:07 +00:00
morris
8cfac8ec38
doc: fix wrong info in MCPWM api reference
2021-07-26 22:32:45 +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
daiziyan
e95893bb1b
docs: rename ESP-MESH to ESP-WIFI-MESH
2021-07-12 19:25:18 +08:00
Lv Xin Yue
faee145a61
docs:add esp32-s3-devkitc-1 user guide
2021-07-02 15:21:07 +08:00
Juraj Michálek
bd749ad8be
docs: update Windows Tools 2.9 installation
2021-06-21 14:19:40 +02:00
Wang Ning
2c31ac24c1
docs/add_how_to_debug_ota_failure_to_api_references
2021-06-16 19:28:01 +08:00
Krzysztof Budzynski
997170ede1
Merge branch 'docs/introduce_new_rules_for_updating_docs' into 'master'
...
docs: introduce new rules for formatting documents
See merge request espressif/esp-idf!13642
2021-05-31 10:07:19 +00:00
daiziyan
8149eda0a9
docs: introduce new rules for writing documents
2021-05-31 10:56:18 +08:00
pedro.minatel
03cb5f8af8
Merge conflict fixed
...
Fixed the scale image on click to enlarge
2021-05-28 15:16:02 +01:00
Roland Dobai
a2cf1a7d38
docs: Update JTAG debugging guides for ESP32-C3
2021-04-13 12:48:50 +02:00
Wang Ning
424fe73a23
Add ESP32-C3-DevKitC-02 User Guide
2021-03-17 06:40:33 +00:00
Marius Vikhammer
4e9d810dfb
Docs: build doc with new layout for target and version select
2021-03-12 16:15:56 +08:00
Kang Zuoling
78a1cd3643
touch_element: add touch element api-reference doc
2021-02-22 12:16:49 +08:00
Juraj Michálek
419673fa96
docs: add links to Windows installer 2.5 Offline and Online versions
2021-02-18 15:16:58 +01:00
Krzysztof
5a8a6c8fff
docs: Provide new links to documentation for ESP32-S2 and ESP32-C3 chips
2021-02-18 18:08:58 +08:00
Wang Ning
aa2b3e1b01
Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS
2021-02-05 12:08:21 +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
Wang Fang
4c31cf9804
docs: Update FreeRTOS version, add tips to set up instructions for Windows
2021-01-26 03:46:25 +00:00
morris
5fe6c9f8ab
doc: update sigma-delta doc for esp32c3
2021-01-25 11:10:19 +08:00
Dai Zi Yan
703aef654b
provide user guide for ESP32-DevKitM-1
2021-01-05 12:32:08 +08:00
Wang Fang
8dbd5a48a8
provide user guide for the development board ESP32-PICO-DevKitM-2
2020-12-14 18:26:44 +08:00
Wang Fang
bdeb3a2fb6
upload user guide for development board: ESP32-PICO-KIT-1
2020-12-09 08:27:25 +00:00
Angus Gratton
66fb5a29bb
Whitespace: Automated whitespace fixes (large commit)
...
Apply the pre-commit hook whitespace fixes to all files in the repo.
(Line endings, blank lines at end of file, trailing whitespace)
2020-11-11 07:36:35 +00:00
Wang Ning
f87cbdee28
Add ESP32-S2-DevKitM-1 User Guide
...
Update 1 based on comments
Fix typo
Add annotation to UFL connector
Add UFL connector to description table
2020-11-06 00:50:33 +00:00
Soumesh Banerjee
ba901179fe
Update docs images
2020-10-09 15:05:01 +08:00
dongyou
e0a698c242
add docs "How to improve Wi-Fi performance" in api-guides.
2020-09-16 12:09:23 +00:00
Andrei Gramakov
c863b4c777
docs: tinyusb documentation
2020-08-27 13:49:33 +02:00
Wang Fang
5773767b81
Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1
2020-07-28 13:49:33 +08: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
Krzysztof Budzynski
95ed99671b
Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master'
...
espcoredump: apply documentation changes in core_dump.rst file
See merge request espressif/esp-idf!5697
2020-05-28 02:25:47 +08:00
Alex Lisitsyn
e649a4f017
espcoredump: apply temporary documentation changes in core_dump.rst file
...
added picture to describe bin and elf format of core dump
added link to core_dump_internals.rst file from main one
added the diagram to describe logic structure of core dump modules and dependencies
2020-05-28 02:25:46 +08:00
Krzysztof Budzynski
71d1b32dde
docs: Provide link to ESP32-S2 specific documentation
2020-05-25 02:59:36 +08:00
lly
514ec37fe4
ble_mesh: Doc miscellaneous fixes
...
- Fix link error in getting started
- Update ble mesh architecture
2020-05-21 07:14:45 +00:00
Valerii Koval
bc397f8b7d
Add new section about using ESP-IDF with PlatformIO
...
This adds a description of PlatformIO ecosystem, tutorials, examples
Merges https://github.com/espressif/esp-idf/pull/5132
2020-05-06 12:55:22 +02:00
Marius Vikhammer
407275f681
doc: add latex and PDF generation to build_docs
...
Adds options for generating tex-files and PDFs when building documentation
Closes IDF-1217
Closes IDF-1464
2020-04-15 17:14:22 +08:00
morris
279e8dd6c2
add Ethernet doc
2020-03-26 11:04:55 +00:00
Wang Ning
a0c37ae1bd
Add ESP32-S2-Saola-1 User Guide
2020-03-26 18:40:05 +08:00
Wang Ning
b85358e593
Updated index
...
components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +08:00
Krzysztof Budzynski
2178e3fba4
docs: Update getting started guide for ESP32-S2 target
2020-03-05 05:05:23 +08:00
Ivan Grokhotkov
1cd6f67679
docs: add API guide page about IDF Tools
2020-01-24 14:02:21 +01:00
Kirill Chalov
c5f77cf6cb
Review the file api-reference/peripherals/i2c.rst
2020-01-09 17:04:41 +08:00
Soumesh Banerjee
e969115a23
Fix the whitespace after everything which is link
2019-12-18 13:11:54 +08:00
lly
2daa8e6587
doc: update ble mesh docs based on the feature and example update
2019-12-09 14:57:15 +08:00
tianyangmin
be3e52b49c
doc: Finalize Ethernet get-started guide. Add Chinese translation.
2019-12-03 02:22:06 +00:00
Krzysztof Budzynski
0abb3b99c1
Update missing description of board A and B connectors. Add a note about incorrect GPIO pin labels on the silkscreen besides the function switch.
2019-11-04 10:44:00 +08:00
Krzysztof Budzynski
2c3548b65e
Provide BLE Mesh documentation
2019-10-30 17:01:18 +08:00
Kirill Chalov
deda0091d9
Review the file api-reference/peripherals/spi_master.rst.
2019-10-21 16:13:16 +08:00
michael
37fdcc1eb5
esp_ringbuf: add documents for SendAcquire and SendComplete
2019-10-11 15:44:27 +08:00
Soumesh Banerjee
d47288d9db
🐛 Fix the white space bug in docs
...
Fix only the visual rendering the issue for selection of text still remains and have to be solved by updating the html generator
Closes #3208
2019-08-09 10:07:22 +08:00
Kirill Chalov
639687f92b
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
qiyuexia
068a2dcb32
mesh: update mesh events demonstration
2019-07-05 21:14:33 +08:00
Hrishikesh Dhayagude
342f6a7829
Port NimBLE Host Stack on ESP-IDF
2019-06-25 09:03:58 +08:00
Krzysztof
4e95b1ad21
Provide getting started guide for 'ESP32-Ethernet-Kit' board
2019-06-06 15:45:45 +08:00
Krzysztof
754a454402
Introduce separate fonts used by blockdiag, sequdiag, actdiag, nwdiag, rackdiag and packetdiag for Chinese and English version of documentation
2019-05-06 13:19:58 +08:00
liying
e2ce0860f6
Updated 404 page not found pages, both Chinese and English versions.
2019-03-28 19:06:43 +08:00
Krzysztof Budzynski
cb87e786a5
docs: Introduced custom 404 page in readthedocs documentation to replace…
2019-03-28 01:38:31 +08:00
Kirill Chalov
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
morris
7ffd0f95d2
doc/jtag_debug: translation of jtag debugging
...
translate JTAG Debugging to zh_CN
2019-01-30 11:34:04 +08:00
michael
58955a79a2
spi_slave: improve the timing configuration
...
SPI Slave
===========
- Correct the configuration of mode 0~3 using new config in the TRM
- Split the workaround for DMA in mode 0/2 out of normal config, to make it clear.
- Update timing and speed document for the SPI slave.
Resolves https://github.com/espressif/esp-idf/issues/1346 , https://github.com/espressif/esp-idf/issues/2393
2019-01-26 00:10:41 +08:00
Alexey Gerenkov
3dcc0ae908
docs: Adds watchpoints limit configuration to example gdbinit
...
Closes https://github.com/espressif/esp-idf/issues/2335
2018-12-20 06:09:23 +00:00
Krzysztof Budzynski
e53f701577
Update information on ADC's eFuse Vref. Inspired by https://esp32.com/viewtopic.php?f=12&t=6832 .
2018-12-17 13:18:32 +08:00
krzychb
7ef74ee863
Updated 'What you need' picture
2018-11-16 22:18:31 +01:00
Krzysztof Budzynski
6fbc3c4361
Added wireshark instruction to provide a common workflow for users submitting diagnostic data for Wi-Fi troubleshooting
2018-11-16 14:44:58 +08:00
Natasha
be0123e10e
Feature/update board guides for headers
2018-11-12 09:15:29 +08:00
Krzysztof Budzynski
46c2112400
Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT'
2018-10-22 09:10:58 +08:00
Angus Gratton
299704cec3
Merge branch 'feature/unified_provisioning' into 'master'
...
provisioning: This patch adds the unified provisioning support
See merge request idf/esp-idf!2812
2018-10-10 16:29:11 +08:00
Krzysztof Budzynski
cd5f8bcf74
MCPWM API doc update
2018-10-10 08:15:23 +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
Angus Gratton
229fe8e2e4
Merge branch 'feature/esp-wrover-kit-v4_1' into 'master'
...
Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference'. Closes https://github.com/espressif/esp-idf/issues/2363 . Closes https://github.com/espressif/esp-idf/issues/2365 .
See merge request idf/esp-idf!3161
2018-09-10 14:48:41 +08:00
krzychb
91c7149f6e
Included information about power on and diagnostics LEDs. Closes https://github.com/espressif/esp-idf/issues/2365 .
2018-09-06 11:28:23 +02:00
krzychb
62389b6be6
Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference'
2018-09-05 22:10:42 +02:00
Angus Gratton
b355854d4d
Merge branch 'master' into feature/cmake
2018-09-05 10:35:04 +08:00
Darian Leung
f4c3917712
docs/rewrite_mesh_docs
...
The following commit rewrites the ESP-MESH docs. This commit includes
new diagrams and a structure approach to the mesh docs. Some mesh api references
have also been modified.
2018-09-02 21:34:21 +08:00
Angus Gratton
a9c4ed7139
Merge branch 'master' into feature/cmake
2018-08-30 18:51:01 +08:00
Angus Gratton
ff2404a272
Merge branch 'master' into feature/cmake
2018-08-16 17:14:17 +10:00
Angus Gratton
191557db02
docs: Copy CMake docs to a separate set of directories
...
Required first step before merging back to mainline.
2018-08-13 15:37:03 +10:00
krzychb
4946850e82
Replaced Espressif logo with a new, consistent, modern and neutral typeface design.
2018-08-13 07:22:41 +02:00
Angus Gratton
d3ae52afd2
Merge branch 'feature/add_logo_to_docs' into 'master'
...
Added Espressif logo to documentation
See merge request idf/esp-idf!2763
2018-08-02 08:26:14 +08:00
krzychb
42cf4429a9
Fixed logo width to display correctly in Chinese version of documentation
2018-07-30 21:16:27 +02:00
krzychb
c7ab37143b
Logo version 8, vector graphics and a new typeface
2018-07-23 19:18:50 +02:00
krzychb
992ead0671
Logo version 7 - gray logo background, improved contrast, simplified css overrides
2018-07-21 20:06:27 +02:00
krzychb
ca15dbd05e
Added description of ESP32-PICO-KIT V4.1 board
2018-07-18 20:02:43 +02:00
krzychb
2506a9416e
Version 2 of the logo, without a frame an with uniform color
2018-07-18 07:03:00 +02:00
krzychb
2fd5ce3022
Made the logo smaller
2018-07-18 07:03:00 +02:00
krzychb
da86681f21
Added Espressif logo to documentation
2018-07-18 07:03:00 +02:00
kittinson
ae728d66c8
Update theme_overrides.css
...
Changed colors in css file, in order to make documentation website look like official website.
2018-07-18 07:03:00 +02:00
Angus Gratton
a67d5d89e0
Replace all DOS line endings with Unix
...
Command run was:
git ls-tree -r HEAD --name-only | xargs dos2unix
2018-07-12 19:10:37 +08:00
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
krzychb
b101e118f2
Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets, reflected upcoming ESP32-SOLO-1 as one of options for ESP32-DevKitC, provided updated schematics and notes on C15.
2018-06-26 18:08:47 +02:00
Angus Gratton
bcd4fb9944
Merge branch 'doc/jtag_startup_command_fix' into 'master'
...
docs/jtag: use 'flushregs' instead of 'x $a1=0' in gdbinit
See merge request idf/esp-idf!2520
2018-06-08 15:15:29 +08:00
Ivan Grokhotkov
f47af6185d
docs/jtag: use ‘flushregs’ instead of ‘x $a1=0” in gdbinit
...
The old command caused was incorrect (x is “examine”, not “execute”)
and caused GDB register update only by chance. This replaces it with
“flushregs” command which purpose is exactly that — force GDB to
fetch registers from the remote.
2018-06-08 11:45:46 +08:00
michael
5cf7d3768d
feat(spi_master): fine tune the timing of SPI
2018-06-06 06:08:39 +00: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