API

lib

confduino.liblist.lib_dir(lib)

return library directory

$ARDUINO/libraries/$LIB

confduino.liblist.lib_example_dir(lib, example)

return library example directory

$ARDUINO/libraries/$LIB/examples/$EXAMPLE

confduino.liblist.lib_examples(lib)

return library examples

EXAMPLE1,EXAMPLE2,..

confduino.liblist.lib_examples_dir(lib)

return library examples directory

$ARDUINO/libraries/$LIB/examples

confduino.liblist.libraries()

return installed library names

confduino.liblist.libraries_dir()

return library root path

$ARDUINO/libraries

confduino.liblist.print_libraries()

print installed arduino libraries

confduino.libinstall.find_lib_dir(root)

search for lib dir under root

confduino.libinstall.fix_examples_dir(lib_dir)

rename examples dir to examples

confduino.libinstall.install_lib(url, replace_existing=False, fix_wprogram=True)

install library from web or local files system

Parameters:

• url – web address or file path
• replace_existing – bool

Return type:

None

confduino.libinstall.move_examples(root, lib_dir)

find examples not under lib dir, and move into examples

confduino.libremove.remove_lib(lib_name)

remove library

Parameters:lib_name – library name (e.g. ‘PS2Keyboard’) Return type:None

board

confduino.boardlist.board_names(hwpack='arduino')

return installed board names

confduino.boardlist.boards(hwpack='arduino')

read boards from boards.txt

Parameters:core_package – ‘all,’arduino’,..

confduino.boardlist.boards_txt(hwpack='arduino')

path of boards.txt

confduino.boardlist.print_boards(hwpack='arduino', verbose=False)

print boards from boards.txt

confduino.boardinstall.install_board(board_id, board_options, hwpack='arduino', replace_existing=False)

install board in boards.txt

Parameters:

• board_id – string identifier
• board_options – dict like
• replace_existing – bool

Return type:

None

confduino.boardremove.remove_board(board_id)

remove board

Parameters:board_id – board id (e.g. ‘diecimila’) Return type:None

programmer

confduino.proglist.print_programmers(verbose=False)

print programmers from programmers.txt

confduino.proglist.programmer_names(hwpack='arduino')

return installed board names

confduino.proglist.programmers()

read programmers from programmers.txt

confduino.proglist.programmers_txt()

path of programmers.txt

confduino.proginstall.install_programmer(programmer_id, programmer_options, replace_existing=False)

install programmer in programmers.txt

Parameters:

• programmer_id – string identifier
• programmer_options – dict like
• replace_existing – bool

Return type:

None

confduino.progremove.remove_programmer(programmer_id)

remove programmer

Parameters:programmer_id – programmer id (e.g. ‘avrisp’) Return type:None

version

confduino.version.all_sketch_extensions()

[‘.pde’,’.ino’]

confduino.version.intversion(text=None)

return version as int

0022 -> 22 0022ubuntu0.1 -> 22 0023 -> 23 1.0 -> 100 1.0.3 -> 103

confduino.version.print_version(integer=False)

print arduino version

example: 0022

confduino.version.sketch_extension()

.pde or .ino

confduino.version.version()

return version as string

example: 0022

confduino.version.version_txt()

return version.txt path

$ARDUINO/lib/version.txt