org.chabala.brick.controllab

Interface ControlLab

All Superinterfaces:

AutoCloseable, Closeable

public interface ControlLab
extends Closeable

This is the main interface for interacting with the LEGO® control lab, instances of which can be created with newControlLab().

Usage example:

    ControlLab controlLab = ControlLab.newControlLab();
    List<String> availablePorts = controlLab.getAvailablePorts();
    try {
        controlLab.open(availablePorts.get(0));
        controlLab.getOutput(OutputId.A).setPowerLevel(PowerLevel.P4).turnOn();
    } catch (IOException e) {
        e.printStackTrace();
    } finally {
        try {
            controlLab.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

Method Summary

Modifier and Type	Method and Description
void	close() Disconnects from the control lab and releases any resources.
List<String>	getAvailablePorts() List available serial ports on this machine.
String	getConnectedPortName() Returns the system specific serial port identifier the control lab is connected to, or empty string if not connected.
Input	getInput(InputId inputId) Return a handle for the input specified on this control lab instance.
Output	getOutput(OutputId outputId) Return a handle for the output specified on this control lab instance.
Output	getOutput(Set<OutputId> outputs) Return a handle for multiple outputs on this control lab instance.
StopButton	getStopButton() Return a handle for the stop button on this control lab instance.
static ControlLab	newControlLab() Returns a new ControlLab instance.
void	open(String portName) Opens a connection to the control lab on the specified port.
void	setOutputDirection(Direction direction, Set<OutputId> outputs) Sets the Direction of the specified outputs.
void	setOutputPowerLevel(PowerLevel powerLevel, Set<OutputId> outputs) Sets the PowerLevel of the specified outputs.
void	turnOutputOff(Set<OutputId> outputs) Stops sending power to the specified outputs.
void	turnOutputOn(Set<OutputId> outputs) Starts sending power to the specified outputs.

Method Detail

newControlLab

static ControlLab newControlLab()

Returns a new ControlLab instance.

Returns:

a new ControlLab instance

getAvailablePorts

List<String> getAvailablePorts()

List available serial ports on this machine. May change over time due to hot pluggable USB serial port adapters and the like.

Returns:

a list of system specific string identifiers for serial ports

open

void open(String portName)
   throws IOException

Opens a connection to the control lab on the specified port.

Parameters:

portName - system specific serial port identifier

Throws:

IOException - if any number of possible communication issues occurs

getConnectedPortName

String getConnectedPortName()

Returns the system specific serial port identifier the control lab is connected to, or empty string if not connected.

Returns:

system specific serial port identifier or empty string

turnOutputOff

void turnOutputOff(Set<OutputId> outputs)
            throws IOException

Stops sending power to the specified outputs.

Parameters:

outputs - outputs to stop

Throws:

IOException - if any number of possible communication issues occurs

turnOutputOn

void turnOutputOn(Set<OutputId> outputs)
           throws IOException

Starts sending power to the specified outputs.

Parameters:

outputs - outputs to start

Throws:

IOException - if any number of possible communication issues occurs

setOutputDirection

void setOutputDirection(Direction direction,
                        Set<OutputId> outputs)
                 throws IOException

Sets the Direction of the specified outputs. Direction may be changed while the outputs are powered or unpowered.

Parameters:

direction - desired direction

outputs - which outputs to change

Throws:

IOException - if any number of possible communication issues occurs

setOutputPowerLevel

void setOutputPowerLevel(PowerLevel powerLevel,
                         Set<OutputId> outputs)
                  throws IOException

Sets the PowerLevel of the specified outputs. Power level may be changed while the outputs are powered or unpowered.

Parameters:

powerLevel - desired power level

outputs - which outputs to change

Throws:

IOException - if any number of possible communication issues occurs

getOutput

Output getOutput(OutputId outputId)

Return a handle for the output specified on this control lab instance.

Parameters:

outputId - identifier of the desired output port

Returns:

handle for the output specific to this control lab instance

getOutput

Output getOutput(Set<OutputId> outputs)

Return a handle for multiple outputs on this control lab instance.

Parameters:

outputs - identifiers of the desired output ports

Returns:

handle for the outputs specific to this control lab instance

getStopButton

StopButton getStopButton()

Return a handle for the stop button on this control lab instance.

Returns:

handle for the stop button on this control lab instance

getInput

Input getInput(InputId inputId)

Return a handle for the input specified on this control lab instance.

Parameters:

inputId - identifier of the desired input port

Returns:

handle for the input specific to this control lab instance

close

void close()
    throws IOException

Disconnects from the control lab and releases any resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if any number of possible communication issues occurs