B C E F G H I K L M P R S T U V W

B

backward() - Method in class ShefRobot.Motor

Tells the motor to rotate backwards The motor will continue rotating until Motor.stop() is called.

ButtonListener - Interface in ShefRobot

Listener interface for catching Button press and release events.

buttonPressed(Buttons.Button) - Method in interface ShefRobot.ButtonListener

Invoked when the listened button is pressed

buttonReleased(Buttons.Button) - Method in interface ShefRobot.ButtonListener

Invoked when the listened button is released

Buttons - Class in ShefRobot

Objects of this class represent the Button interface to the Robot which it was created from Provides the ability to wait for a button on the robot to be pressed.

Buttons.Button - Enum in ShefRobot

C

close() - Method in class ShefRobot.Robot

Close a Robot's connections.

closeMotor(Motor.Port) - Method in class ShefRobot.Robot

This method allows you to close one Motor connection.

closeSensor(Sensor.Port) - Method in class ShefRobot.Robot

This method allows you to close one Sensor connection.

ColorSensor - Class in ShefRobot

This class represents an EV3 ColorSensor which has four modes of operation ColorSensor.Mode.COLOR, ColorSensor.Mode.RED, ColorSensor.Mode.RGB and ColorSensor.Mode.AMBIENT By default the sensor starts in ColorSensor.Mode.RED mode.

ColorSensor.Color - Enum in ShefRobot

Enums used to represent the possible colours returned by the Color sensor

ColorSensor.FloodlightState - Enum in ShefRobot

ColorSensor.Mode - Enum in ShefRobot

Modes that this sensor can be used in

E

equals(Object) - Method in class ShefRobot.util.Pair

F

forward() - Method in class ShefRobot.Motor

Tells the motor to rotate forwards The motor will continue rotating until Motor.stop() is called.

G

getAmbient() - Method in class ShefRobot.ColorSensor

Returns a value representative of the light intensity detected.

getAngle() - Method in class ShefRobot.GyroSensor

Measures the orientation of the sensor in respect to its start orientation.

getButtons() - Method in class ShefRobot.Robot

Get a Buttons object You can use Buttons for creating ButtonListeners and waiting for ButtonPresses

getColor() - Method in class ShefRobot.ColorSensor

Returns the colour detected by the sensor as one of the ColorSensor.Color values.

getColorSensor(Sensor.Port) - Method in class ShefRobot.Robot

Get a ColorSensor object attached to the specified port.

getDistance() - Method in class ShefRobot.UltrasonicSensor

Returns the distance detected by the sensor in metres When in distance mode, the Ultrasonic sensors light will be solid and it will continuously emit pings Values outside of the approximate range ~0.03-1.7m are returned as Float.POSITIVE_INFINITY

getFloodlightState() - Method in class ShefRobot.ColorSensor

Reads the current state of the floodlight

getGyroSensor(Sensor.Port) - Method in class ShefRobot.Robot

Get a GyroSensor object attached to the specified port.

getLargeMotor(Motor.Port) - Method in class ShefRobot.Robot

Get a Motor object attached to the specified port.

getMaxSpeed() - Method in class ShefRobot.Motor

Returns the maximum speed, this value is based off the Robots battery voltage (it decreases as the Robots battery drains).

getMediumMotor(Motor.Port) - Method in class ShefRobot.Robot

Get a Motor object attached to the specified port.

getRate() - Method in class ShefRobot.GyroSensor

Measures angular velocity of the sensor.

getRateAndAngle() - Method in class ShefRobot.GyroSensor

Measures orientation and angular velocity of the sensor.

getRawSample() - Method in class ShefRobot.Sensor

Get a value from the Sensor.

getRed() - Method in class ShefRobot.ColorSensor

Returns the level of red reflected into the sensor If not already in red mode, this will switch the sensor into red mode (enabling the red light).

getRGB() - Method in class ShefRobot.ColorSensor

Returns the colour detected by the sensor ~untested~

getSpeaker() - Method in class ShefRobot.Robot

Get a Speaker object You can use a Speaker for playing tones through the Robot

getSpeed() - Method in class ShefRobot.Motor

Returns the speed of the Motor

getTachoCount() - Method in class ShefRobot.Motor

Returns the cumulative number of degrees the motor has turned since Motor.resetTachoCount() was last called.

getTouchSensor(Sensor.Port) - Method in class ShefRobot.Robot

Get an TouchSensor object attached to the specified port.

getUltrasonicSensor(Sensor.Port) - Method in class ShefRobot.Robot

Get an UltrasonicSensor object attached to the specified port.

getValue() - Method in class ShefRobot.util.Pair

getVolume() - Method in class ShefRobot.Speaker

Returns the current volume of the robots speaker

GyroSensor - Class in ShefRobot

This class represents an EV3 GyroSensor which can detect its angle and the rate of change Each EV3 should contain 1 gyro sensor If the sensor seems insensitive, please check that the EV3s battery is charged.

H

hashCode() - Method in class ShefRobot.util.Pair

I

id - Variable in enum ShefRobot.Buttons.Button

isMoving() - Method in class ShefRobot.Motor

Returns whether the motor is currently moving.

isStalled() - Method in class ShefRobot.Motor

Returns whether the motor has stalled.

