com.qualcomm.robotcore.hardware

Class CompassSensor

java.lang.Object

com.qualcomm.robotcore.hardware.CompassSensor

All Implemented Interfaces:

HardwareDevice

public abstract class CompassSensor
extends java.lang.Object
implements HardwareDevice

Compass Sensor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompassSensor.CompassMode

Constructor Summary

Constructors

Constructor and Description
CompassSensor()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	calibrationFailed() Check to see whether calibration was successful.
abstract double	getDirection() Get the current direction, in degrees
abstract void	setMode(CompassSensor.CompassMode mode) Change to calibration or measurement mode
abstract java.lang.String	status() Status of this sensor, in string form
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.qualcomm.robotcore.hardware.HardwareDevice

close, getConnectionInfo, getDeviceName, getVersion

Constructor Detail

CompassSensor

public CompassSensor()

Method Detail

getDirection

public abstract double getDirection()

Get the current direction, in degrees

Returns:

current direction, in degrees

status

public abstract java.lang.String status()

Status of this sensor, in string form

Returns:

status

setMode

public abstract void setMode(CompassSensor.CompassMode mode)

Change to calibration or measurement mode

calibrationFailed

public abstract boolean calibrationFailed()

Check to see whether calibration was successful. After attempting a calibration, the hardware will (eventually) indicate whether or not it was unsuccessful. The default is "success", even when the calibration is not guaranteed to have completed successfully. A user should monitor this field for (at least) several seconds to determine success.

Returns:

failure

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object