ev3dev.hardware.sensors.ev3

Class EV3ColorSensor

java.lang.Object

ev3dev.hardware.Device

ev3dev.hardware.EV3DevDevice

ev3dev.hardware.EV3DevSensorDevice

ev3dev.hardware.sensors.BaseSensor

ev3dev.hardware.sensors.ev3.EV3ColorSensor

All Implemented Interfaces:

EV3DevSensorDeviceCommands, SensorMode, SensorModes, SupportedPlatform, java.io.Closeable, java.lang.AutoCloseable, ColorIdentifier, LampController, SampleProvider

public class EV3ColorSensor
extends BaseSensor
implements LampController, ColorIdentifier

EV3 color sensors
The digital EV3 Color Sensor distinguishes between eight different colors. It also serves as a light sensors by detecting light intensities.

Sensor configuration
The flood light of the sensors can be put on or off using the setFloodlight methods.

See Sensor Product page See The leJOS sensors framework See leJOS conventions for SampleProviders

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	EV3ColorSensor.AmbientMode
private class	EV3ColorSensor.ColorIDMode
private class	EV3ColorSensor.RedMode
private class	EV3ColorSensor.RGBMode

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	COL_AMBIENT
protected static java.lang.String	COL_CAL
private static java.lang.String	COL_COLOR
private static java.lang.String	COL_REFLECT
protected static java.lang.String	COL_REFRAW
private static java.lang.String	COL_RESET
private static java.lang.String	COL_RGBRAW
protected static int[]	colorMap
private static java.lang.String	LEGO_EV3_COLOR_SENSOR
private static int[]	lightColor
protected short[]	raw

Fields inherited from class ev3dev.hardware.sensors.BaseSensor

currentMode, currentModeS, modes, SWITCH_DELAY

Fields inherited from class ev3dev.hardware.EV3DevDevice

ADDRESS, DEVICE, DEVICE_ROOT_PATH, LEGO_PORT, LEGO_SENSOR, MODE, PATH_DEVICE

Fields inherited from class ev3dev.hardware.Device

closeList

Fields inherited from interface ev3dev.hardware.sensors.EV3DevSensorDeviceCommands

BATTERY, BATTERY_BRICKPI, BATTERY_EV3, BATTERY_PISTORMS, LEGO_UART_SENSOR, SENSOR_MODE, SENSOR_MODES

Fields inherited from interface ev3dev.hardware.SupportedPlatform

BRICKPI, EV3BRICK, PISTORMS

Constructor Summary

Constructors

Constructor and Description
EV3ColorSensor(java.lang.String portName)

Method Summary

Modifier and Type	Method and Description
SensorMode	getAmbientMode() EV3 color sensors, Ambient mode Measures the level of ambient light while the sensors lights are off.
int	getColorID() Return an enumerated constant that indicates the color detected. e.g.
SensorMode	getColorIDMode() EV3 color sensors, Color ID mode Measures the color ID of a surface.
int	getFloodlight() Returns the color of the floodlight, including Color.NONE.
SensorMode	getRedMode() EV3 color sensors, Red mode Measures the level of reflected light from the sensors RED LED.
SensorMode	getRGBMode() EV3 color sensors, RGB mode Measures the level of red, green and blue light when illuminated by a white light source..
private void	initModes()
boolean	isFloodlightOn() Checks if the floodlight is currently on.
void	setFloodlight(boolean floodlight) Turns the default LED light on or off.
boolean	setFloodlight(int color) Used to turn on or off the floodlight by color.

Methods inherited from class ev3dev.hardware.sensors.BaseSensor

fetchSample, getAvailableModes, getCurrentMode, getMode, getMode, getModeCount, getName, sampleSize, setCurrentMode, setCurrentMode, setModes, switchMode, switchMode

Methods inherited from class ev3dev.hardware.EV3DevDevice

detect, getIntegerAttribute, getPlatform, getStringAttribute, setIntegerAttribute, setStringAttribute

