PlatformIO

Introduction

If you are new to PlatformIO, download and install first Visual Studio Code and the PlatformIO plugin. Please follow the instructions on the official website. Then go through this tutorial to get started with PlatformIO in VSCode and create a new project.

Library Installation

With the project created, now the library and its dependencies can be configured in the Platform.ini Project File. This file, located in the project root folder, includes one (or several) building environments [env:__].

In the environment section, the platform, board, and framework are specified. PlatformIO will take care of downloading and installing all dependencies.

In the following example, we use the XMC 2Go Evaluation Kit (only available for Arduino):

[env:xmc1100_xmc2go]
platform = infineonxmc
board = xmc1100_xmc2go
framework = arduino

lib_deps =
# Using a library name
hall-switch
    
# Using the repository URL
    https://github.com/Infineon/hall-switch.git#master