Tutorial: PlatformIO in VSCode

PreviousTutorial: PlatformIO in CLion NextTutorial: Repository Management

Last updated 6 months ago

Was this helpful?

Tutorial: PlatformIO in VSCode

Step 1: Install Python

You can install Python in Window by following the instruction here:

How to check if you already have Python

Open Window Command Prompt > Type python --version
If you see the version, then you already have python installed.
image

Step 2: Install VS Code

Step 3: Install PlatformIO Core

You may not need this step if you are going to use VS Code. But, install anyway.

Download and save it as in py file

WIN OS: In command prompt

# change directory to the folder where is located downloaded "get-platformio.py"
cd C:/path-to-dir/where/get-platformio.py/is-located

# run it
python.exe get-platformio.py

MAC OS

# change directory to the folder where is located downloaded "get-platformio.py"
cd /path-to-dir/where/get-platformio.py/is-located

# run it
python get-platformio.py

Step 4: Install PlatformIO IDE extension in VS Code

Open VS Code

Open VSCode Package Manager
Search for the official PlatformIO IDE in extension.
Install PlatformIO IDE

Step 5: Setting Up the Project in PlatformIO

Go to PlatformIO Home by clicking on the PlatformIO Icon
Create New Project

Name the project as EC or EC2024
Select Setting as follows

Board: ST Nucleo F411RE
Framework: CMSIS
Location: Your EC workspace

Step 6: Manage Environment, Build and Upload

Open VSCode and select the EC workspace folder

eg.: \repos\EC\

Go to PlatformIO Home by clicking on the PlatformIO Icon

Creating a new file

You can start your Tutorial or LAB by following the instructions given in the report.

For example, for LAB_GPIO_DIO_LED, we created the project folder and the main program file, under the workspace of ...\repos\EC\ as

Folder: \LAB\LAB_GPIO_DIO_LED\
Main src: LAB_GPIO_DIO_LED.c

For this tutorial, create the project folder and program file as

Folder: \tutorial\TU_CreateProject_VSC\
Main src 1: TU_CreateProject_Example1_main.c
Main src 2: TU_CreateProject_Example2_main.c

TU_CreateProject_Example1_main.c


#include "stm32f4xx.h"

#define LED_PIN    5
#define BUTTON_PIN 13

// LED ON or OFF 

int main(void) {
/* Part 1. RCC Register Setting */
	// RCC Control Register (HSI)
	RCC->CR |= ((uint32_t)RCC_CR_HSION);
	// wait until HSI is ready
	while ( (RCC->CR & (uint32_t) RCC_CR_HSIRDY) == 0 ) {;}
	// Select HSI as system clock source
	// RCC Configuration Register
	RCC->CFGR &= (uint32_t)((uint32_t) ~(RCC_CFGR_SW));
	RCC->CFGR |= (uint32_t)RCC_CFGR_SW_HSI;
	// Wait till HSI is used as system clock source
	while ((RCC->CFGR & (uint32_t)RCC_CFGR_SWS) != 0 ) {;}
	// HSI is used as system clock
	// RCC Peripheral Clock Enable Register
	RCC->AHB1ENR |= RCC_AHB1ENR_GPIOAEN;

/* Part 2. GPIO Register Setting */
	// GPIO Mode Register
	GPIOA->MODER &= ~(3UL<<(2*LED_PIN));
	GPIOA->MODER |=   1UL<<(2*LED_PIN);


	// Dead loop & program hangs here
	while(1){
		// Turn ON LED2
		GPIOA->ODR |= (1UL << LED_PIN);

		// Turn OFF LED2
		//GPIOA->ODR &= ~(1UL << LED_PIN);
	}
}

TU_CreateProject_Example2_main.c


#include "ecSTM32F4v2.h"
#define LED_PIN PA_5
#define BUTTON_PIN PC_13

void setup(void);

int main(void) {
	setup();

	while (1) {
		delay_ms(1000);
		GPIO_write(LED_PIN, LOW);
		delay_ms(1000);
		GPIO_write(LED_PIN, HIGH);
	}
}


// Initialiization
void setup(void) {
	RCC_PLL_init();
	SysTick_init();

	// initialize the pushbutton pin as an input:
	GPIO_init(BUTTON_PIN, INPUT);
	// initialize the LED pin as an output:
	GPIO_init(LED_PIN, OUTPUT);
}

Adding Library

You can add your EC library header files under the directory of \include

You can add it under the directory of \lib. But you need to modify the include_dir folder in platformio.ini

Creating Environment

For every new TU or LAB, you can create a new environment that shares the MCU configuration. You do not need to re-configure the MCU setup everytime you create a new project. Simply, add a new environment that links your new program main file.

For this tutorial, we will learn how to add new environments for each TU_CreateProject_Example1_main.c, and TU_CreateProject_Example2_main.c.

Modify platformio.ini in the workspace folder as

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


[platformio]
src_dir = .
include_dir = include

# Default environment setting
[env]
platform = ststm32
board = nucleo_f411re
framework = cmsis
debug_tool = stlink
build_flags = -Wl,-u,_print_float,-u,_scanf_float, -std=c11, -O3

##################################################################3
# User-Defined Environment

# For example: LAB GPIO
#[env:LAB_GPIO]
#build_src_filter = +<LAB/LAB_GPIO_DIO_LED/LAB_GPIO_DIO_LED.c> +<include/*.c>

# You can add new environments
[env:TU_CreateProject_Example1]
build_src_filter = +<tutorial/TU_CreateProject_VSC/TU_CreateProject_Example1_main.c> +<include/*.c>

[env:TU_CreateProject_Example2]
build_src_filter = +<tutorial/TU_CreateProject_VSC/TU_CreateProject_Example2_main.c> +<include/*.c>

Selecting Environment, Build and Run

Click on Switch the environment on VSCode
Select the Environment you want to build.
- For this tutorial, first select [env:TU_CreateProject_Example1]
BUILD. If you have MCU connected, you can also UPLOAD
Now, Select the other Environment that uses your EC library [env:TU_CreateProject_Example2]

Appendix

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