Skip navigation links
A B C G I P R S U V Z 

A

AHRS - Class in com.kauailabs.navx.frc
The AHRS class provides an interface to AHRS capabilities of the KauaiLabs navX Robotics Navigation Sensor via SPI, I2C and Serial (TTL UART and USB) communications interfaces on the RoboRIO.
AHRS(SPI.Port, byte) - Constructor for class com.kauailabs.navx.frc.AHRS
Constructs the AHRS class using SPI communication, overriding the default update rate with a custom rate which may be from 4 to 60, representing the number of updates per second sent by the sensor.
AHRS(SPI.Port, int, byte) - Constructor for class com.kauailabs.navx.frc.AHRS
The AHRS class provides an interface to AHRS capabilities of the KauaiLabs navX Robotics Navigation Sensor via SPI, I2C and Serial (TTL UART and USB) communications interfaces on the RoboRIO.
AHRS(I2C.Port, byte) - Constructor for class com.kauailabs.navx.frc.AHRS
Constructs the AHRS class using I2C communication, overriding the default update rate with a custom rate which may be from 4 to 60, representing the number of updates per second sent by the sensor.
AHRS(SerialPort.Port, AHRS.SerialDataType, byte) - Constructor for class com.kauailabs.navx.frc.AHRS
Constructs the AHRS class using serial communication, overriding the default update rate with a custom rate which may be from 4 to 60, representing the number of updates per second sent by the sensor.
AHRS(SPI.Port) - Constructor for class com.kauailabs.navx.frc.AHRS
Constructs the AHRS class using SPI communication and the default update rate.
AHRS(I2C.Port) - Constructor for class com.kauailabs.navx.frc.AHRS
Constructs the AHRS class using I2C communication and the default update rate.
AHRS(SerialPort.Port) - Constructor for class com.kauailabs.navx.frc.AHRS
Constructs the AHRS class using serial communication and the default update rate, and returning processed (rather than raw) data.
AHRS.BoardAxis - Enum in com.kauailabs.navx.frc
Identifies one of the three sensing axes on the navX sensor board.
AHRS.BoardYawAxis - Class in com.kauailabs.navx.frc
Indicates which sensor board axis is used as the "yaw" (gravity) axis.
AHRS.SerialDataType - Enum in com.kauailabs.navx.frc
For use with serial communications, the SerialDataType specifies the type of data to be streamed from the sensor.

B

board_axis - Variable in class com.kauailabs.navx.frc.AHRS.BoardYawAxis
 
BoardYawAxis() - Constructor for class com.kauailabs.navx.frc.AHRS.BoardYawAxis
 

C

com.kauailabs.navx.frc - package com.kauailabs.navx.frc
 

G

getAltitude() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current altitude, based upon calibrated readings from a barometric pressure sensor, and the currently-configured sea-level barometric pressure [navX Aero only].
getAngle() - Method in class com.kauailabs.navx.frc.AHRS
Returns the total accumulated yaw angle (Z Axis, in degrees) reported by the sensor.
getBarometricPressure() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current barometric pressure, based upon calibrated readings from the onboard pressure sensor.
getBoardYawAxis() - Method in class com.kauailabs.navx.frc.AHRS
Returns information regarding which sensor board axis (X,Y or Z) and direction (up/down) is currently configured to report Yaw (Z) angle values.
getByteCount() - Method in class com.kauailabs.navx.frc.AHRS
Returns the count in bytes of data received from the sensor.
getCompassHeading() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current tilt-compensated compass heading value (in degrees, from 0 to 360) reported by the sensor.
getDisplacementX() - Method in class com.kauailabs.navx.frc.AHRS
Returns the displacement (in meters) of the X axis since resetDisplacement() was last invoked [Experimental].
getDisplacementY() - Method in class com.kauailabs.navx.frc.AHRS
Returns the displacement (in meters) of the Y axis since resetDisplacement() was last invoked [Experimental].
getDisplacementZ() - Method in class com.kauailabs.navx.frc.AHRS
Returns the displacement (in meters) of the Z axis since resetDisplacement() was last invoked [Experimental].
getFirmwareVersion() - Method in class com.kauailabs.navx.frc.AHRS
Returns the version number of the firmware currently executing on the sensor.
getFusedHeading() - Method in class com.kauailabs.navx.frc.AHRS
Returns the "fused" (9-axis) heading.
getPIDSourceType() - Method in class com.kauailabs.navx.frc.AHRS
 
