HiTechnicNxtCompassSensor (FtcRobotController API)

java.lang.Object
- com.qualcomm.robotcore.hardware.I2cControllerPortDeviceImpl
- - com.qualcomm.hardware.hitechnic.HiTechnicNxtCompassSensor

All Implemented Interfaces:

CompassSensor, HardwareDevice, I2cController.I2cPortReadyCallback, I2cControllerPortDevice, RobotArmingStateNotifier.Callback
```
public class HiTechnicNxtCompassSensor
extends I2cControllerPortDeviceImpl
implements CompassSensor, I2cController.I2cPortReadyCallback
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.qualcomm.robotcore.hardware.CompassSensor
  CompassSensor.CompassMode
- Nested classes/interfaces inherited from interface com.qualcomm.robotcore.hardware.HardwareDevice
  HardwareDevice.Manufacturer

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`CALIBRATION`
`static byte`	`CALIBRATION_FAILURE`
`static int`	`COMPASS_BUFFER`
`static int`	`COMPASS_BUFFER_SIZE`
`static byte`	`DIRECTION_END`
`static byte`	`DIRECTION_START`
`static byte`	`HEADING_IN_TWO_DEGREE_INCREMENTS`
`static int`	`HEADING_WORD_LENGTH`
`static I2cAddr`	`I2C_ADDRESS`
`static double`	`INVALID_DIRECTION`
`static byte`	`MEASUREMENT`
`static byte`	`MODE_CONTROL_ADDRESS`
`static byte`	`ONE_DEGREE_HEADING_ADDER`

Fields inherited from class com.qualcomm.robotcore.hardware.I2cControllerPortDeviceImpl
controller, physicalPort

Constructor Summary

Constructors
Constructor and Description

HiTechnicNxtCompassSensor(I2cController module, int physicalPort)

Constructors
Constructor and Description
`HiTechnicNxtCompassSensor(I2cController module, int physicalPort)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`calibrationFailed()` Check to see whether calibration was successful.
`void`	`close()` Closes this device
`protected void`	`controllerNowArmedOrPretending()` intended as a subclass hook
`java.lang.String`	`getConnectionInfo()` Get connection information about this device in a human readable format
`java.lang.String`	`getDeviceName()` Returns a string suitable for display to the user as to the type of device.
`double`	`getDirection()` Get the current direction, in degrees, in the range [0, 360).
`HardwareDevice.Manufacturer`	`getManufacturer()` Returns an indication of the manufacturer of this device.
`int`	`getVersion()` Version
`void`	`portIsReady(int port)`
`void`	`resetDeviceConfigurationForOpMode()` Resets the device's configuration to that which is expected at the beginning of an OpMode.
`void`	`setMode(CompassSensor.CompassMode mode)` Change to calibration or measurement mode
`java.lang.String`	`status()` Status of this sensor, in string form
`java.lang.String`	`toString()`

Methods inherited from class com.qualcomm.robotcore.hardware.I2cControllerPortDeviceImpl
controllerNowDisarmed, finishConstruction, getI2cController, getPort, onModuleStateChange

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - I2C_ADDRESS
```
public static final I2cAddr I2C_ADDRESS
```
  - MODE_CONTROL_ADDRESS
```
public static final byte MODE_CONTROL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - CALIBRATION
```
public static final byte CALIBRATION
```
    See Also:
    
    Constant Field Values
  - MEASUREMENT
```
public static final byte MEASUREMENT
```
    See Also:
    
    Constant Field Values
  - HEADING_IN_TWO_DEGREE_INCREMENTS
```
public static final byte HEADING_IN_TWO_DEGREE_INCREMENTS
```
    See Also:
    
    Constant Field Values
  - ONE_DEGREE_HEADING_ADDER
```
public static final byte ONE_DEGREE_HEADING_ADDER
```
    See Also:
    
    Constant Field Values
  - CALIBRATION_FAILURE
```
public static final byte CALIBRATION_FAILURE
```
    See Also:
    
    Constant Field Values
  - DIRECTION_START
```
public static final byte DIRECTION_START
```
    See Also:
    
    Constant Field Values
  - DIRECTION_END
```
public static final byte DIRECTION_END
```
    See Also:
    
    Constant Field Values
  - INVALID_DIRECTION
```
public static final double INVALID_DIRECTION
```
    See Also:
    
    Constant Field Values
  - HEADING_WORD_LENGTH
```
public static final int HEADING_WORD_LENGTH
```
    See Also:
    
    Constant Field Values
  - COMPASS_BUFFER
```
public static final int COMPASS_BUFFER
```
    See Also:
    
    Constant Field Values
  - COMPASS_BUFFER_SIZE
```
public static final int COMPASS_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HiTechnicNxtCompassSensor
```
public HiTechnicNxtCompassSensor(I2cController module,
                                 int physicalPort)
```
- Method Detail
  - controllerNowArmedOrPretending
