PlatformIO

https://docs.platformio.org/en/latest
Admin
PlatformIO is an open-source ecosystem for embedded software development, offering a collaborative...
Tokens:536,964
Snippets:4,569
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install PlatformIO Packages - Examples

Source: https://docs.platformio.org/en/latest/core/userguide/pkg/cmd_install

These examples demonstrate how to use 'pio pkg install' to install specific development platforms, tools, or libraries. Packages can be specified by name, version requirements, or direct Git repository URLs.

```bash
pio pkg install -p "aceinna/aceinna_imu@^1.3.8" -p "platformio/atmelavr"
pio pkg install --platform "https://github.com/platformio/platform-sifive.git"
pio pkg install -t "platformio/tool-openocd"
pio pkg install --tool https://github.com/platformio/platform-sifive.git
pio pkg install -l "bblanchon/ArduinoJson@^6.19.2" -l "milesburton/DallasTemperature@^3.9.1"
pio pkg install --library https://github.com/Makuna/NeoPixelBus.git
```

```bash
pio pkg install --library "bblanchon/ArduinoJson" --library "etlcpp/Embedded Template Library"
pio pkg install --tool "platformio/tool-jlink"
```

--------------------------------

### Initialize a New PlatformIO Project

Source: https://docs.platformio.org/en/latest/core/quickstart

This command initializes a new PlatformIO project in a specified directory. It requires the board identifier and automatically configures the project with necessary toolchains and build scripts. This simplifies the setup process for embedded development.

```bash
# create new directory
> mkdir path_to_the_new_directory

```

--------------------------------

### Library Specification Forms (PlatformIO CLI)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Demonstrates various ways to specify a library for installation, including by owner/name, version constraints, URLs for archives, local file paths, and Git repositories with tags.

```bash
pio lib [STORAGE_OPTIONS] install (with no args, install project dependencies from "lib_deps")
pio lib [STORAGE_OPTIONS] install <ownername/name>
pio lib [STORAGE_OPTIONS] install <ownername/name>@<version>
pio lib [STORAGE_OPTIONS] install <ownername/name>@<version range>
pio lib [STORAGE_OPTIONS] install <zip or tarball url>
pio lib [STORAGE_OPTIONS] install file://<zip or tarball file>
pio lib [STORAGE_OPTIONS] install file://<folder>
pio lib [STORAGE_OPTIONS] install <repository>
pio lib [STORAGE_OPTIONS] install <name>=<repository> (name it should have locally)
pio lib [STORAGE_OPTIONS] install <repository#tag> ("tag" can be commit, branch or tag)
```

--------------------------------

### Install PlatformIO Core Locally (macOS/Linux/Windows)

Source: https://docs.platformio.org/en/latest/core/installation/methods/installer-script

This example illustrates the process of installing PlatformIO Core by first downloading the `get-platformio.py` script locally and then executing it using the Python interpreter. This method is applicable across macOS, Linux, and Windows.

```shell
# change directory to the folder where is located downloaded "get-platformio.py"
cd /path-to-dir/where/get-platformio.py/is-located

# run it
python get-platformio.py
```

--------------------------------

### PlatformIO CLI Usage Example

Source: https://docs.platformio.org/en/latest/core/userguide/index

Demonstrates the basic command structure for the PlatformIO CLI. It shows how to invoke commands with options and view help.

```bash
pio [OPTIONS] COMMAND

$ pio --help
$ pio COMMAND --help
```

--------------------------------

### Install from Git Repository with Version (PlatformIO CLI)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Shows how to install libraries directly from Git repositories, including specifying branches, commit hashes, or tags for version control. PlatformIO automatically detects Git repositories.

```bash
https://github.com/user/library.git#master
git+git://git.server.org/my-library#master
git+https://git.server.org/my-library#v1.0
git+ssh://git.server.org/my-library#7846d8ad52f983f2f2887bdc0f073fe9755a806d
```

--------------------------------

### AppVeyor CI Example: USB_Host_Shield_2.0 Project

Source: https://docs.platformio.org/en/latest/integration/ci/appveyor

This example shows a complete `appveyor.yml` configuration for the USB_Host_Shield_2.0 project. It specifies source files, installs PlatformIO, clones an additional library, and runs `pio ci` for multiple boards.

```yaml
build: off
environment:

  matrix:
    - PLATFORMIO_CI_SRC: "examples\Bluetooth\PS3SPP\PS3SPP.ino"
    - PLATFORMIO_CI_SRC: "examples\pl2303\pl2303_gps\pl2303_gps.ino"

install:
    - cmd: git submodule update --init --recursive
    - cmd: SET PATH=%PATH%;C:\Python27\Scripts
    - cmd: pip install -U platformio
    - cmd: git clone https://github.com/xxxajk/spi4teensy3.git C:\spi4teensy

test_script:
    - cmd: pio ci --lib="." --lib="C:\\spi4teensy" --board=uno --board=teensy31 --board=due
```

--------------------------------

### PlatformIO: Installing from Git Repositories

Source: https://docs.platformio.org/en/latest/core/userguide/platforms/cmd_install

Provides examples of installing development platforms directly from Git repositories using various URL schemes (http, https, ssh) and specifying branches, commit hashes, or tags.