getPitch() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current pitch value (in degrees, from -180 to 180) reported by the sensor.
getPressure() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current barometric pressure (in millibar) [navX Aero only].
getQuaternionW() - Method in class com.kauailabs.navx.frc.AHRS
Returns the imaginary portion (W) of the Orientation Quaternion which fully describes the current sensor orientation with respect to the reference angle defined as the angle at which the yaw was last "zeroed".
getQuaternionX() - Method in class com.kauailabs.navx.frc.AHRS
Returns the real portion (X axis) of the Orientation Quaternion which fully describes the current sensor orientation with respect to the reference angle defined as the angle at which the yaw was last "zeroed".
getQuaternionY() - Method in class com.kauailabs.navx.frc.AHRS
Returns the real portion (X axis) of the Orientation Quaternion which fully describes the current sensor orientation with respect to the reference angle defined as the angle at which the yaw was last "zeroed".
getQuaternionZ() - Method in class com.kauailabs.navx.frc.AHRS
Returns the real portion (X axis) of the Orientation Quaternion which fully describes the current sensor orientation with respect to the reference angle defined as the angle at which the yaw was last "zeroed".
getRate() - Method in class com.kauailabs.navx.frc.AHRS
Return the rate of rotation of the yaw (Z-axis) gyro, in degrees per second.
getRawAccelX() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) X-axis acceleration rate (in G).
getRawAccelY() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) Y-axis acceleration rate (in G).
getRawAccelZ() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) Z-axis acceleration rate (in G).
getRawGyroX() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) X-axis gyro rotation rate (in degrees/sec).
getRawGyroY() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) Y-axis gyro rotation rate (in degrees/sec).
getRawGyroZ() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) Z-axis gyro rotation rate (in degrees/sec).
getRawMagX() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) X-axis magnetometer reading (in uTesla).
getRawMagY() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) Y-axis magnetometer reading (in uTesla).
getRawMagZ() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current raw (unprocessed) Z-axis magnetometer reading (in uTesla).
getRoll() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current roll value (in degrees, from -180 to 180) reported by the sensor.
getSmartDashboardType() - Method in class com.kauailabs.navx.frc.AHRS
 
getTable() - Method in class com.kauailabs.navx.frc.AHRS
 
getTempC() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current temperature (in degrees centigrade) reported by the sensor's gyro/accelerometer circuit.
getUpdateCount() - Method in class com.kauailabs.navx.frc.AHRS
Returns the count of valid updates which have been received from the sensor.
getValue() - Method in enum com.kauailabs.navx.frc.AHRS.BoardAxis
 
getValue() - Method in enum com.kauailabs.navx.frc.AHRS.SerialDataType
 
getVelocityX() - Method in class com.kauailabs.navx.frc.AHRS
Returns the velocity (in meters/sec) of the X axis [Experimental].
getVelocityY() - Method in class com.kauailabs.navx.frc.AHRS
Returns the velocity (in meters/sec) of the Y axis [Experimental].
getVelocityZ() - Method in class com.kauailabs.navx.frc.AHRS
Returns the velocity (in meters/sec) of the Z axis [Experimental].
getWorldLinearAccelX() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current linear acceleration in the X-axis (in G).
getWorldLinearAccelY() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current linear acceleration in the Y-axis (in G).
getWorldLinearAccelZ() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current linear acceleration in the Z-axis (in G).
getYaw() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current yaw value (in degrees, from -180 to 180) reported by the sensor.

I

initTable(ITable) - Method in class com.kauailabs.navx.frc.AHRS
 
isAltitudeValid() - Method in class com.kauailabs.navx.frc.AHRS
Indicates whether the current altitude (and barometric pressure) data is valid.
isCalibrating() - Method in class com.kauailabs.navx.frc.AHRS
Returns true if the sensor is currently performing automatic gyro/accelerometer calibration.
isConnected() - Method in class com.kauailabs.navx.frc.AHRS
Indicates whether the sensor is currently connected to the host computer.
isMagneticDisturbance() - Method in class com.kauailabs.navx.frc.AHRS
Indicates whether the current magnetic field strength diverges from the calibrated value for the earth's magnetic field by more than the currently- configured Magnetic Disturbance Ratio.
isMagnetometerCalibrated() - Method in class com.kauailabs.navx.frc.AHRS
Indicates whether the magnetometer has been calibrated.
isMoving() - Method in class com.kauailabs.navx.frc.AHRS
Indicates if the sensor is currently detecting motion, based upon the X and Y-axis world linear acceleration values.
isRotating() - Method in class com.kauailabs.navx.frc.AHRS
Indicates if the sensor is currently detecting yaw rotation, based upon whether the change in yaw over the last second exceeds the "Rotation Threshold."

P

pidGet() - Method in class com.kauailabs.navx.frc.AHRS
Returns the current yaw value reported by the sensor.

R

reset() - Method in class com.kauailabs.navx.frc.AHRS
Reset the Yaw gyro.
resetDisplacement() - Method in class com.kauailabs.navx.frc.AHRS
Zeros the displacement integration variables.

S

setPIDSourceType(PIDSourceType) - Method in class com.kauailabs.navx.frc.AHRS
 
startLiveWindowMode() - Method in class com.kauailabs.navx.frc.AHRS
 
stopLiveWindowMode() - Method in class com.kauailabs.navx.frc.AHRS
 

U

up - Variable in class com.kauailabs.navx.frc.AHRS.BoardYawAxis
 
updateTable() - Method in class com.kauailabs.navx.frc.AHRS
 

V

valueOf(String) - Static method in enum com.kauailabs.navx.frc.AHRS.BoardAxis
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.kauailabs.navx.frc.AHRS.SerialDataType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.kauailabs.navx.frc.AHRS.BoardAxis
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.kauailabs.navx.frc.AHRS.SerialDataType
Returns an array containing the constants of this enum type, in the order they are declared.

Z

zeroYaw() - Method in class com.kauailabs.navx.frc.AHRS
Sets the user-specified yaw offset to the current yaw value reported by the sensor.
A B C G I P R S U V Z 
Skip navigation links