Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 2.46 KB

arduino-cli-install.md

File metadata and controls

55 lines (44 loc) · 2.46 KB

Arduino CLI Installation Guide

This guide will walk through the installation of the arduino-cli and arduino-cli-cmake-wraper components used to bridge F Prime and the Arduino buuld system. This assumes a virtual environment has been setup for your project.

Activate the project virtual environment now.

Install arduino-cli

curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=$VIRTUAL_ENV/bin sh

This command downloads arduino-cli and installs the binary into the existing (and activated) virtual environment.

Install arduino-cli-wrapper

pip install arduino-cli-cmake-wrapper

Setup arduino-cli for select Arduino boards

The following list of boards were tested. You are free to add your own board manager URL to your configuration if you are using a board that is not listed here:

  • PJRC Teensy (Teensy 3.2, Teensy 4.0, Teensy 4.1)
  • Adafruit Feather M0
  • ESP32 Dev Module
  • Raspberry Pi Pico W (RP2040)
  • Adafruit Feather RP2040
  • SparkFun Thing Plus RP2040
  • ATmega128 (with external memory, not the stock 2K memory)

Initialize the arduino-cli configuration file.

arduino-cli config init

Below are board manager URLs for select Arduino boards. You are not required to add all of these boards, but you are free to do so.

arduino-cli config add board_manager.additional_urls https://www.pjrc.com/teensy/package_teensy_index.json
arduino-cli config add board_manager.additional_urls https://adafruit.github.io/arduino-board-index/package_adafruit_index.json
arduino-cli config add board_manager.additional_urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
arduino-cli config add board_manager.additional_urls https://mcudude.github.io/MegaCore/package_MCUdude_MegaCore_index.json
arduino-cli config add board_manager.additional_urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json

Install the new board packages. Only install the ones you have added to your board manager in the previous step.

arduino-cli core update-index
arduino-cli core install teensy:avr
arduino-cli core install adafruit:samd
arduino-cli core install esp32:esp32
arduino-cli core install MegaCore:avr
arduino-cli core install rp2040:rp2040

Adding udev rules (Linux Only)

Add udev rules. Download/save the .rules files located here for your selected board(s) into /etc/udev/rules.d/.