mirror of
https://github.com/espressif/esp-idf.git
synced 2025-09-30 19:19:21 +00:00
Replace all DOS line endings with Unix
Command run was: git ls-tree -r HEAD --name-only | xargs dos2unix
This commit is contained in:
Angus Gratton
committed by
Ivan Grokhotkov
Ivan Grokhotkov
parent
74245d27d3
commit
a67d5d89e0
@@ -1,16 +1,16 @@
|
||||
# Documentation Source Folder
|
||||
|
||||
This folder contains source files of **ESP-IDF documentation** available in [English](https://docs.espressif.com/projects/esp-idf/en/latest/) and [中文](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/).
|
||||
|
||||
The sources do not render well in GitHub and some information is not visible at all.
|
||||
|
||||
Use actual documentation generated within about 20 minutes on each commit:
|
||||
|
||||
# Hosted Documentation
|
||||
|
||||
* English: https://docs.espressif.com/projects/esp-idf/en/latest/
|
||||
* 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
|
||||
|
||||
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
|
||||
|
||||
|
||||
# Documentation Source Folder
|
||||
|
||||
This folder contains source files of **ESP-IDF documentation** available in [English](https://docs.espressif.com/projects/esp-idf/en/latest/) and [中文](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/).
|
||||
|
||||
The sources do not render well in GitHub and some information is not visible at all.
|
||||
|
||||
Use actual documentation generated within about 20 minutes on each commit:
|
||||
|
||||
# Hosted Documentation
|
||||
|
||||
* English: https://docs.espressif.com/projects/esp-idf/en/latest/
|
||||
* 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
|
||||
|
||||
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
|
||||
|
||||
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
.. this picture is generated by https://wavedrom.com/, using the sphinx plugin sphinxcontrib-wavedrom
|
||||
.. due to plugin issue, we cannot place only the picture information in a standalone file, but have to take .. wavedrom:: inside
|
||||
|
||||
.. wavedrom::
|
||||
|
||||
{ signal: [
|
||||
{ name: 'SCLK', wave: 'p...', node: '.ad...' },
|
||||
{ name: 'MISO', wave: 'x3x.', node: '.b...', phase:-1.8 },
|
||||
{ name: 'MISO delayed', wave: 'x3x.', node: '.c.', phase:-2.4 },
|
||||
],
|
||||
edge: [
|
||||
'a|->b input delay',
|
||||
'b|->c gpio delay',
|
||||
'c-|>d setup slack'
|
||||
],
|
||||
config: { hscale: 3 }
|
||||
}
|
||||
.. this picture is generated by https://wavedrom.com/, using the sphinx plugin sphinxcontrib-wavedrom
|
||||
.. due to plugin issue, we cannot place only the picture information in a standalone file, but have to take .. wavedrom:: inside
|
||||
|
||||
.. wavedrom::
|
||||
|
||||
{ signal: [
|
||||
{ name: 'SCLK', wave: 'p...', node: '.ad...' },
|
||||
{ name: 'MISO', wave: 'x3x.', node: '.b...', phase:-1.8 },
|
||||
{ name: 'MISO delayed', wave: 'x3x.', node: '.c.', phase:-2.4 },
|
||||
],
|
||||
edge: [
|
||||
'a|->b input delay',
|
||||
'b|->c gpio delay',
|
||||
'c-|>d setup slack'
|
||||
],
|
||||
config: { hscale: 3 }
|
||||
}
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
.. this picture is generated by https://wavedrom.com/, using the sphinx plugin sphinxcontrib-wavedrom
|
||||
.. due to plugin issue, we cannot place only the picture information in a standalone file, but have to take .. wavedrom:: inside
|
||||
|
||||
.. wavedrom::
|
||||
|
||||
{ signal: [
|
||||
{ name: 'SCLK', wave: '0.1....0....1...', node: '..a.........e'},
|
||||
{ name: 'SLV_CLK',wave: 'p..............', node: '..b..', phase: -0.5 },
|
||||
{ name: 'MISO', wave: 'x...3.....x....', node: '....c', phase:-0.5},
|
||||
{ name: 'MISO delayed', wave: 'x.......3.....x.', node: '........d'},
|
||||
],
|
||||
edge: [
|
||||
'a|->b sample delay',
|
||||
'b|->c slave output delay',
|
||||
'c|->d gpio delay',
|
||||
'd-|>e setup slack',
|
||||
'a-|>c input delay'
|
||||
],
|
||||
}
|
||||
.. this picture is generated by https://wavedrom.com/, using the sphinx plugin sphinxcontrib-wavedrom
|
||||
.. due to plugin issue, we cannot place only the picture information in a standalone file, but have to take .. wavedrom:: inside
|
||||
|
||||
.. wavedrom::
|
||||
|
||||
{ signal: [
|
||||
{ name: 'SCLK', wave: '0.1....0....1...', node: '..a.........e'},
|
||||
{ name: 'SLV_CLK',wave: 'p..............', node: '..b..', phase: -0.5 },
|
||||
{ name: 'MISO', wave: 'x...3.....x....', node: '....c', phase:-0.5},
|
||||
{ name: 'MISO delayed', wave: 'x.......3.....x.', node: '........d'},
|
||||
],
|
||||
edge: [
|
||||
'a|->b sample delay',
|
||||
'b|->c slave output delay',
|
||||
'c|->d gpio delay',
|
||||
'd-|>e setup slack',
|
||||
'a-|>c input delay'
|
||||
],
|
||||
}
|
||||
|
||||
@@ -1,33 +1,33 @@
|
||||
# this is a GNUPLOT script generating the figure of spi_master_freq_tv.png
|
||||
|
||||
set xlabel "Input delay (ns)"
|
||||
set xrange [0: 125]
|
||||
set ylabel "Fmax (MHz)"
|
||||
set yrange [0: 81]
|
||||
set xtics 12.5 textcolor rgb "black"
|
||||
set ytics 10 textcolor rgb "black"
|
||||
set border 3 lc rgb "gray" lw 2
|
||||
set grid lt -1 lc rgb "gray" lw 2
|
||||
set samples 10000
|
||||
set terminal png size 700,500
|
||||
set output "plot.png"
|
||||
|
||||
apb = 12.5
|
||||
|
||||
#each line is broken into 10 pieces by the range determined by i
|
||||
f1(i,x) = (x>= i*apb) && (x < (i+1)*apb) ? 80./(i+1) : 1/0
|
||||
|
||||
set style circle radius graph 0.008
|
||||
|
||||
#solid and empty circles are draw by the coordinates given in the csv
|
||||
plot [0:125]\
|
||||
f1(-1, x) lw 3lc rgb "blue" title "IOMUX",\
|
||||
for [i=0:9] f1(i, x) with lines lw 3 lc rgb "blue" notitle,\
|
||||
f1(0, x+25) lw 3 lc rgb "red" title "GPIO",\
|
||||
for [i=2:11] f1(i, x+25) with lines lw 3 lc rgb "red" notitle, \
|
||||
"tv.csv" using 1:2 with circles notitle fill solid fc rgb "blue", \
|
||||
"tv.csv" using 1:4 with circles notitle fc rgb "blue",\
|
||||
"tv.csv" using 1:3 with circles notitle fill solid fc rgb "red" ,\
|
||||
"tv.csv" using 1:5 with circles notitle fc rgb "red"
|
||||
|
||||
|
||||
# this is a GNUPLOT script generating the figure of spi_master_freq_tv.png
|
||||
|
||||
set xlabel "Input delay (ns)"
|
||||
set xrange [0: 125]
|
||||
set ylabel "Fmax (MHz)"
|
||||
set yrange [0: 81]
|
||||
set xtics 12.5 textcolor rgb "black"
|
||||
set ytics 10 textcolor rgb "black"
|
||||
set border 3 lc rgb "gray" lw 2
|
||||
set grid lt -1 lc rgb "gray" lw 2
|
||||
set samples 10000
|
||||
set terminal png size 700,500
|
||||
set output "plot.png"
|
||||
|
||||
apb = 12.5
|
||||
|
||||
#each line is broken into 10 pieces by the range determined by i
|
||||
f1(i,x) = (x>= i*apb) && (x < (i+1)*apb) ? 80./(i+1) : 1/0
|
||||
|
||||
set style circle radius graph 0.008
|
||||
|
||||
#solid and empty circles are draw by the coordinates given in the csv
|
||||
plot [0:125]\
|
||||
f1(-1, x) lw 3lc rgb "blue" title "IOMUX",\
|
||||
for [i=0:9] f1(i, x) with lines lw 3 lc rgb "blue" notitle,\
|
||||
f1(0, x+25) lw 3 lc rgb "red" title "GPIO",\
|
||||
for [i=2:11] f1(i, x+25) with lines lw 3 lc rgb "red" notitle, \
|
||||
"tv.csv" using 1:2 with circles notitle fill solid fc rgb "blue", \
|
||||
"tv.csv" using 1:4 with circles notitle fc rgb "blue",\
|
||||
"tv.csv" using 1:3 with circles notitle fill solid fc rgb "red" ,\
|
||||
"tv.csv" using 1:5 with circles notitle fc rgb "red"
|
||||
|
||||
|
||||
|
||||
58
docs/_static/diagrams/spi_master/tv.csv
vendored
58
docs/_static/diagrams/spi_master/tv.csv
vendored
@@ -1,29 +1,29 @@
|
||||
0 80 26.66666667 #DIV/0! #DIV/0!
|
||||
12.5 40 20 80 26.66666667
|
||||
25 26.66666667 16 40 20
|
||||
37.5 20 13.33333333 26.66666667 16
|
||||
50 16 11.42857143 20 13.33333333
|
||||
62.5 13.33333333 10 16 11.42857143
|
||||
75 11.42857143 8.888888889 13.33333333 10
|
||||
87.5 10 8 11.42857143 8.888888889
|
||||
100 8.888888889 7.272727273 10 8
|
||||
112.5 8 6.666666667 8.888888889 7.272727273
|
||||
125 7.272727273 6.153846154 8 6.666666667
|
||||
137.5 6.666666667 5.714285714 7.272727273 6.153846154
|
||||
150 6.153846154 5.333333333 6.666666667 5.714285714
|
||||
162.5 5.714285714 5 6.153846154 5.333333333
|
||||
175 5.333333333 4.705882353 5.714285714 5
|
||||
187.5 5 4.444444444 5.333333333 4.705882353
|
||||
200 4.705882353 4.210526316 5 4.444444444
|
||||
212.5 4.444444444 4 4.705882353 4.210526316
|
||||
225 4.210526316 3.80952381 4.444444444 4
|
||||
237.5 4 3.636363636 4.210526316 3.80952381
|
||||
250 3.80952381 3.47826087 4 3.636363636
|
||||
262.5 3.636363636 3.333333333 3.80952381 3.47826087
|
||||
275 3.47826087 3.2 3.636363636 3.333333333
|
||||
287.5 3.333333333 3.076923077 3.47826087 3.2
|
||||
300 3.2 2.962962963 3.333333333 3.076923077
|
||||
312.5 3.076923077 2.857142857 3.2 2.962962963
|
||||
325 2.962962963 2.75862069 3.076923077 2.857142857
|
||||
337.5 2.857142857 2.666666667 2.962962963 2.75862069
|
||||
350 2.75862069 2.580645161 2.857142857 2.666666667
|
||||
0 80 26.66666667 #DIV/0! #DIV/0!
|
||||
12.5 40 20 80 26.66666667
|
||||
25 26.66666667 16 40 20
|
||||
37.5 20 13.33333333 26.66666667 16
|
||||
50 16 11.42857143 20 13.33333333
|
||||
62.5 13.33333333 10 16 11.42857143
|
||||
75 11.42857143 8.888888889 13.33333333 10
|
||||
87.5 10 8 11.42857143 8.888888889
|
||||
100 8.888888889 7.272727273 10 8
|
||||
112.5 8 6.666666667 8.888888889 7.272727273
|
||||
125 7.272727273 6.153846154 8 6.666666667
|
||||
137.5 6.666666667 5.714285714 7.272727273 6.153846154
|
||||
150 6.153846154 5.333333333 6.666666667 5.714285714
|
||||
162.5 5.714285714 5 6.153846154 5.333333333
|
||||
175 5.333333333 4.705882353 5.714285714 5
|
||||
187.5 5 4.444444444 5.333333333 4.705882353
|
||||
200 4.705882353 4.210526316 5 4.444444444
|
||||
212.5 4.444444444 4 4.705882353 4.210526316
|
||||
225 4.210526316 3.80952381 4.444444444 4
|
||||
237.5 4 3.636363636 4.210526316 3.80952381
|
||||
250 3.80952381 3.47826087 4 3.636363636
|
||||
262.5 3.636363636 3.333333333 3.80952381 3.47826087
|
||||
275 3.47826087 3.2 3.636363636 3.333333333
|
||||
287.5 3.333333333 3.076923077 3.47826087 3.2
|
||||
300 3.2 2.962962963 3.333333333 3.076923077
|
||||
312.5 3.076923077 2.857142857 3.2 2.962962963
|
||||
325 2.962962963 2.75862069 3.076923077 2.857142857
|
||||
337.5 2.857142857 2.666666667 2.962962963 2.75862069
|
||||
350 2.75862069 2.580645161 2.857142857 2.666666667
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
About
|
||||
About
|
||||
=====
|
||||
|
||||
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ chip by `Espressif <https://espressif.com>`_.
|
||||
|
||||
@@ -1,104 +1,104 @@
|
||||
128 vTaskAllocateMPURegions xTask=%t pxRegions=%u
|
||||
33 vTaskDelete xTaskToDelete=%t
|
||||
34 vTaskDelay xTicksToDelay=%u
|
||||
35 vTaskDelayUntil
|
||||
129 uxTaskPriorityGet xTask=%t
|
||||
56 uxTaskPriorityGetFromISR xTask=%t
|
||||
130 eTaskGetState xTask=%t
|
||||
55 vTaskPrioritySet xTask=%t uxNewPriority=%u
|
||||
36 vTaskSuspend xTaskToSuspend=%t
|
||||
40 vTaskResume xTaskToResume=%t
|
||||
43 xTaskResumeFromISR xTaskToResume=%t
|
||||
131 vTaskStartScheduler
|
||||
132 vTaskEndScheduler
|
||||
133 vTaskSuspendAll
|
||||
134 xTaskResumeAll
|
||||
135 xTaskGetTickCount
|
||||
57 xTaskGetTickCountFromISR
|
||||
136 uxTaskGetNumberOfTasks
|
||||
137 pcTaskGetTaskName xTaskToQuery=%t
|
||||
138 uxTaskGetStackHighWaterMark xTask=%t
|
||||
139 vTaskSetApplicationTaskTag xTask=%t pxHookFunction=%u
|
||||
140 xTaskGetApplicationTaskTag xTask=%t
|
||||
141 vTaskSetThreadLocalStoragePointer xTaskToSet=%T xIndex=%u pvValue=%u
|
||||
142 pvTaskGetThreadLocalStoragePointer xTaskToQuery=%T xIndex=%u
|
||||
143 xTaskCallApplicationTaskHook xTask=%T pvParameter=%u
|
||||
144 xTaskGetIdleTaskHandle
|
||||
145 uxTaskGetSystemState pxTaskStatusArray=%u uxArraySize=%u pulTotalRunTime=%u
|
||||
146 vTaskList pcWriteBuffer=%u
|
||||
147 vTaskGetRunTimeStats pcWriteBuffer=%u
|
||||
44 xTaskGenericNotify xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u
|
||||
45 xTaskGenericNotifyFromISR xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u pxHigherPriorityTaskWoken=%u
|
||||
46 xTaskNotifyWait ulBitsToClearOnEntry=%u ulBitsToClearOnExit=%u pulNotificationValue=%u xTicksToWait=%u
|
||||
38 vTaskNotifyGiveFromISR xTaskToNotify=%t pxHigherPriorityTaskWoken=%u
|
||||
37 ulTaskNotifyTake xClearCountOnExit=%u xTicksToWait=%u
|
||||
148 xTaskNotifyStateClear xTask=%t
|
||||
149 xTaskGetCurrentTaskHandle
|
||||
150 vTaskSetTimeOutState pxTimeOut=%u
|
||||
151 xTaskCheckForTimeOut pxTimeOut=%u pxTicksToWait=%u
|
||||
152 vTaskMissedYield
|
||||
153 xTaskGetSchedulerState
|
||||
39 vTaskPriorityInherit pxMutexHolder=%p
|
||||
42 xTaskPriorityDisinherit pxMutexHolder=%p
|
||||
154 xTaskGenericCreate pxTaskCode=%u pcName=%u usStackDepth=%u pvParameters=%u uxPriority=%u pxCreatedTask=%u puxStackBuffer=%u xRegions=%u
|
||||
155 uxTaskGetTaskNumber xTask=%u
|
||||
156 vTaskSetTaskNumber xTask=%u uxHandle=%u
|
||||
41 vTaskStepTick xTicksToJump=%u
|
||||
157 eTaskConfirmSleepModeStatus
|
||||
158 xTimerCreate pcTimerName=%u xTimerPeriodInTicks=%u uxAutoReload=%u pvTimerID=%u pxCallbackFunction=%u
|
||||
159 pvTimerGetTimerID xTimer=%u
|
||||
160 vTimerSetTimerID xTimer=%u pvNewID=%u
|
||||
161 xTimerIsTimerActive xTimer=%u
|
||||
162 xTimerGetTimerDaemonTaskHandle
|
||||
163 xTimerPendFunctionCallFromISR xFunctionToPend=%u pvParameter1=%u ulParameter2=%u pxHigherPriorityTaskWoken=%u
|
||||
164 xTimerPendFunctionCall xFunctionToPend=%u pvParameter1=%u ulParameter2=%u xTicksToWait=%u
|
||||
165 pcTimerGetTimerName xTimer=%u
|
||||
166 xTimerCreateTimerTask
|
||||
167 xTimerGenericCommand xTimer=%u xCommandID=%u xOptionalValue=%u pxHigherPriorityTaskWoken=%u xTicksToWait=%u
|
||||
53 xQueueGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
50 xQueuePeekFromISR xQueue=%I pvBuffer=%p
|
||||
49 xQueueGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeek=%u
|
||||
168 uxQueueMessagesWaiting xQueue=%I
|
||||
169 uxQueueSpacesAvailable xQueue=%I
|
||||
48 vQueueDelete xQueue=%I
|
||||
54 xQueueGenericSendFromISR xQueue=%I pvItemToQueue=%p pxHigherPriorityTaskWoken=%u xCopyPosition=%u
|
||||
61 xQueueGiveFromISR xQueue=%I pxHigherPriorityTaskWoken=%u
|
||||
51 xQueueReceiveFromISR xQueue=%I pvBuffer=%p pxHigherPriorityTaskWoken=%u
|
||||
62 xQueueIsQueueEmptyFromISR xQueue=%I
|
||||
63 xQueueIsQueueFullFromISR xQueue=%I
|
||||
170 uxQueueMessagesWaitingFromISR xQueue=%I
|
||||
171 xQueueAltGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
172 xQueueAltGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeeking=%u
|
||||
173 xQueueCRSendFromISR xQueue=%I pvItemToQueue=%p xCoRoutinePreviouslyWoken=%u
|
||||
174 xQueueCRReceiveFromISR xQueue=%I pvBuffer=%p pxTaskWoken=%u
|
||||
175 xQueueCRSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u
|
||||
176 xQueueCRReceive xQueue=%I pvBuffer=%p xTicksToWait=%u
|
||||
177 xQueueCreateMutex ucQueueType=%u
|
||||
178 xQueueCreateCountingSemaphore uxMaxCount=%u uxInitialCount=%u
|
||||
179 xQueueGetMutexHolder xSemaphore=%u
|
||||
180 xQueueTakeMutexRecursive xMutex=%u xTicksToWait=%u
|
||||
181 xQueueGiveMutexRecursive pxMutex=%u
|
||||
52 vQueueAddToRegistry xQueue=%I pcName=%u
|
||||
182 vQueueUnregisterQueue xQueue=%I
|
||||
47 xQueueGenericCreate uxQueueLength=%u uxItemSize=%u ucQueueType=%u
|
||||
183 xQueueCreateSet uxEventQueueLength=%u
|
||||
184 xQueueAddToSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
185 xQueueRemoveFromSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
186 xQueueSelectFromSet xQueueSet=%u xTicksToWait=%u
|
||||
187 xQueueSelectFromSetFromISR xQueueSet=%u
|
||||
188 xQueueGenericReset xQueue=%I xNewQueue=%u
|
||||
189 vListInitialise pxList=%u
|
||||
190 vListInitialiseItem pxItem=%u
|
||||
191 vListInsert pxList=%u pxNewListItem=%u
|
||||
192 vListInsertEnd pxList=%u pxNewListItem=%u
|
||||
193 uxListRemove pxItemToRemove=%u
|
||||
194 xEventGroupCreate
|
||||
195 xEventGroupWaitBits xEventGroup=%u uxBitsToWaitFor=%u xClearOnExit=%u xWaitForAllBits=%u xTicksToWait=%u
|
||||
196 xEventGroupClearBits xEventGroup=%u uxBitsToClear=%u
|
||||
58 xEventGroupClearBitsFromISR xEventGroup=%u uxBitsToSet=%u
|
||||
197 xEventGroupSetBits xEventGroup=%u uxBitsToSet=%u
|
||||
59 xEventGroupSetBitsFromISR xEventGroup=%u uxBitsToSet=%u pxHigherPriorityTaskWoken=%u
|
||||
198 xEventGroupSync xEventGroup=%u uxBitsToSet=%u uxBitsToWaitFor=%u xTicksToWait=%u
|
||||
60 xEventGroupGetBitsFromISR xEventGroup=%u
|
||||
199 vEventGroupDelete xEventGroup=%u
|
||||
200 uxEventGroupGetNumber xEventGroup=%u
|
||||
128 vTaskAllocateMPURegions xTask=%t pxRegions=%u
|
||||
33 vTaskDelete xTaskToDelete=%t
|
||||
34 vTaskDelay xTicksToDelay=%u
|
||||
35 vTaskDelayUntil
|
||||
129 uxTaskPriorityGet xTask=%t
|
||||
56 uxTaskPriorityGetFromISR xTask=%t
|
||||
130 eTaskGetState xTask=%t
|
||||
55 vTaskPrioritySet xTask=%t uxNewPriority=%u
|
||||
36 vTaskSuspend xTaskToSuspend=%t
|
||||
40 vTaskResume xTaskToResume=%t
|
||||
43 xTaskResumeFromISR xTaskToResume=%t
|
||||
131 vTaskStartScheduler
|
||||
132 vTaskEndScheduler
|
||||
133 vTaskSuspendAll
|
||||
134 xTaskResumeAll
|
||||
135 xTaskGetTickCount
|
||||
57 xTaskGetTickCountFromISR
|
||||
136 uxTaskGetNumberOfTasks
|
||||
137 pcTaskGetTaskName xTaskToQuery=%t
|
||||
138 uxTaskGetStackHighWaterMark xTask=%t
|
||||
139 vTaskSetApplicationTaskTag xTask=%t pxHookFunction=%u
|
||||
140 xTaskGetApplicationTaskTag xTask=%t
|
||||
141 vTaskSetThreadLocalStoragePointer xTaskToSet=%T xIndex=%u pvValue=%u
|
||||
142 pvTaskGetThreadLocalStoragePointer xTaskToQuery=%T xIndex=%u
|
||||
143 xTaskCallApplicationTaskHook xTask=%T pvParameter=%u
|
||||
144 xTaskGetIdleTaskHandle
|
||||
145 uxTaskGetSystemState pxTaskStatusArray=%u uxArraySize=%u pulTotalRunTime=%u
|
||||
146 vTaskList pcWriteBuffer=%u
|
||||
147 vTaskGetRunTimeStats pcWriteBuffer=%u
|
||||
44 xTaskGenericNotify xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u
|
||||
45 xTaskGenericNotifyFromISR xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u pxHigherPriorityTaskWoken=%u
|
||||
46 xTaskNotifyWait ulBitsToClearOnEntry=%u ulBitsToClearOnExit=%u pulNotificationValue=%u xTicksToWait=%u
|
||||
38 vTaskNotifyGiveFromISR xTaskToNotify=%t pxHigherPriorityTaskWoken=%u
|
||||
37 ulTaskNotifyTake xClearCountOnExit=%u xTicksToWait=%u
|
||||
148 xTaskNotifyStateClear xTask=%t
|
||||
149 xTaskGetCurrentTaskHandle
|
||||
150 vTaskSetTimeOutState pxTimeOut=%u
|
||||
151 xTaskCheckForTimeOut pxTimeOut=%u pxTicksToWait=%u
|
||||
152 vTaskMissedYield
|
||||
153 xTaskGetSchedulerState
|
||||
39 vTaskPriorityInherit pxMutexHolder=%p
|
||||
42 xTaskPriorityDisinherit pxMutexHolder=%p
|
||||
154 xTaskGenericCreate pxTaskCode=%u pcName=%u usStackDepth=%u pvParameters=%u uxPriority=%u pxCreatedTask=%u puxStackBuffer=%u xRegions=%u
|
||||
155 uxTaskGetTaskNumber xTask=%u
|
||||
156 vTaskSetTaskNumber xTask=%u uxHandle=%u
|
||||
41 vTaskStepTick xTicksToJump=%u
|
||||
157 eTaskConfirmSleepModeStatus
|
||||
158 xTimerCreate pcTimerName=%u xTimerPeriodInTicks=%u uxAutoReload=%u pvTimerID=%u pxCallbackFunction=%u
|
||||
159 pvTimerGetTimerID xTimer=%u
|
||||
160 vTimerSetTimerID xTimer=%u pvNewID=%u
|
||||
161 xTimerIsTimerActive xTimer=%u
|
||||
162 xTimerGetTimerDaemonTaskHandle
|
||||
163 xTimerPendFunctionCallFromISR xFunctionToPend=%u pvParameter1=%u ulParameter2=%u pxHigherPriorityTaskWoken=%u
|
||||
164 xTimerPendFunctionCall xFunctionToPend=%u pvParameter1=%u ulParameter2=%u xTicksToWait=%u
|
||||
165 pcTimerGetTimerName xTimer=%u
|
||||
166 xTimerCreateTimerTask
|
||||
167 xTimerGenericCommand xTimer=%u xCommandID=%u xOptionalValue=%u pxHigherPriorityTaskWoken=%u xTicksToWait=%u
|
||||
53 xQueueGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
50 xQueuePeekFromISR xQueue=%I pvBuffer=%p
|
||||
49 xQueueGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeek=%u
|
||||
168 uxQueueMessagesWaiting xQueue=%I
|
||||
169 uxQueueSpacesAvailable xQueue=%I
|
||||
48 vQueueDelete xQueue=%I
|
||||
54 xQueueGenericSendFromISR xQueue=%I pvItemToQueue=%p pxHigherPriorityTaskWoken=%u xCopyPosition=%u
|
||||
61 xQueueGiveFromISR xQueue=%I pxHigherPriorityTaskWoken=%u
|
||||
51 xQueueReceiveFromISR xQueue=%I pvBuffer=%p pxHigherPriorityTaskWoken=%u
|
||||
62 xQueueIsQueueEmptyFromISR xQueue=%I
|
||||
63 xQueueIsQueueFullFromISR xQueue=%I
|
||||
170 uxQueueMessagesWaitingFromISR xQueue=%I
|
||||
171 xQueueAltGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
172 xQueueAltGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeeking=%u
|
||||
173 xQueueCRSendFromISR xQueue=%I pvItemToQueue=%p xCoRoutinePreviouslyWoken=%u
|
||||
174 xQueueCRReceiveFromISR xQueue=%I pvBuffer=%p pxTaskWoken=%u
|
||||
175 xQueueCRSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u
|
||||
176 xQueueCRReceive xQueue=%I pvBuffer=%p xTicksToWait=%u
|
||||
177 xQueueCreateMutex ucQueueType=%u
|
||||
178 xQueueCreateCountingSemaphore uxMaxCount=%u uxInitialCount=%u
|
||||
179 xQueueGetMutexHolder xSemaphore=%u
|
||||
180 xQueueTakeMutexRecursive xMutex=%u xTicksToWait=%u
|
||||
181 xQueueGiveMutexRecursive pxMutex=%u
|
||||
52 vQueueAddToRegistry xQueue=%I pcName=%u
|
||||
182 vQueueUnregisterQueue xQueue=%I
|
||||
47 xQueueGenericCreate uxQueueLength=%u uxItemSize=%u ucQueueType=%u
|
||||
183 xQueueCreateSet uxEventQueueLength=%u
|
||||
184 xQueueAddToSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
185 xQueueRemoveFromSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
186 xQueueSelectFromSet xQueueSet=%u xTicksToWait=%u
|
||||
187 xQueueSelectFromSetFromISR xQueueSet=%u
|
||||
188 xQueueGenericReset xQueue=%I xNewQueue=%u
|
||||
189 vListInitialise pxList=%u
|
||||
190 vListInitialiseItem pxItem=%u
|
||||
191 vListInsert pxList=%u pxNewListItem=%u
|
||||
192 vListInsertEnd pxList=%u pxNewListItem=%u
|
||||
193 uxListRemove pxItemToRemove=%u
|
||||
194 xEventGroupCreate
|
||||
195 xEventGroupWaitBits xEventGroup=%u uxBitsToWaitFor=%u xClearOnExit=%u xWaitForAllBits=%u xTicksToWait=%u
|
||||
196 xEventGroupClearBits xEventGroup=%u uxBitsToClear=%u
|
||||
58 xEventGroupClearBitsFromISR xEventGroup=%u uxBitsToSet=%u
|
||||
197 xEventGroupSetBits xEventGroup=%u uxBitsToSet=%u
|
||||
59 xEventGroupSetBitsFromISR xEventGroup=%u uxBitsToSet=%u pxHigherPriorityTaskWoken=%u
|
||||
198 xEventGroupSync xEventGroup=%u uxBitsToSet=%u uxBitsToWaitFor=%u xTicksToWait=%u
|
||||
60 xEventGroupGetBitsFromISR xEventGroup=%u
|
||||
199 vEventGroupDelete xEventGroup=%u
|
||||
200 uxEventGroupGetNumber xEventGroup=%u
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,153 +1,153 @@
|
||||
SD Pullup Requirements
|
||||
======================
|
||||
|
||||
CMD and DATA lines D0-D3 of the slave should be pulled up by 50KOhm resistor
|
||||
even in 1-bit mode or SPI mode. The pullups of the slave cards should be
|
||||
connected even if they're not connected to the host.
|
||||
|
||||
The MTDI strapping pin is incompatible with DAT2 line pull-up by default
|
||||
when the code flash is 3.3V. See :ref:`mtdi_strapping_pin` below.
|
||||
|
||||
Pullup inside Official Modules
|
||||
------------------------------
|
||||
|
||||
For Espressif official modules, different weak pullups / pulldowns are
|
||||
connected to CMD, and DATA pins as below. To use these modules,
|
||||
these pins are required to be pulled up by 50KOhm resistors, since internal
|
||||
weak pullups are insufficient.
|
||||
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
| GPIO | 15 | 2 | 4 | 12 | 13 |
|
||||
+=======================+=====+==========================+======+======================+======+
|
||||
| Name | CMD | DAT0 | DAT1 | DAT2 | DAT3 |
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
| At startup | WPU | WPD | WPD | PU for 1.8v flash; | WPU |
|
||||
| | | | | WPD for 3.3v flash | |
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
| Strapping requirement | | Low to download to flash | | High for 1.8v flash; | |
|
||||
| | | | | Low for 3.3v flash | |
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
|
||||
- WPU: Weak pullup
|
||||
- WPD: Weak pulldown
|
||||
- PU: Pullup inside the module
|
||||
|
||||
For Wrover modules, they use 1.8v flash, and have pullup on GPIO12 inside.
|
||||
For Wroom-32 Series, PICO-D4 modules, they use 3.3v flash, and is weakly
|
||||
pulled down internally. See :ref:`mtdi_strapping_pin` below.
|
||||
|
||||
Pullup on Official Devkit (WroverKit)
|
||||
--------------------------------------
|
||||
|
||||
For official Wrover Kit (till version 3), some of the pullups are provided on
|
||||
the board as the table below. For other devkits that don't have pullups,
|
||||
please connect them yourselves.
|
||||
|
||||
+-----------------------+-----+------+------+------+---------+
|
||||
| GPIO | 15 | 2 | 4 | 12 | 13 |
|
||||
+=======================+=====+======+======+======+=========+
|
||||
| Name | CMD | DAT0 | DAT1 | DAT2 | DAT3 |
|
||||
+-----------------------+-----+------+------+------+---------+
|
||||
| Pullup on the Kit | PU | PU | PU | | PU & PD |
|
||||
+-----------------------+-----+------+------+------+---------+
|
||||
|
||||
- PU: Pullup
|
||||
- PD: Pulldown
|
||||
|
||||
The DAT3 pullup conflicts with JTAG pulldown in WroverKit v3 and earlier, please
|
||||
either:
|
||||
|
||||
1. pull it up by resistor less than 5KOhm (2kOhm suggested) in 4-bit mode.
|
||||
2. pull it up or drive it high by host or VDD3.3V in 1-bit mode.
|
||||
|
||||
.. _mtdi_strapping_pin:
|
||||
|
||||
MTDI strapping pin
|
||||
------------------
|
||||
|
||||
MTDI (GPIO12) is used as a bootstrapping pin to select output voltage of an
|
||||
internal regulator which powers the flash chip (VDD_SDIO). This pin has an
|
||||
internal pulldown so if left unconnected it will read low at reset (selecting
|
||||
default 3.3V operation). When adding a pullup to this pin for SD card
|
||||
operation, consider the following:
|
||||
|
||||
- For boards which don't use the internal regulator (VDD_SDIO) to power the
|
||||
flash, GPIO12 can be pulled high.
|
||||
- For boards which use 1.8V flash chip, GPIO12 needs to be pulled high at
|
||||
reset. This is fully compatible with SD card operation.
|
||||
- On boards which use the internal regulator and a 3.3V flash chip, GPIO12
|
||||
must be low at reset. This is incompatible with SD card operation. Please
|
||||
check the table below to see whether your modules/kits use 3.3v flash.
|
||||
|
||||
+-----------------+---------------+--------------------------------------+
|
||||
| Module | Flash voltage | DAT2 connections |
|
||||
+=================+===============+======================================+
|
||||
| PICO-D4 | 3.3V | Internal PD, change EFUSE and pullup |
|
||||
+-----------------+ + or disable DAT2 line* +
|
||||
| Wroom-32 Series | | |
|
||||
+-----------------+---------------+--------------------------------------+
|
||||
| Wrover | 1.8V | Internal PU, pullup suggested |
|
||||
+-----------------+---------------+--------------------------------------+
|
||||
|
||||
Official devkits of different types and version mount different types of
|
||||
modules, please refer to the table below to see whether your devkit can
|
||||
support SDIO slave without steps above.
|
||||
|
||||
+--------------------------+-----------------+---------------+
|
||||
| Devkit | Module | Flash voltage |
|
||||
+==========================+=================+===============+
|
||||
| PICO Kit | PICO-D4 | 3.3V |
|
||||
+--------------------------+-----------------+ (see steps +
|
||||
| DevKitC | Wroom-32 Series | below) |
|
||||
+--------------------------+ + +
|
||||
| WroverKit v2 and earlier | | |
|
||||
+--------------------------+-----------------+---------------+
|
||||
| WroverKit v3 | Wrover | 1.8V |
|
||||
+--------------------------+-----------------+---------------+
|
||||
|
||||
If your board requires internal regulator with 3.3v output, to make it
|
||||
compatible with SD pullup, you can either:
|
||||
|
||||
- **In the case using ESP32 host only**, external pullup can be omitted and an
|
||||
internal pullup can be enabled using a ``gpio_pullup_en(GPIO_NUM_12);`` call.
|
||||
Most SD cards work fine when an internal pullup on GPIO12 line is enabled.
|
||||
Note that if ESP32 experiences a power-on reset while the SD card is
|
||||
sending data, high level on GPIO12 can be latched into the bootstrapping
|
||||
register, and ESP32 will enter a boot loop until external reset with
|
||||
correct GPIO12 level is applied.
|
||||
- **In the case using ESP32 slave in 1-bit mode**, speicfy
|
||||
``SDIO_SLAVE_FLAG_DAT2_DISABLED`` in the slave to avoid slave detecting on
|
||||
DAT2 line. Note the host will not know 4-bit mode is not supported any more
|
||||
by the standard CCCR register. You have to tell the host use 1-bit only.
|
||||
- **For ESP32 host or slave**, another option is to burn the flash voltage
|
||||
selection efuses. This will permanently select 3.3V output voltage for the
|
||||
internal regulator, and GPIO12 will not be used as a bootstrapping pin.
|
||||
Then it is safe to connect a pullup resistor to GPIO12. This option is
|
||||
suggested for production use. NOTE this cannot be reverted once the EFUSE
|
||||
is burnt.
|
||||
|
||||
The following command can be used to program flash voltage selection efuses **to 3.3V**:
|
||||
|
||||
components/esptool_py/esptool/espefuse.py set_flash_voltage 3.3V
|
||||
|
||||
This command will burn the `XPD_SDIO_TIEH`, `XPD_SDIO_FORCE`, and
|
||||
`XPD_SDIO_REG` efuses. With all three burned to value 1, the internal
|
||||
VDD_SDIO flash voltage regulator is permanently enabled at 3.3V. See
|
||||
the technical reference manual for more details.
|
||||
|
||||
`espefuse.py` has a `--do-not-confirm` option if running from an automated flashing script.
|
||||
|
||||
GPIO2 Strapping pin
|
||||
-------------------
|
||||
|
||||
GPIO2 pin is used as a bootstrapping pin, and should be low to enter UART
|
||||
download mode. You may find it unable to enter the UART download mode if you
|
||||
correctly connect the pullup of SD on GPIO2. For WroverKit v3, there are
|
||||
dedicated circuits to pulldown the GPIO2 when downloading. For other boards,
|
||||
one way to do this is to connect GPIO0 and GPIO2 using a jumper, and then the
|
||||
auto-reset circuit on most development boards will pull GPIO2 low along with
|
||||
GPIO0, when entering download mode.
|
||||
|
||||
- Some boards have pulldown and/or LED on GPIO2. LED is usually ok, but
|
||||
pulldown will interfere with D0 signals and must be removed. Check the
|
||||
schematic of your development board for anything connected to GPIO2.
|
||||
SD Pullup Requirements
|
||||
======================
|
||||
|
||||
CMD and DATA lines D0-D3 of the slave should be pulled up by 50KOhm resistor
|
||||
even in 1-bit mode or SPI mode. The pullups of the slave cards should be
|
||||
connected even if they're not connected to the host.
|
||||
|
||||
The MTDI strapping pin is incompatible with DAT2 line pull-up by default
|
||||
when the code flash is 3.3V. See :ref:`mtdi_strapping_pin` below.
|
||||
|
||||
Pullup inside Official Modules
|
||||
------------------------------
|
||||
|
||||
For Espressif official modules, different weak pullups / pulldowns are
|
||||
connected to CMD, and DATA pins as below. To use these modules,
|
||||
these pins are required to be pulled up by 50KOhm resistors, since internal
|
||||
weak pullups are insufficient.
|
||||
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
| GPIO | 15 | 2 | 4 | 12 | 13 |
|
||||
+=======================+=====+==========================+======+======================+======+
|
||||
| Name | CMD | DAT0 | DAT1 | DAT2 | DAT3 |
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
| At startup | WPU | WPD | WPD | PU for 1.8v flash; | WPU |
|
||||
| | | | | WPD for 3.3v flash | |
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
| Strapping requirement | | Low to download to flash | | High for 1.8v flash; | |
|
||||
| | | | | Low for 3.3v flash | |
|
||||
+-----------------------+-----+--------------------------+------+----------------------+------+
|
||||
|
||||
- WPU: Weak pullup
|
||||
- WPD: Weak pulldown
|
||||
- PU: Pullup inside the module
|
||||
|
||||
For Wrover modules, they use 1.8v flash, and have pullup on GPIO12 inside.
|
||||
For Wroom-32 Series, PICO-D4 modules, they use 3.3v flash, and is weakly
|
||||
pulled down internally. See :ref:`mtdi_strapping_pin` below.
|
||||
|
||||
Pullup on Official Devkit (WroverKit)
|
||||
--------------------------------------
|
||||
|
||||
For official Wrover Kit (till version 3), some of the pullups are provided on
|
||||
the board as the table below. For other devkits that don't have pullups,
|
||||
please connect them yourselves.
|
||||
|
||||
+-----------------------+-----+------+------+------+---------+
|
||||
| GPIO | 15 | 2 | 4 | 12 | 13 |
|
||||
+=======================+=====+======+======+======+=========+
|
||||
| Name | CMD | DAT0 | DAT1 | DAT2 | DAT3 |
|
||||
+-----------------------+-----+------+------+------+---------+
|
||||
| Pullup on the Kit | PU | PU | PU | | PU & PD |
|
||||
+-----------------------+-----+------+------+------+---------+
|
||||
|
||||
- PU: Pullup
|
||||
- PD: Pulldown
|
||||
|
||||
The DAT3 pullup conflicts with JTAG pulldown in WroverKit v3 and earlier, please
|
||||
either:
|
||||
|
||||
1. pull it up by resistor less than 5KOhm (2kOhm suggested) in 4-bit mode.
|
||||
2. pull it up or drive it high by host or VDD3.3V in 1-bit mode.
|
||||
|
||||
.. _mtdi_strapping_pin:
|
||||
|
||||
MTDI strapping pin
|
||||
------------------
|
||||
|
||||
MTDI (GPIO12) is used as a bootstrapping pin to select output voltage of an
|
||||
internal regulator which powers the flash chip (VDD_SDIO). This pin has an
|
||||
internal pulldown so if left unconnected it will read low at reset (selecting
|
||||
default 3.3V operation). When adding a pullup to this pin for SD card
|
||||
operation, consider the following:
|
||||
|
||||
- For boards which don't use the internal regulator (VDD_SDIO) to power the
|
||||
flash, GPIO12 can be pulled high.
|
||||
- For boards which use 1.8V flash chip, GPIO12 needs to be pulled high at
|
||||
reset. This is fully compatible with SD card operation.
|
||||
- On boards which use the internal regulator and a 3.3V flash chip, GPIO12
|
||||
must be low at reset. This is incompatible with SD card operation. Please
|
||||
check the table below to see whether your modules/kits use 3.3v flash.
|
||||
|
||||
+-----------------+---------------+--------------------------------------+
|
||||
| Module | Flash voltage | DAT2 connections |
|
||||
+=================+===============+======================================+
|
||||
| PICO-D4 | 3.3V | Internal PD, change EFUSE and pullup |
|
||||
+-----------------+ + or disable DAT2 line* +
|
||||
| Wroom-32 Series | | |
|
||||
+-----------------+---------------+--------------------------------------+
|
||||
| Wrover | 1.8V | Internal PU, pullup suggested |
|
||||
+-----------------+---------------+--------------------------------------+
|
||||
|
||||
Official devkits of different types and version mount different types of
|
||||
modules, please refer to the table below to see whether your devkit can
|
||||
support SDIO slave without steps above.
|
||||
|
||||
+--------------------------+-----------------+---------------+
|
||||
| Devkit | Module | Flash voltage |
|
||||
+==========================+=================+===============+
|
||||
| PICO Kit | PICO-D4 | 3.3V |
|
||||
+--------------------------+-----------------+ (see steps +
|
||||
| DevKitC | Wroom-32 Series | below) |
|
||||
+--------------------------+ + +
|
||||
| WroverKit v2 and earlier | | |
|
||||
+--------------------------+-----------------+---------------+
|
||||
| WroverKit v3 | Wrover | 1.8V |
|
||||
+--------------------------+-----------------+---------------+
|
||||
|
||||
If your board requires internal regulator with 3.3v output, to make it
|
||||
compatible with SD pullup, you can either:
|
||||
|
||||
- **In the case using ESP32 host only**, external pullup can be omitted and an
|
||||
internal pullup can be enabled using a ``gpio_pullup_en(GPIO_NUM_12);`` call.
|
||||
Most SD cards work fine when an internal pullup on GPIO12 line is enabled.
|
||||
Note that if ESP32 experiences a power-on reset while the SD card is
|
||||
sending data, high level on GPIO12 can be latched into the bootstrapping
|
||||
register, and ESP32 will enter a boot loop until external reset with
|
||||
correct GPIO12 level is applied.
|
||||
- **In the case using ESP32 slave in 1-bit mode**, speicfy
|
||||
``SDIO_SLAVE_FLAG_DAT2_DISABLED`` in the slave to avoid slave detecting on
|
||||
DAT2 line. Note the host will not know 4-bit mode is not supported any more
|
||||
by the standard CCCR register. You have to tell the host use 1-bit only.
|
||||
- **For ESP32 host or slave**, another option is to burn the flash voltage
|
||||
selection efuses. This will permanently select 3.3V output voltage for the
|
||||
internal regulator, and GPIO12 will not be used as a bootstrapping pin.
|
||||
Then it is safe to connect a pullup resistor to GPIO12. This option is
|
||||
suggested for production use. NOTE this cannot be reverted once the EFUSE
|
||||
is burnt.
|
||||
|
||||
The following command can be used to program flash voltage selection efuses **to 3.3V**:
|
||||
|
||||
components/esptool_py/esptool/espefuse.py set_flash_voltage 3.3V
|
||||
|
||||
This command will burn the `XPD_SDIO_TIEH`, `XPD_SDIO_FORCE`, and
|
||||
`XPD_SDIO_REG` efuses. With all three burned to value 1, the internal
|
||||
VDD_SDIO flash voltage regulator is permanently enabled at 3.3V. See
|
||||
the technical reference manual for more details.
|
||||
|
||||
`espefuse.py` has a `--do-not-confirm` option if running from an automated flashing script.
|
||||
|
||||
GPIO2 Strapping pin
|
||||
-------------------
|
||||
|
||||
GPIO2 pin is used as a bootstrapping pin, and should be low to enter UART
|
||||
download mode. You may find it unable to enter the UART download mode if you
|
||||
correctly connect the pullup of SD on GPIO2. For WroverKit v3, there are
|
||||
dedicated circuits to pulldown the GPIO2 when downloading. For other boards,
|
||||
one way to do this is to connect GPIO0 and GPIO2 using a jumper, and then the
|
||||
auto-reset circuit on most development boards will pull GPIO2 low along with
|
||||
GPIO0, when entering download mode.
|
||||
|
||||
- Some boards have pulldown and/or LED on GPIO2. LED is usually ok, but
|
||||
pulldown will interfere with D0 signals and must be removed. Check the
|
||||
schematic of your development board for anything connected to GPIO2.
|
||||
|
||||
@@ -1,53 +1,53 @@
|
||||
SPIFFS Filesystem
|
||||
=================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
SPIFFS is a file system intended for SPI NOR flash devices on embedded targets.
|
||||
It supports wear leveling, file system consistency checks and more.
|
||||
|
||||
Notes
|
||||
-----
|
||||
|
||||
- Presently, spiffs does not support directories. It produces a flat structure. If SPIFFS is mounted under ``/spiffs`` creating a file with path ``/spiffs/tmp/myfile.txt`` will create a file called ``/tmp/myfile.txt`` in SPIFFS, instead of ``myfile.txt`` under directory ``/spiffs/tmp``.
|
||||
- It is not a realtime stack. One write operation might last much longer than another.
|
||||
- Presently, it does not detect or handle bad blocks.
|
||||
|
||||
Tools
|
||||
-----
|
||||
|
||||
Host-Side tools for creating SPIFS partition images exist and one such tool is `mkspiffs <https://github.com/igrr/mkspiffs>`_.
|
||||
You can use it to create image from a given folder and then flash that image with ``esptool.py``
|
||||
|
||||
To do that you need to obtain some parameters:
|
||||
|
||||
- Block Size: 4096 (standard for SPI Flash)
|
||||
- Page Size: 256 (standard for SPI Flash)
|
||||
- Image Size: Size of the partition in bytes (can be obtained from partition table)
|
||||
- Partition Offset: Starting address of the partition (can be obtained from partition table)
|
||||
|
||||
To pack a folder into 1 Megabyte image::
|
||||
|
||||
mkspiffs -c [src_folder] -b 4096 -p 256 -s 0x100000 spiffs.bin
|
||||
|
||||
To flash the image to ESP32 at offset 0x110000::
|
||||
|
||||
python esptool.py --chip esp32 --port [port] --baud [baud] write_flash -z 0x110000 spiffs.bin
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
- :doc:`Partition Table documentation <../../api-guides/partition-tables>`
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
An example for using SPIFFS is provided in :example:`storage/spiffs` directory. This example initializes and mounts SPIFFS partition, and writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information.
|
||||
|
||||
High level API Reference
|
||||
------------------------
|
||||
|
||||
* :component_file:`spiffs/include/esp_spiffs.h`
|
||||
|
||||
.. include:: /_build/inc/esp_spiffs.inc
|
||||
SPIFFS Filesystem
|
||||
=================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
SPIFFS is a file system intended for SPI NOR flash devices on embedded targets.
|
||||
It supports wear leveling, file system consistency checks and more.
|
||||
|
||||
Notes
|
||||
-----
|
||||
|
||||
- Presently, spiffs does not support directories. It produces a flat structure. If SPIFFS is mounted under ``/spiffs`` creating a file with path ``/spiffs/tmp/myfile.txt`` will create a file called ``/tmp/myfile.txt`` in SPIFFS, instead of ``myfile.txt`` under directory ``/spiffs/tmp``.
|
||||
- It is not a realtime stack. One write operation might last much longer than another.
|
||||
- Presently, it does not detect or handle bad blocks.
|
||||
|
||||
Tools
|
||||
-----
|
||||
|
||||
Host-Side tools for creating SPIFS partition images exist and one such tool is `mkspiffs <https://github.com/igrr/mkspiffs>`_.
|
||||
You can use it to create image from a given folder and then flash that image with ``esptool.py``
|
||||
|
||||
To do that you need to obtain some parameters:
|
||||
|
||||
- Block Size: 4096 (standard for SPI Flash)
|
||||
- Page Size: 256 (standard for SPI Flash)
|
||||
- Image Size: Size of the partition in bytes (can be obtained from partition table)
|
||||
- Partition Offset: Starting address of the partition (can be obtained from partition table)
|
||||
|
||||
To pack a folder into 1 Megabyte image::
|
||||
|
||||
mkspiffs -c [src_folder] -b 4096 -p 256 -s 0x100000 spiffs.bin
|
||||
|
||||
To flash the image to ESP32 at offset 0x110000::
|
||||
|
||||
python esptool.py --chip esp32 --port [port] --baud [baud] write_flash -z 0x110000 spiffs.bin
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
- :doc:`Partition Table documentation <../../api-guides/partition-tables>`
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
An example for using SPIFFS is provided in :example:`storage/spiffs` directory. This example initializes and mounts SPIFFS partition, and writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information.
|
||||
|
||||
High level API Reference
|
||||
------------------------
|
||||
|
||||
* :component_file:`spiffs/include/esp_spiffs.h`
|
||||
|
||||
.. include:: /_build/inc/esp_spiffs.inc
|
||||
|
||||
@@ -1,34 +1,34 @@
|
||||
.. include:: ../../../../components/wear_levelling/README.rst
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
- :doc:`FAT Filesystem <./fatfs>`
|
||||
- :doc:`Partition Table documentation <../../api-guides/partition-tables>`
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
An example which combines wear levelling driver with FATFS library is provided in ``examples/storage/wear_levelling`` directory. This example initializes the wear levelling driver, mounts FATFS partition, and writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information.
|
||||
|
||||
High level API Reference
|
||||
------------------------
|
||||
|
||||
Header Files
|
||||
^^^^^^^^^^^^
|
||||
|
||||
* :component_file:`fatfs/src/esp_vfs_fat.h`
|
||||
|
||||
Functions
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfunction:: esp_vfs_fat_spiflash_mount
|
||||
.. doxygenstruct:: esp_vfs_fat_mount_config_t
|
||||
:members:
|
||||
.. doxygenfunction:: esp_vfs_fat_spiflash_unmount
|
||||
|
||||
Mid level API Reference
|
||||
-----------------------
|
||||
|
||||
.. include:: /_build/inc/wear_levelling.inc
|
||||
|
||||
.. include:: ../../../../components/wear_levelling/README.rst
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
- :doc:`FAT Filesystem <./fatfs>`
|
||||
- :doc:`Partition Table documentation <../../api-guides/partition-tables>`
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
An example which combines wear levelling driver with FATFS library is provided in ``examples/storage/wear_levelling`` directory. This example initializes the wear levelling driver, mounts FATFS partition, and writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information.
|
||||
|
||||
High level API Reference
|
||||
------------------------
|
||||
|
||||
Header Files
|
||||
^^^^^^^^^^^^
|
||||
|
||||
* :component_file:`fatfs/src/esp_vfs_fat.h`
|
||||
|
||||
Functions
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfunction:: esp_vfs_fat_spiflash_mount
|
||||
.. doxygenstruct:: esp_vfs_fat_mount_config_t
|
||||
:members:
|
||||
.. doxygenfunction:: esp_vfs_fat_spiflash_unmount
|
||||
|
||||
Mid level API Reference
|
||||
-----------------------
|
||||
|
||||
.. include:: /_build/inc/wear_levelling.inc
|
||||
|
||||
|
||||
@@ -1,79 +1,79 @@
|
||||
ESP32-DevKitC V2 Getting Started Guide
|
||||
======================================
|
||||
|
||||
This user guide shows how to get started with ESP32-DevKitC development board.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-DevKitC V2 board <get-started-esp32-devkitc-v2-board-front>`
|
||||
* 1 × USB A / micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-DevKitC is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC board.
|
||||
|
||||
ESP-WROOM-32
|
||||
Standard `ESP-WROOM-32 <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP-WROOM-32.
|
||||
I/O
|
||||
Most of the pins on the ESP-WROOM-32 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
|
||||
.. _get-started-esp32-devkitc-v2-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png
|
||||
:align: center
|
||||
:alt: ESP32-DevKitC V2 board layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitC V2 board layout
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to this board:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
3. 3V3 / GND header pins
|
||||
|
||||
.. warning::
|
||||
|
||||
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
|
||||
|
||||
|
||||
Start Application Development
|
||||
------------------------------
|
||||
|
||||
Before powering up the ESP32-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
ESP32-DevKitC V2 Getting Started Guide
|
||||
======================================
|
||||
|
||||
This user guide shows how to get started with ESP32-DevKitC development board.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-DevKitC V2 board <get-started-esp32-devkitc-v2-board-front>`
|
||||
* 1 × USB A / micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-DevKitC is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC board.
|
||||
|
||||
ESP-WROOM-32
|
||||
Standard `ESP-WROOM-32 <https://www.espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ module soldered to the ESP32-DevKitC board.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP-WROOM-32.
|
||||
I/O
|
||||
Most of the pins on the ESP-WROOM-32 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
|
||||
.. _get-started-esp32-devkitc-v2-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-v2-functional-overview.png
|
||||
:align: center
|
||||
:alt: ESP32-DevKitC V2 board layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitC V2 board layout
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to this board:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
3. 3V3 / GND header pins
|
||||
|
||||
.. warning::
|
||||
|
||||
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
|
||||
|
||||
|
||||
Start Application Development
|
||||
------------------------------
|
||||
|
||||
Before powering up the ESP32-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-DevKitC schematic <https://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
|
||||
@@ -1,126 +1,126 @@
|
||||
ESP32-DevKitC V4 Getting Started Guide
|
||||
======================================
|
||||
|
||||
This user guide shows how to get started with ESP32-DevKitC V4 development board. For description of other versions of the ESP32-DevKitC check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-DevKitC V4 board <get-started-esp32-devkitc-board-front>`
|
||||
* 1 × USB A / micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
|
||||
|
||||
The board supports various ESP32 modules, including :ref:`esp-modules-and-boards-esp32-wroom-32`, :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`, :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>` and :ref:`esp-modules-and-boards-esp32-solo-1`.
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC V4 board.
|
||||
|
||||
ESP32-WROOM-32
|
||||
:ref:`esp-modules-and-boards-esp32-wroom-32` module soldered to the ESP32-DevKitC V4 board. Optionally ESP32-WROOM-32D, ESP32-WROOM-32U or ESP32-SOLO-1 module may be soldered instead of the ESP32-WROOM-32.
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 3 Mbps transfers rates.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
Micro USB Port
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and the ESP module.
|
||||
5V Power On LED
|
||||
This LED lights when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
I/O
|
||||
Most of the pins on the ESP module are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
|
||||
.. note::
|
||||
|
||||
Some of broken out pins are used internally by the ESP32-WROOM-32, ESP32-WROOM-32D/U and ESP32-SOLO-1 modules to communicate with SPI memory. They are grouped on one side of the board besides the USB connector and labeled CLK, D0, D1, D2, D3 and CMD (GPIO6 - GPIO11). In general these pins should be left unconnected, otherwise access to the SPI flash memory / SPI RAM may be disturbed.
|
||||
|
||||
.. _get-started-esp32-devkitc-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
|
||||
:align: center
|
||||
:alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to this board:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
3. 3V3 / GND header pins
|
||||
|
||||
.. warning::
|
||||
|
||||
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
|
||||
|
||||
|
||||
Note on C15
|
||||
-----------
|
||||
|
||||
The C15, on the board of earlier batches of V4, may bring two issues:
|
||||
|
||||
1. The board may boot into download mode;
|
||||
2. If users output clock on GPIO0, C15 may impact the clock output.
|
||||
|
||||
As a result, if users believe that C15 will impact their use of the board, they can remove it completely (please refer to the screenshot below for the precise location of C15 that is colored in yellow). Otherwise, users do not need to concern about C15.
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-c15-location.png
|
||||
:align: center
|
||||
:alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board
|
||||
:figclass: align-center
|
||||
:width: 30%
|
||||
|
||||
Location of C15 (colored yellow) on ESP32-DevKitC V4 board
|
||||
|
||||
|
||||
Start Application Development
|
||||
------------------------------
|
||||
|
||||
Before powering up the ESP32-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Board Dimensions
|
||||
----------------
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
|
||||
:align: center
|
||||
:alt: ESP32 DevKitC board dimensions - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP32 DevKitC board dimensions - back
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-DevKitC V4 schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32D/U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf>`_ (PDF)
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
ESP32-DevKitC V4 Getting Started Guide
|
||||
======================================
|
||||
|
||||
This user guide shows how to get started with ESP32-DevKitC V4 development board. For description of other versions of the ESP32-DevKitC check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-DevKitC V4 board <get-started-esp32-devkitc-board-front>`
|
||||
* 1 × USB A / micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-DevKitC V4 is a small-sized ESP32-based development board produced by `Espressif <https://espressif.com>`_. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can connect these pins to peripherals as needed. Standard headers also make development easy and convenient when using a breadboard.
|
||||
|
||||
The board supports various ESP32 modules, including :ref:`esp-modules-and-boards-esp32-wroom-32`, :ref:`ESP32-WROOM-32U <esp-modules-and-boards-esp32-wroom-32d-and-u>`, :ref:`ESP32-WROOM-32D <esp-modules-and-boards-esp32-wroom-32d-and-u>` and :ref:`esp-modules-and-boards-esp32-solo-1`.
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-DevKitC V4 board.
|
||||
|
||||
ESP32-WROOM-32
|
||||
:ref:`esp-modules-and-boards-esp32-wroom-32` module soldered to the ESP32-DevKitC V4 board. Optionally ESP32-WROOM-32D, ESP32-WROOM-32U or ESP32-SOLO-1 module may be soldered instead of the ESP32-WROOM-32.
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 3 Mbps transfers rates.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
Micro USB Port
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and the ESP module.
|
||||
5V Power On LED
|
||||
This LED lights when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
I/O
|
||||
Most of the pins on the ESP module are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
|
||||
.. note::
|
||||
|
||||
Some of broken out pins are used internally by the ESP32-WROOM-32, ESP32-WROOM-32D/U and ESP32-SOLO-1 modules to communicate with SPI memory. They are grouped on one side of the board besides the USB connector and labeled CLK, D0, D1, D2, D3 and CMD (GPIO6 - GPIO11). In general these pins should be left unconnected, otherwise access to the SPI flash memory / SPI RAM may be disturbed.
|
||||
|
||||
.. _get-started-esp32-devkitc-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-functional-overview.jpg
|
||||
:align: center
|
||||
:alt: ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-DevKitC V4 with ESP32-WROOM-32 module soldered
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to this board:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
3. 3V3 / GND header pins
|
||||
|
||||
.. warning::
|
||||
|
||||
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
|
||||
|
||||
|
||||
Note on C15
|
||||
-----------
|
||||
|
||||
The C15, on the board of earlier batches of V4, may bring two issues:
|
||||
|
||||
1. The board may boot into download mode;
|
||||
2. If users output clock on GPIO0, C15 may impact the clock output.
|
||||
|
||||
As a result, if users believe that C15 will impact their use of the board, they can remove it completely (please refer to the screenshot below for the precise location of C15 that is colored in yellow). Otherwise, users do not need to concern about C15.
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-c15-location.png
|
||||
:align: center
|
||||
:alt: Location of C15 (colored yellow) on ESP32-DevKitC V4 board
|
||||
:figclass: align-center
|
||||
:width: 30%
|
||||
|
||||
Location of C15 (colored yellow) on ESP32-DevKitC V4 board
|
||||
|
||||
|
||||
Start Application Development
|
||||
------------------------------
|
||||
|
||||
Before powering up the ESP32-DevKitC, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Board Dimensions
|
||||
----------------
|
||||
|
||||
.. figure:: ../../_static/esp32-devkitc-dimensions-back.jpg
|
||||
:align: center
|
||||
:alt: ESP32 DevKitC board dimensions - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP32 DevKitC board dimensions - back
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-DevKitC V4 schematic <https://dl.espressif.com/dl/schematics/esp32_devkitc_v4-sch-20180607a.pdf>`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32D/U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf>`_ (PDF)
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-devkitc-v2
|
||||
@@ -1,66 +1,66 @@
|
||||
ESP32-PICO-KIT V3 Getting Started Guide
|
||||
=======================================
|
||||
|
||||
This user guide shows how to get started with the ESP32-PICO-KIT V3 mini development board. For description of other versions of the ESP32-PICO-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × ESP32-PICO-KIT V3 mini development board
|
||||
* 1 × USB A / Micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-PICO-KIT V3 is a mini development board based on the ESP32-PICO-D4 SIP module produced by `Espressif <https://espressif.com>`_. All the IO signals and system power on ESP32-PICO-D4 are led out through two standard 20 pin x 0.1" pitch headers on both sides for easy interfacing. The development board integrates a USB-UART Bridge circuit, allowing the developers to connect the development board to a PC's USB port for downloads and debugging.
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-PICO-KIT V3 board.
|
||||
|
||||
ESP32-PICO-D4
|
||||
Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT V3 board. The complete system of the ESP32 chip has been integrated into the SIP module, requiring only external antenna with LC matching network, decoupling capacitors and pull-up resistors for EN signals to function properly.
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 1 Mbps transfers rates.
|
||||
I/O
|
||||
All the pins on ESP32-PICO-D4 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
Micro USB Port
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32-PICO-KIT V3.
|
||||
EN Button
|
||||
Reset button; pressing this button resets the system.
|
||||
BOOT Button
|
||||
Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v3-layout.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V3 board layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V3 board layout
|
||||
|
||||
|
||||
Start Application Development
|
||||
------------------------------
|
||||
|
||||
Before powering up the ESP32-PICO-KIT V3, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-PICO-KIT V3 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
ESP32-PICO-KIT V3 Getting Started Guide
|
||||
=======================================
|
||||
|
||||
This user guide shows how to get started with the ESP32-PICO-KIT V3 mini development board. For description of other versions of the ESP32-PICO-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × ESP32-PICO-KIT V3 mini development board
|
||||
* 1 × USB A / Micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-PICO-KIT V3 is a mini development board based on the ESP32-PICO-D4 SIP module produced by `Espressif <https://espressif.com>`_. All the IO signals and system power on ESP32-PICO-D4 are led out through two standard 20 pin x 0.1" pitch headers on both sides for easy interfacing. The development board integrates a USB-UART Bridge circuit, allowing the developers to connect the development board to a PC's USB port for downloads and debugging.
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-PICO-KIT V3 board.
|
||||
|
||||
ESP32-PICO-D4
|
||||
Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT V3 board. The complete system of the ESP32 chip has been integrated into the SIP module, requiring only external antenna with LC matching network, decoupling capacitors and pull-up resistors for EN signals to function properly.
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 1 Mbps transfers rates.
|
||||
I/O
|
||||
All the pins on ESP32-PICO-D4 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
Micro USB Port
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32-PICO-KIT V3.
|
||||
EN Button
|
||||
Reset button; pressing this button resets the system.
|
||||
BOOT Button
|
||||
Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v3-layout.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V3 board layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V3 board layout
|
||||
|
||||
|
||||
Start Application Development
|
||||
------------------------------
|
||||
|
||||
Before powering up the ESP32-PICO-KIT V3, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-PICO-KIT V3 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
|
||||
@@ -1,212 +1,212 @@
|
||||
ESP32-PICO-KIT V4 Getting Started Guide
|
||||
=======================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This user guide shows how to get started with the ESP32-PICO-KIT V4 mini development board. For description of other versions of the ESP32-PICO-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-PICO-KIT V4 mini development board <get-started-pico-kit-v4-board-front>`
|
||||
* 1 × USB A / Micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
If you like to start using this board right now, go directly to section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-PICO-KIT V4 is a mini development board produced by `Espressif <https://espressif.com>`_. At the core of this board is the ESP32-PICO-D4, a System-in-Package (SIP) module with complete Wi-Fi and Bluetooth functionalities. Comparing to other ESP32 chips, the ESP32-PICO-D4 integrates several peripheral components in one single package, that otherwise would need to be installed separately. This includes a 40 MHz crystal oscillator, 4 MB flash, filter capacitors and RF matching links in. This greatly reduces quantity and costs of additional components, subsequent assembly and testing cost, as well as overall product complexity.
|
||||
|
||||
The development board integrates a USB-UART Bridge circuit, allowing the developers to connect the board to a PC's USB port for downloads and debugging.
|
||||
|
||||
For easy interfacing, all the IO signals and system power on ESP32-PICO-D4 are led out through two rows of 20 x 0.1" pitch header pads on both sides of the development board. To make the ESP32-PICO-KIT V4 fit into mini breadboards, the header pads are populated with two rows of 17 pin headers. Remaining 2 x 3 pads grouped on each side of the board besides the antenna are not populated. The remaining 2 x 3 pin headers may be soldered later by the user.
|
||||
|
||||
.. note::
|
||||
|
||||
The 2 x 3 pads not populated with pin headers are internally connected to the flash memory embedded in the ESP32-PICO-D4 SIP module. For more details see module's datasheet in `Related Documents`_.
|
||||
|
||||
The board dimensions are 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4"), see section `Board Dimensions`_. An overview functional block diagram is shown below.
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 functional block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 functional block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-PICO-KIT V4 board.
|
||||
|
||||
ESP32-PICO-D4
|
||||
Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT V4 board. The complete system of the ESP32 chip has been integrated into the SIP module, requiring only external antenna with LC matching network, decoupling capacitors and pull-up resistors for EN signals to function properly.
|
||||
LDO
|
||||
5V-to-3.3V Low dropout voltage regulator (LDO).
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 1 Mbps transfers rates.
|
||||
Micro USB Port
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32-PICO-KIT V4.
|
||||
5V Power On LED
|
||||
This light emitting diode lits when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
|
||||
I/O
|
||||
All the pins on ESP32-PICO-D4 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc. For details please see section `Pin Descriptions`_.
|
||||
BOOT Button
|
||||
Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
EN Button
|
||||
Reset button; pressing this button resets the system.
|
||||
|
||||
.. _get-started-pico-kit-v4-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-layout.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 board layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 board layout
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to the ESP32-PICO-KIT V4:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
3. 3V3 / GND header pins
|
||||
|
||||
.. warning::
|
||||
|
||||
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
|
||||
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up the ESP32-PICO-KIT V4, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Pin Descriptions
|
||||
----------------
|
||||
|
||||
The two tables below provide the **Name** and **Function** of I/O headers on both sides of the board, see :ref:`get-started-pico-kit-v4-board-front`. The pin numbering and header names are the same as on a schematic in `Related Documents`_.
|
||||
|
||||
|
||||
Header J2
|
||||
"""""""""
|
||||
|
||||
====== ================= ====== ======================================================
|
||||
No. Name Type Function
|
||||
====== ================= ====== ======================================================
|
||||
1 FLASH_SD1 (FSD1) I/O | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2CTS
|
||||
2 FLASH_SD3 (FSD3) I/O | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2RTS
|
||||
3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U1CTS
|
||||
4 IO21 I/O | GPIO21, VSPIHD, EMAC_TX_EN
|
||||
5 IO22 I/O | GPIO22, VSPIWP, U0RTS, EMAC_TXD1
|
||||
6 IO19 I/O | GPIO19, VSPIQ, U0CTS, EMAC_TXD0
|
||||
7 IO23 I/O | GPIO23, VSPID, HS1_STROBE
|
||||
8 IO18 I/O | GPIO18, VSPICLK, HS1_DATA7
|
||||
9 IO5 I/O | GPIO5, VSPICS0, HS1_DATA6, EMAC_RX_CLK
|
||||
10 IO10 I/O | GPIO10, SD_DATA3, SPIWP, HS1_DATA3, U1TXD
|
||||
11 IO9 I/O | GPIO9, SD_DATA2, SPIHD, HS1_DATA2, U1RXD
|
||||
12 RXD0 I/O | GPIO3, U0RXD :ref:`(4) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT2
|
||||
13 TXD0 I/O | GPIO1, U0TXD :ref:`(4) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT3, EMAC_RXD2
|
||||
14 IO35 I | ADC1_CH7, RTC_GPIO5
|
||||
15 IO34 I | ADC1_CH6, RTC_GPIO4
|
||||
16 IO38 I | GPIO38, ADC1_CH2, ADC_PRE_AMP :ref:`(2b) <get-started-pico-kit-v4-pin-notes>` , RTC_GPIO2
|
||||
17 IO37 I | GPIO37, ADC_PRE_AMP :ref:`(2a) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH1, RTC_GPIO1
|
||||
18 EN I | CHIP_PU
|
||||
19 GND P | Ground
|
||||
20 VDD33 (3V3) P | 3.3V power supply
|
||||
====== ================= ====== ======================================================
|
||||
|
||||
|
||||
Header J3
|
||||
"""""""""
|
||||
|
||||
====== ================= ====== ======================================================
|
||||
No. Name Type Function
|
||||
====== ================= ====== ======================================================
|
||||
1 FLASH_CS (FCS) I/O | GPIO16, HS1_DATA4 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2RXD, EMAC_CLK_OUT
|
||||
2 FLASH_SD0 (FSD0) I/O | GPIO17, HS1_DATA5 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2TXD, EMAC_CLK_OUT_180
|
||||
3 FLASH_SD2 (FSD2) I/O | GPIO11, SD_CMD, SPICS0, HS1_CMD :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U1RTS
|
||||
4 SENSOR_VP (FSVP) I | GPIO36, ADC1_CH0, ADC_PRE_AMP :ref:`(2a) <get-started-pico-kit-v4-pin-notes>` , RTC_GPIO0
|
||||
5 SENSOR_VN (FSVN) I | GPIO39, ADC1_CH3, ADC_PRE_AMP :ref:`(2b) <get-started-pico-kit-v4-pin-notes>` , RTC_GPIO3
|
||||
6 IO25 I/O | GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
|
||||
7 IO26 I/O | GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
|
||||
8 IO32 I/O | 32K_XP :ref:`(3a) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH4, TOUCH9, RTC_GPIO9
|
||||
9 IO33 I/O | 32K_XN :ref:`(3b) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH5, TOUCH8, RTC_GPIO8
|
||||
10 IO27 I/O | GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17
|
||||
| EMAC_RX_DV
|
||||
11 IO14 I/O | ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK,
|
||||
| HS2_CLK, SD_CLK, EMAC_TXD2
|
||||
12 IO12 I/O | ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI :ref:`(5) <get-started-pico-kit-v4-pin-notes>` , HSPIQ,
|
||||
| HS2_DATA2, SD_DATA2, EMAC_TXD3
|
||||
13 IO13 I/O | ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID,
|
||||
| HS2_DATA3, SD_DATA3, EMAC_RX_ER
|
||||
14 IO15 I/O | ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0
|
||||
| HS2_CMD, SD_CMD, EMAC_RXD3
|
||||
15 IO2 I/O | ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP,
|
||||
| HS2_DATA0, SD_DATA0
|
||||
16 IO4 I/O | ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD,
|
||||
| HS2_DATA1, SD_DATA1, EMAC_TX_ER
|
||||
17 IO0 I/O | ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1
|
||||
| EMAC_TX_CLK
|
||||
18 VDD33 (3V3) P | 3.3V power supply
|
||||
19 GND P | Ground
|
||||
20 EXT_5V (5V) P | 5V power supply
|
||||
====== ================= ====== ======================================================
|
||||
|
||||
|
||||
.. _get-started-pico-kit-v4-pin-notes:
|
||||
|
||||
**Notes to** `Pin Descriptions`_
|
||||
|
||||
1. This pin is connected to the flash pin of ESP32-PICO-D4.
|
||||
2. When used as ADC_PRE_AMP, connect 270 pF capacitors between: (a) SENSOR_VP and IO37, (b) SENSOR_VN and IO38.
|
||||
3. 32.768 kHz crystal oscillator: (a) input, (b) output.
|
||||
4. This pin is connected to the pin of the USB bridge chip on the board.
|
||||
5. The operating voltage of ESP32-PICO-KIT’s embedded SPI flash is 3.3V. Therefore, the strapping pin MTDI should hold bit ”0” during the module power-on reset.
|
||||
|
||||
|
||||
Board Dimensions
|
||||
----------------
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-back.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 dimensions - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 dimensions - back
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 dimensions - side
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 dimensions - side
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-PICO-KIT V4 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-pico-kit-v3
|
||||
ESP32-PICO-KIT V4 Getting Started Guide
|
||||
=======================================
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
This user guide shows how to get started with the ESP32-PICO-KIT V4 mini development board. For description of other versions of the ESP32-PICO-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP32-PICO-KIT V4 mini development board <get-started-pico-kit-v4-board-front>`
|
||||
* 1 × USB A / Micro USB B cable
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
If you like to start using this board right now, go directly to section `Start Application Development`_.
|
||||
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-PICO-KIT V4 is a mini development board produced by `Espressif <https://espressif.com>`_. At the core of this board is the ESP32-PICO-D4, a System-in-Package (SIP) module with complete Wi-Fi and Bluetooth functionalities. Comparing to other ESP32 chips, the ESP32-PICO-D4 integrates several peripheral components in one single package, that otherwise would need to be installed separately. This includes a 40 MHz crystal oscillator, 4 MB flash, filter capacitors and RF matching links in. This greatly reduces quantity and costs of additional components, subsequent assembly and testing cost, as well as overall product complexity.
|
||||
|
||||
The development board integrates a USB-UART Bridge circuit, allowing the developers to connect the board to a PC's USB port for downloads and debugging.
|
||||
|
||||
For easy interfacing, all the IO signals and system power on ESP32-PICO-D4 are led out through two rows of 20 x 0.1" pitch header pads on both sides of the development board. To make the ESP32-PICO-KIT V4 fit into mini breadboards, the header pads are populated with two rows of 17 pin headers. Remaining 2 x 3 pads grouped on each side of the board besides the antenna are not populated. The remaining 2 x 3 pin headers may be soldered later by the user.
|
||||
|
||||
.. note::
|
||||
|
||||
The 2 x 3 pads not populated with pin headers are internally connected to the flash memory embedded in the ESP32-PICO-D4 SIP module. For more details see module's datasheet in `Related Documents`_.
|
||||
|
||||
The board dimensions are 52 x 20.3 x 10 mm (2.1" x 0.8" x 0.4"), see section `Board Dimensions`_. An overview functional block diagram is shown below.
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-functional-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 functional block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 functional block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
----------------------
|
||||
|
||||
The following list and figure below describe key components, interfaces and controls of ESP32-PICO-KIT V4 board.
|
||||
|
||||
ESP32-PICO-D4
|
||||
Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT V4 board. The complete system of the ESP32 chip has been integrated into the SIP module, requiring only external antenna with LC matching network, decoupling capacitors and pull-up resistors for EN signals to function properly.
|
||||
LDO
|
||||
5V-to-3.3V Low dropout voltage regulator (LDO).
|
||||
USB-UART Bridge
|
||||
A single chip USB-UART bridge provides up to 1 Mbps transfers rates.
|
||||
Micro USB Port
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32-PICO-KIT V4.
|
||||
5V Power On LED
|
||||
This light emitting diode lits when the USB or an external 5V power supply is applied to the board. For details see schematic in `Related Documents`_.
|
||||
I/O
|
||||
All the pins on ESP32-PICO-D4 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc. For details please see section `Pin Descriptions`_.
|
||||
BOOT Button
|
||||
Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
EN Button
|
||||
Reset button; pressing this button resets the system.
|
||||
|
||||
.. _get-started-pico-kit-v4-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-layout.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 board layout
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 board layout
|
||||
|
||||
|
||||
Power Supply Options
|
||||
--------------------
|
||||
|
||||
There following options are available to provide power supply to the ESP32-PICO-KIT V4:
|
||||
|
||||
1. Micro USB port, this is default power supply connection
|
||||
2. 5V / GND header pins
|
||||
3. 3V3 / GND header pins
|
||||
|
||||
.. warning::
|
||||
|
||||
Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.
|
||||
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up the ESP32-PICO-KIT V4, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Pin Descriptions
|
||||
----------------
|
||||
|
||||
The two tables below provide the **Name** and **Function** of I/O headers on both sides of the board, see :ref:`get-started-pico-kit-v4-board-front`. The pin numbering and header names are the same as on a schematic in `Related Documents`_.
|
||||
|
||||
|
||||
Header J2
|
||||
"""""""""
|
||||
|
||||
====== ================= ====== ======================================================
|
||||
No. Name Type Function
|
||||
====== ================= ====== ======================================================
|
||||
1 FLASH_SD1 (FSD1) I/O | GPIO8, SD_DATA1, SPID, HS1_DATA1 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2CTS
|
||||
2 FLASH_SD3 (FSD3) I/O | GPIO7, SD_DATA0, SPIQ, HS1_DATA0 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2RTS
|
||||
3 FLASH_CLK (FCLK) I/O | GPIO6, SD_CLK, SPICLK, HS1_CLK :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U1CTS
|
||||
4 IO21 I/O | GPIO21, VSPIHD, EMAC_TX_EN
|
||||
5 IO22 I/O | GPIO22, VSPIWP, U0RTS, EMAC_TXD1
|
||||
6 IO19 I/O | GPIO19, VSPIQ, U0CTS, EMAC_TXD0
|
||||
7 IO23 I/O | GPIO23, VSPID, HS1_STROBE
|
||||
8 IO18 I/O | GPIO18, VSPICLK, HS1_DATA7
|
||||
9 IO5 I/O | GPIO5, VSPICS0, HS1_DATA6, EMAC_RX_CLK
|
||||
10 IO10 I/O | GPIO10, SD_DATA3, SPIWP, HS1_DATA3, U1TXD
|
||||
11 IO9 I/O | GPIO9, SD_DATA2, SPIHD, HS1_DATA2, U1RXD
|
||||
12 RXD0 I/O | GPIO3, U0RXD :ref:`(4) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT2
|
||||
13 TXD0 I/O | GPIO1, U0TXD :ref:`(4) <get-started-pico-kit-v4-pin-notes>` , CLK_OUT3, EMAC_RXD2
|
||||
14 IO35 I | ADC1_CH7, RTC_GPIO5
|
||||
15 IO34 I | ADC1_CH6, RTC_GPIO4
|
||||
16 IO38 I | GPIO38, ADC1_CH2, ADC_PRE_AMP :ref:`(2b) <get-started-pico-kit-v4-pin-notes>` , RTC_GPIO2
|
||||
17 IO37 I | GPIO37, ADC_PRE_AMP :ref:`(2a) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH1, RTC_GPIO1
|
||||
18 EN I | CHIP_PU
|
||||
19 GND P | Ground
|
||||
20 VDD33 (3V3) P | 3.3V power supply
|
||||
====== ================= ====== ======================================================
|
||||
|
||||
|
||||
Header J3
|
||||
"""""""""
|
||||
|
||||
====== ================= ====== ======================================================
|
||||
No. Name Type Function
|
||||
====== ================= ====== ======================================================
|
||||
1 FLASH_CS (FCS) I/O | GPIO16, HS1_DATA4 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2RXD, EMAC_CLK_OUT
|
||||
2 FLASH_SD0 (FSD0) I/O | GPIO17, HS1_DATA5 :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U2TXD, EMAC_CLK_OUT_180
|
||||
3 FLASH_SD2 (FSD2) I/O | GPIO11, SD_CMD, SPICS0, HS1_CMD :ref:`(1) <get-started-pico-kit-v4-pin-notes>` , U1RTS
|
||||
4 SENSOR_VP (FSVP) I | GPIO36, ADC1_CH0, ADC_PRE_AMP :ref:`(2a) <get-started-pico-kit-v4-pin-notes>` , RTC_GPIO0
|
||||
5 SENSOR_VN (FSVN) I | GPIO39, ADC1_CH3, ADC_PRE_AMP :ref:`(2b) <get-started-pico-kit-v4-pin-notes>` , RTC_GPIO3
|
||||
6 IO25 I/O | GPIO25, DAC_1, ADC2_CH8, RTC_GPIO6, EMAC_RXD0
|
||||
7 IO26 I/O | GPIO26, DAC_2, ADC2_CH9, RTC_GPIO7, EMAC_RXD1
|
||||
8 IO32 I/O | 32K_XP :ref:`(3a) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH4, TOUCH9, RTC_GPIO9
|
||||
9 IO33 I/O | 32K_XN :ref:`(3b) <get-started-pico-kit-v4-pin-notes>` , ADC1_CH5, TOUCH8, RTC_GPIO8
|
||||
10 IO27 I/O | GPIO27, ADC2_CH7, TOUCH7, RTC_GPIO17
|
||||
| EMAC_RX_DV
|
||||
11 IO14 I/O | ADC2_CH6, TOUCH6, RTC_GPIO16, MTMS, HSPICLK,
|
||||
| HS2_CLK, SD_CLK, EMAC_TXD2
|
||||
12 IO12 I/O | ADC2_CH5, TOUCH5, RTC_GPIO15, MTDI :ref:`(5) <get-started-pico-kit-v4-pin-notes>` , HSPIQ,
|
||||
| HS2_DATA2, SD_DATA2, EMAC_TXD3
|
||||
13 IO13 I/O | ADC2_CH4, TOUCH4, RTC_GPIO14, MTCK, HSPID,
|
||||
| HS2_DATA3, SD_DATA3, EMAC_RX_ER
|
||||
14 IO15 I/O | ADC2_CH3, TOUCH3, RTC_GPIO13, MTDO, HSPICS0
|
||||
| HS2_CMD, SD_CMD, EMAC_RXD3
|
||||
15 IO2 I/O | ADC2_CH2, TOUCH2, RTC_GPIO12, HSPIWP,
|
||||
| HS2_DATA0, SD_DATA0
|
||||
16 IO4 I/O | ADC2_CH0, TOUCH0, RTC_GPIO10, HSPIHD,
|
||||
| HS2_DATA1, SD_DATA1, EMAC_TX_ER
|
||||
17 IO0 I/O | ADC2_CH1, TOUCH1, RTC_GPIO11, CLK_OUT1
|
||||
| EMAC_TX_CLK
|
||||
18 VDD33 (3V3) P | 3.3V power supply
|
||||
19 GND P | Ground
|
||||
20 EXT_5V (5V) P | 5V power supply
|
||||
====== ================= ====== ======================================================
|
||||
|
||||
|
||||
.. _get-started-pico-kit-v4-pin-notes:
|
||||
|
||||
**Notes to** `Pin Descriptions`_
|
||||
|
||||
1. This pin is connected to the flash pin of ESP32-PICO-D4.
|
||||
2. When used as ADC_PRE_AMP, connect 270 pF capacitors between: (a) SENSOR_VP and IO37, (b) SENSOR_VN and IO38.
|
||||
3. 32.768 kHz crystal oscillator: (a) input, (b) output.
|
||||
4. This pin is connected to the pin of the USB bridge chip on the board.
|
||||
5. The operating voltage of ESP32-PICO-KIT’s embedded SPI flash is 3.3V. Therefore, the strapping pin MTDI should hold bit ”0” during the module power-on reset.
|
||||
|
||||
|
||||
Board Dimensions
|
||||
----------------
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-back.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 dimensions - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 dimensions - back
|
||||
|
||||
.. figure:: ../../_static/esp32-pico-kit-v4-dimensions-side.jpg
|
||||
:align: center
|
||||
:alt: ESP32-PICO-KIT V4 dimensions - side
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-PICO-KIT V4 dimensions - side
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP32-PICO-KIT V4 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v4_schematic.pdf>`_ (PDF)
|
||||
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-pico-kit-v3
|
||||
|
||||
@@ -1,412 +1,412 @@
|
||||
ESP-WROVER-KIT V3 Getting Started Guide
|
||||
=======================================
|
||||
|
||||
This user guide shows how to get started with ESP-WROVER-KIT V3 development board including description of its functionality and configuration options. For description of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
If you like to start using this board right now, go directly to section :ref:`get-started-esp-wrover-kit-start-development`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-board-front>`
|
||||
* 1 x Micro USB 2.0 Cable, Type A to Micro B
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
^^^^^^^^
|
||||
|
||||
The ESP-WROVER-KIT is a development board produced by `Espressif <https://espressif.com>`_ built around ESP32. This board is compatible with ESP32 modules, including the ESP32-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP-WROVER-KIT V3 integrates the ESP32-WROVER module by default.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components.
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following list and figures below describe key components, interfaces and controls of ESP-WROVER-KIT board.
|
||||
|
||||
32.768 kHz
|
||||
An external precision 32.768 kHz crystal oscillator provides the chip with a clock of low-power consumption during the Deep-sleep mode.
|
||||
0R
|
||||
A zero Ohm resistor intended as a placeholder for a current shunt. May be desoldered or replaced with a current shunt to facilitate measurement of current required by ESP32 module depending on power mode.
|
||||
ESP32 Module
|
||||
ESP-WROVER-KIT is compatible with both ESP32-WROOM-32 and ESP32-WROVER. The ESP32-WROVER module features all the functions of ESP32-WROOM-32 and integrates an external 32-MBit PSRAM for flexible extended storage and data processing capabilities.
|
||||
|
||||
.. note::
|
||||
|
||||
GPIO16 and GPIO17 are used as the CS and clock signal for PSRAM. To ensure reliable performance, the two GPIOs are not broken out.
|
||||
|
||||
FT2232
|
||||
The FT2232 chip is a multi-protocol USB-to-serial bridge. Users can control and program the FT2232 chip through the USB interface to establish communication with ESP32. The FT2232 chip also features USB-to-JTAG interface. USB-to-JTAG is available on channel A of FT2232, USB-to-serial on channel B. The embedded FT2232 chip is one of the distinguishing features of the ESPWROVER-KIT. It enhances users’ convenience in terms of application development and debugging. In addition, users do not need to buy a JTAG debugger separately, which reduces the development cost, see `ESP-WROVER-KIT V3 schematic`_.
|
||||
UART
|
||||
Serial port: the serial TX/RX signals on FT2232HL and ESP32 are broken out to the two sides of JP11. By default, the two signals are connected with jumpers. To use the ESP32 module serial interface only, the jumpers may be removed and the module can be connected to another external serial device.
|
||||
SPI
|
||||
SPI interface: the SPI interface connects to an external flash (PSRAM). To interface another SPI device, an extra CS signal is needed. The electrical level on the flash of this module is 1.8V. If an ESP32-WROOM-32 is being used, please note that the electrical level on the flash of this module is 3.3V.
|
||||
CTS/RTS
|
||||
Serial port flow control signals: the pins are not connected to the circuitry by default. To enable them, respective pins of JP14 must be shorted with jumpers.
|
||||
JTAG
|
||||
JTAG interface: the JTAG signals on FT2232HL and ESP32 are broken out to the two sides of JP8. By default, the two signals are disconnected. To enable JTAG, shorting jumpers are required on the signals.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
|
||||
Power Select
|
||||
Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in section :ref:`get-started-esp-wrover-kit-setup-options`, jumper header JP7.
|
||||
Power Key
|
||||
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
|
||||
5V Input
|
||||
The 5V power supply interface is used as a backup power supply in case of full-load operation.
|
||||
LDO
|
||||
NCP1117(1A). 5V-to-3.3V LDO. (There is an alternative pin-compatible LDO — LM317DCY, with an output current of up to 1.5A). NCP1117 can provide a maximum current of 1A. The LDO solutions are available with both fixed output voltage and variable output voltage. For details please refer to `ESP-WROVER-KIT V3 schematic`_.
|
||||
Camera
|
||||
Camera interface: a standard OV7670 camera module is supported.
|
||||
RGB
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O
|
||||
All the pins on the ESP32 module are led out to the pin headers on the ESP-WROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
Micro SD Card
|
||||
Micro SD card slot for data storage.
|
||||
LCD
|
||||
ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`get-started-esp-wrover-kit-board-back`.
|
||||
|
||||
.. _get-started-esp-wrover-kit-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-front.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - front
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _get-started-esp-wrover-kit-board-back:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-back.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-setup-options:
|
||||
|
||||
Setup Options
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
There are five jumper headers available to set up the board functionality. Typical options to select from are listed in table below.
|
||||
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| Header | Jumper Setting | Description of Functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-ext_5v| | Power ESP-WROVER-KIT board from an external |
|
||||
| | | power supply |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP8 | |jp8| | Enable JTAG functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP11 | |jp11-rx-tx| | Enable UART communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP14 | |jp14| | Enable RTS/CTS flow control for serial |
|
||||
| | | communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
|
||||
|
||||
Allocation of ESP32 Pins
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Several pins / terminals of ESP32 module are allocated to the on board hardware. Some of them, like GPIO0 or GPIO2, have multiple functions. If certain hardware is not installed, e.g. nothing is plugged in to the Camera / JP4 header, then selected GPIOs may be used for other purposes.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
""""""""""""""""""""""""
|
||||
|
||||
The JP1 connector is shown in two columns in the middle under "I/O" headers. The two columns "Shared With" outside, describe where else on the board certain GPIO is used.
|
||||
|
||||
+----------------------+------+------+----------------------+
|
||||
| Shared With | I/O | I/O | Shared With |
|
||||
+======================+======+======+======================+
|
||||
| | 3.3V | GND | |
|
||||
+----------------------+------+------+----------------------+
|
||||
| NC/XTAL | IO32 | IO33 | NC/XTAL |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO12 | IO13 | JTAG, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO14 | IO27 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO26 | IO25 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO35 | IO34 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO39 | IO36 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG | EN | IO23 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO22 | IO21 | Camera, LCD, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO19 | IO18 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO5 | IO17 | PSRAM |
|
||||
+----------------------+------+------+----------------------+
|
||||
| PSRAM | IO16 | IO4 | LED, Camera, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| LED, Boot | IO0 | IO2 | LED, Camera, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO15 | 5V | |
|
||||
+----------------------+------+------+----------------------+
|
||||
|
||||
Legend:
|
||||
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-xtal>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-jtag-header>`
|
||||
* Boot - Boot button / SW2
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-camera-header>`
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-rgb-led-connections>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-microsd-card-slot>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-lcd-connector>`
|
||||
* PSRAM - ESP32-WROVER's PSRAM, if ESP32-WROVER is installed
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-xtal:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
"""""""""""""""""""""
|
||||
|
||||
+---+-----------+
|
||||
| | ESP32 Pin |
|
||||
+===+===========+
|
||||
| 1 | GPIO32 |
|
||||
+---+-----------+
|
||||
| 2 | GPIO33 |
|
||||
+---+-----------+
|
||||
|
||||
.. note::
|
||||
|
||||
As GPIO32 and GPIO33 are connected to the oscillator, to maintain signal integrity, they are not connected to JP1 I/O expansion connector. This allocation may be changed from oscillator to JP1 by desoldering 0R resistors from positions R11 / R23 and installing them in positions R12 / R24.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-spi-flash-header:
|
||||
|
||||
SPI Flash / JP13
|
||||
""""""""""""""""
|
||||
|
||||
+---+--------------+
|
||||
| | ESP32 Pin |
|
||||
+===+==============+
|
||||
| 1 | CLK / GPIO6 |
|
||||
+---+--------------+
|
||||
| 2 | SD0 / GPIO7 |
|
||||
+---+--------------+
|
||||
| 3 | SD1 / GPIO8 |
|
||||
+---+--------------+
|
||||
| 4 | SD2 / GPIO9 |
|
||||
+---+--------------+
|
||||
| 5 | SD3 / GPIO10 |
|
||||
+---+--------------+
|
||||
| 6 | CMD / GPIO11 |
|
||||
+---+--------------+
|
||||
|
||||
.. important::
|
||||
|
||||
The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz, to improve integrity of the bus signals, it is recommended to desolder resistors R140 ~ R145. At this point, the module's flash bus is disconnected with the pin header JP13.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-jtag-header:
|
||||
|
||||
JTAG / JP8
|
||||
""""""""""
|
||||
|
||||
+---+---------------+-------------+
|
||||
| | ESP32 Pin | JTAG Signal |
|
||||
+===+===============+=============+
|
||||
| 1 | EN | TRST_N |
|
||||
+---+---------------+-------------+
|
||||
| 2 | MTDO / GPIO15 | TDO |
|
||||
+---+---------------+-------------+
|
||||
| 3 | MTDI / GPIO12 | TDI |
|
||||
+---+---------------+-------------+
|
||||
| 4 | MTCK / GPIO13 | TCK |
|
||||
+---+---------------+-------------+
|
||||
| 5 | MTMS / GPIO14 | TMS |
|
||||
+---+---------------+-------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-camera-header:
|
||||
|
||||
Camera / JP4
|
||||
""""""""""""
|
||||
|
||||
+----+--------------+----------------------+
|
||||
| | ESP32 Pin | Camera Signal |
|
||||
+====+==============+======================+
|
||||
| 1 | GPIO27 | SCCB Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 2 | GPIO26 | SCCB Data |
|
||||
+----+--------------+----------------------+
|
||||
| 3 | GPIO21 | System Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 4 | GPIO25 | Vertical Sync |
|
||||
+----+--------------+----------------------+
|
||||
| 5 | GPIO23 | Horizontal Reference |
|
||||
+----+--------------+----------------------+
|
||||
| 6 | GPIO22 | Pixel Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 7 | GPIO4 | Pixel Data Bit 0 |
|
||||
+----+--------------+----------------------+
|
||||
| 8 | GPIO5 | Pixel Data Bit 1 |
|
||||
+----+--------------+----------------------+
|
||||
| 9 | GPIO18 | Pixel Data Bit 2 |
|
||||
+----+--------------+----------------------+
|
||||
| 10 | GPIO19 | Pixel Data Bit 3 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO36 | Pixel Data Bit 4 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO39 | Pixel Data Bit 5 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO34 | Pixel Data Bit 6 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO35 | Pixel Data Bit 7 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO2 | Camera Reset |
|
||||
+----+--------------+----------------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-rgb-led-connections:
|
||||
|
||||
RGB LED
|
||||
"""""""
|
||||
|
||||
+---+-----------+---------+
|
||||
| | ESP32 Pin | RGB LED |
|
||||
+===+===========+=========+
|
||||
| 1 | GPIO0 | Red |
|
||||
+---+-----------+---------+
|
||||
| 2 | GPIO2 | Blue |
|
||||
+---+-----------+---------+
|
||||
| 3 | GPIO4 | Green |
|
||||
+---+-----------+---------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-microsd-card-slot:
|
||||
|
||||
MicroSD Card / J4
|
||||
"""""""""""""""""
|
||||
|
||||
+---+---------------+----------------+
|
||||
| | ESP32 Pin | MicroSD Signal |
|
||||
+===+===============+================+
|
||||
| 1 | MTDI / GPIO12 | DATA2 |
|
||||
+---+---------------+----------------+
|
||||
| 2 | MTCK / GPIO13 | CD / DATA3 |
|
||||
+---+---------------+----------------+
|
||||
| 3 | MTDO / GPIO15 | CMD |
|
||||
+---+---------------+----------------+
|
||||
| 4 | MTMS / GPIO14 | CLK |
|
||||
+---+---------------+----------------+
|
||||
| 5 | GPIO2 | DATA0 |
|
||||
+---+---------------+----------------+
|
||||
| 6 | GPIO4 | DATA1 |
|
||||
+---+---------------+----------------+
|
||||
| 7 | GPIO21 | CD |
|
||||
+---+---------------+----------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-lcd-connector:
|
||||
|
||||
LCD / U5
|
||||
""""""""
|
||||
|
||||
+---+-----------+------------+
|
||||
| | ESP32 Pin | LCD Signal |
|
||||
+===+===========+============+
|
||||
| 1 | GPIO18 | RESET |
|
||||
+---+-----------+------------+
|
||||
| 2 | GPIO19 | SCL |
|
||||
+---+-----------+------------+
|
||||
| 3 | GPIO21 | D/C |
|
||||
+---+-----------+------------+
|
||||
| 4 | GPIO22 | CS |
|
||||
+---+-----------+------------+
|
||||
| 5 | GPIO23 | SDA |
|
||||
+---+-----------+------------+
|
||||
| 6 | GPIO25 | SDO |
|
||||
+---+-----------+------------+
|
||||
| 7 | GPIO5 | Backlight |
|
||||
+---+-----------+------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-start-development:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up the ESP-WROVER-KIT, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Select the source of power supply for the board by setting jumper JP7. The options are either USB port or an external power supply. For this application selection of USB port is sufficient. Enable UART communication by installing jumpers on JP11. Both selections are shown in table below.
|
||||
|
||||
+----------------------+----------------------+
|
||||
| Power up | Enable UART |
|
||||
| from USB port | communication |
|
||||
+----------------------+----------------------+
|
||||
| |jp7-usb_5v| | |jp11-rx-tx| |
|
||||
+----------------------+----------------------+
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To start development of applications for ESP-WROVER-KIT, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP-WROVER-KIT V3 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
.. |jp7-ext_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-ext_5v.png
|
||||
.. |jp7-usb_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-usb_5v.png
|
||||
.. |jp8| image:: ../../_static/esp-wrover-kit-v3-jp8.png
|
||||
.. |jp11-rx-tx| image:: ../../_static/esp-wrover-kit-v3-jp11-tx-rx.png
|
||||
.. |jp14| image:: ../../_static/esp-wrover-kit-v3-jp14.png
|
||||
|
||||
.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-wrover-kit-v2.rst
|
||||
ESP-WROVER-KIT V3 Getting Started Guide
|
||||
=======================================
|
||||
|
||||
This user guide shows how to get started with ESP-WROVER-KIT V3 development board including description of its functionality and configuration options. For description of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.
|
||||
|
||||
If you like to start using this board right now, go directly to section :ref:`get-started-esp-wrover-kit-start-development`.
|
||||
|
||||
|
||||
What You Need
|
||||
-------------
|
||||
|
||||
* 1 × :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-board-front>`
|
||||
* 1 x Micro USB 2.0 Cable, Type A to Micro B
|
||||
* 1 × PC loaded with Windows, Linux or Mac OS
|
||||
|
||||
|
||||
Overview
|
||||
^^^^^^^^
|
||||
|
||||
The ESP-WROVER-KIT is a development board produced by `Espressif <https://espressif.com>`_ built around ESP32. This board is compatible with ESP32 modules, including the ESP32-WROOM-32 and ESP32-WROVER. The ESP-WROVER-KIT features support for an LCD and MicroSD card. The I/O pins have been broken out from the ESP32 module for easy extension. The board carries an advanced multi-protocol USB bridge (the FTDI FT2232HL), enabling developers to use JTAG directly to debug the ESP32 through the USB interface. The development board makes secondary development easy and cost-effective.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP-WROVER-KIT V3 integrates the ESP32-WROVER module by default.
|
||||
|
||||
|
||||
Functionality Overview
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Block diagram below presents main components of ESP-WROVER-KIT and interconnections between components.
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-block-diagram.png
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT block diagram
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT block diagram
|
||||
|
||||
|
||||
Functional Description
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following list and figures below describe key components, interfaces and controls of ESP-WROVER-KIT board.
|
||||
|
||||
32.768 kHz
|
||||
An external precision 32.768 kHz crystal oscillator provides the chip with a clock of low-power consumption during the Deep-sleep mode.
|
||||
0R
|
||||
A zero Ohm resistor intended as a placeholder for a current shunt. May be desoldered or replaced with a current shunt to facilitate measurement of current required by ESP32 module depending on power mode.
|
||||
ESP32 Module
|
||||
ESP-WROVER-KIT is compatible with both ESP32-WROOM-32 and ESP32-WROVER. The ESP32-WROVER module features all the functions of ESP32-WROOM-32 and integrates an external 32-MBit PSRAM for flexible extended storage and data processing capabilities.
|
||||
|
||||
.. note::
|
||||
|
||||
GPIO16 and GPIO17 are used as the CS and clock signal for PSRAM. To ensure reliable performance, the two GPIOs are not broken out.
|
||||
|
||||
FT2232
|
||||
The FT2232 chip is a multi-protocol USB-to-serial bridge. Users can control and program the FT2232 chip through the USB interface to establish communication with ESP32. The FT2232 chip also features USB-to-JTAG interface. USB-to-JTAG is available on channel A of FT2232, USB-to-serial on channel B. The embedded FT2232 chip is one of the distinguishing features of the ESPWROVER-KIT. It enhances users’ convenience in terms of application development and debugging. In addition, users do not need to buy a JTAG debugger separately, which reduces the development cost, see `ESP-WROVER-KIT V3 schematic`_.
|
||||
UART
|
||||
Serial port: the serial TX/RX signals on FT2232HL and ESP32 are broken out to the two sides of JP11. By default, the two signals are connected with jumpers. To use the ESP32 module serial interface only, the jumpers may be removed and the module can be connected to another external serial device.
|
||||
SPI
|
||||
SPI interface: the SPI interface connects to an external flash (PSRAM). To interface another SPI device, an extra CS signal is needed. The electrical level on the flash of this module is 1.8V. If an ESP32-WROOM-32 is being used, please note that the electrical level on the flash of this module is 3.3V.
|
||||
CTS/RTS
|
||||
Serial port flow control signals: the pins are not connected to the circuitry by default. To enable them, respective pins of JP14 must be shorted with jumpers.
|
||||
JTAG
|
||||
JTAG interface: the JTAG signals on FT2232HL and ESP32 are broken out to the two sides of JP8. By default, the two signals are disconnected. To enable JTAG, shorting jumpers are required on the signals.
|
||||
EN
|
||||
Reset button: pressing this button resets the system.
|
||||
Boot
|
||||
Download button: holding down the **Boot** button and pressing the **EN** button initiates the firmware download mode. Then user can download firmware through the serial port.
|
||||
USB
|
||||
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
|
||||
Power Select
|
||||
Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in section :ref:`get-started-esp-wrover-kit-setup-options`, jumper header JP7.
|
||||
Power Key
|
||||
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
|
||||
5V Input
|
||||
The 5V power supply interface is used as a backup power supply in case of full-load operation.
|
||||
LDO
|
||||
NCP1117(1A). 5V-to-3.3V LDO. (There is an alternative pin-compatible LDO — LM317DCY, with an output current of up to 1.5A). NCP1117 can provide a maximum current of 1A. The LDO solutions are available with both fixed output voltage and variable output voltage. For details please refer to `ESP-WROVER-KIT V3 schematic`_.
|
||||
Camera
|
||||
Camera interface: a standard OV7670 camera module is supported.
|
||||
RGB
|
||||
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
|
||||
I/O
|
||||
All the pins on the ESP32 module are led out to the pin headers on the ESP-WROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
|
||||
Micro SD Card
|
||||
Micro SD card slot for data storage.
|
||||
LCD
|
||||
ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`get-started-esp-wrover-kit-board-back`.
|
||||
|
||||
.. _get-started-esp-wrover-kit-board-front:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-front.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - front
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - front
|
||||
|
||||
.. _get-started-esp-wrover-kit-board-back:
|
||||
|
||||
.. figure:: ../../_static/esp32-wrover-kit-layout-back.jpg
|
||||
:align: center
|
||||
:alt: ESP-WROVER-KIT board layout - back
|
||||
:figclass: align-center
|
||||
|
||||
ESP-WROVER-KIT board layout - back
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-setup-options:
|
||||
|
||||
Setup Options
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
There are five jumper headers available to set up the board functionality. Typical options to select from are listed in table below.
|
||||
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| Header | Jumper Setting | Description of Functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-ext_5v| | Power ESP-WROVER-KIT board from an external |
|
||||
| | | power supply |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP8 | |jp8| | Enable JTAG functionality |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP11 | |jp11-rx-tx| | Enable UART communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
| JP14 | |jp14| | Enable RTS/CTS flow control for serial |
|
||||
| | | communication |
|
||||
+--------+------------------+--------------------------------------------------+
|
||||
|
||||
|
||||
Allocation of ESP32 Pins
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Several pins / terminals of ESP32 module are allocated to the on board hardware. Some of them, like GPIO0 or GPIO2, have multiple functions. If certain hardware is not installed, e.g. nothing is plugged in to the Camera / JP4 header, then selected GPIOs may be used for other purposes.
|
||||
|
||||
|
||||
Main I/O Connector / JP1
|
||||
""""""""""""""""""""""""
|
||||
|
||||
The JP1 connector is shown in two columns in the middle under "I/O" headers. The two columns "Shared With" outside, describe where else on the board certain GPIO is used.
|
||||
|
||||
+----------------------+------+------+----------------------+
|
||||
| Shared With | I/O | I/O | Shared With |
|
||||
+======================+======+======+======================+
|
||||
| | 3.3V | GND | |
|
||||
+----------------------+------+------+----------------------+
|
||||
| NC/XTAL | IO32 | IO33 | NC/XTAL |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO12 | IO13 | JTAG, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO14 | IO27 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO26 | IO25 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO35 | IO34 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera | IO39 | IO36 | Camera |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG | EN | IO23 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO22 | IO21 | Camera, LCD, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO19 | IO18 | Camera, LCD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| Camera, LCD | IO5 | IO17 | PSRAM |
|
||||
+----------------------+------+------+----------------------+
|
||||
| PSRAM | IO16 | IO4 | LED, Camera, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| LED, Boot | IO0 | IO2 | LED, Camera, MicroSD |
|
||||
+----------------------+------+------+----------------------+
|
||||
| JTAG, MicroSD | IO15 | 5V | |
|
||||
+----------------------+------+------+----------------------+
|
||||
|
||||
Legend:
|
||||
|
||||
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-xtal>`
|
||||
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-jtag-header>`
|
||||
* Boot - Boot button / SW2
|
||||
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-camera-header>`
|
||||
* LED - :ref:`RGB LED <get-started-esp-wrover-rgb-led-connections>`
|
||||
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-microsd-card-slot>`
|
||||
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-lcd-connector>`
|
||||
* PSRAM - ESP32-WROVER's PSRAM, if ESP32-WROVER is installed
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-xtal:
|
||||
|
||||
32.768 kHz Oscillator
|
||||
"""""""""""""""""""""
|
||||
|
||||
+---+-----------+
|
||||
| | ESP32 Pin |
|
||||
+===+===========+
|
||||
| 1 | GPIO32 |
|
||||
+---+-----------+
|
||||
| 2 | GPIO33 |
|
||||
+---+-----------+
|
||||
|
||||
.. note::
|
||||
|
||||
As GPIO32 and GPIO33 are connected to the oscillator, to maintain signal integrity, they are not connected to JP1 I/O expansion connector. This allocation may be changed from oscillator to JP1 by desoldering 0R resistors from positions R11 / R23 and installing them in positions R12 / R24.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-spi-flash-header:
|
||||
|
||||
SPI Flash / JP13
|
||||
""""""""""""""""
|
||||
|
||||
+---+--------------+
|
||||
| | ESP32 Pin |
|
||||
+===+==============+
|
||||
| 1 | CLK / GPIO6 |
|
||||
+---+--------------+
|
||||
| 2 | SD0 / GPIO7 |
|
||||
+---+--------------+
|
||||
| 3 | SD1 / GPIO8 |
|
||||
+---+--------------+
|
||||
| 4 | SD2 / GPIO9 |
|
||||
+---+--------------+
|
||||
| 5 | SD3 / GPIO10 |
|
||||
+---+--------------+
|
||||
| 6 | CMD / GPIO11 |
|
||||
+---+--------------+
|
||||
|
||||
.. important::
|
||||
|
||||
The module's flash bus is connected to the pin header JP13 through 0-Ohm resistors R140 ~ R145. If the flash frequency needs to operate at 80 MHz, to improve integrity of the bus signals, it is recommended to desolder resistors R140 ~ R145. At this point, the module's flash bus is disconnected with the pin header JP13.
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-jtag-header:
|
||||
|
||||
JTAG / JP8
|
||||
""""""""""
|
||||
|
||||
+---+---------------+-------------+
|
||||
| | ESP32 Pin | JTAG Signal |
|
||||
+===+===============+=============+
|
||||
| 1 | EN | TRST_N |
|
||||
+---+---------------+-------------+
|
||||
| 2 | MTDO / GPIO15 | TDO |
|
||||
+---+---------------+-------------+
|
||||
| 3 | MTDI / GPIO12 | TDI |
|
||||
+---+---------------+-------------+
|
||||
| 4 | MTCK / GPIO13 | TCK |
|
||||
+---+---------------+-------------+
|
||||
| 5 | MTMS / GPIO14 | TMS |
|
||||
+---+---------------+-------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-camera-header:
|
||||
|
||||
Camera / JP4
|
||||
""""""""""""
|
||||
|
||||
+----+--------------+----------------------+
|
||||
| | ESP32 Pin | Camera Signal |
|
||||
+====+==============+======================+
|
||||
| 1 | GPIO27 | SCCB Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 2 | GPIO26 | SCCB Data |
|
||||
+----+--------------+----------------------+
|
||||
| 3 | GPIO21 | System Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 4 | GPIO25 | Vertical Sync |
|
||||
+----+--------------+----------------------+
|
||||
| 5 | GPIO23 | Horizontal Reference |
|
||||
+----+--------------+----------------------+
|
||||
| 6 | GPIO22 | Pixel Clock |
|
||||
+----+--------------+----------------------+
|
||||
| 7 | GPIO4 | Pixel Data Bit 0 |
|
||||
+----+--------------+----------------------+
|
||||
| 8 | GPIO5 | Pixel Data Bit 1 |
|
||||
+----+--------------+----------------------+
|
||||
| 9 | GPIO18 | Pixel Data Bit 2 |
|
||||
+----+--------------+----------------------+
|
||||
| 10 | GPIO19 | Pixel Data Bit 3 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO36 | Pixel Data Bit 4 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO39 | Pixel Data Bit 5 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO34 | Pixel Data Bit 6 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO35 | Pixel Data Bit 7 |
|
||||
+----+--------------+----------------------+
|
||||
| 11 | GPIO2 | Camera Reset |
|
||||
+----+--------------+----------------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-rgb-led-connections:
|
||||
|
||||
RGB LED
|
||||
"""""""
|
||||
|
||||
+---+-----------+---------+
|
||||
| | ESP32 Pin | RGB LED |
|
||||
+===+===========+=========+
|
||||
| 1 | GPIO0 | Red |
|
||||
+---+-----------+---------+
|
||||
| 2 | GPIO2 | Blue |
|
||||
+---+-----------+---------+
|
||||
| 3 | GPIO4 | Green |
|
||||
+---+-----------+---------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-microsd-card-slot:
|
||||
|
||||
MicroSD Card / J4
|
||||
"""""""""""""""""
|
||||
|
||||
+---+---------------+----------------+
|
||||
| | ESP32 Pin | MicroSD Signal |
|
||||
+===+===============+================+
|
||||
| 1 | MTDI / GPIO12 | DATA2 |
|
||||
+---+---------------+----------------+
|
||||
| 2 | MTCK / GPIO13 | CD / DATA3 |
|
||||
+---+---------------+----------------+
|
||||
| 3 | MTDO / GPIO15 | CMD |
|
||||
+---+---------------+----------------+
|
||||
| 4 | MTMS / GPIO14 | CLK |
|
||||
+---+---------------+----------------+
|
||||
| 5 | GPIO2 | DATA0 |
|
||||
+---+---------------+----------------+
|
||||
| 6 | GPIO4 | DATA1 |
|
||||
+---+---------------+----------------+
|
||||
| 7 | GPIO21 | CD |
|
||||
+---+---------------+----------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-lcd-connector:
|
||||
|
||||
LCD / U5
|
||||
""""""""
|
||||
|
||||
+---+-----------+------------+
|
||||
| | ESP32 Pin | LCD Signal |
|
||||
+===+===========+============+
|
||||
| 1 | GPIO18 | RESET |
|
||||
+---+-----------+------------+
|
||||
| 2 | GPIO19 | SCL |
|
||||
+---+-----------+------------+
|
||||
| 3 | GPIO21 | D/C |
|
||||
+---+-----------+------------+
|
||||
| 4 | GPIO22 | CS |
|
||||
+---+-----------+------------+
|
||||
| 5 | GPIO23 | SDA |
|
||||
+---+-----------+------------+
|
||||
| 6 | GPIO25 | SDO |
|
||||
+---+-----------+------------+
|
||||
| 7 | GPIO5 | Backlight |
|
||||
+---+-----------+------------+
|
||||
|
||||
|
||||
.. _get-started-esp-wrover-kit-start-development:
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up the ESP-WROVER-KIT, please make sure that the board has been received in good condition with no obvious signs of damage.
|
||||
|
||||
|
||||
Initial Setup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Select the source of power supply for the board by setting jumper JP7. The options are either USB port or an external power supply. For this application selection of USB port is sufficient. Enable UART communication by installing jumpers on JP11. Both selections are shown in table below.
|
||||
|
||||
+----------------------+----------------------+
|
||||
| Power up | Enable UART |
|
||||
| from USB port | communication |
|
||||
+----------------------+----------------------+
|
||||
| |jp7-usb_5v| | |jp11-rx-tx| |
|
||||
+----------------------+----------------------+
|
||||
|
||||
Do not install any other jumpers.
|
||||
|
||||
|
||||
Now to Development
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To start development of applications for ESP-WROVER-KIT, proceed to section :doc:`index`, that will walk you through the following steps:
|
||||
|
||||
* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language
|
||||
* :ref:`get-started-connect` the module to the PC and verify if it is accessible
|
||||
* :ref:`get-started-build-flash` an example application to the ESP32
|
||||
* :ref:`get-started-build-monitor` instantly what the application is doing
|
||||
|
||||
|
||||
Related Documents
|
||||
-----------------
|
||||
|
||||
* `ESP-WROVER-KIT V3 schematic`_ (PDF)
|
||||
* `ESP32 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROVER Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-WROOM-32 Datasheet <https://espressif.com/sites/default/files/documentation/esp32-wroom-32_datasheet_en.pdf>`_ (PDF)
|
||||
* :doc:`../api-guides/jtag-debugging/index`
|
||||
* :doc:`../hw-reference/index`
|
||||
|
||||
.. |jp7-ext_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-ext_5v.png
|
||||
.. |jp7-usb_5v| image:: ../../_static/esp-wrover-kit-v3-jp7-usb_5v.png
|
||||
.. |jp8| image:: ../../_static/esp-wrover-kit-v3-jp8.png
|
||||
.. |jp11-rx-tx| image:: ../../_static/esp-wrover-kit-v3-jp11-tx-rx.png
|
||||
.. |jp14| image:: ../../_static/esp-wrover-kit-v3-jp14.png
|
||||
|
||||
.. _ESP-WROVER-KIT V3 schematic: https://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
get-started-wrover-kit-v2.rst
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
*************************************
|
||||
*************************************
|
||||
Standard Setup of Toolchain for Linux
|
||||
*************************************
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
@@ -1,19 +1,19 @@
|
||||
Switch Between Languages/切换语言
|
||||
=================================
|
||||
|
||||
The documentation now has two language versions, however, please refer to the English version if there is any discrepancy.
|
||||
|
||||
本文档现在有两种语言的版本，如有出入请以英文版本为准。
|
||||
|
||||
- English/英文
|
||||
- Chinese/中文
|
||||
|
||||
You can easily changed from one language to another by the panel on the sidebar like below. Just click on the **Read
|
||||
the Docs** title button on the left-bottom conner if it is folded.
|
||||
|
||||
如下图所示，你可使用边栏的面板进行语言的切换。如果该面板被折叠，点击左下角 **Read the Docs** 标题按钮来显示它。
|
||||
|
||||
.. image:: /../_static/choose_version.png
|
||||
|
||||
|
||||
|
||||
Switch Between Languages/切换语言
|
||||
=================================
|
||||
|
||||
The documentation now has two language versions, however, please refer to the English version if there is any discrepancy.
|
||||
|
||||
本文档现在有两种语言的版本，如有出入请以英文版本为准。
|
||||
|
||||
- English/英文
|
||||
- Chinese/中文
|
||||
|
||||
You can easily changed from one language to another by the panel on the sidebar like below. Just click on the **Read
|
||||
the Docs** title button on the left-bottom conner if it is folded.
|
||||
|
||||
如下图所示，你可使用边栏的面板进行语言的切换。如果该面板被折叠，点击左下角 **Read the Docs** 标题按钮来显示它。
|
||||
|
||||
.. image:: /../_static/choose_version.png
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,104 +1,104 @@
|
||||
128 vTaskAllocateMPURegions xTask=%t pxRegions=%u
|
||||
33 vTaskDelete xTaskToDelete=%t
|
||||
34 vTaskDelay xTicksToDelay=%u
|
||||
35 vTaskDelayUntil
|
||||
129 uxTaskPriorityGet xTask=%t
|
||||
56 uxTaskPriorityGetFromISR xTask=%t
|
||||
130 eTaskGetState xTask=%t
|
||||
55 vTaskPrioritySet xTask=%t uxNewPriority=%u
|
||||
36 vTaskSuspend xTaskToSuspend=%t
|
||||
40 vTaskResume xTaskToResume=%t
|
||||
43 xTaskResumeFromISR xTaskToResume=%t
|
||||
131 vTaskStartScheduler
|
||||
132 vTaskEndScheduler
|
||||
133 vTaskSuspendAll
|
||||
134 xTaskResumeAll
|
||||
135 xTaskGetTickCount
|
||||
57 xTaskGetTickCountFromISR
|
||||
136 uxTaskGetNumberOfTasks
|
||||
137 pcTaskGetTaskName xTaskToQuery=%t
|
||||
138 uxTaskGetStackHighWaterMark xTask=%t
|
||||
139 vTaskSetApplicationTaskTag xTask=%t pxHookFunction=%u
|
||||
140 xTaskGetApplicationTaskTag xTask=%t
|
||||
141 vTaskSetThreadLocalStoragePointer xTaskToSet=%T xIndex=%u pvValue=%u
|
||||
142 pvTaskGetThreadLocalStoragePointer xTaskToQuery=%T xIndex=%u
|
||||
143 xTaskCallApplicationTaskHook xTask=%T pvParameter=%u
|
||||
144 xTaskGetIdleTaskHandle
|
||||
145 uxTaskGetSystemState pxTaskStatusArray=%u uxArraySize=%u pulTotalRunTime=%u
|
||||
146 vTaskList pcWriteBuffer=%u
|
||||
147 vTaskGetRunTimeStats pcWriteBuffer=%u
|
||||
44 xTaskGenericNotify xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u
|
||||
45 xTaskGenericNotifyFromISR xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u pxHigherPriorityTaskWoken=%u
|
||||
46 xTaskNotifyWait ulBitsToClearOnEntry=%u ulBitsToClearOnExit=%u pulNotificationValue=%u xTicksToWait=%u
|
||||
38 vTaskNotifyGiveFromISR xTaskToNotify=%t pxHigherPriorityTaskWoken=%u
|
||||
37 ulTaskNotifyTake xClearCountOnExit=%u xTicksToWait=%u
|
||||
148 xTaskNotifyStateClear xTask=%t
|
||||
149 xTaskGetCurrentTaskHandle
|
||||
150 vTaskSetTimeOutState pxTimeOut=%u
|
||||
151 xTaskCheckForTimeOut pxTimeOut=%u pxTicksToWait=%u
|
||||
152 vTaskMissedYield
|
||||
153 xTaskGetSchedulerState
|
||||
39 vTaskPriorityInherit pxMutexHolder=%p
|
||||
42 xTaskPriorityDisinherit pxMutexHolder=%p
|
||||
154 xTaskGenericCreate pxTaskCode=%u pcName=%u usStackDepth=%u pvParameters=%u uxPriority=%u pxCreatedTask=%u puxStackBuffer=%u xRegions=%u
|
||||
155 uxTaskGetTaskNumber xTask=%u
|
||||
156 vTaskSetTaskNumber xTask=%u uxHandle=%u
|
||||
41 vTaskStepTick xTicksToJump=%u
|
||||
157 eTaskConfirmSleepModeStatus
|
||||
158 xTimerCreate pcTimerName=%u xTimerPeriodInTicks=%u uxAutoReload=%u pvTimerID=%u pxCallbackFunction=%u
|
||||
159 pvTimerGetTimerID xTimer=%u
|
||||
160 vTimerSetTimerID xTimer=%u pvNewID=%u
|
||||
161 xTimerIsTimerActive xTimer=%u
|
||||
162 xTimerGetTimerDaemonTaskHandle
|
||||
163 xTimerPendFunctionCallFromISR xFunctionToPend=%u pvParameter1=%u ulParameter2=%u pxHigherPriorityTaskWoken=%u
|
||||
164 xTimerPendFunctionCall xFunctionToPend=%u pvParameter1=%u ulParameter2=%u xTicksToWait=%u
|
||||
165 pcTimerGetTimerName xTimer=%u
|
||||
166 xTimerCreateTimerTask
|
||||
167 xTimerGenericCommand xTimer=%u xCommandID=%u xOptionalValue=%u pxHigherPriorityTaskWoken=%u xTicksToWait=%u
|
||||
53 xQueueGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
50 xQueuePeekFromISR xQueue=%I pvBuffer=%p
|
||||
49 xQueueGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeek=%u
|
||||
168 uxQueueMessagesWaiting xQueue=%I
|
||||
169 uxQueueSpacesAvailable xQueue=%I
|
||||
48 vQueueDelete xQueue=%I
|
||||
54 xQueueGenericSendFromISR xQueue=%I pvItemToQueue=%p pxHigherPriorityTaskWoken=%u xCopyPosition=%u
|
||||
61 xQueueGiveFromISR xQueue=%I pxHigherPriorityTaskWoken=%u
|
||||
51 xQueueReceiveFromISR xQueue=%I pvBuffer=%p pxHigherPriorityTaskWoken=%u
|
||||
62 xQueueIsQueueEmptyFromISR xQueue=%I
|
||||
63 xQueueIsQueueFullFromISR xQueue=%I
|
||||
170 uxQueueMessagesWaitingFromISR xQueue=%I
|
||||
171 xQueueAltGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
172 xQueueAltGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeeking=%u
|
||||
173 xQueueCRSendFromISR xQueue=%I pvItemToQueue=%p xCoRoutinePreviouslyWoken=%u
|
||||
174 xQueueCRReceiveFromISR xQueue=%I pvBuffer=%p pxTaskWoken=%u
|
||||
175 xQueueCRSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u
|
||||
176 xQueueCRReceive xQueue=%I pvBuffer=%p xTicksToWait=%u
|
||||
177 xQueueCreateMutex ucQueueType=%u
|
||||
178 xQueueCreateCountingSemaphore uxMaxCount=%u uxInitialCount=%u
|
||||
179 xQueueGetMutexHolder xSemaphore=%u
|
||||
180 xQueueTakeMutexRecursive xMutex=%u xTicksToWait=%u
|
||||
181 xQueueGiveMutexRecursive pxMutex=%u
|
||||
52 vQueueAddToRegistry xQueue=%I pcName=%u
|
||||
182 vQueueUnregisterQueue xQueue=%I
|
||||
47 xQueueGenericCreate uxQueueLength=%u uxItemSize=%u ucQueueType=%u
|
||||
183 xQueueCreateSet uxEventQueueLength=%u
|
||||
184 xQueueAddToSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
185 xQueueRemoveFromSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
186 xQueueSelectFromSet xQueueSet=%u xTicksToWait=%u
|
||||
187 xQueueSelectFromSetFromISR xQueueSet=%u
|
||||
188 xQueueGenericReset xQueue=%I xNewQueue=%u
|
||||
189 vListInitialise pxList=%u
|
||||
190 vListInitialiseItem pxItem=%u
|
||||
191 vListInsert pxList=%u pxNewListItem=%u
|
||||
192 vListInsertEnd pxList=%u pxNewListItem=%u
|
||||
193 uxListRemove pxItemToRemove=%u
|
||||
194 xEventGroupCreate
|
||||
195 xEventGroupWaitBits xEventGroup=%u uxBitsToWaitFor=%u xClearOnExit=%u xWaitForAllBits=%u xTicksToWait=%u
|
||||
196 xEventGroupClearBits xEventGroup=%u uxBitsToClear=%u
|
||||
58 xEventGroupClearBitsFromISR xEventGroup=%u uxBitsToSet=%u
|
||||
197 xEventGroupSetBits xEventGroup=%u uxBitsToSet=%u
|
||||
59 xEventGroupSetBitsFromISR xEventGroup=%u uxBitsToSet=%u pxHigherPriorityTaskWoken=%u
|
||||
198 xEventGroupSync xEventGroup=%u uxBitsToSet=%u uxBitsToWaitFor=%u xTicksToWait=%u
|
||||
60 xEventGroupGetBitsFromISR xEventGroup=%u
|
||||
199 vEventGroupDelete xEventGroup=%u
|
||||
200 uxEventGroupGetNumber xEventGroup=%u
|
||||
128 vTaskAllocateMPURegions xTask=%t pxRegions=%u
|
||||
33 vTaskDelete xTaskToDelete=%t
|
||||
34 vTaskDelay xTicksToDelay=%u
|
||||
35 vTaskDelayUntil
|
||||
129 uxTaskPriorityGet xTask=%t
|
||||
56 uxTaskPriorityGetFromISR xTask=%t
|
||||
130 eTaskGetState xTask=%t
|
||||
55 vTaskPrioritySet xTask=%t uxNewPriority=%u
|
||||
36 vTaskSuspend xTaskToSuspend=%t
|
||||
40 vTaskResume xTaskToResume=%t
|
||||
43 xTaskResumeFromISR xTaskToResume=%t
|
||||
131 vTaskStartScheduler
|
||||
132 vTaskEndScheduler
|
||||
133 vTaskSuspendAll
|
||||
134 xTaskResumeAll
|
||||
135 xTaskGetTickCount
|
||||
57 xTaskGetTickCountFromISR
|
||||
136 uxTaskGetNumberOfTasks
|
||||
137 pcTaskGetTaskName xTaskToQuery=%t
|
||||
138 uxTaskGetStackHighWaterMark xTask=%t
|
||||
139 vTaskSetApplicationTaskTag xTask=%t pxHookFunction=%u
|
||||
140 xTaskGetApplicationTaskTag xTask=%t
|
||||
141 vTaskSetThreadLocalStoragePointer xTaskToSet=%T xIndex=%u pvValue=%u
|
||||
142 pvTaskGetThreadLocalStoragePointer xTaskToQuery=%T xIndex=%u
|
||||
143 xTaskCallApplicationTaskHook xTask=%T pvParameter=%u
|
||||
144 xTaskGetIdleTaskHandle
|
||||
145 uxTaskGetSystemState pxTaskStatusArray=%u uxArraySize=%u pulTotalRunTime=%u
|
||||
146 vTaskList pcWriteBuffer=%u
|
||||
147 vTaskGetRunTimeStats pcWriteBuffer=%u
|
||||
44 xTaskGenericNotify xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u
|
||||
45 xTaskGenericNotifyFromISR xTaskToNotify=%t ulValue=%u eAction=%u pulPreviousNotificationValue=%u pxHigherPriorityTaskWoken=%u
|
||||
46 xTaskNotifyWait ulBitsToClearOnEntry=%u ulBitsToClearOnExit=%u pulNotificationValue=%u xTicksToWait=%u
|
||||
38 vTaskNotifyGiveFromISR xTaskToNotify=%t pxHigherPriorityTaskWoken=%u
|
||||
37 ulTaskNotifyTake xClearCountOnExit=%u xTicksToWait=%u
|
||||
148 xTaskNotifyStateClear xTask=%t
|
||||
149 xTaskGetCurrentTaskHandle
|
||||
150 vTaskSetTimeOutState pxTimeOut=%u
|
||||
151 xTaskCheckForTimeOut pxTimeOut=%u pxTicksToWait=%u
|
||||
152 vTaskMissedYield
|
||||
153 xTaskGetSchedulerState
|
||||
39 vTaskPriorityInherit pxMutexHolder=%p
|
||||
42 xTaskPriorityDisinherit pxMutexHolder=%p
|
||||
154 xTaskGenericCreate pxTaskCode=%u pcName=%u usStackDepth=%u pvParameters=%u uxPriority=%u pxCreatedTask=%u puxStackBuffer=%u xRegions=%u
|
||||
155 uxTaskGetTaskNumber xTask=%u
|
||||
156 vTaskSetTaskNumber xTask=%u uxHandle=%u
|
||||
41 vTaskStepTick xTicksToJump=%u
|
||||
157 eTaskConfirmSleepModeStatus
|
||||
158 xTimerCreate pcTimerName=%u xTimerPeriodInTicks=%u uxAutoReload=%u pvTimerID=%u pxCallbackFunction=%u
|
||||
159 pvTimerGetTimerID xTimer=%u
|
||||
160 vTimerSetTimerID xTimer=%u pvNewID=%u
|
||||
161 xTimerIsTimerActive xTimer=%u
|
||||
162 xTimerGetTimerDaemonTaskHandle
|
||||
163 xTimerPendFunctionCallFromISR xFunctionToPend=%u pvParameter1=%u ulParameter2=%u pxHigherPriorityTaskWoken=%u
|
||||
164 xTimerPendFunctionCall xFunctionToPend=%u pvParameter1=%u ulParameter2=%u xTicksToWait=%u
|
||||
165 pcTimerGetTimerName xTimer=%u
|
||||
166 xTimerCreateTimerTask
|
||||
167 xTimerGenericCommand xTimer=%u xCommandID=%u xOptionalValue=%u pxHigherPriorityTaskWoken=%u xTicksToWait=%u
|
||||
53 xQueueGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
50 xQueuePeekFromISR xQueue=%I pvBuffer=%p
|
||||
49 xQueueGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeek=%u
|
||||
168 uxQueueMessagesWaiting xQueue=%I
|
||||
169 uxQueueSpacesAvailable xQueue=%I
|
||||
48 vQueueDelete xQueue=%I
|
||||
54 xQueueGenericSendFromISR xQueue=%I pvItemToQueue=%p pxHigherPriorityTaskWoken=%u xCopyPosition=%u
|
||||
61 xQueueGiveFromISR xQueue=%I pxHigherPriorityTaskWoken=%u
|
||||
51 xQueueReceiveFromISR xQueue=%I pvBuffer=%p pxHigherPriorityTaskWoken=%u
|
||||
62 xQueueIsQueueEmptyFromISR xQueue=%I
|
||||
63 xQueueIsQueueFullFromISR xQueue=%I
|
||||
170 uxQueueMessagesWaitingFromISR xQueue=%I
|
||||
171 xQueueAltGenericSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u xCopyPosition=%u
|
||||
172 xQueueAltGenericReceive xQueue=%I pvBuffer=%p xTicksToWait=%u xJustPeeking=%u
|
||||
173 xQueueCRSendFromISR xQueue=%I pvItemToQueue=%p xCoRoutinePreviouslyWoken=%u
|
||||
174 xQueueCRReceiveFromISR xQueue=%I pvBuffer=%p pxTaskWoken=%u
|
||||
175 xQueueCRSend xQueue=%I pvItemToQueue=%p xTicksToWait=%u
|
||||
176 xQueueCRReceive xQueue=%I pvBuffer=%p xTicksToWait=%u
|
||||
177 xQueueCreateMutex ucQueueType=%u
|
||||
178 xQueueCreateCountingSemaphore uxMaxCount=%u uxInitialCount=%u
|
||||
179 xQueueGetMutexHolder xSemaphore=%u
|
||||
180 xQueueTakeMutexRecursive xMutex=%u xTicksToWait=%u
|
||||
181 xQueueGiveMutexRecursive pxMutex=%u
|
||||
52 vQueueAddToRegistry xQueue=%I pcName=%u
|
||||
182 vQueueUnregisterQueue xQueue=%I
|
||||
47 xQueueGenericCreate uxQueueLength=%u uxItemSize=%u ucQueueType=%u
|
||||
183 xQueueCreateSet uxEventQueueLength=%u
|
||||
184 xQueueAddToSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
185 xQueueRemoveFromSet xQueueOrSemaphore=%u xQueueSet=%u
|
||||
186 xQueueSelectFromSet xQueueSet=%u xTicksToWait=%u
|
||||
187 xQueueSelectFromSetFromISR xQueueSet=%u
|
||||
188 xQueueGenericReset xQueue=%I xNewQueue=%u
|
||||
189 vListInitialise pxList=%u
|
||||
190 vListInitialiseItem pxItem=%u
|
||||
191 vListInsert pxList=%u pxNewListItem=%u
|
||||
192 vListInsertEnd pxList=%u pxNewListItem=%u
|
||||
193 uxListRemove pxItemToRemove=%u
|
||||
194 xEventGroupCreate
|
||||
195 xEventGroupWaitBits xEventGroup=%u uxBitsToWaitFor=%u xClearOnExit=%u xWaitForAllBits=%u xTicksToWait=%u
|
||||
196 xEventGroupClearBits xEventGroup=%u uxBitsToClear=%u
|
||||
58 xEventGroupClearBitsFromISR xEventGroup=%u uxBitsToSet=%u
|
||||
197 xEventGroupSetBits xEventGroup=%u uxBitsToSet=%u
|
||||
59 xEventGroupSetBitsFromISR xEventGroup=%u uxBitsToSet=%u pxHigherPriorityTaskWoken=%u
|
||||
198 xEventGroupSync xEventGroup=%u uxBitsToSet=%u uxBitsToWaitFor=%u xTicksToWait=%u
|
||||
60 xEventGroupGetBitsFromISR xEventGroup=%u
|
||||
199 vEventGroupDelete xEventGroup=%u
|
||||
200 uxEventGroupGetNumber xEventGroup=%u
|
||||
|
||||
@@ -1 +1 @@
|
||||
.. include:: ../en/languages.rst
|
||||
.. include:: ../en/languages.rst
|
||||
|
||||
Reference in New Issue
Block a user