mirror of
https://github.com/platformio/platformio-core.git
synced 2025-10-04 01:20:57 +02:00
162 lines
4.7 KiB
ReStructuredText
162 lines
4.7 KiB
ReStructuredText
.. _installation:
|
|
|
|
Installation
|
|
============
|
|
|
|
**PlatformIO** is written in `Python <https://www.python.org/downloads/>`_ and
|
|
works on Mac OS X, Linux, Windows OS and *ARM*-based credit-card sized
|
|
computers (`Raspberry Pi <http://www.raspberrypi.org>`_,
|
|
`BeagleBone <http://beagleboard.org>`_,
|
|
`CubieBoard <http://cubieboard.org>`_).
|
|
|
|
.. contents::
|
|
|
|
System requirements
|
|
-------------------
|
|
|
|
* **Operating systems:**
|
|
* Mac OS X
|
|
* Linux, +ARM
|
|
* Windows
|
|
* Python 2.6.x or Python 2.7.x(recommended)
|
|
|
|
All commands below should be executed in
|
|
`Command-line <http://en.wikipedia.org/wiki/Command-line_interface>`_
|
|
application:
|
|
|
|
* *Mac OS X / Linux* this is *Terminal* application.
|
|
* *Windows* this is
|
|
`Command Prompt <http://en.wikipedia.org/wiki/Command_Prompt>`_ (``cmd.exe``)
|
|
application.
|
|
|
|
Troubleshooting
|
|
---------------
|
|
|
|
.. warning::
|
|
If you are going to run *PlatformIO* from **subprocess**, you
|
|
:ref:`MUST DISABLE <faq_troubleshooting_pioblocksprompt>` all prompts.
|
|
It will allow you to avoid blocking.
|
|
|
|
.. note::
|
|
**Linux Users:** Don't forget to install "udev" rules file
|
|
`99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file).
|
|
|
|
**Windows Users:** Please check that you have correctly installed USB driver
|
|
from board manufacturer
|
|
|
|
For further details, frequently questions, please refer to :ref:`faq`.
|
|
|
|
Installation Methods
|
|
--------------------
|
|
|
|
.. note::
|
|
**Windows Users**: `Download the latest Python 2.7.x
|
|
<https://www.python.org/downloads/>`_ and install it.
|
|
*DON'T FORGET* to select ``Add python.exe to Path`` feature in installation
|
|
dialog on "Customize" stage.
|
|
|
|
Please *choose one of* the following installation methods:
|
|
|
|
Python Package Manager
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Run the following (**MAY require** administrator access ``sudo``):
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install --upgrade pip setuptools scons
|
|
pip install platformio
|
|
|
|
If your computer does not recognize ``pip`` command, try to install it first
|
|
using `these instructions <https://pip.pypa.io/en/latest/installing.html>`_.
|
|
|
|
Installer Script
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
Super-Quick (Mac / Linux)
|
|
'''''''''''''''''''''''''
|
|
|
|
To install or upgrade *PlatformIO* paste that at a *Terminal* prompt
|
|
(**MAY require** administrator access ``sudo``):
|
|
|
|
.. code-block:: bash
|
|
|
|
python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"
|
|
|
|
|
|
Local Download (Mac / Linux / Windows)
|
|
''''''''''''''''''''''''''''''''''''''
|
|
|
|
To install or upgrade *PlatformIO*, download (save as...)
|
|
`get-platformio.py <https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py>`_
|
|
script. Then run the following (**MAY require** administrator access ``sudo``):
|
|
|
|
.. code-block:: bash
|
|
|
|
# change directory to folder where is located downloaded "get-platformio.py"
|
|
cd /path/to/dir/where/is/located/get-platformio.py/script
|
|
|
|
# run it
|
|
python get-platformio.py
|
|
|
|
|
|
On *Windows OS* it may look like:
|
|
|
|
.. code-block:: bash
|
|
|
|
# change directory to folder where is located downloaded "get-platformio.py"
|
|
cd C:\path\to\dir\where\is\located\get-platformio.py\script
|
|
|
|
# run it
|
|
C:\Python27\python.exe get-platformio.py
|
|
|
|
Full Guide
|
|
~~~~~~~~~~
|
|
|
|
1. Check a ``python`` version (only 2.6-2.7 is supported):
|
|
|
|
.. code-block:: bash
|
|
|
|
python --version
|
|
|
|
*Windows Users* only:
|
|
|
|
* `Download Python 2.7 <https://www.python.org/downloads/>`_ and install it.
|
|
* Add to PATH system variable ``;C:\Python27;C:\Python27\Scripts;`` and
|
|
reopen *Command Prompt* (``cmd.exe``) application. Please read this
|
|
article `How to set the path and environment variables in Windows
|
|
<http://www.computerhope.com/issues/ch000549.htm>`_.
|
|
|
|
2. Install a ``platformio`` and related packages:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install --upgrade pip setuptools scons
|
|
pip install platformio
|
|
|
|
If your computer does not recognize ``pip`` command, try to install it first
|
|
using `these instructions <https://pip.pypa.io/en/latest/installing.html>`_.
|
|
|
|
For upgrading ``platformio`` to the latest version:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install --upgrade platformio
|
|
|
|
Development Version
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. warning::
|
|
We don't recommend to use ``develop`` version in production.
|
|
|
|
Install the latest PlatformIO from the ``develop`` branch:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install -U pip setuptools scons
|
|
pip install -U https://github.com/platformio/platformio/archive/develop.zip
|
|
|
|
If you want to be up-to-date with the latest ``develop`` version of PlatformIO,
|
|
then you need to re-install PlatformIO each time if you see the new commits in
|
|
`PlatformIO GitHub repository (branch: develop) <https://github.com/platformio/platformio/commits/develop>`_.
|