io.github.robolib.module

Interface MotorSafety

All Known Implementing Classes:

CANJaguar, CANTalon, DriveBase, Jaguar, LimitedController, PWMController, Talon, TalonSRX, Victor, VictorSP

public interface MotorSafety

The Interface MotorSafety.

Author:

noriah

Field Summary

Fields

Modifier and Type	Field and Description
static double	SAFETY_TIMEOUT_DEFAULT The Constant SAFETY_TIMEOUT_DEFAULT.
static double	SAFETY_TIMEOUT_LOOSE The Constant SAFETY_TIMEOUT_LOOSE.
static double	SAFETY_TIMEOUT_STRICT The Constant SAFETY_TIMEOUT_STRICT.

Method Summary

Modifier and Type	Method and Description
default void	feed() Feed the safety helper
java.lang.String	getDescription() Gets the description.
default double	getSafetyExpiration() Gets the safety expiration.
MotorSafetyHelper	getSafetyHelper() Return the MotorSafetyHelper object for this MotorSafety Object
default boolean	isAlive() Checks if is alive.
default boolean	isSafetyEnabled() Checks if is safety enabled.
default void	setSafetyEnabled(boolean enabled) Enable safety.
default void	setSafetyExpiration(double timeout) Sets the safety expiration.
void	stopMotor() Stop motor.

Field Detail

SAFETY_TIMEOUT_DEFAULT

static final double SAFETY_TIMEOUT_DEFAULT

The Constant SAFETY_TIMEOUT_DEFAULT.

See Also:

Constant Field Values

SAFETY_TIMEOUT_STRICT

static final double SAFETY_TIMEOUT_STRICT

The Constant SAFETY_TIMEOUT_STRICT.

See Also:

Constant Field Values

SAFETY_TIMEOUT_LOOSE

static final double SAFETY_TIMEOUT_LOOSE

The Constant SAFETY_TIMEOUT_LOOSE.

See Also:

Constant Field Values

Method Detail

getSafetyHelper

MotorSafetyHelper getSafetyHelper()

Return the MotorSafetyHelper object for this MotorSafety Object

Returns:

the motor safety helper

feed

default void feed()

Feed the safety helper

isAlive

default boolean isAlive()

Checks if is alive.

Returns:

true, if is alive

setSafetyExpiration

default void setSafetyExpiration(double timeout)

Sets the safety expiration.

Parameters:

timeout - the new safety expiration

getSafetyExpiration

default double getSafetyExpiration()

Gets the safety expiration.

Returns:

the safety expiration

stopMotor

void stopMotor()

Stop motor.

setSafetyEnabled

default void setSafetyEnabled(boolean enabled)

Enable safety.

Parameters:

enabled - the enabled

isSafetyEnabled

default boolean isSafetyEnabled()

Checks if is safety enabled.

Returns:

true, if is safety enabled

getDescription

java.lang.String getDescription()

Gets the description.

Returns:

the description