isTouched() - Method in class ShefRobot.TouchSensor

K

key - Variable in class ShefRobot.util.Pair

L

LargeMotor - Class in ShefRobot

Represents a large motor Each EV3 should contain 2 large motors All LargeMotor methods are common to Motor, this class is only used for calibration at construction.

listen() - Method in class ShefRobot.UltrasonicSensor

When in Listen mode the Ultrasonic sensor will not emit ultrasound, it will only listen for other robots ultrasound.

M

MediumMotor - Class in ShefRobot

Represents a medium motor Each EV3 should contain 1 medium motor All MediumMotor methods are common to Motor, this class is only used for calibration at construction.

Motor - Class in ShefRobot

This class represents a generic motor, it is must be instantiated as a subclass of the correct motor model (Large or Medium).

Motor.Port - Enum in ShefRobot

These represent the physical ports on the robot which Motors can be connected to

P

Pair<K,V> - Class in ShefRobot.util

Simple pair class used internally Core library equivalent is Map.Entry

Pair(K, V) - Constructor for class ShefRobot.util.Pair

playTone(int, int) - Method in class ShefRobot.Speaker

Synchronously plays a tone of the specified frequency and duration through the robots speaker (The current thread will be stalled whilst tone is playing)

R

reset() - Method in class ShefRobot.GyroSensor

Resets the Gyro sensor The sensor must be still when this method is called, else it may become mis-calibrated

resetTachoCount() - Method in class ShefRobot.Motor

Resets the value returned by Motor.getTachoCount() to 0

Robot - Class in ShefRobot

Objects of this class represent particular EV3 based Lego robots.

Robot() - Constructor for class ShefRobot.Robot

Create a new Robot object.

Robot(String) - Constructor for class ShefRobot.Robot

Create a new Robot object with a specific IP address.

rotate(int) - Method in class ShefRobot.Motor

Rotates the motor the specified number of degrees.

rotate(int, boolean) - Method in class ShefRobot.Motor

Rotates the motor the specified number of degrees.

rotateTo(int) - Method in class ShefRobot.Motor

Rotates the motor to the specified tacho count.

rotateTo(int, boolean) - Method in class ShefRobot.Motor

Rotates the motor to the specified tacho count.

S

Sensor<T> - Class in ShefRobot

Sensor.Port - Enum in ShefRobot

These represent the physical ports on the robot which Sensors can be connected to

setFloodlightState(ColorSensor.FloodlightState) - Method in class ShefRobot.ColorSensor

Changes the state of the floodlight to a colour or off Calls to read the sensor will change the floodlight back to the required colour

setMode(ColorSensor.Mode) - Method in class ShefRobot.ColorSensor

Switches the sensor between modes

setSpeed(int) - Method in class ShefRobot.Motor

Sets the speed of the Motor.

setValue(V) - Method in class ShefRobot.util.Pair

setVolume(int) - Method in class ShefRobot.Speaker

Sets the volume of the robots speaker

ShefRobot - package ShefRobot

ShefRobot.util - package ShefRobot.util

sleep(long) - Static method in class ShefRobot.Robot

Causes the currently executing thread to sleep (temporarily cease execution) for the specified number of milliseconds, subject to the precision and accuracy of system timers and schedulers.

Speaker - Class in ShefRobot

Objects of this class represent the audio interface to the Robot which it was created from

stop() - Method in class ShefRobot.Motor

Tells the motor to stop moving

T

TouchSensor - Class in ShefRobot

Represents a touch sensor Each EV3 should contain 1 touch sensor Some LargeMotor methods are common to Motor

TouchSensor.Mode - Enum in ShefRobot

U

UltrasonicSensor - Class in ShefRobot

This class represents an EV3 UltrasonicSensor which has two modes of operation UltrasonicSensor.Mode.DISTANCE and UltrasonicSensor.Mode.LISTEN By default the sensor starts in UltrasonicSensor.Mode.DISTANCE mode.

UltrasonicSensor.Mode - Enum in ShefRobot

Modes that this sensor can be used in

V

valueOf(String) - Static method in enum ShefRobot.Buttons.Button

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ShefRobot.ColorSensor.Color

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ShefRobot.ColorSensor.FloodlightState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ShefRobot.ColorSensor.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ShefRobot.Motor.Port

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ShefRobot.Sensor.Port

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ShefRobot.TouchSensor.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ShefRobot.UltrasonicSensor.Mode

Returns the enum constant of this type with the specified name.

values() - Static method in enum ShefRobot.Buttons.Button

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ShefRobot.ColorSensor.Color

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ShefRobot.ColorSensor.FloodlightState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ShefRobot.ColorSensor.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ShefRobot.Motor.Port

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ShefRobot.Sensor.Port

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ShefRobot.TouchSensor.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ShefRobot.UltrasonicSensor.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

VOLUME_MAX - Static variable in class ShefRobot.Speaker

The maximum integer that can be passed to setVolume or returned from getVolume

VOLUME_MIN - Static variable in class ShefRobot.Speaker

The minimum integer that can be passed to setVolume or returned from getVolume

W

waitForAnyButton() - Method in class ShefRobot.Buttons

waitForButton(Buttons.Button) - Method in class ShefRobot.Buttons

B C E F G H I K L M P R S T U V W