Skip to content
Arduino Build System for Sublime Text 3
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
CHANGELOG.md
Main.sublime-menu
README.md
arduino-cli (Linux).sublime-settings
arduino-cli (OSX).sublime-settings
arduino-cli (Windows).sublime-settings
arduino-cli.py
arduino-cli.sublime-build
arduino.tmLanguage
messages.json

README.md

Arduino Build System for Sublime Text 3

Utilizes the Arduino command line interface and as such requires Arduino to be installed.

NOTE - If you're updating from v0.0.3 you may need to alter your path to the Arduino executable, instead of the Arduino folder as in previous versions. See below for examples.

INSTALL

Use Package Control to install. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins. When the plugin list appears, type arduino-cli

USE

While viewing a .ino/.cpp/.h file in an Arduino project directory, use Command + B (or Ctrl+B) to build and upload the sketch to your board. Command + Shift + B (or Ctrl+Shift+B) lets you select to just build.

SETTINGS

Settings include:

  • path - The path to the Arduino executable, may include wildcards. eg /Applications/Arduino.app/Contents/MacOS/Arduino or "C:\Program Files*\Arduino\arduino_debug.exe"
  • board - (optional) The package:arch:board. See the Arduino CLI docs. eg arduino:avr:uno
  • port - (optional) The serialport to upload with. eg /dev/tty.usbmodem1411
  • sketchbook.path - (optional) The directory to look for additonal libraries and architectures in. eg /Users/jacobrosenthal/Documents/firmware-pinoccio/

All settings are optional with Path being set internally to likely candidate based on OS. If board and port are not specified, the arduino executable will pull the settings from those last set in the graphical IDE. However you may wish to override

You can set them two places. Use Tool->Arduino->Open User Settings. This is an example override configuration for OS X:

{
  "path": "/Applications/Arduino.app/Contents/MacOS/Arduino",
  "board": "arduino:avr:uno",
  "port": "/dev/tty.usbmodem1421"
} 

Or you can override sublime's settings on a per project basis by adding this to the root folder with the file name whatever.sublime-project and then open it to launch your project in Sublime

{
  "folders":
  [
    {
      "path": "."
    }
  ],
  "settings":
  {
    "path": "/Applications/Arduino.app/Contents/MacOS/Arduino",
    "board": "arduino:avr:uno",
    "port": "/dev/tty.usbmodem1421",
    "sketchbook.path": "/Users/jacobrosenthal/Documents/Arduino"
  }
}

TODO

Sadly I dont have the regex working yet to bring console messages into the status bar. See this issue if you think you can help

You can’t perform that action at this time.