Migrating from 4.x to 5.0¶

PlatformIO Trusted Registry¶

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:

  • Libraries

  • Development platforms

  • Toolchains

• Built-in fine-grained access control (role-based, teams, organizations).

The new Web front-end and upgraded PlatformIO Home are coming soon.

Collaborative Platform¶

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:

• pio package – manage packages in the registry

• pio org - manage organizations

• pio team - manage teams and team memberships

• pio access – manage package access for users, teams, and maintainers.

Package Management¶

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 packageRepositories in 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.

Library Manager¶

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 syntax ownername/pkgname to declare an owner-based dependency in “platformio.ini” (Project Configuration File) via lib_deps:

[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.

Build System¶

Drop support for Python 2 and 3.5¶

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:

1. Install the latest Python 3 following this guide Install Python Interpreter

2. Open system terminal and type python3 --version or python.exe --version (for Windows). The output should contain a version of Python 3.6 or above (depending on which you installed it).

3. 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 C:/.platformio/penv

4. Install PlatformIO Core using Installer Script

5. Run the pio system info command and ensure that Python 3 is used.

Introducing Strict SSL/TLS¶

The setting 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.

packageRepositories¶

PlatformIO Core 5.0 does not support unofficial package repositories declared through packageRepositories in 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.

Command Line Interface¶

The following commands have been changed in v5.0.