Index

A B C D E F G H I K L M O P Q R S T U V W Y Z 
All Classes and Interfaces|All Packages|Constant Field Values

A

absPosition - Variable in class com.reduxrobotics.sensors.canandmag.Canandmag
internal Frame variable holding current absolute position state
accel - Variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Linear acceleration frame (gravitational unit Gs)
accelerationSaturation() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the acceleration flag which will raise if acceleration has been sensed to saturate (potentially degrading accuracy.)
activeFaults() - Method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Returns the value of the activeFaults record component.
activeFaults() - Method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Returns the value of the activeFaults record component.
addCallback(Frame.FrameCallback<T>) - Method in class com.reduxrobotics.frames.Frame
Add a callback that will be run whenever this Frame gets updated.
addListener(CanandDevice) - Method in class com.reduxrobotics.canand.CanandEventLoop
Adds a listener for CAN messages to the event loop.
allSettingsReceived() - Method in class com.reduxrobotics.canand.CanandSettings
Returns whether or not all settings fields have been written into the object.
angularVelocitySaturation() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the angular velocity saturation flag which will raise if angular velocity has been sensed to saturate (potentially degrading accuracy.)

B

bsToLong(BitSet) - Static method in class com.reduxrobotics.canand.CanandUtils
Shorthand for BitSet.toLongArray()[0], except zero length bitsets return 0.
byDescriptor(byte) - Static method in class com.reduxrobotics.canand.CANBus
Returns a CANBus object corresponding to a specific bus descriptor value.
ByteArrayFrame<T> - Class in com.reduxrobotics.frames
Implements an object-holding Frame backed by a byte array.
ByteArrayFrame(int, double, T, ByteArrayFrame.ByteArrayToType<T>) - Constructor for class com.reduxrobotics.frames.ByteArrayFrame
Instantiates a new ByteArrayFrame.
ByteArrayFrame.ByteArrayToType<T> - Interface in com.reduxrobotics.frames
Functional interface for a function mapping a double data value to the final frame type.
bytesToLong(byte[]) - Static method in class com.reduxrobotics.canand.CanandUtils
Convert bytes to long without allocating new bytebuffers.

C

calibrating - Variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Calibrating state
calibrating() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the calibrating flag, which will raise if the device is currently calibrating.
callback(Frame<FC>) - Method in interface com.reduxrobotics.frames.Frame.FrameCallback
The callback called.
CanandAddress - Class in com.reduxrobotics.canand
Class representing the exact combination of CAN bus, product IDs, and device IDs that uniquely correspond to a Redux CAN device on a robot.
CanandAddress(int, int) - Constructor for class com.reduxrobotics.canand.CanandAddress
Constructor with implicit Rio CAN bus.
CanandAddress(CANBus, int, int) - Constructor for class com.reduxrobotics.canand.CanandAddress
Constructor with explicit CAN bus.
CanandDevice - Class in com.reduxrobotics.canand
Base class for Redux CAN devices.
CanandDevice() - Constructor for class com.reduxrobotics.canand.CanandDevice
Default constructor that just adds the device to the incoming CAN message listener.
CanandDeviceDetails - Class in com.reduxrobotics.canand
CanandDevice device constants.
CanandDeviceDetails.Bitsets - Class in com.reduxrobotics.canand
Cananddevice bitsets.
CanandDeviceDetails.Enums - Class in com.reduxrobotics.canand
Cananddevice enums.
CanandDeviceDetails.Enums.SettingCommand - Class in com.reduxrobotics.canand
enum CanandDevice::SETTING_COMMAND.
CanandDeviceDetails.Msg - Class in com.reduxrobotics.canand
Messages.
CanandDeviceDetails.Stg - Class in com.reduxrobotics.canand
Settings.
CanandEventLoop - Class in com.reduxrobotics.canand
Class that runs the CAN packet ingest loop, and starts the CANLink interface.
CanandFirmwareVersion - Record Class in com.reduxrobotics.canand
Represents a firmware version associated with a Redux product.
CanandFirmwareVersion(int, int, int) - Constructor for record class com.reduxrobotics.canand.CanandFirmwareVersion
Creates an instance of a CanandFirmwareVersion record class.
CanandFirmwareVersion(long) - Constructor for record class com.reduxrobotics.canand.CanandFirmwareVersion
Returns a new CanandFirmwareVersion generated from setting data.
Canandgyro - Class in com.reduxrobotics.sensors.canandgyro
Class for the CAN interface of the Canandgyro.
Canandgyro(int) - Constructor for class com.reduxrobotics.sensors.canandgyro.Canandgyro
Instantiates a new Canandgyro.
Canandgyro.Faults - Class in com.reduxrobotics.sensors.canandgyro
A class to hold device faults for the Canandgyro, as returned by Canandgyro.getStickyFaults() and Canandgyro.getActiveFaults().
Canandgyro.Settings - Class in com.reduxrobotics.sensors.canandgyro
The settings class for the Canandgyro.
Canandgyro.Status - Record Class in com.reduxrobotics.sensors.canandgyro
Container record class representing a Canandgyro's status.
CanandgyroDetails - Class in com.reduxrobotics.sensors.canandgyro
Canandgyro device constants.
CanandgyroDetails.Bitsets - Class in com.reduxrobotics.sensors.canandgyro
Canandgyro bitsets.
CanandgyroDetails.Enums - Class in com.reduxrobotics.sensors.canandgyro
Canandgyro enums.
CanandgyroDetails.Enums.CalibrationType - Class in com.reduxrobotics.sensors.canandgyro
enum Canandgyro::CALIBRATION_TYPE.
CanandgyroDetails.Enums.SettingCommand - Class in com.reduxrobotics.sensors.canandgyro
enum Canandgyro::SETTING_COMMAND.
CanandgyroDetails.Msg - Class in com.reduxrobotics.sensors.canandgyro
Messages.
CanandgyroDetails.Stg - Class in com.reduxrobotics.sensors.canandgyro
Settings.
CanandgyroFaultsStruct - Class in com.reduxrobotics.sensors.canandgyro.wpistruct
WPILib struct implementation for Canandgyro.Faults
CanandgyroFaultsStruct() - Constructor for class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroFaultsStruct
 
CanandgyroStatusStruct - Class in com.reduxrobotics.sensors.canandgyro.wpistruct
WPILib struct implementation for Canandgyro.Status
CanandgyroStatusStruct() - Constructor for class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
Canandmag - Class in com.reduxrobotics.sensors.canandmag
Class for the CAN interface of the Canandmag.
Canandmag(int) - Constructor for class com.reduxrobotics.sensors.canandmag.Canandmag
Instantiates a new Canandmag object.
Canandmag.Faults - Class in com.reduxrobotics.sensors.canandmag
A class to hold device faults for the Canandmag.
Canandmag.Settings - Class in com.reduxrobotics.sensors.canandmag
The settings class for the Canandmag.
Canandmag.Status - Record Class in com.reduxrobotics.sensors.canandmag
Container record class representing a Canandmag's status.
CanandmagDetails - Class in com.reduxrobotics.sensors.canandmag
Contains all the constants used by the Canandmag and related classes (as to not pollute their public namespaces)
CanandmagFaultsStruct - Class in com.reduxrobotics.sensors.canandmag.wpistruct
WPILib struct implementation for Canandmag.Faults
CanandmagFaultsStruct() - Constructor for class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagFaultsStruct
 
CanandmagStatusStruct - Class in com.reduxrobotics.sensors.canandmag.wpistruct
WPILib struct implementation for Canandmag.Status
CanandmagStatusStruct() - Constructor for class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
CanandMessage - Class in com.reduxrobotics.canand
Class that represents a CAN message received from the Redux CanandEventLoop This class is generally (re)initialized by CanandMessage.updateFromByteBuf(java.nio.ByteBuffer) with a ByteBuffer from the JNI via CanandEventLoop.
CanandMessage() - Constructor for class com.reduxrobotics.canand.CanandMessage
Construct a new CanandMessage from nothing (to be filled in later.)
CanandMessage(CanandMessage) - Constructor for class com.reduxrobotics.canand.CanandMessage
Copy constructor
CanandSettings - Class in com.reduxrobotics.canand
Base (simple) settings class for Redux devices.
CanandSettings() - Constructor for class com.reduxrobotics.canand.CanandSettings
Default constructor.
CanandSettings(CanandSettings) - Constructor for class com.reduxrobotics.canand.CanandSettings
Clone constructor.
CanandSettingsManager<T extends CanandSettings> - Class in com.reduxrobotics.canand
Common logic for settings management for CanandDevices.
CanandSettingsManager(CanandDevice, CanandSettingsManager.CanandSettingsCtor<T>) - Constructor for class com.reduxrobotics.canand.CanandSettingsManager
Construct a new CanandSettingsManager.
CanandSettingsManager.CanandSettingsCtor<T extends CanandSettings> - Interface in com.reduxrobotics.canand
Functional interface for a CanandSettings constructor.
CanandSettingsManager.ResultCode - Enum Class in com.reduxrobotics.canand
Setting result codes.
CanandSettingsManager.SettingResult - Record Class in com.reduxrobotics.canand
Record of setting results.
CanandUtils - Class in com.reduxrobotics.canand
Series of utility functions for CAN messaging and bit manipulation.
CanandUtils() - Constructor for class com.reduxrobotics.canand.CanandUtils
 
