org.firstinspires.ftc.ftccommon.external

Interface RobotStateMonitor

All Known Implementing Classes:

SoundPlayingRobotMonitor

public interface RobotStateMonitor

Instances of RobotStateMonitor can be registered with the Callback of UpdateUI in order to receive notifications when certain event transitions happen within the robot.

Method Summary

Modifier and Type	Method and Description
void	updateErrorMessage(java.lang.String errorMessage) Informs the monitor that a critical error occurred in the robot, or clears any error previously reported.
void	updateNetworkStatus(NetworkStatus networkStatus, java.lang.String extra) Informs the monitor of the current status of the network connection.
void	updatePeerStatus(PeerStatus peerStatus) Informs the monitor of the current status of relationship to the peer application.
void	updateRobotState(RobotState robotState) Informs the monitor of the current state of the robot.
void	updateRobotStatus(RobotStatus robotStatus) Informs the monitor of the current status of the robot.
void	updateWarningMessage(java.lang.String warningMessage) Informs the monitor that a warning has occurred in the robot, or clears any warning previously reported.

Method Detail

updateRobotState

void updateRobotState(RobotState robotState)

Informs the monitor of the current state of the robot. This may or may not be different from the state previously reported.

Parameters:

robotState - the current state of the robot.

updateRobotStatus

void updateRobotStatus(RobotStatus robotStatus)

Informs the monitor of the current status of the robot. This may or may not be different from the status previously reported. The robot status provides additional information when the robot is not in the running state.

Parameters:

robotStatus - the current status of the robot

See Also:

RobotStatus

updatePeerStatus

void updatePeerStatus(PeerStatus peerStatus)

Informs the monitor of the current status of relationship to the peer application. This may or may not be different from the status previously reported.

Parameters:

peerStatus - the relationship of this app to its peer

See Also:

PeerStatus

updateNetworkStatus

void updateNetworkStatus(NetworkStatus networkStatus,
                         java.lang.String extra)

Informs the monitor of the current status of the network connection. This may or may not be different from the status previously reported.

Parameters:

networkStatus - the current status of the network connection

extra - additional information useful in some statuses

updateErrorMessage

void updateErrorMessage(java.lang.String errorMessage)

Informs the monitor that a critical error occurred in the robot, or clears any error previously reported. This may or may not be different from the error message previously reported.

Parameters:

errorMessage - the error message being reported, or null if the error is being cleared.

updateWarningMessage

void updateWarningMessage(java.lang.String warningMessage)

Informs the monitor that a warning has occurred in the robot, or clears any warning previously reported. This may or may not be different from the warning message previously reported.

Parameters:

warningMessage - the warning message being reported, or null if the warning is being cleared.