Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- accel() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
accelrecord component. - Acceleration3d(LinearAcceleration, LinearAcceleration, LinearAcceleration) - Constructor for record class com.studica.frc.Navx.Acceleration3d
-
Creates an instance of a
Acceleration3drecord class. - accelX() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
accelXrecord component. - accelY() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
accelYrecord component. - accelZ() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
accelZrecord component. - addColor(String, Colore.Chromaticity) - Method in class com.studica.frc.Colore
-
Adds (or replaces) a colour to match against, e.g.
- ALGORITHM_STATE - Enum constant in enum class com.studica.frc.Navx.Message
-
Sensor-fusion filter state.
- AlgorithmState(double, double, double, boolean, boolean, double, double, double, double) - Constructor for record class com.studica.frc.Navx.AlgorithmState
-
Creates an instance of a
AlgorithmStaterecord class. - ANGLE - Enum constant in enum class com.studica.frc.Navx.Message
-
Continuous angle, read by
Navx.getAngle(). - ANGLE - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of continuous angle, degrees.
- ANGULAR_VEL - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of angular velocity (3 values: x y z), rad/s.
- ANGULAR_VELOCITY - Enum constant in enum class com.studica.frc.Navx.Message
-
Angular velocity.
- AngularVelocity3d(AngularVelocity, AngularVelocity, AngularVelocity) - Constructor for record class com.studica.frc.Navx.AngularVelocity3d
-
Creates an instance of a
AngularVelocity3drecord class. - AT_REST - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the at-rest flag (0 or 1).
- atRest() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
atRestrecord component.
C
- CAN_ID - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
Stored CAN ID.
- canBitRateSwitch() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
canBitRateSwitchrecord component. - CanBus - Class in com.studica.frc
-
SystemCore CAN bus configuration (ports S0-S4).
- CanBus.Mode - Enum Class in com.studica.frc
-
CAN bus modes.
- CanBusJNI - Class in com.studica.frc.jni
-
Raw JNI bindings for CAN bus configuration.
- canFd() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
canFdrecord component. - canId() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
canIdrecord component. - Chromaticity(double, double) - Constructor for record class com.studica.frc.Colore.Chromaticity
-
Creates an instance of a
Chromaticityrecord class. - CLASSIC - Enum constant in enum class com.studica.frc.CanBus.Mode
-
Classic CAN, 1 Mbit/s.
- CLASSIC - Static variable in class com.studica.frc.jni.CanBusJNI
-
Classic CAN.
- clearColors() - Method in class com.studica.frc.Colore
-
Forgets every learned colour.
- close() - Method in class com.studica.frc.Colore
-
Closes the device.
- close() - Method in class com.studica.frc.Navx
- close() - Method in class com.studica.frc.Parsec
-
Closes the device.
- COLOR_FORMAT - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
Colour output format.
- COLOR_SIZE - Static variable in class com.studica.frc.jni.ColoreJNI
-
Minimum length of the array passed to getColor().
- Colore - Class in com.studica.frc
-
Studica Colore colour sensor, over CAN or USB.
- Colore(int) - Constructor for class com.studica.frc.Colore
-
Opens a Colore on CAN bus S0.
- Colore(int, CANPort) - Constructor for class com.studica.frc.Colore
-
Opens a Colore on CAN.
- Colore.Chromaticity - Record Class in com.studica.frc
-
CIE 1931 chromaticity: colour with brightness removed.
- Colore.ConfigItem - Enum Class in com.studica.frc
-
Values readable with
Colore.getConfigValue(ConfigItem). - Colore.Match - Record Class in com.studica.frc
-
The learned colour closest to a reading; see
Colore.learnColor(String). - Colore.MeasureMode - Enum Class in com.studica.frc
-
How the Colore compensates for the distance to the target.
- Colore.Reading - Record Class in com.studica.frc
-
One reading, in CIE 1931 XYZ.
- ColoreJNI - Class in com.studica.frc.jni
-
Raw JNI bindings for the Colore driver.
- com.studica.frc - package com.studica.frc
- com.studica.frc.jni - package com.studica.frc.jni
- COMPASS - Enum constant in enum class com.studica.frc.Navx.Message
-
Magnetometer.
- confidence() - Method in record class com.studica.frc.Colore.Match
-
Returns the value of the
confidencerecord component. - Config(int, boolean, boolean, boolean, int, OptionalLong, Optional, OptionalInt, OptionalInt) - Constructor for record class com.studica.frc.Parsec.Config
-
Creates an instance of a
Configrecord class. - CONFIG_CAN_BRS - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the CAN FD bit-rate-switch flag (0 or 1).
- CONFIG_CAN_FD - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the CAN FD flag (0 or 1).
- CONFIG_CAN_ID - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the configured CAN ID.
- CONFIG_DISTANCE_ENABLED - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the distance-enabled flag (0 or 1).
- CONFIG_FIRMWARE - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the firmware version as (major << 16 | minor << 8 | patch), or -1.
- CONFIG_HAS_ZONE_MASK - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the flag saying whether the zone mask is present (0 or 1).
- CONFIG_OUTPUT_RATE - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the output rate in Hz, or 0 if not reported.
- CONFIG_SIZE - Static variable in class com.studica.frc.jni.ParsecJNI
-
Minimum length of the array passed to getConfig().
- CONFIG_VERSION - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the configuration version.
- CONFIG_ZONE_MASK - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the enabled-zone mask.
- CONFIG_ZONES - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the zone count, or 0 if not reported.
- createCan(int, int) - Static method in class com.studica.frc.jni.ColoreJNI
-
Opens a Colore on CAN.
- createCan(int, int) - Static method in class com.studica.frc.jni.ParsecJNI
-
Opens a Parsec on CAN.
- createCan(int, int, int) - Static method in class com.studica.frc.jni.NavxJNI
-
Opens a NavX3 on CAN.
- createSerial(String) - Static method in class com.studica.frc.jni.ColoreJNI
-
Opens a Colore on a serial device path.
- createSerial(String) - Static method in class com.studica.frc.jni.ParsecJNI
-
Opens a Parsec on a serial device path.
- createSerial(String, int) - Static method in class com.studica.frc.jni.NavxJNI
-
Opens a NavX3 on a serial device path.
- createUsb(int) - Static method in class com.studica.frc.jni.ColoreJNI
-
Opens a Colore on USB.
- createUsb(int) - Static method in class com.studica.frc.jni.ParsecJNI
-
Opens a Parsec on USB.
- createUsb(int, int) - Static method in class com.studica.frc.jni.NavxJNI
-
Opens a NavX3 on USB.
D
- DATA_SIZE - Static variable in class com.studica.frc.jni.NavxJNI
-
Minimum length of the array passed to getData().
- destroy(int) - Static method in class com.studica.frc.jni.ColoreJNI
-
Closes a device.
- destroy(int) - Static method in class com.studica.frc.jni.NavxJNI
-
Closes a device.
- destroy(int) - Static method in class com.studica.frc.jni.ParsecJNI
-
Closes a device.
- DEVICE_ERROR - Enum constant in enum class com.studica.frc.Status
-
The device answered but reported a failure.
- distance() - Method in record class com.studica.frc.Colore.Match
-
Returns the value of the
distancerecord component. - distanceEnabled() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
distanceEnabledrecord component. - distanceTo(Colore.Chromaticity) - Method in record class com.studica.frc.Colore.Reading
-
Returns the distance in chromaticity space to a reference colour; smaller is a closer match.
E
- enableMessages(int, int) - Static method in class com.studica.frc.jni.NavxJNI
-
Chooses which message groups stream.
- enableMessages(Navx.Message...) - Method in class com.studica.frc.Navx
-
Chooses which message groups stream.
- equals(Object) - Method in record class com.studica.frc.Colore.Chromaticity
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Colore.Match
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Colore.Reading
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.FirmwareVersion
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Navx.Acceleration3d
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Navx.AlgorithmState
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Navx.AngularVelocity3d
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Navx.MagneticField
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Navx.SelfTestResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.studica.frc.Parsec.Config
-
Indicates whether some other object is "equal to" this one.
F
- FD_5MBPS - Enum constant in enum class com.studica.frc.CanBus.Mode
-
CAN FD: 1 Mbit/s arbitration, 5 Mbit/s data phase.
- FD_5MBPS - Static variable in class com.studica.frc.jni.CanBusJNI
-
CAN FD, 5 Mbit/s data phase.
- firmware() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
firmwarerecord component. - FIRMWARE_VERSION - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
Firmware version, major << 16 | minor << 8 | patch.
- FirmwareVersion - Record Class in com.studica.frc
-
A device's firmware version.
- FirmwareVersion(int, int, int) - Constructor for record class com.studica.frc.FirmwareVersion
-
Creates an instance of a
FirmwareVersionrecord class. - FIXED - Enum constant in enum class com.studica.frc.Colore.MeasureMode
-
Uses a fixed distance you give it.
- forceLoad() - Static method in class com.studica.frc.jni.StudicaJNIWrapper
-
Force load the library.
- fromSerialDevice(String) - Static method in class com.studica.frc.Colore
-
Opens a Colore on an explicit serial device.
- fromSerialDevice(String) - Static method in class com.studica.frc.Parsec
-
Opens a Parsec on an explicit serial device.
- fromSerialDevice(String, int) - Static method in class com.studica.frc.Navx
-
Opens a NavX3 on an explicit serial device.
G
- getAlgorithmState() - Method in class com.studica.frc.Navx
-
Gets the sensor-fusion filter state, for diagnosing calibration.
- getAngle() - Method in class com.studica.frc.Navx
-
Gets the continuous heading, which does not wrap at +/-180 degrees.
- getAngularVelocity() - Method in class com.studica.frc.Navx
-
Gets the angular velocity.
- getChromaticity() - Method in record class com.studica.frc.Colore.Reading
-
Returns the colour without brightness.
- getClosest() - Method in class com.studica.frc.Parsec.Scan
-
Returns the nearest valid reading in any zone.
- getClosestDistance() - Method in class com.studica.frc.Parsec
-
Returns the nearest object in view: a shortcut for
getScan()thenParsec.Scan.getClosest(). - getColor() - Method in class com.studica.frc.Colore
-
Returns the newest reading.
- getColor(int, double[]) - Static method in class com.studica.frc.jni.ColoreJNI
-
Copies the newest reading.
- getConfig() - Method in class com.studica.frc.Parsec
-
Reads the device configuration.
- getConfig(int, long[]) - Static method in class com.studica.frc.jni.ParsecJNI
-
Reads the device configuration.
- getConfigValue(int, int, long[]) - Static method in class com.studica.frc.jni.ColoreJNI
-
Reads one configuration value.
- getConfigValue(Colore.ConfigItem) - Method in class com.studica.frc.Colore
-
Reads one configuration value from the device.
- getData(int, double[]) - Static method in class com.studica.frc.jni.NavxJNI
-
Fills
out(at least DATA_SIZE long) with the latest data. - getDistance(int) - Method in class com.studica.frc.Parsec.Scan
-
Returns the distance measured in one zone, in row-major order as reported by the sensor.
- getDistance(int, int) - Method in class com.studica.frc.Parsec.Scan
-
Returns the distance measured in one zone of the grid.
- 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.Colore
-
Asks the device for its firmware version.
- getFirmwareVersion() - Method in class com.studica.frc.Navx
-
Asks the device for its firmware version.
- getFirmwareVersion(int, int[]) - Static method in class com.studica.frc.jni.NavxJNI
-
Reads the firmware version.
- getGridSize() - Method in class com.studica.frc.Parsec.Scan
-
Returns the zones per row and column.
- getLinearAcceleration() - Method in class com.studica.frc.Navx
-
Gets the linear acceleration.
- getMagneticField() - Method in class com.studica.frc.Navx
-
Gets the magnetometer reading.
- getMatch() - Method in class com.studica.frc.Colore
-
Returns the learned colour closest to the current reading.
- getMode(int) - Static method in class com.studica.frc.jni.CanBusJNI
-
Reads a bus's current mode.
- getMode(CANPort) - Static method in class com.studica.frc.CanBus
-
Gets a bus's current mode.
- getPitch() - Method in class com.studica.frc.Navx
-
Gets the pitch.
- getQuaternion6d() - Method in class com.studica.frc.Navx
-
Gets the fused gyro + accelerometer orientation.
- getQuaternion9d() - Method in class com.studica.frc.Navx
-
Gets the fused gyro + accelerometer + magnetometer orientation.
- getRawMillimeters() - Method in class com.studica.frc.Parsec.Scan
-
Returns the raw readings.
- getRoll() - Method in class com.studica.frc.Navx
-
Gets the roll.
- getRotation2d() - Method in class com.studica.frc.Navx
-
Gets the heading as a Rotation2d, from
Navx.getYaw(). - getRotation3d() - Method in class com.studica.frc.Navx
-
Gets the orientation as a Rotation3d, from the 6-axis quaternion.
- getScan() - Method in class com.studica.frc.Parsec
-
Returns the newest frame.
- getScan(int, short[], long[]) - Static method in class com.studica.frc.jni.ParsecJNI
-
Copies the newest frame.
- getSensorUuid() - Method in class com.studica.frc.Navx
-
Asks the device for its unique ID.
- getSensorUuid(int, int[]) - Static method in class com.studica.frc.jni.NavxJNI
-
Reads the 96-bit sensor ID.
- getSequence() - Method in class com.studica.frc.Parsec.Scan
-
Returns the frame counter from the device, which increments with each new frame.
- getTemperature() - Method in class com.studica.frc.Navx
-
Gets the gyroscope chip temperature.
- getTimestamp() - Method in class com.studica.frc.Navx
-
Gets when the newest sample was taken, on the same clock as
Timer.getTimestamp(), e.g. - getYaw() - Method in class com.studica.frc.Navx
-
Gets the heading.
- getZoneCount() - Method in class com.studica.frc.Parsec.Scan
-
Returns the number of zones.
- gyro() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
gyrorecord component. - GYRO_BIAS - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the gyro bias estimate (3 values: x y z).
- gyroBiasX() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
gyroBiasXrecord component. - gyroBiasY() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
gyroBiasYrecord component. - gyroBiasZ() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
gyroBiasZrecord component. - gyroX() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
gyroXrecord component. - gyroY() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
gyroYrecord component. - gyroZ() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns the value of the
gyroZrecord component.
H
- hashCode() - Method in record class com.studica.frc.Colore.Chromaticity
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Colore.Match
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Colore.Reading
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.FirmwareVersion
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Navx.Acceleration3d
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Navx.AngularVelocity3d
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Navx.MagneticField
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.studica.frc.Parsec.Config
-
Returns a hash code value for this object.
I
- IN_USE - Enum constant in enum class com.studica.frc.Status
-
Another object already uses this CAN ID or port.
- INFO_SIZE - Static variable in class com.studica.frc.jni.ParsecJNI
-
Minimum length of the info array passed to getScan().
- INVALID_ARGUMENT - Enum constant in enum class com.studica.frc.Status
-
An argument was out of range.
- INVALID_HANDLE - Enum constant in enum class com.studica.frc.Status
-
The device failed to open, or was closed.
- isConnected() - Method in class com.studica.frc.Colore
-
Returns whether data arrived recently.
- isConnected() - Method in class com.studica.frc.Navx
-
Returns whether the device is talking.
- isConnected() - Method in class com.studica.frc.Parsec
-
Returns whether data arrived recently.
- isConnected(int) - Static method in class com.studica.frc.jni.ColoreJNI
-
Returns whether data arrived recently.
- isConnected(int) - Static method in class com.studica.frc.jni.NavxJNI
-
Returns whether data arrived recently.
- isConnected(int) - Static method in class com.studica.frc.jni.ParsecJNI
-
Returns whether data arrived recently.
- isOpen() - Method in class com.studica.frc.Colore
-
Returns whether the device was opened.
- isOpen() - Method in class com.studica.frc.Navx
-
Returns whether the device was opened.
- isOpen() - Method in class com.studica.frc.Parsec
-
Returns whether the device was opened.
- isTimeSynced() - Method in class com.studica.frc.Navx
-
Returns whether
Navx.getTimestamp()is the measurement time.
L
- learnColor(String) - Method in class com.studica.frc.Colore
-
Learns a colour: saves the current reading's chromaticity under
name, replacing any colour already learned with that name. - LED_BRIGHTNESS - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
Illumination LED brightness.
- LINEAR_ACCEL - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of linear acceleration (3 values: x y z), m/s^2.
- LINEAR_ACCELERATION - Enum constant in enum class com.studica.frc.Navx.Message
-
Linear acceleration.
M
- MAG - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the magnetic field (4 values: x y z norm), microtesla.
- MAG_CANDIDATE_DIP - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the candidate magnetic dip angle.
- MAG_CANDIDATE_NORM - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the candidate magnetic field magnitude.
- MAG_REF_DIP - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the reference magnetic dip angle.
- MAG_REF_NORM - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the reference magnetic field magnitude.
- MAG_UNDISTURBED - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the magnetometer-undisturbed flag (0 or 1).
- magCandidateDip() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
magCandidateDiprecord component. - magCandidateNorm() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
magCandidateNormrecord component. - MagneticField(double, double, double, double) - Constructor for record class com.studica.frc.Navx.MagneticField
-
Creates an instance of a
MagneticFieldrecord class. - magRefDip() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
magRefDiprecord component. - magRefNorm() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
magRefNormrecord component. - magUndisturbed() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns the value of the
magUndisturbedrecord component. - major() - Method in record class com.studica.frc.FirmwareVersion
-
Returns the value of the
majorrecord component. - Match(String, double, double) - Constructor for record class com.studica.frc.Colore.Match
-
Creates an instance of a
Matchrecord class. - MAX_ZONES - Static variable in class com.studica.frc.jni.ParsecJNI
-
Largest zone count (8x8 grid).
- MEASURE_MODE - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
Distance compensation flags.
- minor() - Method in record class com.studica.frc.FirmwareVersion
-
Returns the value of the
minorrecord component.
N
- name() - Method in record class com.studica.frc.Colore.Match
-
Returns the value of the
namerecord component. - Navx - Class in com.studica.frc
-
Studica NavX3 IMU over CAN or USB.
- Navx(int) - Constructor for class com.studica.frc.Navx
-
Opens a NavX3 on CAN bus S0 at 100 Hz.
- Navx(int, CANPort) - Constructor for class com.studica.frc.Navx
-
Opens a NavX3 on CAN at 100 Hz.
- Navx(int, CANPort, int) - Constructor for class com.studica.frc.Navx
-
Opens a NavX3 on CAN.
- Navx.Acceleration3d - Record Class in com.studica.frc
-
Linear acceleration along each axis.
- Navx.AlgorithmState - Record Class in com.studica.frc
-
Internal state of the sensor-fusion filter, for diagnosing calibration.
- Navx.AngularVelocity3d - Record Class in com.studica.frc
-
Angular velocity about each axis.
- Navx.MagneticField - Record Class in com.studica.frc
-
Magnetic field in microtesla.
- Navx.Message - Enum Class in com.studica.frc
-
Message groups the NavX3 can stream.
- Navx.SelfTestResult - Record Class in com.studica.frc
-
Raw self-test codes as reported by the IMU.
- NavxJNI - Class in com.studica.frc.jni
-
Raw JNI bindings for the NavX3 driver.
- NO_READING - Static variable in class com.studica.frc.jni.ParsecJNI
-
Distance of a zone without a valid reading.
- norm() - Method in record class com.studica.frc.Navx.MagneticField
-
Returns the value of the
normrecord component.
O
- OFF - Enum constant in enum class com.studica.frc.Colore.MeasureMode
-
No distance compensation.
- OK - Enum constant in enum class com.studica.frc.Status
-
The command succeeded.
- outputRateHz() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
outputRateHzrecord component.
P
- Parsec - Class in com.studica.frc
-
Studica Parsec multi-zone time-of-flight distance sensor, over CAN or USB.
- Parsec(int) - Constructor for class com.studica.frc.Parsec
-
Opens a Parsec on CAN bus S0.
- Parsec(int, CANPort) - Constructor for class com.studica.frc.Parsec
-
Opens a Parsec on CAN.
- Parsec.Config - Record Class in com.studica.frc
-
Parsec configuration, as reported by the device.
- Parsec.Resolution - Enum Class in com.studica.frc
-
Parsec zone grids.
- Parsec.Scan - Class in com.studica.frc
-
One distance frame.
- ParsecJNI - Class in com.studica.frc.jni
-
Raw JNI bindings for the Parsec driver.
- patch() - Method in record class com.studica.frc.FirmwareVersion
-
Returns the value of the
patchrecord component. - PITCH - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of pitch, degrees.
- PITCH_ROLL - Enum constant in enum class com.studica.frc.Navx.Message
-
Pitch and roll.
Q
- QUAT6 - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the 6-axis quaternion (4 values: w x y z).
- QUAT9 - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the 9-axis quaternion (4 values: w x y z).
- QUATERNION_6D - Enum constant in enum class com.studica.frc.Navx.Message
-
6-axis quaternion, also used by
Navx.getRotation3d(). - QUATERNION_9D - Enum constant in enum class com.studica.frc.Navx.Message
-
9-axis quaternion.
R
- Reading(double, double, double, int) - Constructor for record class com.studica.frc.Colore.Reading
-
Creates an instance of a
Readingrecord class. - removeColor(String) - Method in class com.studica.frc.Colore
-
Forgets one learned colour.
- requestMode(int, int, int) - Static method in class com.studica.frc.jni.CanBusJNI
-
Switches a bus to a mode, blocking until it is up in that mode.
- requestMode(CANPort, CanBus.Mode) - Static method in class com.studica.frc.CanBus
-
Switches a bus to a mode, blocking until it is back up in that mode (up to 3 seconds).
- resetYaw() - Method in class com.studica.frc.Navx
-
Resets yaw to zero.
- resetYaw(int) - Static method in class com.studica.frc.jni.NavxJNI
-
Resets yaw to zero.
- ROLL - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of roll, degrees.
S
- SAMPLE_TIME - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
Time per reading, ms.
- selfTest() - Method in class com.studica.frc.Navx
-
Runs the IMU self test.
- selfTest(int, int[]) - Static method in class com.studica.frc.jni.NavxJNI
-
Runs the IMU self test.
- SelfTestResult(int, int, int, int, int, int, int, int) - Constructor for record class com.studica.frc.Navx.SelfTestResult
-
Creates an instance of a
SelfTestResultrecord class. - sequence() - Method in record class com.studica.frc.Colore.Reading
-
Returns the value of the
sequencerecord component. - SEQUENCE - Static variable in class com.studica.frc.jni.ColoreJNI
-
Index of the reading counter.
- SEQUENCE - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the frame counter.
- setExtractOnStaticLoad(boolean) - Static method in class com.studica.frc.jni.StudicaJNIWrapper.Helper
-
Set whether to load the driver on static init.
- setFixedDistance(Distance) - Method in class com.studica.frc.Colore
-
Sets distance compensation to a fixed distance.
- setLedBrightness(int) - Method in class com.studica.frc.Colore
-
Sets the illumination LED brightness.
- setLedBrightness(int, int) - Static method in class com.studica.frc.jni.ColoreJNI
-
Sets the illumination LED brightness.
- setMatchThreshold(double) - Method in class com.studica.frc.Colore
-
Sets the largest chromaticity distance that still counts as a match.
- setMeasureMode(int, int, double) - Static method in class com.studica.frc.jni.ColoreJNI
-
Sets distance compensation.
- setMeasureMode(Colore.MeasureMode) - Method in class com.studica.frc.Colore
-
Sets the distance compensation mode.
- setOutputRate(int) - Method in class com.studica.frc.Navx
-
Sets the output data rate.
- setOutputRate(int) - Method in class com.studica.frc.Parsec
-
Sets how often frames are sent.
- setOutputRate(int, int) - Static method in class com.studica.frc.jni.NavxJNI
-
Sets the output data rate.
- setOutputRate(int, int) - Static method in class com.studica.frc.jni.ParsecJNI
-
Sets how often frames are sent.
- setRangingFrequency(int) - Method in class com.studica.frc.Parsec
-
Sets how often the sensor measures.
- setRangingFrequency(int, int) - Static method in class com.studica.frc.jni.ParsecJNI
-
Sets how often the sensor measures.
- setResolution(int, int) - Static method in class com.studica.frc.jni.ParsecJNI
-
Selects the zone count.
- setResolution(Parsec.Resolution) - Method in class com.studica.frc.Parsec
-
Selects the zone grid.
- setSampleTime(int, int) - Static method in class com.studica.frc.jni.ColoreJNI
-
Sets the time per reading.
- setSampleTime(Time) - Method in class com.studica.frc.Colore
-
Sets the time per reading.
- setStatusLed(boolean, int) - Method in class com.studica.frc.Colore
-
Turns the status LED on or off.
- setStatusLed(int, boolean, int) - Static method in class com.studica.frc.jni.ColoreJNI
-
Turns the status LED on or off.
- setYawAxes(int, int) - Static method in class com.studica.frc.jni.NavxJNI
-
Selects 6-axis or 9-axis yaw.
- setZoneMask(int, long) - Static method in class com.studica.frc.jni.ParsecJNI
-
Chooses which zones are measured.
- setZoneMask(long) - Method in class com.studica.frc.Parsec
-
Chooses which zones are measured: bit i enables zone i, counting row-major as
Parsec.Scan.getDistance(int)does. - Status - Enum Class in com.studica.frc
-
Result of a StudicaLib command.
- STATUS_LED - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
Status LED settings, packed.
- StudicaJNIWrapper - Class in com.studica.frc.jni
-
Loads the StudicaLib driver library.
- StudicaJNIWrapper() - Constructor for class com.studica.frc.jni.StudicaJNIWrapper
-
Only device bindings extend this.
- StudicaJNIWrapper.Helper - Class in com.studica.frc.jni
-
Helper class for determining whether or not to load the driver on static initialization.
T
- TEMPERATURE - Enum constant in enum class com.studica.frc.Navx.Message
-
Gyroscope temperature.
- TEMPERATURE - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the temperature, Celsius.
- TIME_SYNCED - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of 1 if TIMESTAMP_NS is the measurement time, else 0.
- TIMEOUT - Enum constant in enum class com.studica.frc.Status
-
The device or service did not answer in time.
- TIMESTAMP_NS - Static variable in class com.studica.frc.jni.ColoreJNI
-
Index of the monotonic arrival time, nanoseconds.
- TIMESTAMP_NS - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of the newest sample's robot time, nanoseconds (see STUDICA_NavxData).
- TIMESTAMP_NS - Static variable in class com.studica.frc.jni.ParsecJNI
-
Index of the monotonic arrival time, nanoseconds.
- toColor() - Method in record class com.studica.frc.Colore.Reading
-
Converts to sRGB, each channel clamped to [0, 1], e.g.
- toString() - Method in record class com.studica.frc.Colore.Chromaticity
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Colore.Match
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Colore.Reading
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.FirmwareVersion
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Navx.Acceleration3d
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Navx.AlgorithmState
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Navx.AngularVelocity3d
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Navx.MagneticField
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Navx.SelfTestResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.studica.frc.Parsec.Config
-
Returns a string representation of this record class.
- TRANSPORT_ERROR - Enum constant in enum class com.studica.frc.Status
-
The CAN bus or serial port could not be opened, written, or configured.
U
- UNKNOWN - Static variable in class com.studica.frc.jni.CanBusJNI
-
Mode not reported yet, or a non-standard mode.
- UNSUPPORTED - Enum constant in enum class com.studica.frc.Status
-
Not available over this connection (e.g.
- usb() - Static method in class com.studica.frc.Colore
-
Opens the Colore plugged into any USB port.
- usb() - Static method in class com.studica.frc.Navx
-
Opens the NavX3 plugged into any USB port, at 100 Hz.
- usb() - Static method in class com.studica.frc.Parsec
-
Opens the Parsec plugged into any USB port.
- usb(int) - Static method in class com.studica.frc.Navx
-
Opens the NavX3 plugged into any USB port.
- usb(UsbPort) - Static method in class com.studica.frc.Colore
-
Opens the Colore in a specific SystemCore USB port.
- usb(UsbPort) - Static method in class com.studica.frc.Navx
-
Opens the NavX3 in a specific SystemCore USB port, at 100 Hz.
- usb(UsbPort) - Static method in class com.studica.frc.Parsec
-
Opens the Parsec in a specific SystemCore USB port.
- usb(UsbPort, int) - Static method in class com.studica.frc.Navx
-
Opens the NavX3 in a specific SystemCore USB port.
- USB_ANY - Static variable in class com.studica.frc.jni.ColoreJNI
-
For createUsb: the Colore on any USB port.
- USB_ANY - Static variable in class com.studica.frc.jni.NavxJNI
-
For createUsb: the NavX3 on any USB port.
- USB_ANY - Static variable in class com.studica.frc.jni.ParsecJNI
-
For createUsb: the Parsec on any USB port.
- USB_OVERRIDE - Enum constant in enum class com.studica.frc.Colore.ConfigItem
-
USB output override.
- USB0 - Enum constant in enum class com.studica.frc.UsbPort
-
USB port 0.
- USB1 - Enum constant in enum class com.studica.frc.UsbPort
-
USB port 1.
- USB2 - Enum constant in enum class com.studica.frc.UsbPort
-
USB port 2.
- USB3 - Enum constant in enum class com.studica.frc.UsbPort
-
USB port 3.
- UsbPort - Enum Class in com.studica.frc
-
SystemCore USB ports, by the label printed on the controller.
- use9AxisYaw(boolean) - Method in class com.studica.frc.Navx
-
Chooses whether the yaw estimate uses the magnetometer.
V
- valueOf(String) - Static method in enum class com.studica.frc.CanBus.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.studica.frc.Colore.ConfigItem
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.studica.frc.Colore.MeasureMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.studica.frc.Navx.Message
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.studica.frc.Parsec.Resolution
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.studica.frc.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.studica.frc.UsbPort
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.studica.frc.CanBus.Mode
-
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.Colore.ConfigItem
-
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.Colore.MeasureMode
-
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.Navx.Message
-
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.Parsec.Resolution
-
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.Status
-
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.UsbPort
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
versionrecord component.
X
- x() - Method in record class com.studica.frc.Colore.Chromaticity
-
Returns the value of the
xrecord component. - x() - Method in record class com.studica.frc.Colore.Reading
-
Returns the value of the
xrecord component. - x() - Method in record class com.studica.frc.Navx.Acceleration3d
-
Returns the value of the
xrecord component. - x() - Method in record class com.studica.frc.Navx.AngularVelocity3d
-
Returns the value of the
xrecord component. - x() - Method in record class com.studica.frc.Navx.MagneticField
-
Returns the value of the
xrecord component. - X - Static variable in class com.studica.frc.jni.ColoreJNI
-
Index of CIE X.
Y
- y() - Method in record class com.studica.frc.Colore.Chromaticity
-
Returns the value of the
yrecord component. - y() - Method in record class com.studica.frc.Colore.Reading
-
Returns the value of the
yrecord component. - y() - Method in record class com.studica.frc.Navx.Acceleration3d
-
Returns the value of the
yrecord component. - y() - Method in record class com.studica.frc.Navx.AngularVelocity3d
-
Returns the value of the
yrecord component. - y() - Method in record class com.studica.frc.Navx.MagneticField
-
Returns the value of the
yrecord component. - Y - Static variable in class com.studica.frc.jni.ColoreJNI
-
Index of CIE Y.
- YAW - Enum constant in enum class com.studica.frc.Navx.Message
-
Yaw, read by
Navx.getYaw()andNavx.getRotation2d(). - YAW - Static variable in class com.studica.frc.jni.NavxJNI
-
Index of yaw, degrees.
Z
- z() - Method in record class com.studica.frc.Colore.Reading
-
Returns the value of the
zrecord component. - z() - Method in record class com.studica.frc.Navx.Acceleration3d
-
Returns the value of the
zrecord component. - z() - Method in record class com.studica.frc.Navx.AngularVelocity3d
-
Returns the value of the
zrecord component. - z() - Method in record class com.studica.frc.Navx.MagneticField
-
Returns the value of the
zrecord component. - Z - Static variable in class com.studica.frc.jni.ColoreJNI
-
Index of CIE Z.
- zoneMask() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
zoneMaskrecord component. - zones() - Method in record class com.studica.frc.Parsec.Config
-
Returns the value of the
zonesrecord component. - ZONES_4X4 - Enum constant in enum class com.studica.frc.Parsec.Resolution
-
16 zones.
- ZONES_8X8 - Enum constant in enum class com.studica.frc.Parsec.Resolution
-
64 zones.
All Classes and Interfaces|All Packages|Constant Field Values