:package: electron-arduino-cli

Library to work with the arduino cli based on the inocli-js and arduino-node libraries.

:computer: S. O. supported:

:heavy_check_mark: Linux
:heavy_check_mark: Windows.
:heavy_check_mark: Mac.

:dvd: examples:

GitHub.

:floppy_disk: Documentation:

:boom: Installation

npm instal electron-arduino-cli

:fire: Import

// JavaScript
let arduinoCli = require('electron-arduino-cli');

:notebook: Methods

init

// JavaScript
/**
 * Init config
 * @param {string} path - Path of custom .cli-config.yml
 * @param {Object} config - path user & path data
 * @returns {JSON} response
 */
arduinoCli.init(path, config = null);

dump

// JavaScript
/**
 * Dump config file
 * @returns {string} dumped config JSON string
 */
arduinoCli.dump();

setSketch

// JavaScript
/**
 * return sketch directory
 * @param {string} name -sketch name 
 * @returns {JSON} response 
 */
arduinoCli.setSketch(name);

boardAttach

// JavaScript
/**
 * Attaches a sketch to a board.
 * @param  {...any} arg <port>|<FQBN> [sketchPath]
 * @returns {JSON} response 
 */
arduinoCli.boardAttach(...arg);

boardDetails

// JavaScript
/**
 * Print details about a board.
 * @param {string} fqbn  -Fully Qualified Board Name, e.g.: arduino:avr:uno
 * @returns {JSON} response 
 */
arduinoCli.boardDetails(fqbn);

boardList

// JavaScript
/**
 * List connected boards.
 * @returns {JSON} response 
 */
arduinoCli.boardList();

boardListall

// JavaScript
/**
 * List all known boards and their corresponding FQBN
 * @param {string} boardName boardname
 * @returns {JSON} response
 */
arduinoCli.boardListall(boardName);

burnBootloader

// JavaScript
/**
 * Upload the bootloader on the board using an external programmer.
 * @param {string} fqbn Fully Qualified Board Name, e.g.: arduino:avr:uno
 * @param {string} port Upload port, e.g.: COM10 or /dev/ttyACM0
 * @returns {JSON} response
 */
arduinoCli.burnBootloader(fqbn, port);

cacheClean

// JavaScript
/**
 * Clean arduino cache.
 * @returns {JSON} response
 */
arduinoCli.cacheClean();

compile

// JavaScript
/**
 * Compiles Arduino sketches.
 * @param {string} fqbn Fully Qualified Board Name, e.g.: arduino:avr:uno
 * @param {string} port Upload port, e.g.: COM10 or /dev/ttyACM0
 * @param {string} sketch sketch name
 * @returns {JSON} response
 */
arduinoCli.compile(fqbn, port, sketch);

completion

// JavaScript
/**
 * Generates completion scripts
 * @param  {...any} arg example 'bash','>','completion.sh'
 * @returns {JSON} response
 */
arduinoCli.completion(...arg);

configDump

// JavaScript
/**
 * Prints the current configuration
 * @returns {JSON} response
 */
arduinoCli.configDump();

configInit

// JavaScript
/**
 * Writes current configuration to a configuration file.
 * @returns {JSON} response
 */
arduinoCli.configInit();

coreDownload

// JavaScript
/**
 * Downloads one core and corresponding tool dependencies.
 * @param {string} packet PACKAGER
 * @param {string} arch ARCH
 * @param {string} version VERSION
 * @returns {JSON} response
 */
arduinoCli.coreDownload(packet, arch, version);

coreInstall

// JavaScript
/**
 * Installs one core and corresponding tool dependencies.
 * @param {string} packet PACKAGER
 * @param {string} arch ARCH
 * @param {string} version VERSION
 * @returns {JSON} response
 */
arduinoCli.coreInstall(packet, arch, version);

coreList

// JavaScript
/**
 * Shows the list of installed platforms.
 * @returns {JSON} response 
 */
arduinoCli.coreList();

coreSearch