```bash
### Git
The supported schemes are: `git`, `git+https` and `git+ssh`. Here are the supported forms:
  * https://github.com/platformio/platform-NAME.git
  * git+git://git.server.org/my-platform
  * git+https://git.server.org/my-platform
  * git+ssh://git.server.org/my-platform
  * git+ssh://user@git.server.org/my-platform
  * [user@]host.xz:path/to/repo.git

Passing branch names, a commit hash or a tag name is possible like so:
  * https://github.com/platformio/platform-name.git#master
  * git+git://git.server.org/my-platform#master
  * git+https://git.server.org/my-platform#v1.0
  * git+ssh://git.server.org/my-platform#7846d8ad52f983f2f2887bdc0f073fe9755a806d
```

--------------------------------

### PlatformIO: Install Custom Platform

Source: https://docs.platformio.org/en/latest/platforms/creating_platform

This snippet demonstrates the command-line steps to install a custom development platform in PlatformIO. It involves creating directories, copying platform files, and using the `pio platform install` command. Ensure the `platform.json` and `builder/main.py` files are correctly placed.

```bash
pio platform install myplatform
```

--------------------------------

### PlatformIO: Versioning Syntax Examples

Source: https://docs.platformio.org/en/latest/core/userguide/platforms/cmd_install

Demonstrates the various ways to specify version constraints for development platforms in PlatformIO, including semantic versioning (SemVer) ranges and exact version matching.

```plaintext
  * `^1.2.3` - any compatible version (new functionality in a backwards compatible manner and patches are allowed, 1.x.x). **RECOMMENDED**
  * `~1.2.3` - any version with the same major and minor versions, and an equal or greater patch version
  * `>1.2.3` - any version greater than `1.2.3`. `>=`, `<`, and `<=` are also possible
  * `>0.1.0,!=0.2.0,<0.3.0` - any version greater than `0.1.0`, not equal to `0.2.0` and less than `0.3.0`
  * `1.2.3` - an exact version number. Use only this exact version.
```

--------------------------------

### PlatformIO Configuration for STC15F408AD

Source: https://docs.platformio.org/en/latest/boards/intel_mcs51/STC15F408AD

This snippet shows the basic configuration for the STC15F408AD board in the platformio.ini file. It specifies the platform and board ID. This is the minimum required setup to start a project with this board.

```ini
[env:STC15F408AD]
platform = intel_mcs51
board = STC15F408AD

```

--------------------------------

### Install Library with Dependencies to Custom Storage

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs a library and its dependencies to a specified custom storage directory. This is useful for managing project-specific libraries or when global installation is not desired.

```bash
> pio lib --storage-dir /my/storage/dir install DallasTemperature

Library Storage: /my/storage/dir
Looking for DallasTemperature library in registry
Found: https://platformio.org/lib/show/54/DallasTemperature
LibraryManager: Installing id=54
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
DallasTemperature @ 3.7.7 has been successfully installed!
Installing dependencies
Looking for OneWire library in registry
Found: https://platformio.org/lib/show/1/OneWire
LibraryManager: Installing id=1
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
OneWire @ 8fd2ebfec7 has been successfully installed!

```

--------------------------------

### Install Library by ID or Name (Latest Version)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs the latest version of a library using its unique ID or its registered name. The library is installed into the global storage. This is a common operation for quickly adding a needed library.

```bash
> pio lib -g install 4

Library Storage: /storage/dir/...
LibraryManager: Installing id=4
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
IRremote @ 2.2.1 has been successfully installed!

# repeat command with name
> pio lib -g install IRRemote

Library Storage: /storage/dir/...
Looking for IRRemote library in registry
Found: https://platformio.org/lib/show/4/IRremote
LibraryManager: Installing id=4
IRremote @ 2.2.1 is already installed

```

--------------------------------

### Install ARM mbed Library from URL (Mercurial)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs an ARM mbed library directly from a Mercurial repository URL. This example demonstrates installing a library hosted on developer.mbed.org, utilizing the 'hg+http' or 'hg+https' scheme.

```bash
> pio lib -g install https://developer.mbed.org/users/simon/code/TextLCD/

Library Storage: /storage/dir/...
LibraryManager: Installing TextLCD
Mercurial Distributed SCM (version 3.8.4)
(see https://mercurial-scm.org for more information)

Copyright (C) 2005-2016 Matt Mackall and others
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
requesting all changes
adding changesets
adding manifests
adding file changes
added 9 changesets with 18 changes to 6 files
updating to branch default
2 files updated, 0 files merged, 0 files removed, 0 files unresolved
TextLCD @ 308d188a2d3a has been successfully installed!

```

--------------------------------

### Install Library by Name with Specific Version

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs a specific version of a library using its name followed by the version number. This ensures compatibility with projects requiring a particular library version. The library is installed globally.

```bash
> pio lib -g install ArduinoJson@5.6.7

Library Storage: /storage/dir/...
Looking for ArduinoJson library in registry
Found: https://platformio.org/lib/show/64/ArduinoJson
LibraryManager: Installing id=64 @ 5.6.7
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
ArduinoJson @ 5.6.7 has been successfully installed!

```

--------------------------------

### Install Library to Global Storage (PlatformIO CLI - Not Recommended)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs a library into the global PlatformIO storage. This is generally not recommended as it can lead to unmanaged dependencies across projects. Use with caution.

```bash
pio lib --global install [OPTIONS] [LIBRARY...]
pio lib -g install [OPTIONS] [LIBRARY...]
```

--------------------------------

### Install Project Dependencies (PlatformIO CLI)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

This command installs all project dependencies declared in the 'lib_deps' section of the 'platformio.ini' file. It's the recommended way to manage project libraries when working from the project root.

