Example of reading csv from PC (using python script)

Author: michalmonday

README.md

@@ -3,6 +3,7 @@
 * [What is this CSV parser](#what-is-this-csv-parser)  
 * [Installation](#installation)  
 * [Usage](#usage)  
+* [Examples](#examples)  
 * [Things to consider](#things-to-consider)  
 * [Specifying value types](#specifying-value-types)  
 	* [How to store unsigned types](#how-to-store-unsigned-types)  
@@ -135,6 +136,16 @@ for (int i = 0; i < strlen(csv_str); i++) {
 ```
 
 
+## Examples
+Examples directory contains examples showing:  
+* [basic usage](https://github.com/michalmonday/CSV-Parser-for-Arduino/tree/master/examples/basic_usage)  
+* [how to handle unsigned types](https://github.com/michalmonday/CSV-Parser-for-Arduino/tree/master/examples/unsigned_values)   
+* [how to supply csv by incomplete parts](https://github.com/michalmonday/CSV-Parser-for-Arduino/tree/master/examples/supplying_csv_by_incomplete_parts)   
+* [how to read csv file from a PC (using provided python script)](https://github.com/michalmonday/CSV-Parser-for-Arduino/tree/master/examples/reading_from_computer_python)  
+* [how to read csv file from SD card](https://github.com/michalmonday/CSV-Parser-for-Arduino/tree/master/examples/reading_from_sd_card)   
+
+
+
 ## Things to consider  
 If CSV file doesn't contain header line, then it must be specified as 3rd argument of the constructor (see [this example](#headerless-files))  
 If CSV file is separated by other character instead of comma, then it must be specified as 4th argument of the constructor (see [this example](#custom-delimiter))  

examples/reading_from_computer_python/hurricanes.csv

@@ -0,0 +1,10 @@
+Month,Average,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015
+May,0.1,0,0,1,1,0,0,0,2,0,0,0
+Jun,0.5,2,1,1,0,0,1,1,2,2,0,1
+Jul,0.7,5,1,1,2,0,1,3,0,2,2,1
+Aug,2.3,6,3,2,4,4,4,7,8,2,2,3
+Sep,3.5,6,4,7,4,2,8,5,2,5,2,5
+Oct,2.0,8,0,1,3,2,5,1,5,2,3,0
+Nov,0.5,3,0,0,1,1,0,1,0,1,0,1
+Dec,0.0,1,0,1,0,0,0,0,0,0,0,1
+

examples/reading_from_computer_python/reading_from_computer_python.ino

@@ -0,0 +1,100 @@
+/*  Usage example for: https://github.com/michalmonday/CSV-Parser-for-Arduino  */
+
+#include <CSV_Parser.h>
+
+/*
+Python script used to send the file through serial (from PC to arduino) can be found at:
+https://github.com/michalmonday/CSV-Parser-for-Arduino/blob/master/examples/reading_from_computer_python/arduino_serial.py
+
+The csv file I used for this particular example can be found at:
+https://github.com/michalmonday/CSV-Parser-for-Arduino/blob/master/examples/reading_from_computer_python/hurricanes.csv
+
+This example shows how Arduino can receive and parse csv file from a computer (sent using a python script).
+It first sends the file from PC to Arduino, Arduino parses it, for verification purposes it sends values
+from 2 columns ("Month", "Average") back to PC (python scripts reads them and prints them in console window). 
+In this particular example the csv file I used was containing information about hurricanes. The csv file contained:
+
+Month,Average,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015
+May,0.1,0,0,1,1,0,0,0,2,0,0,0
+Jun,0.5,2,1,1,0,0,1,1,2,2,0,1
+Jul,0.7,5,1,1,2,0,1,3,0,2,2,1
+Aug,2.3,6,3,2,4,4,4,7,8,2,2,3
+Sep,3.5,6,4,7,4,2,8,5,2,5,2,5
+Oct,2.0,8,0,1,3,2,5,1,5,2,3,0
+Nov,0.5,3,0,0,1,1,0,1,0,1,0,1
+Dec,0.0,1,0,1,0,0,0,0,0,0,0,1
+
+After uploading this code to arduino and running the python script (command: python --csv hurricanes.csv), 
+the python script outputs the following:
+
+All ports:
+1. device=COM1 name=COM1 description=Communications Port (COM1) manufacturer=(Standard port types)
+2. device=COM4 name=COM4 description=Arduino Leonardo (COM4) manufacturer=Arduino LLC (www.arduino.cc)
+
+A single arduino port was found and will be used
+COM4 - Arduino Leonardo (COM4)
+Received:
+0. month = May
+0. average = 0.10
+1. month = Jun
+1. average = 0.50
+2. month = Jul
+2. average = 0.70
+3. month = Aug
+3. average = 2.30
+4. month = Sep
+4. average = 3.50
+5. month = Oct
+5. average = 2.00
+6. month = Nov
+6. average = 0.50
+7. month = Dec
+7. average = 0.00
+
+Received:
+end
+Closing port
+
+
+Note: I suggest to close Serial Monitor window (if it's open) before running the python script,
+      otherwise the port may be busy.
+*/
+
+void setup() {
+  Serial.begin(115200);
+  CSV_Parser cp(/*format*/ "sfccccccccccc");
+
+  // wait for python script to start sending the csv file
+  while(!Serial.available()) {}
+
+  // receive the file and pass it to CSV_Parser object
+  while(Serial.available()) {
+    cp << Serial.read();
+  }
+
+  cp.parseLeftover(); // just in case if the csv file doesn't end with "\n"
+
+  // get "Month" and "Average" columns
+  char **months = (char**)cp["Month"];
+  float *averages = (float*)cp["Average"];
+
+  // Send "Month" and "Average" columns back to the PC 
+  // (python script will read and print them in console window)
+  for(int row = 0; row < cp.getRowsCount(); row++) {
+    Serial.print(row, DEC);
+    Serial.print(". month = ");
+    Serial.println(months[row]);
+    Serial.print(row, DEC);
+    Serial.print(". average = ");
+    Serial.println(String(averages[row]));
+  }
+  Serial.println();
+
+  // the python script is set to terminate after receiving "end" message
+  delay(500);
+  Serial.print("end");
+}
+
+void loop() {
+
+}