A C D E F G H I J K L M N P R S T V
All Classes All Packages

## A

angle - Variable in class com.studica.frc.Lidar.ScanData
angle - Variable in class com.studica.frc.LidarMini.ScanData
  Angle in degrees [0, 360) for each sample point.
autotuneAll() - Method in class com.studica.frc.Titan
  Trigger PID autotune on all four motor channels simultaneously.

## C

c_closeI2C() - Static method in class com.studica.frc.jni.CobraJNI
c_getRawValue(int) - Static method in class com.studica.frc.jni.CobraJNI
c_getVoltage(int) - Static method in class com.studica.frc.jni.CobraJNI
c_initializeI2C(float) - Static method in class com.studica.frc.jni.CobraJNI
c_Lidar_clusterConfig(float, int) - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_create(int) - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_destroy() - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_enableFilter(int, boolean) - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_getData() - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_jitterConfig(float) - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_kalmanConfig(float, float, float) - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_medianConfig(int) - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_movingAverageConfig(int) - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_start() - Static method in class com.studica.frc.jni.LidarJNI
c_Lidar_stop() - Static method in class com.studica.frc.jni.LidarJNI
c_LidarMini_create(int) - Static method in class com.studica.frc.jni.LidarMiniJNI
  Initialises the serial port and configures it for the T-mini Plus (230 400 baud, 8N1).
c_LidarMini_decreaseFrequency(boolean) - Static method in class com.studica.frc.jni.LidarMiniJNI
  Decreases the scan frequency by one step.
c_LidarMini_destroy() - Static method in class com.studica.frc.jni.LidarMiniJNI
  Stops scanning (if active) and closes the serial port.
c_LidarMini_getData() - Static method in class com.studica.frc.jni.LidarMiniJNI
  Returns a snapshot of the last completed 360Â° scan.
c_LidarMini_getHealth() - Static method in class com.studica.frc.jni.LidarMiniJNI
  Queries the device health status.
c_LidarMini_getInfo() - Static method in class com.studica.frc.jni.LidarMiniJNI
  Queries device information (model, firmware/hardware version, serial number).
c_LidarMini_increaseFrequency(boolean) - Static method in class com.studica.frc.jni.LidarMiniJNI
  Increases the scan frequency by one step.
c_LidarMini_start() - Static method in class com.studica.frc.jni.LidarMiniJNI
  Sends the scan-start command to the T-mini Plus and launches the background packet-parsing thread.
c_LidarMini_stop() - Static method in class com.studica.frc.jni.LidarMiniJNI
  Sends the stop command to the T-mini Plus and shuts down the background thread.
c_MockDS_create() - Static method in class com.studica.frc.jni.MockDSJNI
c_MockDS_destroy() - Static method in class com.studica.frc.jni.MockDSJNI
c_MockDS_disable() - Static method in class com.studica.frc.jni.MockDSJNI
c_MockDS_enable() - Static method in class com.studica.frc.jni.MockDSJNI
c_Titan_autotuneAll(long) - Static method in class com.studica.frc.jni.TitanJNI
  Trigger PID autotune on all four channels simultaneously.
c_Titan_configureMotor(long, int, int) - Static method in class com.studica.frc.jni.TitanJNI
  Configure a motor's PWM frequency.
c_Titan_create(int, int) - Static method in class com.studica.frc.jni.TitanJNI
  Initialise the Titan controller, configure all four motors, and start the single background enable/disable thread.
c_Titan_destroy(long) - Static method in class com.studica.frc.jni.TitanJNI
  Stop the background thread and release the CAN handle.
c_Titan_disableMotor(long, int) - Static method in class com.studica.frc.jni.TitanJNI
  Disable a single motor output.
c_Titan_getControllerTemp(long) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getCypherPosition(long, int) - Static method in class com.studica.frc.jni.TitanJNI
  Read an absolute-encoder (Cypher Max) position.