```bash
pio lib install [OPTIONS]
```

--------------------------------

### Example: Integrate USB_Host_Shield_2.0 Project with `pio ci`

Source: https://docs.platformio.org/en/latest/integration/ci/drone

This comprehensive example shows the setup for the USB_Host_Shield_2.0 project using `pio ci`. It includes downloading and unzipping an external library, specifying source files for testing, and configuring multiple target boards.

```shell
pip install -U platformio
wget https://github.com/xxxajk/spi4teensy3/archive/master.zip -O /tmp/spi4teensy3.zip
unzip /tmp/spi4teensy3.zip -d /tmp
pio ci --lib="." --lib="/tmp/spi4teensy3-master" --board=uno --board=teensy31 --board=due
```

--------------------------------

### Install Library for Specific Environment (PlatformIO CLI)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs libraries for a particular project environment defined in 'platformio.ini'. This allows for targeted dependency management for different build configurations.

```bash
pio lib -e myenv install [OPTIONS] [LIBRARY...]
pio lib -d /path/to/platformio/project -e myenv install [OPTIONS] [LIBRARY...]
```

--------------------------------

### PlatformIO Custom Target: Command Shortcut Examples

Source: https://docs.platformio.org/en/latest/scripting/custom_targets

Illustrates creating custom targets in PlatformIO that execute shell commands. Includes examples for single commands and multiple sequential commands, demonstrating how to define aliases for common tasks within the 'extra_script.py' file.

```python
Import("env")

# Single action/command per 1 target
env.AddCustomTarget("sysenv", None, 'python -c "import os; print(os.environ)"')

# Multiple actions
env.AddCustomTarget(
    name="pioenv",
    dependencies=None,
    actions=[
        "pio --version",
        "python --version"
    ],
    title="Core Env",
    description="Show PlatformIO Core and Python versions"
)

```

--------------------------------

### Configure PlatformIO Project Examples (JSON)

Source: https://docs.platformio.org/en/latest/manifests/library-json/fields/examples

This JSON configuration defines example projects for a PlatformIO library. It specifies the name, base directory, and a list of files for each example. This is used by PlatformIO to manage and build project examples.

```json
{
    "examples": [
        {
            "name": "Hello",
            "base": "examples/world",
            "files": [
                "platformio.ini",
                "include/world.h",
                "src/world.c",
                "README",
                "extra.py"
            ]
        },
        {
            "name": "Blink",
            "base": "examples/blink",
            "files": ["blink.cpp", "blink.h"]
        }
    ]
}
```

--------------------------------

### Initialize PlatformIO Project for Multiple Boards

Source: https://docs.platformio.org/en/latest/core/quickstart

Initializes a new PlatformIO project in the current directory, configuring it for specified microcontrollers. The command creates essential project files like 'platformio.ini', 'src/', and 'lib/'. Users are prompted to confirm the creation and can specify a different project directory using the -d flag.

```bash
> pio project init --board uno --board nodemcuv2 --board teensy31
```

--------------------------------

### Install Specific Library (PlatformIO CLI)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs a specific library and its dependencies. This command is run from the project root directory containing 'platformio.ini'. You can specify individual libraries or libraries by owner and name.

```bash
pio lib install [OPTIONS] [LIBRARY...]
```

--------------------------------

### PlatformIO Project Configuration for HiFive1

Source: https://docs.platformio.org/en/latest/boards/sifive/hifive1

This snippet shows the basic configuration for the HiFive1 board in the 'platformio.ini' file. It specifies the platform as 'sifive' and the board ID as 'hifive1'. This is the minimal setup required to start a project for this board.

```ini
[env:hifive1]
platform = sifive
board = hifive1

```

--------------------------------

### Install Library from Archive URL (Git Zip)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs a library from a zipped archive provided via a URL, typically a GitHub repository zipball. This method is useful for installing libraries not yet registered in the PlatformIO registry or for specific versions.

```bash
> pio lib -g install  https://github.com/adafruit/DHT-sensor-library/archive/master.zip

Library Storage: /storage/dir/...
LibraryManager: Installing master
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
DHT sensor library @ 1.2.3 has been successfully installed!

```

--------------------------------

### PlatformIO Configuration for AVR64DD20 Board

Source: https://docs.platformio.org/en/latest/boards/atmelmegaavr/AVR64DD20

This configuration snippet shows the basic setup for the AVR64DD20 board in the platformio.ini file. It specifies the platform and the board ID. This is the fundamental configuration required to start a project with this board.

```ini
[env:AVR64DD20]
platform = atmelmegaavr
board = AVR64DD20

```

--------------------------------

### Install PlatformIO Dependencies and Upload Firmware via CLI

Source: https://docs.platformio.org/en/latest/faq/troubleshooting

This snippet demonstrates how to use PlatformIO Core (CLI) commands to install necessary project dependencies and upload firmware. It's useful when antivirus software or other issues prevent background operations in IDE terminals. Ensure you are in your project directory before executing these commands.

```bash
# Change directory to PlatformIO Project where is located "platformio.ini"
cd path/to/platformio/project

# Force PlatformIO to install PlatformIO Home dependencies
pio home

# Force PlatformIO to install toolchains
pio run --target upload
```

--------------------------------

### PlatformIO Project Configuration for ST Nucleo L433RC-P

Source: https://docs.platformio.org/en/latest/boards/ststm32/nucleo_l433rc_p

