Module: Arduino::Library

Extended by:

Library

Included in:

Library

Defined in:

lib/arduino/library.rb,
lib/arduino/library.rb,
lib/arduino/library/model.rb,
lib/arduino/library/types.rb,
lib/arduino/library/finder.rb,
lib/arduino/library/version.rb,
lib/arduino/library/database.rb,
lib/arduino/library/utilities.rb,
lib/arduino/library/default_database.rb,
lib/arduino/library/instance_methods.rb,
lib/arduino/library/presenters/properties.rb

Defined Under Namespace

Modules: Finder, InstanceMethods, Presenters, Types, Utilities Classes: Database, DefaultDatabase, Model

Constant Summary

DEFAULT_ARDUINO_LIBRARY_INDEX_URL =

'http://downloads.arduino.cc/libraries/library_index.json.gz'

DEFAULT_ARDUINO_LIBRARY_PATH =

ENV['ARDUINO_CUSTOM_LIBRARY_PATH'] || (ENV['HOME'] + '/Documents/Arduino/Libraries')

DEFAULT_ARDUINO_LIBRARY_INDEX_PATH =

ENV['ARDUINO_LIBRARY_INDEX_PATH'] ||
(ENV['HOME'] + '/Documents/Arduino/Libraries/index.json.gz')

VERSION =

'0.6.0'

DESCRIPTION =

<<-eof
This library provides a convenient ruby API for representation of an Arduino Library specification, including field and type validation, reading and writing the library.properties file, as well as downloading the official database of Arduino libraries, and offering a highly advanced searching functionality. This gem only offers Ruby API, but for command line usage please checkout the gem called "arli" — Arduino Library Dependency Manager that uses this library behind the scenes.
eof

Class Method Summary

• .included(base) ⇒ Object

Class Method Details

.included(base) ⇒ Object

# File 'lib/arduino/library.rb', line 30

def included(base)
  base.include(::Arduino::Library::InstanceMethods)
  base.include(::Arduino::Library::Finder::FinderMethods)
end