Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- absPosition - Variable in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
internal Frame variable holding current absolute position state
- activeFaults() - Method in record class com.reduxrobotics.sensors.canandcoder.CanandcoderStatus
-
Returns the value of the
activeFaults
record component. - activeFaults() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorStatus
-
Returns the value of the
activeFaults
record component. - 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.sensors.canandcoder.CanandcoderSettings
-
Returns whether or not all settings fields have been written into the object.
- allSettingsReceived() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Returns whether or not all settings fields have been written into the object.
B
- blue() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns the value of the
blue
record component. - 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 DoubleFrame.
- 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
- 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, int) - Constructor for class com.reduxrobotics.canand.CanandAddress
-
Constructor with implicit Rio CAN bus.
- CanandAddress(CANBus, int, int, int) - Constructor for class com.reduxrobotics.canand.CanandAddress
-
Constructor with explicit CAN bus.
- Canandcoder - Class in com.reduxrobotics.sensors.canandcoder
-
Class for the CAN interface of the Canandcoder.
- Canandcoder(int) - Constructor for class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Instantiates a new Canandcoder object.
- CanandcoderDetails - Class in com.reduxrobotics.sensors.canandcoder
-
Contains all the constants used by the
Canandcoder
and related classes (as to not pollute their public namespaces) - CanandcoderFaults - Class in com.reduxrobotics.sensors.canandcoder
-
A class to hold device faults for the
Canandcoder
, as returned byCanandcoder.getStickyFaults()
andCanandcoder.getActiveFaults()
- CanandcoderFaults(byte) - Constructor for class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
Constructor for the CanandcoderFaults object.
- CanandcoderFaults(byte, boolean) - Constructor for class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
Constructor for the CanandcoderFaults object.
- CanandcoderSettings - Class in com.reduxrobotics.sensors.canandcoder
-
The settings class for the
Canandcoder
. - CanandcoderSettings() - Constructor for class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Instantiates a new
CanandcoderSettings
object, that is "completely blank" -- that is, it holds no settings values at all. - CanandcoderSettings(CanandcoderSettings) - Constructor for class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Instantiates a new
CanandcoderSettings
object that copies its settings from the input instance. - CanandcoderStatus - Record Class in com.reduxrobotics.sensors.canandcoder
-
Container record class representing a
Canandcoder
's status. - CanandcoderStatus(CanandcoderFaults, CanandcoderFaults, double, boolean) - Constructor for record class com.reduxrobotics.sensors.canandcoder.CanandcoderStatus
-
Creates an instance of a
CanandcoderStatus
record class. - Canandcolor - Class in com.reduxrobotics.sensors.canandcolor
-
Class for the CAN interface of the Canandcolor.
- Canandcolor(int) - Constructor for class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Instantiates a new Canandcolor object.
- CanandcolorColor - Record Class in com.reduxrobotics.sensors.canandcolor
-
Record class to hold detected color values.
- CanandcolorColor(double, double, double, double) - Constructor for record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Creates an instance of a
CanandcolorColor
record class. - CanandcolorColorPeriod - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Enum representing the internal configuration of the Canandcolor's color IC.
- CanandcolorDetails - Class in com.reduxrobotics.sensors.canandcolor
-
Contains all the constants used by the
Canandcolor
and related classes (as to not pollute their public namespaces) - CanandcolorDigitalOutput - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Represents the digital outputs on the Canandcolor.
- CanandcolorDigoutSlot - Class in com.reduxrobotics.sensors.canandcolor
-
Represents a digout "slot" which helps determine the digital output's value.
- CanandcolorDigoutSlot.ClauseJoin - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Whether the slot should "join" with the next slot at index + 1 to form a clause.
- CanandcolorDigoutSlot.ClauseOperator - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Specifies how the slot (assuming clause joining is enabled) should join with the next slot.
- CanandcolorDigoutSlot.Comparison - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Enum of numerical comparisons.
- CanandcolorDigoutSlot.DataSource - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Data sources that digout slots can use to perform comparisons.
- CanandcolorDigoutSlot.Opcode - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Enums corresponding to digout slot opcodes.
- CanandcolorDigoutState - Class in com.reduxrobotics.sensors.canandcolor
-
Class representing the state of the Canandcolor digital outputs and the individual condition slots contributing to the outputs.
- CanandcolorDigoutState() - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutState
-
Instatiate with blank (all zeros) digout state.
- CanandcolorDigoutState(byte[]) - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutState
-
Constructor -- used by the
Canandcolor
class to populate this object. - CanandcolorFaults - Class in com.reduxrobotics.sensors.canandcolor
-
A class to hold device faults for the
Canandcolor
, as returned byCanandcolor.getStickyFaults()
andCanandcolor.getActiveFaults()
- CanandcolorFaults(byte, boolean) - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorFaults
-
Constructor for the
CanandcolorFaults
object. - CanandcolorProximityConfig - Class in com.reduxrobotics.sensors.canandcolor
-
Class representing the internal configuration of the Canandcolor's proximity IC.
- CanandcolorProximityConfig() - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Initializes a new proximity config with the default recommended values.
- CanandcolorProximityConfig(int) - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Initializes the config with a long as returned by a report settings CAN message (used internally)
- CanandcolorProximityConfig(CanandcolorProximityConfig) - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Initializes the config with the values from another
CanandcolorProximityConfig
object (copy constructor). - CanandcolorProximityConfig.IntegrationPeriod - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Represents the valid integration periods for the proximity sensor.
- CanandcolorProximityConfig.LEDCurrent - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Determines how much current gets dumped into the IR LED and thus its intensity.
- CanandcolorProximityConfig.MultiPulse - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Determines how many IR LED pulses get sent out during proximity reads.
- CanandcolorProximityConfig.SamplingPeriod - Enum Class in com.reduxrobotics.sensors.canandcolor
-
Represents the valid sampling periods for the proximity sensor.
- CanandcolorSettings - Class in com.reduxrobotics.sensors.canandcolor
-
The settings class for the
Canandcolor
. - CanandcolorSettings() - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Instantiates a new
CanandcolorSettings
object, that is "completely blank" -- that is, it holds no settings values at all. - CanandcolorSettings(CanandcolorSettings) - Constructor for class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Instantiates a new
CanandcolorSettings
object that copies its settings from the input instance. - CanandcolorStatus - Record Class in com.reduxrobotics.sensors.canandcolor
-
Container record class representing a
Canandcolor
's status. - CanandcolorStatus(CanandcolorFaults, CanandcolorFaults, double) - Constructor for record class com.reduxrobotics.sensors.canandcolor.CanandcolorStatus
-
Creates an instance of a
CanandcolorStatus
record class. - CanandDevice - Class in com.reduxrobotics.canand
-
Base class for Redux CAN devices.
- CanandDevice() - Constructor for class com.reduxrobotics.canand.CanandDevice
-
Default constructor for CanandDevices that just adds the device to the incoming CAN message listener.
- CanandDeviceDetails - Class in com.reduxrobotics.canand
-
Contains all the constants used by
CanandDevice
and are generally common to all Redux devices. - CanandDeviceDetails() - Constructor for class com.reduxrobotics.canand.CanandDeviceDetails
- CanandEventLoop - Class in com.reduxrobotics.canand
-
Class that runs the CAN packet ingest loop, and starts the CANLink interface.
- CanandMessage - Class in com.reduxrobotics.canand
-
Class that represents a CAN message received from the Redux
CanandEventLoop
This class is generally (re)initialized byCanandMessage.updateFromByteBuf(java.nio.ByteBuffer)
with aByteBuffer
from the JNI viaCanandEventLoop
From there, it is then passed intoCanandDevice.handleMessage(com.reduxrobotics.canand.CanandMessage)
through the event loop. - 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
- 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.canandcoder.CanandcoderFaults
-
Returns the CAN general error flag, which will raise if the encoder cannot RX packets reliably.
- canGeneralError() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorFaults
-
Returns the CAN general error flag, which will raise if the device cannot RX packets reliably.
- canIDConflict() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
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.canandcolor.CanandcolorFaults
-
Returns the CAN ID conflict flag, which is set to true if there is a CAN id conflict.
- clearAllDigoutSlots(CanandcolorDigitalOutput) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Clears all configured "slots" on the specified digital output.
- 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.
- clearStickyFaults() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Clears sticky faults.
- clearStickyFaults() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Clears sticky faults.
- close() - Method in class com.reduxrobotics.canand.CanandDevice
- color - Variable in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
internal Frame variable holding current color state
- 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.jni - package com.reduxrobotics.jni
-
Package relating to the JNI internals of ReduxLib.
- com.reduxrobotics.sensors.canandcoder - package com.reduxrobotics.sensors.canandcoder
-
Package that holds all classes relating to the Canandcoder
- com.reduxrobotics.sensors.canandcolor - package com.reduxrobotics.sensors.canandcolor
-
Package that holds all classes relating to the Canandcolor proximity/color sensor
- compareAffine(CanandcolorDigoutSlot.DataSource, double, double, CanandcolorDigoutSlot.Comparison, CanandcolorDigoutSlot.DataSource) - Static method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Returns a new
CanandcolorDigoutSlot
object for a slot that compares two data sources against each other, while scaling and offsetting the first data slot's value. - compareImmidiate(CanandcolorDigoutSlot.DataSource, CanandcolorDigoutSlot.Comparison, double) - Static method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Returns a new
CanandcolorDigoutSlot
object for a slot that compares a data source against a constant value (the immidiate). - compareSources(CanandcolorDigoutSlot.DataSource, CanandcolorDigoutSlot.Comparison, CanandcolorDigoutSlot.DataSource) - Static method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Returns a new
CanandcolorDigoutSlot
object for a slot that compares two data sourcces against each other directly with no affine transformation. - confirmSetSetting(byte, long, double) - Method in class com.reduxrobotics.canand.CanandDevice
-
Potentially blocking operation to send a setting and wait for a report setting message to be received to confirm the operation.
- constructMessageId(int, int, int, int) - Static method in class com.reduxrobotics.canand.CanandUtils
-
Construct a CAN message id to send to a Redux device.
- 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.
D
- dataValid() - Method in class com.reduxrobotics.frames.LongFrame
-
Returns if this frame has data.
- digout - Variable in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
internal Frame variable holding current digital output state
- disabledSlot() - Static method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Returns a new
CanandcolorDigoutSlot
object for a disabled and unconfigured slot. - 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.jni.ReduxJNI
-
Supported driver major version
- DRIVER_MINOR_VERSION - Static variable in class com.reduxrobotics.jni.ReduxJNI
-
Supported driver minor version
- DRIVER_YEAR - Static variable in class com.reduxrobotics.jni.ReduxJNI
-
Supported driver year
E
- 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.canandcoder.CanandcoderStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorStatus
-
Indicates whether some other object is "equal to" this one.
- 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.
F
- faultsValid() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
Flag if any faults data has been received at all from the device.
- faultsValid() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorFaults
-
Flag if any faults data has been received at all from the device.
- fetchSetting(byte, double) - Method in class com.reduxrobotics.canand.CanandDevice
-
Fetches a setting from the device and returns the received result.
- forceLoad() - Static method in class com.reduxrobotics.jni.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.
- 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.
- fromIndex(int) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Returns a corresponding color config from the index.
- fromIndex(int) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
Returns a corresponding opcode from the given index.
- fromIndex(int) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Fetches the enum associated with the index value.
- fromIndex(int) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
Fetches the enum associated with the index value.
- fromIndex(int) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Fetches the enum associated with the index value.
- fromIndex(int) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Fetches the enum associated with the index value.
- fromSettingData(long) - Static method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Deserializes a 48-bit setting value into a
CanandcolorDigoutSlot
object.
G
- getAbsPosition() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Gets the current absolute position of the encoder, in a scaled value from 0 inclusive to 1 exclusive.
- getAbsPositionFrame() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Returns the current absolute position frame.
- getActiveFaults() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Returns an object representing currently active faults.
- getActiveFaults() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
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.canandcoder.Canandcoder
- getAddress() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
- 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 5-bit API index from a full message id.
- getArg1() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Gets the slot's 16-bit arg1 value.
- getArg2() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Gets the slot's 16-bit arg2 value.
- getBlue() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Blue intensity, normalized [0..1) where 0 is none and 1 is as bright as possible.
- getBus() - Method in class com.reduxrobotics.canand.CanandMessage
-
Gets an object representing the CAN bus that received the message
- getClauseJoin() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Gets if the slot joins with the next slot to form a clause
- getClauseOperator() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Gets whether the slot's value is ANDed or ORed with the next slot if forming a clause
- getColor() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Returns a CanandcolorColor object which can also convert to HSV.
- getColorConfig() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets the device's sampling/integration period for the color sensor, if set.
- getColorFrame() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Returns the color reading frame, which includes CAN timestamp data.
- getColorFramePeriod() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets the color frame period in seconds [0..65.535], or null if the value has not been set on this object.
- 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.
- 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.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.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
- getDigoutConditionSlotValue(CanandcolorDigitalOutput, int) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutState
-
Gets the output value of a specific condition slot contributing to a digital output.
- getDigoutFrame() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Returns the digital output state frame, which includes CAN timestamp data.
- getDigoutFramePeriod() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets the digout status frame period in seconds [0..65.535], or null if the value has not been set on this object.
- getDigoutPinEnabled(CanandcolorDigitalOutput) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets if output for the specified digout pin is enabled.
- getDigoutPinNormallyClosed(CanandcolorDigitalOutput) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets if output for the specified digout pin is set to normally closed (high logic level) operation.
- getDigoutSlot(CanandcolorDigitalOutput, int) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Fetches a digout slot's configuration with a default 50 ms timeout.
- getDigoutSlot(CanandcolorDigitalOutput, int, double) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Fetches a digout slot's configuration.
- getDigoutState() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Returns a CanandcolorDigoutState object representing the current state of the digital outputs.
- getDigoutValue(CanandcolorDigitalOutput) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutState
-
Gets the output value of either digital output, which corresponds to what the Canandcolor is outputting on those pads.
- getDisableZeroButton() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
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).
- getEnabled() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Gets whether or not the slot is enabled.
- getExtractOnStaticLoad() - Static method in class com.reduxrobotics.jni.ReduxJNI.Helper
-
Internal use method
- getField() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns the internal integer representation of the proximity config which gets written over the wire to the device.
- getFilteredMap() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Return a direct filtered view of settings values as a new HashMap, limited to only valid settings.
- getFilteredMap() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Return a direct filtered view of settings values as a new HashMap, limited to only valid settings.
- getFrameData() - Method in class com.reduxrobotics.frames.Frame
-
Returns an immutable FrameData<T> class containing both value and timestamp.
- getFramePeriodLatencyAdjustment() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets whether or not to transmit frame periods early if data has just been received.
- getGreen() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Green intensity, normalized [0..1) where 0 is none and 1 is as bright as possible.
- getHighGainMode() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns whether or not high gain mode is enabled or not.
- getId() - Method in class com.reduxrobotics.canand.CanandMessage
-
Gets the full 29-bit CAN message id.
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Gets the corresponding index for the value in question.
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Returns the associated index number for the enum (used in serialization)
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
Returns the associated index number for the enum (used in serialization)
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
Gets the corresponding index for the value in question.
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Fetches the index associated with the enum.
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
Fetches the index associated with the enum.
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Fetches the index associated with the enum.
- getIndex() - Method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Fetches the index associated with the enum.
- getInstance() - Static method in class com.reduxrobotics.canand.CanandEventLoop
-
Returns a handle to the event loop.
- getIntegrationPeriod() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns the sensor integration period associated with this proximity config
- getInvertDirection() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Gets whether or not the encoder has an inverted direction (false for no, true for yes, null for unset).
- getLampLED() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets whether or not the onboard lamp LED setting is to be on.
- getLEDCurrent() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns the sensor LED current associated with this proximity config
- getLength() - Method in class com.reduxrobotics.canand.CanandMessage
-
Gets the length of the CAN message's data in bytes.
- getListeners() - Method in class com.reduxrobotics.canand.CanandEventLoop
-
Returns the current list of listeners
- getMap() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Directly access the underlying
Map
of settings values. - getMap() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Directly access the underlying
Map
of settings values. - getMultiPulse() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns the sensor multi-pulse value associated with this proximity config
- getOffsetCancellationValue() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns the 12-bit offset that is subtracted from readings to compensate for ambient IR.
- getOpcode() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Gets the slot's opcode (which determines what it does)
- getPosition() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Gets the current integrated relative position in rotations.
- getPositionFrame() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Returns the current relative position frame.
- getPositionFramePeriod() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Gets the position frame period in seconds [0..65.535], or null if the value has not been set on this object.
- getProdId(int) - Static method in class com.reduxrobotics.canand.CanandUtils
-
Extracts 5-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.
- getProductId() - Method in class com.reduxrobotics.canand.CanandMessage
-
Gets the 5-bit Product ID / API class.
- getProximity() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Gets the currently sensed proximity normalized between [0..1].
- getProximityConfig() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets whether or not the onboard lamp LED setting is to be on.
- getProximityFrame() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Returns the proximity reading frame.
- getProximityFramePeriod() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets the proximity frame period in seconds [1..65.535], or null if the value has not been set on this object.
- getRed() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Red intensity, normalized [0..1) where 0 is none and 1 is as bright as possible.
- getRioBus() - Static method in class com.reduxrobotics.canand.CANBus
-
Returns a CANBus object representing the roboRIO's onboard bus.
- getSamplingPeriod() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns the sampling period associated with this proximity config
- getSettings() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Fetches the Canandcoder's current configuration in a blocking manner.
- getSettings() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Fetches the Canandcolor's current configuration in a blocking manner.
- getSettings(double) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Fetches the Canandcoder's current configuration in a blocking manner.
- getSettings(double) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Fetches the Canandcolor's current configuration in a blocking manner.
- getSettingsAsync() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Non-blockingly returns a
CanandcoderSettings
object of the most recent known settings values received from the encoder. - getSettingsAsync() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Non-blockingly returns a
CanandcolorSettings
object of the most recent known settings values received from the device. - getStatusFrame() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Returns the current status frame, which includes CAN timestamp data.
- getStatusFrame() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Returns the current status frame, which includes CAN timestamp data.
- getStatusFramePeriod() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Gets the status frame period in seconds [1..65.535], or null if the value has not been set on this object.
- getStatusFramePeriod() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Gets the status frame period in seconds [1..65.535], or null if the value has not been set on this object.
- getStickyFaults() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Returns sticky faults.
- getStickyFaults() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Returns sticky faults.
- getSunlightCancellation() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Returns whether or not sunlight cancellation is enabled or not.
- getTemperature() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Get onboard encoder temperature readings in degrees Celsius.
- getTemperature() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Get onboard device 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.
- 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
- getVelocity() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Returns the measured velocity in rotations per second.
- getVelocityFilterWidth() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
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.canandcoder.Canandcoder
-
Returns the current velocity frame, which includes CAN timestamp data.
- getVelocityFramePeriod() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Gets the velocity frame period in seconds [0..65.535], or null if the value has not been set on this object.
- getWhite() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
White intensity, normalized [0..1) This can be used as a proxy for proximity at ranges too close for the normmal proximity sensor to give useful values.
- green() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns the value of the
green
record component.
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.canandcoder.Canandcoder
- handleMessage(CanandMessage) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
- handleSettingRecv(byte, long) - Method in class com.reduxrobotics.canand.CanandDevice
-
Method to be called in a
CanandDevice.handleMessage(com.reduxrobotics.canand.CanandMessage)
implementation to notifyCanandDevice.confirmSetSetting(byte,long,double)
calls of a setting value receipt. - hardwareFault() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
Returns the hardware fault flag, which will raise if a hardware issue is detected.
- hardwareFaultColor() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorFaults
-
Returns the color sensor hardware fault flag, which will raise if the color sensor is unreadable.
- hardwareFaultProximity() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorFaults
-
Returns the proximity sensor hardware fault flag, which will raise if the proximity sensor is unreadable.
- 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.
- hashCode() - Method in record class com.reduxrobotics.sensors.canandcoder.CanandcoderStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorStatus
-
Returns a hash code value for this object.
- Helper() - Constructor for class com.reduxrobotics.jni.ReduxJNI.Helper
- hue() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns hue (0-1) in HSV colorspace.
I
- idMatches(int, int, int, int) - Static method in class com.reduxrobotics.canand.CanandUtils
-
Checks if a full CAN id will match against device type, product id, and device id We use this to determine if a message is intended for a specific device.
- init() - Static method in class com.reduxrobotics.jni.ReduxJNI
-
Starts the Redux CANlink server -- not usually needed to be called manually.
- isPresent() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Checks whether or not the Canandcoder has sent a message within the last 2000 milliseconds.
- isPresent() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Checks whether or not the device has sent a message within the last 2000 milliseconds.
- isPresent(double) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Checks whether or not the Canandcoder has sent a message within the last timeout seconds.
- isPresent(double) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Checks whether or not the device has sent a message within the last timeout seconds.
K
- k100us - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Uses a 100 microsecond period for IR pulse.
- k10mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
10 milliamp LED current.
- k10ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Sample the proximity sensor every 10 ms.
- k1280ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Sample the color sensor every 1280 ms.
- k12mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
12 milliamp LED current.
- k14mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
14 milliamp LED current.
- k160ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Sample the color sensor every 160 ms.
- k16mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
16 milliamp LED current.
- k18mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
18 milliamp LED current.
- k1Pulse - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Use 1 pulse.
- k200us - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Uses a 200 microsecond period for IR pulse.
- k20mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
20 milliamp LED current.
- k20ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Sample the proximity sensor every 20 ms.
- k25us - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Uses a 25 microsecond period for IR pulse.
- k2Pulse - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Use 2 pulses.
- k320ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Sample the color sensor every 320 ms.
- k400us - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Uses a 400 microsecond period for IR pulse.
- k40ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Sample the color sensor every 40 ms.
- k40ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Sample the proximity sensor every 40 ms.
- k4Pulse - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Use 4 pulses.
- k50us - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Uses a 50 microsecond period for IR pulse.
- k640ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Sample the color sensor every 640 ms.
- k6mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
6 milliamp LED current.
- k80ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Sample the color sensor every 80 ms.
- k80ms - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Sample the proximity sensor every 80 ms.
- k8mA - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
8 milliamp LED current.
- k8Pulse - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Use 8 pulses.
- kAndWithNextSlot - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseOperator
-
Logical AND this slot's value with the next slot's value
- kBlue - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
Blue reading
- kCountsPerRotation - Static variable in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Conversion factor for number of position packet ticks per rotation.
- kCountsPerRotationPerSecond - Static variable in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Conversion factor from velocity packet ticks per second to rotations per second.
- kDigout1 - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigitalOutput
-
Enum representing the pad silkscreened as OUT1 on the Canandcolor.
- kDigout2 - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigitalOutput
-
Enum representing the pad silkscreened as OUT2 on the Canandcolor.
- kEqAffine - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
equals affine
- kEqImmidiate - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
equals immidiate
- kEquals - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Equals
- kGeqAffine - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
greater than or equals affine
- kGeqImmidiate - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
greater than or equals immidiate
- kGreaterThan - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Greater than
- kGreaterThanOrEquals - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Greater than or equals
- kGreen - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
Green reading
- kGtAffine - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
greater than affine
- kGtImmidiate - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
greater than immidiate
- kJoinWithNextSlot - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseJoin
-
Join with the next slot using either logical AND or OR
- kLeqAffine - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
less than or equals affine
- kLeqImmidiate - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
less than or equals immidiate
- kLessThan - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Less than
- kLessThanOrEquals - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Less than or equals
- kLtAffine - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
less than affine
- kLtImmidiate - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
less than immidiate
- kMsg_ClearStickyFaults - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
Message id for clear device sticky faults
- kMsg_ClearStickyFaults - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for clear device sticky faults
- kMsg_ClearStickyFaults - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for Clear device sticky faults
- kMsg_ColorOutput - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for Color frame
- kMsg_DigitalOutput - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for Digital output frame
- kMsg_PartyMode - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
Message id for party mode
- kMsg_PartyMode - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for party mode
- kMsg_PartyMode - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for Party mode
- kMsg_PositionOutput - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for Position frame
- kMsg_ProximityOutput - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for Proximity frame
- kMsg_RawPositionOutput - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for Raw position frame
- kMsg_ReportSetting - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
Message id for setting value report from device
- kMsg_ReportSetting - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for setting value report from device
- kMsg_ReportSetting - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for setting value report from device
- kMsg_SetSetting - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
Message id for update setting on device
- kMsg_SetSetting - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for update setting on device
- kMsg_SetSetting - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for update setting on device
- kMsg_SettingCommand - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
Message id for setting control command
- kMsg_SettingCommand - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for setting control command
- kMsg_SettingCommand - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for setting control command
- kMsg_Status - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
Message id for status frames
- kMsg_Status - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for status frames
- kMsg_Status - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Message index for Status frame
- kMsg_VelocityOutput - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
Message id for Velocity frame
- kOrWithNextSlot - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseOperator
-
Logical OR this slot's value with the next slot's value
- kPrevClauseTrue - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
previous clause true
- kPrevSlotTrue - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
previous slot true
- kProximity - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
Proximity value
- kRed - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
Red reading
- kStg_ColorFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Color frame period (ms)
- kStg_ColorIntegrationPeriod - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Color integration period
- kStg_Digout1Config - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Digout1 config slot base address
- kStg_Digout1ControlConfig - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Digital output 1 control config
- kStg_Digout2Config - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Digout2 config slot base address
- kStg_Digout2ControlConfig - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Digital output 2 control config
- kStg_DigoutFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Digout frame period (ms)
- kStg_DisableZeroButton - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Disable the zero button
- kStg_FirmwareVersion - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Firmware version
- kStg_FramePeriodLatencyAdjust - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Enable frame period latency adjustment
- kStg_InvertDirection - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Invert direction (use cw instead of ccw)
- kStg_LampEnable - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Lamp LED enable
- kStg_PositionFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Position frame period (ms)
- kStg_ProximityFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Proximity frame period (ms)
- kStg_ProximitySensorConfig - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Proximity sensor IC configuration
- kStg_RawPositionFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Raw position frame period (ms)
- kStg_RelativePosition - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Relative position value
- kStg_SerialNumber - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Serial number
- kStg_StatusFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for status frame period (ms)
- kStg_StatusFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting index for Status frame period (ms)
- kStg_VelocityFramePeriod - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Velocity frame period (ms)
- kStg_VelocityWindow - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Velocity window width (value*250us)
- kStg_ZeroOffset - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting id for Encoder zero offset
- kStgCmd_ClearDigout1 - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting command index for Clear all digout1 slots
- kStgCmd_ClearDigout2 - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting command index for Clear all digout2 slots
- kStgCmd_FetchSettings - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
setting command for Fetch all settings from device
- kStgCmd_FetchSettings - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting command for Fetch all settings from device
- kStgCmd_FetchSettings - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting command index for Fetch all settings from device
- kStgCmd_FetchSettingValue - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
setting command for Fetch individual setting
- kStgCmd_FetchSettingValue - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting command for Fetch individual setting
- kStgCmd_FetchSettingValue - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting command index for Fetches a single setting from device
- kStgCmd_ResetFactoryDefault - Static variable in class com.reduxrobotics.canand.CanandDeviceDetails
-
setting command for Reset everything to factory default
- kStgCmd_ResetFactoryDefault - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting command for Reset everything to factory default
- kStgCmd_ResetFactoryDefault - Static variable in class com.reduxrobotics.sensors.canandcolor.CanandcolorDetails
-
Setting command index for Reset settings to factory default
- kStgCmd_ResetFactoryDefaultKeepZero - Static variable in class com.reduxrobotics.sensors.canandcoder.CanandcoderDetails
-
setting command for Factory defaults, but keep the encoder zero offset
- kTerminateClause - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseJoin
-
Do not join with the next slot.
- kWhite - Enum constant in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
White reading
L
- 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.canandcoder.Canandcoder
-
Returns whether the encoder magnet is in range of the sensor or not.
- magnetInRange() - Method in record class com.reduxrobotics.sensors.canandcoder.CanandcoderStatus
-
Returns the value of the
magnetInRange
record component. - magnetOutOfRange() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
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
- 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
O
- outOfTemperatureRange() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
Returns the temperature range flag, which will raise if the encoder is not between 0-70 degrees Celsius.
- outOfTemperatureRange() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorFaults
-
Returns the temperature range flag, which will raise if the device is not between 0-70 degrees Celsius.
P
- position - Variable in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
internal Frame variable holding current relative position state
- powerCycle() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
Returns the power cycle fault flag, which is set to true when the encoder first boots.
- powerCycle() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorFaults
-
Returns the power cycle fault flag, which is set to true when the device first boots.
- prevClauseTrueFor(double) - Static method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Returns a new
CanandcolorDigoutSlot
object for a slot that is true if the previous clause has been true for a certain period of time. - prevSlotTrueFor(double) - Static method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Returns a new
CanandcolorDigoutSlot
object for a slot that is true if the previous slot has been true for a certain period of time. - proximity - Variable in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
internal Frame variable holding current proximity state
R
- red() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns the value of the
red
record component. - ReduxJNI - Class in com.reduxrobotics.jni
-
Java side of the Redux device driver JNI wrapper.
- ReduxJNI() - Constructor for class com.reduxrobotics.jni.ReduxJNI
- ReduxJNI.Helper - Class in com.reduxrobotics.jni
-
Internal use class.
- removeListener(CanandDevice) - Method in class com.reduxrobotics.canand.CanandEventLoop
-
Removes a listener for CAN messages, if it is in fact listening.
- resetFactoryDefaults() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Resets the device to factory defaults, waiting up to 500 ms to confirm the settings changes.
- resetFactoryDefaults(boolean) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
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.canandcoder.Canandcoder
-
Resets the encoder to factory defaults.
- resetFactoryDefaults(double) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Resets the Canandcolor to factory defaults.
- run() - Method in class com.reduxrobotics.canand.CanandEventLoop
S
- sat() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns saturation (0-1) in HSV colorspace.
- 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(CANBus, int, byte[]) - Static method in class com.reduxrobotics.jni.ReduxJNI
-
Sends a CAN message.
- sendSettingCommand(byte) - Method in class com.reduxrobotics.canand.CanandDevice
-
Sends a setting command with no arguments.
- setAbsPosition(double) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Sets the new absolute position value for the encoder which will persist across reboots with default timeout of 50 ms
- setAbsPosition(double, double) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Sets the new absolute position value for the encoder which will persist across reboots
- setArg1(int) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Sets the slot's 16-bit arg1 value.
- setArg2(int) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Sets the slot's 16-bit arg2 value.
- setClauseJoin(CanandcolorDigoutSlot.ClauseJoin) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Sets if the slot joins with the next slot to form a clause
- setClauseOperator(CanandcolorDigoutSlot.ClauseOperator) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Sets whether the slot's value is ANDed or ORed with the next slot if forming a clause
- setColorConfig(CanandcolorColorPeriod) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets the sampling/integration period for the color sensor.
- setColorFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets the color frame period in seconds.
- setDigoutFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets the digital output (digout) frame period in seconds.
- setDigoutPinEnabled(CanandcolorDigitalOutput, boolean) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets whether to enable output on a digital output pin.
- setDigoutPinNormallyClosed(CanandcolorDigitalOutput, boolean) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets whether to default to normally open or normally closed on a digital output pin.
- setDigoutSlot(CanandcolorDigitalOutput, int, CanandcolorDigoutSlot) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Sets an indexed slot on a Canandcolor digital output with a default 50 ms timeout.
- setDigoutSlot(CanandcolorDigitalOutput, int, CanandcolorDigoutSlot, double) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Sets an indexed slot on a Canandcolor digital output.
- setDisableZeroButton(boolean) - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Sets whether or not the sensor should disallow zeroing and factory resets from the onboard button.
- setEnabled(boolean) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Sets whether or not the slot is enabled.
- setExtractOnStaticLoad(boolean) - Static method in class com.reduxrobotics.jni.ReduxJNI.Helper
-
Internal use method
- setFramePeriodLatencyAdjustment(boolean) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets whether or not to transmit frame periods early if data has just been received.
- setHighGainMode(boolean) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Sets whether to use high gain mode.
- setIntegrationPeriod(CanandcolorProximityConfig.IntegrationPeriod) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Sets the proximity sensor integration period config.
- setInvertDirection(boolean) - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Inverts the direction read from the sensor.
- setLampLED(boolean) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Sets whether or not the onboard lamp LED is to be powered.
- setLampLED(boolean) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets whether or not the onboard lamp LED is to be powered.
- setLEDCurrent(CanandcolorProximityConfig.LEDCurrent) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Sets the proximity sensor LED currentconfig.
- setMultiPulse(CanandcolorProximityConfig.MultiPulse) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Sets the proximity sensor multi-pulse config.
- setOffsetCancellationValue(int) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Sets a fixed 12-bit value to subtract from readings to compensate for ambient IR.
- setOpcode(CanandcolorDigoutSlot.Opcode) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Sets the slot's opcode (which determines what it does)
- setPartyMode(int) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Controls "party mode" -- an encoder identification tool that blinks the onboard LED various colors at a user-specified strobe period.
- setPartyMode(int) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Controls "party mode" -- an device identification tool that blinks the onboard LED various colors at a user-specified strobe period.
- setPosition(double) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Sets the new relative (multi-turn) position of the encoder to the given value, with a confirmation timeout of 50 ms.
- setPosition(double, double) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Sets the new relative (multi-turn) position of the encoder to the given value.
- setPositionFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Sets the position frame period in seconds.
- setProximityConfig(CanandcolorProximityConfig) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets fine-tuned settings for the proximity sensor through values in a
CanandcolorProximityConfig
object. - setProximityFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets the proximity frame period in seconds.
- setSamplingPeriod(CanandcolorProximityConfig.SamplingPeriod) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Sets the proximity sensor sampling period config.
- setSettingById(int, byte[]) - Method in class com.reduxrobotics.canand.CanandDevice
-
Directly sends a CAN message to a
CanandDevice
to set a setting by index. - setSettingById(int, long) - Method in class com.reduxrobotics.canand.CanandDevice
-
Directly sends a CAN message to a
CanandDevice
to set a setting by index. - setSettings(CanandcoderSettings) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Applies the settings from a
CanandcoderSettings
object to the Canandcoder. - setSettings(CanandcoderSettings, double) - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Applies the settings from a
CanandcoderSettings
object to the Canandcoder. - setSettings(CanandcolorSettings) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Applies the settings from a
CanandcolorSettings
object to the device. - setSettings(CanandcolorSettings, double) - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Applies the settings from a
CanandcolorSettings
object to the device. - setStatusFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Sets the status frame period in seconds.
- setStatusFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorSettings
-
Sets the status frame period in seconds.
- setSunlightCancellation(boolean) - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig
-
Sets whether to use sunlight cancellation.
- setVelocityFilterWidth(double) - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Sets the velocity filter width in milliseconds to sample over.
- setVelocityFramePeriod(double) - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderSettings
-
Sets the velocity frame period in seconds.
- signExtend(BitSet, int) - Static method in class com.reduxrobotics.canand.CanandUtils
- startFetchSettings() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
Tells the Canandcoder to begin transmitting its settings; once they are all transmitted (after ~200-300ms), the values can be retrieved from
Canandcoder.getSettingsAsync()
- startFetchSettings() - Method in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
Tells the Canandcolor to begin transmitting its settings; once they are all transmitted (after ~200-300ms), the values can be retrieved from
Canandcolor.getSettingsAsync()
- status - Variable in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
internal Frame variable holding current status value state
- status - Variable in class com.reduxrobotics.sensors.canandcolor.Canandcolor
-
internal Frame variable holding current status value state
- stickyFaults() - Method in record class com.reduxrobotics.sensors.canandcoder.CanandcoderStatus
-
Returns the value of the
stickyFaults
record component. - stickyFaults() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorStatus
-
Returns the value of the
stickyFaults
record component.
T
- temperature() - Method in record class com.reduxrobotics.sensors.canandcoder.CanandcoderStatus
-
Returns the value of the
temperature
record component. - temperature() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorStatus
-
Returns the value of the
temperature
record component. - toSettingData() - Method in class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot
-
Serializes the
CanandcolorDigoutSlot
to a value that can be written in a set settings packet. - toString() - Method in record class com.reduxrobotics.sensors.canandcoder.CanandcoderStatus
-
Returns a string representation of this record class.
- toString() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns a string representation of this record class.
- toString() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorStatus
-
Returns a string representation of this record class.
- toWpilibColor() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Converts to a WPILib
Color
object.
U
- underVolt() - Method in class com.reduxrobotics.sensors.canandcoder.CanandcoderFaults
-
Returns the undervolt flag, which will raise if the encoder is experiencing brownout conditions.
- 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(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.
V
- value() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns value (0-1) in HSV color space.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigitalOutput
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseJoin
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseOperator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorColorPeriod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigitalOutput
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseJoin
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.ClauseOperator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Comparison
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.DataSource
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorDigoutSlot.Opcode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.IntegrationPeriod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.LEDCurrent
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.MultiPulse
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.reduxrobotics.sensors.canandcolor.CanandcolorProximityConfig.SamplingPeriod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- velocity - Variable in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
internal Frame variable holding current velocity state
W
- waitForCANMessage(ByteBuffer) - Static method in class com.reduxrobotics.jni.ReduxJNI
-
Don't use this function directly -- use CanandDevice with CanandEventLoop instead!!! Blocks until a new CAN message is returned.
- waitForFrames(double, Frame<?>...) - Static method in class com.reduxrobotics.frames.Frame
-
Waits for all Frames to have transmitted a value.
- white() - Method in record class com.reduxrobotics.sensors.canandcolor.CanandcolorColor
-
Returns the value of the
white
record component.
Z
- zeroAll() - Method in class com.reduxrobotics.sensors.canandcoder.Canandcoder
-
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.canandcoder.Canandcoder
-
Sets both the current absolute and relative encoder position to 0 -- generally equivalent to pressing the physical zeroing button on the encoder.
All Classes and Interfaces|All Packages|Constant Field Values