diff --git a/app/lib/arduino/Readme.md b/app/lib/arduino/Readme.md index 498f041..76fbd7c 100644 --- a/app/lib/arduino/Readme.md +++ b/app/lib/arduino/Readme.md @@ -1,23 +1,82 @@ +## Classes + +
+
Arduino
+

Class representing the arduino communication features

+
+
+ ## 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

-
+ + +## Arduino +Class representing the arduino communication features + +**Kind**: global class + +* [Arduino](#Arduino) + * [.sendAsync(device, cmd)](#Arduino+sendAsync) ⇒ Promise + * [.writeAsync(device, str)](#Arduino+writeAsync) ⇒ Promise + * [.openArduino(device)](#Arduino+openArduino) ⇒ Promise + * [.closeArduino(device)](#Arduino+closeArduino) ⇒ Promise + + + +### arduino.sendAsync(device, cmd) ⇒ Promise +Send a command to an Arduino using async/await + +**Kind**: instance method of [Arduino](#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](#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](#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](#Arduino) +**Returns**: Promise - Resolves after closing + +| Param | Type | Description | +| --- | --- | --- | +| device | string | Arduino identifier | + ## delay(ms) ⇒ Promise @@ -30,53 +89,3 @@ Pause the process for X milliseconds in async/await functions | --- | --- | --- | | ms | integer | milliseconds | - - -## send(device, cmd) ⇒ Promise -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 | - - - -## write(device, str) ⇒ Promise -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 | - - - -## open(device) ⇒ Promise -Connect to an Arduino using async/await - -**Kind**: global function -**Returns**: Promise - Resolves after opening - -| Param | Type | Description | -| --- | --- | --- | -| device | string | Arduino identifier | - - - -## close(device) ⇒ Promise -Close a connection to an Arduino using async/await - -**Kind**: global function -**Returns**: Promise - Resolves after closing - -| Param | Type | Description | -| --- | --- | --- | -| device | string | Arduino identifier | -