c5f77cf6cb
Review the file api-reference/peripherals/i2c.rst
2020-01-09 17:04:41 +08:00
e969115a23
Fix the whitespace after everything which is link
2019-12-18 13:11:54 +08:00
2daa8e6587
doc: update ble mesh docs based on the feature and example update
2019-12-09 14:57:15 +08:00
be3e52b49c
doc: Finalize Ethernet get-started guide. Add Chinese translation.
2019-12-03 02:22:06 +00:00
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
2c3548b65e
Provide BLE Mesh documentation
2019-10-30 17:01:18 +08:00
deda0091d9
Review the file api-reference/peripherals/spi_master.rst.
2019-10-21 16:13:16 +08:00
37fdcc1eb5
esp_ringbuf: add documents for SendAcquire and SendComplete
2019-10-11 15:44:27 +08:00
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
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
068a2dcb32
mesh: update mesh events demonstration
2019-07-05 21:14:33 +08:00
342f6a7829
Port NimBLE Host Stack on ESP-IDF
2019-06-25 09:03:58 +08:00
4e95b1ad21
Provide getting started guide for 'ESP32-Ethernet-Kit' board
2019-06-06 15:45:45 +08:00
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
e2ce0860f6
Updated 404 page not found pages, both Chinese and English versions.
2019-03-28 19:06:43 +08:00
cb87e786a5
docs: Introduced custom 404 page in readthedocs documentation to replace…
2019-03-28 01:38:31 +08:00
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
7ffd0f95d2
doc/jtag_debug: translation of jtag debugging
...
translate JTAG Debugging to zh_CN
2019-01-30 11:34:04 +08:00
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
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
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
7ef74ee863
Updated 'What you need' picture
2018-11-16 22:18:31 +01:00
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
be0123e10e
Feature/update board guides for headers
2018-11-12 09:15:29 +08:00
46c2112400
Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT'
2018-10-22 09:10:58 +08:00
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
cd5f8bcf74
MCPWM API doc update
2018-10-10 08:15:23 +08:00
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
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
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
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
b355854d4d
Merge branch 'master' into feature/cmake
2018-09-05 10:35:04 +08:00
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
a9c4ed7139
Merge branch 'master' into feature/cmake
2018-08-30 18:51:01 +08:00
ff2404a272
Merge branch 'master' into feature/cmake
2018-08-16 17:14:17 +10:00
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
4946850e82
Replaced Espressif logo with a new, consistent, modern and neutral typeface design.
2018-08-13 07:22:41 +02:00
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
42cf4429a9
Fixed logo width to display correctly in Chinese version of documentation
2018-07-30 21:16:27 +02:00
c7ab37143b
Logo version 8, vector graphics and a new typeface
2018-07-23 19:18:50 +02:00
992ead0671
Logo version 7 - gray logo background, improved contrast, simplified css overrides
2018-07-21 20:06:27 +02:00
ca15dbd05e
Added description of ESP32-PICO-KIT V4.1 board
2018-07-18 20:02:43 +02:00
2506a9416e
Version 2 of the logo, without a frame an with uniform color
2018-07-18 07:03:00 +02:00
2fd5ce3022
Made the logo smaller
2018-07-18 07:03:00 +02:00
da86681f21
Added Espressif logo to documentation
2018-07-18 07:03:00 +02:00
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
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
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
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
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
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
5cf7d3768d
feat(spi_master): fine tune the timing of SPI
2018-06-06 06:08:39 +00:00
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
42b1ec76b7
Provided links to 'Touch Sensor Application Note' and 'Guide for ESP32-Sense Development Kit'
2018-05-21 19:29:36 +02:00
6d85d159d6
Updated pictures of user configurable jumpers to reflect Version 3 of ESP-WROVER-KIT.
...
This includes changing the picture of JTAG jumper block by removing the jumper on S_TDI. It has been reported by a number of users that removing this jumper fixes random communication issues observed in OpenOCD.
2018-05-21 19:29:36 +02:00
2852dd37fb
docs: add language link to easily change to Chinese version
2018-05-21 10:30:12 +08:00
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
43fb8033ec
ReadTheDocs theme has an annoying bug of text not being wrapped inside table cells. Each row is extended to fit the text as a single line. For a table with multiple columns and long sentences the table may get wide, with long scrollbar underneath and is not convenient to read. This MR makes the text wrap inside table cells. There is an open PR to fix this issue - https://github.com/rtfd/sphinx_rtd_theme/pull/432 .
2018-04-09 05:47:36 +02:00
2984cdbbe3
add mesh feature
2018-04-04 22:57:45 +08:00
852f7f8a36
Updated get started instructions for windows following https://esp32.com/viewtopic.php?f=13&t=4232
2018-03-14 19:26:59 +01:00
73cdfbfe79
esp_adc_cal/Add eFuse functionality
...
This commit updates the esp_adc_cal ocmponent to support new calibration methods
which utilize calibratoin values stored in eFuse. This commit includes LUT mode
2018-02-13 21:22:48 +08:00
c759ff3aab
Docs for ESP32 DevKitC V4
2018-01-31 18:31:13 +01:00
ec7cac5fe8
Merge branch 'feature/docs_update_rmt_api' into 'master'
...
RMT API docs update, new example
See merge request !1564
2017-12-27 09:23:47 +08:00
062cc89abd
Pin descriptions, overview diagram and board dimensions carried over from ESP32-PICO-KIT_Datasheet_EN.pdf. The datasheet looks redundant and will not be used.
2017-12-05 22:03:38 +01:00
2b010d4bc9
RMT transmitter and receiver overview pictures
2017-11-24 21:33:50 +01:00
d488bb7bac
Provided more meaningful parameter names by renaming 'bit_num' to 'duty_resolution' and 'div_num' to 'clock_divider'
2017-11-15 08:08:12 +01:00
3a1521f965
Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams
2017-11-07 18:17:53 +01:00
4d882c1fb7
ESP32-PICO-KIT V4 Getting Started Guide
2017-10-20 22:49:59 +02:00
f7daaa9ebe
ESP32-PICO-KIT Getting Started Guide
2017-10-11 08:02:23 +02:00
d60722c33d
Updated example and descritpion of LED PWM Controller API
2017-10-06 08:34:27 +02:00
6ab552a6ea
docs: Added documentation for FreeRTOS SMP changes
...
Added documentation about the ESP-IDF changes to FreeRTOS.
The documentation covers changes to the following FreeRTOS aspects.
- Task Creation
- Affects on scheduling (Task skipping, scheduler suspension, tick synchronicity)
- Critical sections and disabling interrupts
- Thread Local Storage Pointers and deletion callbacks
- Configuring ESP-IDF FreeRTOS
2017-09-21 16:40:57 +08:00
7c7d29dc4a
Implemented 2 of 3 review comments
2017-09-05 08:28:44 +02:00
ba42c46cb3
Touch Pad driver overview
2017-09-05 08:28:44 +02:00
f2ce3e8678
ESP-WROVER-KIT now integrates the ESP32-WROVER module by default. But it is still compatible with both ESP-WROOM-32 and ESP32-WROVER. The latest baseboard is still V3. The original 'ESP-WROVER-KIT' that integrates ESP-WROOM-32 is unlikely to be produced any longer, while the original 'ESP-WROVER-KIT-RVB' is renamed as “ESP-WROVER-KIT” and in mass production.
2017-08-19 21:16:00 +02:00
bfb15c6fc9
Merge branch 'bugfix/docs_app_trace_lib' into 'master'
...
Update of "Application Level Tracing library" documentation to reflect "esp32" target
See merge request !1081
2017-08-16 19:12:51 +08:00
ca5065c66c
Trace collection command examples
2017-08-05 16:54:58 +02:00
485518cb59
Target change, clarifications and formatting updates
2017-08-04 22:17:31 +02:00
b1fcfca987
Updated desription of ESP-WROVER-KIT features in getting started guide, changed link to JTAG Debugging
2017-08-02 06:57:28 +02:00
1fb85b494c
JTAG Debugging - revamping of Debugging documentation
2017-07-26 14:53:43 +08:00
6cf6f43ac5
Merge branch 'feature/update_wrover_v3' into 'master'
...
docs: layout of esp-wrover-kit updated to v3
See merge request !929
2017-07-07 14:16:36 +08:00
9bb4dac3d2
Layout of esp-wrover-kit updated to v3
2017-07-05 21:21:54 +02:00
8d43859b6a
esp32: SEGGER SystemView Tracing Support
...
Implements support for system level traces compatible with SEGGER
SystemView tool on top of ESP32 application tracing module.
That kind of traces can help to analyse program's behaviour.
SystemView can show timeline of tasks/ISRs execution, context switches,
statistics related to the CPUs' load distribution etc.
Also this commit adds useful feature to ESP32 application tracing module:
- Trace data buffering is implemented to handle temporary peaks of events load
2017-06-27 20:52:43 +03:00
034d37b9cb
Merge branch 'bugfix/doc-small-updates' into 'master'
...
Small fixes/updates to toolchain installation procedures
See merge request !782
2017-05-29 07:09:47 +08:00
d12f871be6
Small fixes/updates to toolchain installation procedures
2017-05-25 08:01:42 +02:00
30edcca1fb
docs: Generate Doxygen directives for API documentation
...
This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130 .
2017-05-19 18:26:02 +02:00
1a19747678
Getting started guides
2017-04-27 19:51:42 +02:00
4e9e8f52ac
doc: Documenting Code clean up
2016-11-21 10:24:12 +08:00
d66f05c61b
Guide on documenting code
2016-11-01 01:21:18 +08:00
ec99397c3e
Initial Sphinx / ReadTheDocs.org configuration
2016-11-01 01:20:04 +08:00
Kirill Chalov