Knowledge Base

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Command-Line Arduino ======

===== Prerequisites =====

Install Arduino tools:

<code bash>
sudo apt install --reinstall arduino
</code>

Make sure your user id is in the “dialout” group.

===== Installation =====

The easiest way to install the Arduino command line utility is to download the latest release package from [[https://github.com/arduino/arduino-cli/releases|here]], and just extract it into a directory in your path. It’s a single executable (built with [[https://golang.org/|Go]]), so it won’t clutter things up.

===== Getting Started =====

I used [[https://arduino.github.io/arduino-cli/getting-started/|this]] as a reference. It has a lot more detail.

==== Configuration File ====

Before you run for the first time, create a configuration file:

<code bash>
arduino-cli config init
</code>

==== Create Sketch / Add Some Code ====

Create a new sketch:

<code bash>
arduino-cli sketch new MyFirstSketch
</code>

A boilerplate sketch file is generated for you:

<file c MyFirstSketch.ino>
void setup() {
}
    
void loop() {
}
</file>

Edit the generated file, and fill in some details:

<file c MyFirstSketch.ino>
void setup() {
    pinMode(LED_BUILTIN, OUTPUT);
}
 
void loop() {
    digitalWrite(LED_BUILTIN, HIGH);
    delay(1000);
    digitalWrite(LED_BUILTIN, LOW);
    delay(1000);
}
</file>

==== Connect a Board ====

Update local cache of available platforms:

<code bash>
arduino-cli core update-index
</code>

After connecting your board, check to see if it’s recognized:

<code bash>
arduino-cli board list
</code>

Result should look something like this (I’m using an Uno):

<code>
Port         Type              Board Name  FQBN            Core       
/dev/ttyACM0 Serial Port (USB) Arduino Uno arduino:avr:uno arduino:avr
</code>

Install the core for your board (refer to the first two segments of the FQBN):

<code bash>
arduino-cli core install arduino:avr
</code>

==== Compile and Upload the Sketch ====

Compile:

<code bash>
arduino-cli compile --fqbn arduino:avr:uno MyFirstSketch
</code>

Upload:

<code bash>
arduino-cli upload -p /dev/ttyACM0 --fqbn arduino:avr:uno MyFirstSketch
</code>

===== Makefile =====

This Makefile simplifies the compile and upload steps, and adds format, reset, and clean commands:

<file make Makefile>
ARDCMD=arduino-cli
FQBNSTR=arduino:avr:uno
PORT=/dev/ttyACM0
SKETCHNAME=MyFirstSketch
FORMATTER=clang-format -i
 
default:
	@echo 'Targets:'
	@echo '  compile  -- Compile sketch, but don''t upload it.'
	@echo '  upload   -- Compile and upload sketch.'
	@echo '  format   -- Beautify your sketch code.'
	@echo '  reset    -- Use to resolve Device Busy error.'
	@echo '  clean    -- Remove binaries and object files.'
 
compile:
	$(ARDCMD) compile --fqbn $(FQBNSTR) $(SKETCHNAME)
 
upload: compile
	$(ARDCMD) upload -p $(PORT) --fqbn $(FQBNSTR) $(SKETCHNAME)
 
format:
	$(FORMATTER) $(SKETCHNAME)/$(SKETCHNAME).ino
 
reset:
	fuser -k $(PORT)
 
clean:
	-rm -f $(SKETCHNAME)/*.hex
	-rm -f $(SKETCHNAME)/*.elf
</file>

{{tag>embedded_and_iot}}