diff --git a/docs/librarymanager/config.rst b/docs/librarymanager/config.rst index 2befb7df..2f0e5bbf 100644 --- a/docs/librarymanager/config.rst +++ b/docs/librarymanager/config.rst @@ -1,5 +1,5 @@ -.. _library_config: .. |PIOAPICR| replace:: *PlatformIO Library Registry Crawler* +.. _library_config: library.json ============ diff --git a/docs/librarymanager/creating.rst b/docs/librarymanager/creating.rst index 890d3588..12406eb2 100644 --- a/docs/librarymanager/creating.rst +++ b/docs/librarymanager/creating.rst @@ -36,7 +36,7 @@ you **need to specify** only these fields in the :ref:`library_config`: * :ref:`libjson_repository` |PIOAPICR| will populate the rest fields, like :ref:`libjson_version` or -:ref:`libjson_author` with an actual information from *GitHub*. +:ref:`libjson_authors` with an actual information from *GitHub*. Example: @@ -62,7 +62,7 @@ The list of **required** fields in the :ref:`library_config` will look like: * :ref:`libjson_name` * :ref:`libjson_keywords` * :ref:`libjson_description` -* :ref:`libjson_author` +* :ref:`libjson_authors` * :ref:`libjson_repository` Example: @@ -97,7 +97,7 @@ of **required** fields in the :ref:`library_config` will look like: * :ref:`libjson_name` * :ref:`libjson_keywords` * :ref:`libjson_description` -* :ref:`libjson_author` +* :ref:`libjson_authors` * :ref:`libjson_version` * :ref:`libjson_downloadurl` diff --git a/docs/userguide/lib/cmd_install.rst b/docs/userguide/lib/cmd_install.rst index 4ba8755e..b31a6b04 100644 --- a/docs/userguide/lib/cmd_install.rst +++ b/docs/userguide/lib/cmd_install.rst @@ -35,38 +35,38 @@ Examples .. code-block:: bash - # IRremote: http://platformio.ikravets.com/#!/lib/show/4 + # IRremote: http://platformio.ikravets.com/#!/lib/show/4/IRremote $ platformio lib install 4 - Installing library [ 4 ]: - Downloading [####################################] 100% - Unpacking [####################################] 100% - The library #4 'IRremote' has been successfully installed! + # Installing library [ 4 ]: + # Downloading [####################################] 100% + # Unpacking [####################################] 100% + # The library #4 'IRremote' has been successfully installed! 2. Install specified version of library .. code-block:: bash - # XBee: http://platformio.ikravets.com/#!/lib/show/6 + # XBee: http://platformio.ikravets.com/#!/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! + # Installing library [ 6 ]: + # Downloading [####################################] 100% + # Unpacking [####################################] 100% + # The library #6 'XBee' has been successfully installed! 3. Install library with dependencies .. code-block:: bash - # Adafruit-ST7735: http://platformio.ikravets.com/#!/lib/show/12 + # Adafruit-ST7735: http://platformio.ikravets.com/#!/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! + # 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! diff --git a/docs/userguide/lib/cmd_list.rst b/docs/userguide/lib/cmd_list.rst index a5ea681e..5ab7e0dc 100644 --- a/docs/userguide/lib/cmd_list.rst +++ b/docs/userguide/lib/cmd_list.rst @@ -25,15 +25,15 @@ Examples .. code-block:: bash $ 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) - ... + # + # [ 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) + # ... diff --git a/docs/userguide/lib/cmd_search.rst b/docs/userguide/lib/cmd_search.rst index e9bae79e..7bcf28b0 100644 --- a/docs/userguide/lib/cmd_search.rst +++ b/docs/userguide/lib/cmd_search.rst @@ -16,8 +16,8 @@ Usage Description ----------- -Search for library in *PlatformIO Library Registry* by -:ref:`library_config` fields in the boolean mode. +Search for library in `PlatformIO Library Registry `_ +by :ref:`library_config` fields in the boolean mode. The boolean search capability supports the following operators: @@ -91,101 +91,102 @@ Examples .. code-block:: bash $ platformio lib search "" - Found N libraries: + # 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]: + # ... - [ 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" library +2. Search for `1-Wire libraries `_ .. code-block:: bash - $ platformio lib search 1-wire - Found N libraries: + $ 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) + # ... - [ 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 operator. +3. Search for `Arduino-based "I2C" libraries `_ .. code-block:: bash - $ platformio lib search "i2c" --framework=arduino - Found N libraries: + $ 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) + # ... - [ 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. The ``""`` here is for - "empty" query argument. +4. Search for `libraries by "web" and "http" keywords `_. + The ``""`` here is for "empty" query argument .. code-block:: bash - $ platformio lib search "" --keyword=web --keyword=http - Found N libraries: + $ 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 + # ... - [ 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 from "Adafruit Industries" author. +5. Search for `libraries from "Adafruit Industries" author `_ .. code-block:: bash $ platformio lib search "" --author="Adafruit Industries" - Found N libraries: + # 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) + # ... - [ 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 that are compatible with Dallas temperature sensors +6. Search for `libraries that are compatible with Dallas temperature sensors `_ like DS18B20, DS18S20 and etc. .. code-block:: bash $ platformio lib search "DS*" - Found N libraries: + # 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) + # ... - [ 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 Arduino-based *X10* or *XBee* libraries. The search query that is - described below can be interpreted like ``arduino x10 OR arduino xbee``. +7. Search for `Arduino-based *X10* or *XBee* libraries `_. + The search query that is described below can be interpreted like + ``arduino x10 OR arduino xbee`` .. code-block:: bash - $ platformio lib search --framework=arduino "+(x10 xbee)" - Found 2 libraries: - - [ ID ] Name Compatibility "Authors": Description - ------------------------------------------------------------------------------------- - [ 36 ] X10 arduino, atmelavr "Doug Clinton": Sending X10 signals over AC power lines (PL513, TW523 and etc) - [ 6 ] XBee arduino, atmelavr "Andrew Rapp": Arduino library for communicating with XBees in API mode + $ platformio lib search "+(x10 xbee)" --framework="arduino" + # Found 2 libraries: + # + # [ ID ] Name Compatibility "Authors": Description + # ------------------------------------------------------------------------------------- + # [ 36 ] X10 arduino, atmelavr "Doug Clinton": Sending X10 signals over AC power lines (PL513, TW523 and etc) + # [ 6 ] XBee arduino, atmelavr "Andrew Rapp": Arduino library for communicating with XBees in API mode diff --git a/docs/userguide/lib/cmd_show.rst b/docs/userguide/lib/cmd_show.rst index a323669f..669acac6 100644 --- a/docs/userguide/lib/cmd_show.rst +++ b/docs/userguide/lib/cmd_show.rst @@ -24,14 +24,14 @@ Examples .. code-block:: bash - # OneWire: http://platformio.ikravets.com/#!/lib/show/1 + # OneWire: http://platformio.ikravets.com/#!/lib/show/1/OneWire $ platformio lib show 1 - OneWire - ------- - Authors: Paul Stoffregen http://www.pjrc.com/teensy/td_libs_OneWire.html - 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) + # OneWire + # ------- + # Authors: Paul Stoffregen http://www.pjrc.com/teensy/td_libs_OneWire.html (maintainer), Jim Studt, Jason Dangel , Derek Yerger, Tom Pollard , 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) diff --git a/docs/userguide/lib/cmd_uninstall.rst b/docs/userguide/lib/cmd_uninstall.rst index ed226e3e..b98025ed 100644 --- a/docs/userguide/lib/cmd_uninstall.rst +++ b/docs/userguide/lib/cmd_uninstall.rst @@ -24,6 +24,6 @@ Examples .. code-block:: bash - # XBee: http://platformio.ikravets.com/#!/lib/show/6 + # XBee: http://platformio.ikravets.com/#!/lib/show/6/XBee $ platformio lib uninstall 6 - The library #6 'XBee' has been successfully uninstalled! + # The library #6 'XBee' has been successfully uninstalled! diff --git a/docs/userguide/lib/cmd_update.rst b/docs/userguide/lib/cmd_update.rst index f1da7f9d..f719fa13 100644 --- a/docs/userguide/lib/cmd_update.rst +++ b/docs/userguide/lib/cmd_update.rst @@ -25,19 +25,19 @@ Examples .. code-block:: bash $ 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] + # 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]