PlatformIO
v4.2.0

Getting Started

Configuration

Instruments

PIO Plus

Integration

Miscellaneous

CLion

The CLion is a cross-platform C/C++ IDE for Linux, OS X, and Windows integrated with the CMake build system. The initial version will support the GCC and Clang compilers and GDB debugger. Clion includes such features as a smart editor, code quality assurance, automated refactorings, project manager, integrated version control systems.

Refer to the CLion Documentation page for more detailed information.

../../_images/ide-platformio-clion.png

Integration

Integration process consists of these steps:

  1. Install File Watchers plugin via “Clion: Preferences > Plugins”. We need it to automatically update project configuration when changes are made in “platformio.ini” (Project Configuration File)

  2. Open system Terminal and install PlatformIO Core (CLI)

  3. Create new folder for your project and change directory (cd) to it

  4. Generate a project using PIO Core Project Generator (platformio project init --ide)

  5. Open project in IDE.

Choose board ID using platformio boards or Embedded Boards Explorer command and generate project via platformio project init --ide command:

platformio project init --ide clion --board <ID>

# For example, generate project for Arduino UNO
platformio project init --ide clion --board uno

Then:

  1. Place source files (*.c, *.cpp, *.h, *.hpp) to src directory and repeat platformio project init --ide command above (to refresh source files list)

  2. Open this project via Menu: File > Open... and specify root directory where is located “platformio.ini” (Project Configuration File)

  3. Open source file from src directory

  4. Build project (DO NOT use “Run” button, see marks on the screenshot above): Menu: Run > Build.

Warning

  1. PlatformIO Core (CLI) DOES NOT depend on CMake, it has own cross-platform Build System. All data related to build flags and source code filtering should be specified using Build options in “platformio.ini” (Project Configuration File).

2. See know issue: Arduino .ino files are not supported and how to resolve it.

There are 11 predefined targets for building (NOT FOR RUNNING, see marks on the screenshot above):

  • PLATFORMIO_BUILD - Build project without auto-uploading

  • PLATFORMIO_BUILD_VERBOSE - Build project without auto-uploading in verbose mode

  • PLATFORMIO_UPLOAD - Build and upload (if no errors)

  • PLATFORMIO_CLEAN - Clean compiled objects

  • PLATFORMIO_MONITOR - Device monitor platformio device monitor

  • PLATFORMIO_TEST - PIO Unit Testing

  • PLATFORMIO_PROGRAM - Build and upload using external programmer (if no errors), see Upload using Programmer

  • PLATFORMIO_UPLOADFS - Upload files to file system SPIFFS, see Uploading files to file system SPIFFS

  • PLATFORMIO_UPDATE - Update installed platforms and libraries via platformio update

  • PLATFORMIO_REBUILD_PROJECT_INDEX - Rebuild C/C++ Index for the Project. Allows one to fix code completion and code linting issues.

  • PLATFORMIO_DEVICE_LIST - List connected devices.

If you have multiple environements, you can select which one the target is going to use by changing the build profile (See screenshot). Changing the build profile also updates defines and includes for code completion in the editor to those specified by the environement.

The profile All runs the target for all environements ; this was the previous behavior.

Warning

The libraries which are added, installed or used in a project after generating process will not be reflected in IDE. Please run PLATFORMIO_REBUILD_PROJECT_INDEX target to resolve this issue.

Known issues

Arduino .ino files are not supported

CLion uses “CMake” tool for code completion and code linting. As result, it doesn’t support Arduino files (*.ino and .pde) because they are not valid C/C++ based source files:

  1. Missing includes such as #include <Arduino.h>

  2. Function declarations are omitted.

See how to Convert Arduino file to C++ manually.

Articles / Manuals

See more Articles about us.