Index (navx-vendordep API)

A B C E F G H I K R S U V Z
All Classes and Interfaces|All Packages

A

AHRS - Class in com.studica.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(AHRS.NavXComType) - Constructor for class com.studica.frc.AHRS: Constructs the AHRS class using the selected communication.
AHRS(AHRS.NavXComType, int) - Constructor for class com.studica.frc.AHRS: Constructs the AHRS class using the selected communication, overriding the default update rate with a custom rate which may be from 4 to 200, representing the number of updates per second sent by the sensor.
AHRS(AHRS.NavXComType, AHRS.NavXUpdateRate) - Constructor for class com.studica.frc.AHRS: Constructs the AHRS class using the selected communication, overriding the default update rate with a custom rate which may be from 4 to 200, representing the number of updates per second sent by the sensor.
AHRS.BoardAxis - Enum Class in com.studica.frc: Identifies one of the three sensing axes on the navX sensor board.
AHRS.BoardYawAxis - Class in com.studica.frc: Indicates which sensor board axis is used as the "yaw" (gravity) axis.
AHRS.NavXComType - Enum Class in com.studica.frc: Enum for the user to select which method to communcicate with a navx device
AHRS.NavXUpdateRate - Enum Class in com.studica.frc: Enum for the user to select which custom update rate to run the NavX and NavX background thread at.
AHRSJNI - Class in com.studica.frc.jni
AHRSJNI() - Constructor for class com.studica.frc.jni.AHRSJNI

B

board_axis - Variable in class com.studica.frc.AHRS.BoardYawAxis
BoardYawAxis(int, boolean) - Constructor for class com.studica.frc.AHRS.BoardYawAxis

C

c_AHRS_ConfigureVelocity(boolean, boolean, boolean, boolean) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_create(AHRS.NavXComType) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_create_custom(AHRS.NavXComType, int) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_create_rate(AHRS.NavXComType, AHRS.NavXUpdateRate) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_destroy() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_EnableBoardlevelYawReset(boolean) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_EnableLogging(boolean) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetAccelFullScaleRangeG() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetActualUpdateRate() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetAltitude() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetAngle() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetAngleAdjustment() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetBarometricPressure() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetBoardYawAxis() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetByteCount() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetCompassHeading() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetDisplacementX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetDisplacementY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetDisplacementZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetFirmwareVersion() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetFusedHeading() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetGyroFullScaleRangeDPS() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetLastSensorTimestamp() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetPitch() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetPressure() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetQuaternionW() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetQuaternionX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetQuaternionY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetQuaternionZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRate() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawAccelX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawAccelY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawAccelZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawGyroX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawGyroY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawGyroZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawMagX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawMagY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRawMagZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRequestedUpdateRate() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRobotCentricVelocityX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRobotCentricVelocityY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRobotCentricVelocityZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetRoll() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetTempC() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetUpdateCount() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetVelocityX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetVelocityY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetVelocityZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetWorldLinearAccelX() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetWorldLinearAccelY() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetWorldLinearAccelZ() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_GetYaw() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsAltitudeValid() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsBoardlevelYawResetEnabled() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsCalibrating() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsConnected() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsMagneticDisturbance() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsMagnetometerCalibrated() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsMoving() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_IsRotating() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_Reset() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_ResetDisplacement() - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_SetAngleAdjustment(double) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_UpdateDisplacement(float, float, int, boolean) - Static method in class com.studica.frc.jni.AHRSJNI
c_AHRS_ZeroYaw() - Static method in class com.studica.frc.jni.AHRSJNI
close() - Method in class com.studica.frc.AHRS
com.studica.frc - package com.studica.frc
com.studica.frc.jni - package com.studica.frc.jni
configureVelocity(boolean, boolean, boolean, boolean) - Method in class com.studica.frc.AHRS: Call this to configure swapable axes for X/Y or to invert an axis.

E

enableBoardlevelYawReset(boolean) - Method in class com.studica.frc.AHRS: Enables or disables board-level yaw zero (reset) requests.
enableLogging(boolean) - Method in class com.studica.frc.AHRS: Enables or disables logging (via Console I/O) of AHRS library internal behaviors, including events such as transient communication errors.

F

forceLoad() - Static method in class com.studica.frc.jni.StudicaJNIWrapper: Force load the library.

G

