mcopy

History

mmcwilliams a5a9a4ea86 Refactor arduino module to not use the mcopy. prefix. This should really be a class, not an object. We'll get there.		2019-02-26 21:55:52 -05:00
..
Readme.md	Make modules local because modules in /app directory are recompiled for electron. Throws error on load in node 10.	2019-02-24 08:32:16 -05:00
index.js	Refactor arduino module to not use the mcopy. prefix. This should really be a class, not an object. We'll get there.	2019-02-26 21:55:52 -05:00
package.json	Make modules local because modules in /app directory are recompiled for electron. Throws error on load in node 10.	2019-02-24 08:32:16 -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