// JavaScript
/**
 * Search for a core in the package index.
 * @param {string} search keywords
 * @returns {JSON} response
 */
arduinoCli.coreSearch(search);

coreUninstall

// JavaScript
/**
 * Uninstall one core and corresponding tool dependencies if no longer used.
 * @param {string} packet PACKAGER
 * @param {string} arch ARCH
 * @returns {JSON} response
 */
arduinoCli.coreUninstall(packet, arch);

coreUpdateIndex

// JavaScript
/**
 * Updates the index of cores.
 * @returns {JSON} response
 */
arduinoCli.coreUpdateIndex();

coreUpgrade

// JavaScript
/**
 * Upgrade one installed platforms to the latest version.
 * @param {string} packet PACKAGER
 * @param {string} arch ARCH
 * @returns {JSON} response
 */
arduinoCli.coreUpgrade(packet, arch);

daemon

// JavaScript
/**
 * Run as a daemon on port
 * @returns {JSON} response
 */
arduinoCli.daemon();

debug

// JavaScript
/**
 * Debug Arduino sketches.
 * @param {string} fqbn Fully Qualified Board Name, e.g.: arduino:avr:uno
 * @param {string} sketch sketch name
 * @returns {JSON} response
 */
arduinoCli.debug(fqbn, sketch);

libDeps

// JavaScript
/**
 * Check dependencies status for the specified library.
 * @param {string} library library name example AudioZero
 * @param {string} version version example 1.0.0
 * @returns {JSON} response
 */
arduinoCli.libDeps(library, version);

libDownload

// JavaScript
/**
 * Downloads one or more libraries without installing them.
 * @param  {...any} arg library name and version example '[email protected]'
 * @returns {JSON} response
 */
arduinoCli.libDownload(...arg);

libInstall

// JavaScript
/**
 * Installs one or more specified libraries into the system.
 * @param  {...any} arg library name and version example '[email protected]'
 * @returns {JSON} response
 */
arduinoCli.libInstall(...arg);

libList

// JavaScript
/**
 * Shows a list of all installed libraries.
 * @returns {JSON} response
 */
arduinoCli.libList();

libSearch

// JavaScript
/**
 * Searches for one or more libraries data.
 * @param {string} search LIBRARY_NAME
 * @returns {JSON} response
 */
arduinoCli.libSearch(search);

libUninstall

// JavaScript
/**
 * Uninstalls one or more libraries.
 * @param  {...any} arg library name example 'AudioZero'
 * @returns {JSON} response
 */
arduinoCli.libUninstall(...arg);

libUpdateIndex

// JavaScript
/**
 * Updates the libraries index.
 * @returns {JSON} response
 */
arduinoCli.libUpdateIndex();

libUpgrade

// JavaScript
/**
 * Upgrades installed libraries.
 * @param  {...any} arg library name example 'Audio','ArduinoJson'
 * @returns {JSON} response
 */
arduinoCli.libUpgrade(...arg);

outdated

// JavaScript
/**
 * Lists cores and libraries that can be upgraded
 * @returns {JSON} response
 */
arduinoCli.outdated();

sketchNew

// JavaScript
/**
 * Create a new Sketch
 * @param {string} sketch sketch name
 * @returns {JSON} response
 */
arduinoCli.sketchNew(sketch);

update

// JavaScript
/**
 * Updates the index of cores and libraries
 * @returns {JSON} response
 */
arduinoCli.update();

upgrade

// JavaScript
/**
 * Upgrades installed cores and libraries.
 * @returns {JSON} response
 */
arduinoCli.upgrade();

upload

// JavaScript
/**
 * Upload Arduino sketches.
 * @param {string} sketch sketch name
 * @param {string} fqbn Fully Qualified Board Name, e.g.: arduino:avr:uno
 * @param {string} port Upload port, e.g.: COM10 or /dev/ttyACM0
 * @returns {JSON} response
 */
arduinoCli.upload(sketch, fqbn, port);

version

// JavaScript
/**
 * Shows version number of Arduino CLI.
 * @return  {JSON} response
 */
arduinoCli.version();