Sublime Text¶

Deviot Plugin¶

We are glad to inform you about awesome Sublime Text plugin for IoT development named Deviot. It is based on PlatformIO Core and will automatically install it for you. Please visit official Deviot page for the further installation steps and documentation.

Project Generator¶

Choose board ID using platformio boards or Embedded Boards Explorer command and generate project via platformio init --ide command:

platformio init --ide sublimetext --board <ID>

# For example, generate project for Arduino UNO
platformio init --ide sublimetext --board uno

Then:

1. Import project via Menu: Project > Open Project... and select platformio.sublime-project from the folder where is located Project Configuration File platformio.ini

2. Select PlatformIO as build system: Menu: Tools > Build System > PlatformIO

3. Open source file from src directory (*.c, *.cpp, *.ino, etc.)

4. Build project: Menu: Tools > Build.

Also, you can access to all pre-configured targets via Menu: Tools > Builds With... (ST3)

• PlatformIO - Build - Build project without auto-uploading

• PlatformIO - Clean - Clean compiled objects.

• PlatformIO - Test - Unit Testing

• PlatformIO - Upload - Build and upload (if no errors)

• PlatformIO - Upload using Programmer see Upload using Programmer

• PlatformIO - Upload SPIFFS image see Uploading files to file system SPIFFS

• PlatformIO - Update platforms and libraries - Update installed platforms and libraries via platformio update.

Manual Integration¶

Initial configuration¶

First of all, we need to create “New Build System” with name “PlatformIO” from Menu: Tools > Build System > New Build System and fill it like described below:

{
    "cmd": ["platformio", "-f", "-c", "sublimetext", "run"],
    "working_dir": "${project_path:${folder}}",
    "variants":
    [
        {
            "name": "Clean",
            "cmd": ["platformio", "-f", "-c", "sublimetext", "run", "--target", "clean"]
        },
        {
            "name": "Upload",
            "cmd": ["platformio", "-f", "-c", "sublimetext", "run", "--target", "upload"]
        }
    ]
}

Secondly, we need to select “PlatformIO” Build System from a list:

After that, we can use the necessary commands from Menu: Tools > Command Palette or with Ctrl+Shift+P (Windows/Linux) Cmd+Shift+P (Mac) shortcut.

Command Hotkeys¶

Sublime Text allows to bind own hotkey per command. Let’s setup them for PlatformIO commands using shortcut Menu: Preferences > Key-Bindings - User:

We are going to use these shortcuts:

• F11 for clean project

• F12 for upload firmware to target device

In this case, the final code will look like:

[
    { "keys": ["f11"], "command": "build", "args": {"variant": "Clean"} },
    { "keys": ["f12"], "command": "build", "args": {"variant": "Upload"} }
]

#include "Arduino.h"
#define WLED    13  // Most Arduino boards already have an LED attached to pin 13 on the board itself

void setup()
{
  pinMode(WLED, OUTPUT);  // set pin as output
}

void loop()
{
  digitalWrite(WLED, HIGH);  // set the LED on
  delay(1000);               // wait for a second
  digitalWrite(WLED, LOW);   // set the LED off
  delay(1000);               // wait for a second
}

; PlatformIO Project Configuration File
;
;   Build options: build flags, source filter, extra scripting
;   Upload options: custom port, speed and extra flags
;   Library options: dependencies, extra library storages
;
; Please visit documentation for the other options and examples
; http://docs.platformio.org/en/stable/projectconf.html

[env:arduino_uno]
platform = atmelavr
framework = arduino
board = uno

“Blink” Project¶

Source code of Sublime Text “Blink” Project.