Ameba ARDUINO: Getting Started with RTL8722
Required Environment
AmebaD RTL8722CSM/RTL8722DM board currently supports Windows OS 32-bits and 64-bits (WIN7/8/10), Linux OS (Ubuntu 18 LTS/20 LTS/latest) and macOS operating systems. Please use the latest OS version to have the best experiences. In this documentation, please use the latest version Arduino IDE (at least version 1.8.12).
Introduction to AmebaD RTL8722CSM/RTL8722DM
Ameba is an easy-to-program platform for developing all kind of IoT applications. AmebaD is equipped with various peripheral interfaces, including WiFi, GPIO INT, I2C, UART, SPI, PWM, ADC. Through these interfaces, AmebaD can connect with electronic components such as LED, switches, manometer, hygrometer, PM2.5 dust sensors, …etc.
The collected data can be uploaded via WiFi and be utilized by applications on smart devices to realize IoT implementation.
AmebaD and Arduino Uno have similar size, as shown in the above figure, and the pins on AmebaD are compatible with Arduino Uno.
AmebaD uses Micro USB to supply power, which is common in many smart devices.
Please refer to the following figure and table for the pin diagram and function of AmebaD.
| PIN name | GPIO INT | ADC | PWM | UART | SPI | I2C | |
| D0 | GPIOB_2 | ✓ | A5 | UART3_RX(b) | |||
| D1 | GPIOB_1 | ✓ | A4 | UART3_TX(b) | |||
| D2 | GPIOB_3 | ✓ | A6 | ||||
| D3 | GPIOB_31 | ✓ | |||||
| D4 | GPIOB_30 | ✓ | |||||
| D5 | GPIOB_28 | ✓ | |||||
| D6 | GPIOB_29 | ✓ | |||||
| D7 | NC | ||||||
| D8 | GPIOB_22 | ✓ | ✓ | ||||
| D9 | GPIOB_23 | ✓ | ✓ | ||||
| D10 | GPIOB_21 | ✓ | ✓ | UART0_RTS(b) | SPI0_CS | ||
| D11 | GPIOB_18 | ✓ | ✓ | UART0_RX(b) | SPI0_MOSI | ||
| D12 | GPIOB_19 | ✓ | ✓ | UART0_TX(b) | SPI0_MISO | ||
| D13 | GPIOB_20 | ✓ | ✓ | UART0_CTS(b) | SPI0_CLK | ||
| D14 | GPIOA_7 | ✓ | UART2_TX(log) | ||||
| D15 | GPIOA_8 | ✓ | UART2_RX(log) | ||||
| D16 | GPIOA_25 | ✓ | ✓ | UART3_RX(a) | I2C0_SCL | ||
| D17 | GPIOA_26 | ✓ | ✓ | UART3_TX(a) | I2C0_SDA | ||
| D18 | GPIOB_7 | ✓ | A3 | ✓ | SPI1_CS | ||
| D19 | GPIOB_6 | ✓ | A2 | SPI1_CLK | |||
| D20 | GPIOB_5 | ✓ | A1 | ✓ | SPI1_MISO | ||
| D21 | GPIOB_4 | ✓ | A0 | ✓ | SPI1_MOSI | ||
| D22 | GPIOA_28 | ✓ | |||||
| D23 | GPIOA_24 | ✓ | ✓ | UART0_CTS(a) | I2C1_SDA | ||
| D24 | GPIOA_23 | ✓ | ✓ | UART0_RTS(a) | I2C1_SCL | ||
| D25 | GPIOA_22 | ✓ | UART0_RX(a) | ||||
| D26 | GPIOA_21 | ✓ | UART0_TX(a) | ||||
| D27 | GPIOA_20 | ✓ | |||||
| D28 | GPIOA_19 | ✓ |
Setting up Development Environment
Step 1. Installing the Driver
First, connect AmebaD to the computer via Micro USB:
If this is the first time you connect AmebaD to your computer, the USB driver for AmebaD will be automatic installed.
If you have driver issue of connect board to your computer please go to https://ftdichip.com/drivers/ for USB driver.
You can check the COM port number in Device Manager of your computer:
Step 2. Set up Arduino IDE
From version 1.6.5, Arduino IDE supports third-party hardware. Therefore, we can use Arduino IDE to develop applications on AmebaD, and the examples of Arduino can run on AmebaD too. Arduino IDE can be downloaded in the Arduino website:
https://www.arduino.cc/en/Main/Software
When the installation is finished, open Arduino IDE. To set up AmebaD correctly in Arduino IDE, go to “File” -> “Preferences”
And paste the following URL into “Additional Boards Manager URLs” field:
https://github.com/ambiot/ambd_arduino/raw/master/Arduino_package/package_realtek.com_amebad_index.json
Next, go to “Tools” -> “Board” -> “Boards Manager”:
The “Boards Manager” requires about 10~20 seconds to refresh all hardware files (if the network is in bad condition, it may take longer). Every time the new hardware is connected, we need to reopen the Board Manager. So, we close the Boards Manager, and then open it again. Find “Realtek Ameba Boards” in the list, click “Install”, then the Arduino IDE starts to download required files for AmebaD.
If you are facing GitHub downloading issue, please refer to the following link at “Download/Software Development Kit”. There are 3 sections.
1. “AmebaD_Arduino_patch1_SDK”, please select at least 1 of the SDKs. There are 5 latest released SDK options.
2. “AmebaD_Arduino_patch2_Tools”, please select according to your operation system. There are Windows, Linux and MacOS.
3. “AmebaD_Arduino_Source_Code”, this section is optional download only wants to refer the latest source code.
https://www.amebaiot.com.cn/en/ameba-arduino-summary/
Download the files selected, then unzip (patch1 and patch2 are compulsory). There are “Install.doc”/“Install.pdf” for you to refer installation steps. According to your system, please run the installation tool in the “Offline_SDK_installation_tool” folder.
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 for AmebaD.
Finally, we select AmebaD as current connected board in “tools” -> “Board” -> “Arduino AmebaD”：
Try the First Example
Step 1. Compile & Upload
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.
Open “File” -> “Examples” -> “01.Basics” -> “Blink”:
Arduino IDE opens a new window with the complete sample code.
Next, we compile the sample code directly; click “Sketch” -> “Verify/Compile”
Arduino IDE prints the compiling messages in the bottom area of the IDE window. When the compilation is finished, you will get the message similar to the following figure:
Afterwards, we will upload the compiled code to AmebaD.
Please make sure AmebaD is connected to your computer, then click “Sketch” -> “Upload”.
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. There is a 5-seconds count down set as a reminder to enter the upload mode.
It is optional for users to check if the board entered the upload mode. Open serial monitor/terminal and look for “#Flash Download Start”. Note, it is normal that some serial terminals may show unknown characters as following picture.
Again, during the uploading procedure the IDE prints messages. Uploading procedure takes considerably longer time (about 30 seconds to 1 minute). When upload completed, the “Done uploading” message is printed.
Step 2.Run the Blink example
In each example, Arduino not only provides sample code, but also detailed documentation, including wiring diagram, sample code explanation, technical details, …etc. These examples can be directly used on AmebaD.
So, we find the detailed information of the Blink example:
https://www.arduino.cc/en/Tutorial/Blink
In short, this example makes LED blinks, and it uses GPIO pin 08 (refer to the pin diagram D08). Then we connect the LED and resistance as the following figure:
（NOTE: In an LED, the longer pin is the positive pole, and shorter pin is the negative pole. So we connect the longer pin to D08, and connect the shorter pin to GND. In addition, please use a resister with suitable resistance in series between LED and GND to protect LED）
Finally, press the RESET button, and you can see the LED blinking.
If you encounter any problem, please refer to Trouble-shooting.