CANBus - Class in com.reduxrobotics.canand
Class representing CAN buses that may exist on a robot.
canGeneralError() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the CAN general error flag, which will raise if the device has encountered a bus fault.
canGeneralError() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the CAN general error flag, which will raise if the encoder cannot RX packets reliably.
canIDConflict() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the CAN ID conflict flag, which is set to true if there is a CAN id conflict.
canIDConflict() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the CAN ID conflict flag, which is set to true if there is a CAN id conflict.
checkBounds(String, double, int, int, double) - Static method in class com.reduxrobotics.canand.CanandSettings
Check bounds for an input double that is mapped to some integer type underneath.
checkReceivedFirmwareVersion() - Method in class com.reduxrobotics.canand.CanandDevice
Checks the received firmware version.
clearData() - Method in class com.reduxrobotics.frames.ByteArrayFrame
Flag that this frame's data is not valid.
clearData() - Method in class com.reduxrobotics.frames.DoubleFrame
Flag that this frame's data is not valid.
clearData() - Method in class com.reduxrobotics.frames.LongFrame
Flag that this frame's data is not valid.
clearData() - Method in class com.reduxrobotics.frames.ShortArrayFrame
Flag that this frame's data is not valid.
clearData() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Flag that this frame's data is not valid.
clearData() - Method in class com.reduxrobotics.sensors.canandgyro.Vec3Frame
Flag that this frame's data is not valid.
clearMessageBuffer() - Static method in class com.reduxrobotics.canand.TransmitDeferrer
Clears the internal message buffer.
clearStickyFaults() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Clears sticky faults.
clearStickyFaults() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Clears sticky faults.
close() - Method in class com.reduxrobotics.canand.CanandDevice
 
com.reduxrobotics.canand - package com.reduxrobotics.canand
Package holding base and utility classes for all CAN-based Redux Robotics devices
com.reduxrobotics.frames - package com.reduxrobotics.frames
Package holding base and utility classes for device data frames
com.reduxrobotics.sensors.canandgyro - package com.reduxrobotics.sensors.canandgyro
Package that holds all classes relating to the Canandgyro IMU.
com.reduxrobotics.sensors.canandgyro.wpistruct - package com.reduxrobotics.sensors.canandgyro.wpistruct
Package that holds WPILib struct classes for the Canandgyro.
com.reduxrobotics.sensors.canandmag - package com.reduxrobotics.sensors.canandmag
Package that holds all classes relating to the Canandmag
com.reduxrobotics.sensors.canandmag.wpistruct - package com.reduxrobotics.sensors.canandmag.wpistruct
Package that holds WPILib struct classes for the Canandmag.
compareTo(CanandFirmwareVersion) - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
 
