added Begin() function to handle Serial.begin and storing milllis(). Avoid calling default constructor twice, was exhibiting undefined behaviour on copy to global plotter. Left duplicate calls in default constructor for the sake of backward compatibility

devinaconley · devinaconley · commit 0d1f59e6acc0 · 2017-04-07T16:08:17.000-04:00
diff --git a/README.md b/README.md
@@ -26,11 +26,11 @@ _by: Devin Conley_
 #include "Plotter.h"
 
 double x; // global variables
-Plotter p;
+Plotter p; // create plotter
 
 void setup()
 {
-  p = Plotter(); // create plotter
+  p.Begin(); // start plotter
   
   p.AddTimeGraph( "Some title of a graph", 500, "label for x", x ); // add any graphs you want
 }
diff --git a/listener/Graph.java b/listener/Graph.java
@@ -17,7 +17,7 @@
 
   -------------------------------------------------------------------------------------------
   Arduino Plotter Listener
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
diff --git a/listener/listener.pde b/listener/listener.pde
@@ -18,7 +18,7 @@
 
   -------------------------------------------------------------------------------------------
   Arduino Plotter Listener
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
diff --git a/plotter/Plotter.cpp b/plotter/Plotter.cpp
@@ -17,7 +17,7 @@
 
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -29,12 +29,18 @@
 
 Plotter::Plotter()
 {
-    Serial.begin( 115200 );
     head = NULL;
     tail = NULL;
     numGraphs = 0;
-    lastUpdated = millis();
     counter = 0;
+    Serial.begin( 115200 ); // duplicate calls left for backward compatibility
+    lastUpdated = millis();
+}
+
+void Plotter::Begin()
+{
+    Serial.begin( 115200 );
+    lastUpdated = millis();
 }
 
 Plotter::~Plotter()
diff --git a/plotter/Plotter.h b/plotter/Plotter.h
@@ -17,7 +17,7 @@
 
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -33,7 +33,10 @@ class Plotter
 public:
     // The constructor for Plotter requires no arguments
     Plotter();
-  
+
+    // Initialize Plotter
+    void Begin();
+    
     /* 
        Add a 1-variable graph vs. time
      
diff --git a/plotter/examples/control_points_displayed/control_points_displayed.ino b/plotter/examples/control_points_displayed/control_points_displayed.ino
@@ -3,7 +3,7 @@
   Example to demonstrate effect of "Points Displayed" in Time Graph and in XY Graph
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -20,8 +20,8 @@ Plotter p;
 
 void setup()
 {
-    // Plotter constructor
-    p = Plotter();
+    // Start plotter
+    p.Begin();
   
     // Add X-Y graphs 
     p.AddXYGraph( "X-Y graph w/ 500 points", 500, "x axis", x, "y axis", y );
diff --git a/plotter/examples/different_types/different_types.ino b/plotter/examples/different_types/different_types.ino
@@ -3,7 +3,7 @@
   Example to demonstrate effect of plotting different variable types
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -22,8 +22,8 @@ Plotter p;
 
 void setup()
 {
-    // Plotter constructor
-    p = Plotter();
+    // Start plotter
+    p.Begin();
   
     // Add time graphs.
     p.AddTimeGraph( "float vs int", 500, "float", f, "int", i );
diff --git a/plotter/examples/dynamically_modify_graph_layout/dynamically_modify_graph_layout.ino b/plotter/examples/dynamically_modify_graph_layout/dynamically_modify_graph_layout.ino
@@ -3,7 +3,7 @@
   Example to demonstrate dynamic addition and removal of graphs
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -26,9 +26,9 @@ boolean remove_graph = true;
 
 void setup()
 {
-    // Plotter contructor
-    p = Plotter();
-  
+    // Plotter constructor
+    p.Begin();
+    
     // Add a graph during setup
     p.AddTimeGraph( "x and y against time", 1000, "x label", x, "y label", y );
 }
diff --git a/plotter/examples/multivariable_plotting/multivariable_plotting.ino b/plotter/examples/multivariable_plotting/multivariable_plotting.ino
@@ -3,7 +3,7 @@
   Example to demonstrate multi-variable plotting against time
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -23,8 +23,8 @@ Plotter p;
 
 void setup()
 {
-    // Plotter constructor
-    p = Plotter();
+    // Start plotter
+    p.Begin();
   
     // Add 5 variable time graph
     p.AddTimeGraph( "5 variable time graph", 1000, "v label", v, "w label", w, "x label", x,
diff --git a/plotter/examples/quick_start/quick_start.ino b/plotter/examples/quick_start/quick_start.ino
@@ -3,7 +3,7 @@
   Example used in Quick-Start
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/devinaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -17,7 +17,7 @@ Plotter p;
 
 void setup()
 {
-    p = Plotter();
+    p.Begin();
 
     p.AddTimeGraph( "Some title of a graph", 500, "label for x", x );
 }
diff --git a/plotter/examples/set_colors/set_colors.ino b/plotter/examples/set_colors/set_colors.ino
@@ -3,7 +3,7 @@
   Example to demonstrate configuring specific colors for each variable 
   -------------------------------------------------------------------------------------------
   Plotter
-  v2.2.1
+  v2.3.0
   https://github.com/deviaconley/arduino-plotter
   by Devin Conley
   ===========================================================================================
@@ -18,8 +18,10 @@ Plotter p;
 
 void setup()
 {
-    p = Plotter();
+    // Start plotter
+    p.Begin();
 
+    // Add plots
     p.AddTimeGraph( "Some title of a graph", 500, "label for x", x, "label for y", y );
     p.AddXYGraph( "Title of X vs Y graph", 1000, "x axis", x, "y axis", y );
 
diff --git a/plotter/keywords.txt b/plotter/keywords.txt
@@ -1,4 +1,5 @@
 Plotter	KEYWORD1
+Begin		KEYWORD2
 AddTimeGraph	KEYWORD2
 AddXYGraph	KEYWORD2
 Plot		KEYWORD2
diff --git a/plotter/library.properties b/plotter/library.properties
@@ -1,5 +1,5 @@
 name=Plotter
-version=2.2.1
+version=2.3.0
 author=Devin Conley <devinconley@jhu.edu>
 maintainer=Devin Conley <devinconley@jhu.edu>
 sentence=An Arduino library for easy plotting on host computer via serial communication.

Original file line number	Diff line number	Diff line change
`@@ -26,11 +26,11 @@ _by: Devin Conley_`
`26`	`26`	`#include "Plotter.h"`
`27`	`27`
`28`	`28`	`double x; // global variables`
`29`		`-Plotter p;`
	`29`	`+Plotter p; // create plotter`
`30`	`30`
`31`	`31`	`void setup()`
`32`	`32`	`{`
`33`		`- p = Plotter(); // create plotter`
	`33`	`+ p.Begin(); // start plotter`
`34`	`34`
`35`	`35`	`p.AddTimeGraph( "Some title of a graph", 500, "label for x", x ); // add any graphs you want`
`36`	`36`	`}`