com.qualcomm.hardware.hitechnic

Class HiTechnicNxtLightSensor

java.lang.Object

com.qualcomm.robotcore.hardware.LegacyModulePortDeviceImpl

com.qualcomm.hardware.hitechnic.HiTechnicNxtLightSensor

All Implemented Interfaces:

AnalogSensor, HardwareDevice, LegacyModulePortDevice, LightSensor, RobotArmingStateNotifier.Callback

public class HiTechnicNxtLightSensor
extends LegacyModulePortDeviceImpl
implements LightSensor, AnalogSensor

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
static byte	LED_DIGITAL_LINE_NUMBER
static double	MAX_LIGHT_FRACTION
static double	MIN_LIGHT_FRACTION

Fields inherited from class com.qualcomm.robotcore.hardware.LegacyModulePortDeviceImpl

module, physicalPort

Constructor Summary

Constructors

Constructor and Description
HiTechnicNxtLightSensor(LegacyModule legacyModule, 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() Read the scaled light level from an NXT Light sensor and return a scaled value NOTE: Returned values INCREASE as the light energy INCREASES Typical Scaled Light Levels: LED ON (reflective): Black = 0.1 White = 0.55 LED OFF (ambient): Dark = 0.0 Bright = 1.0
HardwareDevice.Manufacturer	getManufacturer() Returns an indication of the manufacturer of this device.
double	getRawLightDetected() Read the raw light level from an NXT Light sensor NOTE: Returned values INCREASE as the light energy INCREASES
double	getRawLightDetectedMax() Returns the maximum value that can be returned by LightSensor.getRawLightDetected().
int	getVersion() Version
protected void	moduleNowArmedOrPretending() intended as a subclass hook
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 com.qualcomm.robotcore.hardware.LegacyModulePortDeviceImpl

finishConstruction, getLegacyModule, getPort, moduleNowDisarmed, onModuleStateChange

Methods inherited from class java.lang.Object

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

Field Detail

LED_DIGITAL_LINE_NUMBER

public static final byte LED_DIGITAL_LINE_NUMBER

See Also:

Constant Field Values

MIN_LIGHT_FRACTION

public static final double MIN_LIGHT_FRACTION

See Also:

Constant Field Values

MAX_LIGHT_FRACTION

public static final double MAX_LIGHT_FRACTION

See Also:

Constant Field Values

apiLevelMin

protected static final double apiLevelMin

See Also:

Constant Field Values

apiLevelMax

protected static final double apiLevelMax

See Also:

Constant Field Values

Constructor Detail

HiTechnicNxtLightSensor

public HiTechnicNxtLightSensor(LegacyModule legacyModule,
                               int physicalPort)

Method Detail

moduleNowArmedOrPretending

protected void moduleNowArmedOrPretending()

Description copied from class: LegacyModulePortDeviceImpl

intended as a subclass hook

Overrides:

moduleNowArmedOrPretending in class LegacyModulePortDeviceImpl

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLightDetected

public double getLightDetected()

Read the scaled light level from an NXT Light sensor and return a scaled value
NOTE: Returned values INCREASE as the light energy INCREASES
Typical Scaled Light Levels:
LED ON (reflective): Black = 0.1 White = 0.55
LED OFF (ambient): Dark = 0.0 Bright = 1.0

Specified by:

getLightDetected in interface LightSensor

Returns:

a double scaled to a value between 0.0 and 1.0, inclusive

getRawLightDetected

public double getRawLightDetected()

Read the raw light level from an NXT Light sensor
NOTE: Returned values INCREASE as the light energy INCREASES

Specified by:

getRawLightDetected in interface LightSensor

Returns:

the light level detected, in volts (here; interface doesn't specify the units) Typical Scaled Light Levels:
LED ON (reflective): Black = 0.9 White = 2.7
LED OFF (ambient): Dark = 0.1 Bright = 5.0

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