Ivan Grokhotkov
7e2028d598
Merge branch 'bugfix/gpio_timer_doc_fixes' into 'master'
...
Minor fixes of GPIO and timer group driver docs
See merge request idf/esp-idf!2081
2018-03-20 10:49:36 +08:00
Ivan Grokhotkov
e56897b7a4
Merge branch 'bugfix/docs_updates_from_github' into 'master'
...
Bugfix/docs updates from github
See merge request idf/esp-idf!2057
2018-03-20 09:50:43 +08:00
Stefan Tauner
757c1d6739
docs: explicitly note that timer alarms are not recurring
...
Merges https://github.com/espressif/esp-idf/pull/1740
2018-03-19 11:56:57 +08:00
John
f32abada86
Update building-openocd-linux.rst. Merges https://github.com/espressif/esp-idf/pull/1714
...
replace - for -- in line 16 to make it run
2018-03-18 20:02:54 +01:00
Alex Lisitsyn
ce09cfd99b
esp32: Deactivate wakeup trigger after first wakeup
...
Added function esp_sleep_disable_wakeup_source() to deactivate wakeup trigger for selected source.
Updated documentation for this function in sleep_modes.rst file.
Updated unit test to check this functionality for light sleep.
The test_sleep.c unit test is updated to add reliability for unit testing.
(TW#18952)
Closes https://github.com/espressif/esp-idf/issues/1677
2018-03-16 18:49:24 +05:00
Alex Lisitsyn
2d90da0817
esp32: Deactivate wakeup trigger after first wakeup
...
The timer wakeup function once activated cannot be disabled later using existing api. If user wants to use different wakeup sources after first sleep but it does not work. This change disables timer wakeup trigger in configuration that will be set into appropriate RTC registers in esp_light_sleep_start() function.
Added function esp_sleep_disable_wakeup_source() to deactivate wakeup trigger for selected source.
Updated documentation for this function in sleep_modes.rst file to pass make html.
Updated unit test to check this functionality for light sleep.
The test_sleep.c unit test is updated to add reliability for auto unit testing.
(TW#18952)
Closes https://github.com/espressif/esp-idf/issues/1677
2018-03-16 18:22:02 +05:00
krzychb
621076f329
Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files
2018-03-16 07:54:58 +01:00
Angus Gratton
748fef4363
doc: Move non-language-specific RTD/Sphinx config to conf_common.py
2018-03-16 12:00:01 +11:00
krzychb
36bbfbb4bf
Updated instructions to install Eclipse. Closes https://github.com/espressif/esp-idf/issues/1509 .
2018-03-14 19:26:59 +01:00
krzychb
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
krzychb
b7f7ac3b28
Implemented review comments to zh_CN version of eclipse setup and PICO-KIT get started guides. Resolved issues after rebasing on master of several commits.
2018-03-13 22:31:54 +01:00
krzychb
6a1b2c6ad0
Included zh_CN version of Eclipse setup and PICO-KIT get started guides
2018-03-13 22:07:31 +01:00
krzychb
c63d7a4b5e
Adjusted CI configuration to handle 'en' and 'zh_CN' language versions
2018-03-13 22:07:31 +01:00
krzychb
56d5647d3f
Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions
2018-03-13 22:07:31 +01:00
krzychb
40bc387bae
Restored back original 'zh_CN' version files and updated links between versions
2018-03-13 21:57:08 +01:00
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
krzychb
c8d8cdbf38
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-03-13 21:57:08 +01:00
Ivan Grokhotkov
7a1e3265fe
Merge branch 'bugfix/docs_small_corrections' into 'master'
...
Bugfix/docs small corrections
See merge request idf/esp-idf!2025
2018-03-13 17:43:00 +08:00
Ivan Grokhotkov
c54ce12853
Merge branch 'bugfix/docs_incremental_build' into 'master'
...
docs: speed up incremental builds
See merge request idf/esp-idf!2012
2018-03-13 17:41:08 +08:00
Ivan Grokhotkov
e1cfa133bd
Merge branch 'bugfix/docs_from_github' into 'master'
...
Bugfix/docs from github
See merge request idf/esp-idf!2015
2018-03-13 17:40:26 +08:00
krzychb
e437c7d6ad
Exposed important information regrading the flash bus signals
2018-03-12 05:56:35 +01:00
XuanZe
bf2a7fd2c9
fix: fatfs link
2018-03-12 05:56:35 +01:00
krzychb
ef76ae3d29
Extra links in 'Resources' section
2018-03-12 05:56:35 +01:00
krzychb
53e01bfb96
Added missing link to sdkconfig
2018-03-08 10:03:32 +01:00
Ivan Grokhotkov
2e0f8b5a70
docs: speed up incremental builds
...
On each documentation build (‘make html’), doxygen regenerates XML
files. In addition to that, gen-dxd.py regenerates API reference
files under _build/inc/. This results in Sphinx flagging about half
of the input files as modified, and incremental builds taking long
time.
With this change, XML files generated by Doxygen are copied into
docs/xml_in directory only when they are changed. Breathe is pointed
to docs/xml_in directory instead of docs/xml. In addition to that,
gen-dxd.py is modified to only write to the output file when contents
change.
Overall, incremental build time (with no source files changed) is
reduced from ~7 minutes to ~8 seconds (on a particular OS X
computer).
Due to the way Breathe includes Doxygen XML files, there is still
going to be a massive rebuild every time functions, enums, macros,
structures are added or removed from the header files scanned
by Doxygen, but at least individual .rst files can be edited
at a much faster pace.
2018-03-07 17:45:15 +08:00
XuanZe
9b2bce2c17
Fix missing 'cpp:func:'. Merges https://github.com/espressif/esp-idf/pull/1680
2018-03-06 06:54:54 +01:00
Alex Kaariainen
bfb5c92740
Update adc.rst. Merges https://github.com/espressif/esp-idf/pull/1657
2018-03-06 06:54:20 +01:00
krzychb
b2ecaa64f0
Added a note how to modify ESP-WROVER-KIT V3 hardware to improve flash bus signal's integrity when using 80 MHz flash frequency. Due to length of the signal lines the flash mode QIO + 80M is not stable and may cause random exceptions on the ESP-WROVER-KIT.
2018-03-02 15:26:46 +01:00
Ivan Grokhotkov
0538daa3f4
Merge branch 'bugfix/docs_missing_reference' into 'master'
...
Added missing references to the current and previous ESP32-DevKitC board versions
See merge request idf/esp-idf!1920
2018-02-26 06:39:54 +08:00
Ivan Grokhotkov
04ad0f79c0
Merge branch 'adc_calibration_update' into 'master'
...
ADC Calibraiton - Support new new calibration methods and eFuse functionality
See merge request idf/esp-idf!1846
2018-02-26 06:15:06 +08:00
Ivan Grokhotkov
c8ba6cf156
Merge branch 'feature/rtc_gpio_isolate' into 'master'
...
Add rtc_gpio_isolate function, use it in deep sleep examples
See merge request idf/esp-idf!1936
2018-02-26 06:09:08 +08:00
Darian Leung
0c9e2c0fba
esp_adc_cal/Remove lookup table
...
This commit removes the lookup table mode due to inferior performance when compared
to linear mode under attenuation 0, 1 and 2. However small portions of the lookup table
are kept for the higher voltages of atten 3 (above ADC reading 2880). That voltage range
in atten 3 has non linear characteristics making the LUT performan better than linear mode.
2018-02-22 20:01:41 +08:00
Roland Dobai
4017cf3516
partition_table: Optionally disable the MD5 checksum in partition tables
2018-02-22 07:46:41 +01:00
Angus Gratton
63ddae5087
Merge branch 'bugfix/i2s_driver' into 'master'
...
i2s: add support fixed_mclk configuration
See merge request idf/esp-idf!1600
2018-02-22 12:03:26 +08:00
Tuan PM
7cda34c626
i2s: add support fixed_mclk configuration
2018-02-22 09:00:23 +07:00
STB3
0bde61e3ca
Update eclipse-setup.rst
...
Chapter Flash from Eclipse: Changed "Select Make Targets -> ..." to "Select Build Targets -> ..." to match the Eclipse wording. Same with "Project -> Make Target" replace Make by build to match the Eclipse wording.
2018-02-15 21:13:01 +01:00
njyq2008
37b98f7306
Update index-cn.rst. Closes https://github.com/espressif/esp-idf/issue/1620
2018-02-13 15:06:05 +01:00
SmallRoomLabs
ef080c0841
Remove the THEN keyword from IF. Closes https://github.com/espressif/esp-idf/issue/1606
...
Both the TinyBasicPlus and the ESP32 variant don't use the THEN keyword in a IF statement
2018-02-13 15:06:05 +01:00
Darian Leung
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
Ivan Grokhotkov
af6cfc5552
docs, examples: use rtc_gpio_isolate to disconnect GPIO12
...
This is needed to reduce deep sleep current on ESP32-WROVER modules.
Ref TW18165.
2018-02-11 13:28:47 +08:00
Alexey Gerenkov
f8c42369f1
freertos: Adds C11 TLS support
2018-02-07 18:46:57 +03:00
krzychb
ade6bd4ad8
Added missing references to the current and previous board versions
2018-02-06 18:54:58 +01:00
Roland Dobai
cf7a4cc650
Protect partition table by MD5 checksum
2018-02-05 11:36:03 +01:00
Ivan Grokhotkov
8ef7434d55
Merge branch 'feature/docs_devkitc-v4' into 'master'
...
Docs for ESP32 DevKitC V4
See merge request idf/esp-idf!1853
2018-02-01 12:20:17 +08:00
krzychb
c759ff3aab
Docs for ESP32 DevKitC V4
2018-01-31 18:31:13 +01:00
Ivan Grokhotkov
e676676541
Merge branch 'bugfix/ulp_docs_typo' into 'master'
...
Fix typo in ulp_instruction_set.rst. Merges https://github.com/espressif/esp-idf/pull/1540
See merge request idf/esp-idf!1874
2018-01-30 12:17:24 +08:00
Markus Witt
75011a8611
Fix typo in ulp_instruction_set.rst. Merges https://github.com/espressif/esp-idf/pull/1540
2018-01-29 21:56:55 +01:00
Jiang Jiang Jian
58f0edfd03
Merge branch 'bugfix/btdm_tutorials_compatible_with_github' into 'master'
...
component/bt: modify ble tutorials to make them be compatible with GitHub markdown
See merge request idf/esp-idf!1786
2018-01-29 15:47:36 +08:00
island
e22f8ad1aa
component/bt: Update BLE examples tutorials and ReadMe files
...
- Make docs compatible with GitHub Markdown
- Add tutorials links in programming doc
- Modify ReadMe files
2018-01-25 16:59:40 +08:00
michael
fcfcab7678
feat(attr): add new macro DMA_ATTR
and WORD_ALIGNED_ATTR
to help dma buffer declaration.
2018-01-24 11:28:14 +08:00
Ivan Grokhotkov
3bc1a8318b
Merge branch 'doc/debian_build_prereqs' into 'master'
...
docs: Add build dependencies for toolchain for Debian (Github PR)
See merge request !1830
2018-01-23 15:38:09 +08:00
Ivan Grokhotkov
f6cfe92533
Merge branch 'feature/support-markdown-docs' into 'master'
...
docs : Add support for markdown files
See merge request !1781
2018-01-23 15:36:12 +08:00
Urs Fässler
93872837d3
Add build dependencies for toolchain for Debian
...
Merges https://github.com/espressif/esp-idf/pull/1465
2018-01-23 11:38:28 +11:00
krzychb
f3ccc5da4f
Custom link roles have been extended to provide an option of displaying some text where originally a bare link is rendered
2018-01-17 20:01:36 +01:00
me-no-dev
4bddbc031c
Import mDNS changes
2018-01-16 10:58:34 +02:00
Anuj Deshpande
bd47f405a3
docs : Add support for markdown files
2018-01-15 13:58:31 +08:00
Wu Jian Gang
595688a32a
Merge branch 'feature/doc_translations' into 'master'
...
Feature/doc translations
See merge request !1718
2018-01-12 21:09:03 +08:00
lvxinyue
3bdd62ec1c
docs: add CN translation of Windows setup guide
2018-01-12 20:41:32 +08:00
lvxinyue
b7e6d31d42
docs: add CN translation of Linux setup guide
2018-01-12 20:41:32 +08:00
Ivan Grokhotkov
2ddee72996
Merge branch 'feature/toolchain-80-g6c4433a' into 'master'
...
Toolchain: Update to version 1.22.0-80-g6c4433a
See merge request !1771
2018-01-11 21:44:42 +08:00
Angus Gratton
3ef69b8e6d
docs: Add a temporary index page to get CN docs started
2018-01-11 18:18:55 +08:00
Ivan Grokhotkov
914ab07567
Merge branch 'feature/ulp_i2c_reg' into 'master'
...
soc,ulp: add register definitions of RTC_I2C peripheral
See merge request !1762
2018-01-11 12:08:25 +08:00
Angus Gratton
853736afe2
Toolchain: Update to version 1.22.0-80-g6c4433a
...
Includes updated prebuilt Windows MSYS2 environment.
2018-01-10 07:49:24 +00:00
Jiang Jiang Jian
c147d7b03e
Merge branch 'feature/btdm_bt_spp' into 'master'
...
component/bt: Add bt spp profile
See merge request !1593
2018-01-09 10:44:46 +08:00
Angus Gratton
7ea16872d4
Merge branch 'bugfix/docs-pico-kit-swapped-pins' into 'master'
...
Fixed swapped GPIO6 and GPIO11 in ESP-PICO-KIT 'Pin Descriptions', ref. https://esp32.com/viewtopic.php?f=2&t=3880
See merge request !1736
2018-01-09 08:53:10 +08:00
Ivan Grokhotkov
dba291416f
soc,ulp: add register definitions of RTC_I2C peripheral
2018-01-08 21:28:14 +08:00
baohongde
d2663c866e
component/bt: Add SPP profile
2018-01-05 16:48:29 +08:00
JoveToo
ecb75ba669
fix typo
...
Merges https://github.com/espressif/esp-idf/pull/1429
2018-01-03 10:51:34 +11:00
Greg Herlein
a834c069f1
added notes on where to change XTAL freq
...
Merges https://github.com/espressif/esp-idf/pull/1458
2018-01-03 10:45:00 +11:00
krzychb
03d5af9859
Fixed swapped GPIO6 and GPIO11 in documenation of module pinout, ref. https://esp32.com/viewtopic.php?f=2&t=3880
2018-01-02 22:30:45 +01:00
Angus Gratton
4f44d16e88
Merge branch 'feature/docs_add_python3_support' into 'master'
...
docs: Add build support for python3
See merge request !1712
2017-12-29 06:11:50 +08:00
Angus Gratton
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
Angus Gratton
258d0329c1
Merge branch 'bugfix/blockdiag_windows_installation' into 'master'
...
A workaround for MSYS2 / Windows system to be able to install 'blockdiag'
See merge request !1684
2017-12-27 09:05:12 +08:00
Anuj Deshpande
59b0c50d77
docs: Add build support for python3
2017-12-26 17:48:33 +05:30
Ivan Grokhotkov
c488235e9c
Merge branch 'feature/components_can_add_to_component_make_rules' into 'master'
...
Support Makefile.componentbuild so components can add to global component make rules
See merge request !1667
2017-12-22 11:40:54 +08:00
Jeroen Domburg
1be1e747c4
Add support for Makefile.componentbuild files
2017-12-20 10:35:27 +08:00
Tuan PM
5615b9ca2b
Add .editorconfig file
...
remove newlinet in binary file
editorconfig style guide
correct format for rst hyperlinks
2017-12-18 12:47:30 +07:00
krzychb
d2da250353
A workaround for MSYS2 / Windows system to be able to install 'blockdiag'
2017-12-18 05:34:44 +01:00
michael
cb810ccbe1
feat(monitor): add pause feature.
2017-12-14 13:48:03 +08:00
michael
a8f89009a4
feat(monitor): add new feature allowing disabling log display.
2017-12-14 13:48:03 +08:00
Ivan Grokhotkov
661686b840
Merge branch 'feature/doc_wroom_modules_with_ESP32-D0WD' into 'master'
...
The WROOM and WROVER family of modules is now extended with ESP-WROOM-32D and ESP32-WROOM-32U
See merge request !1654
2017-12-14 13:36:49 +08:00
Ivan Grokhotkov
d2bd9cccd8
Merge branch 'feature/ulp_docs_update' into 'master'
...
ULP docs update
See merge request !1640
2017-12-13 15:36:36 +08:00
krzychb
465ab0ca10
Linked ESP32 datasheet and regulatory certificates
2017-12-12 08:42:22 +01:00
Ivan Grokhotkov
a7a861962d
Merge branch 'bugfix/note_about_main_xtal_frequency_selection' into 'master'
...
Getting Started docs: Updated information about setting the main XTAL frequency
See merge request !1645
2017-12-11 15:45:01 +08:00
Ivan Grokhotkov
82aeb18c3f
Merge branch 'test/UT_master_slave_mode' into 'master'
...
unit-test-app: support multiple devices test cases
See merge request !1220
2017-12-11 15:22:51 +08:00
krzychb
6584bcf62d
Fixed issues identified during review
2017-12-11 08:01:37 +01:00
krzychb
9b847b2903
1. Following https://esp32.com/viewtopic.php?f=14&t=3834 and https://github.com/espressif/esp-idf/issues/1351 updated information regarding selection of the main XTAL frequency. 2. Removed obsolete note about ': not a valid identifier...', as it does not show up anymore with the latests MSYS2 installation.
2017-12-11 07:52:27 +01:00
Ivan Grokhotkov
a99483a727
docs: add information about execution time of ULP instructions
2017-12-11 14:05:41 +08:00
Angus Gratton
dcf94f2189
Merge branch 'bugfix/minor_fixes_github' into 'master'
...
Minor fixes from github
See merge request !1638
2017-12-11 12:51:41 +08:00
Ivan Grokhotkov
ca751648fa
ulp: document the need to wait for RTC to be ready for wakeup
2017-12-11 12:11:46 +08:00
Ivan Grokhotkov
65fa71f565
docs: add description of ULP I2C instructions
2017-12-11 12:11:46 +08:00
krzychb
e99c7c3b50
The WROOM and WROVER family of modules is now extended with ESP-WROOM-32D and ESP32-WROOM-32U
2017-12-08 21:03:05 +01:00
houchenyao
7a31b93fa3
unit-test-app: support multiple devices test cases:
...
current unit-test-app don't support test components need to communicate
with each other (like GPIO, SPI ...). Now we add multiple devices mode
to unit test app, support writing and running test with multiple DUTs.
please refer to `docs/api-guides/unit-tests.rst` for detail.
2017-12-07 13:57:26 +08:00
Ivan Grokhotkov
7e3ac34704
Merge branch 'bugfix/fix_i2s_doc' into 'master'
...
docs: fix i2s code snippet for interrupt flags setting
See merge request !1637
2017-12-07 13:50:49 +08:00
Ivan Grokhotkov
d6525fb3e6
docs: link to FreeRTOS APIs from SMP changes documentation
2017-12-07 12:41:24 +08:00
Ivan Grokhotkov
cda22d9aaf
docs: add FreeRTOS API docs
...
- Use `code` tags instead of a mix of `<pre></pre>` and
`@verbatim .. @endverbatim`
- Remove manually added function prototypes from comment blocks
- Remove of grouping (`\defgroup`) — some extra work is needed
to make groups compatible with the way we auto-generate API
reference from Doxygen XML files. It's pretty easy to add the
grouping directives back if/when we implement support for
Doxygen groups in the later stages of documentation build
process.
- Hide private APIs under `@cond .. @endcond`
- Convert some comments into Doxygen-compatible ones
- Fix various documentation issues: missing documentation for
some parameters, mismatch between parameter names in comment
block and in function prototype.
- Add doxygen comments for functions which didn't have them
(thread local storage).
- Add [out] param tags where necessary
- Redefine `xTaskCreate` and `xTaskCreateStatic` as inline
functions instead of macros.
2017-12-07 12:01:14 +08:00
Ivan Grokhotkov
2b92119840
Merge branch 'bugfix/freertos_check_task_waiting_termination' into 'master'
...
Freertos Task Deletion backport and FPU documentation
See merge request !1591
2017-12-07 11:55:10 +08:00
Paul Reimer
78855211fe
build system: Add *.cc files to list of file extensions compiled by default
...
Merges https://github.com/espressif/esp-idf/pull/1318
2017-12-07 10:17:03 +11:00
Mahavir Jain
2efef48e3e
docs: fix i2s code snippet for interrupt flags setting
...
Signed-off-by: Mahavir Jain <mahavir@espressif.com>
2017-12-06 12:05:11 +05:30
krzychb
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