org.ardulink.core

Class ConnectionBasedLink

java.lang.Object

org.ardulink.core.AbstractListenerLink

org.ardulink.core.ConnectionBasedLink

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Link

public class ConnectionBasedLink
extends AbstractListenerLink

[ardulinktitle] [ardulinkversion] project Ardulink http://www.ardulink.org/ [adsense]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionBasedLink.Mode

Constructor Summary

Constructors

Constructor and Description
ConnectionBasedLink(Connection connection, Protocol protocol)

Method Summary

Modifier and Type	Method and Description
void	close()
Connection	getConnection()
Protocol	getProtocol()
long	sendCustomMessage(java.lang.String... messages)
long	sendKeyPressEvent(char keychar, int keycode, int keylocation, int keymodifiers, int keymodifiersex)
long	sendNoTone(Pin.AnalogPin analogPin)
long	sendTone(Tone tone)
long	startListening(Pin pin)
long	stopListening(Pin pin)
long	switchAnalogPin(Pin.AnalogPin analogPin, int value)
long	switchDigitalPin(Pin.DigitalPin digitalPin, boolean value)
boolean	waitForArduinoToBoot(int wait, java.util.concurrent.TimeUnit timeUnit) Will wait for the arduino to received the "ready" paket or the arduino to respond to our messages sent.
boolean	waitForArduinoToBoot(int wait, java.util.concurrent.TimeUnit timeUnit, ConnectionBasedLink.Mode mode) Will wait for the arduino to received the "ready" paket or the arduino to respond to our messages sent.

Methods inherited from class org.ardulink.core.AbstractListenerLink

addConnectionListener, addCustomListener, addListener, addRplyListener, deregisterAllEventListeners, fireConnectionLost, fireCustomReceived, fireReconnected, fireReplyReceived, fireStateChanged, fireStateChanged, hasRplyListeners, removeConnectionListener, removeCustomListener, removeListener, removeRplyListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionBasedLink

public ConnectionBasedLink(Connection connection,
                           Protocol protocol)

Method Detail

getConnection

public Connection getConnection()

getProtocol

public Protocol getProtocol()

waitForArduinoToBoot

public boolean waitForArduinoToBoot(int wait,
                                    java.util.concurrent.TimeUnit timeUnit)

Will wait for the arduino to received the "ready" paket or the arduino to respond to our messages sent.

Parameters:

wait - the maximum time to wait

timeUnit - the units to wait

Returns:

true if the arduino did response within the given time otherwise false

waitForArduinoToBoot

public boolean waitForArduinoToBoot(int wait,
                                    java.util.concurrent.TimeUnit timeUnit,
                                    ConnectionBasedLink.Mode mode)

Will wait for the arduino to received the "ready" paket or the arduino to respond to our messages sent.

Parameters:

wait - the maximum time to wait

timeUnit - the units to wait

mode - the messages to be interpreted as "ok"

Returns:

true if the arduino did response within the given time otherwise false

startListening

public long startListening(Pin pin)
                    throws java.io.IOException

Throws:

java.io.IOException

stopListening

public long stopListening(Pin pin)
                   throws java.io.IOException

Throws:

java.io.IOException

switchAnalogPin

public long switchAnalogPin(Pin.AnalogPin analogPin,
                            int value)
                     throws java.io.IOException

Throws:

java.io.IOException

switchDigitalPin

public long switchDigitalPin(Pin.DigitalPin digitalPin,
                             boolean value)
                      throws java.io.IOException

Throws:

java.io.IOException

sendKeyPressEvent

public long sendKeyPressEvent(char keychar,
                              int keycode,
                              int keylocation,
                              int keymodifiers,
                              int keymodifiersex)
                       throws java.io.IOException

Throws:

java.io.IOException

sendTone

public long sendTone(Tone tone)
              throws java.io.IOException

Throws:

java.io.IOException

sendNoTone

public long sendNoTone(Pin.AnalogPin analogPin)
                throws java.io.IOException

Throws:

java.io.IOException

sendCustomMessage

public long sendCustomMessage(java.lang.String... messages)
                       throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class AbstractListenerLink

Throws:

java.io.IOException