c_Titan_getEncoderCount(long, int) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getEncoderDistance(long, int) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getEncoderRaw(long, int) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getEncoderSpeed(long, int) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getFirmwareVersion(long) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getFrequency(long) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getHardwareVersion(long) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getID(long) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getLimitSwitch(long, int, boolean) - Static method in class com.studica.frc.jni.TitanJNI
  Read a limit switch state.
c_Titan_getRPM(long, int) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getSerialNumber(long) - Static method in class com.studica.frc.jni.TitanJNI
c_Titan_getTargetRPMFromDevice(long) - Static method in class com.studica.frc.jni.TitanJNI
  Request and read back the target RPM for all four motors.
c_Titan_resetEncoder(long, int) - Static method in class com.studica.frc.jni.TitanJNI
  Zero an encoder's tick count on the controller.
c_Titan_setCurrentLimit(long, int, float) - Static method in class com.studica.frc.jni.TitanJNI
  Set the motor current limit in amperes.
c_Titan_setCurrentLimitMode(long, int, int) - Static method in class com.studica.frc.jni.TitanJNI
  Set the current-limit mode: 0 = disabled, 1 = enabled.
c_Titan_setEncoder(long, int, double) - Static method in class com.studica.frc.jni.TitanJNI
  Store the distance-per-tick conversion factor for an encoder in the native driver.
c_Titan_setEncoderResolution(long, int, int) - Static method in class com.studica.frc.jni.TitanJNI
  Set the encoder counts-per-revolution (CPR).
c_Titan_setMotorSpeed(long, int, double) - Static method in class com.studica.frc.jni.TitanJNI
  Set a motor's output speed.
c_Titan_setMotorStopMode(long, int) - Static method in class com.studica.frc.jni.TitanJNI
  Set the global motor stop behaviour mode.
c_Titan_setPIDType(long, int) - Static method in class com.studica.frc.jni.TitanJNI
  Select PID algorithm type: 0 = standard, 1 = alternate.
c_Titan_setPositionHold(long, int, boolean) - Static method in class com.studica.frc.jni.TitanJNI
  Enable or disable position-hold mode for a motor.
c_Titan_setSensitivity(long, int, int) - Static method in class com.studica.frc.jni.TitanJNI
  Set velocity-control sensitivity [0, 10] for a motor.
c_Titan_setTargetAngle(long, int, double) - Static method in class com.studica.frc.jni.TitanJNI
  Set closed-loop target angle [0.0, 360.0] degrees.
c_Titan_setTargetDistance(long, int, int) - Static method in class com.studica.frc.jni.TitanJNI
  Set closed-loop target distance in encoder counts.
c_Titan_setTargetVelocity(long, int, short) - Static method in class com.studica.frc.jni.TitanJNI
  Set closed-loop target velocity.
c_Titan_tryGetRPM(long, int, short[]) - Static method in class com.studica.frc.jni.TitanJNI
  Non-blocking RPM read.
clusterConfig(float, int) - Method in class com.studica.frc.Lidar
  Configure the Cluster Filter
Cobra - Class in com.studica.frc
  Cobra class c++ documentation
Cobra() - Constructor for class com.studica.frc.Cobra
  Default constructor for Cobra
Cobra(float) - Constructor for class com.studica.frc.Cobra
  Constructor for Cobra
CobraJNI - Class in com.studica.frc.jni
CobraJNI() - Constructor for class com.studica.frc.jni.CobraJNI
com.studica.frc - package com.studica.frc
com.studica.frc.jni - package com.studica.frc.jni
configure(int) - Method in class com.studica.frc.Titan.Motor
  Configure this motor's PWM frequency independently of the others.

## D

decreaseFrequencyHz() - Method in class com.studica.frc.LidarMini
  Decreases the scan frequency by 1 Hz.
decreaseFrequencyTenthHz() - Method in class com.studica.frc.LidarMini
  Decreases the scan frequency by 0.1 Hz.
