Skip to content

Commit 8fe3099

Browse files
M-ichae-lM-ichae-l
committed
Update Getting Started with Ameba.rst
1 parent cc3858b commit 8fe3099

File tree

1 file changed

+80
-66
lines changed

1 file changed

+80
-66
lines changed

‎source/ameba_pro2/amb82-mini/Getting_Started/Getting Started with Ameba.rst

Lines changed: 80 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -118,26 +118,26 @@ Step 3. Set up Arduino IDE
118118

119119
From version 1.6.5, Arduino IDE supports third-party hardware. Therefore, we can use Arduino IDE to develop applications, and the Arduino basic examples are supported. Arduino IDE can be downloaded in the Arduino website: https://www.arduino.cc/en/Main/Software
120120

121-
When the installation is finished, open Arduino IDE. To set up correctly in Arduino IDE, go to “File” -> “Preferences”
121+
When the installation is finished, open Arduino IDE. To set up correctly in Arduino IDE, go to "File" -> "Preferences"
122122

123123
|image05|
124124

125-
And paste the following URL into “Additional Boards Manager URLs” field: https://github.com/ambiot/ambpro2_arduino/raw/main/Arduino_package/package_realtek_amebapro2_index.json
125+
And paste the following URL into "Additional Boards Manager URLs" field: https://github.com/ambiot/ambpro2_arduino/raw/main/Arduino_package/package_realtek_amebapro2_index.json
126126
or https://ameba-doc-arduino-sdk-json.readthedocs-hosted.com/en/latest/_static/package_realtek_amebapro2_early_index_rtd.json
127127

128-
Next, go to “Tools” -> “Board” -> “Boards Manager”:
128+
Next, go to "Tools" -> "Board" -> "Boards Manager":
129129

130130
|image06|
131131

132-
The “Boards Manager” requires about 10~20 seconds to refresh all hardware files (if the network is in bad condition, it may take longer).
132+
The "Boards Manager" requires about 10~20 seconds to refresh all hardware files (if the network is in bad condition, it may take longer).
133133

134-
Every time the new hardware is connected, we need to reopen the Board Manager. Find “Realtek Ameba Boards” in the list, click “Install”, then the Arduino IDE starts to download required files.
134+
Every time the new hardware is connected, we need to reopen the Board Manager. Find "Realtek Ameba Boards" in the list, click "Install", then the Arduino IDE starts to download required files.
135135

136136
|image07|
137137

138-
After the installation tool running successfully, you may open Arduino IDE and proceed to “tools” -> “Board“ -> “Boards Manager…”. Try to find “Realtek Ameba Boards” in the list, click “Install”, then the Arduino IDE starts to download required files.
138+
After the installation tool running successfully, you may open Arduino IDE and proceed to "tools" -> "Board" -> "Boards Manager…". Try to find "Realtek Ameba Boards" in the list, click "Install", then the Arduino IDE starts to download required files.
139139

140-
Finally, we select board in “tools” -> “Board” -> “AmebaPro2 ARM (32-bits) Boards” -> “AMB82-MINI”
140+
Finally, we select board in "tools" -> "Board" -> "AmebaPro2 ARM (32-bits) Boards" -> "AMB82-MINI"
141141

142142
|image08|
143143

@@ -151,72 +151,86 @@ There are many different Modes for user to select for different settings of comp
151151

152152
|image09|
153153

