mcopy/cli/lib/arduino

Arduino

Class representing the arduino communication features

Kind: global class

• Arduino
  • .enumerate() ⇒ Promise
  • .sendAsync(device, cmd) ⇒ Promise
  • .writeAsync(device, str) ⇒ Promise
  • .openArduino(device) ⇒ Promise
  • .closeArduino(device) ⇒ Promise

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