This snippet shows the basic configuration for the ST Nucleo L433RC-P board in the PlatformIO project configuration file (platformio.ini). It specifies the platform ('ststm32') and the board ID ('nucleo_l433rc_p'). This is the minimal setup required to start a project targeting this board.

```ini
[env:nucleo_l433rc_p]
platform = ststm32
board = nucleo_l433rc_p

```

--------------------------------

### PlatformIO Core Installer Script Help (CLI)

Source: https://docs.platformio.org/en/latest/core/installation/integration

Displays the available arguments and options for the PlatformIO Core installer script (`get-platformio.py`). This is useful for understanding all the customization possibilities for installation and checking.

```bash
python get-platformio.py --help
```

--------------------------------

### PlatformIO Project Configuration for SparkFun ESP32-S2 Thing Plus

Source: https://docs.platformio.org/en/latest/boards/espressif32/sparkfun_esp32s2_thing_plus

This configuration defines the project environment for the SparkFun ESP32-S2 Thing Plus board in PlatformIO. It specifies the platform and board type. This is the basic setup required to start a project with this board.

```ini
[env:sparkfun_esp32s2_thing_plus]
platform = espressif32
board = sparkfun_esp32s2_thing_plus


```

--------------------------------

### PlatformIO Project Configuration for ESP32-S3-DevKitC-1

Source: https://docs.platformio.org/en/latest/boards/espressif32/esp32-s3-devkitc-1

This snippet shows the basic configuration for the ESP32-S3-DevKitC-1 board in the PlatformIO project configuration file (platformio.ini). It sets the platform to 'espressif32' and the board to 'esp32-s3-devkitc-1'. This is the essential setup required to start a project for this specific board.

```ini
[env:esp32-s3-devkitc-1]
platform = espressif32
board = esp32-s3-devkitc-1

```

--------------------------------

### PlatformIO Build Script (main.py) Example

Source: https://docs.platformio.org/en/latest/platforms/creating_platform

This Python script, based on SCons, defines the build process for a PlatformIO project. It configures build tools, flags, defines, and libraries, and sets up targets for building the firmware and uploading it.

```python
"""
    Build script for test.py
    test-builder.py
"""

from os.path import join
from SCons.Script import AlwaysBuild, Builder, Default, DefaultEnvironment

env = DefaultEnvironment()

# A full list with the available variables
# http://www.scons.org/doc/production/HTML/scons-user.html#app-variables
env.Replace(
    AR="ar",
    AS="gcc",
    CC="gcc",
    CXX="g++",
    OBJCOPY="objcopy",
    RANLIB="ranlib",

    UPLOADER=join("$PIOPACKAGES_DIR", "tool-bar", "uploader"),
    UPLOADCMD="$UPLOADER $SOURCES"
)

env.Append(
    ARFLAGS=["..."],

    ASFLAGS=["flag1", "flag2", "flagN"],
    CCFLAGS=["flag1", "flag2", "flagN"],
    CXXFLAGS=["flag1", "flag2", "flagN"],
    LINKFLAGS=["flag1", "flag2", "flagN"],

    CPPDEFINES=["DEFINE_1", "DEFINE=2", "DEFINE_N"],

    LIBS=["additional", "libs", "here"],

    BUILDERS=dict(
        ElfToBin=Builder(
            action=" ".join([
                "$OBJCOPY",
                "-O",
                "binary",
                "$SOURCES",
                "$TARGET"]),
            suffix=".bin"
        )
    )
)

# The source code of "platformio-build-tool" is here
# https://github.com/platformio/platformio-core/blob/develop/platformio/builder/tools/platformio.py

#
# Target: Build executable and linkable firmware
#
target_elf = env.BuildProgram()

#
# Target: Build the .bin file
#
target_bin = env.ElfToBin(join("$BUILD_DIR", "firmware"), target_elf)

#
# Target: Upload firmware
#
upload = env.Alias(["upload"], target_bin, "$UPLOADCMD")
AlwaysBuild(upload)

#
# Target: Define targets

```

--------------------------------

### PlatformIO Remote Build and Upload Example

Source: https://docs.platformio.org/en/latest/core/userguide/remote/cmd_run

This snippet demonstrates the PlatformIO CLI command for building and uploading firmware to an Arduino Uno board remotely. It shows the build process, including dependency collection, compilation, linking, and size checking, followed by the upload process using avrdude. The output includes success and summary messages for each stage.