154-
+----------------------------------+---------------------------------------------+-------------+
155-
| **Mode Name** | **Usage** | **Remarks** |
156-
+==================================+=============================================+=============+
157-
| \* Auto Flash Mode | - Disable. Manual process to enter flash | |
158-
| | mode. | |
159-
| | | |
160-
| | - Enable. Auto process to enter flash mode. | |
161-
+----------------------------------+---------------------------------------------+-------------+
162-
| \* Camera Options | - JFX37. Use the camera sensor JFX37. | |
163-
| | | |
164-
| | - GC5035. Use the camera sensor GC5035. | |
165-
| | | |
166-
| | - JFX53. Use the camera sensor JFX53. | |
167-
| | | |
168-
| | - IMX327. Use the camera sensor IMX327. | |
169-
| | | |
170-
| | - PS5268. Use the camera sensor PS5268. | |
171-
+----------------------------------+---------------------------------------------+-------------+
172-
| \* Erase All Flash Memory (16MB) | - Disable. No erash flash process. | |
173-
| | | |
174-
| | - Erase only. Erase entire flash. | |
175-
| | | |
176-
| | - Erase then Upload. Erase entire flash | |
177-
| | then upload the current application. | |
178-
+----------------------------------+---------------------------------------------+-------------+
179-
| \* Camera FCS Mode | - Disable. No Camera FCS mode process. | |
180-
| | | |
181-
| | - Enable. Enable Camera FCS mode, if the | |
182-
| | camera sensor has FCS mode. | |
183-
+----------------------------------+---------------------------------------------+-------------+
184-
| \* NN Model Load From | - Flash. Load the Neural Network AI model | |
185-
| | from flash memory. | |
186-
| | | |
187-
| | - SD Card. Load the Neural Network AI model | |
188-
| | from SD card memory. Total size of the | |
189-
| | models depend on the total size of the SD | |
190-
| | card. | |
191-
+----------------------------------+---------------------------------------------+-------------+
192-
| \* OTA Mode | - Disable. No OTA mode process. | |
193-
| | | |
194-
| | - Enable. Enable OTA mode. | |
195-
+----------------------------------+---------------------------------------------+-------------+
196-
| \* Standard Lib | - Arduino_STD_PRINTF. Choose the standard | |
197-
| | library function for compile and upload. | |
198-
| | | |
199-
| | - Disable. No standard library function. | |
200-
+----------------------------------+---------------------------------------------+-------------+
201-
| \* Upload Speed | - 2000000. Upload baud rate set as 2000000. | |
202-
| | | |
203-
| | - 1000000. Upload baud rate set as 1000000. | |
204-
| | | |
205-
| | - 230400. Upload baud rate set as 230400. | |
206-
+----------------------------------+---------------------------------------------+-------------+
154+
+----------------------------------+-------------------------------------------------+-------------+
155+
| **Mode Name** | **Usage** | **Remarks** |
156+
+==================================+=================================================+=============+
157+
| \* Auto Flash Mode | - *Disable* Manual process to enter flash mode. | |
158+
| | | |
159+
| | - *Enable* Auto process to enter flash mode. | |
160+
+----------------------------------+-------------------------------------------------+-------------+
161+
| \* Upload Speed | - *2000000* Upload baud rate set as 2000000. | |
162+
| | | |
163+
| | - *1000000* Upload baud rate set as 1000000. | |
164+
| | | |
165+
| | - *230400* Upload baud rate set as 230400. | |
166+
+----------------------------------+-------------------------------------------------+-------------+
167+
| \* Erase All Flash Memory (16MB) | - *Disable* No erash flash process. | |
168+
| | | |
169+
| | - *Erase only* Erase entire flash. | |
170+
| | | |
171+
| | - *Erase then Upload* Erase entire flash then | |
172+
| | upload the current application. | |
173+
+----------------------------------+-------------------------------------------------+-------------+
174+
| \* Camera Options | - *JFX37* Use the camera sensor JFX37. | |
175+
| | | |
176+
| | - *JFX53* Use the camera sensor JFX53. | |
177+
| | | |
178+
| | - *GC2053* Use the camera sensor GC2053. | |
179+
| | | |
180+
| | - *GC4653* Use the camera sensor GC4653. | |
181+
| | | |
182+
| | - *GC5035* Use the camera sensor GC5035. | |
183+
| | | |
184+
| | - *IMX307* Use the camera sensor IMX307. | |
185+
| | | |
186+
| | - *IMX327* Use the camera sensor IMX327. | |
187+
| | | |
188+
| | - *IMX662* Use the camera sensor IMX662. | |
189+
| | | |
190+
| | - *PS5268* Use the camera sensor PS5268. | |
191+
| | | |
192+
| | - *OV9734* Use the camera sensor OV9734. | |
193+
| | | |
194+
| | - *SC2336* Use the camera sensor SC2336. | |
195+
+----------------------------------+-------------------------------------------------+-------------+
196+
| \* Camera FCS Mode | - *Disable* No Camera FCS mode process. | |
197+
| | | |
198+
| | - *Enable* Enable Camera FCS mode, if the | |
199+
| | camera sensor has FCS mode. | |
200+
+----------------------------------+-------------------------------------------------+-------------+
201+
| \* NN Model Load From | - *Flash* Load the Neural Network AI model from | |
202+
| | flash memory. | |
203+
| | | |
204+
| | - *SD Card* Load the Neural Network AI model | |
205+
| | from SD card memory. Total size of the models | |
206+
| | depend on the total size of the SD card. | |
207+
+----------------------------------+-------------------------------------------------+-------------+
208+
| \* Show NN Logs | - *Enable* Show NN related debug logs. | |
209+
| | | |
210+
| | - *Disable* Do not show NN related debug logs. | |
211+
+----------------------------------+-------------------------------------------------+-------------+
212+
| \* OTA Mode | - *Disable* No OTA mode process. | |
213+
| | | |
214+
| | - *Enable* Enable OTA mode. | |
215+
+----------------------------------+-------------------------------------------------+-------------+
216+
| \* Standard Lib | - *Arduino_STD_PRINTF* Choose the standard | |
217+
| | library function for compile and upload. | |
218+
| | | |
219+
| | - *Disable* No standard library function. | |
220+
+----------------------------------+-------------------------------------------------+-------------+
207221

