Your Gateway to Embedded Software Development Excellence 👽 https://platformio.org
Find a file
2025-08-09 13:31:17 +03:00
.github build and publish wheel (#5088) 2025-02-14 12:15:12 +02:00
docs@48c9af468a Sync docs 2025-07-31 14:57:19 +03:00
examples@0409a90a01 Sync examples 2025-05-07 19:43:52 +03:00
platformio Fix: Preserve RFC2217 URLs in SerialPortFinder.find() in "device monitor" (#5226) 2025-08-09 13:01:33 +03:00
scripts Use owner-based platform declaration // Resolve #4962 2024-08-28 19:43:52 +03:00
tests CI: Disable cleaning of ubuntu instance 2025-02-08 21:51:50 +02:00
.gitignore Ignore Python3 "__pycache__" binaries 2022-03-06 16:00:01 +02:00
.gitmodules Add docs submodule 2016-12-05 20:45:31 +02:00
.pylintrc PyLint fixes 2023-02-02 17:43:38 +02:00
CODE_OF_CONDUCT.md Provide CODE_OF_CONDUCT.md 2023-04-18 20:20:03 +03:00
CONTRIBUTING.md Improve "CONTRIBUTING" guide // Resolve #4622 2023-05-16 18:12:25 +03:00
HISTORY.rst Fixed an issue where fully-qualified serial port URLs (e.g., `rfc2217://host:port`) were incorrectly treated as wildcard patterns // Resolve #5225 2025-08-09 13:31:17 +03:00
LICENSE Add Apache License, Version 2.0 to @PlatformIO docs 2015-11-18 17:33:46 +02:00
Makefile Sync docs 2025-02-09 12:22:58 +02:00
README.rst Update slogan 2023-08-11 12:07:16 +03:00
SECURITY.md Provide SECURITY.md 2023-04-18 20:16:59 +03:00
setup.py Move core/pip dependencies to the separate "dependencies" module 2024-03-18 13:14:22 +02:00
tox.ini Fix spell issues 2025-02-08 19:27:58 +02:00

PlatformIO Core
===============

.. image:: https://github.com/platformio/platformio-core/workflows/Core/badge.svg
    :target: https://docs.platformio.org/en/latest/core/index.html
    :alt:  CI Build for PlatformIO Core
.. image:: https://github.com/platformio/platformio-core/workflows/Docs/badge.svg
    :target: https://docs.platformio.org?utm_source=github&utm_medium=core
    :alt:  CI Build for Docs
.. image:: https://github.com/platformio/platformio-core/workflows/Examples/badge.svg
    :target: https://github.com/platformio/platformio-examples
    :alt:  CI Build for dev-platform examples
.. image:: https://github.com/platformio/platformio-core/workflows/Projects/badge.svg
    :target: https://docs.platformio.org/en/latest/tutorials/index.html#projects
    :alt:  CI Build for the Community Projects
.. image:: https://img.shields.io/pypi/v/platformio.svg
    :target: https://pypi.python.org/pypi/platformio/
    :alt: Latest Version
.. image:: https://img.shields.io/badge/PlatformIO-Labs-orange.svg
   :alt: PlatformIO Labs
   :target: https://piolabs.com/?utm_source=github&utm_medium=core

**Quick Links:** `Homepage <https://platformio.org?utm_source=github&utm_medium=core>`_ |
`PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_ |
`Registry <https://registry.platformio.org?utm_source=github&utm_medium=core>`_ |
`Project Examples <https://github.com/platformio/platformio-examples/>`__ |
`Docs <https://docs.platformio.org?utm_source=github&utm_medium=core>`_ |
`Donate <https://platformio.org/donate?utm_source=github&utm_medium=core>`_ |
`Contact Us <https://piolabs.com/?utm_source=github&utm_medium=core>`_

**Social:** `LinkedIn <https://www.linkedin.com/company/platformio/>`_ |
`Twitter <https://twitter.com/PlatformIO_Org>`_ |
`Facebook <https://www.facebook.com/platformio>`_ |
`Community Forums <https://community.platformio.org?utm_source=github&utm_medium=core>`_

.. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-ide-laptop.png
    :target: https://platformio.org?utm_source=github&utm_medium=core

`PlatformIO <https://platformio.org>`_: Your Gateway to Embedded Software Development Excellence.

Unlock the true potential of embedded software development with
PlatformIO's collaborative ecosystem, embracing declarative principles,
test-driven methodologies, and modern toolchains for unrivaled success.

* Open source, maximum permissive Apache 2.0 license
* Cross-platform IDE and Unified Debugger
* Static Code Analyzer and Remote Unit Testing
* Multi-platform and Multi-architecture Build System
* Firmware File Explorer and Memory Inspection

Get Started
-----------

* `What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=core>`_
* `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=github&utm_medium=core>`_
* `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=core>`_
* `Project Examples <https://github.com/platformio/platformio-examples?utm_source=github&utm_medium=core>`__

Solutions
---------

* `Library Management <https://docs.platformio.org/en/latest/librarymanager/index.html?utm_source=github&utm_medium=core>`_
* `Desktop IDEs Integration <https://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=core>`_
* `Continuous Integration <https://docs.platformio.org/en/latest/ci/index.html?utm_source=github&utm_medium=core>`_

**Advanced**

* `Debugging <https://docs.platformio.org/en/latest/plus/debugging.html?utm_source=github&utm_medium=core>`_
* `Unit Testing <https://docs.platformio.org/en/latest/advanced/unit-testing/index.html?utm_source=github&utm_medium=core>`_
* `Static Code Analysis <https://docs.platformio.org/en/latest/plus/pio-check.html?utm_source=github&utm_medium=core>`_
* `Remote Development <https://docs.platformio.org/en/latest/plus/pio-remote.html?utm_source=github&utm_medium=core>`_

Registry
--------

* `Libraries <https://registry.platformio.org/search?t=library&utm_source=github&utm_medium=core>`_
* `Development Platforms <https://registry.platformio.org/search?t=platform&utm_source=github&utm_medium=core>`_
* `Development Tools <https://registry.platformio.org/search?t=tool&utm_source=github&utm_medium=core>`_

Contributing
------------

See `contributing guidelines <https://github.com/platformio/platformio/blob/develop/CONTRIBUTING.md>`_.

Telemetry / Privacy Policy
--------------------------

Share minimal diagnostics and usage information to help us make PlatformIO better.
It is enabled by default. For more information see:

* `Telemetry Setting <https://docs.platformio.org/en/latest/userguide/cmd_settings.html?utm_source=github&utm_medium=core#enable-telemetry>`_

License
-------

Copyright (c) 2014-present PlatformIO <contact@platformio.org>

The PlatformIO is licensed under the permissive Apache 2.0 license,
so you can use it in both commercial and personal projects with confidence.

.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct.svg
    :target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
    :alt:  SWUbanner