mcopy

History

mmcwilliams ea91ea5ff5 Remove console logging from arduino lib. Reject or throw to log errors		2019-03-21 15:59:50 -04:00
..
Readme.md	Port shared modules to typescript. Migrate shared modules first, then look at individual needs of sub-projects.	2019-03-04 22:09:12 -05:00
index.js	Remove console logging from arduino lib. Reject or throw to log errors	2019-03-21 15:59:50 -04:00
index.js.map	Remove console logging from arduino lib. Reject or throw to log errors	2019-03-21 15:59:50 -04:00
package.json	Port shared modules to typescript. Migrate shared modules first, then look at individual needs of sub-projects.	2019-03-04 22:09:12 -05:00

Functions

delay(ms) ⇒ Promise: Pause the process for X milliseconds in async/await functions
send(device, cmd) ⇒ Promise: Send a command to an Arduino using async/await
write(device, str) ⇒ Promise: Send a string to an Arduino using async/await
open(device) ⇒ Promise: Connect to an Arduino using async/await
close(device) ⇒ Promise: Close a connection to an Arduino using async/await

Pause the process for X milliseconds in async/await functions

Kind: global function
Returns: Promise - Resolves after wait

Param	Type	Description
ms	`integer`	milliseconds

Send a command to an Arduino using async/await

Kind: global function
Returns: Promise - Resolves after sending

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

Send a string to an Arduino using async/await

Kind: global function
Returns: Promise - Resolves after sending

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

Connect to an Arduino using async/await

Kind: global function
Returns: Promise - Resolves after opening

Param	Type	Description
device	`string`	Arduino identifier

Close a connection to an Arduino using async/await

Kind: global function
Returns: Promise - Resolves after closing

Param	Type	Description
device	`string`	Arduino identifier