SignalLogger.hpp

Go to the documentation of this file.

/*
 * Copyright (C) Cross The Road Electronics.  All rights reserved.
 * License information can be found in CTRE_LICENSE.txt
 * For support and suggestions contact support@ctr-electronics.com or file
 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
 */
#pragma once
 
#include "ctre/phoenix/StatusCodes.h"
 
namespace ctre {
namespace phoenix6 {
 
/**
 * 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.
 */
class SignalLogger
{
public:
    /**
     * \brief 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.
     *
     * @return Status of logger restart
     */
    static ctre::phoenix::StatusCode SetPath(const char *path);
    /**
     * \brief 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.
     *
     * @return Status of logger start
     */
    static ctre::phoenix::StatusCode StartLog();
    /**
     * \brief Stop logging StatusSignals
     *
     * Stops regardless of auto logging status.
     *
     * @return Status of logger stop
     */
    static ctre::phoenix::StatusCode StopLog();
    /**
     * \brief 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.
     *
     * @return Status of auto logging enable/disable
     */
    static ctre::phoenix::StatusCode EnableAutoLogging(bool enable);
};
 
}
}