ctre::phoenix6::SignalLogger Class Reference

Static class for controlling the signal logger. More...

#include <ctre/phoenix6/SignalLogger.hpp>

Static Public Member Functions
static ctre::phoenix::StatusCode	SetPath (const char *path)
	Set the destination for logging, restarting logger if needed. More...
static ctre::phoenix::StatusCode	StartLog ()
	Start logging StatusSignals. More...
static ctre::phoenix::StatusCode	StopLog ()
	Stop logging StatusSignals. More...
static ctre::phoenix::StatusCode	EnableAutoLogging (bool enable)
	Turn on or off auto logging. More...

Detailed Description

Static class for controlling the signal logger.

This logs all the signals from a canbus into a .hoot file The file name starts with the CANivore serial number or "rio" for the roboRIO canbus, followed by the timestamp.

In the header of a hoot file, the CANivore name and firmware verion are logged in plain text.

Member Function Documentation

EnableAutoLogging()

static ctre::phoenix::StatusCode ctre::phoenix6::SignalLogger::EnableAutoLogging ( bool  enable )

static

Turn on or off auto logging.

Auto logging is only supported on the roboRIO When auto logging is enabled, logging is started at the beginning of a match and stopped at the end.

Returns

Status of auto logging enable/disable

SetPath()

static ctre::phoenix::StatusCode ctre::phoenix6::SignalLogger::SetPath ( const char *  path )

static

Set the destination for logging, restarting logger if needed.

If this is not called or the path is left empty, the default is /home/lvuser on roboRIO and the current working directory on all other platforms. Typical use for this routine is to use a removable thumb drive for logging instead of onboard flash.

Returns

Status of logger restart

StartLog()

static ctre::phoenix::StatusCode ctre::phoenix6::SignalLogger::StartLog ( )

static

Start logging StatusSignals.

Starts regardless of auto logging status. For example, you can manually start a log before a match begins, and if the auto logger is enabled, the log will still be ended at the end of the match.

Returns

Status of logger start

StopLog()

static ctre::phoenix::StatusCode ctre::phoenix6::SignalLogger::StopLog ( )

static

Stop logging StatusSignals.

Stops regardless of auto logging status.

Returns

Status of logger stop

---

The documentation for this class was generated from the following file:

• ctre/phoenix6/SignalLogger.hpp