PlatformIO Library Manager 3.0 // Resolve #588 , Resolve #414, Resolve #498, Resolve #475, Resolve #410, Resolve #461, Resolve #361, Resolve #507, Resolve #554
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
||||
.. Copyright 2014-present Ivan Kravets <me@ikravets.com>
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
@@ -21,22 +21,67 @@ Usage
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
platformio lib install [OPTIONS] [LIBRARY_ID]
|
||||
platformio lib [STORAGE_OPTIONS] install [OPTIONS] [LIBRARY...]
|
||||
|
||||
# install project dependent library
|
||||
# (run it from a project root where is located "platformio.ini")
|
||||
platformio lib install [OPTIONS] [LIBRARY...]
|
||||
|
||||
# install to global storage
|
||||
platformio lib --global install [OPTIONS] [LIBRARY...]
|
||||
platformio lib -g install [OPTIONS] [LIBRARY...]
|
||||
|
||||
# install to custom storage
|
||||
platformio lib --storage-dir /path/to/dir install [OPTIONS] [LIBRARY...]
|
||||
platformio lib -d /path/to/dir install [OPTIONS] [LIBRARY...]
|
||||
|
||||
# [LIBRARY...] forms
|
||||
platformio lib [STORAGE_OPTIONS] install (with no args, project dependencies)
|
||||
platformio lib [STORAGE_OPTIONS] install <id>
|
||||
platformio lib [STORAGE_OPTIONS] install <id>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] install <id>@<version range>
|
||||
platformio lib [STORAGE_OPTIONS] install <name>
|
||||
platformio lib [STORAGE_OPTIONS] install <name>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] install <name>@<version range>
|
||||
platformio lib [STORAGE_OPTIONS] install <zip or tarball url>
|
||||
platformio lib [STORAGE_OPTIONS] install file://<zip or tarball file>
|
||||
platformio lib [STORAGE_OPTIONS] install file://<folder>
|
||||
platformio lib [STORAGE_OPTIONS] install <repository>
|
||||
platformio lib [STORAGE_OPTIONS] install <name=repository> (name it should have locally)
|
||||
platformio lib [STORAGE_OPTIONS] install <repository#tag> ("tag" can be commit, branch or tag)
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Install new library by specified
|
||||
`PlatformIO Library Registry ID <http://platformio.org/lib>`_.
|
||||
Install a library, and any libraries that it depends on using:
|
||||
|
||||
Installs the project library dependencies or a specific set of libraries.
|
||||
[LIBRARY] can have multiple forms: <source>, <source>@<target>,
|
||||
<id=> or <name>=<source>@<target>
|
||||
1. Library ``id`` or ``name`` from `PlatformIO Library Registry <http://platformio.org/lib>`_
|
||||
2. Custom folder, repository or archive.
|
||||
|
||||
Where, <source> is a registry ID, registry name, repository URL, physical
|
||||
location, <target> is a valid semantic version/range, commit, branch, etc., and
|
||||
<name> is the name it should have locally.
|
||||
The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
|
||||
``<major>.<minor>.<patch>``) and can take any of the following forms:
|
||||
|
||||
* ``0.1.2`` - an exact version number. Use only this exact version
|
||||
* ``^0.1.2`` - any compatible version (exact version for ``0.x.x`` versions
|
||||
* ``~0.1.2`` - any version with the same major and minor versions, and an
|
||||
equal or greater patch version
|
||||
* ``>0.1.2`` - any version greater than ``0.1.2``. ``>=``, ``<``, 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``
|
||||
|
||||
Also, PlatformIO supports installing from local directory or archive. Need
|
||||
to use ``file://`` prefix before local path. Also, directory or
|
||||
archive should contain ``.library.json`` manifest (see :ref:`library_config`).
|
||||
|
||||
* ``file:///local/path/to/the/platform/dir``
|
||||
* ``file:///local/path/to/the/platform.zip``
|
||||
* ``file:///local/path/to/the/platform.tar.gz``
|
||||
|
||||
Storage Options
|
||||
---------------
|
||||
|
||||
See base options for :ref:`userguide_lib`.
|
||||
|
||||
Options
|
||||
-------
|
||||
@@ -44,50 +89,151 @@ Options
|
||||
.. program:: platformio lib install
|
||||
|
||||
.. option::
|
||||
-v, --version
|
||||
-q, --quiet
|
||||
|
||||
Install specified version of library
|
||||
Suppress progress reporting
|
||||
|
||||
Version control
|
||||
---------------
|
||||
|
||||
PlatformIO supports installing from Git, Mercurial and Subversion, and detects
|
||||
the type of VCS using url prefixes: "git+", "hg+", or "svn+".
|
||||
|
||||
.. note::
|
||||
PlatformIO requires a working VCS command on your path: ``git``, ``hg``
|
||||
or ``svn``.
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The supported schemes are: ``git``, ``git+https`` and ``git+ssh``. Here are
|
||||
the supported forms:
|
||||
|
||||
* user/library (short version for GitHub repository)
|
||||
* https://github.com/user/library.git
|
||||
* git+git://git.server.org/my-library
|
||||
* git+https://git.server.org/my-library
|
||||
* git+ssh://git.server.org/my-library
|
||||
|
||||
Passing branch names, a commit hash or a tag name is possible like so:
|
||||
|
||||
* 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
|
||||
|
||||
Mercurial
|
||||
^^^^^^^^^
|
||||
|
||||
The supported schemes are: ``hg+http``, ``hg+https`` and ``hg+ssh``. Here are
|
||||
the supported forms:
|
||||
|
||||
* https://developer.mbed.org/users/user/code/library/ (install ARM mbed library)
|
||||
* hg+hg://hg.server.org/my-library
|
||||
* hg+https://hg.server.org/my-library
|
||||
* hg+ssh://hg.server.org/my-library
|
||||
|
||||
Passing branch names, a commit hash or a tag name is possible like so:
|
||||
|
||||
* hg+hg://hg.server.org/my-library#master
|
||||
* hg+https://hg.server.org/my-library#v1.0
|
||||
* hg+ssh://hg.server.org/my-library#4cfe2fa00668
|
||||
|
||||
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-library
|
||||
* svn+https://svn.server.org/my-library
|
||||
* svn+ssh://svn.server.org/my-library
|
||||
|
||||
You can also give specific revisions to an SVN URL, like so:
|
||||
|
||||
* svn+svn://svn.server.org/my-library#13
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
1. Install the latest version of library
|
||||
1. Install the latest version of library to a global storage using ID or NAME
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
# IRremote: http://platformio.org/lib/show/4/IRremote
|
||||
$ platformio lib install 4
|
||||
# Installing library [ 4 ]:
|
||||
# Downloading [####################################] 100%
|
||||
# Unpacking [####################################] 100%
|
||||
# The library #4 'IRremote' has been successfully installed!
|
||||
> platformio 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
|
||||
> platformio lib -g install IRRemote
|
||||
|
||||
Library Storage: /storage/dir/...
|
||||
Looking for IRRemote library in registry
|
||||
Found: http://platformio.org/lib/show/4/IRremote
|
||||
LibraryManager: Installing id=4
|
||||
IRremote @ 2.2.1 is already installed
|
||||
|
||||
|
||||
2. Install specified version of library
|
||||
2. Install specified version of a library to a global storage
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
# XBee: http://platformio.org/lib/show/6/XBee
|
||||
$ platformio lib install 6 --version=0.5
|
||||
# Installing library [ 6 ]:
|
||||
# Downloading [####################################] 100%
|
||||
# Unpacking [####################################] 100%
|
||||
# The library #6 'XBee' has been successfully installed!
|
||||
> platformio lib -g install Json@5.4.0
|
||||
|
||||
Library Storage: /storage/dir/...
|
||||
Looking for Json library in registry
|
||||
Found: http://platformio.org/lib/show/64/Json
|
||||
LibraryManager: Installing id=64 @ 5.4.0
|
||||
Downloading [####################################] 100%
|
||||
Unpacking [####################################] 100%
|
||||
Json @ 5.4.0 has been successfully installed!
|
||||
|
||||
|
||||
3. Install library with dependencies
|
||||
3. Install library with dependencies to custom storage
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
# Adafruit-ST7735: http://platformio.org/lib/show/12/Adafruit-ST7735
|
||||
$ platformio lib install 12
|
||||
# Installing library [ 12 ]:
|
||||
# Downloading [####################################] 100%
|
||||
# Unpacking [####################################] 100%
|
||||
# The library #12 'Adafruit-ST7735' has been successfully installed!
|
||||
# Installing dependencies:
|
||||
# Installing library [ 13 ]:
|
||||
# Downloading [####################################] 100%
|
||||
# Unpacking [####################################] 100%
|
||||
# The library #13 'Adafruit-GFX' has been successfully installed!
|
||||
> platformio lib --storage-dir /my/storage/dir install DallasTemperature
|
||||
|
||||
Library Storage: /my/storage/dir
|
||||
Looking for DallasTemperature library in registry
|
||||
Found: http://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: http://platformio.org/lib/show/1/OneWire
|
||||
LibraryManager: Installing id=1
|
||||
Downloading [####################################] 100%
|
||||
Unpacking [####################################] 100%
|
||||
OneWire @ 8fd2ebfec7 has been successfully installed!
|
||||
|
||||
4. Install ARM mbed library to the global storage
|
||||
|
||||
.. code::
|
||||
|
||||
> platformio 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!
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
||||
.. Copyright 2014-present Ivan Kravets <me@ikravets.com>
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
@@ -21,14 +21,30 @@ Usage
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
platformio lib [STORAGE_OPTIONS] list [OPTIONS]
|
||||
|
||||
# list project dependent libraries
|
||||
# (run it from a project root where is located "platformio.ini")
|
||||
platformio lib list [OPTIONS]
|
||||
|
||||
# list libraries from global storage
|
||||
platformio lib --global list [OPTIONS]
|
||||
platformio lib -g list [OPTIONS]
|
||||
|
||||
# list libraries from custom storage
|
||||
platformio lib --storage-dir /path/to/dir list [OPTIONS]
|
||||
platformio lib -d /path/to/dir list [OPTIONS]
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
List installed libraries
|
||||
|
||||
Storage Options
|
||||
---------------
|
||||
|
||||
See base options for :ref:`userguide_lib`.
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
@@ -42,18 +58,14 @@ Return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib list
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 23 ] Adafruit-L3GD20-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the L3GD20 Gyroscope
|
||||
# [ 12 ] Adafruit-ST7735 arduino, atmelavr "Adafruit Industries": A library for the Adafruit 1.8" SPI display
|
||||
# [ 31 ] Adafruit-Unified-Sensor arduino, atmelavr "Adafruit Industries": Adafruit Unified Sensor Driver
|
||||
# [ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer)
|
||||
# [ 6 ] XBee arduino, atmelavr "Andrew Rapp": Arduino library for communicating with XBees in API mode
|
||||
# [ 13 ] Adafruit-GFX arduino, atmelavr "Adafruit Industries": A core graphics library for all our displays, providing a common set of graphics primitives (points, lines, circles, etc.)
|
||||
# [ 4 ] IRremote arduino, atmelavr "Ken Shirriff": Send and receive infrared signals with multiple protocols
|
||||
# [ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
# ...
|
||||
> platformio lib list
|
||||
|
||||
pio lib -g list
|
||||
Library Storage: /storage/dir/...
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
[ 4 ] IRremote arduino, atmelavr "Rafi Khan, Ken Shirriff": Send and receive infrared signals with multiple protocols | @2.2.1
|
||||
[ 64 ] Json arduino, atmelavr, atmelsam, timsp430, titiva, teensy, freescalekinetis, ststm32, nordicnrf51, nxplpc, espressif, siliconlabsefm32, linux_arm, native, intel_arc32 "Benoit Blanchon": An elegant and efficient JSON library for embedded systems | @5.4.0
|
||||
[ VCS ] TextLCD - "Unknown": hg+https://developer.mbed.org/users/simon/code/TextLCD/ | @308d188a2d3a
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
||||
.. Copyright 2014-present Ivan Kravets <me@ikravets.com>
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
@@ -32,6 +32,6 @@ Register new library and allow others to install it.
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib register http://my.example.com/library.json
|
||||
platformio lib register http://my.example.com/raw-library.json
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
||||
.. Copyright 2014-present Ivan Kravets <me@ikravets.com>
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
@@ -74,6 +74,11 @@ Options
|
||||
|
||||
.. program:: platformio lib search
|
||||
|
||||
.. option::
|
||||
-n, --name
|
||||
|
||||
Filter libraries by specified name (strict search)
|
||||
|
||||
.. option::
|
||||
-a, --author
|
||||
|
||||
@@ -112,126 +117,134 @@ Examples
|
||||
|
||||
1. List all libraries
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search
|
||||
# Found N libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
# [ 13 ] Adafruit-GFX arduino, atmelavr "Adafruit Industries": A core graphics library for all our displays, providing a common set of graphics primitives (points, lines, circles, etc.)
|
||||
# [ 23 ] Adafruit-L3GD20-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the L3GD20 Gyroscope
|
||||
# [ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer)
|
||||
# [ 12 ] Adafruit-ST7735 arduino, atmelavr "Adafruit Industries": A library for the Adafruit 1.8" SPI display
|
||||
# [ 31 ] Adafruit-Unified-Sensor arduino, atmelavr "Adafruit Industries": Adafruit Unified Sensor Driver
|
||||
# [ 4 ] IRremote arduino, atmelavr "Ken Shirriff": Send and receive infrared signals with multiple protocols
|
||||
# [ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)
|
||||
# [ 6 ] XBee arduino, atmelavr "Andrew Rapp": Arduino library for communicating with XBees in API mode
|
||||
# [ 15 ] Adafruit-ADXL345-Unified arduino, atmelavr "Adafruit Industries": Unified driver for the ADXL345 Accelerometer
|
||||
# Show next libraries? [y/N]:
|
||||
# ...
|
||||
> platformio lib search
|
||||
|
||||
Found N libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
[ 13 ] Adafruit-GFX arduino, atmelavr "Adafruit Industries": A core graphics library for all our displays, providing a common set of graphics primitives (points, lines, circles, etc.)
|
||||
[ 23 ] Adafruit-L3GD20-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the L3GD20 Gyroscope
|
||||
[ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer)
|
||||
[ 12 ] Adafruit-ST7735 arduino, atmelavr "Adafruit Industries": A library for the Adafruit 1.8" SPI display
|
||||
[ 31 ] Adafruit-Unified-Sensor arduino, atmelavr "Adafruit Industries": Adafruit Unified Sensor Driver
|
||||
[ 4 ] IRremote arduino, atmelavr "Ken Shirriff": Send and receive infrared signals with multiple protocols
|
||||
[ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)
|
||||
[ 6 ] XBee arduino, atmelavr "Andrew Rapp": Arduino library for communicating with XBees in API mode
|
||||
[ 15 ] Adafruit-ADXL345-Unified arduino, atmelavr "Adafruit Industries": Unified driver for the ADXL345 Accelerometer
|
||||
Show next libraries? [y/N]:
|
||||
...
|
||||
|
||||
2. Search for `1-Wire libraries <http://platformio.org/lib/search?query=%25221-wire%2522>`_
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search "1-wire"
|
||||
# Found N libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)
|
||||
# ...
|
||||
> platformio lib search "1-wire"
|
||||
|
||||
Found N libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)
|
||||
...
|
||||
|
||||
3. Search for `Arduino-based "I2C" libraries <http://platformio.org/lib/search?query=framework%253Aarduino%2520i2c>`_
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search "i2c" --framework="arduino"
|
||||
# Found N libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 11 ] I2Cdevlib-Core arduino, atmelavr "Jeff Rowberg": The I2C Device Library (I2Cdevlib) is a collection of uniform and well-documented classes to provide simple and intuitive interfaces to I2C devices.
|
||||
# [ 24 ] Adafruit-L3GD20 arduino, atmelavr "Adafruit Industries": Driver for Adafruit's L3GD20 I2C Gyroscope Breakout
|
||||
# [ 10 ] I2Cdevlib-AK8975 arduino, atmelavr "Jeff Rowberg": AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology
|
||||
# [ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
# ...
|
||||
> platformio lib search "i2c" --framework="arduino"
|
||||
|
||||
Found N libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 11 ] I2Cdevlib-Core arduino, atmelavr "Jeff Rowberg": The I2C Device Library (I2Cdevlib) is a collection of uniform and well-documented classes to provide simple and intuitive interfaces to I2C devices.
|
||||
[ 24 ] Adafruit-L3GD20 arduino, atmelavr "Adafruit Industries": Driver for Adafruit's L3GD20 I2C Gyroscope Breakout
|
||||
[ 10 ] I2Cdevlib-AK8975 arduino, atmelavr "Jeff Rowberg": AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology
|
||||
[ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
...
|
||||
|
||||
4. Search for `libraries by "web" and "http" keywords <http://platformio.org/lib/search?query=keyword%253A%2522web%2522%2520keyword%253A%2522http%2522>`_.
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search --keyword="web" --keyword="http"
|
||||
# Found N libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 5 ] Webduino arduino, atmelavr "Ben Combee": An extensible web server library (for use with the Arduino WizNet Ethernet Shield)
|
||||
# [ 17 ] Adafruit-CC3000 arduino, atmelavr "Adafruit Industries": Library code for Adafruit's CC3000 Wi-Fi/WiFi breakouts
|
||||
# ...
|
||||
> platformio lib search --keyword="web" --keyword="http"
|
||||
|
||||
Found N libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 5 ] Webduino arduino, atmelavr "Ben Combee": An extensible web server library (for use with the Arduino WizNet Ethernet Shield)
|
||||
[ 17 ] Adafruit-CC3000 arduino, atmelavr "Adafruit Industries": Library code for Adafruit's CC3000 Wi-Fi/WiFi breakouts
|
||||
...
|
||||
|
||||
5. Search for `libraries by "Adafruit Industries" author <http://platformio.org/lib/search?query=author%253A%2522Adafruit%20Industries%2522>`_
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search --author="Adafruit Industries"
|
||||
# Found N libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
# [ 13 ] Adafruit-GFX arduino, atmelavr "Adafruit Industries": A core graphics library for all our displays, providing a common set of graphics primitives (points, lines, circles, etc.)
|
||||
# [ 23 ] Adafruit-L3GD20-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the L3GD20 Gyroscope
|
||||
# [ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer)
|
||||
# ...
|
||||
> platformio lib search --author="Adafruit Industries"
|
||||
|
||||
Found N libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
[ 13 ] Adafruit-GFX arduino, atmelavr "Adafruit Industries": A core graphics library for all our displays, providing a common set of graphics primitives (points, lines, circles, etc.)
|
||||
[ 23 ] Adafruit-L3GD20-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the L3GD20 Gyroscope
|
||||
[ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer)
|
||||
...
|
||||
|
||||
6. Search for `libraries which are compatible with Dallas temperature sensors <http://platformio.org/lib/search?query=DS*>`_
|
||||
like DS18B20, DS18S20 and etc.
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search "DS*"
|
||||
# Found N libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)
|
||||
# ...
|
||||
> platformio lib search "DS*"
|
||||
|
||||
Found N libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 1 ] OneWire arduino, atmelavr "Paul Stoffregen": Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)
|
||||
...
|
||||
|
||||
7. Search for `Energia-based *nRF24* or *HttpClient* libraries <http://platformio.org/lib/search?query=framework%253Aenergia%2520%252B(nRF24%2520HttpClient)>`_.
|
||||
The search query that is described below can be interpreted like
|
||||
``energia nRF24 OR energia HttpClient``
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search "+(nRF24 HttpClient)" --framework="energia"
|
||||
# Found 2 libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 46 ] HttpClient energia, timsp430, titiva "Zack Lalanne": HttpClient is a library to make it easier to interact with web servers
|
||||
# [ 43 ] nRF24 energia, timsp430 "Eric": The nRF24L01 is a low-cost 2.4GHz ISM transceiver module. It supports a number of channel frequencies in the 2.4GHz band and a range of data rates.
|
||||
> platformio lib search "+(nRF24 HttpClient)" --framework="energia"
|
||||
|
||||
Found 2 libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 46 ] HttpClient energia, timsp430, titiva "Zack Lalanne": HttpClient is a library to make it easier to interact with web servers
|
||||
[ 43 ] nRF24 energia, timsp430 "Eric": The nRF24L01 is a low-cost 2.4GHz ISM transceiver module. It supports a number of channel frequencies in the 2.4GHz band and a range of data rates.
|
||||
|
||||
|
||||
8. Search for the `all sensor libraries excluding temperature <http://platformio.org/lib/search?query=sensor%2520-temperature>`_.
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib search "sensor -temperature"
|
||||
# Found N libraries:
|
||||
#
|
||||
# [ ID ] Name Compatibility "Authors": Description
|
||||
# -------------------------------------------------------------------------------------
|
||||
# [ 31 ] Adafruit-Unified-Sensor arduino, atmelavr "Adafruit Industries": Adafruit Unified Sensor Driver
|
||||
# [ 10 ] I2Cdevlib-AK8975 arduino, atmelavr "Jeff Rowberg": AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology
|
||||
# [ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
# [ 23 ] Adafruit-L3GD20-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the L3GD20 Gyroscope
|
||||
# [ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer)
|
||||
# [ 33 ] Adafruit-TMP006 arduino, atmelavr "Adafruit Industries": A library for the Adafruit TMP006 Infrared Thermopile Sensor
|
||||
# [ 34 ] Adafruit-TSL2561-Unified arduino, atmelavr "Adafruit Industries": Unified light sensor driver for Adafruit's TSL2561 breakouts
|
||||
# [ 97 ] I2Cdevlib-BMA150 arduino, atmelavr "Jeff Rowberg": The BMA150 is a triaxial, low-g acceleration sensor IC with digital output for consumer market applications
|
||||
# [ 106 ] I2Cdevlib-MPR121 arduino, atmelavr "Jeff Rowberg": The MPR121 is a 12-bit proximity capacitive touch sensor
|
||||
# [ 111 ] I2Cdevlib-AK8975 energia, timsp430 "Jeff Rowberg": AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology
|
||||
# Show next libraries? [y/N]:
|
||||
> platformio lib search "sensor -temperature"
|
||||
|
||||
Found N libraries:
|
||||
|
||||
[ ID ] Name Compatibility "Authors": Description
|
||||
-------------------------------------------------------------------------------------
|
||||
[ 31 ] Adafruit-Unified-Sensor arduino, atmelavr "Adafruit Industries": Adafruit Unified Sensor Driver
|
||||
[ 10 ] I2Cdevlib-AK8975 arduino, atmelavr "Jeff Rowberg": AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology
|
||||
[ 14 ] Adafruit-9DOF-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)
|
||||
[ 23 ] Adafruit-L3GD20-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for the L3GD20 Gyroscope
|
||||
[ 26 ] Adafruit-LSM303DLHC-Unified arduino, atmelavr "Adafruit Industries": Unified sensor driver for Adafruit's LSM303 Breakout (Accelerometer + Magnetometer)
|
||||
[ 33 ] Adafruit-TMP006 arduino, atmelavr "Adafruit Industries": A library for the Adafruit TMP006 Infrared Thermopile Sensor
|
||||
[ 34 ] Adafruit-TSL2561-Unified arduino, atmelavr "Adafruit Industries": Unified light sensor driver for Adafruit's TSL2561 breakouts
|
||||
[ 97 ] I2Cdevlib-BMA150 arduino, atmelavr "Jeff Rowberg": The BMA150 is a triaxial, low-g acceleration sensor IC with digital output for consumer market applications
|
||||
[ 106 ] I2Cdevlib-MPR121 arduino, atmelavr "Jeff Rowberg": The MPR121 is a 12-bit proximity capacitive touch sensor
|
||||
[ 111 ] I2Cdevlib-AK8975 energia, timsp430 "Jeff Rowberg": AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology
|
||||
Show next libraries? [y/N]:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
||||
.. Copyright 2014-present Ivan Kravets <me@ikravets.com>
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
@@ -21,28 +21,65 @@ Usage
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
platformio lib show ID
|
||||
platformio lib [STORAGE_OPTIONS] show [LIBRARY]
|
||||
|
||||
# show info about project dependent library
|
||||
# (run it from a project root where is located "platformio.ini")
|
||||
platformio lib show [LIBRARY]
|
||||
|
||||
# show info about library from global storage
|
||||
platformio lib --global show [LIBRARY]
|
||||
platformio lib -g show [LIBRARY]
|
||||
|
||||
# show info about library from custom storage
|
||||
platformio lib --storage-dir /path/to/dir show [LIBRARY]
|
||||
platformio lib -d /path/to/dir show [LIBRARY]
|
||||
|
||||
# [LIBRARY] forms
|
||||
platformio lib [STORAGE_OPTIONS] show <id>
|
||||
platformio lib [STORAGE_OPTIONS] show <id>
|
||||
platformio lib [STORAGE_OPTIONS] show <id>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] show <id>@<version range>
|
||||
platformio lib [STORAGE_OPTIONS] show <name>
|
||||
platformio lib [STORAGE_OPTIONS] show <name>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] show <name>@<version range>
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Show details about the installed library
|
||||
Show details about the installed library.
|
||||
|
||||
The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
|
||||
``<major>.<minor>.<patch>``) and can take any of the following forms:
|
||||
|
||||
* ``0.1.2`` - an exact version number. Use only this exact version
|
||||
* ``^0.1.2`` - any compatible version (exact version for ``0.x.x`` versions
|
||||
* ``~0.1.2`` - any version with the same major and minor versions, and an
|
||||
equal or greater patch version
|
||||
* ``>0.1.2`` - any version greater than ``0.1.2``. ``>=``, ``<``, 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``
|
||||
|
||||
Storage Options
|
||||
---------------
|
||||
|
||||
See base options for :ref:`userguide_lib`.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
# OneWire: http://platformio.org/lib/show/1/OneWire
|
||||
$ platformio lib show 1
|
||||
# OneWire
|
||||
# -------
|
||||
# Authors: Paul Stoffregen <paul@pjrc.com> http://www.pjrc.com/teensy/td_libs_OneWire.html (maintainer), Jim Studt, Jason Dangel <dangel.jason@gmail.com>, Derek Yerger, Tom Pollard <pollard@alum.mit.edu>, Robin James
|
||||
# Keywords: onewire, 1-wire, bus, sensor, temperature, ibutton
|
||||
# Frameworks: arduino
|
||||
# Platforms: atmelavr
|
||||
# Version: 2.2
|
||||
#
|
||||
# Control devices (from Dallas Semiconductor) that use the One Wire protocol (DS18S20, DS18B20, DS2408 and etc)
|
||||
platformio lib -g show Json
|
||||
|
||||
Library Storage: /storage/dir/...
|
||||
Json
|
||||
====
|
||||
An elegant and efficient JSON library for embedded systems
|
||||
|
||||
Authors: Benoit Blanchon http://blog.benoitblanchon.fr
|
||||
Keywords: json, rest, http, web
|
||||
Frameworks: arduino
|
||||
Platforms: atmelavr, atmelsam, timsp430, titiva, teensy, freescalekinetis, ststm32, nordicnrf51, nxplpc, espressif, siliconlabsefm32, linux_arm, native, intel_arc32
|
||||
Version: 5.4.0
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
||||
.. Copyright 2014-present Ivan Kravets <me@ikravets.com>
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
@@ -21,20 +21,56 @@ Usage
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
platformio lib uninstall ID
|
||||
platformio lib [STORAGE_OPTIONS] uninstall [LIBRARY...]
|
||||
|
||||
# uninstall project dependent library
|
||||
# (run it from a project root where is located "platformio.ini")
|
||||
platformio lib uninstall [LIBRARY...]
|
||||
|
||||
# uninstall library from global storage
|
||||
platformio lib --global uninstall [LIBRARY...]
|
||||
platformio lib -g uninstall [LIBRARY...]
|
||||
|
||||
# uninstall library from custom storage
|
||||
platformio lib --storage-dir /path/to/dir uninstall [LIBRARY...]
|
||||
platformio lib -d /path/to/dir uninstall [LIBRARY...]
|
||||
|
||||
# [LIBRARY...] forms
|
||||
platformio lib [STORAGE_OPTIONS] uninstall <id>
|
||||
platformio lib [STORAGE_OPTIONS] uninstall <id>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] uninstall <id>@<version range>
|
||||
platformio lib [STORAGE_OPTIONS] uninstall <name>
|
||||
platformio lib [STORAGE_OPTIONS] uninstall <name>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] uninstall <name>@<version range>
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Uninstall specified library
|
||||
|
||||
The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
|
||||
``<major>.<minor>.<patch>``) and can take any of the following forms:
|
||||
|
||||
* ``0.1.2`` - an exact version number. Use only this exact version
|
||||
* ``^0.1.2`` - any compatible version (exact version for ``0.x.x`` versions
|
||||
* ``~0.1.2`` - any version with the same major and minor versions, and an
|
||||
equal or greater patch version
|
||||
* ``>0.1.2`` - any version greater than ``0.1.2``. ``>=``, ``<``, 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``
|
||||
|
||||
Storage Options
|
||||
---------------
|
||||
|
||||
See base options for :ref:`userguide_lib`.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
# XBee: http://platformio.org/lib/show/6/XBee
|
||||
$ platformio lib uninstall 6
|
||||
# The library #6 'XBee' has been successfully uninstalled!
|
||||
> platformio lib -g uninstall AsyncMqttClient
|
||||
|
||||
Library Storage: /storage/dir/...
|
||||
Uninstalling AsyncMqttClient @ 0.2.0: [OK]
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
||||
.. Copyright 2014-present Ivan Kravets <me@ikravets.com>
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
@@ -21,51 +21,102 @@ Usage
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
platformio lib update [LIBRARY_ID]
|
||||
platformio lib [STORAGE_OPTIONS] update [OPTIONS]
|
||||
|
||||
# update all project libraries
|
||||
# (run it from a project root where is located "platformio.ini")
|
||||
platformio lib update [OPTIONS]
|
||||
|
||||
# update project dependent library
|
||||
platformio lib [STORAGE_OPTIONS] update [OPTIONS] [LIBRARY...]
|
||||
|
||||
# update library in global storage
|
||||
platformio lib --global update [OPTIONS] [LIBRARY...]
|
||||
platformio lib -g update [OPTIONS] [LIBRARY...]
|
||||
|
||||
# update library in custom storage
|
||||
platformio lib --storage-dir /path/to/dir update [OPTIONS] [LIBRARY...]
|
||||
platformio lib -d /path/to/dir update [OPTIONS] [LIBRARY...]
|
||||
|
||||
# [LIBRARY...] forms
|
||||
platformio lib [STORAGE_OPTIONS] update <id>
|
||||
platformio lib [STORAGE_OPTIONS] update <id>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] update <id>@<version range>
|
||||
platformio lib [STORAGE_OPTIONS] update <name>
|
||||
platformio lib [STORAGE_OPTIONS] update <name>@<version>
|
||||
platformio lib [STORAGE_OPTIONS] update <name>@<version range>
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Check or update installed libraries
|
||||
Check or update installed libraries.
|
||||
|
||||
The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
|
||||
``<major>.<minor>.<patch>``) and can take any of the following forms:
|
||||
|
||||
* ``0.1.2`` - an exact version number. Use only this exact version
|
||||
* ``^0.1.2`` - any compatible version (exact version for ``0.x.x`` versions
|
||||
* ``~0.1.2`` - any version with the same major and minor versions, and an
|
||||
equal or greater patch version
|
||||
* ``>0.1.2`` - any version greater than ``0.1.2``. ``>=``, ``<``, 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``
|
||||
|
||||
Storage Options
|
||||
---------------
|
||||
|
||||
See base options for :ref:`userguide_lib`.
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
.. program:: platformio lib update
|
||||
|
||||
.. option::
|
||||
-c, --only-check
|
||||
|
||||
Do not update, only check for new version
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
1. Update all installed libraries
|
||||
1. Update all installed libraries in global storage
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio lib update
|
||||
# Updating [ 23 ] Adafruit-L3GD20-Unified library:
|
||||
# Versions: Current=63de2eb9ea, Latest=63de2eb9ea [Up-to-date]
|
||||
# Updating [ 12 ] Adafruit-ST7735 library:
|
||||
# Versions: Current=e880eb1687, Latest=e880eb1687 [Up-to-date]
|
||||
# Updating [ 31 ] Adafruit-Unified-Sensor library:
|
||||
# Versions: Current=88ae805bce, Latest=88ae805bce [Up-to-date]
|
||||
# Updating [ 26 ] Adafruit-LSM303DLHC-Unified library:
|
||||
# Versions: Current=59767208a8, Latest=59767208a8 [Up-to-date]
|
||||
# Updating [ 13 ] Adafruit-GFX library:
|
||||
# Versions: Current=a9e5bc4707, Latest=a9e5bc4707 [Up-to-date]
|
||||
# Updating [ 1 ] OneWire library:
|
||||
# Versions: Current=2.2, Latest=2.2 [Up-to-date]
|
||||
# Updating [ 4 ] IRremote library:
|
||||
# Versions: Current=f2dafe5030, Latest=f2dafe5030 [Up-to-date]
|
||||
# Updating [ 14 ] Adafruit-9DOF-Unified library:
|
||||
# Versions: Current=b2f07242ac, Latest=b2f07242ac [Up-to-date]
|
||||
> platformio lib -g update
|
||||
|
||||
2. Update specified libraries
|
||||
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)
|
||||
|
||||
.. code-block:: bash
|
||||
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
|
||||
|
||||
$ platformio lib update 1 59
|
||||
# Updating [ 1 ] OneWire library:
|
||||
# Versions: Current=2.2, Latest=2.2 [Up-to-date]
|
||||
# Updating [ 59 ] USB-Host-Shield-20 library:
|
||||
# Versions: Current=fcab83dcb3, Latest=c61f9ce1c2 [Out-of-date]
|
||||
# The library #59 'USB-Host-Shield-20' has been successfully uninstalled!
|
||||
# Installing library [ 59 ]:
|
||||
# Downloading [####################################] 100%
|
||||
# Unpacking [####################################] 100%
|
||||
# The library #59 'USB-Host-Shield-20' has been successfully installed!
|
||||
2. Update specified libraries in global storage
|
||||
|
||||
.. code::
|
||||
|
||||
> platformio lib -g update Json 4
|
||||
|
||||
Library Storage: /storage/dir/...
|
||||
Updating Json @ 5.6.4: [Up-to-date]
|
||||
Updating IRremote @ 2.2.1: [Up-to-date]
|
||||
|
||||
@@ -14,15 +14,48 @@
|
||||
Library Manager
|
||||
===============
|
||||
|
||||
To print all available commands and options use:
|
||||
Usage
|
||||
-----
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ platformio lib --help
|
||||
$ platformio lib COMMAND --help
|
||||
platformio lib [OPTIONS] COMMAND
|
||||
|
||||
# To print all available commands and options use
|
||||
platformio lib --help
|
||||
platformio lib COMMAND --help
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
.. program:: platformio lib
|
||||
|
||||
.. option::
|
||||
-g, --global
|
||||
|
||||
.. versionadded:: 3.0
|
||||
|
||||
|
||||
Manage global PlatformIO's library storage (
|
||||
":ref:`projectconf_pio_home_dir`/lib") where :ref:`ldf` will look for
|
||||
dependencies by default.
|
||||
|
||||
.. option::
|
||||
-d, --storage-dir
|
||||
|
||||
.. versionadded:: 3.0
|
||||
|
||||
Manage custom library storage. It can be used later for the
|
||||
:ref:`projectconf_extra_script` option from :ref:`projectconf`.
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
.. image:: ../../_static/platformio-demo-lib.gif
|
||||
|
||||
Commands
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
@@ -21,14 +21,18 @@ Usage
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
# install platform by name
|
||||
platformio platform install [OPTIONS] [PLATFORM...]
|
||||
|
||||
# install specific platform version using Semantic Versioning
|
||||
platformio platform install [OPTIONS] PLATFORM@X.Y.Z
|
||||
|
||||
# install platform using URL
|
||||
platformio platform install [OPTIONS] URL
|
||||
# [PLATFORM...] forms
|
||||
platformio platform install <name>
|
||||
platformio platform install <name>@<version>
|
||||
platformio platform install <name>@<version range>
|
||||
platformio platform install <zip or tarball url>
|
||||
platformio platform install file://<zip or tarball file>
|
||||
platformio platform install file://<folder>
|
||||
platformio platform install <repository>
|
||||
platformio platform install <name=repository> (name it should have locally)
|
||||
platformio platform install <repository#tag> ("tag" can be commit, branch or tag)
|
||||
|
||||
|
||||
Description
|
||||
@@ -36,33 +40,56 @@ Description
|
||||
|
||||
Install :ref:`platforms` and dependent packages.
|
||||
|
||||
There are several predefined aliases for packages, such as:
|
||||
The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
|
||||
``<major>.<minor>.<patch>``) and can take any of the following forms:
|
||||
|
||||
* ``framework``
|
||||
* ``toolchain``
|
||||
* ``uploader``
|
||||
* ``0.1.2`` - an exact version number. Use only this exact version
|
||||
* ``^0.1.2`` - any compatible version (exact version for ``0.x.x`` versions
|
||||
* ``~0.1.2`` - any version with the same major and minor versions, and an
|
||||
equal or greater patch version
|
||||
* ``>0.1.2`` - any version greater than ``0.1.2``. ``>=``, ``<``, 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``
|
||||
|
||||
Local
|
||||
~~~~~
|
||||
|
||||
PlatformIO supports installing development platform from local directory or
|
||||
archive. Need to use ``file://`` prefix before local path. Also, platform
|
||||
directory or archive should contain ``platform.json`` manifest.
|
||||
Also, PlatformIO supports installing from local directory or archive. Need to
|
||||
use ``file://`` prefix before local path. Also, directory or archive should
|
||||
contain ``platform.json`` manifest.
|
||||
|
||||
* ``file:///local/path/to/the/platform/dir``
|
||||
* ``file:///local/path/to/the/platform.zip``
|
||||
* ``file:///local/path/to/the/platform.tar.gz``
|
||||
|
||||
Remote
|
||||
~~~~~~
|
||||
Options
|
||||
-------
|
||||
|
||||
VCS
|
||||
~~~
|
||||
.. program:: platformio platform install
|
||||
|
||||
.. option::
|
||||
--with-package
|
||||
|
||||
Install specified package (or alias)
|
||||
|
||||
|
||||
.. option::
|
||||
--without-package
|
||||
|
||||
Do not install specified package (or alias)
|
||||
|
||||
.. option::
|
||||
--skip-default
|
||||
|
||||
Skip default packages
|
||||
|
||||
Version control
|
||||
---------------
|
||||
|
||||
PlatformIO supports installing from Git, Mercurial and Subversion, and detects
|
||||
the type of VCS using url prefixes: "git+", "hg+", or "svn+".
|
||||
|
||||
PlatformIO requires a working VCS command on your path: git, hg or svn.
|
||||
.. note::
|
||||
PlatformIO requires a working VCS command on your path: ``git``, ``hg``
|
||||
or ``svn``.
|
||||
|
||||
Git
|
||||
^^^
|
||||
@@ -70,6 +97,7 @@ Git
|
||||
The supported schemes are: ``git``, ``git+https`` and ``git+ssh``. Here are
|
||||
the supported forms:
|
||||
|
||||
* platformio/platform-NAME (short version for GitHub repository)
|
||||
* https://github.com/platformio/platform-NAME.git
|
||||
* git+git://git.server.org/my-platform
|
||||
* git+https://git.server.org/my-platform
|
||||
@@ -112,35 +140,15 @@ You can also give specific revisions to an SVN URL, like so:
|
||||
|
||||
* svn+svn://svn.server.org/my-platform#13
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
.. program:: platformio platform install
|
||||
|
||||
.. option::
|
||||
--with-package
|
||||
|
||||
Install specified package (or alias)
|
||||
|
||||
|
||||
.. option::
|
||||
--without-package
|
||||
|
||||
Do not install specified package (or alias)
|
||||
|
||||
.. option::
|
||||
--skip-default
|
||||
|
||||
Skip default packages
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
1. Install :ref:`platform_atmelavr` with default packages
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform install atmelavr
|
||||
|
||||
$ platformio platform install atmelavr
|
||||
PlatformManager: Installing atmelavr
|
||||
Downloading...
|
||||
Unpacking [####################################] 100%
|
||||
@@ -159,7 +167,9 @@ Examples
|
||||
2. Install :ref:`platform_atmelavr` with ``uploader`` utility only and skip
|
||||
default packages
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform install atmelavr --skip-default-package --with-package=uploader
|
||||
|
||||
PlatformManager: Installing atmelavr
|
||||
Downloading [####################################] 100%
|
||||
@@ -178,9 +188,9 @@ Examples
|
||||
|
||||
3. Install the latest development :ref:`platform_atmelavr` from Git repository
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio platform install https://github.com/platformio/platform-atmelavr.git
|
||||
> platformio platform install https://github.com/platformio/platform-atmelavr.git
|
||||
|
||||
PlatformManager: Installing platform-atmelavr
|
||||
git version 2.7.4 (Apple Git-66)
|
||||
|
||||
@@ -42,9 +42,10 @@ Return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform list
|
||||
|
||||
$ platformio platform list
|
||||
atmelavr ~ Atmel AVR
|
||||
====================
|
||||
Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
|
||||
|
||||
@@ -45,9 +45,10 @@ Examples
|
||||
|
||||
1. Print all available development platforms
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform search
|
||||
|
||||
$ platformio platform search
|
||||
atmelavr ~ Atmel AVR
|
||||
====================
|
||||
Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
|
||||
@@ -75,9 +76,10 @@ Examples
|
||||
|
||||
2. Search for TI development platforms
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform search texas
|
||||
|
||||
$ platformio platform search texas
|
||||
timsp430 ~ TI MSP430
|
||||
====================
|
||||
MSP430 microcontrollers (MCUs) from Texas Instruments (TI) are 16-bit, RISC-based, mixed-signal processors designed for ultra-low power. These MCUs offer the lowest power consumption and the perfect mix of integrated peripherals for thousands of applications.
|
||||
@@ -92,9 +94,10 @@ Examples
|
||||
Home: http://platformio.org/platforms/titiva
|
||||
Packages: ldscripts, framework-libopencm3, toolchain-gccarmnoneeabi, tool-lm4flash, framework-energiativa
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform search framework-mbed
|
||||
|
||||
$ platformio platform search framework-mbed
|
||||
atmelsam ~ Atmel SAM
|
||||
====================
|
||||
Atmel | SMART offers Flash- based ARM products based on the ARM Cortex-M0+, Cortex-M3 and Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich peripheral and feature mix.
|
||||
|
||||
@@ -33,9 +33,10 @@ Show details about the installed :ref:`platforms`
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform show atmelavr
|
||||
|
||||
$ platformio platform show atmelavr
|
||||
atmelavr ~ Atmel AVR
|
||||
====================
|
||||
Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
|
||||
|
||||
@@ -36,9 +36,9 @@ Uninstall specified :ref:`platforms`
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
$ platformio platform uninstall atmelavr
|
||||
> platformio platform uninstall atmelavr
|
||||
Uninstalling platform atmelavr @ 0.0.0: [OK]
|
||||
Uninstalling package tool-scons @ 2.4.1: [OK]
|
||||
Uninstalling package toolchain-atmelavr @ 1.40801.0: [OK]
|
||||
|
||||
@@ -51,9 +51,10 @@ Do not update, only check for new version
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: bash
|
||||
.. code::
|
||||
|
||||
> platformio platform update
|
||||
|
||||
$ platformio platform update
|
||||
Platform atmelavr
|
||||
--------
|
||||
Updating atmelavr @ 0.0.0: [Up-to-date]
|
||||
|
||||
@@ -18,8 +18,8 @@ To print all available commands and options use:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ platformio platform --help
|
||||
$ platformio platform COMMAND --help
|
||||
platformio platform --help
|
||||
platformio platform COMMAND --help
|
||||
|
||||
.. image:: ../../_static/platformio-demo-platforms.gif
|
||||
|
||||
|
||||
Reference in New Issue
Block a user