Skip to content

Arduino Installation

Renaud GASPARD edited this page Mar 18, 2023 · 17 revisions

In order to be able to flash an Arduino firmware you will need to install arduino-cli. arduino-cli is a lightweight command line tool to work with Arduino sketches.

Installation via the plugin settings (recommended)

Starting with version 1.0.0 of the plugin, there is now a way to automatically install arduino-cli from the plugin settings.

This is the recommended way of installing arduino-cli for the plugin.

To this, simply go in the Settings (little wrench icon a the top of OctpPrint). Then go into the Marlin Flasher settings, select Arduino and then click the "Download and install" button.

Wait until the installation complete. Once it's installed, you can closed the popup with the installation log. The path to arduino-cli had been automatically set, you can now save the settings. Arduino-cli is now installed and ready to use

Manual installation (not recommended)

If you want to have more control on how arduino-cli will be installed, you can install it manually. This is not the recommended way of installing arduino-cli.

Download

arduino-cli can be download from the official GitHub page. Currently, only versions from 0.18.x up to 0.31.x are supported by the plugin. There are a few links depending of the environment you will be running it on (Windows, Linux, ...). Pick the one that will work for you. If you are using a Rasberry Pi, you should use the Linux_ARMv6 version. Download it and extract it somewhere on the system that runs OctoPrint. On Linux, I like to place it in the /opt directory. Just remember where you did place it.

Install script

arduino-cli comes with an install script. While it may work well, I would go against using it as it will install the latest version available, which may not be supported by the plugin at the time.