• Documentation
  • PlatformIO
  • v3.5.0
PlatformIO
v3.5.0
  • What is PlatformIO?

Getting Started

  • PlatformIO IDE
  • PlatformIO Core
    • Demo
    • Installation
    • Quick Start
    • User Guide
      • Usage
      • Options
      • Commands
        • platformio account
        • platformio boards
        • platformio ci
        • platformio debug
        • platformio device
        • platformio home
        • platformio init
        • platformio lib
        • platformio platform
        • platformio remote
        • platformio run
        • platformio settings
        • platformio test
        • platformio update
        • platformio upgrade
  • PlatformIO Home
  • Tutorials and Examples

Configuration

  • platformio.ini
  • Environment variables
  • Advanced Scripting

Instruments

  • Library Manager
  • Platforms
  • Frameworks
  • Boards
  • Custom Platform & Board

PlatformIO Plus

  • PIO Account
  • PIO Remote™
  • PIO Unified Debugger
  • PIO Unit Testing

Integration

  • Cloud & Standalone IDE
  • Continuous Integration

Miscellaneous

  • Articles about us
  • FAQ
  • Migrating from 2.x to 3.0

platformio lib search¶

Contents

  • platformio lib search

    • Usage

    • Description

    • Options

    • Examples

Usage¶

platformio lib search [OPTIONS] [QUERY]
pio lib search [OPTIONS] [QUERY]

Description¶

Search for library in PlatformIO Library Registry by library.json fields in the boolean mode.

The boolean search capability supports the following operators:

Operator

Description

+

A leading or trailing plus sign indicates that this word must be present in library fields (see above) that is returned.

-

A leading or trailing minus sign indicates that this word must not be present in any of the libraries that are returned.

(no operator)

By default (when neither + nor - is specified), the word is optional, but the libraries that contain it are rated higher.

> <

These two operators are used to change a word’s contribution to the relevance value that is assigned to a library. The > operator increases the contribution and the < operator decreases it.

( )

Parentheses group words into subexpressions. Parenthesized groups can be nested.

~

A leading tilde acts as a negation operator, causing the word’s contribution to the library’s relevance to be negative. This is useful for marking “noise” words. A library containing such a word is rated lower than others, but is not excluded altogether, as it would be with the - operator.

*

The asterisk serves as the truncation (or wildcard) operator. Unlike the other operators, it is appended to the word to be affected. Words match if they begin with the word preceding the * operator.

"

