PlatformIO IDE for VSCode¶

Installation¶

0. Download and install official Microsoft Visual Studio Code. PlatformIO IDE is built on top of it

1. Open VSCode Package Manager

2. Search for official platformio-ide extension

3. Install PlatformIO IDE.

Quick Start¶

This tutorial introduces you to the basics of PlatformIO IDE workflow and shows you a creation process of a simple “Blink” example. After finishing you will have a general understanding of how to work with projects in the IDE.

Setting Up the Project¶

1. Click on “PlatformIO Home” button on the bottom PlatformIO Toolbar

2. Click on “New Project”, select a board and create new PlatformIO Project

3. Open main.cpp file form src folder and replace its contents with the next:

Warning

The code below works only in pair with Arduino-based boards. Please follow to PlatformIO Project Examples repository for other pre-configured projects.

/**
 * Blink
 *
 * Turns on an LED on for one second,
 * then off for one second, repeatedly.
 */
#include "Arduino.h"

// Set LED_BUILTIN if it is not defined by Arduino framework
// #define LED_BUILTIN 13

void setup()
{
  // initialize LED digital pin as an output.
  pinMode(LED_BUILTIN, OUTPUT);
}

void loop()
{
  // turn the LED on (HIGH is the voltage level)
  digitalWrite(LED_BUILTIN, HIGH);

  // wait for a second
  delay(1000);

  // turn the LED off by making the voltage LOW
  digitalWrite(LED_BUILTIN, LOW);

   // wait for a second
  delay(1000);
}

4. Build your project with ctrl+alt+b hotkey (see all Key Bindings in “User Guide” section below) or using “Build” button on the PlatformIO Toolbar

Learn more about PlatformIO Toolbar and other commands (Upload, Clean, Serial Monitor) below.

Happy coding with PlatformIO!

PlatformIO Toolbar¶

PlatformIO IDE Toolbar is located in VSCode Status Bar (left corner) and contains quick access buttons for the popular commands. Each button contains hint (delay mouse on it).

1. PlatformIO Home

2. PlatformIO: Build

3. PlatformIO: Upload

4. PIO Remote™

5. PlatformIO: Clean

6. PIO Unit Testing

7. Run a task… (See “Task Runner” below)

8. Serial Port Monitor

9. PIO Terminal

Key Bindings¶

• ctrl+alt+b / cmd-shift-b / ctrl-shift-b Build Project

• cmd-shift-d / ctrl-shift-d Debug project

• ctrl+alt+u Upload Firmware

• ctrl+alt+s Open Serial Port Monitor

Task Runner¶

PlatformIO IDE provides base tasks Menu > Tasks (Build, Upload, Clean, Monitor, etc) and custom tasks per Project Configuration File platformio.ini environment ([env:***]). A default behavior is to use Terminal Panel for presentation. Also, we use dedicated panel per unique task.

PlatformIO IDE provides own Problems Matcher named $platformio. You can use it later if decide to change base task settings.

You can override existing task with own presentation options. For example, let configure PlatformIO Task Runner to use NEW Terminal panel per each “Build” command:

1. Please click on “gear” icon near “Build” task in Menu > Tasks

2. Replace template in tasks.json with this code

{
    "version": "2.0.0",
    "tasks": [
        {
            "type": "PlatformIO",
            "args": [
                "run"
            ],
            "problemMatcher": [
                "$platformio"
            ],
            "presentation": {
                "panel": "new"
            }
        }
    ]
}

See more options in official VSCode documentation.

Serial Port Monitor¶

You can customize Serial Port Monitor using Monitor options in Project Configuration File platformio.ini:

• monitor_port

• monitor_speed

• monitor_rts

• monitor_dtr

Example:

[env:esp32dev]
platform = espressif32
framework = arduino
board = esp32dev

; Custom Serial Monitor port
monitor_port = /dev/ttyUSB1

; Custom Serial Monitor speed (baud rate)
monitor_speed = 115200

Install Shell Commands¶

Please navigate to FAQ Install PlatformIO Core Shell Commands.

Settings¶

How to configure VSCode settings?

Known issues¶

Changelog¶

Please visit releases page.