PlatformIO IDE for VScode¶

Setting Up the Project¶

1. Create empty directory (or use existing) and open it via File > Open...

2. Initialize PlatformIO Project using one of these methods:

   • Run “Initialize or Update Project” command using ctrl+alt+i hotkey

   • Launch “VS Code Menu: View > Command Palette…” or use hotkey Ctrl+Shift+P (Cmd+Shift+P for macOS), search for PlatformIO: Initialize or Update Project, and press enter

3. Select a board. You can change it any time in Project Configuration File platformio.ini or add new using the same PlatformIO: Initialize or Update Project command.

4. Create FREE PIO Account which opens access to extra features, such as:

   • PIO Unified Debugger

   • PIO Unit Testing

   • PIO Remote™

Please open PIO Terminal using PlatformIO Toolbar

• Create new PIO Account with platformio account register command

• Use temporary password from received e-mail and login with platformio account login command

• Change temporary password using platformio account password command

5. Create New File named main.cpp in src folder

6. Copy the next source code to the just created file main.cpp

/**
 * 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);
}

7. Build your project with ctrl+alt+b hotkey (see all Key Bindings in “User Guide” section below)

8. Learn more about PlatformIO Toolbar and other commands (Upload, Clean, Serial Monitor, Library Manager, Run Other Tasks) in “User Guider” section.

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).

• PlatformIO: Build

• PlatformIO: Upload

• PlatformIO: Clean

• PlatformIO: Run Other Tasks

• Initialize new PlatformIO Project or Update existing…

• Library Manager

• Serial Port Monitor

• PIO Terminal

Key Bindings: Building / Uploading / Other Tasks¶

• ctrl+alt+i Initialize or Update Project

• 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

• ctrl+alt+t Run Other Tasks (Upload using Programmer, Upload SPIFFS image, Test Project, Update packages and libraries, Upgrade PlatformIO Core)

Extension Settings¶

Serial Port Monitor¶

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

• monitor_port

• monitor_baud

• monitor_rts

• monitor_dtr

Example:

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

; Custom Serial Monitor port
monitor_port = /dev/ttyUSB1

; Custom Serial Monitor baud rate
monitor_baud = 115200

Install Shell Commands¶

Please navigate to FAQ Install PIO Core Shell Commands.

PIO Account¶

Create FREE PIO Account which opens access to extra features, such as:

• PIO Unified Debugger

• PIO Unit Testing

• PIO Remote™

Please open PIO Terminal using PlatformIO Toolbar

• Create new PIO Account with platformio account register command

• Use temporary password from received e-mail and login with platformio account login command

• Change temporary password using platformio account password command