A phrase that is enclosed within double quote (") characters matches only libraries that contain the phrase literally, as it was typed.

For more detail information please go to MySQL Boolean Full-Text Searches.

Options¶

-n, --name¶

Filter libraries by specified name (strict search)

-a, --author¶

Filter libraries by specified author

-k, --keyword¶

Filter libraries by specified keyword

-f, --framework¶

Filter libraries by specified framework

-p, --platform¶

Filter libraries by specified keyword

-i, --header¶

Filter libraries by header file (include)

For example, platformio lib search --header "OneWire.h"

--json-output¶

Return the output in JSON format

--page¶

Manually paginate through search results. This option is useful in pair with --json-output.

Examples¶

  1. List all libraries

> platformio lib search

Found N libraries:

ArduinoJson
===========
#ID: 64
An elegant and efficient JSON library for embedded systems

Keywords: web, json, http, rest
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR, Atmel SAM, Espressif 8266, Intel ARC32, Microchip PIC32, Nordic nRF51, Teensy, TI MSP430
Authors: Benoit Blanchon

DHT sensor library
==================
#ID: 19
Arduino library for DHT11, DHT22, etc Temp & Humidity Sensors

Keywords: unified, dht, sensor, temperature, humidity
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Adafruit Industries

PubSubClient
============
#ID: 89
A client library for MQTT messaging. MQTT is a lightweight messaging protocol ideal for small devices. This library allows you to send and receive MQTT messages. It supports the latest MQTT 3.1.1 protocol and can be configured to use the older MQTT 3.1...

Keywords: ethernet, mqtt, iot, m2m
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR, Atmel SAM, Espressif 8266, Intel ARC32, Microchip PIC32, Nordic nRF51, Teensy, TI MSP430
Authors: Nick O'Leary

...

ESPAsyncWebServer
=================
#ID: 306
Asynchronous HTTP and WebSocket Server Library for ESP8266 and ESP32

Keywords: async, websocket, http, webserver
Compatible frameworks: Arduino
Compatible platforms: Espressif 8266
Authors: Hristo Gochkov

Show next libraries? [y/N]:
...
  1. Search for 1-Wire libraries

> platformio lib search "1-wire"

Found N libraries:

DS1820
======
#ID: 196
Dallas / Maxim DS1820 1-Wire library. For communication with multiple DS1820 on a single 1-Wire bus. Also supports DS18S20 and DS18B20.

Keywords: ds18s20, 1-wire, ds1820, ds18b20
Compatible frameworks: mbed
Compatible platforms: Freescale Kinetis, Nordic nRF51, NXP LPC, ST STM32, Teensy
Authors: Michael Hagberg

OneWire
=======
#ID: 1
Control 1-Wire protocol (DS18S20, DS18B20, DS2408 and etc)

Keywords: onewire, temperature, bus, 1-wire, ibutton, sensor
Compatible frameworks: Arduino
Compatible platforms:
Authors: Paul Stoffregen, Jim Studt, Tom Pollard, Derek Yerger, Josh Larios, Robin James, Glenn Trewitt, Jason Dangel, Guillermo Lovato, Ken Butcher, Mark Tillotson, Bertrik Sikken, Scott Roberts

Show next libraries? [y/N]:
...
  1. Search for Arduino-based “I2C” libraries

> platformio lib search "i2c" --framework="arduino"

Found N libraries:

I2Cdevlib-AK8975
================
#ID: 10
AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology

Keywords: i2c, i2cdevlib, sensor, compass
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Jeff Rowberg

I2Cdevlib-Core
==============
#ID: 11
The I2C Device Library (I2Cdevlib) is a collection of uniform and well-documented classes to provide simple and intuitive interfaces to I2C devices.

Keywords: i2cdevlib, i2c
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Jeff Rowberg

Adafruit 9DOF Library
=====================
#ID: 14
Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)

Keywords: magnetometer, unified, accelerometer, spi, compass, i2c, sensor, gyroscope
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Adafruit Industries

Show next libraries? [y/N]:
...
  1. Search for libraries by “web” and “http” keywords.

> platformio lib search --keyword="web" --keyword="http"

Found N libraries:

ArduinoJson
===========
#ID: 64
An elegant and efficient JSON library for embedded systems

Keywords: web, json, http, rest
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR, Atmel SAM, Espressif 8266, Intel ARC32, Microchip PIC32, Nordic nRF51, Teensy, TI MSP430
Authors: Benoit Blanchon

ESPAsyncWebServer
=================
#ID: 306
Asynchronous HTTP and WebSocket Server Library for ESP8266 and ESP32

Keywords: async, websocket, http, webserver
Compatible frameworks: Arduino
Compatible platforms: Espressif 8266
Authors: Hristo Gochkov

ESP8266wifi
===========
#ID: 1101
ESP8266 Arduino library with built in reconnect functionality

Keywords: web, http, wifi, server, client, wi-fi
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Jonas Ekstrand

Blynk
=====
#ID: 415
Build a smartphone app for your project in minutes. Blynk allows creating IoT solutions easily. It supports  WiFi, BLE, Bluetooth, Ethernet, GSM, USB, Serial. Works with many boards like ESP8266, ESP32, Arduino UNO, Nano, Due, Mega, Zero, MKR100, Yun,...

Keywords: control, gprs, protocol, communication, app, bluetooth, serial, cloud, web, usb, m2m, ble, 3g, smartphone, http, iot, device, sensors, data, esp8266, mobile, wifi, ethernet, gsm
Compatible frameworks: Arduino, Energia, WiringPi
Compatible platforms: Atmel AVR, Atmel SAM, Espressif 8266, Intel ARC32, Linux ARM, Microchip PIC32, Nordic nRF51, Teensy, TI MSP430, TI Tiva
Authors: Volodymyr Shymanskyy

