Setup Arduino IDE 2.3
Arduino IDE stands out with its simple design, allowing to write a code, compile a project and upload it to the RoboBoard. This is one of the reasons why it's so popular among beginners. Aside from basic functionality, it has thousands of third-party libraries and code examples to create a project even faster.
Step 1. Download Arduino IDE
Go to Arduino website to download application for your operating system.
Install guide: Windows / MacOS / Linux
Step 2. Install Totem Boards
Install Totem Boards
extension to add support for Totem RoboBoard.
- In Arduino IDE select
File
→Preferences
. - Locate
Additional Boards Manager URLs
and paste in:
If you have multiple URLs, click a button next to input field and add this link to the bottom.https://totemmaker.github.io/TotemArduinoBoards/package_totemmaker_index.json
- Click OK.
- Open Boards Manager in side panel and type
totem
in search field. - Click Install on
Totem Boards
and wait for it to complete. It can take a few minutes.
Full tutorial how to use board manager: Using the Board Manager.
RoboBoard X4 (only)
Update motor driver firmware to latest version. See driver update guide.
Step 3. Compile and upload code
Load example code and upload it to RoboBoard.
- Connect RoboBoard to PC over USB cable and power it on.
- Click on boards field and select
Select other board and port...
- Inside new dialog search for
roboboard
and selectRoboBoard X4
(orRoboBoard X3
).
Also select USB port board is connected to and click OK - Select
File
→Examples
→> RoboBoard
→RGB
→ColorRun
. - Select
Tools
→Port
and click on the port displayed there.
IfPort
is not available - check if RoboBoard is on and plugged to PC with USB cable.
If there are multiple ports, disconnect USB cable and check which one is gone. Reconnect and select it. - Select
Sketch
→Upload
and wait till it completes (can take a few minutes first time).
Note: in case upload fails - try selecting lower speed inTools
→Upload speed
. - RoboBoard RGB will start to blink in different colors. There is an example for each functionality, including a simple description.
Full tutorial how to compile and upload code: Upload a sketch.
In case of RoboBoard X4 - make sure the battery or DC jack is connected and power switch is turned on. It won't work from USB alone!.
Step 4. Project settings
Menu option Tools
contains Board settings that can change code build and upload parameters.
- Board - board type selection
- Upload speed - firmware upload speed. Use highest, unless upload errors occur
- Erase All Flash Before Sketch Upload - fully erase ESP32 flash before new firmware upload
- Remote Control - makes RoboBoard discoverable by Totem App when selected
- Board Status - enable RoboBoard status with RGB lights and beeping
- Charging Mode - enable RoboBoard X3 charging mode
- Totem Prefix - append "totem::" prefix to every RoboBoard function Totem Prefix
- Port - USB port name RoboBoard is connected to (required for Serial Monitor and upload)
Step 5. Using Arduino IDE
For more information about getting started with Arduino, read following topics:
User interface:
- Getting Started with Arduino IDE - walk around Arduino IDE UI
- Uploading sketch with the Arduino IDE - upload compiled code to RoboBoard
- Installing libraries - install third-party libraries
- Autocomplete feature - displays code suggestions while typing
Monitor:
- Using Serial Monitor - view
Serial.print()
output - Using Serial Plotter - view plotted graphs
Code documentation:
- RoboBoard board settings - RoboBoard settings and default firmware
- RoboBoard API documentation - RoboBoard functions documentation
- Arduino code reference - Arduino functions documentation
Code examples:
- Connect GPIO and Qwiic - interface GPIO pins and Qwiic modules
- Interface with Totem App - read commands from Totem App
- RoboBoard code examples - RoboBoard specific code examples
- ESP32 code examples - ESP32 processor specific code examples
- Arduino examples / projects - general Arduino example projects
Question
Visit Support page to find more information or help from our community.