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
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
me-no-dev
4bddbc031c
Import mDNS changes
2018-01-16 10:58:34 +02: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
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
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
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
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
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
Jiang Jiang Jian
c672fc54fd
Merge branch 'feature/ledc_more_meaningful_parameter_names' into 'master'
...
Provided more meaningful parameter names by renaming 'bit_num' to 'duty_resoluti…
See merge request !1440
2017-12-01 19:33:53 +08:00
krzychb
fe1e1e2f8e
Review comments implemented
2017-12-01 07:29:54 +01:00
Ivan Grokhotkov
f0547d58e4
esp_timer: add documentation, expose profiling option in Kconfig
2017-11-29 11:44:46 +08:00
krzychb
2b010d4bc9
RMT transmitter and receiver overview pictures
2017-11-24 21:33:50 +01:00
Darian Leung
4c13b2f391
docs/ipc documentation
...
This commit updates doxygen comments in the IPC header files and adds an rst
docs page.
2017-11-24 15:31:28 +08:00
krzychb
cdad1e8382
Implement review comments
2017-11-22 23:33:29 +01:00
krzychb
2ec35f60ca
RMT API docs update, new example
2017-11-21 22:34:23 +01:00
krzychb
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
Angus Gratton
b83792f504
Merge branch 'doc/esp_wifi_types' into 'master'
...
docs: Add esp_wifi_types.h items to wifi API reference
See merge request !1320
2017-11-15 15:03:02 +08:00
Angus Gratton
9a96c8379e
docs: Add introduction section for WiFi, replace boilerplate
2017-11-15 17:40:38 +11:00
Ivan Grokhotkov
09d2791cfd
Merge branch 'feature/spi_variable_len' into 'master'
...
feat(spi_master): add new feature allow use variable command and address field length for the same device.
See merge request !1322
2017-11-14 00:08:50 +08:00
Angus Gratton
36692dbac7
docs: Add esp_wifi_types.h items to wifi API reference
...
Previously only items defined esp_wifi.h in esp_wifi_crypto_types.h
were including in documentation reference.
2017-11-10 11:00:44 -08:00
Ivan Grokhotkov
3eedf3ed18
Merge branch 'bugfix/to_docs_from_github' into 'master'
...
Documentation bugfixes from the github
See merge request !1501
2017-11-10 11:13:25 +08:00
Anton Maklakov
bb4838314c
doc: Add internal links for chapters and fix typos
...
Used 'git grep -i -E "see *\`[^\`]+\`[^_]"' to find the invalid links
2017-11-09 11:45:13 +08:00
krzychb
60f954448c
I2C API documenation update
2017-11-08 23:38:29 +01:00
krzychb
9cee2f9558
Linked API reference of 'Application Level Tracing' with description in the 'API Guides'
2017-11-07 20:27:19 +01:00
Darian Leung
9d63e1da4a
New Task Watchdog API (Revert of Revert)
...
This commit reverts the revert on the new task watchdog API. It also
fixes the following bug which caused the reversion.
- sdkconfig TASK_WDT_TIMEOUT_S has been reverted from the unit of ms back to the
unit of seconds. Fixes bug where projects using the new API without rebuilding sdkconfig
would cause the old default value of 5 to be interpreted in ms.
This commit also adds the following features to the task watchdog
- Updated idle hook registration to be compatible with dual core hooks
- Updated dual core hooks to support deregistration for cpu
- Legacy mode has been removed and esp_task_wdt_feed() is now replaced by
esp_task_wdt_reset(). esp_task_wdt_feed() is deprecated
- Idle hooks to reset are now registered/deregistered when the idle tasks are
added/deleted from the Task Watchdog instead of at Task Watchdog init/deinit
- Updated example
2017-11-02 16:47:51 +08:00
krzychb
d637952555
Small updates of documentation
2017-10-31 07:36:55 +01:00
michael
0330ec270a
feat(spi_master): add new feature allow use variable command and address field length for the same device.
...
Closes #654
2017-10-30 19:33:41 +08:00
Angus Gratton
ffeecde9e2
Merge branch 'feature/docs_update_timer_api' into 'master'
...
Timer API docs update, refactored example
See merge request !1316
2017-10-27 13:31:18 +08:00
krzychb
9b7d5d76a7
Timer API docs update, refactored example
2017-10-27 07:13:59 +02:00
esp32de
7c0020bfd0
feat(adc2): append adc2 support and api and the lock with WIFI module
...
append adc support and api
- esp_err_t adc2_config_width(adc_bits_width_t width_bit);
- esp_err_t adc2_config_channel_atten(adc2_channel_t channel, adc_atten_t atten);
- int adc2_get_voltage(adc2_channel_t channel);
2017-10-26 14:35:29 +08:00
Ivan Grokhotkov
59b7d98fec
Merge branch 'feature/dfs' into 'master'
...
Dynamic frequency scaling
See merge request !1189
2017-10-22 12:34:11 +08:00
Ivan Grokhotkov
b6f37bda97
Merge branch 'feature/i2s_built_in_adc' into 'master'
...
feature(I2S-ADC): add ADC mode for I2S.
See merge request !1077
2017-10-20 15:52:56 +08:00
Angus Gratton
47aaf402b8
heap: Add heap_caps_dump() / heap_caps_dump_all() functions
...
Dump the structure of the heap for debugging purposes.
2017-10-20 11:38:24 +08:00
Ivan Grokhotkov
c360f8dece
Merge branch 'bugfix/heap_check_integrity' into 'master'
...
heap: Fix spurious heap_caps_check_integrity() errors in Comprehensive mode
See merge request !1421
2017-10-19 21:30:16 +08:00
Ivan Grokhotkov
8e01b4aef8
Merge branch 'docs/esp32_hooks' into 'master'
...
docs/Added documentation about esp32 hooks
See merge request !1417
2017-10-19 12:32:36 +08:00
Angus Gratton
04188d8ec7
heap: Fix spurious heap_caps_check_integrity() errors in Comprehensive mode
...
Heap was not being locked before poisoning, so heap_caps_check_integrity()
would sometimes race with checking the poison bytes and print unnecessary
errors.
Details: https://esp32.com/viewtopic.php?f=2&t=3348&p=15732#p15732
2017-10-18 15:57:52 +08:00
Darian Leung
461f8da704
docs/Added documentation about esp32 hooks
...
This commit adds documentation about the esp32 Idle and Tick Hooks
2017-10-18 15:19:35 +08:00
Ivan Grokhotkov
062be56c3c
docs: add power management API reference
2017-10-18 14:37:23 +08:00
michael
8e31a36562
feat(spi_slave): append trans_len field in trans_desc to show length actually transferred.
2017-10-17 12:01:12 +08:00
Jiang Jiang Jian
8e47c355fa
Merge branch 'feature/i2s_apll' into 'master'
...
driver/i2s: add support apll clock
See merge request !1115
2017-10-12 19:06:50 +08:00
Angus Gratton
dda136eab7
Merge branch 'bugfix/heap_debugging_cleanup' into 'master'
...
Heap debugging docs cleanup & convenience functions
See merge request !1347
2017-10-10 14:59:54 +08:00
Jeroen Domburg
a8131b14b0
Merge branch 'feature/docs_update_uart_api' into 'master'
...
Updated functional overview of UART API documentation
See merge request !1328
2017-10-10 14:06:08 +08:00
Jeroen Domburg
1835c3a213
Merge branch 'feature/docs_update_pcnt_api' into 'master'
...
Extended description of the Pulse Counter API and removed redundant comments from the example
See merge request !1312
2017-10-10 14:06:03 +08:00
Angus Gratton
f0d7cfdafe
heap: Add new heap_caps_check_integrity_all() & heap_caps_check_integrity_addr() debugging functions
...
Easier to either check all heaps, or focus on checking a particular region.
2017-10-10 16:19:30 +11:00
Angus Gratton
325bd3a4dc
doc: Rewrite heap debugging docs to add function/struct links & improve actionability
2017-10-10 16:19:29 +11:00
krzychb
9107b47deb
Updated UART API documentation and examples. Included a fix of #1091 from GitHub
2017-10-10 05:54:36 +02:00
Tuan PM
9d39881981
i2s: add support apll clock
...
using apll_param to setup APLL
new apll calculation method, much faster
validate freq calculation
Ensure that the i2s frequency is greater than the hardware limit
Add description of how to calculate apll clock, support apll for other 16-bits audio, check rev0 chip
correct space
2017-10-06 15:36:24 +07:00
krzychb
d60722c33d
Updated example and descritpion of LED PWM Controller API
2017-10-06 08:34:27 +02:00