```bash
> pio remote run --environment uno --target upload

Building project locally
[Wed Oct 26 16:35:09 2016] Processing uno (platform: atmelavr, board: uno, framework: arduino)
--------------------------------------------------------------------------------
Verbose mode can be enabled via `-v, --verbose` option
Collected 25 compatible libraries
Looking for dependencies...
Project does not have dependencies
Compiling .pio/build/uno/src/main.o
Archiving .pio/build/uno/libFrameworkArduinoVariant.a
Indexing .pio/build/uno/libFrameworkArduinoVariant.a
Compiling .pio/build/uno/FrameworkArduino/CDC.o
Compiling .pio/build/uno/FrameworkArduino/HardwareSerial.o
Compiling .pio/build/uno/FrameworkArduino/HardwareSerial0.o
Compiling .pio/build/uno/FrameworkArduino/HardwareSerial1.o
Compiling .pio/build/uno/FrameworkArduino/HardwareSerial2.o
Compiling .pio/build/uno/FrameworkArduino/HardwareSerial3.o
Compiling .pio/build/uno/FrameworkArduino/IPAddress.o
Compiling .pio/build/uno/FrameworkArduino/PluggableUSB.o
Compiling .pio/build/uno/FrameworkArduino/Print.o
Compiling .pio/build/uno/FrameworkArduino/Stream.o
Compiling .pio/build/uno/FrameworkArduino/Tone.o
Compiling .pio/build/uno/FrameworkArduino/USBCore.o
Compiling .pio/build/uno/FrameworkArduino/WInterrupts.o
Compiling .pio/build/uno/FrameworkArduino/WMath.o
Compiling .pio/build/uno/FrameworkArduino/WString.o
Compiling .pio/build/uno/FrameworkArduino/_wiring_pulse.o
Compiling .pio/build/uno/FrameworkArduino/abi.o
Compiling .pio/build/uno/FrameworkArduino/hooks.o
Compiling .pio/build/uno/FrameworkArduino/main.o
Compiling .pio/build/uno/FrameworkArduino/new.o
Compiling .pio/build/uno/FrameworkArduino/wiring.o
Compiling .pio/build/uno/FrameworkArduino/wiring_analog.o
Compiling .pio/build/uno/FrameworkArduino/wiring_digital.o
Compiling .pio/build/uno/FrameworkArduino/wiring_pulse.o
Compiling .pio/build/uno/FrameworkArduino/wiring_shift.o
Archiving .pio/build/uno/libFrameworkArduino.a
Indexing .pio/build/uno/libFrameworkArduino.a
Linking .pio/build/uno/firmware.elf
Checking program size
Building .pio/build/uno/firmware.hex
text       data     bss     dec     hex filename
2574         48     168    2790     ae6 .pio/build/uno/firmware.elf
========================= [SUCCESS] Took 10.01 seconds =======================
================================== [SUMMARY] =================================
Environment nodemcuv2   [SKIP]  
Environment uno_pic32   [SKIP]  
Environment teensy31    [SKIP]  
Environment uno         [SUCCESS]
========================= [SUCCESS] Took 10.01 seconds ========================
Uploading firmware remotely
[Wed Oct 26 19:35:20 2016] Processing uno (platform: atmelavr, board: uno, framework: arduino)
----------------------------------------------------------------------------------------------
Verbose mode can be enabled via `-v, --verbose` option
Looking for upload port...
Auto-detected: /dev/cu.usbmodemFA1431
Uploading .pio/build/uno/firmware.hex
avrdude: AVR device initialized and ready to accept instructions
Reading | ################################################## | 100% 0.00s
avrdude: Device signature = 0x1e950f
avrdude: reading input file ".pio/build/uno/firmware.hex"
avrdude: writing flash (2622 bytes):
Writing | ################################################## | 100% 0.43s
avrdude: 2622 bytes of flash written
avrdude: verifying flash memory against .pio/build/uno/firmware.hex:
avrdude: load data flash data from input file .pio/build/uno/firmware.hex:
avrdude: input file .pio/build/uno/firmware.hex contains 2622 bytes
avrdude: reading on-chip flash data:
Reading | ################################################## | 100% 0.34s
avrdude: verifying ...
avrdude: 2622 bytes of flash verified
avrdude done.  Thank you.
========================= [SUCCESS] Took 3.04 seconds =======================
========================= [SUMMARY] =========================================
Environment nodemcuv2   [SKIP]  
Environment uno_pic32   [SKIP]  
Environment teensy31    [SKIP]  
Environment uno         [SUCCESS]
========================= [SUCCESS] Took 3.04 seconds ========================

```

--------------------------------

### PlatformIO Configuration for AVR64DA28

Source: https://docs.platformio.org/en/latest/boards/atmelmegaavr/AVR64DA28

This configuration snippet shows how to set up the AVR64DA28 board in the PlatformIO project configuration file (platformio.ini). It specifies the platform and board ID. This is the basic setup required to start a project targeting this board.

```ini
[env:AVR64DA28]
platform = atmelmegaavr
board = AVR64DA28

```

--------------------------------

### PlatformIO CLI --version Option

Source: https://docs.platformio.org/en/latest/core/userguide/index

Shows how to display the installed version of PlatformIO Core using the --version flag.

```bash
--version
    Show the version of PlatformIO
```

--------------------------------

### PlatformIO Core Build and Management Commands

Source: https://docs.platformio.org/en/latest/core/quickstart

Provides essential PlatformIO Core CLI commands for managing embedded projects. These commands include building (processing) all project environments, uploading firmware, cleaning compiled files, and selectively processing specific environments.

```bash
> pio run
> pio run --target upload
> pio run --target clean
> pio run -e uno
> pio run -e uno -t upload
```

--------------------------------

### PlatformIO Project Configuration for Adafruit QT Py M0

Source: https://docs.platformio.org/en/latest/boards/atmelsam/adafruit_qt_py_m0

This configuration sets the PlatformIO environment for the Adafruit QT Py M0 board. It specifies the 'atmelsam' platform and the 'adafruit_qt_py_m0' board ID. This is the basic setup required to start a project with this board.

```ini
[env:adafruit_qt_py_m0]
platform = atmelsam
board = adafruit_qt_py_m0

```

--------------------------------

### PlatformIO Manifest File (platform.json) Example

Source: https://docs.platformio.org/en/latest/platforms/creating_platform

This JSON file defines a custom PlatformIO development platform, specifying its name, description, version, repository, and the packages and frameworks it utilizes. It includes configurations for toolchains, frameworks, and optional uploaders.

