Package org.littletonrobotics.junction

Class LoggedRobot

java.lang.Object

edu.wpi.first.wpilibj.RobotBase

edu.wpi.first.wpilibj.IterativeRobotBase

org.littletonrobotics.junction.LoggedRobot

All Implemented Interfaces:

AutoCloseable

public class LoggedRobot
extends IterativeRobotBase

LoggedRobot implements the IterativeRobotBase robot program framework.

The LoggedRobot class is intended to be subclassed by a user creating a robot program, and will call all required AdvantageKit periodic methods.

periodic() functions from the base class are called on an interval by a Notifier instance.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	defaultPeriodSecs	Default loop period.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LoggedRobot()	Constructor for LoggedRobot.
protected	LoggedRobot(double period)	Constructor for LoggedRobot.

Method Summary

Modifier and Type	Method	Description
void	close()
void	endCompetition()	Ends the main loop in startCompetition().
void	setUseTiming(boolean useTiming)	Sets whether to use standard timing or run as fast as possible.
void	startCompetition()	Provide an alternate "main loop" via startCompetition().

Methods inherited from class edu.wpi.first.wpilibj.IterativeRobotBase

autonomousExit, autonomousInit, autonomousPeriodic, disabledExit, disabledInit, disabledPeriodic, driverStationConnected, enableLiveWindowInTest, getPeriod, isLiveWindowEnabledInTest, loopFunc, printWatchdogEpochs, robotInit, robotPeriodic, setNetworkTablesFlushEnabled, simulationInit, simulationPeriodic, teleopExit, teleopInit, teleopPeriodic, testExit, testInit, testPeriodic

Methods inherited from class edu.wpi.first.wpilibj.RobotBase

getMainThreadId, getRuntimeType, isAutonomous, isAutonomousEnabled, isDisabled, isEnabled, isReal, isSimulation, isTeleop, isTeleopEnabled, isTest, isTestEnabled, startRobot, suppressExitWarning

Methods inherited from class java.lang.Object

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

Field Details

defaultPeriodSecs

public static final double defaultPeriodSecs

Default loop period.

See Also:

• Constant Field Values

Constructor Details

LoggedRobot

protected LoggedRobot()

Constructor for LoggedRobot.

LoggedRobot

protected LoggedRobot(double period)

Constructor for LoggedRobot.

Parameters:

period - Period in seconds.

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class RobotBase

startCompetition

public void startCompetition()

Provide an alternate "main loop" via startCompetition().

Specified by:

startCompetition in class IterativeRobotBase

endCompetition

public void endCompetition()

Ends the main loop in startCompetition().

Specified by:

endCompetition in class RobotBase

setUseTiming

public void setUseTiming(boolean useTiming)

Sets whether to use standard timing or run as fast as possible.

Parameters:

useTiming - If true, use standard timing. If false, run as fast as possible.