PlatformIO Core Documentation

PlatformIO Core offers several key capabilities for embedded development:

Core Capabilities

• Build System: Multi-platform and multi-architecture support.
• Debugging: Unified Debugger and advanced debugging tools.
• Testing: Remote unit testing and test-driven methodologies.
• Analysis: Static Code Analyzer (via pio-check).
• File Management: Firmware File Explorer and Memory Inspection.

Key Solutions

• Library Management: Automated management of embedded libraries.
• IDE Integration: Integration with various desktop IDEs.
• Continuous Integration: Support for CI/CD workflows.
• Remote Development: Capabilities for remote development environments.

The pio lib command group is used for managing PlatformIO libraries.

Note: Most pio lib commands are deprecated and will be removed in future releases. It is highly recommended to use the pio pkg command suite instead (e.g., pio pkg install instead of pio lib install).

Using the --sample-code flag during platformio init will attempt to create a boilerplate source file in the src directory.

Note: This feature is primarily implemented for the Arduino framework. If the board's default framework is not Arduino, sample code generation will be skipped.

You can use platformio init with the --board flag to add new environment sections to an existing platformio.ini file. PlatformIO will automatically determine the correct platform and framework for the specified board.

If you provide --project-option, these options will be applied to the newly created environment section. You can also use --env-prefix to customize the name of the generated environment section (e.g., env:my_prefixboard_id).

When using pio lib commands, you can control which library storage is being managed using the following flags:

• -d, --storage-dir <DIR>: Manage custom library storage in the specified directory(s).
• -g, --global: Manage the global PlatformIO library storage.
• -e, --environment <ENV>: Manage libraries for specific project build environments declared in platformio.ini.

You can control the number of parallel jobs used during the run process to optimize build performance.

1. CLI Flag: Use the -j or --jobs flag.
2. Environment Variable: Set PLATFORMIO_RUN_JOBS to a specific integer to set a global default for your session.

You can configure static analysis tools directly within your platformio.ini file under specific environments.

Supported configuration keys per environment:

• check_tool: A list of tools to run (e.g., check_tool = cppcheck).
• check_src_filters: Filters for source files to be checked.
• check_patterns: Alternative to check_src_filters.
• check_flags: Additional flags to pass to the tool.
• check_severity: The minimum severity level to report.
• check_skip_packages: Whether to skip platform packages.
• platform_packages: List of platform packages to include/exclude.

The PlatformIO Registry is a central repository where you can discover and use various components for your embedded projects:

• Libraries: Search for and integrate third-party libraries.
• Development Platforms: Find support for specific hardware platforms and architectures.
• Development Tools: Access specialized tools for the embedded ecosystem.