DEFAULT_FREQUENCY - Static variable in class com.studica.frc.Titan
  Default PWM frequency used when none is specified (Hz).
destroy() - Method in class com.studica.frc.LidarMini
  Stops scanning (if active) and closes the serial port.
destroy() - Method in class com.studica.frc.Titan
  Stop the background thread and release the CAN handle.
disable() - Method in class com.studica.frc.MockDS
  Disable the robot in auto mode
disable() - Method in class com.studica.frc.Titan.Motor
  Disable this motor output (sets it to the controller's disabled state).
distance - Variable in class com.studica.frc.Lidar.ScanData
distance - Variable in class com.studica.frc.LidarMini.ScanData
  Distance in metres for each sample point.

## E

enable() - Method in class com.studica.frc.MockDS
  Enable the robot in auto mode
enableFilter(Lidar.Filter, boolean) - Method in class com.studica.frc.Lidar
  Enables the cluster filter on distance in ScanData
errorCode - Variable in class com.studica.frc.LidarMini.LidarHealth
  Extended error code (consult the T-mini Plus development manual).

## F

firmwareVersion - Variable in class com.studica.frc.LidarMini.LidarInfo
  Combined firmware version word (little-endian: low byte = major, high byte = minor).
FREQ_DEFAULT_HZ - Static variable in class com.studica.frc.LidarMini
  Factory default scan frequency: 6 Hz.
FREQ_MAX_HZ - Static variable in class com.studica.frc.LidarMini
  Maximum scan frequency permitted by the T-mini Plus hardware: 12 Hz.
FREQ_MIN_HZ - Static variable in class com.studica.frc.LidarMini
  Minimum scan frequency permitted by the T-mini Plus hardware: 6 Hz.

## G

get() - Method in class com.studica.frc.Servo
  Gets the servo position
get() - Method in class com.studica.frc.Titan.Encoder
  Returns 0 â€” use `Titan.Encoder.getRaw()` for the actual tick count.
get() - Method in class com.studica.frc.Titan.Motor
getAngle() - Method in class com.studica.frc.Servo
  Gets the servo angle
getControllerTemp() - Method in class com.studica.frc.Titan
getCount() - Method in class com.studica.frc.Titan.Encoder
  Return the raw signed tick count as an `int`.
getCurrentFrequency() - Method in class com.studica.frc.LidarMini
  Returns the current scan frequency as tracked by this driver instance.
getCypherPosition() - Method in class com.studica.frc.Titan.Motor
  Read the Cypher Max absolute-encoder position for this motor's port.
getData() - Method in class com.studica.frc.Lidar
  Gets angle and distance output of Lidar sensor
getData() - Method in class com.studica.frc.LidarMini
  Returns a snapshot of the last completed 360Â° scan.
getDirection() - Method in class com.studica.frc.Titan.Encoder
getDistance() - Method in class com.studica.frc.Titan.Encoder
  Return the accumulated travel distance in the units configured by the `distPerTick` value supplied to `Titan.getEncoder(int, double)`.
getDistanceAt(float, float) - Method in class com.studica.frc.LidarMini.ScanData
  Returns the distance (metres) at the closest angle to `targetDeg`, or `-1.0` if no valid sample is available near that angle.
getEncoder(int, double) - Method in class com.studica.frc.Titan
  Return the `Titan.Encoder` object for the given encoder index.
getEncoderIndex() - Method in class com.studica.frc.Titan.Encoder
getFirmwareMajor() - Method in class com.studica.frc.LidarMini.LidarInfo
  Returns the firmware major version number.
getFirmwareMinor() - Method in class com.studica.frc.LidarMini.LidarInfo
  Returns the firmware minor version number.
getFirmwareVersion() - Method in class com.studica.frc.Titan
getFrequency() - Method in class com.studica.frc.Titan
getHardwareVersion() - Method in class com.studica.frc.Titan
getHealth() - Method in class com.studica.frc.LidarMini
  Queries the T-mini Plus health status.
getID() - Method in class com.studica.frc.Titan
getInfo() - Method in class com.studica.frc.LidarMini
  Queries the T-mini Plus for its model, firmware version, hardware version, and factory serial number.
getInverted() - Method in class com.studica.frc.Titan.Motor
getLimitSwitch(boolean) - Method in class com.studica.frc.Titan.Motor
  Read a limit switch attached to this motor's channel.
getMotor(int) - Method in class com.studica.frc.Titan
  Return the `Titan.Motor` object for the given motor index.
getMotorIndex() - Method in class com.studica.frc.Titan.Motor
getPeriod() - Method in class com.studica.frc.Titan.Encoder
  Not implemented.
getRaw() - Method in class com.studica.frc.Titan.Encoder
  Return the raw signed tick count from the controller.
getRawValue(int) - Method in class com.studica.frc.Cobra
  Gets the raw value of the sensor
getRPM() - Method in class com.studica.frc.Titan.Motor
getSerialNumber() - Method in class com.studica.frc.Titan
getSerialString() - Method in class com.studica.frc.LidarMini.LidarInfo
  Returns the serial number as a hex string (32 hex characters).
getSpeed() - Method in class com.studica.frc.Titan.Encoder
getStopped() - Method in class com.studica.frc.Titan.Encoder
  Not implemented.
getTargetRPMFromDevice() - Method in class com.studica.frc.Titan
  Request and read back the current target RPM for all four motors.
getVoltage(int) - Method in class com.studica.frc.Cobra
  Gets the voltage of the sensor

## H

hardwareVersion - Variable in class com.studica.frc.LidarMini.LidarInfo
  Hardware revision number.

## I

increaseFrequencyHz() - Method in class com.studica.frc.LidarMini
  Increases the scan frequency by 1 Hz.
increaseFrequencyTenthHz() - Method in class com.studica.frc.LidarMini
  Increases the scan frequency by 0.1 Hz.
initSendable(SendableBuilder) - Method in class com.studica.frc.Servo
intensity - Variable in class com.studica.frc.LidarMini.ScanData
  Raw reflectance intensity [0, 255] for each sample point.
invertRPM() - Method in class com.studica.frc.Titan.Motor
  Invert the sign of RPM readings returned by `Titan.Motor.getRPM()`.
invertSpeed() - Method in class com.studica.frc.Titan.Encoder
  Invert the sign of speed readings returned by `Titan.Encoder.getSpeed()`.
isDataOk() - Method in class com.studica.frc.LidarMini.LidarHealth
isEncoderOk() - Method in class com.studica.frc.LidarMini.LidarHealth
isHealthy() - Method in class com.studica.frc.LidarMini.LidarHealth
isLDOk() - Method in class com.studica.frc.LidarMini.LidarHealth
isPDOk() - Method in class com.studica.frc.LidarMini.LidarHealth
isSensorOk() - Method in class com.studica.frc.LidarMini.LidarHealth
isWirelessPowerOk() - Method in class com.studica.frc.LidarMini.LidarHealth

## J

jitterConfig(float) - Method in class com.studica.frc.Lidar
  Configure the jitter filter

## K

kalmanConfig(float, float, float) - Method in class com.studica.frc.Lidar
  Configure the Kalman Filter
kCLUSTER - com.studica.frc.Lidar.Filter
kDefaultMaxServoPWM - Static variable in class com.studica.frc.Servo
kDefaultMinServoPWM - Static variable in class com.studica.frc.Servo
kJITTER - com.studica.frc.Lidar.Filter
kKALMAN - com.studica.frc.Lidar.Filter
kMEDIAN - com.studica.frc.Lidar.Filter
kMOVINGAVERAGE - com.studica.frc.Lidar.Filter
kUSB1 - com.studica.frc.Lidar.Port
kUSB1 - com.studica.frc.LidarMini.Port
kUSB2 - com.studica.frc.Lidar.Port
kUSB2 - com.studica.frc.LidarMini.Port

## L

Lidar - Class in com.studica.frc
  Lidar class Java documentation
Lidar(Lidar.Port) - Constructor for class com.studica.frc.Lidar
  Constructor for Lidar
Lidar.Filter - Enum in com.studica.frc
  kCLUSTER - Cluster Filter
Lidar.Port - Enum in com.studica.frc
  kUSB1 - Top USB2.0 port
Lidar.ScanData - Class in com.studica.frc
  Class to receive Lidar data.
LidarHealth() - Constructor for class com.studica.frc.LidarMini.LidarHealth
LidarInfo() - Constructor for class com.studica.frc.LidarMini.LidarInfo
LidarJNI - Class in com.studica.frc.jni
LidarJNI() - Constructor for class com.studica.frc.jni.LidarJNI
LidarMini - Class in com.studica.frc
  Java driver for the T-mini Plus 360Â° laser range scanner.
LidarMini(LidarMini.Port) - Constructor for class com.studica.frc.LidarMini
  Creates a LidarMini instance, opens the serial port, and performs a brief scan-start â†’ stop wake sequence to bring the T-mini Plus into a responsive idle state.
LidarMini.LidarHealth - Class in com.studica.frc
  Device health status.
LidarMini.LidarInfo - Class in com.studica.frc
  Device information.
LidarMini.Port - Enum in com.studica.frc
  Physical USB port location
LidarMini.ScanData - Class in com.studica.frc
  A single completed 360Â° scan from the T-mini Plus.
LidarMiniJNI - Class in com.studica.frc.jni
  JNI wrapper for T-mini Plus native C++ driver.
LidarMiniJNI() - Constructor for class com.studica.frc.jni.LidarMiniJNI

## M

medianConfig(int) - Method in class com.studica.frc.Lidar
  Configure the median filter
MockDS - Class in com.studica.frc
MockDS() - Constructor for class com.studica.frc.MockDS
  MockDS Constructor
MockDSJNI - Class in com.studica.frc.jni
MockDSJNI() - Constructor for class com.studica.frc.jni.MockDSJNI
model - Variable in class com.studica.frc.LidarMini.LidarInfo
  Device model code.
movingAverageConfig(int) - Method in class com.studica.frc.Lidar
  Configure the moving average Filter

## N

NUM_ENCODERS - Static variable in class com.studica.frc.Titan
  Total number of encoder inputs on the Titan Quad.
NUM_MOTORS - Static variable in class com.studica.frc.Titan
  Total number of motor outputs on the Titan Quad.

## P

pidWrite(double) - Method in class com.studica.frc.Titan.Motor

## R

reset() - Method in class com.studica.frc.Titan.Encoder
  Zero the encoder tick count on the controller.

## S

ScanData() - Constructor for class com.studica.frc.Lidar.ScanData
ScanData() - Constructor for class com.studica.frc.LidarMini.ScanData
serialnum - Variable in class com.studica.frc.LidarMini.LidarInfo
  16-byte factory serial number.
Servo - Class in com.studica.frc
Servo(int) - Constructor for class com.studica.frc.Servo
  Constructor for Servo
ServoContinuous - Class in com.studica.frc
ServoContinuous(int) - Constructor for class com.studica.frc.ServoContinuous
set(double) - Method in class com.studica.frc.Servo
  Sets the position of the servo
set(double) - Method in class com.studica.frc.Titan.Motor
  Set the motor output speed.
setAngle(double) - Method in class com.studica.frc.Servo
  Sets the servo angle
setCurrentLimit(float) - Method in class com.studica.frc.Titan.Motor
  Set the current limit for this motor channel.
setCurrentLimitMode(int) - Method in class com.studica.frc.Titan.Motor
  Set the current-limit enforcement mode for this motor channel.
setEncoderResolution(int) - Method in class com.studica.frc.Titan.Motor
  Set the encoder counts-per-revolution (CPR) for this motor's channel.
setInverted(boolean) - Method in class com.studica.frc.Titan.Motor
setMaxPeriod(double) - Method in class com.studica.frc.Titan.Encoder
  Not implemented.
setMotorStopMode(int) - Method in class com.studica.frc.Titan
  Set the global motor stop behaviour for all channels.
setPIDType(int) - Method in class com.studica.frc.Titan
  Select the PID algorithm type used by the controller.
setPositionHold(boolean) - Method in class com.studica.frc.Titan.Motor
  Enable or disable position-hold mode.
setReverseDirection() - Method in class com.studica.frc.Titan.Encoder
  Reverse the sign of all distance readings from this encoder.
setSensitivity(int) - Method in class com.studica.frc.Titan.Motor
  Set velocity-control sensitivity for this motor.
setTargetAngle(double) - Method in class com.studica.frc.Titan.Motor
  Set closed-loop target angle for a Cypher Max equipped motor.
setTargetDistance(int) - Method in class com.studica.frc.Titan.Motor
  Set closed-loop target distance in encoder counts.
setTargetVelocity(short) - Method in class com.studica.frc.Titan.Motor
  Set closed-loop target velocity (RPM).
size() - Method in class com.studica.frc.LidarMini.ScanData
  Returns the number of sample points in this scan.
start() - Method in class com.studica.frc.Lidar
  Starts the Lidar sensor The constructor by default starts the Lidar sensor
start() - Method in class com.studica.frc.LidarMini
  Sends the scan-start command to the T-mini Plus and launches the background packet-parsing thread.
status - Variable in class com.studica.frc.LidarMini.LidarHealth
  Raw status byte.
stop() - Method in class com.studica.frc.Lidar
  Stops the Lidar sensor
stop() - Method in class com.studica.frc.LidarMini
  Sends the stop command to the T-mini Plus and shuts down the background thread.
stopMotor() - Method in class com.studica.frc.Titan.Motor
  Stop this motor by setting its speed to 0.
StudicaJNIWrapper - Class in com.studica.frc.jni
StudicaJNIWrapper() - Constructor for class com.studica.frc.jni.StudicaJNIWrapper

## T

timestamp - Variable in class com.studica.frc.LidarMini.ScanData
  Nanosecond timestamp (steady clock) when this lap began.
Titan - Class in com.studica.frc
  Motor controller features for Studica Titan Quad motor controllers
Titan(int) - Constructor for class com.studica.frc.Titan
  Initialise the Titan Quad with the default PWM frequency (15600 Hz).
Titan(int, int) - Constructor for class com.studica.frc.Titan
  Initialise the Titan Quad with a custom PWM frequency.
Titan.Encoder - Class in com.studica.frc
  Represents one encoder input on the Titan Quad controller.
Titan.Motor - Class in com.studica.frc
  Represents one motor output on the Titan Quad controller.
TitanJNI - Class in com.studica.frc.jni
  JNI wrapper for the unified Titan motor controller native driver.
TitanJNI() - Constructor for class com.studica.frc.jni.TitanJNI
toString() - Method in class com.studica.frc.LidarMini.LidarHealth
toString() - Method in class com.studica.frc.LidarMini.LidarInfo
tryGetRPM() - Method in class com.studica.frc.Titan.Motor
  Non-blocking RPM read.

## V

value - Variable in enum com.studica.frc.Lidar.Filter
value - Variable in enum com.studica.frc.Lidar.Port
value - Variable in enum com.studica.frc.LidarMini.Port
valueOf(String) - Static method in enum com.studica.frc.Lidar.Filter
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.studica.frc.Lidar.Port
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.studica.frc.LidarMini.Port
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.studica.frc.Lidar.Filter
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.studica.frc.Lidar.Port
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.studica.frc.LidarMini.Port
  Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I J K L M N P R S T V
All Classes All Packages