Migrating from 4.x to 5.0¶
Guidance on how to upgrade from PlatformIO Core (CLI) v4.x to v5.x with emphasis on major changes, what is new, and what has been removed.
PlatformIO Core 5.0 is fully backward compatible with PlatformIO 4.0 projects.
Please read PlatformIO 5.0 Release Notes before.
- Ensure that you do not use a short version of the Github declaration in lib_deps.
- We recommend updating your project dependency declarations in lib_deps using a new owner-based syntax. See the Library Manager section for details.
PlatformIO Core 5.0 has been switched to the official PlatformIO Trusted Registry:
- Enterprise-grade package storage with high availability (multi replicas)
- Secure, fast, and reliable global content delivery network (CDN)
- Universal support for all packages:
- Development platforms
- Built-in fine-grained access control (role-based, teams, organizations).
The new Web front-end and upgraded PlatformIO Home are coming soon.
PlatformIO Core 5.0 is fully unlocked for developers and teams. They can now share their packages (libraries, Development Platforms, toolchains) with team members or collaborate on open source projects. There are new CLI commands that help you to manage organizations, teams, team memberships, and resource access:
The package management infrastructure has been rewritten from scratch. It is based now on the new PlatformIO Trusted Registry that supports a strict dependency declaration using the package owner. This improvement resolves the issues when package maintainers publish packages under the same name.
PlatformIO Core 5.0 does not handle packages from unofficial repositories declared via
platform.json. There were a lot of security issues and
reports when PlatformIO Core 4.0 hangs when you manage external dependencies.
PlatformIO Core 5.0 uses THE ONLY official PlatformIO Trusted Registry that supports not only the libraries but also Development Platforms and toolchains.
Package maintainers can publish their libraries, development platforms, and toolchains to the registry using pio package CLI.
The biggest improvement for Library Management is the owner-based dependency declaration.
You can finally forget about conflicts with library names in the registry. Use the new
ownername/pkgname to declare an owner-based dependency in “platformio.ini” (Project Configuration File)
[env:myenv] platform = ... framework = ... board = ... lib_deps = bblanchon/ArduinoJson @ ^6.16.1 knolleary/PubSubClient @ ^2.8
You can find an owner name of a library in the registry using PlatformIO Home > Libraries > Some Library > Installation tab.
PlatformIO Core 5.0 build engine has been upgraded to the latest SCons 4.0 - a next-generation software construction tool:
- Pre/Post processing based on dependent sources (another target, source file, etc.)
- Command launcher with own arguments
- Launch command with custom options declared in “platformio.ini” (Project Configuration File)
- Python callback as a target (use the power of Python interpreter and PlatformIO Build API)
- List available project targets (including dev-platform specific and custom targets) with a new
pio run --list-targetscommand
See Build System section in PlatformIO Core 5 release notes for more details.
Python 2.7 is reached the end of its life on 1 January 2020, and Python Software Foundation will not provide any security fixes for it. The same situation with Python 3.5.
To avoid unrelated issues to the PlatformIO Core, we decided to drop support for Python 2 and 3.5. The minimum supported version for PlatformIO Core 5.0 is Python 3.6.
If you use PlatformIO IDE, it already comes with the built-in compatible Python 3 interpreter. You do not need to do any extra steps. If you see a warning message that your local PlatformIO Core installation uses incompatible Python, please do the next steps:
- Install the latest Python 3 following this guide Install Python Interpreter
- Open system terminal and type
python.exe --version(for Windows). The output should contain a version of Python 3.6 or above (depending on which you installed it).
- Remove PlatformIO Core installation “penv” folder that is located by this path
USER_HOME_DIR/.platformio/penv. If you use Windows and your user name contains non-ASCII chars the “penv” folder is located in
- Install PlatformIO Core using Installer Script
- Run the pio system info command and ensure that Python 3 is used.
strict_ssl has been removed from pio settings. Now, PlatformIO Core 5.0
communicates over the encrypted SSL/TLS by default with the PlatformIO Registry and
other services such as Remote Development.
At PlatformIO, we are always looking for ways to improve the security of our services.
PlatformIO Core 5.0 does not support unofficial package repositories declared through
platform.json that was introduced in PlatformIO 3.0.
Please publish your development platforms and toolchains to the PlatformIO Trusted Registry using pio package CLI.
The following commands have been changed in v5.0.
|pio access||New. Manage package access for users, teams, and maintainers|
|pio package||New. Manage packages in the registry (publish, unpublish)|
|pio project data||New. Dump build system data intended for IDE extensions/plugins|
|pio system info||New. Display system-wide information|
|pio system prune||New. Remove unused data|
|pio project init||Update project configuration for the specific environment using
|pio run||List projects targets with
|pio account destroy||New command to remove permanently PlatformIO Account and related data|