208222
Step 2. Compile
209223
~~~~~~~~~~~~~~~
210224

211-
Arduino IDE provides many built-in examples, which can be compiled, uploaded, and run directly on the boards. Here, we take the “Blink” example as the first try.
225+
Arduino IDE provides many built-in examples, which can be compiled, uploaded, and run directly on the boards. Here, we take the "Blink" example as the first try.
212226

213-
Open “File” -> “Examples” -> “01.Basics” -> “Blink”:
227+
Open "File" -> "Examples" -> "01.Basics" -> "Blink":
214228

215229
|image10|
216230

217231
Arduino IDE opens a new window with the complete sample code.
218232

219-
Next, we compile the sample code directly; click “Sketch” -> “Verify/Compile”
233+
Next, we compile the sample code directly; click "Sketch" -> "Verify/Compile"
220234

221235
Arduino IDE prints the compiling messages in the bottom area of the IDE window. When the compilation is finished, you will get the message as following.
222236

@@ -227,19 +241,19 @@ Afterwards, we will upload the compiled code to board.
227241
Step 3. Upload
228242
~~~~~~~~~~~~~~
229243

230-
Please make sure board is connected to computer, then click “Sketch” -> “Upload”.
244+
Please make sure board is connected to computer, then click "Sketch" -> "Upload".
231245

232246
The Arduino IDE will compile first then upload. Users are required to enter the upload mode of the board. To enter upload mode, first press and hold the UART_DOWNLOAD button, then press and release the RESET button, lastly release the UART_DOWNLOAD button.
233247

234-
Additionally, if the board has the hardware updates and enabled “Auto Flash Mode”, please ignore above instruction.
248+
Additionally, if the board has the hardware updates and enabled "Auto Flash Mode", please ignore above instruction.
235249

236250
|image12|
237251

238252
It is optional for users to check if the board entered the upload mode. Open serial monitor/terminal and check the following information,.
239253

240254
|image13|
241255

242-
When upload completed, the “Done uploading” message is printed.
256+
When upload completed, the "Done uploading" message is printed.
243257

244258
Step 4. Run the Blink example
245259
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)