Methods inherited from class ev3dev.hardware.Device

close, releaseOnClose

Methods inherited from class java.lang.Object

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

Field Detail

colorMap

protected static int[] colorMap

LEGO_EV3_COLOR_SENSOR

private static final java.lang.String LEGO_EV3_COLOR_SENSOR

See Also:

Constant Field Values

COL_RESET

private static final java.lang.String COL_RESET

See Also:

Constant Field Values

COL_REFLECT

private static final java.lang.String COL_REFLECT

See Also:

Constant Field Values

COL_AMBIENT

private static final java.lang.String COL_AMBIENT

See Also:

Constant Field Values

COL_COLOR

private static final java.lang.String COL_COLOR

See Also:

Constant Field Values

COL_REFRAW

protected static final java.lang.String COL_REFRAW

See Also:

Constant Field Values

COL_RGBRAW

private static final java.lang.String COL_RGBRAW

See Also:

Constant Field Values

COL_CAL

protected static final java.lang.String COL_CAL

See Also:

Constant Field Values

lightColor

private static final int[] lightColor

raw

protected short[] raw

Constructor Detail

EV3ColorSensor

public EV3ColorSensor(java.lang.String portName)

Method Detail

initModes

private void initModes()

getColorID

public int getColorID()

Return an enumerated constant that indicates the color detected. e.g. Color.BLUE

Specified by:

getColorID in interface ColorIdentifier

Returns:

An integer from the Color constants, such as Color.BLUE

setFloodlight

public void setFloodlight(boolean floodlight)

Turns the default LED light on or off. If the sensors has more than one lamp color, this will control the red LED.

Specified by:

setFloodlight in interface LampController

Parameters:

floodlight - true to turn on lamp, false for off (ambient light only).

isFloodlightOn

public boolean isFloodlightOn()

Checks if the floodlight is currently on.

Specified by:

isFloodlightOn in interface LampController

Returns:

true if on, false if off.

getFloodlight

public int getFloodlight()

Returns the color of the floodlight, including Color.NONE.

Specified by:

getFloodlight in interface LampController

Returns:

An enumeration of the current color.

setFloodlight

public boolean setFloodlight(int color)

Used to turn on or off the floodlight by color. If the sensors has multiple light colors, you can control which color is turned on or off. If the color does not exist, it does nothing and returns false. You can turn the floodlight off by using Color.NONE.

Specified by:

setFloodlight in interface LampController

Parameters:

color - Use Color enumeration constant to control lamp colors.

Returns:

True if lamp changed, false if lamp color doesn't exist for this sensors.

getColorIDMode

public SensorMode getColorIDMode()

EV3 color sensors, Color ID mode
Measures the color ID of a surface. The sensors can identify 8 unique colors (NONE, BLACK, BLUE, GREEN, YELLOW, RED, WHITE, BROWN).

Size and content of the sample
The sample contains one element containing the ID (0-7) of the detected color.

Returns:

A sampleProvider See leJOS conventions for SampleProviders

getRedMode

public SensorMode getRedMode()

EV3 color sensors, Red mode
Measures the level of reflected light from the sensors RED LED.

Size and content of the sample
The sample contains one element containing the intensity level (Normalized between 0 and 1) of reflected light.

Returns:

A sampleProvider See leJOS conventions for SampleProviders

getAmbientMode

public SensorMode getAmbientMode()

EV3 color sensors, Ambient mode
Measures the level of ambient light while the sensors lights are off.

Size and content of the sample
The sample contains one element containing the intensity level (Normalized between 0 and 1) of ambient light.

Returns:

A sampleProvider See leJOS conventions for SampleProviders

getRGBMode

public SensorMode getRGBMode()

EV3 color sensors, RGB mode
Measures the level of red, green and blue light when illuminated by a white light source..

Size and content of the sample
The sample contains 3 elements containing the intensity level (Normalized between 0 and 1) of red, green and blue light respectivily.

Returns:

A sampleProvider See leJOS conventions for SampleProviders