```
protected void controllerNowArmedOrPretending()
```
    Description copied from class: I2cControllerPortDeviceImpl
    
    intended as a subclass hook
    
    Overrides:
    
    controllerNowArmedOrPretending in class I2cControllerPortDeviceImpl
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getDirection
```
public double getDirection()
```
    Description copied from interface: CompassSensor
    
    Get the current direction, in degrees, in the range [0, 360). North is zero, East is 90, South is 180, and West is 270.
    
    Specified by:
    
    getDirection in interface CompassSensor
    
    Returns:
    
    current direction, in degrees
  - status
```
public java.lang.String status()
```
    Description copied from interface: CompassSensor
    
    Status of this sensor, in string form
    
    Specified by:
    
    status in interface CompassSensor
    
    Returns:
    
    status
  - setMode
```
public void setMode(CompassSensor.CompassMode mode)
```
    Description copied from interface: CompassSensor
    
    Change to calibration or measurement mode
    
    Specified by:
    
    setMode in interface CompassSensor
  - calibrationFailed
```
public boolean calibrationFailed()
```
    Description copied from interface: CompassSensor
    
    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.
    
    Specified by:
    
    calibrationFailed in interface CompassSensor
    
    Returns:
    
    failure
  - portIsReady
```
public void portIsReady(int port)
```
    Specified by:
    
    portIsReady in interface I2cController.I2cPortReadyCallback
  - getManufacturer
```
public HardwareDevice.Manufacturer getManufacturer()
```
    Description copied from interface: HardwareDevice
    
    Returns an indication of the manufacturer of this device.
    
    Specified by:
    
    getManufacturer in interface HardwareDevice
    
    Returns:
    
    the device's manufacturer
  - getDeviceName
```
public java.lang.String getDeviceName()
```
    Description copied from interface: HardwareDevice
    
    Returns a string suitable for display to the user as to the type of device. Note that this is a device-type-specific name; it has nothing to do with the name by which a user might have configured the device in a robot configuration.
    
    Specified by:
    
    getDeviceName in interface HardwareDevice
    
    Returns:
    
    device manufacturer and name
  - getConnectionInfo
```
public java.lang.String getConnectionInfo()
```
    Description copied from interface: HardwareDevice
    
    Get connection information about this device in a human readable format
    
    Specified by:
    
    getConnectionInfo in interface HardwareDevice
    
    Returns:
    
    connection info
  - getVersion
```
public int getVersion()
```
    Description copied from interface: HardwareDevice
    
    Version
    
    Specified by:
    
    getVersion in interface HardwareDevice
    
    Returns:
    
    get the version of this device
  - resetDeviceConfigurationForOpMode
```
public void resetDeviceConfigurationForOpMode()
```
    Description copied from interface: HardwareDevice
    
    Resets the device's configuration to that which is expected at the beginning of an OpMode. For example, motors will reset the their direction to 'forward'.
    
    Specified by:
    
    resetDeviceConfigurationForOpMode in interface HardwareDevice
  - close
```
public void close()
```
    Description copied from interface: HardwareDevice
    
    Closes this device
    
    Specified by:
    
    close in interface HardwareDevice

Class HiTechnicNxtCompassSensor

Nested Class Summary

Nested classes/interfaces inherited from interface com.qualcomm.robotcore.hardware.CompassSensor

Nested classes/interfaces inherited from interface com.qualcomm.robotcore.hardware.HardwareDevice

Field Summary

Fields inherited from class com.qualcomm.robotcore.hardware.I2cControllerPortDeviceImpl

Constructor Summary

Method Summary

Methods inherited from class com.qualcomm.robotcore.hardware.I2cControllerPortDeviceImpl

Methods inherited from class java.lang.Object

Field Detail

I2C_ADDRESS

MODE_CONTROL_ADDRESS

CALIBRATION

MEASUREMENT

HEADING_IN_TWO_DEGREE_INCREMENTS

ONE_DEGREE_HEADING_ADDER

CALIBRATION_FAILURE

DIRECTION_START

DIRECTION_END

INVALID_DIRECTION

HEADING_WORD_LENGTH

COMPASS_BUFFER

COMPASS_BUFFER_SIZE

Constructor Detail

HiTechnicNxtCompassSensor

Method Detail

controllerNowArmedOrPretending

toString

getDirection

status

setMode

calibrationFailed

portIsReady

getManufacturer

getDeviceName

getConnectionInfo

getVersion

resetDeviceConfigurationForOpMode

close