mcopy_web/lib/arduino
Matt McWilliams d2f018f4a5 Port over all UI code and source files from mcopy (to be pruned). Next step is to identify all the Electron-specific and node.js-specific code and replace it or remove the functionality if there's no parity with the web. 2021-08-02 19:46:41 -04:00
..
Readme.md Port over all UI code and source files from mcopy (to be pruned). Next step is to identify all the Electron-specific and node.js-specific code and replace it or remove the functionality if there's no parity with the web. 2021-08-02 19:46:41 -04:00
index.js Port over all UI code and source files from mcopy (to be pruned). Next step is to identify all the Electron-specific and node.js-specific code and replace it or remove the functionality if there's no parity with the web. 2021-08-02 19:46:41 -04:00
index.js.map Port over all UI code and source files from mcopy (to be pruned). Next step is to identify all the Electron-specific and node.js-specific code and replace it or remove the functionality if there's no parity with the web. 2021-08-02 19:46:41 -04:00
package.json Port over all UI code and source files from mcopy (to be pruned). Next step is to identify all the Electron-specific and node.js-specific code and replace it or remove the functionality if there's no parity with the web. 2021-08-02 19:46:41 -04:00

Readme.md

Arduino

Class representing the arduino communication features

Kind: global class

arduino.enumerate() ⇒ Promise

Enumerate all connected devices that might be Arduinos

Kind: instance method of Arduino
Returns: Promise - Resolves after enumerating

arduino.sendAsync(device, cmd) ⇒ Promise

Send a command to an Arduino using async/await

Kind: instance method of Arduino
Returns: Promise - Resolves after sending

Param Type Description
device string Arduino identifier
cmd string Single character command to send

arduino.writeAsync(device, str) ⇒ Promise

Send a string to an Arduino using async/await

Kind: instance method of Arduino
Returns: Promise - Resolves after sending

Param Type Description
device string Arduino identifier
str string String to send

arduino.openArduino(device) ⇒ Promise

Connect to an Arduino using async/await

Kind: instance method of Arduino
Returns: Promise - Resolves after opening

Param Type Description
device string Arduino identifier

arduino.closeArduino(device) ⇒ Promise

Close a connection to an Arduino using async/await

Kind: instance method of Arduino
Returns: Promise - Resolves after closing

Param Type Description
device string Arduino identifier