|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.zu.ardulink.protocol.SimpleBinaryProtocol
public class SimpleBinaryProtocol
v0.6.1 Magnum PI
This is a binary protocol to minimize messages payload. With this protocol tiny devices as Digispark work better than with text protocols as ALProtocol (that is the default). Hovewer this protocol is actually very limited and are implemented only sendPowerPinIntensity and sendPowerPinSwitch methods (without callback feature).
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.zu.ardulink.protocol.IProtocol |
---|
IProtocol.ProtocolType |
Field Summary | |
---|---|
static String |
NAME
|
Fields inherited from interface org.zu.ardulink.protocol.IProtocol |
---|
DEFAULT_INCOMING_MESSAGE_DIVIDER, DEFAULT_OUTGOING_MESSAGE_DIVIDER, HIGH, LOW, POWER_HIGH, POWER_LOW, REPLY_KO, REPLY_OK, UNDEFINED_ID, UNDEFINED_REPLY |
Constructor Summary | |
---|---|
SimpleBinaryProtocol()
|
Method Summary | |
---|---|
int |
getIncomingMessageDivider()
the incoming message divider used from Connection to divide incoming message (if ProtocolType is binary then incoming must be equal to outgoing |
int |
getOutgoingMessageDivider()
the outgoing message divider used from Protocol to divide outgoing message (if ProtocolType is binary then incoming must be equal to outgoing |
String |
getProtocolName()
|
IProtocol.ProtocolType |
getProtocolType()
|
IncomingMessageEvent |
parseMessage(int[] realMsg)
When a message arrives from Arduino, ConnectionContactImpl and Link classes call this method that parses message and returns a specific event. |
MessageInfo |
sendCustomMessage(Link link,
String message)
Sends a custom message used for specific actions in Arduino sketches |
MessageInfo |
sendCustomMessage(Link link,
String message,
ReplyMessageCallback callback)
Sends a custom message used for specific actions in Arduino sketches |
MessageInfo |
sendKeyPressEvent(Link link,
char keychar,
int keycode,
int keylocation,
int keymodifiers,
int keymodifiersex)
Sends information about which key was pressed. |
MessageInfo |
sendKeyPressEvent(Link link,
char keychar,
int keycode,
int keylocation,
int keymodifiers,
int keymodifiersex,
ReplyMessageCallback callback)
Sends information about which key was pressed. |
MessageInfo |
sendNoToneMessage(Link link,
int pin)
Sends the request to stop the generation of a tone (square wave) |
MessageInfo |
sendNoToneMessage(Link link,
int pin,
ReplyMessageCallback callback)
Sends the request to stop the generation of a tone (square wave) |
MessageInfo |
sendPowerPinIntensity(Link link,
int pin,
int intensity)
Sends the request to set a PWM type pin to a certain intensity. |
MessageInfo |
sendPowerPinIntensity(Link link,
int pin,
int intensity,
ReplyMessageCallback callback)
Sends the request to set a PWM type pin to a certain intensity. |
MessageInfo |
sendPowerPinSwitch(Link link,
int pin,
int power)
Sends the request to set a pin to HIGH or LOW power. |
MessageInfo |
sendPowerPinSwitch(Link link,
int pin,
int power,
ReplyMessageCallback callback)
Sends the request to set a pin to HIGH or LOW power. |
MessageInfo |
sendToneMessage(Link link,
int pin,
int frequency)
Sends the request to generate a tone (square wave) |
MessageInfo |
sendToneMessage(Link link,
int pin,
int frequency,
int duration)
Sends the request to generate a tone (square wave) |
MessageInfo |
sendToneMessage(Link link,
int pin,
int frequency,
int duration,
ReplyMessageCallback callback)
Sends the request to generate a tone (square wave) |
MessageInfo |
sendToneMessage(Link link,
int pin,
int frequency,
ReplyMessageCallback callback)
Sends the request to generate a tone (square wave) |
MessageInfo |
startListenAnalogPin(Link link,
int pin)
Sends the request to listen on a specific analog pin. |
MessageInfo |
startListenAnalogPin(Link link,
int pin,
ReplyMessageCallback callback)
Sends the request to listen on a specific analog pin. |
MessageInfo |
startListenDigitalPin(Link link,
int pin)
Sends the request to listen on a specific pin. |
MessageInfo |
startListenDigitalPin(Link link,
int pin,
ReplyMessageCallback callback)
Sends the request to listen on a specific pin. |
MessageInfo |
stopListenAnalogPin(Link link,
int pin)
Sends the request to not listen on a specific analog pin. |
MessageInfo |
stopListenAnalogPin(Link link,
int pin,
ReplyMessageCallback callback)
Sends the request to not listen on a specific analog pin. |
MessageInfo |
stopListenDigitalPin(Link link,
int pin)
Sends the request to not listen on a specific pin. |
MessageInfo |
stopListenDigitalPin(Link link,
int pin,
ReplyMessageCallback callback)
Sends the request to not listen on a specific pin. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String NAME
Constructor Detail |
---|
public SimpleBinaryProtocol()
Method Detail |
---|
public MessageInfo sendKeyPressEvent(Link link, char keychar, int keycode, int keylocation, int keymodifiers, int keymodifiersex)
IProtocol
sendKeyPressEvent
in interface IProtocol
public MessageInfo sendPowerPinIntensity(Link link, int pin, int intensity)
IProtocol
sendPowerPinIntensity
in interface IProtocol
public MessageInfo sendPowerPinSwitch(Link link, int pin, int power)
IProtocol
sendPowerPinSwitch
in interface IProtocol
public MessageInfo sendToneMessage(Link link, int pin, int frequency)
IProtocol
sendToneMessage
in interface IProtocol
public MessageInfo sendToneMessage(Link link, int pin, int frequency, int duration)
IProtocol
sendToneMessage
in interface IProtocol
public MessageInfo sendNoToneMessage(Link link, int pin)
IProtocol
sendNoToneMessage
in interface IProtocol
public MessageInfo sendCustomMessage(Link link, String message)
IProtocol
sendCustomMessage
in interface IProtocol
public MessageInfo sendKeyPressEvent(Link link, char keychar, int keycode, int keylocation, int keymodifiers, int keymodifiersex, ReplyMessageCallback callback)
IProtocol
sendKeyPressEvent
in interface IProtocol
public MessageInfo sendPowerPinIntensity(Link link, int pin, int intensity, ReplyMessageCallback callback)
IProtocol
sendPowerPinIntensity
in interface IProtocol
public MessageInfo sendPowerPinSwitch(Link link, int pin, int power, ReplyMessageCallback callback)
IProtocol
sendPowerPinSwitch
in interface IProtocol
public MessageInfo sendToneMessage(Link link, int pin, int frequency, ReplyMessageCallback callback)
IProtocol
sendToneMessage
in interface IProtocol
public MessageInfo sendToneMessage(Link link, int pin, int frequency, int duration, ReplyMessageCallback callback)
IProtocol
sendToneMessage
in interface IProtocol
public MessageInfo sendNoToneMessage(Link link, int pin, ReplyMessageCallback callback)
IProtocol
sendNoToneMessage
in interface IProtocol
public MessageInfo sendCustomMessage(Link link, String message, ReplyMessageCallback callback)
IProtocol
sendCustomMessage
in interface IProtocol
public IncomingMessageEvent parseMessage(int[] realMsg)
IProtocol
parseMessage
in interface IProtocol
public MessageInfo startListenDigitalPin(Link link, int pin)
IProtocol
startListenDigitalPin
in interface IProtocol
public MessageInfo stopListenDigitalPin(Link link, int pin)
IProtocol
stopListenDigitalPin
in interface IProtocol
public MessageInfo startListenAnalogPin(Link link, int pin)
IProtocol
startListenAnalogPin
in interface IProtocol
public MessageInfo stopListenAnalogPin(Link link, int pin)
IProtocol
stopListenAnalogPin
in interface IProtocol
public MessageInfo startListenDigitalPin(Link link, int pin, ReplyMessageCallback callback)
IProtocol
startListenDigitalPin
in interface IProtocol
public MessageInfo stopListenDigitalPin(Link link, int pin, ReplyMessageCallback callback)
IProtocol
stopListenDigitalPin
in interface IProtocol
public MessageInfo startListenAnalogPin(Link link, int pin, ReplyMessageCallback callback)
IProtocol
startListenAnalogPin
in interface IProtocol
public MessageInfo stopListenAnalogPin(Link link, int pin, ReplyMessageCallback callback)
IProtocol
stopListenAnalogPin
in interface IProtocol
public String getProtocolName()
getProtocolName
in interface IProtocol
public IProtocol.ProtocolType getProtocolType()
getProtocolType
in interface IProtocol
public int getIncomingMessageDivider()
IProtocol
getIncomingMessageDivider
in interface IProtocol
public int getOutgoingMessageDivider()
IProtocol
getOutgoingMessageDivider
in interface IProtocol
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |