Package ftclib.sensor

Class FtcSparkFunOtos

java.lang.Object

ftclib.sensor.FtcSparkFunOtos

All Implemented Interfaces:

TrcDriveBaseOdometry

public class FtcSparkFunOtos
extends Object
implements TrcDriveBaseOdometry

This class implements a DriveBase Odometry device using the SparkFun Optical Tracking Odometry Sensor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FtcSparkFunOtos.Config

Field Summary

Fields

Modifier and Type	Field	Description
private final String	instanceName
private final com.qualcomm.hardware.sparkfun.SparkFunOTOS	otos
final TrcDbgTrace	tracer

Constructor Summary

Constructors

Constructor	Description
FtcSparkFunOtos(com.qualcomm.robotcore.hardware.HardwareMap hardwareMap, String instanceName, FtcSparkFunOtos.Config config)	Constructor: Creates an instance of the object.
FtcSparkFunOtos(String instanceName)	Constructor: Creates an instance of the object with default configuration.
FtcSparkFunOtos(String instanceName, FtcSparkFunOtos.Config config)	Constructor: Creates an instance of the object.

Method Summary

Modifier and Type	Method	Description
TrcPose2D	getPosition()	This method returns the DriveBase position.
TrcPose2D	getVelocity()	This method returns the DriveBase velocity.
void	reset()	This method resets the DriveBase position.
void	setPosition(TrcPose2D pose)	This method sets the DriveBase position.
String	toString()	This method returns the instance name.
void	updateCache()	This method is called once at the beginning of the INPUT_TASK loop.

Methods inherited from class java.lang.Object

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

Field Details

tracer

public final TrcDbgTrace tracer

instanceName

private final String instanceName

otos

private final com.qualcomm.hardware.sparkfun.SparkFunOTOS otos

Constructor Details

FtcSparkFunOtos

public FtcSparkFunOtos(com.qualcomm.robotcore.hardware.HardwareMap hardwareMap,
 String instanceName,
 FtcSparkFunOtos.Config config)

Constructor: Creates an instance of the object.

Parameters:

hardwareMap - specifies the global hardware map.

instanceName - specifies the instance name.

config - specifies the sensor configuration.

FtcSparkFunOtos

public FtcSparkFunOtos(String instanceName,
 FtcSparkFunOtos.Config config)

Constructor: Creates an instance of the object.

Parameters:

instanceName - specifies the instance name.

config - specifies the sensor configuration.

FtcSparkFunOtos

public FtcSparkFunOtos(String instanceName)

Constructor: Creates an instance of the object with default configuration.

Parameters:

instanceName - specifies the instance name.

Method Details

toString

@NonNull
public String toString()

This method returns the instance name.

Overrides:

toString in class Object

Returns:

instance name.

updateCache

public void updateCache()

This method is called once at the beginning of the INPUT_TASK loop. Odometry device can update their cache at this time.

Specified by:

updateCache in interface TrcDriveBaseOdometry

reset

public void reset()

This method resets the DriveBase position.

Specified by:

reset in interface TrcDriveBaseOdometry

getPosition

public TrcPose2D getPosition()

This method returns the DriveBase position.

Specified by:

getPosition in interface TrcDriveBaseOdometry

Returns:

DriveBase position.

setPosition

public void setPosition(TrcPose2D pose)

This method sets the DriveBase position.

Specified by:

setPosition in interface TrcDriveBaseOdometry

Parameters:

pose - specifies the DriveBase position.

getVelocity

public TrcPose2D getVelocity()

This method returns the DriveBase velocity.

Specified by:

getVelocity in interface TrcDriveBaseOdometry

Returns:

DriveBase velocity.