org.usfirst.frc.team1736.lib.Logging

Class simpleCsvLogger

java.lang.Object

org.usfirst.frc.team1736.lib.Logging.simpleCsvLogger

public class simpleCsvLogger
extends java.lang.Object

DESCRIPTION:
Provides an API for FRC 1736 Robot Casserole datalogging on the robot during testing or matches. Will write lines into a CSV file with a unique name between calls to init() and close(). output_dir is hardcoded to point to a specific 2016 folder on a flash drive connected to the roboRIO.

USAGE:

1. Instantiate Class
2. Create global variables containing arrays of strings to represent the column (data vector) names and units
3. During teleop init or autonomous init, call the init() function to start logging data to a new file.
4. Once per loop, call the writeData() method with the full list of values to write to file (all must be converted to doubles).
5. During DisabledInit, call the close() method to close out any file which was being written to while the robot was doing something.
6. Post-match or -practice, extract the data logs from the USB drive(maybe using FTP?) and view with excel or your favourite software.

Constructor Summary

Constructors

Constructor and Description
simpleCsvLogger()

Method Summary

Modifier and Type	Method and Description
int	close() Closes the log file and ensures everything is written to disk.
int	forceSync() Clears the buffer in memory and forces things to file.
int	init(java.lang.String[] data_fields, java.lang.String[] units_fields) Determines a unique file name, and opens a file in the data captures directory and writes the initial lines to it.
int	writeData(double... data_elements) Write a list of doubles to the output file, assuming it's open.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

simpleCsvLogger

public simpleCsvLogger()

Method Detail

init

public int init(java.lang.String[] data_fields,
                java.lang.String[] units_fields)

Determines a unique file name, and opens a file in the data captures directory and writes the initial lines to it.

Parameters:

data_fields - A set of strings for signal names to write into the file

units_fields - A set of strings for signal units to write into the file

Returns:

0 on successful log open, -1 on failure

writeData

public int writeData(double... data_elements)

Write a list of doubles to the output file, assuming it's open. Creates a new line in the .csv log file.

Parameters:

data_elements - Values to write (any number of doubles, each as its own argument). Should have the same number of arguments here as signal names/units set during the call to init()

Returns:

0 on write success, -1 on failure.

forceSync

public int forceSync()

Clears the buffer in memory and forces things to file. Generally a good idea to use this as infrequently as possible (because it increases logging overhead), but definitely use it before the roboRIO might crash without a proper call to the close() method (during brownout, maybe?)

Returns:

Returns 0 on flush success or -1 on failure.

close

public int close()

Closes the log file and ensures everything is written to disk. init() must be called again in order to write to a new file.

Returns:

-1 on failure to close, 0 on success