Show next libraries? [y/N]:
...
  1. Search for libraries by “Adafruit Industries” author

> platformio lib search --author="Adafruit Industries"

Found N libraries:

DHT sensor library
==================
#ID: 19
Arduino library for DHT11, DHT22, etc Temp & Humidity Sensors

Keywords: unified, dht, sensor, temperature, humidity
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Adafruit Industries

Adafruit DHT Unified
====================
#ID: 18
Unified sensor library for DHT (DHT11, DHT22 and etc) temperature and humidity sensors

Keywords: unified, dht, sensor, temperature, humidity
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Adafruit Industries

Show next libraries? [y/N]:
...
  1. Search for libraries which are compatible with Dallas temperature sensors like DS18B20, DS18S20 and etc.

> platformio lib search "DS*"

Found N libraries:

DS1820
======
#ID: 196
Dallas / Maxim DS1820 1-Wire library. For communication with multiple DS1820 on a single 1-Wire bus. Also supports DS18S20 and DS18B20.

Keywords: ds18s20, 1-wire, ds1820, ds18b20
Compatible frameworks: mbed
Compatible platforms: Freescale Kinetis, Nordic nRF51, NXP LPC, ST STM32, Teensy
Authors: Michael Hagberg

I2Cdevlib-DS1307
================
#ID: 99
The DS1307 serial real-time clock (RTC) is a low-power, full binary-coded decimal (BCD) clock/calendar plus 56 bytes of NV SRAM

Keywords: i2cdevlib, clock, i2c, rtc, time
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Jeff Rowberg

Show next libraries? [y/N]:
...
  1. Search for Energia-based *nRF24* or *HttpClient* libraries. The search query that is described below can be interpreted like energia nRF24 OR energia HttpClient

> platformio lib search "+(nRF24 HttpClient)" --framework="energia"

Found N libraries:

nRF24
=====
#ID: 43
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.

Keywords: wireless, spi, rf, radio
Compatible frameworks: Energia
Compatible platforms: TI MSP430
Authors: Eric

HttpClient
==========
#ID: 46
HttpClient is a library to make it easier to interact with web servers

Keywords: web, client, http, ethernet
Compatible frameworks: Energia
Compatible platforms: TI MSP430, TI Tiva
Authors: Zack Lalanne

RadioHead
=========
#ID: 124
The RadioHead Packet Radio library which provides a complete object-oriented library for sending and receiving packetized messages via RF22/24/26/27/69, Si4460/4461/4463/4464, nRF24/nRF905, SX1276/77/78, RFM95/96/97/98 and etc.

Keywords: wireless, rf, radio
Compatible frameworks: Arduino, Energia
Compatible platforms: Atmel AVR, Atmel SAM, Espressif 8266, Intel ARC32, Microchip PIC32, Nordic nRF51, Teensy, TI MSP430, TI Tiva
Authors: Mike McCauley

Show next libraries? [y/N]:
...
  1. Search for the all sensor libraries excluding temperature.

> platformio lib search "sensor -temperature"

Found N libraries:

SparkFun VL6180 Sensor
======================
#ID: 407
The VL6180 combines an IR emitter, a range sensor, and an ambient light sensor together for you to easily use and communicate with via an I2C interface.

Keywords: sensors
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR, Atmel SAM, Espressif 8266, Intel ARC32, Microchip PIC32, Nordic nRF51, Teensy, TI MSP430
Authors: Casey Kuhns@SparkFun, SparkFun Electronics

I2Cdevlib-AK8975
================
#ID: 10
AK8975 is 3-axis electronic compass IC with high sensitive Hall sensor technology

Keywords: i2c, i2cdevlib, sensor, compass
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Jeff Rowberg

Adafruit 9DOF Library
=====================
#ID: 14
Unified sensor driver for the Adafruit 9DOF Breakout (L3GD20 / LSM303)

Keywords: magnetometer, unified, accelerometer, spi, compass, i2c, sensor, gyroscope
Compatible frameworks: Arduino
Compatible platforms: Atmel AVR
Authors: Adafruit Industries

Show next libraries? [y/N]:
...