diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 05d413c91ab..bca8cadece0 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -32,3 +32,4 @@ User and Developer Guides west/index optimizations/index zephyr_cmake_package.rst + platformio/index.rst diff --git a/doc/guides/platformio/img/platformio-ide-vscode.png b/doc/guides/platformio/img/platformio-ide-vscode.png new file mode 100644 index 00000000000..0433440690b Binary files /dev/null and b/doc/guides/platformio/img/platformio-ide-vscode.png differ diff --git a/doc/guides/platformio/img/platformio-logo.png b/doc/guides/platformio/img/platformio-logo.png new file mode 100644 index 00000000000..012819a8fd4 Binary files /dev/null and b/doc/guides/platformio/img/platformio-logo.png differ diff --git a/doc/guides/platformio/index.rst b/doc/guides/platformio/index.rst new file mode 100644 index 00000000000..a67bafd0806 --- /dev/null +++ b/doc/guides/platformio/index.rst @@ -0,0 +1,91 @@ +.. _platformio: + +Using with PlatformIO +##################### + +.. image:: img/platformio-logo.png + :target: https://platformio.org/?utm_source=docs.zephyrproject.org + +.. contents:: + :local: + +What is PlatformIO? +******************* + +`PlatformIO `__ +is a cross-platform, cross-architecture, multiple framework, professional +tool for embedded systems engineers and for software developers who write +applications for embedded products. It is fully compatible with the Zephyr +project. + +- 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. + +.. image:: img/platformio-ide-vscode.png + :target: https://platformio.org/platformio-ide?utm_source=docs.zephyrproject.org + +PlatformIO’s unique philosophy in the embedded market provides developers with +a modern integrated development environment (`Cloud & Desktop IDE `_) +that works cross-platform, supports many different software development kits +(SDKs) or `Frameworks `_, +and includes sophisticated debugging (`PIO Unified Debugger `_), +unit testing (`PIO Unit Testing `_), +automated code analysis (`PIO Check `_), +firmware inspection, and remote management (`PIO Remote `_). +It is architected to maximize flexibility and choice by developers, who can use +either graphical or command line editors (`PlatformIO Core (CLI) `__), +or both. PlatformIO is a must-have tool for professional embedded systems +engineers who develop solutions on more than one specific platform. In addition, +by having a decentralized architecture, PlatformIO offers both new and existing +developers a quick integration path for developing commercial-ready products, +and reduces the overall time-to-market. + +And it runs on any one of your favorite modern operating systems (macOS, MS Windows, +Linux, FreeBSD). + +Installation +************ + +.. tip:: + In our experience, PlatformIO IDE is the best way to start exploring the PlatformIO ecosystem. + +* `PlatformIO IDE `_ + is a new generation toolset for embedded C/C++ development +* `PlatformIO Core (CLI) `_ + is a unique, developed-from-scratch build system that removes the usual pain of + software integration, packaging, and library dependencies that developers encounter + when they move beyond the bounds of a specific SDK or example embedded application. + It can be used with a variety of code development environments and allows easy + integration with numerous cloud platforms and web services feeds. + +Configuration +************* + +Please go through `the official PlatformIO configuration guide for Zephyr project `_. + +Tutorials +********* + +- `Zephyr and Nordic nRF52-DK: debugging, unit testing, project analysis + `_ +- `Developing Zephyr RTOS embedded applications on PlatformIO and simulating on Antmicro Renode + `_ + +Project Examples +**************** + +Please check `the official examples for various development platforms `_ + +Next Steps +********** + +Here are some useful links for exploring the PlatformIO ecosystem: + +- Try `other platforms `_ + that support Zephyr project +- Learn more about `integrations with other IDEs/Text Editors `_ +- Get help from `awesome PlatformIO community `_ +