Package com.qualcomm.robotcore.hardware
RobotCore hardware library.
Contains libraries for working with gamepads, DC motor controllers, servo controllers, and more.
-
Interface Summary Interface Description AccelerationSensor Acceleration SensorAnalogInputController Interface for working with Analog ControllersAnalogSensor Instances of this interface are sensors whose input is reported as a voltage level to an analog to digital converter.Blinker Blinker
provides the means to control an LED or a light that can be illuminated in a sequenced pattern of colors and durations.ColorRangeSensor Color Range SensorColorSensor Color SensorCompassSensor Compass SensorCRServo CRServo is the central interface supported by continuous rotation servosDcMotor DcMotor interface provides access to full-featured motor functionality.DcMotorController Interface for working with DC Motor ControllersDcMotorControllerEx DcMotorControllerEx is an optional motor controller interface supported by some hardware that provides enhanced motor functionality.DcMotorEx The DcMotorEx interface provides enhanced motor functionality which is available with some hardware devices.DcMotorSimple Instances of DcMotorSimple interface provide a most basic motor-like functionalityDeviceManager DigitalChannel DigitalChannel
is an interface by which digital channels can be controlled.DigitalChannelController Interface for working with Digital Channel ControllersDistanceSensor TheDistanceSensor
may be found on hardware sensors which measure distance by one means or another.Engagable The engageable interface can be used to temporarily disengage higher-level hardware objects from the services they manipulate, then later be able to re-engage them.Gyroscope TheGyroscope
interface exposes core, fundamental functionality that is applicable to all gyroscopes: that of reporting angular rotation rate.GyroSensor Gyro SensorHardwareDevice Interface used by Hardware DevicesHardwareDeviceCloseOnTearDown Instances ofHardwareDeviceCloseOnTearDown
are those which should be automatically closed when we we 'teardown' a robotHardwareDeviceHealth HardwareDeviceHealth
provides an indication of the perceived health of a hardware deviceI2cAddrConfig I2cAddrConfig
allows the runtime I2C address used with a sensor to be changed or queried.I2cAddressableDevice I2cAddressableDevice
provides a means by which the address of a device living on an I2C bus can be retrieved.I2cDevice TheI2cDevice
interface abstracts the engine used to interact on with a specific I2c deviceI2cDeviceSynch I2cDeviceSynch
is an interface that exposes functionality for interacting with I2c devices.I2cDeviceSynchReadHistory I2cDeviceSynchReadHistory
provides a means by which one can be guaranteed to be informed of all data read by through anI2cDeviceSynch
.I2cDeviceSynchSimple I2cDeviceSyncSimple is an interface that provides simple synchronous read and write functionality to an I2c device.IMU An Inertial Measurement Unit that provides robot-centric orientation and angular velocity.ImuOrientationOnRobot Defines how an IMU is oriented relative to the robot.IntegratingGyroscope For gyroscopes which perform angular rotation rate integration inside the sensor,IntegratingGyroscope
provides a means by which the integrated rotation can be easily retrieved.IrSeekerSensor IR Seeker SensorLight Light
instances are sources of illumination.LightSensor Light SensorNormalizedColorSensor NormalizedColorSensor
returns color sensor data in standardized units, which provides a measure of absolute color color intensity beyond the relative intensities available usingColorSensor
.OpticalDistanceSensor OpticalDistanceSensor
is aLightSensor
whose reported light intensities reflect (pun intended) a relationship to distance.OrientationSensor OrientationSensor
provides access to sensors which measure absolute orientationPwmControl For hardware devices which are manipulated using a pulse width modulation (PWM) signal, thePwmControl
interface provides control of the width of pulses used and whether the PWM is enabled or disabled.PWMOutput Created by bob on 2016-03-12.PWMOutputController Interface for working with PWM Input ControllersPWMOutputControllerEx Created by bob on 2016-03-12.PWMOutputEx Created by bob on 2016-03-12.RobotConfigNameable RobotConfigNameable
provides access to the name by which a device has been configured within a robot configurationRobotCoreLynxController RobotCoreLynxController
is the view of a LynxController available at the RobotCore layer.RobotCoreLynxModule RobotCoreLynxModule
is the view of a Lynx Module available at the RobotCore layer.RobotCoreLynxUsbDevice RobotCoreLynxUsbDevice is the subset of the functionality of the LynxUsbDevice which is accessible from the RobotCore subsystem.Servo Instances of Servo interface provide access to servo hardware devices.ServoController Interface for working with Servo ControllersServoControllerEx ServoControllerEx is an optional servo controller interface supported by some hardware that provides enhanced servo functionality.SwitchableLight SwitchableLight
instances areLight
s whose on/off status can be programmatically manipulated.TouchSensor TouchSensor
models a button.TouchSensorMultiplexer NXT Touch Sensor Multiplexer.UltrasonicSensor VisuallyIdentifiableHardwareDevice VoltageSensor Voltage Sensor -
Class Summary Class Description AnalogInput Control a single analog deviceBlinker.Step Blinker.Step
represents a particular color held for a particular length of time.CRServoImpl ContinuousRotationServoImpl provides an implementation of continuous rotation servo functionality.CRServoImplEx CRServoEx provides access to extended functionality on continuous rotation servos.DcMotorImpl Control a DC Motor attached to a DC Motor ControllerDcMotorImplEx DigitalChannelImpl Control a single digital channelEmbeddedControlHubModule EmbeddedControlHubModule
provides easy access to the Lynx module embedded in the Control Hub via a singletonGamepad Monitor a hardware gamepad.Gamepad.LedEffect Gamepad.LedEffect.Builder Gamepad.LedEffect.Step Gamepad.RumbleEffect Gamepad.RumbleEffect.Builder Gamepad.RumbleEffect.Step HardwareDeviceHealthImpl HardwareDeviceHealthImpl
provides a delegatable-to implemenatation of HardwareDeviceHealthHardwareMap HardwareMap provides a means of retrieving runtime HardwareDevice instances according to the names with which the corresponding physical devices were associated during robot configuration.HardwareMap.DeviceInstanceHolder HardwareMap.DeviceInstancesFromSingleConfigEntry ALL device instances in this data structure come from the SAME configuration entry.I2cAddr I2cAddr represents an address on an I2C bus.I2cDeviceSynch.HeartbeatAction Instances of HeartBeatAction indicate what action to carry out to perform a heartbeat should that become necessary.I2cDeviceSynch.ReadWindow RegWindow is a utility class for managing the window of I2C register bytes that are read from our I2C device on every hardware cycleI2cDeviceSynchDevice<DEVICE_CLIENT extends I2cDeviceSynchSimple> I2cDeviceSynchDevice
instances are I2c devices which are built on top of I2cDeviceSynchSimple instances or subclasses thereof.I2cDeviceSynchDeviceWithParameters<DEVICE_CLIENT extends I2cDeviceSynchSimple,PARAMETERS> I2cDeviceSynchDeviceWithParameters
adds toI2cDeviceSynchDevice
support for sensors that can be publicly initialized with a particular parameters class.I2cDeviceSynchImplOnSimple I2cDeviceSynchImplOnSimple takes an I2cDeviceSynchSimple and adds to it heartbeat and readwindow functionality.I2cDeviceSynchReadHistoryImpl I2cDeviceSynchReadHistoryImpl
is a helper class providing an implementation of the I2c read history queueI2cWarningManager IMU.Parameters Settings to change the IMU's behavior.IrSeekerSensor.IrSeekerIndividualSensor IR Sensor attached to an IR SeekerLED LightBlinker ALightBlinker
is a handy utility that will flash aSwitchableLight
in a pattern of timed durations, and, optionally, colors, if the light supports same (NYI)LightMultiplexor ALightMultiplexor
adapts a secondSwitchableLight
by adding reference counting toSwitchableLight.enableLight(boolean)
: the light will be lit if the net number of enables is greater than zero.LynxModuleDescription A description of the properties that you'd like the LynxModule instance returned by LynxUsbDevice#getOrAddModule() to haveLynxModuleDescription.Builder LynxModuleMeta LynxModuleMeta
has simple lynx module meta information for transmission from RC to DSLynxModuleMetaList LynxModuleMetaList
is a container ofRobotCoreLynxModule
s.NormalizedRGBA NormalizedRGBA
instances represent a set of normalized color values.PIDCoefficients PIDCoefficients
conveys a set of configuration parameters for a PID algorithm.PIDFCoefficients PIDFCoefficients
conveys a set of configuration parameters for a PIDF algorithm, a PID algorithm which includes an additional feed-forward term.PwmControl.PwmRange PwmRange instances are used to specify the upper and lower pulse widths and overall framing rate for a servo.PWMOutputImpl Control a single digital portPWMOutputImplEx Created by bob on 2016-03-12.QuaternionBasedImuHelper ScannedDevices ScannedDevices
is a simple distinguished kind of map of serial numbers to device types.ScannedDevices.MapAdapter There *has* to be an easier way here, somehow.ServoImpl ServoImpl provides an implementation of the Servo interface that operates on top of an instance of the ServoController interface.ServoImplEx ServoImplEx provides access to extended functionality on servos.TimestampedData TimestampedData pairs together data which has been read with the timestamp at which the read occurred, as best that can be determinedTimestampedI2cData TimestampedI2cData
extendsTimestampedData
so as to provide an indication of the I2c source from which the data was retrieved.USBAccessibleLynxModule A simple utility class holding the serial number of a USB accessible lynx module and (optionally) its module address This class should be considered a part of the public JSON API exposed via the webserver -
Enum Summary Enum Description CompassSensor.CompassMode ControlSystem Used to specify what type of control system a particular piece of hardware is connected toDcMotor.RunMode The run mode of a motorDcMotor.RunMode
controls how the motor interprets the it's parameter settings passed through power- and encoder-related methods.DcMotor.ZeroPowerBehavior ZeroPowerBehavior provides an indication as to a motor's behavior when a power level of zero is applied.DcMotorSimple.Direction DcMotors can be configured to internally reverse the values to which, e.g., their motor power is set.DeviceManager.UsbDeviceType Enum of known USB Device TypesDigitalChannel.Mode Digital channel mode - input or outputDigitalChannelController.Mode Deprecated. useDigitalChannel.Mode
insteadGamepad.LegacyType Gamepad.Type HardwareDevice.Manufacturer HardwareDeviceHealth.HealthStatus I2cDeviceSynch.ReadMode I2cDeviceSynch.ReadMode
controls whether when asked to read we read only once or read multiple times.I2cWaitControl Values inI2cWaitControl
control the semantics of waiting on I2c writesIrSeekerSensor.Mode Enumeration of device modesLynxModuleImuType MotorControlAlgorithm MotorControlAlgorithm
indicates the control algorithm variant to use withDcMotor.RunMode.RUN_TO_POSITION
andDcMotor.RunMode.RUN_USING_ENCODER
.Servo.Direction Servos can be configured to internally reverse the values to which their positioning power is set.ServoController.PwmStatus PWM Status - is pwm enabled? -
Exception Summary Exception Description QuaternionBasedImuHelper.FailedToRetrieveQuaternionException