9.13.1 arduinoio.AddonBase

: arduinoio.AddonBase ¶

Base class used for arduino library sensors

See also: arduinoio.LibraryBase.

Properties

Base properties are expected to be inherited and overwritten in inherited classes. and are constant in order to query through the metaobject mechanism.

Parent - parent librarybase object

Methods

: ab = AddonBase () ¶

Constructor of base class

Outputs

The return value ab is an object of the arduinio.AddonBase class.

See also: arduino, addon.

: display () ¶

Display the addon in a verbose way.

9.13.2 arduinoio.FilePath

: retval = arduinoio.FilePath (fullpathname) ¶

Get the directory component of a pathname.

Inputs

fullpathname filepath to get directory component of.

Outputs

retval the directory part of the filename.

9.13.3 arduinoio.LibFiles

: filelist = arduinoio.LibFiles () ¶

Get the list of files used for the building arduino library

Outputs

filelist - string cell array of files for the arduino project

9.13.4 arduinoio.LibraryBase

: arduinoio.LibraryBase ¶

Base class used for arduino library plugins

See also: arduino, listArduinoLibraries, addon.

Properties

Base properties are expected to be inherited and overwritten in inherited classes and are constant in order to query through the metaobject mechanism.

LibraryName - name of the addon library

DependentLibraries - array of dependent library names that must be included when installing this plugin.

CppHeaderFile - name (if any) of header file that will be included into the arduino project when adding this library.

CppSourceFile - name (if any) of source file that will be included into the arduino project when adding this library.

CppClassName - name of the cpp class for the addon library. project when adding this library.

Pins - pins allocated to the addon

Parent - parent arduino object.

Methods

: lb = LibraryBase () ¶

Constructor of base class

The constructor is usually not called but called indirectly from the addon function.

Outputs

The return value lb is an object of the arduinio.LibraryBase class.

See also: arduino, listArduinoLibraries, addon.

: display () ¶

Display the addon in a verbose way.

9.13.5 arduinoio.getBoardConfig

: retval = arduinoio.getBoardConfig (boardname) ¶

Return the configuration for a known arduino board type

Function is used to get the expected pin/board configuration for a named board type which is used to verify and identify the functionality of the board.

Inputs

boardname - name of board to get configuration of ie: "uno"

Outputs

retval configuration struct.