krzychb
ed0db52f74
docs: This is a quick reference of more than a dozen and-ons and extensions prepared over the last two years to add contents, improve look & feel and cut on maintenance of the ESP-IDF documentation.
2019-02-17 20:32:50 +01:00
krzychb
43c6e77c2f
Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section.
2019-02-17 20:24:17 +01:00
Anurag Kar
59b10709d1
wifi_provisioning : context pointer added to wifi_config_t structure and related examples/docs updated
...
Closes https://github.com/espressif/esp-idf/issues/2874
2019-02-15 10:45:34 +00:00
Angus Gratton
eb4d48815f
Merge branch 'feature/protocomm_httpd_changes' into 'master'
...
Feature/protocomm httpd changes
See merge request idf/esp-idf!4227
2019-02-15 14:21:44 +08:00
Konstantin Kondrashov
e916cf52a3
bootloader: Add support of anti-rollback
...
Added:
* set a secure version in app/bootloader.
* description anti-rollback to ota part
* emulate the secure_version write and read operations
* efuse_em partition.
* a description about a rollback for native_ota_example.
Closes: TW26335
2019-02-14 18:51:43 +08:00
Angus Gratton
4e770aec61
Merge branch 'feature/predictable_event_dispatch_via_duplication' into 'master'
...
Predictable event handler dispatch
See merge request idf/esp-idf!3932
2019-02-05 08:47:03 +08:00
Piyush Shah
759b90a5e1
protocomm_httpd: Allow applications to pass HTTPD handle
...
This will be useful if a webserver is already running and the application
does not want protocomm to start a new instance.
Signed-off-by: Piyush Shah <piyush@espressif.com>
2019-02-04 18:22:05 +05:30
Renz Christian Bagaporo
e9a765d0fd
docs: add notes on handler dispatch order
2019-01-30 20:59:47 +08:00
zhuying
5b938199ab
doc(esp-idf) | JTAG debugging EN update
2019-01-30 11:34:04 +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
Angus Gratton
aa4a5668b0
Merge branch 'bugfix/add_missing_links_to_translation' into 'master'
...
Included missing links between English and Chinese documentation, where…
See merge request idf/esp-idf!4176
2019-01-30 11:32:15 +08:00
Angus Gratton
35a53453f1
Merge branch 'bugfix/doc_updates_from_github' into 'master'
...
Documenation updates from github
See merge request idf/esp-idf!4120
2019-01-30 09:34:28 +08:00
morris
7528dc0f20
ethernet: support new PHY (IP101)
...
1. Add support for new PHY IP101.
2. Re-enable GPIO0 output mode.
3. Clean up some docs.
2019-01-29 14:08:35 +08:00
Anton Maklakov
1332d3ba9c
docs: Correct priorities in the PATH string
...
Fixes https://github.com/espressif/esp-idf/pull/2944
2019-01-28 11:28:55 +08:00
krzychb
f675334ebb
Included missing links between English and Chinese documentation, where translation into Chinese is available
2019-01-27 19:01:34 +01: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
krzychb
7fa8eb91dd
Small updates of wording
2019-01-24 19:50:55 +08:00
ShellAddicted
aa364961d0
docs(en): dialout-linux added specific command for Arch linux the correct group is 'uucp'
...
Merges https://github.com/espressif/esp-idf/pull/2940
2019-01-24 19:50:55 +08:00
Angus Gratton
7f307423c1
newlib: Provide library name for ROM libc object files linked as PSRAM workarounds
...
Works around bug reported on forums where any source file ending in *lock.c or *creat.c
was being linked to IRAM.
https://esp32.com/viewtopic.php?f=13&t=8909&p=37362#p37362
Also moves all related functionality to newlib component.
2019-01-24 11:30:05 +08:00
XiaXiaotian
f3b72ef6aa
esp32: fix invalid channel state information(CSI) data index
...
Due to a hardware limitation in ESP32, the first four bytes of some
CSI data is invalid, not the last four bytes.
Correct a mistake of CSI sub-carrier index in documentation.
2019-01-22 20:11:05 +08:00
He Yin Ling
783cb692e8
unit-test-app: support passing parameter with signals
2019-01-10 09:51:17 +00:00
Liu Zhi Fu
c1022ac22b
docs: udpate wifi document
...
Update WiFi document
2019-01-03 13:46:16 +08:00
Angus Gratton
9f09431f07
doc: wifi: Remove disclaimers
2019-01-02 17:43:11 +11:00
Angus Gratton
6578673ed4
Merge branch 'feature/esp_platform_cmake_pr2601' into 'master'
...
cmake: Add ESP_PLATFORM in CMake build (PR 2601)
See merge request idf/esp-idf!3823
2019-01-02 14:03:52 +08:00
Angus Gratton
db8bc3eea7
Merge branch 'doc/cmake_branch' into 'master'
...
Make CMake Getting Started guides version-aware
See merge request idf/esp-idf!3984
2018-12-21 17:36:48 +08:00
Angus Gratton
88150cb9bb
docs: Make Getting Started (CMake) guides version-aware
...
Also clean up some changes in Chinese CMake guide which were not propagated from the English guide.
2018-12-21 19:13:20 +11:00
Angus Gratton
39dc1b4ff3
doc: cmake: Add description of ESP_PLATFORM variable
...
Ref: https://github.com/espressif/esp-idf/pull/2601
2018-12-21 19:00:12 +11:00
Angus Gratton
78487123bf
Merge branch 'feature/cut_len_for_header_struct' into 'master'
...
build: Add trimming PROJECT_VER and PROJECT_NAME vars
See merge request idf/esp-idf!3927
2018-12-21 07:45:22 +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
Angus Gratton
ad200227d2
Merge branch 'feature/add_rollback_flags' into 'master'
...
bootloader/app_update: Add a support of an app rollback.
See merge request idf/esp-idf!3547
2018-12-19 14:28:11 +08:00
Konstantin Kondrashov
7b68e346fa
build: Fix a warning from git describe
...
Fixed a fatal message when run `git describe`.
2018-12-18 15:58:22 +08:00
Angus Gratton
42dcdecce2
Merge branch 'doc/network' into 'master'
...
docs: Rearrange wifi & ethernet docs under "Networking", add tcpip_adapter docs
See merge request idf/esp-idf!3890
2018-12-18 13:15:05 +08:00
Angus Gratton
ede47ed33a
tcpip_adapter: Update header descriptions, constify some parameters
2018-12-18 14:07:43 +11:00
Angus Gratton
15a7ad78f7
Merge branch 'feature/rename_main_instructions' into 'master'
...
Add instructions on how to rename main component
See merge request idf/esp-idf!3933
2018-12-18 08:08:20 +08: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
Wang Fang
e7bc89774d
Doc/translation establish serial connection wangfang
2018-12-17 11:49:35 +08:00
Angus Gratton
6a4955ef74
doc: Rearrange wifi & ethernet docs into a common "network" doc
2018-12-17 14:18:09 +11:00
Konstantin Kondrashov
dde1fd9b94
bootloader: Add support flags for rollback app
...
Added
* Set actual ota_seq if both ota are init or incorrect.
* Description of rollback
* UT tests
Closes TW15459
2018-12-11 11:54:21 +08:00
Noeël Moeskops
19cf1bb7db
Typo fix in mqtt.rst.
...
changed 'defalut' to 'default'
Merges https://github.com/espressif/esp-idf/pull/2780
2018-12-10 19:13:01 +01:00
Stephen Bird
bb4936b4d5
Add missing dependency.
...
Merges https://github.com/espressif/esp-idf/pull/2781
2018-12-10 19:12:46 +01:00
Renz Christian Bagaporo
fd44580e52
docs: add section on renaming main component
2018-12-10 12:30:08 +08:00
Ivan Grokhotkov
646d36c728
Merge branch 'feature/nmea-parser' into 'master'
...
NMEA0183 Parser
See merge request idf/esp-idf!3866
2018-12-07 14:32:04 +08:00
Ivan Grokhotkov
8b885fb935
Merge branch 'docs/add_note_for_ulp_set_wakeup_period' into 'master'
...
ulp: add note regarding limitation of ulp_set_wakeup_period in deep sleep mode
See merge request idf/esp-idf!3796
2018-12-07 14:07:14 +08:00
morris
8b7b5821c7
example: add nmea0183 parser example
...
Add NMEA0183 Parser example to illustrate how to use uart event driver together with esp event library to get GPS information.
2018-12-07 10:57:34 +08:00
Angus Gratton
aae955d1ae
Merge branch 'docs/mesh_channel_switch' into 'master'
...
docs: Add documentation about ESP-MESH channel switching and self organized behavior
See merge request idf/esp-idf!3854
2018-12-07 09:24:51 +08:00
Roland Dobai
b56ed1a99e
docs: Correct Python coding style
2018-12-05 08:22:33 +01:00
Ivan Grokhotkov
37975c186d
Merge branch 'feature/pthread_name_affinity_config' into 'master'
...
pthread: make affinity and task name configurable
See merge request idf/esp-idf!3878
2018-12-05 13:46:05 +08:00
Ivan Grokhotkov
8a7b46aa90
Merge branch 'feature/anti_rollback_exp' into 'master'
...
esp32: Add firmware version to app
See merge request idf/esp-idf!3461
2018-12-05 11:10:04 +08:00
Angus Gratton
794155f975
Merge branch 'doc/security_features_small_fixes' into 'master'
...
doc: Small secure boot & flash encryption corrections
See merge request idf/esp-idf!3876
2018-12-05 09:03:30 +08:00
Angus Gratton
a2d0fbb9ab
docs: flash encryption: Fix description of behaviour when all bits of FLASH_CRYPT_CNT are set
...
Correct behaviour is described in section 25.3.3 Flash Decryption Block of the ESP32 TRM
2018-12-05 11:15:00 +11:00
Jeroen Domburg
d6ee27e313
Merge branch 'feat/spi_check_length_buffer' into 'master'
...
spi: add checks for slave buffer valid and master length
See merge request idf/esp-idf!3744
2018-12-04 11:48:32 +08:00
Angus Gratton
ac1d1aa3c8
doc: secure boot: Explain output of digest_secure_bootloader command
...
Mentioned on forum https://esp32.com/viewtopic.php?f=13&t=8162&start=10#p34714
2018-12-04 12:34:59 +11:00
Angus Gratton
b45b0f2348
doc: security: Use less ambiguous language about using bot flash encryption & secure boot together
2018-12-04 12:34:38 +11:00
Konstantin Kondrashov
3b9cb25fe1
esp32: Add firmware version to app
...
Added a new structure esp_app_desc_t. It has info about firmware:
version, secure_version, project_name, time/date build and IDF version.
Added the ability to add a custom structure with a description of the firmware.
The esp_app_desc_t is located in fixed place in start of ROM secotor. It is located after structures esp_image_header_t and esp_image_segment_header_t.
app_version is filed from PROJECT_VER variable (if set in custom make file) or PROJECT_PATH/version.txt or git repo (git describe).
Add API to get app_desc from partition.
2018-12-03 16:52:04 +08:00
Mahavir Jain
588ecaae09
ulp: add note regarding limitation of ulp_set_wakeup_period in deep sleep mode
2018-12-03 11:41:10 +05:30
Darian Leung
674f0b1ebd
doc: Add mesh channel switching and self organized networking documentation
2018-12-03 11:57:32 +08:00
Angus Gratton
fffa98647b
Merge branch 'feature/docs_more_on_shared_pins_of_esp-wrover-kit' into 'master'
...
Extended information on using pins of ESP-WROVER-KIT that are shared among…
See merge request idf/esp-idf!3841
2018-12-03 07:02:40 +08:00
Krzysztof Budzynski
340e7f3b2f
Provided translation of 'Hardware Reference' into Chinese
2018-12-03 07:02:33 +08:00
Jiang Jiang Jian
e07c5a22f2
Merge branch 'doc/RF_calibration' into 'master'
...
doc: add documentation for RF calibration
See merge request idf/esp-idf!3828
2018-11-30 21:50:29 +08:00
Darian Leung
f0e8c068d2
docs: Fix mesh doc line wrapping
...
This commit fixes mesh doc line wrapping by making every
paragraph into a single line.
2018-11-30 21:13:28 +08:00
Xia Xiaotian
59761b0fcb
doc: add documentation for RF calibration
...
Add an API to erase phy namespace of NVS
2018-11-30 16:26:56 +08:00
Angus Gratton
afe4c76b6b
Merge branch 'doc/heap_basics' into 'master'
...
docs: Add some more explanation about heap, memory types
See merge request idf/esp-idf!3810
2018-11-30 10:24:51 +08:00
Angus Gratton
a3a1cc080e
docs: Add some more explanation about heap, memory types
2018-11-30 12:29:38 +11:00
krzychb
29b1f86f16
Extended information on using pins of ESP-WROVER-KIT that are shared among peripherals. Inspired by https://esp32.com/viewtopic.php?f=12&t=6856 .
2018-11-29 16:56:49 +01:00
Angus Gratton
759185b16c
Merge branch 'bugfix/bt_ut_build_all' into 'master'
...
Fix unit test cmake build for BT
See merge request idf/esp-idf!3767
2018-11-29 09:52:55 +08:00
Per Malmberg
71f57931bd
#2743 - Implemented ability to core affinity and thread name for pthreads and thus also for std::thread.
2018-11-28 20:43:09 +01:00
Jiang Jiang Jian
a134141320
Merge branch 'mesh/feature_channel_switch' into 'master'
...
mesh: add channel switch function
See merge request idf/esp-idf!3772
2018-11-28 20:11:38 +08:00
Anton Maklakov
9dde91ce2b
modbus: Fix a typo in the docs
2018-11-28 15:19:03 +08:00
qiyuexia
1692896e5e
mesh: add channel switch function
...
1. add network channel switch function.
- users can obtain the new channel through the event MESH_EVENT_CHANNEL_SWITCH.
- the entire network will be moved to the same channel as the router without user intervention.
- if no router is in the network, users can call esp_mesh_switch_channel() on the root side to
move the entire network to their desired channel.
2. support not configuring the network channel.
3. support not configuring the router BSSID even if the router is hidden.
4. add allow_channel_switch to mesh configuration.
- if the channel is not specified, this value will be ignored.
- if the channel is specified and this value is set, when "fail" (mesh_attempts_t) times of parent selection
or look for networks are reached, device will change to perform a full channel scan for networks that could join.
- if the channel is specified and this value is set to 0, when a root is not elected, channel switch is not allowed.
but when a root appears, the root performs a full channel scan during the process of connecting to the router,
so even allow_channel_switch is set to 0, the root may still switch channel and eventually the entire network
changes channel.
5. add allow_router_switch to mesh router configuration.
- if the BSSID of router is not specified, this value will be ignored.
- if the BSSID of router is specified and this value is set, when the router of this specified BSSID fails to be found
after "fail" (mesh_attempts_t) times, the entire network is allowed to switch to another router with the same SSID.
6. modify the root to perform a full channel scan when esp_wifi_connect().
7. support handling beacon without DS Paramter Set.
2018-11-27 23:36:01 +08:00
Renz Bagaporo
7e7cc99241
docs: generic cmake support
2018-11-27 19:56:52 +08:00
michael
cfba157fdd
spi_slave: add valid check for DMA buffers
...
The DMA cannot receive data correctly when the buffer address is not
WORD aligned. Currently we only check whether the buffer is in the DRAM
region.
The DMA always write in WORDs, so the length arguments should also be
multiples of 32 bits.
A check is added to see whether the buffer is WORD aligned and has valid
length.
2018-11-26 03:49:26 +00:00
Angus Gratton
83f6ee9912
Merge branch 'bugfix/docs_https_server' into 'master'
...
Docs : esp_https_server API references corrected
See merge request idf/esp-idf!3775
2018-11-23 10:44:55 +08:00
Renz Christian Bagaporo
1600c3144c
docs: add pyparsing install to setup guide
2018-11-22 22:09:43 +08:00
Anurag Kar
684f0b0a32
Docs : esp_https_server API references corrected
2018-11-22 15:57:05 +05:30
Angus Gratton
92f32f0060
Merge branch 'fix/spi_callback_in_iram' into 'master'
...
spi: fix the crash when callbacks are not in the IRAM
See merge request idf/esp-idf!3498
2018-11-20 16:25:08 +08:00
Angus Gratton
61ee1bd31f
Merge branch 'feature/esp_https_server' into 'master'
...
Add HTTPS Server component
See merge request idf/esp-idf!3608
2018-11-20 13:58:26 +08:00
Michael (XIAO Xufeng)
8cddfa35b8
spi: fix the crash when callbacks are not in the IRAM
...
Introduced in 9c23b8e5
and 4f87a62f
. To get higher speed, menuconfig
options are added to put ISR and other functions into the IRAM. The
interrupt flag ESP_INTR_FLAG_IRAM is also mistakenly set when the ISR is
put into the IRAM. However callbacks, which are wrote by the user, are
called in the master and slave ISR. The user may not be aware of that
these callbacks are not disabled during flash operations. Any cache miss
during flash operation will cause panic.
Essentially IRAM functions and intrrupt flag ESP_INTR_FLAG_IRAM are
different, the latter means not disabling the ISR during flash
operations. New bus_config flag intr_flags is offered to help set the
interrupt attribute, including priority level, SHARED, IRAM (not
disabled during flash operations). It introduced a small BREAK to
IDFv3.1 (but the same as IDFv3.0) that the user has to manually set IRAM
flag now (therefore he's aware of the IRAM thing) to void the ISR being
disabled during flash operations.
2018-11-20 13:07:13 +08:00
Angus Gratton
57273d48d4
Merge branch 'doc/translation_eclipse-setup_wangfang' into 'master'
...
Doc/translation eclipse setup wangfang
See merge request idf/esp-idf!3681
2018-11-19 14:04:04 +08:00
Angus Gratton
26a6969873
Merge branch 'doc/add_cmake_translation' into 'master'
...
doc/add_translation_for_cmake_documents
See merge request idf/esp-idf!3636
2018-11-19 12:53:06 +08:00
Angus Gratton
8915f48208
Merge branch 'feature/linker_script_generator' into 'master'
...
Linker script generator
See merge request idf/esp-idf!2286
2018-11-19 12:43:27 +08:00
Prasad Alatkar
b1189e9645
Docs: Change makes Eclipse setup inline with Mac OS and Linux.
2018-11-19 12:15:53 +08:00
Wang Fang
7d888ff6eb
Doc/translation linux setup scratch wangfang
2018-11-19 12:14:45 +08:00
Anurag Kar
aa6066a197
esp_https_server : Docs and API references fixed
2018-11-19 04:00:21 +00: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
Renz Bagaporo
63411fc556
tools: implement linker script generation
2018-11-16 12:42:02 +08:00
Angus Gratton
b6d7c70238
Merge branch 'doc/console_zh_CN' into 'master'
...
doc/console: translate console.rst into zh_CN
See merge request idf/esp-idf!3320
2018-11-16 11:21:16 +08:00
Alexey Gerenkov
b152c1020c
esp32: Adds logging level to core dump script
2018-11-15 06:13:48 +00:00
Alexey Gerenkov
181a40ae30
esp32: Adds menuconfig option for max tasks number in core dump
2018-11-15 06:13:48 +00:00
Alexey Gerenkov
a55cc99f50
esp32: Replaces magic numbers with CRC for core dump in flash
2018-11-15 06:13:48 +00:00
liying
08ef71b386
1.Update 8 English cmake files
...
2.Provide Chinese translation to these 8 cmake files
2018-11-13 11:38:23 +08:00
wangfang
df8feaa5c2
Update translation based on review
2018-11-12 16:16:52 +08:00
Ivan Grokhotkov
7efb3926c5
Merge branch 'feature/build_system_multi_target' into 'master'
...
build system: support for multiple targets (CMake only)
See merge request idf/esp-idf!3499
2018-11-12 15:30:36 +08:00
Natasha
be0123e10e
Feature/update board guides for headers
2018-11-12 09:15:29 +08:00
Ivan Grokhotkov
ccfa134533
build system: support for multiple targets
2018-11-11 21:46:02 +08:00
Cheppali Umasankar Reddy
f85f64b481
docs: corrected typo event_handler
...
esp_http_client_config_t has member event_handler not event_handle
Merges https://github.com/espressif/esp-idf/pull/2662
2018-11-08 15:57:13 +05:30
morris
71b9720309
doc/console: translate console.rst into zh_CN
2018-11-07 17:27:15 +08:00
liying
df9d1cc5d4
doc:update_creating_example_cn
2018-11-07 17:18:51 +08:00
Ivan Grokhotkov
621e316725
Merge branch 'feat/psram_support_hspi' into 'master'
...
esp32: support to use hspi to output clock for 4M psram
See merge request idf/esp-idf!3377
2018-11-06 20:34:41 +08:00
liying
9894d35839
(doc)update_CN/EN_partition_tables
2018-11-05 18:58:54 +08:00
morris
d61680b211
doc/partition-tables: translation of zh_CN
...
1. Translated partition-tables.rst into Chinese.
2. Fixed some error in the English version.
2018-11-05 18:58:22 +08:00