Aug 18, 2019

PlatformIO IDE(VSCode) 基本使用 - 新建项目

PlatformIO IDE (VSCode) 可以帮助我们更好地使用 PlatforIO，一个 MCU 项目的开始那就是新建，本文就讲解一下如果使用 PlatformIO IDE 新建一个 MCU 的项目。

基本概念

在使用 PlatformIO 的过程中经常会遇到一些词，比如 Platform 、 Framworks 以及 Boards，在新建项目之前有必要先说明一下，这些具体都代表了什么！

Platform

直译的话就是平台，具体就是指的芯片平台，再详细一点那就是各个公司具体的系列芯片的开发平台了。目前为止 PIO^[PIO 是 PlatformIO 的简称，后面系列文章会经常使用这个简称] 针对支持的平台都有以下功能支撑：

支持指定框架的基于脚本的编译构建系统
针对各公司常规开发板的预配置
提供多架构的构建工具及相关工具链的支持

PIO 目前支持的平台分为嵌入式和桌面两大类。

嵌入式平台
桌面平台

上面也有前面文章中使用到的 ST STM32，Atmel AVR 一般指的就是 Arduino 系列开发板使用的芯片，说到 Arduino ，它其实就是一个完整的生态，提供开源的硬件开发板的设计以及 Arduino 统一的软件开发包就是所谓的 Frameworks。

Frameworks

上面已经提到 Frameworks 其实就是类似于 SDK 的一个东西，全世界最有名的 Arduino 有自家的一套 SDK，那就是 Arduino，框架基本特征就是提供一整套一致的 API 的集合，本质是一个官方或第三方提供的软件库。

因为 Arduino 极具影响力，所以很多芯片平台也都有了自己的 Arduino 框架，现在 Arduino 框架平台支持的平台有很多：Atmel AVR、Atmel SAM、Espressif 32、Espressif 8266、Infineon XMC、Intel ARC32、Kendryte K210、Microchip PIC32、Nordic nRF51、Nordic nRF52、T STM32、ST STM8 、Teensy、TI MSP430 、TI TIVA ^[更多关于 Arduino 框架的信息参考：https://docs.platformio.org/en/latest/frameworks/arduino.html]。

反过来讲，一个平台有可能支持多个不同开发框架，比如 ST STM32 支持的开发框架有：Arduino、CMSIS、libOpenCM3、mbed、SPL、STM32Cube^[更多关于 stm32 单片机开发平台的信息参考：https://docs.platformio.org/en/latest/platforms/ststm32.html]。

PIO 支持的框架也是有很多，总有适合你的：

Arduino
ARTIK SDK
CMSIS
ESP8266 Non-OS SDK
ESP8266 RTOS SDK
ESP-IDF
Freedom E SDK
Kendryte FreeRTOS SDK
Kendryte Standalone SDK
libOpenCM3
mbed
PULP OS
Pumbaa
Simba
SPL
STM32Cube
Tizen RT
WiringPi

详见：https://docs.platformio.org/en/latest/frameworks/index.html

Boards

PIO 支持绝大部分流行的开发板，比如 Arduino 的全系开发板、STM32 的 Nucleo 和 Discovery 系列评估板。有太多太多了，这里就没必要一一罗列了，可以查看下面的链接了解更多关于开发板的支持列表：

https://docs.platformio.org/en/latest/boards/index.html

PIO 针对支持的开发板都提供完整的项目生成脚本，新建项目从未如此快捷和简单！

新建项目

这里我们以新建一个 Arduino Leonardo 的项目为例。

打开 PIO Home：打开新的 VSCode 的窗口，点击左下角状态栏的第三个小房子按钮，就能打开 PIO Home 页面了：
点击项目操作按钮的 + New Project，在弹窗中分别填入或选择 Name、Board、Framework 点击 Finish：
稍作等待，PIO 会自动根据选择的 Board 和 Framework 配置工程并且下载需要用到的编译工具，需要的编译依赖什么的 PIO 通通帮我们搞定，一段时间过后项目工程就新建完成了，打开 src 文件夹下的 main.cpp 如下：

项目文件结构

项目文件结构要了解一下，方便后期自己手动管理项目。

.pio，存放工程编译产生的文件
.vscode, 存放针对工程定制化的 vscode 配置文件
include，存放统一管理的 h 头文件
lib，存放自己编写的库文件
src，存放工程项目的 C/C++ 源文件
test，存放工程项目的测试文件，一般用不到
.gitignore，git 仓库的忽略文件，方便 git 进行工程项目的版本控制
travis.yml，持续集成的配置文件，一般用不到
platformio.ini，项目的核心配置文件，这个会经常用到，所以得了解其中可用的配置项^[详见：“platformio.ini” (Project Configuration File)]

编译和上传

新建了项目工程之后，就是进行开发了，必然要用到编译代码，要将编译生成的二进制文件上传到开发板的芯片中。

为了看到效果，我们编写一段让板载 LED 闪动的实现：

#include <Arduino.h>

void setup() {
  // put your setup code here, to run once:
  pinMode(LED_BUILTIN, OUTPUT);
}

void loop() {
  // put your main code here, to run repeatedly:
  digitalWrite(LED_BUILTIN, HIGH);
  delay(1000);
  digitalWrite(LED_BUILTIN, LOW);
  delay(1000);
}

在这之前有必要了解一下 PIO 的工具栏按钮：

Tip:

如果使用 Arduino 框架代码中，一定要包含头文件 Arduino.h。

编译项目工程

将上面的代码录入 src 目录下的 main.cpp 文件中，看文件名就知道使用的是 c++ 编程语言了。多种方式可以触发编译，比如笔者经常用的两种方式：

点击上面截图底部中工具栏的第二个对号图标
按下组合键 CTRL + ALT + B

还有两种方式可以触发编译任务：

按下组合键 CTRL + SHIFT + P (macOS 下是 COMMAND + SHIFT + P)，然后输入关键字 platformio，选择 Build
点击窗口左边栏的蚂蚁头的图标会打开 PlatformIO 的工具栏，点击其中的 Build

顺利的话，触发了编译，很快就会在终端窗口提示编译完成：

> Executing task: platformio run <

Processing leonardo (platform: atmelavr; board: leonardo; framework: arduino)
------------------------------------------------------------------------------------
Verbose mode can be enabled via `-v, --verbose` option
CONFIGURATION: https://docs.platformio.org/page/boards/atmelavr/leonardo.html
PLATFORM: Atmel AVR 1.15.0 > Arduino Leonardo
HARDWARE: ATMEGA32U4 16MHz, 2.50KB RAM, 28KB Flash
PACKAGES: toolchain-atmelavr 1.50400.190710 (5.4.0), framework-arduinoavr 4.1.1
LDF: Library Dependency Finder -> http://bit.ly/configure-pio-ldf
LDF Modes: Finder ~ chain, Compatibility ~ soft
Found 7 compatible libraries
Scanning dependencies...
No dependencies
Checking size .pio/build/leonardo/firmware.elf
Memory Usage -> http://bit.ly/pio-memory-usage
DATA:    [=         ]   5.8% (used 149 bytes from 2560 bytes)
PROGRAM: [=         ]  14.4% (used 4130 bytes from 28672 bytes)
============================ [SUCCESS] Took 0.66 seconds ============================