```json
{
  "name": "myplatform",
  "title": "My Platform",
  "description": "My custom development platform",
  "homepage": "https://mycompany.com",
  "license": "Apache-2.0",
  "keywords": ["keyword_1", "keyword_N"],
  "repository": {
    "type": "git",
    "url": "https://github.com/platformio/platform-myplatform.git"
  },
  "version": "0.0.0",
  "frameworks": {
    "%FRAMEWORK_NAME_1%": {
      "package": "framework-%FRAMEWORK_NAME_1%",
      "script": "builder/frameworks/%FRAMEWORK_NAME_1%.py"
    },
    "%FRAMEWORK_NAME_N%": {
      "package": "framework-%FRAMEWORK_NAME_N%",
      "script": "builder/frameworks/%FRAMEWORK_NAME_N%.py"
    }
  },
  "packages": {
    "toolchain-gccarmnoneeabi": {
      "type": "toolchain",
      "owner": "platformio",
      "version": ">=1.40803.0,<1.40805.0"
    },
    "framework-%FRAMEWORK_NAME_1%": {
      "type": "framework",
      "optional": true,
      "version": "~1.10607.0"
    },
    "framework-%FRAMEWORK_NAME_N%": {
      "type": "framework",
      "optional": true,
      "version": "~1.117.0"
    },
    "tool-direct-vcs-url": {
      "type": "uploader",
      "optional": true,
      "version": "https://github.com/user/repo.git"
    }
  }
}
```

--------------------------------

### Install Library to Custom Storage Directory (PlatformIO CLI)

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_install

Installs libraries to a specified custom storage directory instead of the default global or project locations. This is useful for managing libraries in specific project setups or shared environments.

```bash
pio lib --storage-dir /path/to/dir install [OPTIONS] [LIBRARY...]
pio lib -d /path/to/dir1 -d /path/to/dir2 install [OPTIONS] [LIBRARY...]
```

--------------------------------

### Custom Unity Test Example in C++

Source: https://docs.platformio.org/en/latest/advanced/unit-testing/frameworks/custom/examples/custom_unity_library

This C++ code demonstrates a basic test case using the Unity testing framework within a PlatformIO project. It includes `setUp` and `tearDown` functions for test environment management and a simple test assertion, utilizing the `UNITY_BEGIN()` and `UNITY_END()` macros to define the test suite.

```cpp
#include <Arduino.h>
#include <unity.h>

void setUp(void) {
    // set stuff up here
}

void tearDown(void) {
    // clean stuff up here
}

void simple_test(void)
{
    TEST_ASSERT_EQUAL(33, 33);
}

void setup()
{
    delay(2000);

    UNITY_BEGIN();
    RUN_TEST(simple_test);
    UNITY_END();
}

void loop()
{
    delay(1000);
}


```

--------------------------------

### Install PlatformIO Development Version (Python/CLI)

Source: https://docs.platformio.org/en/latest/core/installation/development-version

Installs the latest PlatformIO from the 'develop' branch using pip. This command fetches the development version directly from the GitHub repository. It's recommended to re-run this command to get the latest updates.

```python
python -m pip install -U https://github.com/platformio/platformio-core/archive/develop.zip

```

--------------------------------

### PlatformIO CLI: Install Platform Usage

Source: https://docs.platformio.org/en/latest/core/userguide/platforms/cmd_install

Illustrates the basic usage and different forms of the 'pio platform install' command for installing development platforms. It shows how to specify platform names, versions, owners, and installation sources like URLs or local files.

```bash
pio platform install [OPTIONS] [PLATFORM...]

# [PLATFORM...] forms
pio platform install <name>
pio platform install <name>@<version>
pio platform install <name>@<version range>
pio platform install <ownername>@<version>
pio platform install <ownername>@<version range>
pio platform install <zip or tarball url>
pio platform install file://<zip or tarball file>
pio platform install file://<folder>
pio platform install <repository>
pio platform install <name=repository> (name it should have locally)
pio platform install <repository#tag> ("tag" can be commit, branch or tag)
```

--------------------------------

### PlatformIO Project Configuration for STM32F407IG

Source: https://docs.platformio.org/en/latest/boards/ststm32/genericSTM32F407IGT6

This snippet shows the basic configuration for the STM32F407IG board in the PlatformIO project configuration file ('platformio.ini'). It specifies the 'ststm32' platform and the 'genericSTM32F407IGT6' board identifier. This is the minimal setup required to start a project for this board.

```ini
[env:genericSTM32F407IGT6]
platform = ststm32
board = genericSTM32F407IGT6

```

--------------------------------

### Execute Arbitrary Commands with PlatformIO Package Manager CLI

Source: https://docs.platformio.org/en/latest/core/migration

The `pio pkg exec` command allows running commands from installed packages. It ensures the specified package is installed before execution, useful for toolchains, debuggers, or uploaders. Examples include starting a GDB server, erasing flash memory, or disassembling ELF files.

```bash
# Ensure JLink tool is installed and start GDB server
> pio pkg exec --package=tool-jlink -- JLinkGDBServer -singlerun -if JTAG -select USB -jtagconf -1,-1 -device EFR32BG22CxxxF512 -port 2331

# Run Espressif SoC serial bootloader utility and erase a flash from the target device
> pio pkg exec -- esptool.py erase_flash

# Disassembly AVR ELF file
> pio pkg exec -- avr-objdump -d -m avr2 .pio/build/uno/firmware.elf
```

