mcopy/app/lib/arduino/Readme.md

2.6 KiB

Classes

Arduino

Class representing the arduino communication features

Functions

delay(ms)Promise

Pause the process for X milliseconds in async/await functions

Arduino

Class representing the arduino communication features

Kind: global class

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

delay(ms) ⇒ Promise

Pause the process for X milliseconds in async/await functions

Kind: global function
Returns: Promise - Resolves after wait

Param Type Description
ms integer milliseconds