confirmSetSetting(int, long, double, int) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Potentially blocking operation to send a setting and wait for a report setting message to be received to confirm the operation.
construct() - Method in interface com.reduxrobotics.canand.CanandSettingsManager.CanandSettingsCtor
Constructor function.
constructAccelerationFramePeriod(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a ACCELERATION_FRAME_PERIOD setting.
constructAccelerationOutput(int, int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a ACCELERATION_OUTPUT message.
constructAngularPositionFramePeriod(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a ANGULAR_POSITION_FRAME_PERIOD setting.
constructAngularPositionOutput(int, int, int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a ANGULAR_POSITION_OUTPUT message.
constructAngularVelocityFramePeriod(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a ANGULAR_VELOCITY_FRAME_PERIOD setting.
constructAngularVelocityOutput(int, int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a ANGULAR_VELOCITY_OUTPUT message.
constructCalibrate(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a CALIBRATE message.
constructCalibrationStatus() - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a CALIBRATION_STATUS message.
constructClearStickyFaults() - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Constructs a CLEAR_STICKY_FAULTS message.
constructClearStickyFaults() - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a CLEAR_STICKY_FAULTS message.
constructDeviceType(int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Constructs a DEVICE_TYPE setting.
constructDeviceType(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a DEVICE_TYPE setting.
constructEnumerate(long, boolean) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Constructs a ENUMERATE message.
constructEnumerate(long, boolean) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a ENUMERATE message.
constructFaults(boolean, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Constructs a faults bitset.
constructFirmwareVersion(int, int, int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Constructs a FIRMWARE_VERSION setting.
constructFirmwareVersion(int, int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a FIRMWARE_VERSION setting.
constructMessageId(int, int, int, int) - Static method in class com.reduxrobotics.canand.CanandUtils
Construct a CAN message id to send to a Redux device.
constructPartyMode(int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Constructs a PARTY_MODE message.
constructPartyMode(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a PARTY_MODE message.
constructReportSetting(int, long, int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Constructs a REPORT_SETTING message.
constructReportSetting(int, long, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a REPORT_SETTING message.
constructSerialNumber(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Constructs a SERIAL_NUMBER setting.
constructSerialNumber(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a SERIAL_NUMBER setting.
constructSetPoseNegativeW(int, int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a SET_POSE_NEGATIVE_W setting.
constructSetPosePositiveW(int, int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a SET_POSE_POSITIVE_W setting.
constructSetSetting(int, long, boolean, boolean, int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Constructs a SET_SETTING message.
constructSetSetting(int, long, boolean, boolean, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a SET_SETTING message.
constructSettingCommand(int, int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Constructs a SETTING_COMMAND message.
constructSettingCommand(int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a SETTING_COMMAND message.
constructSettingReportFlags(boolean, boolean) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Bitsets
Constructs a setting_report_flags bitset.
constructSettingReportFlags(boolean, boolean) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Constructs a setting_report_flags bitset.
constructSetYaw(float, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a SET_YAW setting.
constructStatus(int, int, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a STATUS message.
constructStatus(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Constructs a STATUS message.
constructStatusFramePeriod(int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Constructs a STATUS_FRAME_PERIOD setting.
constructStatusFramePeriod(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a STATUS_FRAME_PERIOD setting.
constructYawFramePeriod(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Constructs a YAW_FRAME_PERIOD setting.
constructYawOutput(float, int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Constructs a YAW_OUTPUT message.
convert(byte[]) - Method in interface com.reduxrobotics.frames.ByteArrayFrame.ByteArrayToType
Converison function from byte[] to the type parameter.
convert(double) - Method in interface com.reduxrobotics.frames.DoubleFrame.DoubleToType
Converison function from double to the type parameter.
convert(long) - Method in interface com.reduxrobotics.frames.LongFrame.LongToType
Converison function from long to the type parameter.
convert(short[]) - Method in interface com.reduxrobotics.frames.ShortArrayFrame.ShortArrayToType
Converison function from byte[] to the type parameter.
CooldownWarning - Class in com.reduxrobotics.canand
Class that yells at the user if CooldownWarning.feed() is called too often in too short a succession.
CooldownWarning(String, double, int) - Constructor for class com.reduxrobotics.canand.CooldownWarning
Constructor.

D

deferTransmit(Runnable) - Static method in class com.reduxrobotics.canand.TransmitDeferrer
Batches Redux device messages writes in the passed Runnable into a single JNI-passing call.
DoubleFrame<T> - Class in com.reduxrobotics.frames
Implements an object-holding Frame backed by a double.
DoubleFrame(double, double, T, DoubleFrame.DoubleToType<T>) - Constructor for class com.reduxrobotics.frames.DoubleFrame
Instantiates a new DoubleFrame.
DoubleFrame.DoubleToType<T> - Interface in com.reduxrobotics.frames
Functional interface for a function mapping a double data value to the final frame type.
DRIVER_MAJOR_VERSION - Static variable in class com.reduxrobotics.canand.ReduxJNI
Supported driver major version
DRIVER_MINOR_VERSION - Static variable in class com.reduxrobotics.canand.ReduxJNI
Supported driver minor version
DRIVER_YEAR - Static variable in class com.reduxrobotics.canand.ReduxJNI
Supported driver year

E

ephemeral - Variable in class com.reduxrobotics.canand.CanandSettings
Whether the settings will be applied ephemerally.
equals(Object) - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.reduxrobotics.canand.CANBus
Returns whether two CANBus objects refer to the same bus.
equals(Object) - Method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Indicates whether some other object is "equal to" this one.
extractAccelerationFramePeriod(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Acceleration frame period (ms) from AccelerationFramePeriod.
extractAccelerationOutput_X(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts X-axis acceleration from AccelerationOutput.
extractAccelerationOutput_Y(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Y-axis acceleration from AccelerationOutput.
extractAccelerationOutput_Z(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Z-axis acceleration from AccelerationOutput.
extractAngularPositionFramePeriod(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Angular position frame period (ms) from AngularPositionFramePeriod.
extractAngularPositionOutput_W(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Quaternion w term from AngularPositionOutput.
extractAngularPositionOutput_X(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Quaternion x term from AngularPositionOutput.
extractAngularPositionOutput_Y(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Quaternion y term from AngularPositionOutput.
extractAngularPositionOutput_Z(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Quaternion z term from AngularPositionOutput.
extractAngularVelocityFramePeriod(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Angular velocity frame period (ms) from AngularVelocityFramePeriod.
extractAngularVelocityOutput_Pitch(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Pitch velocity from AngularVelocityOutput.
extractAngularVelocityOutput_Roll(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Roll velocity from AngularVelocityOutput.
extractAngularVelocityOutput_Yaw(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Yaw velocity from AngularVelocityOutput.
extractCalibrate_CalibrationType(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Calibration type from Calibrate.
extractDeviceType(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Extracts Device-specific type identifier from DeviceType.
extractDeviceType(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Device-specific type identifier from DeviceType.
extractEnumerate_IsBootloader(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Device is in bootloader.
extractEnumerate_IsBootloader(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Device is in bootloader.
extractEnumerate_Serial(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Device-unique serial number from Enumerate.
extractEnumerate_Serial(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Device-unique serial number from Enumerate.
extractFaults_AccelerationSaturation(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts acceleration_saturation from faults.
extractFaults_AngularVelocitySaturation(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts angular_velocity_saturation from faults.
extractFaults_Calibrating(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts calibrating from faults.
extractFaults_CanGeneralError(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts can_general_error from faults.
extractFaults_CanIdConflict(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts can_id_conflict from faults.
extractFaults_HardwareFault(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts hardware_fault from faults.
extractFaults_OutOfTemperatureRange(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts out_of_temperature_range from faults.
extractFaults_PowerCycle(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts power_cycle from faults.
extractFirmwareVersion_FirmwareMinor(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Extracts Firmware version minor number from FirmwareVersion.
extractFirmwareVersion_FirmwareMinor(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Firmware version minor number from FirmwareVersion.
extractFirmwareVersion_FirmwarePatch(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Extracts Firmware version patch number from FirmwareVersion.
extractFirmwareVersion_FirmwarePatch(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Firmware version patch number from FirmwareVersion.
extractFirmwareVersion_FirmwareYear(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Extracts Firmware version year from FirmwareVersion.
extractFirmwareVersion_FirmwareYear(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Firmware version year from FirmwareVersion.
extractFloat(byte[], int) - Static method in class com.reduxrobotics.canand.CanandUtils
Extracts a float from a byte array.
extractFloatFromGuineaFloat24(long) - Static method in class com.reduxrobotics.canand.CanandUtils
Convert a 24-bit float in a long field to a 32-bit float.
extractLong(byte[], int, int, boolean) - Static method in class com.reduxrobotics.canand.CanandUtils
More scope-limited long-extracting helper that only works on up to 8-length byte arrays.
extractLong(BitSet, int, int, boolean) - Static method in class com.reduxrobotics.canand.CanandUtils
Extracts a long from a BitSet, optionally sign-extending the output.
extractPartyMode_PartyLevel(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Party level.
extractPartyMode_PartyLevel(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Party level.
extractReportSetting_Address(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Setting index to write to from ReportSetting.
extractReportSetting_Address(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Setting index to write to from ReportSetting.
extractReportSetting_Flags(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Setting receive status from ReportSetting.
extractReportSetting_Flags(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Setting receive status from ReportSetting.
extractReportSetting_Value(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts 6-byte setting value from ReportSetting.
extractReportSetting_Value(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts 6-byte setting value from ReportSetting.
extractSerialNumber(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Extracts Serial number from SerialNumber.
extractSerialNumber(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Serial number from SerialNumber.
extractSetPoseNegativeW_X(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Quaternion x term from SetPoseNegativeW.
extractSetPoseNegativeW_Y(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Quaternion y term from SetPoseNegativeW.
extractSetPoseNegativeW_Z(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Quaternion z term from SetPoseNegativeW.
extractSetPosePositiveW_X(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Quaternion x term from SetPosePositiveW.
extractSetPosePositiveW_Y(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Quaternion y term from SetPosePositiveW.
extractSetPosePositiveW_Z(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Quaternion z term from SetPosePositiveW.
extractSetSetting_Address(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Setting index to write to from SetSetting.
extractSetSetting_Address(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Setting index to write to from SetSetting.
extractSetSetting_Flags_Ephemeral(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Whether the setting should be set ephemeral from SetSetting_Flags.
extractSetSetting_Flags_Ephemeral(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Whether the setting should be set ephemeral from SetSetting_Flags.
extractSetSetting_Flags_SynchHold(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Whether the setting should be held until the next synch barrier from SetSetting_Flags.
extractSetSetting_Flags_SynchHold(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Whether the setting should be held until the next synch barrier from SetSetting_Flags.
extractSetSetting_Flags_SynchMsgCount(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Synch message count from SetSetting_Flags.
extractSetSetting_Flags_SynchMsgCount(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Synch message count from SetSetting_Flags.
extractSetSetting_Value(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts 6-byte setting value from SetSetting.
extractSetSetting_Value(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts 6-byte setting value from SetSetting.
extractSettingCommand_ControlFlag(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Setting command index from SettingCommand.
extractSettingCommand_ControlFlag(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Setting command index from SettingCommand.
extractSettingCommand_SettingIndex(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts setting index to fetch from SettingCommand.
extractSettingCommand_SettingIndex(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts setting index to fetch from SettingCommand.
extractSettingReportFlags_CommitSuccess(int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Bitsets
Extracts commit_success from setting_report_flags.
extractSettingReportFlags_CommitSuccess(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts commit_success from setting_report_flags.
extractSettingReportFlags_SetSuccess(int) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Bitsets
Extracts set_success from setting_report_flags.
extractSettingReportFlags_SetSuccess(int) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
Extracts set_success from setting_report_flags.
extractSetYaw_Wraparound(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Wraparound counter from SetYaw.
extractSetYaw_Yaw(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Yaw angle (f32 between [-pi..pi) degrees) from SetYaw.
extractStatus_DevSpecific(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Extracts Device-specific status data.
extractStatus_Faults(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts 8-bit active faults bitfield from Status.
extractStatus_StickyFaults(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts 8-bit sticky faults bitfield from Status.
extractStatus_Temperature(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts 16-bit signed temperature byte in 1/256ths of a Celsius from Status.
extractStatusFramePeriod(long) - Static method in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Extracts Status frame period (ms) from StatusFramePeriod.
extractStatusFramePeriod(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Status frame period (ms) from StatusFramePeriod.
extractYawFramePeriod(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Extracts Yaw angle frame period (ms) from YawFramePeriod.
extractYawOutput_Yaw_Wraparound(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Wraparound counter from YawOutput_Yaw.
extractYawOutput_Yaw_Yaw(long) - Static method in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Extracts Yaw angle (f32 between [-pi..pi) degrees) from YawOutput_Yaw.

F

faultBitField() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the faults bitfield as an integer.
faultBitField() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the faults bitfield as an integer.
Faults(int) - Constructor for class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Constructor for the CanandmagFaults object.
Faults(int, boolean) - Constructor for class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Constructor for the Canandgyro.Faults object.
Faults(int, boolean) - Constructor for class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Constructor for the CanandmagFaults object.
faultsValid() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Flag if any faults data has been received at all from the device.
faultsValid() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Flag if any faults data has been received at all from the device.
feed() - Method in class com.reduxrobotics.canand.CooldownWarning
Feed the CooldownError.
fetchMissingSettings(double, int) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Attempt to fill out the known settings with the set of settings it is missing.
fetchSetting(int, double) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Fetches a setting from the device and returns the received result.
fetchSettingsAddresses() - Method in class com.reduxrobotics.canand.CanandSettings
Gets the list of settings addresses this settings class records.
fetchSettingsAddresses() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
 
fetchSettingsAddresses() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
 
floatToGuineaFloat24(float) - Static method in class com.reduxrobotics.canand.CanandUtils
Converts a 32-bit float to a 24-bit representation with the least significant eight bits of mantissa removed.
floatToShiftedLong(float, int) - Static method in class com.reduxrobotics.canand.CanandUtils
Writes a float to a long.
forceLoad() - Static method in class com.reduxrobotics.canand.ReduxJNI
Force load the library.
Frame<T> - Class in com.reduxrobotics.frames
Class representing periodic timestamped data received from CAN or other sources.
Frame(double) - Constructor for class com.reduxrobotics.frames.Frame
Constructs a new Frame object.
Frame.FrameCallback<FC> - Interface in com.reduxrobotics.frames
Functional interface for Frame callbacks.
FrameData<T> - Class in com.reduxrobotics.frames
Immutable container class for timestamped values.
FrameData(T, double) - Constructor for class com.reduxrobotics.frames.FrameData
Constructs a new FrameData object.
fromByteArray(byte[]) - Static method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Deserializes a Status object from a byte array.
fromByteArray(byte[]) - Static method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Deserializes a Status object from a byte array.
fromIndex(int) - Static method in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
Return the appropirate enum from the index value.
fromLong(long) - Static method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Deserializes a Status object from a long.

G

getAbsPosition() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Gets the current absolute position of the encoder, scaled from 0 inclusive to 1 exclusive.
getAbsPositionFrame() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns the current absolute position frame.
getAccelerationFrame() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the linear acceleration Frame object.
getAccelerationFramePeriod() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Gets the acceleration frame period in seconds [0..65.535], or Optional.empty() if the value has not been set on this object.
getAccelerationX() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the linear acceleration along the X axis in gravitational units.
getAccelerationY() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the linear acceleration along the Y axis in gravitational units.
getAccelerationZ() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the linear acceleration along the Z axis in gravitational units.
getActiveFaults() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Returns an object representing currently active faults.
getActiveFaults() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns an object representing currently active faults.
getAddress() - Method in class com.reduxrobotics.canand.CanandDevice
Returns the CanandAddress representing the combination of CAN bus and CAN device ID that this CanandDevice refers to.
getAddress() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
 
getAddress() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
 
getAngularPositionFrame() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the angular position Frame object.
getAngularPositionFramePeriod() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Gets the angular position frame period in seconds [0..65.535], or Optional.empty() if the value has not been set on this object.
getAngularVelocityFrame() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the angular velocity Frame object.
getAngularVelocityFramePeriod() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Gets the angular velocity frame period in seconds [0..65.535], or Optional.empty() if the value has not been set on this object.
getAngularVelocityPitch() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the angular velocity along the pitch (Y) axis in rotations per second.
getAngularVelocityRoll() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the angular velocity along the roll (X) axis in rotations per second.
getAngularVelocityYaw() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the angular velocity along the yaw (Z) axis in rotations per second.
getApiIndex() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the 5-bit CAN API index.
getApiIndex(int) - Static method in class com.reduxrobotics.canand.CanandUtils
Extracts the 8-bit API index from a full message id.
getApiPage() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the 5-bit Product ID / API class.
getApiPage(int) - Static method in class com.reduxrobotics.canand.CanandUtils
Extracts 2-bit product id/API class from a full message id Instead of doing a 6bit/4bit split for api class/api index, we use an even 5 bit split.
getBool(int) - Method in class com.reduxrobotics.canand.CanandSettings
Gets a boolean from the internal Map if it exists and return true, false, or null
getBus() - Method in class com.reduxrobotics.canand.CanandMessage
Gets an object representing the CAN bus that received the message
getData() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the CAN message payload (up to 8 bytes).
getData() - Method in class com.reduxrobotics.frames.ByteArrayFrame
Gets the underlying byte array data.
getData() - Method in class com.reduxrobotics.frames.DoubleFrame
Gets the underlying double data.
getData() - Method in class com.reduxrobotics.frames.LongFrame
Gets the underlying long data.
getData() - Method in class com.reduxrobotics.frames.ShortArrayFrame
Gets the underlying short array data.
getDataAsLong() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the CAN message payload as a long.
getDescriptor() - Method in class com.reduxrobotics.canand.CANBus
Returns the descriptor ID associated with the CAN bus object.
getDeviceId() - Method in class com.reduxrobotics.canand.CanandAddress
Returns the user-settable device ID.
getDeviceId() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the 6-bit CAN Device id.
getDeviceId(int) - Static method in class com.reduxrobotics.canand.CanandUtils
Extracts 6-bit device id from a full message id This is the "CAN id" that end users will see and care about.
getDeviceType() - Method in class com.reduxrobotics.canand.CanandAddress
Returns the 5-bit device type.
getDeviceType() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the 5-bit device type code Product ID/ device type combinations will be unique to a Redux product.
getDeviceType(int) - Static method in class com.reduxrobotics.canand.CanandUtils
Extracts 5-bit device type code from a full message id
getDisableZeroButton() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Gets whether or not the sensor should disallow zeroing and factory resets from the onboard button (0 for allow, 1 for disallow, -1 for unset).
getExtractOnStaticLoad() - Static method in class com.reduxrobotics.canand.ReduxJNI.Helper
Internal use method
getFilteredMap() - Method in class com.reduxrobotics.canand.CanandSettings
Return a direct filtered view of settings values as a new Map, limited to only valid settings.
getFirmwareVersion() - Method in class com.reduxrobotics.canand.CanandDevice
Returns the firmware version received by the device.
getFloatAsDouble(int, double) - Method in class com.reduxrobotics.canand.CanandSettings
Gets an integer from the internal Map if it exists and return a scaled user value.
getFPGATimestamp() - Static method in class com.reduxrobotics.canand.CanandUtils
Always returns the hardware FPGA timestamp.
getFrameData() - Method in class com.reduxrobotics.frames.Frame
Returns an immutable FrameData<T> class containing both value and timestamp.
getId() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the full 29-bit CAN message id.
getIndex() - Method in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
Return associated index (unsigned for values >= 0).
getInstance() - Static method in class com.reduxrobotics.canand.CanandEventLoop
Returns a handle to the event loop.
getIntAsDouble(int, double) - Method in class com.reduxrobotics.canand.CanandSettings
Gets an integer from the internal Map if it exists and return a scaled user value.
getInternalSettingsManager() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Returns the CanandSettingsManager associated with this device.
getInternalSettingsManager() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns the CanandSettingsManager associated with this device.
getInvertDirection() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Gets whether or not the encoder has an inverted direction (false for no, true for yes, null for unset).
getKnownSettings() - Method in class com.reduxrobotics.canand.CanandSettingsManager
Return a CanandSettings of known settings.
getLength() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the length of the CAN message's data in bytes.
getMap() - Method in class com.reduxrobotics.canand.CanandSettings
Directly access the underlying Map of settings values.
getMinimumFirmwareVersion() - Method in class com.reduxrobotics.canand.CanandDevice
Returns the minimum firmware version this vendordep requires for this device.
getMinimumFirmwareVersion() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
 
getMissingIndexes() - Method in class com.reduxrobotics.canand.CanandSettings
Generates a list of setting indexes missing from this object to be considered "complete".
getMultiturnYaw() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets a multi-turn yaw (Z-axis) rotation that tracks to multiple continuous rotations.
getMultiturnYawFrame() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the dedicated multi-turn yaw Frame object.
getNested() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
getNested() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
getPitch() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the pitch (Y-axis) rotation from [-0.5 inclusive..0.5 exclusive).
getPitch() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Gets the Euler pitch value in rotations from [-0.5 inclusive..0.5 exclusive).
getPosition() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Gets the current integrated relative position in rotations.
getPositionFrame() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns the current relative position frame.
getPositionFramePeriod() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Gets the position frame period in seconds [0..65.535], or null if the value has not been set on this object.
getQuaternion() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets a quaternion object of the gyro's 3d rotation from the zero point -- Warning: this allocates objects! Limit the number of calls you make to this per robot loop!
getQuaternionW() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the W term of the current Canandgyro rotation quaternion, normalized from [-1.0..1.0] inclusive.
getQuaternionX() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the X term of the current Canandgyro rotation quaternion, normalized from [-1.0..1.0] inclusive.
getQuaternionY() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the Y term of the current Canandgyro rotation quaternion, normalized from [-1.0..1.0] inclusive.
getQuaternionZ() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the Z term of the current Canandgyro rotation quaternion, normalized from [-1.0..1.0] inclusive.
getRioBus() - Static method in class com.reduxrobotics.canand.CANBus
Returns a CANBus object representing the roboRIO's onboard bus.
getRoll() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the roll (Z-axis) rotation from [-0.5 inclusive..0.5 exclusive).
getRoll() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Gets the Euler roll value in rotations from [-0.5 inclusive..0.5 exclusive).
getRotation2d() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets a Rotation2d object representing the rotation around the yaw axis from the zero point -- Warning: this allocates objects! Limit the number of calls you make to this per robot loop! If you just want Z-axis rotation as a double, it's more performant to use Canandgyro.getYaw().
getRotation3d() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets a Rotation3d object of the gyro's 3d rotation from the zero point -- Warning: this allocates objects! Limit the number of calls you make to this per robot loop! If you just want Z-axis rotation as a double, it's more performant to use Canandgyro.getYaw().
getSchema() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroFaultsStruct
 
getSchema() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
getSchema() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagFaultsStruct
 
getSchema() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
getSettings() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Fetches the device's current configuration in a blocking manner.
getSettings() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Fetches the Canandmag's current configuration in a blocking manner.
getSettings(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Fetches the device's current configuration in a blocking manner.
getSettings(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Fetches the device's current configuration in a blocking manner.
getSettings(double, double, int) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Fetches the device's current configuration in a blocking manner.
getSettings(double, double, int) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Fetches the device's current configuration in a blocking manner, with control over failure handling.
getSettings(double, double, int) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Fetches the device's current configuration in a blocking manner, with control over failure handling.
getSettingsAsync() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Non-blockingly returns a Canandgyro.Settings object of the most recent known settings values received from the device.
getSettingsAsync() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Non-blockingly returns a Canandmag.Settings object of the most recent known settings values received from the encoder.
getSize() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroFaultsStruct
 
getSize() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
getSize() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagFaultsStruct
 
getSize() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
getStatus() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Get the contents of the previous status packet, which includes active faults, sticky faults, and temperature.
getStatus() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Get the contents of the previous status packet, which includes active faults, sticky faults, and temperature.
getStatusFrame() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Returns the current status frame which includes CAN timestamp data.
getStatusFrame() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns the current status frame, which includes CAN timestamp data.
getStatusFramePeriod() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Gets the status frame period in seconds [0.001..65.535], or Optional.empty() if the value has not beeno set on this object.
getStatusFramePeriod() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Gets the status frame period in seconds [0.001..65.535], or null if the value has not beeno set on this object.
getStickyFaults() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Returns sticky faults.
getStickyFaults() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns sticky faults.
getTemperature() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Get onboard device temperature readings in degrees Celsius.
getTemperature() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Get onboard encoder temperature readings in degrees Celsius.
getTimestamp() - Method in class com.reduxrobotics.canand.CanandMessage
Gets the CAN message timestamp, in seconds.
getTimestamp() - Method in class com.reduxrobotics.frames.Frame
Gets the timestamp in seconds of when this value was updated.
getTimestamp() - Method in class com.reduxrobotics.frames.FrameData
Gets the timestamp in seconds of when this value was updated.
getTypeClass() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroFaultsStruct
 
getTypeClass() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
getTypeClass() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagFaultsStruct
 
getTypeClass() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
getTypeString() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroFaultsStruct
 
getTypeString() - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
getTypeString() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagFaultsStruct
 
getTypeString() - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
getValue() - Method in class com.reduxrobotics.frames.ByteArrayFrame
 
getValue() - Method in class com.reduxrobotics.frames.DoubleFrame
 
getValue() - Method in class com.reduxrobotics.frames.Frame
Returns the value of the data frame.
getValue() - Method in class com.reduxrobotics.frames.FrameData
Returns the value of the data frame.
getValue() - Method in class com.reduxrobotics.frames.LongFrame
 
getValue() - Method in class com.reduxrobotics.frames.ShortArrayFrame
 
getValue() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
 
getValue() - Method in class com.reduxrobotics.sensors.canandgyro.Vec3Frame
 
getVelocity() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns the measured velocity in rotations per second.
getVelocityFilterWidth() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Gets the velocity filter width in milliseconds [0.25..63.75], or null if the value has not been set on this object.
getVelocityFrame() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns the current velocity frame, which includes CAN timestamp data.
getVelocityFramePeriod() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Gets the velocity frame period in seconds [0..65.535], or null if the value has not been set on this object.
getW() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Gets the W term of the current quaternion, normalized from [-1.0..1.0] inclusive.
getX() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Gets the X term of the current quaternion, normalized from [-1.0..1.0] inclusive.
getX() - Method in class com.reduxrobotics.sensors.canandgyro.Vec3Frame
The x (first) component.
getY() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Gets the Y term of the current quaternion, normalized from [-1.0..1.0] inclusive.
getY() - Method in class com.reduxrobotics.sensors.canandgyro.Vec3Frame
The y (second) component.
getYaw() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the yaw (Z-axis) rotation from [-0.5 inclusive..0.5 exclusive).
getYaw() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Gets the Euler yaw value in rotations from [-0.5 inclusive..0.5 exclusive).
getYawFrame() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Gets the dedicated single-turn yaw Frame object.
getYawFramePeriod() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Gets the dedicated yaw frame period in seconds [0..65.535], or Optional.empty() if the value has not been set on this object.
getZ() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Gets the Z term of the current quaternion, normalized from [-1.0..1.0] inclusive.
getZ() - Method in class com.reduxrobotics.sensors.canandgyro.Vec3Frame
The z (third) component.
getZeroOffset() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Gets the zero offset of the encoder.

H

handleMessage(CanandMessage) - Method in class com.reduxrobotics.canand.CanandDevice
A callback called when a Redux CAN message is received and should be parsed.
handleMessage(CanandMessage) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
 
handleMessage(CanandMessage) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
 
handleSetting(CanandMessage) - Method in class com.reduxrobotics.canand.CanandSettingsManager
hardwareFault() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the hardware fault flag, which will raise if a hardware issue is detected.
hardwareFault() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the hardware fault flag, which will raise if a hardware issue is detected.
hasData() - Method in class com.reduxrobotics.frames.ByteArrayFrame
Returns if this frame has data.
hasData() - Method in class com.reduxrobotics.frames.DoubleFrame
Returns if this frame has data.
hasData() - Method in class com.reduxrobotics.frames.Frame
Returns if this frame has data.
hasData() - Method in class com.reduxrobotics.frames.LongFrame
Returns if this frame has data.
hasData() - Method in class com.reduxrobotics.frames.ShortArrayFrame
Returns if this frame has data.
hasData() - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Returns if this frame has data.
hasData() - Method in class com.reduxrobotics.sensors.canandgyro.Vec3Frame
Returns if this frame has data.
hashCode() - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
Returns a hash code value for this object.
hashCode() - Method in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Returns a hash code value for this object.
hashCode() - Method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Returns a hash code value for this object.
hashCode() - Method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Returns a hash code value for this object.
Helper() - Constructor for class com.reduxrobotics.canand.ReduxJNI.Helper
 

I

idMatches(int, int, int) - Static method in class com.reduxrobotics.canand.CanandUtils
Checks if a full CAN id will match against device type and device id We use this to determine if a message is intended for a specific device.
init() - Static method in class com.reduxrobotics.canand.ReduxJNI
Starts the Redux CANlink server -- not usually needed to be called manually.
invalid() - Static method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Returns a default Status record for frame initializion
invalid() - Static method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Return an invalid Status.
INVALID - Static variable in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Invalid singleton.
isActive() - Static method in class com.reduxrobotics.canand.TransmitDeferrer
Returns whether or not the current thread is collecting all message transmits into the local MessageBatcher.
isCalibrating() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Returns if the Canandgyro is known to be currently calibrating.
isConnected() - Method in class com.reduxrobotics.canand.CanandDevice
Checks whether or not the device has sent a message within the last 2000 milliseconds.
isConnected(double) - Method in class com.reduxrobotics.canand.CanandDevice
Checks whether or not the device has sent a message within the last timeout seconds.
isEmpty() - Method in class com.reduxrobotics.canand.CanandSettings
Returns if this CanandSettings has any set settings or not.
isValid() - Method in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Returns true if the result is valid.

K

kAccelerationFramePeriod - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Acceleration frame period (ms)
kAccelerationOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Acceleration frame
kAngularPositionFramePeriod - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Angular position frame period (ms)
kAngularPositionOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Angular position quaternion frame
kAngularVelocityFramePeriod - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Angular velocity frame period (ms)
kAngularVelocityOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Angular velocity frame
kCalibrate - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Trigger Calibration
kCalibrationStatus - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Calibration Status
kClearStickyFaults - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Clear device sticky faults
kClearStickyFaults - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Clear device sticky faults
kCountsPerRotation - Static variable in class com.reduxrobotics.sensors.canandmag.Canandmag
Conversion factor for number of position packet ticks per rotation.
kCountsPerRotationPerSecond - Static variable in class com.reduxrobotics.sensors.canandmag.Canandmag
Conversion factor from velocity packet ticks per second to rotations per second.
kDeviceType - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Device-specific type identifier
kDeviceType - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Device-specific type identifier
kDlc_AccelerationOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
ACCELERATION_OUTPUT message length
kDlc_AngularPositionOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
ANGULAR_POSITION_OUTPUT message length
kDlc_AngularVelocityOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
ANGULAR_VELOCITY_OUTPUT message length
kDlc_Calibrate - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
CALIBRATE message length
kDlc_CalibrationStatus - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
CALIBRATION_STATUS message length
kDlc_Enumerate - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
ENUMERATE message length
kDlc_Enumerate - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
ENUMERATE message length
kDlc_ReportSetting - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
REPORT_SETTING message length
kDlc_ReportSetting - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
REPORT_SETTING message length
kDlc_SetSetting - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
SET_SETTING message length
kDlc_SetSetting - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
SET_SETTING message length
kDlc_Status - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
STATUS message length
kDlc_Status - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
STATUS message length
kDlc_YawOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
YAW_OUTPUT message length
kDlcMax_ClearStickyFaults - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
CLEAR_STICKY_FAULTS message max length
kDlcMax_ClearStickyFaults - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
CLEAR_STICKY_FAULTS message max length
kDlcMax_PartyMode - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
PARTY_MODE message max length
kDlcMax_PartyMode - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
PARTY_MODE message max length
kDlcMax_SettingCommand - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
SETTING_COMMAND message max length
kDlcMax_SettingCommand - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
SETTING_COMMAND message max length
kDlcMin_ClearStickyFaults - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
CLEAR_STICKY_FAULTS message min length
kDlcMin_ClearStickyFaults - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
CLEAR_STICKY_FAULTS message min length
kDlcMin_PartyMode - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
PARTY_MODE message min length
kDlcMin_PartyMode - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
PARTY_MODE message min length
kDlcMin_SettingCommand - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
SETTING_COMMAND message min length
kDlcMin_SettingCommand - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
SETTING_COMMAND message min length
kEnumerate - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Device enumerate response
kEnumerate - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Device enumerate response
kError - Enum constant in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
Success
kFaults_AccelerationSaturation - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The acceleration saturation flag, which triggers on saturation of acceleration.
kFaults_AngularVelocitySaturation - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The angular velocity saturation flag, which triggers on saturation of angular velocity.
kFaults_Calibrating - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The calibration status flag, which will raise if the device is currently calibrating.
kFaults_CanGeneralError - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The CAN general error flag, which will raise if the device cannot RX packets reliably.
kFaults_CanIdConflict - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The CAN ID conflict flag, which is set to true if there is a CAN id conflict.
kFaults_HardwareFault - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The hardware fault flag, which will raise if a hardware issue is detected.
kFaults_OutOfTemperatureRange - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The temperature range flag, which will raise if the device is not between 0-70 degrees Celsius.
kFaults_PowerCycle - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
faults - The power cycle fault flag, which is set to true when the device first boots.
kFetchSettings - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Enums.SettingCommand
Fetch all settings from device
kFetchSettings - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Enums.SettingCommand
Fetch all settings from device
kFetchSettingValue - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Enums.SettingCommand
Fetches a single setting from device
kFetchSettingValue - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Enums.SettingCommand
Fetches a single setting from device
kFirmwareVersion - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Firmware version
kFirmwareVersion - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Firmware version
kFlag_Ephemeral - Static variable in class com.reduxrobotics.canand.CanandSettingsManager
Bit flag specifying this setting should be set ephemeral.,
kInvalid - Enum constant in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
General invalid data (a placeholder)
kMsg_ClearStickyFaults - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for clear device sticky faults
kMsg_PartyMode - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for party mode
kMsg_PositionOutput - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for Position frame
kMsg_RawPositionOutput - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for Raw position frame
kMsg_ReportSetting - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for setting value report from device
kMsg_SetSetting - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for update setting on device
kMsg_SettingCommand - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for setting control command
kMsg_Status - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for status frames
kMsg_VelocityOutput - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
Message id for Velocity frame
kNormal - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Enums.CalibrationType
Normal calibration routine
kOk - Enum constant in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
General error
kPartyMode - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Party mode
kPartyMode - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Party mode
kReportSetting - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
setting value report from device
kReportSetting - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
setting value report from device
kResetFactoryDefault - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Enums.SettingCommand
Reset settings to factory default
kResetFactoryDefault - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Enums.SettingCommand
Reset settings to factory default
kSaveZro - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Enums.CalibrationType
Save ZRO at calibration complete
kSerialNumber - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Serial number
kSerialNumber - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Serial number
kSetPoseNegativeW - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Set (normed) quaternion assuming negative W
kSetPosePositiveW - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Set (normed) quaternion assuming positive W
kSetSetting - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
update setting on device
kSetSetting - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
update setting on device
kSettingCommand - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
setting control command
kSettingCommand - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
setting control command
kSettingReportFlags_CommitSuccess - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Bitsets
setting_report_flags - Whether the setting synch commit was successful
kSettingReportFlags_CommitSuccess - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
setting_report_flags - Whether the setting synch commit was successful
kSettingReportFlags_SetSuccess - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Bitsets
setting_report_flags - Whether the setting set was successful
kSettingReportFlags_SetSuccess - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Bitsets
setting_report_flags - Whether the setting set was successful
kSetYaw - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Set yaw
kStatus - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Msg
Status frame
kStatus - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Status frame
kStatusFramePeriod - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
Status frame period (ms)
kStatusFramePeriod - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Status frame period (ms)
kStg_DisableZeroButton - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Disable the zero button
kStg_InvertDirection - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Invert direction (use cw instead of ccw)
kStg_PositionFramePeriod - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Position frame period (ms)
kStg_RawPositionFramePeriod - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Raw position frame period (ms)
kStg_RelativePosition - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Relative position value
kStg_StatusFramePeriod - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for status frame period (ms)
kStg_VelocityFramePeriod - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Velocity frame period (ms)
kStg_VelocityWindow - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Velocity window width (value*250us)
kStg_ZeroOffset - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting id for Encoder zero offset
kStgCmd_FetchSettings - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting command for Fetch all settings from device
kStgCmd_FetchSettingValue - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting command for Fetch individual setting
kStgCmd_ResetFactoryDefault - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting command for Reset everything to factory default
kStgCmd_ResetFactoryDefaultKeepZero - Static variable in class com.reduxrobotics.sensors.canandmag.CanandmagDetails
setting command for Factory defaults, but keep the encoder zero offset
kTempCal0 - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Enums.CalibrationType
Temperature calibrate slot 0
kTempCal1 - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Enums.CalibrationType
Temperature calibrate slot 1
kTimeout - Enum constant in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
Operation timeout
kYawFramePeriod - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
Yaw angle frame period (ms)
kYawOutput - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Msg
Yaw angle frame

L

lastMessageTs - Variable in class com.reduxrobotics.canand.CanandDevice
The last received message timestamp.
LongFrame<T> - Class in com.reduxrobotics.frames
Implements an object-holding Frame backed by a Long.
LongFrame(long, double, T, LongFrame.LongToType<T>) - Constructor for class com.reduxrobotics.frames.LongFrame
Instantiates a new LongFrame.
LongFrame.LongToType<T> - Interface in com.reduxrobotics.frames
Functional interface for a function mapping a double data value to the final frame type.

M

magnetInRange() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Returns whether the encoder magnet is in range of the sensor or not.
magnetInRange() - Method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Returns the value of the magnetInRange record component.
magnetOutOfRange() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the magnet out of range flag, which will raise if the measured shaft's magnet is not detected.
maxTimestamp(FrameData<?>[]) - Static method in class com.reduxrobotics.frames.Frame
Returns the max timestamp from a tuple of FrameData objects.
maxTimestamp(FrameData<?>[]) - Static method in class com.reduxrobotics.frames.FrameData
Fetches the maximum CAN timestamp out of an array of FrameData objects
minor() - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
Returns the value of the minor record component.
msgMatches(CanandMessage) - Method in class com.reduxrobotics.canand.CanandAddress
Checks if a CAN message matches against the device type, product id, and device can id
multiYaw - Variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Yaw frame (units: rotations)

O

outOfTemperatureRange() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the out of temperature spec flag, which will raise if the device is above 95 degrees Celsius.
outOfTemperatureRange() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the temperature range flag, which will raise if the encoder is not between 0-70 degrees Celsius.

P

pack(ByteBuffer, Canandgyro.Faults) - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroFaultsStruct
 
pack(ByteBuffer, Canandgyro.Status) - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
pack(ByteBuffer, Canandmag.Faults) - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagFaultsStruct
 
pack(ByteBuffer, Canandmag.Status) - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
patch() - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
Returns the value of the patch record component.
position - Variable in class com.reduxrobotics.sensors.canandmag.Canandmag
internal Frame variable holding current relative position state
powerCycle() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
Returns the power cycle fault flag, which is set to true when the device first boots.
powerCycle() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the power cycle fault flag, which is set to true when the encoder first boots.
preHandleMessage(CanandMessage) - Method in class com.reduxrobotics.canand.CanandDevice
Called before CanandDevice.handleMessage(com.reduxrobotics.canand.CanandMessage) gets called to run some common logic.

Q

quat - Variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Quaternion frame
QuaternionFrame - Class in com.reduxrobotics.sensors.canandgyro
Implements an object-holding Frame with considerations for quaternions.
QuaternionFrame(double, Quaternion) - Constructor for class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Instantiates a new QuaternionFrame.
queueCANMessage(CANBus, int, byte[]) - Static method in class com.reduxrobotics.canand.TransmitDeferrer
Queues a CAN message to be sent in the batch.
queueCANMessage(CANBus, int, long, int) - Static method in class com.reduxrobotics.canand.TransmitDeferrer
Queues a CAN message to be sent in the batch.

R

ReduxJNI - Class in com.reduxrobotics.canand
Java side of the Redux device driver JNI wrapper.
ReduxJNI() - Constructor for class com.reduxrobotics.canand.ReduxJNI
 
ReduxJNI.Helper - Class in com.reduxrobotics.canand
Internal use class.
removeCallback(Frame.FrameCallback<T>) - Method in class com.reduxrobotics.frames.Frame
Remove a registered callback by the handle.
removeListener(CanandDevice) - Method in class com.reduxrobotics.canand.CanandEventLoop
Removes a listener for CAN messages, if it is in fact listening.
resetFactoryDefaults(boolean) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Resets the encoder to factory defaults, waiting up to 500 ms to confirm the settings changes.
resetFactoryDefaults(boolean, double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Resets the encoder to factory defaults, and then wait for all settings to be broadcasted back.
resetFactoryDefaults(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Resets the device to factory defaults.
result() - Method in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Returns the value of the result record component.
run() - Method in class com.reduxrobotics.canand.CanandEventLoop
 

S

sendCANMessage(int, byte[]) - Method in class com.reduxrobotics.canand.CanandAddress
Sends a CAN message to the CanandAddress.
sendCANMessage(int, byte[]) - Method in class com.reduxrobotics.canand.CanandDevice
Directly sends a CAN message to the device.
sendCANMessage(int, long, int) - Method in class com.reduxrobotics.canand.CanandAddress
Sends a CAN message to the CanandAddress.
sendCANMessage(int, long, int) - Method in class com.reduxrobotics.canand.CanandDevice
Directly sends a CAN message to the device.
sendCANMessage(CANBus, int, byte[]) - Static method in class com.reduxrobotics.canand.ReduxJNI
Sends a CAN message.
sendCANMessage(CANBus, int, long, int) - Static method in class com.reduxrobotics.canand.ReduxJNI
Sends a CAN message using a long as the data medium.
sendReceiveSettingCommand(int, double, boolean) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Runs a setting command that may mutate all settings and trigger a response.
sendSettingCommand(int) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Sends a setting command with no arguments.
setAbsPosition(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Sets the new absolute position value for the encoder which will persist across reboots with default timeout of 20 ms.
setAbsPosition(double, double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Sets the new absolute position value for the encoder which will persist across reboots with a specified timeout.
setAbsPosition(double, double, boolean) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Sets the new absolute position value for the encoder which will (by default) persist across reboots.
setAccelerationFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Sets the angular velocity frame period in seconds.
setAngularPositionFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Sets the angular position frame period in seconds.
setAngularVelocityFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Sets the angular velocity frame period in seconds.
setDevicePresenceThreshold(CanandDevice, double) - Method in class com.reduxrobotics.canand.CanandEventLoop
Sets the device presence threshold of how many seconds must pass without a message for the device checker to consider them disconnected from bus.
setDevicePresenceWarnings(CanandDevice, boolean) - Method in class com.reduxrobotics.canand.CanandEventLoop
Set whether to enable device presence warnings to the driver station for a single device (defaults to true).
setDisableZeroButton(boolean) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Sets whether or not the sensor should disallow zeroing and factory resets from the onboard button.
setEphemeral(boolean) - Method in class com.reduxrobotics.canand.CanandSettings
Sets whether or not the settings will be set as ephemeral -- that is, does not persist on device power cycle.
setExtractOnStaticLoad(boolean) - Static method in class com.reduxrobotics.canand.ReduxJNI.Helper
Internal use method
setGlobalDevicePresenceWarnings(boolean) - Method in class com.reduxrobotics.canand.CanandEventLoop
Set whether to enable device presence warnings to the driver station globally (defaults to true).
setInvertDirection(boolean) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Inverts the direction read from the sensor.
setPartyMode(int) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Controls "party mode" -- an device identification tool that blinks the onboard LED various colors if level != 0.
setPartyMode(int) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Controls "party mode" -- an encoder identification tool that blinks the onboard LED various colors at a user-specified strobe period.
setPose(double, double, double, double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Sets a new angular position pose without recalibrating with a given roll/pitch/yaw.
setPose(Quaternion, double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Sets a new pose without recalibrating with a Quaternion.
setPose(Rotation3d, double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Sets a new angular position without recalibrating with a Rotation3d.
setPosition(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Sets the new relative (multi-turn) position of the encoder to the given value, with a confirmation timeout of 20 ms.
setPosition(double, double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Sets the new relative (multi-turn) position of the encoder to the given value.
setPositionFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Sets the position frame period in seconds.
setSettingById(int, byte[], int) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Directly sends a CAN message to the associated CanandDevice to set a setting by index.
setSettingById(int, long, int) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Directly sends a CAN message to the associated CanandDevice to set a setting by index.
setSettings(Canandgyro.Settings) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Applies the settings from a Canandgyro.Settings object to the device.
setSettings(Canandgyro.Settings, double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Applies the settings from a Canandgyro.Settings object to the device.
setSettings(Canandgyro.Settings, double, int) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Applies the settings from a Canandgyro.Settings object to the device, with fine grained control over failure-handling.
setSettings(Canandmag.Settings) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Applies the settings from a Canandmag.Settings object to the Canandmag.
setSettings(Canandmag.Settings, double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Applies the settings from a Canandmag.Settings object to the Canandmag.
setSettings(Canandmag.Settings, double, int) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Applies the settings from a Canandmag.Settings object to the device, with fine grained control over failure-handling.
setSettings(T, double) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Applies the settings from a CanandSettings object to the device.
setSettings(T, double, int) - Method in class com.reduxrobotics.canand.CanandSettingsManager
Applies the settings from a CanandSettings object to the device, with fine grained control over failure-handling.
setStatusFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Sets the status frame period in seconds.
setStatusFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Sets the status frame period in seconds.
SettingResult(long, CanandSettingsManager.ResultCode) - Constructor for record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Creates an instance of a SettingResult record class.
Settings() - Constructor for class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Instantiates a blank Canandgyro.Settings object with no settings to be set.
Settings() - Constructor for class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Instantiates a new Canandmag.Settings object that is "completely blank" -- holding no settings values at all.
Settings(Canandgyro.Settings) - Constructor for class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Instantiates a new Canandgyro.Settings object that copies its settings from the input instance.
Settings(Canandmag.Settings) - Constructor for class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Instantiates a new Canandmag.Settings object that copies its settings from the input instance.
settingsAddresses - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails.Stg
List of settings to fetch for.
settingsAddresses - Static variable in class com.reduxrobotics.sensors.canandgyro.CanandgyroDetails.Stg
List of settings to fetch for.
setVelocityFilterWidth(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Sets the velocity filter width in milliseconds to sample over.
setVelocityFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Sets the velocity frame period in seconds.
setYaw(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Sets a new yaw without recalibrating the Canandgyro.
setYaw(double, double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Sets a new yaw without recalibrating the Canandgyro.
setYawFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Settings
Sets the dedicated yaw frame period in seconds.
setZeroOffset(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Settings
Sets the zero offset of the encoder directly, rather than adjusting the zero offset relative to the currently read position.
ShortArrayFrame<T> - Class in com.reduxrobotics.frames
Implements an object-holding Frame backed by a byte array.
ShortArrayFrame(int, double, T, ShortArrayFrame.ShortArrayToType<T>) - Constructor for class com.reduxrobotics.frames.ShortArrayFrame
Instantiates a new ShortArrayFrame.
ShortArrayFrame.ShortArrayToType<T> - Interface in com.reduxrobotics.frames
Functional interface for a function mapping a double data value to the final frame type.
signExtend(BitSet, int) - Static method in class com.reduxrobotics.canand.CanandUtils
Sign extends a BitSet to 64 bits by copying the bit from index s-1 to [s..64).
singleYaw - Variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Yaw frame (units: rotations)
startCalibration() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Tell the Canandgyro to begin its calibration routine.
startFetchSettings() - Method in class com.reduxrobotics.canand.CanandSettingsManager
Tells the device to begin transmitting its settings.
startFetchSettings() - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Tells the Canandgyro to begin transmitting its settings; once they are all transmitted (after ~200-300ms), the values can be retrieved from Canandgyro.getSettingsAsync()
startFetchSettings() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Tells the device to begin transmitting its settings.
status - Variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Status frame
status - Variable in class com.reduxrobotics.sensors.canandmag.Canandmag
internal Frame variable holding current status value state
Status(boolean, Canandgyro.Faults, Canandgyro.Faults, double) - Constructor for record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Creates an instance of a Status record class.
Status(Canandmag.Faults, Canandmag.Faults, double, boolean) - Constructor for record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Creates an instance of a Status record class.
stickyFaults() - Method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Returns the value of the stickyFaults record component.
stickyFaults() - Method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Returns the value of the stickyFaults record component.
struct - Static variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro.Faults
This field is necessary for WPILib structs to work around Java type erasure.
struct - Static variable in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
This field is necessary for WPILib structs to work around Java type erasure.
struct - Static variable in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
This field is necessary for WPILib structs to work around Java type erasure.
struct - Static variable in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
This field is necessary for WPILib structs to work around Java type erasure.

T

temperature() - Method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Returns the value of the temperature record component.
temperature() - Method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Returns the value of the temperature record component.
TIMEOUT - Static variable in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Timeout singleton.
toByteArray(byte[]) - Method in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Copies the long-backed value to a byte array.
toSettingData() - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
Serializes the firmware version record into a wire-formattable Long.
toString() - Method in class com.reduxrobotics.canand.CanandDevice
 
toString() - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
Returns a string representation of this record class.
toString() - Method in class com.reduxrobotics.canand.CanandSettings
 
toString() - Method in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Returns a string representation of this record class.
toString() - Method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Returns a string representation of this record class.
toString() - Method in record class com.reduxrobotics.sensors.canandmag.Canandmag.Status
Returns a string representation of this record class.
TransmitDeferrer - Class in com.reduxrobotics.canand
Class that allows for batching messages to be transmitted.
TransmitDeferrer() - Constructor for class com.reduxrobotics.canand.TransmitDeferrer
 

U

underVolt() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag.Faults
Returns the undervolt flag, which will raise if the encoder is experiencing brownout conditions.
unpack(ByteBuffer) - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroFaultsStruct
 
unpack(ByteBuffer) - Method in class com.reduxrobotics.sensors.canandgyro.wpistruct.CanandgyroStatusStruct
 
unpack(ByteBuffer) - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagFaultsStruct
 
unpack(ByteBuffer) - Method in class com.reduxrobotics.sensors.canandmag.wpistruct.CanandmagStatusStruct
 
update(double) - Method in class com.reduxrobotics.frames.Frame
Updates the Frame's value, notifying any listeners of new data.
updateData(byte[], double) - Method in class com.reduxrobotics.frames.ByteArrayFrame
Update the ByteArrayFrame with new byte array data.
updateData(byte[], double) - Method in class com.reduxrobotics.frames.ShortArrayFrame
Update the ShortArrayFrame with new short array data.
updateData(byte[], double) - Method in class com.reduxrobotics.sensors.canandgyro.QuaternionFrame
Update the Frame with new data.
updateData(byte[], double) - Method in class com.reduxrobotics.sensors.canandgyro.Vec3Frame
Update the Frame with new data.
updateData(double, double) - Method in class com.reduxrobotics.frames.DoubleFrame
Update the DoubleFrame with new double-backed data.
updateData(long, double) - Method in class com.reduxrobotics.frames.LongFrame
Update the LongFrame with new long data.
useDedicatedYawAngleFrame(boolean) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Sets whether this object should use the dedicated yaw message for yaw angle instead of deriving it from the pose quaternion frame.

V

valid() - Method in record class com.reduxrobotics.sensors.canandgyro.Canandgyro.Status
Returns the value of the valid record component.
value() - Method in record class com.reduxrobotics.canand.CanandSettingsManager.SettingResult
Returns the value of the value record component.
valueOf(String) - Static method in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
Returns the enum constant of this class with the specified name.
values - Variable in class com.reduxrobotics.canand.CanandSettings
The backing Map of raw setting indexes to raw setting values (serialized as Long)
values() - Static method in enum class com.reduxrobotics.canand.CanandSettingsManager.ResultCode
Returns an array containing the constants of this enum class, in the order they are declared.
Vec3Frame - Class in com.reduxrobotics.sensors.canandgyro
Implements an object-holding Frame with considerations for 3-vectors.
Vec3Frame(double, Vector<N3>, double) - Constructor for class com.reduxrobotics.sensors.canandgyro.Vec3Frame
Instantiates a new Vec3Frame.
vel - Variable in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Angular velocity frame (rotations/second)
velocity - Variable in class com.reduxrobotics.sensors.canandmag.Canandmag
internal Frame variable holding current velocity state

W

waitForCalibrationToFinish(double) - Method in class com.reduxrobotics.sensors.canandgyro.Canandgyro
Blocks the current thread until the Canandgyro has finished calibrating or until a timeout is reached.
waitForFrames(double, Frame<?>...) - Static method in class com.reduxrobotics.frames.Frame
Waits for all Frames to have transmitted a value.
writeFloatToBytes(float, byte[], int) - Static method in class com.reduxrobotics.canand.CanandUtils
Writes a float to a byte array.

Y

year() - Method in record class com.reduxrobotics.canand.CanandFirmwareVersion
Returns the value of the year record component.

Z

zeroAll() - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Sets both the current absolute and relative encoder position to 0 -- generally equivalent to pressing the physical zeroing button on the encoder.
zeroAll(double) - Method in class com.reduxrobotics.sensors.canandmag.Canandmag
Sets both the current absolute and relative encoder position to 0 -- generally equivalent to pressing the physical zeroing button on the encoder.
A B C D E F G H I K L M O P Q R S T U V W Y Z 
All Classes and Interfaces|All Packages|Constant Field Values