com.qualcomm.hardware.lynx.commands.standard

Class LynxDiscoveryCommand

java.lang.Object

com.qualcomm.hardware.lynx.commands.LynxMessage

com.qualcomm.hardware.lynx.commands.LynxRespondable<RESPONSE>

com.qualcomm.hardware.lynx.commands.LynxCommand<RESPONSE>

com.qualcomm.hardware.lynx.commands.standard.LynxStandardCommand<LynxAck>

com.qualcomm.hardware.lynx.commands.standard.LynxDiscoveryCommand

public class LynxDiscoveryCommand
extends LynxStandardCommand<LynxAck>

Performs discovery respecting half-duplex aspect of EIA485 communications link. This message is sent to the broadcast address 0xFF. If this message arrives via USB, the Controller Module knows it is USB-connected (a Parent) and may have children on its 485 bus. The Parent issues its own Discovery Response and then takes ownership of the 485 bus. The Parent sends Discovery packets directly to all possible Child addresses (1 ~ 254) in sequence, waiting 2 msec (1kHz system clock guarantees that to be between 1 ~ 2 msec) between each. Any connected Child should respond to the Discovery packet effectively immediately, taking brief control over the child bus to do so. Discovery completes in about 500msec. Once discovered, a Child requires a Keep Alive addressed directly to it (rather than a broadcast message) within the usual KA interval to lock in the child status. If no Keep Alive is received by the Child in time, it reverts to ready-to-discover mode. The discovery packet is sent from the host to the broadcast address (255). Note that the message number of a broadcast message is completely ignored by receivers, as it cannot be guaranteed to be a non-duplicate across all receivers. Note that sending a LynxDiscoveryCommand can in theory result in up to 254 response messages; thus the 'finished' processing of LynxDiscoveryCommands will be special. First, an incoming LynxDiscoveryResponse should be processed unilaterally; the original LynxDiscoveryCommand will NOT have a response expected (nor will it be ackable). Second, after sending a LynxDiscoveryCommand we will wait for a sufficient time to receive all possible responses before ever sending any further messages.

Field Summary

Fields inherited from class com.qualcomm.hardware.lynx.commands.standard.LynxStandardCommand

COMMAND_NUMBER_ACK, COMMAND_NUMBER_DEBUG_LOG_LEVEL, COMMAND_NUMBER_DISCOVERY, COMMAND_NUMBER_DOWNLOAD_CHUNK, COMMAND_NUMBER_FAIL_SAFE, COMMAND_NUMBER_FIRST, COMMAND_NUMBER_GET_MODULE_LED_COLOR, COMMAND_NUMBER_GET_MODULE_LED_PATTERN, COMMAND_NUMBER_GET_MODULE_STATUS, COMMAND_NUMBER_KEEP_ALIVE, COMMAND_NUMBER_LAST, COMMAND_NUMBER_NACK, COMMAND_NUMBER_QUERY_INTERFACE, COMMAND_NUMBER_SET_MODULE_LED_COLOR, COMMAND_NUMBER_SET_MODULE_LED_PATTERN, COMMAND_NUMBER_SET_NEW_MODULE_ADDRESS, COMMAND_NUMBER_START_DOWNLOAD

Fields inherited from class com.qualcomm.hardware.lynx.commands.LynxRespondable

ackOrNackReceived, isAckOrResponseReceived, nackReceived, response, responseOrNackReceived, retransmissionsRemaining

Fields inherited from class com.qualcomm.hardware.lynx.commands.LynxMessage

hasBeenTransmitted, messageNumber, module, nanotimeLastTransmit, payloadTimeWindow, referenceNumber, serialization

Constructor Summary

Constructors

Constructor and Description
LynxDiscoveryCommand(LynxModule module)

Method Summary

Modifier and Type	Method and Description
void	acquireNetworkLock()
void	fromPayloadByteArray(byte[] rgb)
int	getCommandNumber()
int	getDestModuleAddress()
static int	getStandardCommandNumber()
boolean	isAckable()
boolean	isRetransmittable()
protected void	noteAttentionRequired()
void	releaseNetworkLock()
void	send()
LynxAck	sendReceive()
byte[]	toPayloadByteArray()

Methods inherited from class com.qualcomm.hardware.lynx.commands.standard.LynxStandardCommand

isStandardCommandNumber, isStandardPacketId, isStandardResponseNumber

Methods inherited from class com.qualcomm.hardware.lynx.commands.LynxCommand

getResponseClass

Methods inherited from class com.qualcomm.hardware.lynx.commands.LynxRespondable

awaitAckResponseOrNack, awaitAndRetransmit, getMsAwaitInterval, getMsRetransmissionInterval, getNackReceived, hasBeenAcknowledged, isAckOrResponseReceived, isNackReceived, noteRetransmission, onAckReceived, onNackReceived, onPretendTransmit, onResponseReceived, pretendFinish, responseOrThrow, setUnretransmittable, throwIfNack, throwNackForUnsupportedCommand, usePretendResponseIfRealModuleDoesntSupport

Methods inherited from class com.qualcomm.hardware.lynx.commands.LynxMessage

forgetSerialization, getMessageNumber, getModule, getModuleAddress, getNanotimeLastTransmit, getPayloadTimeWindow, getReferenceNumber, getSerialization, hasBeenTransmitted, invokeStaticNullaryMethod, isAck, isNack, isResponse, isResponseExpected, loadFromSerialization, noteHasBeenTransmitted, resetModulePingTimer, setMessageNumber, setModule, setNanotimeLastTransmit, setPayloadTimeWindow, setReferenceNumber, setSerialization

Methods inherited from class java.lang.Object

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

Constructor Detail

LynxDiscoveryCommand

public LynxDiscoveryCommand(LynxModule module)

Method Detail

getDestModuleAddress

public int getDestModuleAddress()

Overrides:

getDestModuleAddress in class LynxMessage

send

public void send()
          throws LynxNackException,
                 java.lang.InterruptedException

Overrides:

send in class LynxRespondable<LynxAck>

Throws:

LynxNackException

java.lang.InterruptedException

sendReceive

public LynxAck sendReceive()
                    throws LynxNackException,
                           java.lang.InterruptedException

Overrides:

sendReceive in class LynxRespondable<LynxAck>

Throws:

LynxNackException

java.lang.InterruptedException

isAckable

public boolean isAckable()

Overrides:

isAckable in class LynxRespondable<LynxAck>

isRetransmittable

public boolean isRetransmittable()

Overrides:

isRetransmittable in class LynxRespondable<LynxAck>

noteAttentionRequired

protected void noteAttentionRequired()

Overrides:

noteAttentionRequired in class LynxRespondable<LynxAck>

acquireNetworkLock

public void acquireNetworkLock()
                        throws java.lang.InterruptedException

Overrides:

acquireNetworkLock in class LynxMessage

Throws:

java.lang.InterruptedException

releaseNetworkLock

public void releaseNetworkLock()
                        throws java.lang.InterruptedException

Overrides:

releaseNetworkLock in class LynxMessage

Throws:

java.lang.InterruptedException

getStandardCommandNumber

public static int getStandardCommandNumber()

getCommandNumber

public int getCommandNumber()

Specified by:

getCommandNumber in class LynxMessage

toPayloadByteArray

public byte[] toPayloadByteArray()

Specified by:

toPayloadByteArray in class LynxMessage

fromPayloadByteArray

public void fromPayloadByteArray(byte[] rgb)

Specified by:

fromPayloadByteArray in class LynxMessage