How to use the command 'arduino' (with examples)

The arduino command is a versatile tool used to interface with the Arduino platform via its Integrated Development Environment (IDE). It allows users to compile, upload and manage sketches (programs) on various Arduino boards, control preferences, and install necessary libraries. These features help streamline the development and deployment processes in Arduino projects, enabling efficient use of resources and time.

Build a sketch

Code:

arduino --verify path/to/file.ino

Motivation:
Verifying a sketch is crucial for anyone working with Arduino as it ensures that your code is free of syntax errors and ready for execution. This command helps developers catch issues in the code before any attempt is made to upload it onto a board, potentially preventing hardware miscommunication or unexpected behavior.

Explanation:

• arduino: Invokes the Arduino command line interface.
• --verify: This argument checks the syntax and logic of your code without uploading it. It essentially compiles the sketch.
• path/to/file.ino: Specifies the path to the sketch file you want to verify. The .ino file is the standard file type for Arduino sketches.

Example Output:
Upon successful verification, you might see an output similar to this:

Sketch uses 928 bytes (2%) of program storage space. Maximum is 32,256 bytes.
Global variables use 9 bytes (0%) of dynamic memory, leaving 2,039 bytes for local variables. Maximum is 2,048 bytes.

If there are errors, the output would detail those issues to be corrected.

Build and upload a sketch

Code:

arduino --upload path/to/file.ino

Motivation:
Uploading a verified sketch to an Arduino board is the next step after writing and verifying your code. This process transfers the sketch onto the board, allowing it to begin executing. This is essential for testing the sketch on the actual hardware.

Explanation:

• arduino: Initiates the Arduino command line tool.
• --upload: This argument compiles the code and uploads it to the connected Arduino hardware if there are no errors.
• path/to/file.ino: Indicates the path to the sketch being uploaded.

Example Output:
The command’s successful execution results in an output similar to:

Sketch uses 928 bytes (2%) of program storage space. Maximum is 32,256 bytes.
Global variables use 9 bytes (0%) of dynamic memory, leaving 2,039 bytes for local variables. Maximum is 2,048 bytes.
Uploading complete!

Build and upload a sketch to an Arduino Nano with an Atmega328p CPU, connected on port /dev/ttyACM0

Code:

arduino --board arduino:avr:nano:cpu=atmega328p --port /dev/ttyACM0 --upload path/to/file.ino

Motivation:
Different Arduino boards have different specifications and might require specific settings for successful uploads. This example is tailored for an Arduino Nano with an Atmega328p CPU, a common configuration. The specific port designation ensures that the communication between your computer and the Arduino board is correctly set up.

Explanation:

• arduino: Activates the Arduino command line utility.
• --board arduino:avr:nano:cpu=atmega328p: Specifies the type of board and its CPU for which the sketch is being uploaded. This ensures that the compiled code matches the board’s architecture.
• --port /dev/ttyACM0: Defines the communication port to which the Arduino is connected. This may change depending on the system configuration.
• --upload: Indicates that the sketch should be uploaded to the board after a successful build.
• path/to/file.ino: The sketch file to be uploaded.

Example Output:
Upon successful execution, you should see a clear notification:

Sketch uses 928 bytes (2%) of program storage space. Maximum is 30,720 bytes.
Global variables use 9 bytes (0%) of dynamic memory, leaving 2,039 bytes for local variables. Maximum is 2,048 bytes.
Uploading complete on /dev/ttyACM0!

Set the preference name to a given value

Code:

arduino --pref name=value

Motivation:
Setting and modifying preferences in the Arduino IDE environment facilitates customization based on user needs or project requirements. Preferences might control things like custom board configurations, programmer settings, or debugging outputs.

Explanation:

• arduino: Initiates the Arduino command operation.
• --pref name=value: Assigns a new value to a specified preference, name, allowing users to customize their environment or development settings. Replace name with the preference’s key, and value with the desired value.

Example Output:
This command may not necessarily provide an output but affects the operation of the Arduino environment. Users might notice changes in their development setup upon running the IDE again.

Build a sketch, put the build results in the build directory, and reuse any previous build results in that directory

Code:

arduino --pref build.path=path/to/build_directory --verify path/to/file.ino

Motivation:
Using a designated build directory enables efficient use of resources by conserving time through reusing previous build artifacts. This is particularly helpful in large projects where recompilation from scratch may take significant time.

Explanation:

• arduino: Launches Arduino’s command line.
• --pref build.path=path/to/build_directory: Specifies a directory for storing the compilation outputs. If subsequent builds are attempted, previous outputs from this path can be reused, speeding up the process.
• --verify: Checks the sketch’s syntax and logic, compiling the program without uploading.
• path/to/file.ino: The sketch file intended for build and verification.

Example Output:
A finished process might yield the following lines:

Using previous build results from path/to/build_directory
Sketch uses 928 bytes (2%) of program storage space. Maximum is 32,256 bytes.
Global variables use 9 bytes (0%) of dynamic memory, leaving 2,039 bytes for local variables. Maximum is 2,048 bytes.

Save any (changed) preferences to preferences.txt

Code:

arduino --save-prefs

Motivation:
Saving modified preferences ensures that your changes in the setup persist across sessions, providing a consistent development environment. This command is instrumental for retaining user configurations or when setting up a system for multiple developers.

Explanation:

• arduino: Begins the operation with the Arduino CLI.
• --save-prefs: Saves any currently modified preferences to the preferences.txt file, preserving them for future use.

Example Output:
Like setting preferences, saving them may not yield an explicit output but ensures configurations will not reset when the Arduino IDE is restarted.

Install the latest SAM board

Code:

arduino --install-boards "arduino:sam"

Motivation:
The installation of board support packages is essential when expanding your project to new hardware. Installing the latest SAM boards via command means developers can quickly prepare their environment for ARM-based Arduino boards like the Arduino Due.

Explanation:

• arduino: Starts the Arduino IDE operation via its command line.
• --install-boards "arduino:sam": Specifies that the latest versions of the SAM boards should be downloaded and installed. This encompasses all the necessary files and tools for development on these boards.

Example Output:
Upon success, you might observe:

Downloading packages for arduino:sam
Installing arduino:sam tools and core packages
Installation complete!

Install Bridge and Servo libraries

Code:

arduino --install-library "Bridge:1.0.0,Servo:1.2.0"

Motivation:
Libraries like Bridge and Servo extend the capabilities of Arduino sketches by providing code simplifies complex tasks like network communication and servo motor control. Installing specific versions ensures compatibility and stability in existing projects reliant on these libraries.

Explanation:

• arduino: Executes the Arduino command tool.
• --install-library "Bridge:1.0.0,Servo:1.2.0": Directs the tool to install specified versions of the libraries. Bridge:1.0.0 specifies version 1.0.0 of the Bridge library, while Servo:1.2.0 refers to version 1.2.0 of the Servo library.

Example Output:
The executed command results may look like:

Library Bridge:1.0.0 is being installed
Library Servo:1.2.0 is being installed
Installation of libraries complete!

Conclusion:

Utilizing the Arduino command line tool provides developers with powerful options to efficiently manage the development lifecycle of Arduino projects. From building and uploading sketches to managing preferences and libraries, these commands grant granular control and customization options, enhancing productivity and facilitating advanced operations for both newcomers and seasoned Arduino users.