Skip to content

Commit 8360667

Browse files
devinaconleydevinaconley
committed
Updated README, and comment headers (description and version)
1 parent 0fc5f27 commit 8360667

File tree

12 files changed

+83
-39
lines changed

12 files changed

+83
-39
lines changed

‎README.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
Arduino-Plotter
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:
88
---
9-
- Multi-variable plots against time
9+
- Continuous multi-variable plots against time
1010
- 2-variable "x" vs "y" plots
11-
- Display multiple graphs within single window
11+
- Display multiple graphs within single resizable window
1212
- Support for any data type that can be cast to a double
1313
- Simply pass a reference to your variables when the graph is added, no need to update each value explicitly
1414
- Control number of data points displayed on each graph
1515
- Auto-scaling to fit all data on graph
16+
- Configurable line color per variable
1617
- Stand-alone listener application, written with Processing, is provided
1718

1819
![Plotter Preview Image](https://www.dropbox.com/s/0471kf89skyo72x/plotter_preview.png?raw=1)
@@ -27,7 +28,7 @@ Search for "Plotter" in the Arduino Library Manager.
2728

2829
___or___
2930

30-
Install manually with the [ZIP file of Plotter](https://github.com/devinconley/ArduinoPlotter-for-Library-Manager/archive/master.zip).
31+
Install manually with the [ZIP file of Plotter](https://github.com/devinconley/arduino-plotter-for-library-manager/archive/master.zip).
3132

3233
---
3334

@@ -146,3 +147,15 @@ Documentation:
146147

147148
##### Returns
148149
- bool: true if successful
150+
151+
---
152+
153+
#### bool SetColor( int index, String colorA, ... )
154+
155+
*Sets the line colors for each variable in the graph at the specified position with zero-indexing. (ie passing 0 would set colors for the first graph added)*
156+
##### Arguments
157+
- index: position of graph to remove
158+
- colorA: color for first variable
159+
160+
##### Returns
161+
- bool: true if successful

‎listener/Graph.java‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
1+
/*
2+
===========================================================================================
3+
This Graph class handles an individual graph being displayed on the Arduino Plotter
4+
listener.
5+
-------------------------------------------------------------------------------------------
6+
The library stores and handles all relevant graph information and variable references,
7+
and transfers information via the serial port to a listener program written with the
8+
software provided by Processing. No modification is needed to this program; graph placement,
9+
axis-scaling, etc. are handled automatically.
10+
Multiple options for this listener are available including stand-alone applications as well
11+
as the source Processing script.
12+
13+
The library, these listeners, a quick-start guide, documentation, and usage examples are
14+
available at:
15+
16+
https://github.com/devinaconley/arduino-plotter
17+
18+
-------------------------------------------------------------------------------------------
19+
Arduino Plotter Listener
20+
v2.1.0
21+
https://github.com/devinaconley/arduino-plotter
22+
by Devin Conley
23+
===========================================================================================
24+
*/
25+
26+
127
import processing.core.PApplet;
2-
import java.text.DecimalFormat;
328

429
class Graph
530
{

‎listener/listener.pde‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
/*
22
===========================================================================================
3-
This listener is the source processing script that corresponds to the Arduino Plotter
4-
library for Arduino. The library supports plots against time as well as 2-variable
5-
"X vs Y" graphing.
3+
This listener is the main processing script that corresponds to the Arduino Plotter
4+
library for Arduino. This driver script handles serial port information and manages a
5+
set of Graph objects to do the actual plotting.
66
-------------------------------------------------------------------------------------------
7-
The library transfers information via the serial port to a listener program written with the
7+
The library stores and handles all relevant graph information and variable references,
8+
and transfers information via the serial port to a listener program written with the
89
software provided by Processing. No modification is needed to this program; graph placement,
910
axis-scaling, etc. are handled automatically.
1011
Multiple options for this listener are available including stand-alone applications as well
1112
as the source Processing script.
1213
13-
The library, these listeners, a quick-start guide, and usage examples are available at:
14+
The library, these listeners, a quick-start guide, documentation, and usage examples are
15+
available at:
1416
15-
https://github.com/devinconley/Arduino-Plotter
17+
https://github.com/devinaconley/arduino-plotter
1618
1719
-------------------------------------------------------------------------------------------
1820
Arduino Plotter Listener
19-
v2.0.0
20-
https://github.com/devinconley/Arduino-Plotter
21+
v2.1.0
22+
https://github.com/devinaconley/arduino-plotter
2123
by Devin Conley
2224
===========================================================================================
2325
*/
@@ -166,7 +168,6 @@ void serialEvent( Serial ser )
166168
{
167169
colorsTemp[j] = COLORMAP.get( "green" );
168170
}
169-
println( colorsTemp[j] );
170171
}
171172

172173
if ( xvyTemp )

‎plotter/Plotter.cpp‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,25 @@
33
Plotter is an Arduino library that allows easy multi-variable and multi-graph plotting. The
44
library supports plots against time as well as 2-variable "X vs Y" graphing.
55
-------------------------------------------------------------------------------------------
6-
The library transfers information via the serial port to a listener program written with the
6+
The library stores and handles all relevant graph information and variable references,
7+
and transfers information via the serial port to a listener program written with the
78
software provided by Processing. No modification is needed to this program; graph placement,
89
axis-scaling, etc. are handled automatically.
910
Multiple options for this listener are available including stand-alone applications as well
1011
as the source Processing script.
1112
12-
The library, these listeners, a quick-start guide, and usage examples are available at:
13+
The library, these listeners, a quick-start guide, documentation, and usage examples are
14+
available at:
1315
14-
https://github.com/devinconley/Arduino-Plotter
16+
https://github.com/devinaconley/arduino-plotter
1517
1618
-------------------------------------------------------------------------------------------
1719
Plotter
18-
v2.0.0
19-
https://github.com/devinconley/Arduino-Plotter
20+
v2.1.0
21+
https://github.com/devinaconley/arduino-plotter
2022
by Devin Conley
2123
===========================================================================================
22-
*/
24+
*/
2325

2426
#include "Plotter.h"
2527

‎plotter/Plotter.h‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,22 @@
33
Plotter is an Arduino library that allows easy multi-variable and multi-graph plotting. The
44
library supports plots against time as well as 2-variable "X vs Y" graphing.
55
-------------------------------------------------------------------------------------------
6-
The library transfers information via the serial port to a listener program written with the
6+
The library stores and handles all relevant graph information and variable references,
7+
and transfers information via the serial port to a listener program written with the
78
software provided by Processing. No modification is needed to this program; graph placement,
89
axis-scaling, etc. are handled automatically.
910
Multiple options for this listener are available including stand-alone applications as well
1011
as the source Processing script.
1112
12-
The library, these listeners, a quick-start guide, and usage examples are available at:
13+
The library, these listeners, a quick-start guide, documentation, and usage examples are
14+
available at:
1315
14-
https://github.com/devinconley/Arduino-Plotter
16+
https://github.com/devinaconley/arduino-plotter
1517
1618
-------------------------------------------------------------------------------------------
1719
Plotter
18-
v2.0.0
19-
https://github.com/devinconley/Arduino-Plotter
20+
v2.1.0
21+
https://github.com/devinaconley/arduino-plotter
2022
by Devin Conley
2123
===========================================================================================
2224
*/

‎plotter/examples/control_points_displayed/control_points_displayed.ino‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Example to demonstrate effect of "Points Displayed" in Time Graph and in XY Graph
44
-------------------------------------------------------------------------------------------
55
Plotter
6-
v2.0.0
7-
https://github.com/devinconley/Arduino-Plotter
6+
v2.1.0
7+
https://github.com/devinaconley/arduino-plotter
88
by Devin Conley
99
===========================================================================================
1010
*/

‎plotter/examples/different_types/different_types.ino‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Example to demonstrate effect of plotting different variable types
44
-------------------------------------------------------------------------------------------
55
Plotter
6-
v2.0.0
7-
https://github.com/devinconley/Arduino-Plotter
6+
v2.1.0
7+
https://github.com/devinaconley/arduino-plotter
88
by Devin Conley
99
===========================================================================================
1010
*/

‎plotter/examples/dynamically_modify_graph_layout/dynamically_modify_graph_layout.ino‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Example to demonstrate dynamic addition and removal of graphs
44
-------------------------------------------------------------------------------------------
55
Plotter
6-
v2.0.0
7-
https://github.com/devinconley/Arduino-Plotter
6+
v2.1.0
7+
https://github.com/devinaconley/arduino-plotter
88
by Devin Conley
99
===========================================================================================
1010
*/

‎plotter/examples/multivariable_plotting/multivariable_plotting.ino‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Example to demonstrate multi-variable plotting against time
44
-------------------------------------------------------------------------------------------
55
Plotter
6-
v2.0.0
7-
https://github.com/devinconley/Arduino-Plotter
6+
v2.1.0
7+
https://github.com/devinaconley/arduino-plotter
88
by Devin Conley
99
===========================================================================================
1010
*/

‎plotter/examples/quick_start/quick_start.ino‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Example used in Quick-Start
44
-------------------------------------------------------------------------------------------
55
Plotter
6-
v2.0.0
7-
https://github.com/devinconley/Arduino-Plotter
6+
v2.1.0
7+
https://github.com/devinaconley/arduino-plotter
88
by Devin Conley
99
===========================================================================================
1010
*/

0 commit comments

Comments
 (0)