--------------------------------

### PlatformIO: Installing from Local Files

Source: https://docs.platformio.org/en/latest/core/userguide/platforms/cmd_install

Shows how to install development platforms using the `file://` prefix to specify local directories, zip archives, or tarball archives containing a `platform.json` manifest.

```bash
  * `file:///local/path/to/the/platform/dir`
  * `file:///local/path/to/the/platform.zip`
  * `file:///local/path/to/the/platform.tar.gz`
```

--------------------------------

### PlatformIO Project Configuration for BlackPill F401CC

Source: https://docs.platformio.org/en/latest/boards/ststm32/blackpill_f401cc

This snippet shows the basic configuration for the WeAct Studio BlackPill V2.0 board in PlatformIO's `platformio.ini` file. It specifies the platform and board ID. This is the minimum required configuration to start a project with this board.

```ini
[env:blackpill_f401cc]
platform = ststm32
board = blackpill_f401cc

```

--------------------------------

### Get PIO System Information

Source: https://docs.platformio.org/en/latest/core/userguide/system/index

The 'pio system info' command provides detailed information about the PlatformIO environment, including installed versions, configuration, and system compatibility. This is useful for troubleshooting and understanding your setup. It has various options to filter or format the output.

```shell
pio system info

```

--------------------------------

### Configure ESPectro32 Board in PlatformIO

Source: https://docs.platformio.org/en/latest/boards/espressif32/espectro32

This snippet shows the basic configuration for the ESPectro32 board in the platformio.ini file. It specifies the platform and board ID. This is the minimum required setup to start a project targeting this board.

```ini
[env:espectro32]
platform = espressif32
board = espectro32

```

--------------------------------

### Travis CI with External Library Downloads for PlatformIO

Source: https://docs.platformio.org/en/latest/integration/ci/travis

This configuration extends the basic PlatformIO setup by downloading and extracting external libraries (jeelib and Gamebuino) from URLs before running the PlatformIO CI command. It maintains the caching strategy and standard installation steps for PlatformIO.

```yaml
os: linux
dist: focal
language: python
python:
    - "3.11"

# Cache PlatformIO packages using Travis CI container-based infrastructure
cache:
    directories:
        - "~/.platformio"
        - $HOME/.cache/pip

env:
    - PLATFORMIO_CI_SRC=examples/backSoon/backSoon.ino
    - PLATFORMIO_CI_SRC=examples/etherNode/etherNode.ino
    # - 

install:
    - pip install -U platformio
    - pio update

    - wget https://github.com/jcw/jeelib/archive/master.zip -O /tmp/jeelib.zip
    - unzip /tmp/jeelib.zip -d /tmp

    - wget https://github.com/Rodot/Gamebuino/archive/master.zip  -O /tmp/gamebuino.zip
    - unzip /tmp/gamebuino.zip -d /tmp

script:
    - pio ci --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560

```

--------------------------------

### Arduino Blink Sketch for PlatformIO

Source: https://docs.platformio.org/en/latest/core/quickstart

A basic Arduino sketch designed for PlatformIO projects that blinks the built-in LED. It includes necessary headers, defines the LED pin, and implements `setup()` for initialization and `loop()` for the blinking logic using `pinMode`, `digitalWrite`, and `delay`.

```cpp
/**
 * Blink
 * ... (description)
 */
#include "Arduino.h"

#ifndef LED_BUILTIN
#define LED_BUILTIN 13
#endif

void setup()
{
  // initialize LED digital pin as an output.
  pinMode(LED_BUILTIN, OUTPUT);
}

void loop()
{
  // turn the LED on (HIGH is the voltage level)
  digitalWrite(LED_BUILTIN, HIGH);

  // wait for a second
  delay(1000);

  // turn the LED off by making the voltage LOW
  digitalWrite(LED_BUILTIN, LOW);

   // wait for a second
  delay(1000);
}
```

--------------------------------

### Example: pio home command usage

Source: https://docs.platformio.org/en/latest/core/userguide/cmd_home

Demonstrates the typical output and behavior when running the 'pio home' command, including the server URL and startup message.

```bash
> pio home

  ___I_
 /\-_--\   PlatformIO Home
/  \_-__\
|[]| [] |
|__|____|_______________________

Open PlatformIO Home in your browser by this URL => http://127.0.0.1:8008
PlatformIO Home has been started. Press Ctrl+C to shutdown.

```

--------------------------------

### PlatformIO Example: Update All Global Libraries

Source: https://docs.platformio.org/en/latest/core/userguide/lib/cmd_update

An example demonstrating how to update all libraries installed in the global storage using the 'pio lib -g update' command. The output shows the status for each library, including successful installations.

```bash
> pio lib -g update