getAccelFullScaleRangeG() - Method in class com.studica.frc.AHRS: Returns the sensor full scale range (in G) of the X, Y and X-axis accelerometers.
getActualUpdateRate() - Method in class com.studica.frc.AHRS: Returns the navX-Model device's currently configured update rate.
getAltitude() - Method in class com.studica.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.studica.frc.AHRS: Returns the total accumulated yaw angle (Z Axis, in degrees) reported by the sensor.
getAngleAdjustment() - Method in class com.studica.frc.AHRS: Returns the currently configured adjustment angle.
getBarometricPressure() - Method in class com.studica.frc.AHRS: Returns the current barometric pressure, based upon calibrated readings from the onboard pressure sensor.
getBoardYawAxis() - Method in class com.studica.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.studica.frc.AHRS: Returns the count in bytes of data received from the sensor.
getCompassHeading() - Method in class com.studica.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.studica.frc.AHRS: Returns the displacement (in meters) of the X axis since resetDisplacement() was last invoked [Experimental].
getDisplacementY() - Method in class com.studica.frc.AHRS: Returns the displacement (in meters) of the Y axis since resetDisplacement() was last invoked [Experimental].
getDisplacementZ() - Method in class com.studica.frc.AHRS: Returns the displacement (in meters) of the Z axis since resetDisplacement() was last invoked [Experimental].
getExtractOnStaticLoad() - Static method in class com.studica.frc.jni.StudicaJNIWrapper.Helper: Get whether to load the driver on static init.
getFirmwareVersion() - Method in class com.studica.frc.AHRS: Returns the version number of the firmware currently executing on the sensor.
getFusedHeading() - Method in class com.studica.frc.AHRS: Returns the "fused" (9-axis) heading.
getGyroFullScaleRangeDPS() - Method in class com.studica.frc.AHRS: Returns the sensor full scale range (in degrees per second) of the X, Y and X-axis gyroscopes.
getLastSensorTimestamp() - Method in class com.studica.frc.AHRS: Returns the sensor timestamp corresponding to the last sample retrieved from the sensor.
getPitch() - Method in class com.studica.frc.AHRS: Returns the current pitch value (in degrees, from -180 to 180) reported by the sensor.
getPort() - Method in class com.studica.frc.AHRS: Returns the port number of the navx.
getPressure() - Method in class com.studica.frc.AHRS: Returns the current barometric pressure (in millibar) [navX Aero only].
getQuaternionW() - Method in class com.studica.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.studica.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.studica.frc.AHRS: Returns the real portion (Y 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.studica.frc.AHRS: Returns the real portion (Z 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.studica.frc.AHRS: Return the rate of rotation of the yaw (Z-axis) gyro, in degrees per second.
getRawAccelX() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) X-axis acceleration rate (in G).
getRawAccelY() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) Y-axis acceleration rate (in G).
getRawAccelZ() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) Z-axis acceleration rate (in G).
getRawGyroX() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) X-axis gyro rotation rate (in degrees/sec).
getRawGyroY() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) Y-axis gyro rotation rate (in degrees/sec).
getRawGyroZ() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) Z-axis gyro rotation rate (in degrees/sec).
getRawMagX() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) X-axis magnetometer reading (in uTesla).
getRawMagY() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) Y-axis magnetometer reading (in uTesla).
getRawMagZ() - Method in class com.studica.frc.AHRS: Returns the current raw (unprocessed) Z-axis magnetometer reading (in uTesla).
getRequestedUpdateRate() - Method in class com.studica.frc.AHRS: Returns the currently requested update rate.
getRobotCentricVelocityX() - Method in class com.studica.frc.AHRS: Returns the velocity (in meters/sec) of the Robot Centric X axis [Experimental].
getRobotCentricVelocityY() - Method in class com.studica.frc.AHRS: Returns the velocity (in meters/sec) of the Robot Centric Y axis [Experimental].
getRobotCentricVelocityZ() - Method in class com.studica.frc.AHRS: Returns the velocity (in meters/sec) of the Robot Centric Z axis [Experimental].
getRoll() - Method in class com.studica.frc.AHRS: Returns the current roll value (in degrees, from -180 to 180) reported by the sensor.
getRotation2d() - Method in class com.studica.frc.AHRS: Return the heading of the robot as a Rotation2d.
getRotation3d() - Method in class com.studica.frc.AHRS: Constructs a Rotation3d from a quaternion
getTempC() - Method in class com.studica.frc.AHRS: Returns the current temperature (in degrees centigrade) reported by the sensor's gyro/accelerometer circuit.
getUpdateCount() - Method in class com.studica.frc.AHRS: Returns the count of valid updates which have been received from the sensor.
getValue() - Method in enum class com.studica.frc.AHRS.BoardAxis
getValue() - Method in enum class com.studica.frc.AHRS.NavXComType
getValue() - Method in enum class com.studica.frc.AHRS.NavXUpdateRate
getVelocityX() - Method in class com.studica.frc.AHRS: Returns the velocity (in meters/sec) of the X axis [Experimental].
getVelocityY() - Method in class com.studica.frc.AHRS: Returns the velocity (in meters/sec) of the Y axis [Experimental].
getVelocityZ() - Method in class com.studica.frc.AHRS: Returns the velocity (in meters/sec) of the Z axis [Experimental].
getWorldLinearAccelX() - Method in class com.studica.frc.AHRS: Returns the current linear acceleration in the X-axis (in G).
getWorldLinearAccelY() - Method in class com.studica.frc.AHRS: Returns the current linear acceleration in the Y-axis (in G).
getWorldLinearAccelZ() - Method in class com.studica.frc.AHRS: Returns the current linear acceleration in the Z-axis (in G).
getYaw() - Method in class com.studica.frc.AHRS: Returns the current yaw value (in degrees, from -180 to 180) reported by the sensor.

