ev3dev.sensors.ev3

Class EV3UltrasonicSensor

java.lang.Object

ev3dev.hardware.EV3DevDevice

ev3dev.hardware.EV3DevSensorDevice

ev3dev.sensors.BaseSensor

ev3dev.sensors.ev3.EV3UltrasonicSensor

public class EV3UltrasonicSensor
extends BaseSensor

Lego EV3 Ultrasonic sensors
The EV3 Ultrasonic sensors measures distance to an object in front of the sensors. It can also be used to detect other (active) Ultrasonic sensors in the vicinity.

Sensor configuration
The sensors can be switched off and on using the enable() and disable() methods. Disabling the sensors also shuts down the lights.

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

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	LEGO_EV3_US
static float	MAX_RANGE
static float	MIN_RANGE
private static java.lang.String	MODE_DISTANCE
private static java.lang.String	MODE_LISTEN
private static java.lang.String	MODE_SINGLE_MEASURE

Fields inherited from class ev3dev.sensors.BaseSensor

currentMode, modes, SWITCH_DELAY

Fields inherited from class ev3dev.hardware.EV3DevSensorDevice

LEGO_ANALOG_SENSOR, LEGO_I2C, LEGO_UART_SENSOR, SENSOR_MODE, SENSOR_MODES

Fields inherited from class ev3dev.hardware.EV3DevDevice

ADDRESS, CURRENT_PLATFORM, DEVICE, ev3DevProperties, LEGO_PORT, LEGO_SENSOR, MODE, PATH_DEVICE

Constructor Summary

Constructors

Constructor and Description
EV3UltrasonicSensor(Port portName) Create the Ultrasonic sensors class.

Method Summary

Modifier and Type	Method and Description
void	disable() Disable the sensor.
void	enable() Enable the sensor.
SampleProvider	getDistanceMode() Lego EV3 Ultrasonic sensors, Distance mode Measures distance to an object in front of the sensors
SampleProvider	getListenMode() Lego EV3 Ultrasonic sensors, Listen mode Listens for the presence of other ultrasonic sensors.
boolean	isEnabled() Indicate that the sensors is enabled.

Methods inherited from class ev3dev.sensors.BaseSensor

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

Methods inherited from class ev3dev.hardware.EV3DevDevice

detect, getIntegerAttribute, getStringAttribute, setIntegerAttribute, setStringAttribute

Methods inherited from class java.lang.Object

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

Field Detail

LEGO_EV3_US

private static final java.lang.String LEGO_EV3_US

See Also:

Constant Field Values

MIN_RANGE

public static float MIN_RANGE

MAX_RANGE

public static float MAX_RANGE

MODE_DISTANCE

private static final java.lang.String MODE_DISTANCE

See Also:

Constant Field Values

MODE_LISTEN

private static final java.lang.String MODE_LISTEN

See Also:

Constant Field Values

MODE_SINGLE_MEASURE

private static final java.lang.String MODE_SINGLE_MEASURE

See Also:

Constant Field Values

Constructor Detail

EV3UltrasonicSensor

public EV3UltrasonicSensor(Port portName)

Create the Ultrasonic sensors class.

Parameters:

portName - port

Method Detail

getListenMode

public SampleProvider getListenMode()

Lego EV3 Ultrasonic sensors, Listen mode
Listens for the presence of other ultrasonic sensors.

Size and content of the sample
The sample contains one elements indicating the presence of another ultrasonic sensors. A value of 1 indicates that the sensors detects another ultrasonic sensors.

Returns:

A sampleProvider

getDistanceMode

public SampleProvider getDistanceMode()

Lego EV3 Ultrasonic sensors, Distance mode
Measures distance to an object in front of the sensors

Size and content of the sample
The sample contains one elements representing the distance (in metres) to an object in front of the sensors. unit).

Returns:

A sampleProvider

enable

public void enable()

Enable the sensor. This puts the indicater LED on.

Note: this function switches the sensor mode. This means that reads from SensorModes different from the one returned by getDistanceMode() will be invalid. See GenericMode.fetchSample(float[], int)

disable

public void disable()

Disable the sensor. This puts the indicater LED off.

Note: this function switches the sensor mode. This means that reads from SensorModes will be invalid until enable() or get*Mode() is called. See GenericMode.fetchSample(float[], int)

isEnabled

public boolean isEnabled()

Indicate that the sensors is enabled.

Returns:

True, when the sensors is enabled.
False, when the sensors is disabled.