coelner/OpenLog
1
0
Fork 0
mirror of https://github.com/sparkfun/OpenLog.git synced 2024-09-20 00:50:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added 'disk' checking in the read example sketch.

Browse Source 
Related to issue 158.
This commit is contained in:
Nathan Seidle 2013-09-22 20:22:31 -06:00
parent 2b37b0ea50
commit 0df7f4c164
1 changed files with 255 additions and 196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

451
firmware/examples/OpenLog_ReadExample/OpenLog_ReadExample.ino
View File

@ -1,197 +1,256 @@
/*
2-22-2012
SparkFun Electronics 2011
Nathan Seidle
This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
This is an exampe of writing to a file then read from a file contain OpenLog
Connect the following OpenLog to Arduino:
TXO of OpenLog to pin 3 on the Arduino
RXI to 3
GRN to 4
VCC to 5V
GND to GND
This example code assumes the OpenLog is set to operate at 9600bps in NewLog mode, meaning OpenLog
should power up and output '12<'. This code then sends the three escape characters and then sends
the commands to create a new random file called log###.txt where ### is a random number from 0 to 999.
The example code will then read back the random file and print it to the serial terminal.
This code assume OpenLog is in the default state of 9600bps with ASCII-26 as the esacape character.
If you're unsure, make sure the config.txt file contains the following: 9600,26,3,0
Be careful when sending commands to OpenLog. println() sends extra newline characters that
cause problems with the command parser. The new v2.51 ignores \n commands so it should be easier to
talk to on the command prompt level. This example code works with all OpenLog v2 and higher.
*/
#include <SoftwareSerial.h>
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
//Connect TXO of OpenLog to pin 3, RXI to pin 2
SoftwareSerial OpenLog(3, 2); //Soft RX on 3, Soft TX out on 2
//SoftwareSerial(rxPin, txPin)
int resetOpenLog = 4; //This pin resets OpenLog. Connect pin 4 to pin GRN on OpenLog.
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
int statLED = 13;
float dummyVoltage = 3.50; //This just shows to to write variables to OpenLog
void setup() {
pinMode(statLED, OUTPUT);
Serial.begin(9600);
setupOpenLog(); //Resets logger and waits for the '<' I'm alive character
Serial.println("OpenLog online");
}
void loop() {
randomSeed(analogRead(A0)); //Use the analog pins for a good seed value
int fileNumber = random(999); //Select a random file #, 0 to 999
char fileName[12]; //Max file name length is "12345678.123" (12 characters)
sprintf(fileName, "log%03d.txt", fileNumber);
gotoCommandMode(); //Puts OpenLog in command mode
createFile(fileName); //Creates a new file called log###.txt where ### is random
Serial.print("Random file created: ");
Serial.println(fileName);
//Write something to OpenLog
OpenLog.println("Hi there! How are you today?");
OpenLog.print("Voltage: ");
OpenLog.println(dummyVoltage);
dummyVoltage++;
OpenLog.print("Voltage: ");
OpenLog.println(dummyVoltage);
Serial.println("Text written to file");
Serial.println("Reading file contents:");
Serial.println();
//Now let's read back
gotoCommandMode(); //Puts OpenLog in command mode
readFile(fileName); //This dumps the contents of a given file to the serial terminal
Serial.println();
Serial.println("File read complete");
//Infinite loop
Serial.println("Yay!");
while(1) {
digitalWrite(13, HIGH);
delay(250);
digitalWrite(13, LOW);
delay(250);
}
}
//Setups up the software serial, resets OpenLog so we know what state it's in, and waits
//for OpenLog to come online and report '<' that it is ready to receive characters to record
void setupOpenLog(void) {
pinMode(resetOpenLog, OUTPUT);
OpenLog.begin(9600);
//Reset OpenLog
digitalWrite(resetOpenLog, LOW);
delay(100);
digitalWrite(resetOpenLog, HIGH);
//Wait for OpenLog to respond with '<' to indicate it is alive and recording to a file
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '<') break;
}
}
//This function creates a given file and then opens it in append mode (ready to record characters to the file)
//Then returns to listening mode
void createFile(char *fileName) {
//Old way
OpenLog.print("new ");
OpenLog.print(fileName);
OpenLog.write(13); //This is \r
//New way
//OpenLog.print("new ");
//OpenLog.println(filename); //regular println works with OpenLog v2.51 and above
//Wait for OpenLog to return to waiting for a command
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '>') break;
}
OpenLog.print("append ");
OpenLog.print(fileName);
OpenLog.write(13); //This is \r
//Wait for OpenLog to indicate file is open and ready for writing
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '<') break;
}
//OpenLog is now waiting for characters and will record them to the new file
}
//Reads the contents of a given file and dumps it to the serial terminal
//This function assumes the OpenLog is in command mode
void readFile(char *fileName) {
//Old way
OpenLog.print("read ");
OpenLog.print(fileName);
OpenLog.write(13); //This is \r
//New way
//OpenLog.print("read ");
//OpenLog.println(filename); //regular println works with OpenLog v2.51 and above
//The OpenLog echos the commands we send it by default so we have 'read log823.txt\r' sitting
//in the RX buffer. Let's try to not print this.
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '\r') break;
}
//This will listen for characters coming from OpenLog and print them to the terminal
//This relies heavily on the SoftSerial buffer not overrunning. This will probably not work
//above 38400bps.
//This loop will stop listening after 1 second of no characters received
for(int timeOut = 0 ; timeOut < 1000 ; timeOut++) {
if(OpenLog.available()) {
Serial.write(OpenLog.read()); //Take the character from OpenLog and push it to the Arduino terminal
timeOut = 0;
}
delay(1);
}
//This is not perfect. The above loop will print the '.'s from the log file. These are the two escape characters
//recorded before the third escape character is seen.
//It will also print the '>' character. This is the OpenLog telling us it is done reading the file.
//This function leaves OpenLog in command mode
}
//This function pushes OpenLog into command mode
void gotoCommandMode(void) {
//Send three control z to enter OpenLog command mode
//Works with Arduino v1.0
OpenLog.write(26);
OpenLog.write(26);
OpenLog.write(26);
//Wait for OpenLog to respond with '>' to indicate we are in command mode
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '>') break;
}
/*
Example of reading the disk properties on OpenLog
By: Nathan Seidle
SparkFun Electronics
Date: September 22nd, 2013
License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
This is an example of issuing the 'disk' command and seeing how big the current SD card is.
Connect the following OpenLog to Arduino:
RXI of OpenLog to pin 2 on the Arduino
TXO to 3
GRN to 4
VCC to 5V
GND to GND
This example code assumes the OpenLog is set to operate at 9600bps in NewLog mode, meaning OpenLog
should power up and output '12<'. This code then sends the three escape characters and then sends
the commands to create a new random file called log###.txt where ### is a random number from 0 to 999.
The example code will then read back the random file and print it to the serial terminal.
This code assume OpenLog is in the default state of 9600bps with ASCII-26 as the esacape character.
If you're unsure, make sure the config.txt file contains the following: 9600,26,3,0
Be careful when sending commands to OpenLog. println() sends extra newline characters that
cause problems with the command parser. The new v2.51 ignores \n commands so it should be easier to
talk to on the command prompt level. This example code works with all OpenLog v2 and higher.
*/
#include <SoftwareSerial.h>
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
//Connect TXO of OpenLog to pin 3, RXI to pin 2
SoftwareSerial OpenLog(3, 2); //Soft RX on 3, Soft TX out on 2
//SoftwareSerial(rxPin, txPin)
int resetOpenLog = 4; //This pin resets OpenLog. Connect pin 4 to pin GRN on OpenLog.
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
int statLED = 13;
float dummyVoltage = 3.50; //This just shows to to write variables to OpenLog
void setup() {
pinMode(statLED, OUTPUT);
Serial.begin(9600);
setupOpenLog(); //Resets logger and waits for the '<' I'm alive character
Serial.println("OpenLog online");
}
void loop() {
randomSeed(analogRead(A0)); //Use the analog pins for a good seed value
int fileNumber = random(999); //Select a random file #, 0 to 999
char fileName[12]; //Max file name length is "12345678.123" (12 characters)
sprintf(fileName, "log%03d.txt", fileNumber);
gotoCommandMode(); //Puts OpenLog in command mode
createFile(fileName); //Creates a new file called log###.txt where ### is random
Serial.print("Random file created: ");
Serial.println(fileName);
//Write something to OpenLog
OpenLog.println("Hi there! How are you today?");
OpenLog.print("Voltage: ");
OpenLog.println(dummyVoltage);
dummyVoltage++;
OpenLog.print("Voltage: ");
OpenLog.println(dummyVoltage);
Serial.println("Text written to file");
Serial.println("Reading file contents:");
Serial.println();
//Now let's read back
gotoCommandMode(); //Puts OpenLog in command mode
readFile(fileName); //This dumps the contents of a given file to the serial terminal
//Now let's read back
readDisk(); //Check the size and stats of the SD card
Serial.println();
Serial.println("File read complete");
//Infinite loop
Serial.println("Yay!");
while(1) {
digitalWrite(13, HIGH);
delay(250);
digitalWrite(13, LOW);
delay(250);
}
}
//Setups up the software serial, resets OpenLog so we know what state it's in, and waits
//for OpenLog to come online and report '<' that it is ready to receive characters to record
void setupOpenLog(void) {
pinMode(resetOpenLog, OUTPUT);
OpenLog.begin(9600);
//Reset OpenLog
digitalWrite(resetOpenLog, LOW);
delay(100);
digitalWrite(resetOpenLog, HIGH);
//Wait for OpenLog to respond with '<' to indicate it is alive and recording to a file
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '<') break;
}
}
//This function creates a given file and then opens it in append mode (ready to record characters to the file)
//Then returns to listening mode
void createFile(char *fileName) {
//Old way
OpenLog.print("new ");
OpenLog.print(fileName);
OpenLog.write(13); //This is \r
//New way
//OpenLog.print("new ");
//OpenLog.println(filename); //regular println works with OpenLog v2.51 and above
//Wait for OpenLog to return to waiting for a command
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '>') break;
}
OpenLog.print("append ");
OpenLog.print(fileName);
OpenLog.write(13); //This is \r
//Wait for OpenLog to indicate file is open and ready for writing
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '<') break;
}
//OpenLog is now waiting for characters and will record them to the new file
}
//Reads the contents of a given file and dumps it to the serial terminal
//This function assumes the OpenLog is in command mode
void readFile(char *fileName) {
//Old way
OpenLog.print("read ");
OpenLog.print(fileName);
OpenLog.write(13); //This is \r
//New way
//OpenLog.print("read ");
//OpenLog.println(filename); //regular println works with OpenLog v2.51 and above
//The OpenLog echos the commands we send it by default so we have 'read log823.txt\r' sitting
//in the RX buffer. Let's try to not print this.
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '\r') break;
}
//This will listen for characters coming from OpenLog and print them to the terminal
//This relies heavily on the SoftSerial buffer not overrunning. This will probably not work
//above 38400bps.
//This loop will stop listening after 1 second of no characters received
for(int timeOut = 0 ; timeOut < 1000 ; timeOut++) {
while(OpenLog.available()) {
char tempString[100];
int spot = 0;
while(OpenLog.available()) {
tempString[spot++] = OpenLog.read();
if(spot > 98) break;
}
tempString[spot] = '\0';
Serial.write(tempString); //Take the string from OpenLog and push it to the Arduino terminal
timeOut = 0;
}
delay(1);
}
//This is not perfect. The above loop will print the '.'s from the log file. These are the two escape characters
//recorded before the third escape character is seen.
//It will also print the '>' character. This is the OpenLog telling us it is done reading the file.
//This function leaves OpenLog in command mode
}
//Check the stats of the SD card via 'disk' command
//This function assumes the OpenLog is in command mode
void readDisk() {
//Old way
OpenLog.print("disk");
OpenLog.write(13); //This is \r
//New way
//OpenLog.print("read ");
//OpenLog.println(filename); //regular println works with OpenLog v2.51 and above
//The OpenLog echos the commands we send it by default so we have 'disk\r' sitting
//in the RX buffer. Let's try to not print this.
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '\r') break;
}
//This will listen for characters coming from OpenLog and print them to the terminal
//This relies heavily on the SoftSerial buffer not overrunning. This will probably not work
//above 38400bps.
//This loop will stop listening after 1 second of no characters received
for(int timeOut = 0 ; timeOut < 1000 ; timeOut++) {
while(OpenLog.available()) {
char tempString[100];
int spot = 0;
while(OpenLog.available()) {
tempString[spot++] = OpenLog.read();
if(spot > 98) break;
}
tempString[spot] = '\0';
Serial.write(tempString); //Take the string from OpenLog and push it to the Arduino terminal
timeOut = 0;
}
delay(1);
}
//This is not perfect. The above loop will print the '.'s from the log file. These are the two escape characters
//recorded before the third escape character is seen.
//It will also print the '>' character. This is the OpenLog telling us it is done reading the file.
//This function leaves OpenLog in command mode
}
//This function pushes OpenLog into command mode
void gotoCommandMode(void) {
//Send three control z to enter OpenLog command mode
//Works with Arduino v1.0
OpenLog.write(26);
OpenLog.write(26);
OpenLog.write(26);
//Wait for OpenLog to respond with '>' to indicate we are in command mode
while(1) {
if(OpenLog.available())
if(OpenLog.read() == '>') break;
}
}