H

Helper() - Constructor for class com.studica.frc.jni.StudicaJNIWrapper.Helper

I

initSendable(NTSendableBuilder) - Method in class com.studica.frc.AHRS: Initializes smart dashboard communication
isAltitudeValid() - Method in class com.studica.frc.AHRS: Indicates whether the current altitude (and barometric pressure) data is valid.
isBoardlevelYawResetEnabled() - Method in class com.studica.frc.AHRS: Returns true if Board-level yaw resets are enabled.
isCalibrating() - Method in class com.studica.frc.AHRS: Returns true if the sensor is currently performing automatic gyro/accelerometer calibration.
isConnected() - Method in class com.studica.frc.AHRS: Indicates whether the sensor is currently connected to the host computer.
isMagneticDisturbance() - Method in class com.studica.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.studica.frc.AHRS: Indicates whether the magnetometer has been calibrated.
isMoving() - Method in class com.studica.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.studica.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."

K

k100Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k10Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k200Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k20Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k25Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k40Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k4Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k50Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k5Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
k8Hz - Enum constant in enum class com.studica.frc.AHRS.NavXUpdateRate
kBoardAxisX - Enum constant in enum class com.studica.frc.AHRS.BoardAxis
kBoardAxisY - Enum constant in enum class com.studica.frc.AHRS.BoardAxis
kBoardAxisZ - Enum constant in enum class com.studica.frc.AHRS.BoardAxis
kI2C - Enum constant in enum class com.studica.frc.AHRS.NavXComType
kMXP_SPI - Enum constant in enum class com.studica.frc.AHRS.NavXComType
kMXP_UART - Enum constant in enum class com.studica.frc.AHRS.NavXComType
kUSB1 - Enum constant in enum class com.studica.frc.AHRS.NavXComType
kUSB2 - Enum constant in enum class com.studica.frc.AHRS.NavXComType

R

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

S

setAngleAdjustment(double) - Method in class com.studica.frc.AHRS: Sets an amount of angle to be automatically added before returning a angle from the getAngle() method.
setExtractOnStaticLoad(boolean) - Static method in class com.studica.frc.jni.StudicaJNIWrapper.Helper: Set whether to load the driver on static init.
StudicaJNIWrapper - Class in com.studica.frc.jni: Demo class for loading the driver via JNI.
StudicaJNIWrapper() - Constructor for class com.studica.frc.jni.StudicaJNIWrapper
StudicaJNIWrapper.Helper - Class in com.studica.frc.jni: Helper class for determining whether or not to load the driver on static initialization.

U

up - Variable in class com.studica.frc.AHRS.BoardYawAxis
updateDisplacement(float, float, int, boolean) - Method in class com.studica.frc.AHRS: Each time new linear acceleration samples are received, this function should be invoked.

V

valueOf(String) - Static method in enum class com.studica.frc.AHRS.BoardAxis: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.studica.frc.AHRS.NavXComType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.studica.frc.AHRS.NavXUpdateRate: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.studica.frc.AHRS.BoardAxis: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.studica.frc.AHRS.NavXComType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.studica.frc.AHRS.NavXUpdateRate: Returns an array containing the constants of this enum class, in the order they are declared.

Z

zeroYaw() - Method in class com.studica.frc.AHRS: Sets the user-specified yaw offset to the current yaw value reported by the sensor.

A B C E F G H I K R S U V Z
All Classes and Interfaces|All Packages