Library Storage: /storage/dir/...
Updating ESP8266_SSD1306 @ 3.2.3:   [Up-to-date]
Updating EngduinoMagnetometer @ 3.1.0:  [Up-to-date]
Updating IRremote @ 2.2.1:  [Up-to-date]
Updating Json @ 5.4.0:  [Out-of-date]
LibraryManager: Installing id=64 @ 5.6.4
Downloading  [####################################]  100%
Unpacking  [####################################]  100%
Json @ 5.6.4 has been successfully installed!
Updating PJON @ 1fb26fd:    [Checking]
git version 2.7.4 (Apple Git-66)
Already up-to-date.
Updating TextLCD @ 308d188a2d3a:    [Checking]
Mercurial Distributed SCM (version 3.8.4)
(see https://mercurial-scm.org for more information)

Copyright (C) 2005-2016 Matt Mackall and others
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
pulling from https://developer.mbed.org/users/simon/code/TextLCD/
searching for changes
no changes found

```

--------------------------------

### List Available Boards with PlatformIO CLI

Source: https://docs.platformio.org/en/latest/core/quickstart

This command displays a list of available boards for a specified platform, including their IDs, MCUs, frequencies, and memory details. It's crucial for identifying the correct board identifier needed for project initialization.

```bash
> pio boards teensy
```

--------------------------------

### PlatformIO Project Configuration (platformio.ini)

Source: https://docs.platformio.org/en/latest/boards/espressif32/esp-wrover-kit

This snippet shows the basic configuration for the ESP-WROVER-KIT board in the `platformio.ini` file. It specifies the platform and board ID, which are essential for PlatformIO to recognize and build for the target hardware. This is the starting point for any project targeting this board.

```ini
[env:esp-wrover-kit]
platform = espressif32
board = esp-wrover-kit

```

--------------------------------

### PlatformIO Project Configuration for NodeMCUv2

Source: https://docs.platformio.org/en/latest/boards/espressif8266/nodemcuv2

This configuration snippet defines a PlatformIO project environment for the NodeMCUv2 board, specifying the 'espressif8266' platform and the 'nodemcuv2' board type. It's the basic setup required to start a project for this hardware.

```ini
[env:nodemcuv2]
platform = espressif8266
board = nodemcuv2

```

--------------------------------

### Customize Serial Monitor in platformio.ini

Source: https://docs.platformio.org/en/latest/integration/ide/vscode

This example demonstrates how to configure custom serial monitor settings within the `platformio.ini` file for an `esp32dev` environment. It overrides the default serial port and sets a custom baud rate for the serial monitor. This allows for tailored serial communication during development.

```ini
[env:esp32dev]
platform = platformio/espressif32
framework = arduino
board = esp32dev

; Custom Serial Monitor port
monitor_port = /dev/ttyUSB1

; Custom Serial Monitor speed (baud rate)
monitor_speed = 115200

```

--------------------------------

### Configure Labplus mPython Board in platformio.ini

Source: https://docs.platformio.org/en/latest/boards/espressif32/labplus_mpython

This snippet shows the basic configuration for the Labplus mPython board in the 'platformio.ini' file. It specifies the platform as 'espressif32' and the board as 'labplus_mpython'. This is the minimum required configuration to start a project with this board.

```ini
[env:labplus_mpython]
platform = espressif32
board = labplus_mpython

```

--------------------------------

### Install PlatformIO Core with wget (macOS/Linux)

Source: https://docs.platformio.org/en/latest/core/installation/methods/installer-script

This snippet shows how to install PlatformIO Core on macOS or Linux using `wget` to download the installer script, followed by execution with `python3`. It's an alternative to using `curl`.

```shell
wget -O get-platformio.py https://raw.githubusercontent.com/platformio/platformio-core-installer/master/get-platformio.py
python3 get-platformio.py
```

--------------------------------

### Configure WEMOS LOLIN S2 PICO Board in PlatformIO

Source: https://docs.platformio.org/en/latest/boards/espressif32/lolin_s2_pico

This snippet shows the basic configuration for the WEMOS LOLIN S2 PICO board in the 'platformio.ini' file. It specifies the platform as 'espressif32' and the board ID as 'lolin_s2_pico'. This is the minimal setup required to start a project with this board.

```ini
[env:lolin_s2_pico]
platform = espressif32
board = lolin_s2_pico

```

--------------------------------

### Configure Mini 2.0 Board in platformio.ini

Source: https://docs.platformio.org/en/latest/boards/microchippic32/fubarino_mini_20

This snippet shows the basic configuration for the Mini 2.0 board in the `platformio.ini` file. It specifies the platform (`microchippic32`) and the board ID (`fubarino_mini_20`). This is the minimum required to start a project with this board.

```ini
[env:fubarino_mini_20]
platform = microchippic32
board = fubarino_mini_20

```

--------------------------------

### PlatformIO Project Configuration File (platformio.ini)

Source: https://docs.platformio.org/en/latest/core/quickstart

Defines the build options, upload settings, and library dependencies for a PlatformIO project. This file specifies the platform, framework, and board for each environment, enabling targeted compilation and uploading.

```ini
; PlatformIO Project Configuration File
; ... (other options and examples)

[env:uno]
platform = atmelavr
framework = arduino
board = uno

[env:nodemcuv2]
platform = espressif8266
framework = arduino
board = nodemcuv2

[env:teensy31]
platform = teensy
framework = arduino
board = teensy31
```

--------------------------------

### PlatformIO: Installing from Subversion Repositories

Source: https://docs.platformio.org/en/latest/core/userguide/platforms/cmd_install

Explains how to install development platforms from Subversion (SVN) repositories using various URL schemes and how to specify specific revisions.

```bash
### Subversion
The supported schemes are: `svn`, `svn+svn`, `svn+http`, `svn+https` and `svn+ssh`. Here are the supported forms:
  * svn+svn://svn.server.org/my-platform
  * svn+https://svn.server.org/my-platform
  * svn+ssh://svn.server.org/my-platform

You can also give specific revisions to an SVN URL, like so:
  * svn+svn://svn.server.org/my-platform#13
```
Tokens:
Raw