Tutorial: PlatformIO in VSCode

Tutorial: PlatformIO in VSCode

In this class, we are going to use VS Code to program firmware on STM32f4.

Part 1: Installation

Step 1: Install Python

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

Install Python 3.x in Win OS

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

Refer to Installation-guide: VS CDOE

Step 3: Install PlatformIO Core

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

1. Download python file of PlatformIO Core: Save as (다른이름으로 링크저장): get-platformio.py

• Download and save it as in py file

WIN OS: In command prompt

# change directory to the folder where you 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 you 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

1. Open VS Code

1. Open VSCode Package Manager

2. Search for the official PlatformIO IDE in extension.

3. Install PlatformIO IDE

Part 2: Configure Project (STM32f4) / One-time only

Step 1: Create a Project in PlatformIO

1. Go to PlatformIO Home by clicking on the PlatformIO Icon

2. Create New Project

1. Name the project as EC

2. Select setting as follows

• Board: ST Nucleo F411RE

• Framework: CMSIS

• Location: Your EC workspace

Step 2: Project Configuration (platformio.ini)

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.

You only need one configuration file platformio.ini for all tutorial and assigments.

Copy this platformio.ini in the workspace folder

; 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


##################################################################
# 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>

image

Step 3: Adding Library

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

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

Part 3: Create and Add New Environment

You can start your Tutorial or LAB by following this Part 3.

Each Lab and Tutorial session will have a unique environment.

Step 1: Create a new environment and program file

1. Open VSCode and select the EC workspace folder

• i.e. : \repos\EC\

1. Go to PlatformIO Home by clicking on the PlatformIO Icon

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

• Folder: repos\EC\tutorial\TU_CreateProject_VSC\

• Main src: TU_CreateProject_Example1_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);
	}
}

Step 2. Modify the Configuration

Simply, add the new environment that links your new program main file.

[env:TU_CreateProject_Example1]

Modify platformio.ini , to add new environment

; 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,_printf_float,-u,_scanf_float -std=c11 -O3



##################################################################
# 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>

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

Step 3: Selecting Environment, Build and Run

1. Click on Switch the environment on VSCode

2. Select the Environment you want to build.

   • For this tutorial, select [env:TU_CreateProject_Example1]

3. BUILD

4. If you have MCU connected, you can also UPLOAD

image

Exercise - Add another environment

In this Exercise, we are going to add another environment, and add more library header files.

For every time you do a new LAB or Tutorial, you do NOT need to create a project.

Just add a new environment in platformio.ini and select this environment to build.

Preparation

First, download the library header files

• Library download folder: https://github.com/ykkimhgu/EC-student/tree/main/include/lib-student

• File: ecSTM32_simple.c, ecSTM32_simple.h

Save them in the include folder

See here for more information on header files: https://ykkim.gitbook.io/ec/ec-course/tutorial/tutorial-library-header-files#ec-header-files

Procedure

Repeat Part 3 (Step 1 to Step 3).

• Folder: repos\EC\tutorial\TU_CreateProject_VSC\

• Main src : TU_CreateProject_Example2_main.c

• Environment: [env:TU_CreateProject_Example2]

TU_CreateProject_Example2_main.c

//#include "ecSTM32F4v2.h"
#include "ecSTM32_simple.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);
}

Appendix

PlatformIO Toolbar

Read more about it here

image

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. PlatformIO: Clean

5. Serial Port Monitor

6. PlatformIO Core (CLI)

7. Project environment switcher (if more than one environment is available). See [Section env] of “platformio.ini” (Project Configuration File) .