Skip to content

Latest commit

 

History

History
143 lines (90 loc) · 4.13 KB

installation.rst

File metadata and controls

143 lines (90 loc) · 4.13 KB
Raw

Installation

PlatformIO is written in Python and works on Mac OS X, Linux, Windows OS and ARM-based credit-card computers (Raspberry Pi, BeagleBoard, CubieBoard).

System requirements

All commands below should be executed in Command-line application:

  • Mac OS X / Linux this is Terminal application.
  • Windows this is Command Prompt (cmd.exe) application.

Warning

If you are going to run PlatformIO from subprocess, you MUST DISABLE all prompts. It will allow you to avoid blocking. There are a few options:

  • using environment variable PLATFORMIO_SETTING_ENABLE_PROMPTS=No <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>
  • disable global setting enable_prompts via cmd_settings command
  • masking under Continuous Integration system via environment variable CI=true <envvar_CI>.

Please choose one of the following:

Super-Quick (Mac / Linux)

To install or upgrade PlatformIO paste that at a Terminal prompt (you might need to run sudo first):

python -c "$(curl -fsSL https://raw.githubusercontent.com/ivankravets/platformio/master/scripts/get-platformio.py)"

Installer Script (Mac / Linux / Windows)

To install or upgrade PlatformIO, download get-platformio.py script. Then run the following (you might need to run sudo first):

python get-platformio.py

On Windows OS it may look like:

C:\Python27\python.exe get-platformio.py

Warning

If you have an error pkg_resources.DistributionNotFound please upgrade SetupTools package: $ [sudo] pip uninstall setuptools and $ [sudo] pip install setuptools. Then re-install PlatformIO: $ [sudo] pip uninstall platformio and $ [sudo] pip install platformio.

Full Guide

  1. Check a python version (only 2.6-2.7 is supported):
$ python --version

Windows OS Users only:

  1. Check a pip tool for installing and managing Python packages:
$ pip search platformio

You should see short information about platformio package.

If your computer does not recognize pip command, try to install it first using these instructions.

  1. Install a platformio and related packages:
$ pip install platformio && pip install --egg scons

For upgrading the platformio to new version please use this command:

$ pip install -U platformio

Development Version

Warning

We don't recommend to use develop version in production.

  1. If you had have already installed PlatformIO, please uninstall it:
$ pip uninstall platformio
  1. Install the latest PlatformIO from the develop branch:
$ pip install https://github.com/ivankravets/platformio/archive/develop.zip

If you want to be up-to-date with the latest develop version of PlatformIO, then you need to perform step #2 each time if you see the new commits in PlatformIO GitHub repository.