CrcLib Basic Programs
- David Martin (Unlicensed)
- CRC Volunteer
- Xavier L'Heureux
This page presents the most basic programs that should first be tried out by every program when first getting their hands on a CrcDuino.
Minimal program
The following details the code lines that should be minimally used in every program that uses CrcLib.
#include <CrcLib.h>
void setup()
{
CrcLib::Initialize();
}
void loop()
{
CrcLib::Update();
}
//Lines starting with 2 slashes won't be compiled; they are comments.
/*This is a way
to comment multiple lines of code */
Let's go through this line by line to figure out exactly why all this is here:
#include <CrcLib.h>This is how Arduino IDE loads the CrcLib when compiling the code, allowing the use use its functions. This will of course only work if the library as first been properly installed as detailed here.
using namespace Crc;
Once upon a time, using namespace Crc was needed at the top of every program. Since it was only boilerplate, this requirement has been removed. You might still stumble on some relics of the past, and in that case, simply remove this line at the top of the file.
void setup()
{
//The code executed once at power-up
}The "setup" function is Arduino-specific. All the lines in the brackets right after it will be executed only once, when the CrcDuino is powered up.
This call must be made in order to properly set up everything in order for CrcLib functions to be executed properly.
The “loop” function is Arduino-specific. All the lines in the brackets right after it will be executed cyclically as long as the CrcDuino is powered up.
This call must be made in order to periodically update CrcLib data, including the remote controller state.
Using the Arduino IDE serial monitor
The Arduino serial monitor is a very useful tool that every programmer should be able to use when debugging their CrcDuino program. It allows the the CrcDuino to print messages to a computer screen. It can be used, for example, to confirm that a sensor state is read correctly by the CrcDuino. It most be opened in Arduino IDE to be used.
Running a program with serial printing can dramatically slows its execution time, resulting in slower response time and greater power consumption.
Serial printing should therefore only be used for debugging and should be removed from the program executed during the Crc Robotics Competition playing game.