br3ttb / Arduino-PID-AutoTune-Library

420 stars 225 forks source link

PlatformIO Library Registry manifest file #12

Open ivankravets opened 10 years ago

ivankravets commented 10 years ago
ivankravets commented 10 years ago

library.json is a library manifest file which can be used by the different tools/managers to organise embedded libraries. How does this look from CLI:

$ platformio lib search "arduino PID"
# Found ... libraries:
# [ ID  ] Name             Compatibility         "Authors": Description
# -------------------------------------------------------------------------------------
[ 3  ] PID-AutoTune         arduino, atmelavr     "Brett Beauregard": A proportional-integral-derivative controller is a control loop feedback mechanism (controller) widely used in industrial control systems

$ platformio lib install 3
# Installing PID-AutoTune  library:
# Downloading  [####################################]  100%
# Unpacking  [####################################]  100%
# The library ‘PID-AutoTune' has been successfully installed!
# Installing dependencies:
# Installing PID  library:
# Downloading  [####################################]  100%
# Unpacking  [####################################]  100%
# The library ‘PID' has been successfully installed!

$ platformio lib show 3
# PID-AutoTune
# -------------
# Author: Brett Beauregard 
# Keywords: pid, integral, controller, industrial
# Version: ***
#
# A proportional-integral-derivative controller is a control loop feedback mechanism (controller) widely used in industrial control systems

$ platformio lib update
# Updating PID-AutoTune  library:
# Versions: Current=***, Latest=***       [Up-to-date]