Skip to content

Commit 814f6cd

Browse files
committed
readme
1 parent 5f81705 commit 814f6cd

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
ArduinoPlotter
1+
Arduino-Plotter
22
===============
33
An Arduino library for easy graphing on host computer via serial communication
44

55
_by: Devin Conley_
66

77
Features:
8-
----------
8+
---
99
- Multi-variable plots against time
1010
- 2-variable "x" vs "y" plots
1111
- Display multiple graphs within single window
@@ -18,7 +18,7 @@ Features:
1818
![Plotter Preview Image](https://www.dropbox.com/s/0471kf89skyo72x/plotter_preview.png?raw=1)
1919

2020
Quickstart:
21-
------------
21+
---
2222

2323
#### Install Plotter library
2424
Search for "Plotter" in the Arduino Library Manager.
@@ -81,7 +81,7 @@ The application will configure itself and your data should be plotted appropriat
8181
![Quick Start Results Image](https://www.dropbox.com/s/jcj7wilsu8fbzia/quickstart.png?raw=1)
8282

8383
Documentation:
84-
------------
84+
---
8585

8686
#### void AddTimeGraph( String title, int pointsDisplayed, String label1, Variable1Type variable1 )
8787

@@ -92,6 +92,8 @@ Documentation:
9292
- label1: String with label of the plotted variable
9393
- variable1: global variable that will be updated throughout program
9494

95+
---
96+
9597
#### void AddTimeGraph( String title, int pointsDisplayed, String label1, Variable1Type variable1, String label2, Variable2Type variable2, ... )
9698

9799
*Add a multi-variable graph vs. time*
@@ -104,6 +106,8 @@ Documentation:
104106
- variable2: global variable that will be updated throughout program
105107
- ...
106108

109+
---
110+
107111
#### void AddXYGraph( String title, int pointsDisplayed, String labelX, VariableTypeX variableX, String labelY, VariableTypeY variableY )
108112

109113
*Add an X vs Y graph*
@@ -114,10 +118,12 @@ Documentation:
114118
- variableX: global X-variable that will be updated throughout program
115119
- labelY: String with label of variable to be plotted along Y-axis
116120
- variableY: global Y-variable that will be updated throughout program
121+
---
117122

118123
#### void Plot()
119124

120125
*Send most recent values for all plotted variables to the listener application*
126+
---
121127

122128
#### bool Remove( int index )
123129

0 commit comments

Comments
 (0)