16mm
/
mcopy
1
0
Fork 0
Code Issues 14 Pull Requests Projects 2 Releases 13 Wiki Activity
mcopy/app/lib/arduino
History
Matthew McWilliams 5026cf869f Arri-S work 2022-10-07 19:47:56 -04:00
..
Readme.md Move docs generation to host repo 2019-03-30 17:56:31 -04:00
index.d.ts Arri-S work 2022-10-07 19:47:56 -04:00
index.js All capper work. Need to wrap all actions in the 'b' command and push functionality to a lower level to prevent unneeded complexity. 2022-07-13 15:21:26 -04:00
index.js.map All capper work. Need to wrap all actions in the 'b' command and push functionality to a lower level to prevent unneeded complexity. 2022-07-13 15:21:26 -04:00
package.json
…

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