Ivan Grokhotkov
996c925d29
Merge branch 'doc/tools_docker_bind_kconfig' into 'master'
...
docs: docker: add instructions for binding tools/kconfig to a volume
See merge request espressif/esp-idf!7655
2020-02-21 09:57:21 +08:00
Marius Vikhammer
63b76a9d90
doc: custom list filter directive
...
Custom directive that allows for creation of lists where the content can be filtered based on target.
Closes IDF-1385
2020-02-20 18:08:05 +08:00
Angus Gratton
3b498a0576
Merge branch 'bugfix/confserver_hex_types' into 'master'
...
confserver: Standardize and document the handling of hex values
See merge request espressif/esp-idf!7437
2020-02-20 14:48:15 +08:00
Ivan Grokhotkov
fe0df01b12
Merge branch 'bugfix/from_github' into 'master'
...
Fixes from Github
Closes IDFGH-2679, IDFGH-2632, IDFGH-2716, IDFGH-2439, and IDFGH-2509
See merge request espressif/esp-idf!7659
2020-02-18 23:53:38 +08:00
Ivan Grokhotkov
75d0f38108
Merge branch 'doc/unit_test_multiple_targets' into 'master'
...
doc: add multi-target rules for writing unit tests
See merge request espressif/esp-idf!7438
2020-02-18 23:30:02 +08:00
Ivan Grokhotkov
20d93ac835
docs: remove note about v4.0 docker tag, use release-v4.0 as example
2020-02-18 14:02:46 +01:00
Rusty Eddy
a81d231791
Added semi-colon to esp_event_loop_create(...)
...
Title sums it up.
Merges https://github.com/espressif/esp-idf/pull/4711
2020-02-18 12:30:38 +01:00
Mooli Tayer
311983eb55
Fix typo
...
Merges https://github.com/espressif/esp-idf/pull/4752
2020-02-18 12:30:29 +01:00
Ivan Grokhotkov
9be3cd883b
docs: docker: add instructions for binding tools/kconfig to a volume
...
Closes https://github.com/espressif/esp-idf/issues/4790
2020-02-18 11:43:29 +01:00
Jakob Hasse
7e7f87a70d
DOC: fixed MR regression leading to doc build error
2020-02-18 09:01:33 +01:00
Angus Gratton
e95ba301d8
Merge branch 'bugfix/use_quotes_in_embedding_ulp_apps' into 'master'
...
ulp: use quotes when specifying files for embedding ulp binaries
See merge request espressif/esp-idf!7606
2020-02-18 09:15:50 +08:00
Renz Christian Bagaporo
bb639bb91d
ulp: use quotes when specifying files for embedding ulp binaries
2020-02-18 00:12:56 +00:00
Angus Gratton
99cdddeb63
docs: Fix broken or incorrect link roles to IDF files & directories
2020-02-18 10:34:11 +11:00
Angus Gratton
d9d7a906b1
confserver docs: Merge the build-system docs info about confserver into the README
...
Add link into the README from the docs
2020-02-17 17:21:22 +11:00
Krzysztof Budzynski
41bc06b9b9
Merge branch 'bugfix/docs_ledc' into 'master'
...
drivers: Remove high speed mode from LEDC docs for ESP32-S2, update headers to match
See merge request espressif/esp-idf!7532
2020-02-17 05:00:36 +08:00
Michael (XIAO Xufeng)
699c6db836
doc: add multi-target rules for writing unit tests
2020-02-14 14:54:30 +08:00
Michael (XIAO Xufeng)
067f3d21c9
sdspi, vfs_fat: allow sharing SPI bus among devices, and mounting multiple SD cards
2020-02-12 15:16:08 +08:00
Ivan Grokhotkov
700161921c
docs: update version of IDF tools installer for windows to v2.3
2020-02-11 19:05:17 +01:00
Angus Gratton
ea34f3bb27
drivers: Remove high speed mode from LEDC docs for ESP32-S2, update headers to match
2020-02-11 14:36:47 +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
291735c7dd
docs: Move to Python 3.5+ and Sphinx 2.3
2020-02-07 16:47:50 +11:00
Angus Gratton
4636e8a34c
docs/documenting-code: Add a couple of follow up notes on top of last commit
2020-02-07 16:37:45 +11:00
Marius Vikhammer
9f617c7874
docs: Add a short user guide for how to write multi target docs
2020-02-07 16:37:45 +11:00
Angus Gratton
eb85cfb9f6
docs: Temporarily mark RF calibration chapter as ESP32 only
...
Can be re-enabled once ESP32-S2 calibration support is added
2020-02-07 16:37:45 +11:00
Angus Gratton
50324b505d
docs: Note that the idf target formatting filters don't work on "included" documents
2020-02-07 16:37:45 +11:00
Angus Gratton
740d422134
docs: Possible fix for blockdiag & seqdiag UnicodeEncodeErrors
2020-02-07 16:37:45 +11: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
Marius Vikhammer
105567d077
doc: updated peripherals api-reference for s2
2020-02-07 16:37:44 +11:00
Marius Vikhammer
46dab1b4e8
doc: removed reference to idf_target in core dump title
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
a7bac4721a
doc: Add external ram note link to CN translation
2020-02-07 16:37:43 +11:00
Marius Vikhammer
d56ea52ea1
doc: EN doc update and fixed warnings
2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69
doc: Update English pages with generic target name
2020-02-07 16:37:43 +11:00
Angus Gratton
fdbcc12401
doc: Fix RMT waveform path warnings
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
a148d8e6ba
docs: Refactor extensions into packages, update the add-ons-reference docs page
...
Includes converting some of the remaining standalone scripts into Sphinx extensions.
Make flake8 clean
2020-02-07 16:37:43 +11:00
Angus Gratton
d1373119e1
docs: Cleanup build warnings
2020-02-07 16:37:43 +11:00
Angus Gratton
b0748b4364
docs: Mark some more docs sections as ESP32 only
2020-02-07 16:37:43 +11:00
Angus Gratton
e753c1b509
docs: Edit out some unnecessary instances of "ESP32" in the doc text
2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2020-02-07 16:37:43 +11:00
Angus Gratton
37d5e2fba6
docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of 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
Angus Gratton
783856d557
docs: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers
2020-02-07 16:37:12 +11:00
Konstantin Kondrashov
739eb05bb9
esp32: add implementation of esp_timer based on TG0 LAC timer
...
Closes: IDF-979
2020-02-06 14:00:18 +08:00
Ivan Grokhotkov
036a29bb3d
docs: update build system guide on setting IDF_TARGET
2020-01-31 10:19:44 +01:00
Felipe Neves
5cbb3f05c0
freertos: Added experimental, optional FPU usage on level 1 ISR
2020-01-27 10:55:03 -03:00
Ivan Grokhotkov
1cd6f67679
docs: add API guide page about IDF Tools
2020-01-24 14:02:21 +01:00
Angus Gratton
c1ab87b580
Merge branch 'bugfix/fix_broken_example_link' into 'master'
...
doc:fix icmp initialization and broken example links
Closes IDFGH-2563
See merge request espressif/esp-idf!7402
2020-01-23 14:32:55 +08:00
morris
e30cd361a8
global: rename esp32s2beta to esp32s2
2020-01-22 12:14:38 +08:00
Felipe Neves
73592d9bc4
spin_lock: added new spinlock interface and decoupled it from RTOS
...
spin_lock: cleaned-up port files and removed portmux files
components/soc: decoupled compare and set operations from FreeRTOS
soc/spinlock: filled initial implementation of spinlock refactor
It will decouple the spinlocks into separated components with not depencences of freertos
an similar interface was provided focusing the readabillity and maintenance, also
naming to spinlocks were adopted. On FreeRTOS side the legacy portMUX macros
gained a form of wrapper functions that calls the spinlocks component thus
minimizing the impact on RTOS side.
This feature aims to close IDF-967
soc/spinlock: spinlocks passed on unit test, missing test corner cases
components/compare_set: added better function namings plus minor performance optimization on spinlocks
soc/spinlock: code reordering to remove ISC C90 mix error
freertos/portmacro: gor rid of critical sections multiline macros, placed inline functions instead
soc/spinlock: improved spinlock performance from internal RAM
For cases where the spinlock is executed from IRAM, there is no
need to check where the spinlock object is placed on memory,
removing this checks caused a great improvement on performance.
2020-01-22 06:20:34 +08:00
morris
f2cb6bd4b6
doc: fix broken example links
2020-01-21 12:11:24 +08:00
morris
1c710a1b31
doc: fix incomplete ping session initialization
...
Thanks @nopnop2002 for reporting this issue.
Closes https://github.com/espressif/esp-idf/issues/4648
2020-01-21 12:07:38 +08:00
Krzysztof Budzynski
ac27ab29fd
doc: Fix broken links to examples
2020-01-20 12:10:18 +08:00
Angus Gratton
eaafe7f599
Merge branch 'feature/add_setting_project_version_from_kconfig' into 'master'
...
build: Add CONFIG_APP_PROJECT_VER to set the project version from Kconfig
See merge request espressif/esp-idf!7125
2020-01-16 15:54:14 +08:00
Wang Ning
0093f50214
Add Chinese translation to LEDC.
...
Need technical and language review.
2020-01-16 10:13:40 +08:00
KonstantinKondrashov
b49a657448
build: Add CONFIG_APP_PROJECT_VER to set the project version from Kconfig
2020-01-15 11:02:27 +00:00
Angus Gratton
0da18955aa
Merge branch 'bugfix/doc_remove_cmake_defconfig' into 'master'
...
Doc: replace defconfig with reconfigure
Closes IDFGH-1730
See merge request espressif/esp-idf!5958
2020-01-15 13:29:52 +08:00
Ivan Grokhotkov
80d7db9466
Merge branch 'bugfix/esp32s2_mac_addr_allocation' into 'master'
...
esp32s2 mac address allocation
Closes IDF-1191
See merge request espressif/esp-idf!7286
2020-01-15 11:58:14 +08:00
Ivan Grokhotkov
da8c06eafc
Merge branch 'doc/minor_cxx_additions' into 'master'
...
doc: small changes for cxx code style
See merge request espressif/esp-idf!7210
2020-01-15 11:36:40 +08:00
morris
e1f9b283bc
esp32s2: mac addr allocation
2020-01-14 15:19:38 +08:00
Krzysztof Budzynski
5aa21584cf
Merge branch 'doc/ulp_cmake_fix' into 'master'
...
doc: Remove duplicate ulp-cmake
See merge request espressif/esp-idf!7259
2020-01-10 15:29:56 +08:00
Angus Gratton
782fc0df5f
Merge branch 'refactor/can_driver' into 'master'
...
Refactor CAN to use HAL and LowLevel layers
Closes IDF-617
See merge request espressif/esp-idf!7019
2020-01-10 14:22:02 +08:00
Angus Gratton
b2404513db
Merge branch 'doc/cmake_external_lib' into 'master'
...
docs: Add example of using IDF APIs from an external CMake library
See merge request espressif/esp-idf!6527
2020-01-10 14:13:07 +08:00
Angus Gratton
13f67d4279
doc: Remove duplicate ulp-cmake
...
This file was renamed in 62ed221
when CMake became default, but 8fe3ecd
accidentally reintroduced it.
A redirect is still generated from ulp-cmake to ulp, so the old URL continues to work.
2020-01-10 16:38:06 +11:00
Angus Gratton
8bc618f070
Merge branch 'feature/sntp_add_desc' into 'master'
...
docs: Add System time chapter and for sntp a description about using...
Closes IDFGH-2237, IDF-1199, and IDF-38
See merge request espressif/esp-idf!6818
2020-01-10 13:29:47 +08:00
Angus Gratton
58755cc2f5
Merge branch 'doc/review_api-ref_periph-i2c' into 'master'
...
Review the file api-reference/peripherals/i2c.rst
See merge request espressif/esp-idf!6519
2020-01-10 13:13:23 +08:00
Konstantin Kondrashov
2c793cef06
idf: Support a custom toolchain with time_t wide 64-bits
...
Allows resolving the Y2K38 problem.
Closes: IDF-350
Closes: https://github.com/espressif/esp-idf/issues/584
2020-01-10 12:58:54 +08:00
Angus Gratton
a39e8e5de9
Merge branch 'feature/asio_update' into 'master'
...
asio: updated ASIO port to use latest asio and esp-idf features
See merge request espressif/esp-idf!6623
2020-01-10 12:57:25 +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
Ivan Grokhotkov
a559014ff0
Merge branch 'bugfix/coredump_bin_fmt_ver_update' into 'master'
...
Fixes coredump compatibility with legacy binary core dumps
See merge request espressif/esp-idf!6794
2020-01-10 10:04:17 +08:00
David Cermak
13d603e486
asio: updated ASIO port to use latest asio and esp-idf features
...
closes https://github.com/espressif/esp-idf/issues/4296
2020-01-09 21:53:50 +01:00
Kirill Chalov
c5f77cf6cb
Review the file api-reference/peripherals/i2c.rst
2020-01-09 17:04:41 +08:00
Darian Leung
a049e02d96
can: Refactor CAN to use HAL and LowLevel layers
...
The following commit refactors the CAN driver such that
it is split into HAL and Lowlevel layers. The following
changes have also been made:
- Added bit field members to can_message_t as alternative
to message flags. Updated examples and docs accordingly
- Register field names and fields of can_dev_t updated
2020-01-09 16:13:51 +08:00
Angus Gratton
e1833fa3de
docs: Add example of using IDF APIs from an external CMake library
2020-01-09 13:51:30 +11:00
Angus Gratton
71b4768df8
Merge branch 'doc/secure_boot_ref' into 'master'
...
doc: secure boot: Fix relative reference to key generation step
See merge request espressif/esp-idf!7171
2020-01-07 16:01:09 +08:00
Jakob Hasse
9a10c1bccd
doc: small changes for cxx code style
2020-01-07 15:13:41 +08:00
Angus Gratton
262ce6b9c6
Merge branch 'bugfix/pthread_examples' into 'master'
...
Fix syntax errors on examples contained in esp_pthread documentation
Closes IDF-1313
See merge request espressif/esp-idf!7194
2020-01-07 14:41:06 +08:00
Angus Gratton
6f2a00c425
doc: secure boot: Fix relative reference to key generation step
2020-01-07 06:14:03 +00:00
Felipe Neves
e5e8ee8912
docs: fix esp_pthread example syntax error
2020-01-03 11:21:35 -03:00
Angus Gratton
3a451afb82
doc: Update the legacy MSYS2 environment to use 2019r2 toolchain version
...
As reported at https://www.esp32.com/viewtopic.php?p=52805
2020-01-03 06:05:00 +00: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
Hrishikesh Dhayagude
cca2613a01
NimBLE: Update the link to NimBLE upstream documentation
2019-12-30 20:05:37 +08:00
Kirill Chalov
ab6311c548
Reveiw the file api-reference/peripherals/i2s.rst
2019-12-29 21:05:57 +00:00
Felipe Neves
785abfeb82
docs: update esp_expresstion_with_stack code snippet to check shared stack and mutex allocation.
2019-12-20 13:30:30 -03:00
Felipe Neves
f0e82311a5
esp_expression_with_stack: fix wrong top of stack calculation plus documentation update
2019-12-20 13:23:47 -03:00
Felipe Neves
8bfb8e885e
docs: update on expression with stack api usage regard the stack setup.
2019-12-20 13:18:13 -03:00
Felipe Neves
dfea4196a2
docs: added esp-expression-with-stack on documentation
2019-12-20 13:18:13 -03:00
Angus Gratton
a26e78f66c
Merge branch 'doc/mqtt_api_ref_add_event_info' into 'master'
...
doc/mqtt: add event description to API reference
See merge request espressif/esp-idf!6518
2019-12-20 13:11:56 +08:00
Kirill Chalov
9da268bd32
Review the file api-reference/peripherals/uart.rst
2019-12-19 19:13:38 +08:00
Krzysztof Budzynski
2fa24d6e39
Merge branch 'doc/hr-ref/gs-wrover-kit-v4.1-fix-header-name' into 'master'
...
JP8 -> JP2
See merge request espressif/esp-idf!7053
2019-12-19 17:44:43 +08:00
Natasha
0c444c06a7
add translation for esp_mesh doc
2019-12-19 15:16:50 +08:00
Romain
35bbd996af
JP8 -> JP2
...
Signed-off-by: Kirill Chalov <kirill.chalov@espressif.com>
Merges https://github.com/espressif/esp-idf/pull/4147
2019-12-19 12:43:41 +08:00
Tian Yang Min
666337eb7a
Add Chinese translation for ble-mesh-architecture; add a link for ble-mesh-architecture-en.
2019-12-18 14:37:09 +08:00
Tian Yang Min
ee93da1826
Add Chinese translation for esp-ble-mesh-terminology. Add link to Chinese version in English original text.
2019-12-18 14:34:01 +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
Roland Dobai
bbbc12478a
Docs: Update Debian & Ubuntu install prerequisites
...
Latest versions of apt-get don't install as much packages by default
as older ones. This fix adds some missing packages discovered for an OS
derived from the latest stable Debian. These packages exist for older
Debian derivatives as well (tested with Ubuntu 16.04 LTS).
Closes https://github.com/espressif/esp-idf/issues/4480
2019-12-16 11:41:28 +01:00
Angus Gratton
1843630ef3
Merge branch 'feature/sdio_slave_support_hal_new' into 'master'
...
sdio_slave: support HAL layer
See merge request espressif/esp-idf!6314
2019-12-16 07:22:04 +08:00
Angus Gratton
433d046a2a
Merge branch 'feature/tools_installer_v2.2' into 'master'
...
tools: bump windows tools installer version to v2.2
Closes IDFGH-2036 and IDFGH-2202
See merge request espressif/esp-idf!6999
2019-12-16 07:20:43 +08:00