com.qualcomm.hardware.modernrobotics

Class ModernRoboticsAnalogOpticalDistanceSensor

java.lang.Object

com.qualcomm.hardware.modernrobotics.ModernRoboticsAnalogOpticalDistanceSensor

All Implemented Interfaces:

AnalogSensor, HardwareDevice, LightSensor, OpticalDistanceSensor

@AnalogSensorType
 @DeviceProperties(name="@string/configTypeOpticalDistanceSensor",
                  xmlTag="OpticalDistanceSensor",
                  builtIn=true,
                  description="@string/optical_distance_sensor_description")
public class ModernRoboticsAnalogOpticalDistanceSensor
extends java.lang.Object
implements OpticalDistanceSensor, AnalogSensor

ModernRoboticsAnalogOpticalDistanceSensor supports the Modern Robotics Optical Distance Sensor.

See Also:

MR Optical Distance Sensor

Nested Class Summary

Nested classes/interfaces inherited from interface com.qualcomm.robotcore.hardware.HardwareDevice

HardwareDevice.Manufacturer

Field Summary

Fields

Modifier and Type	Field and Description
protected static double	apiLevelMax
protected static double	apiLevelMin

Constructor Summary

Constructors

Constructor and Description
ModernRoboticsAnalogOpticalDistanceSensor(AnalogInputController analogInputController, int physicalPort)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this device
void	enableLed(boolean enable) Enable the LED light
java.lang.String	getConnectionInfo() Get connection information about this device in a human readable format
java.lang.String	getDeviceName() Returns a string suitable for display to the user as to the type of device.
double	getLightDetected() Get the amount of light detected by the sensor, scaled and cliped to a range which is a pragmatically useful sensitivity.
HardwareDevice.Manufacturer	getManufacturer() Returns an indication of the manufacturer of this device.
double	getMaxVoltage()
double	getRawLightDetected() Returns a signal whose strength is proportional to the intensity of the light measured.
double	getRawLightDetectedMax() Returns the maximum value that can be returned by LightSensor.getRawLightDetected().
int	getVersion() Version
double	readRawVoltage() Returns the sensor's current value as a raw voltage level.
void	resetDeviceConfigurationForOpMode() Resets the device's configuration to that which is expected at the beginning of an OpMode.
java.lang.String	status() Status of this sensor, in string form
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

apiLevelMin

protected static final double apiLevelMin

See Also:

Constant Field Values

apiLevelMax

protected static final double apiLevelMax

See Also:

Constant Field Values

Constructor Detail

ModernRoboticsAnalogOpticalDistanceSensor

public ModernRoboticsAnalogOpticalDistanceSensor(AnalogInputController analogInputController,
                                                 int physicalPort)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLightDetected

public double getLightDetected()

Description copied from interface: LightSensor

Get the amount of light detected by the sensor, scaled and cliped to a range which is a pragmatically useful sensitivity. Note that returned values INCREASE as the light energy INCREASES.

Specified by:

getLightDetected in interface LightSensor

Returns:

amount of light, on a scale of 0.0 to 1.0

getMaxVoltage

public double getMaxVoltage()

getRawLightDetected

public double getRawLightDetected()

Description copied from interface: LightSensor

Returns a signal whose strength is proportional to the intensity of the light measured. Note that returned values INCREASE as the light energy INCREASES. The units in which this signal is returned are unspecified.

Specified by:

getRawLightDetected in interface LightSensor

Returns:

a value proportional to the amount of light detected, in unspecified units

getRawLightDetectedMax

public double getRawLightDetectedMax()

Description copied from interface: LightSensor

Returns the maximum value that can be returned by LightSensor.getRawLightDetected().

Specified by:

getRawLightDetectedMax in interface LightSensor

Returns:

the maximum value that can be returned by getRawLightDetected

See Also:

LightSensor.getRawLightDetected()

readRawVoltage

public double readRawVoltage()

Description copied from interface: AnalogSensor

Returns the sensor's current value as a raw voltage level. Note that for Returns the light level voltage as reported by the sensor. Note that returned values INCREASE as the light energy INCREASES.

Specified by:

readRawVoltage in interface AnalogSensor

Returns:

unscaled / unclipped voltage level reported by the device

enableLed

public void enableLed(boolean enable)

Description copied from interface: LightSensor

Enable the LED light

Specified by:

enableLed in interface LightSensor

Parameters:

enable - true to enable; false to disable

status

public java.lang.String status()

Description copied from interface: LightSensor

Status of this sensor, in string form

Specified by:

status in interface LightSensor

Returns:

status

getManufacturer

public HardwareDevice.Manufacturer getManufacturer()

Description copied from interface: HardwareDevice

Returns an indication of the manufacturer of this device.

Specified by:

getManufacturer in interface HardwareDevice

Returns:

the device's manufacturer

getDeviceName

public java.lang.String getDeviceName()

Description copied from interface: HardwareDevice

Returns a string suitable for display to the user as to the type of device. Note that this is a device-type-specific name; it has nothing to do with the name by which a user might have configured the device in a robot configuration.

Specified by:

getDeviceName in interface HardwareDevice

Returns:

device manufacturer and name

getConnectionInfo

public java.lang.String getConnectionInfo()

Description copied from interface: HardwareDevice

Get connection information about this device in a human readable format

Specified by:

getConnectionInfo in interface HardwareDevice

Returns:

connection info

getVersion

public int getVersion()

Description copied from interface: HardwareDevice

Version

Specified by:

getVersion in interface HardwareDevice

Returns:

get the version of this device

resetDeviceConfigurationForOpMode

public void resetDeviceConfigurationForOpMode()

Description copied from interface: HardwareDevice

Resets the device's configuration to that which is expected at the beginning of an OpMode. For example, motors will reset the their direction to 'forward'.

Specified by:

resetDeviceConfigurationForOpMode in interface HardwareDevice

close

public void close()

Description copied from interface: HardwareDevice

Closes this device

Specified by:

close in interface HardwareDevice