SunSPOT API V5.0


com.sun.spot.peripheral.radio
Interface IProprietaryMAC


public interface IProprietaryMAC


Method Summary
 int getChannelAccessFailure()
           
 int getMaxReceiveQueueLength()
          Get the maximum number of packets that can be in the MAC layer's RX queue before the radio is turned off.
 int getNoAck()
           
 int getNullPacketAfterAckWait()
           
 int getPLMETransmitPower()
          Passthrough to allow direct access to the physical layer facility for querying the power.
 int getReceiveQueueLengthToDropBroadcastPackets()
          Get the maximum number of packets that that can be in the MAC layer's RX queue before it starts discarding broadcast packets.
 int getRxError()
           
 int getWrongAck()
           
 void resetErrorCounters()
          Reset the NullPacketAfterAckWait, ChannelAccessFailure, NoAck, WrongAck and RxError counters to zero.
 void setMaxReceiveQueueLength(int maxPackets)
          Set the maximum number of packets that can be in the MAC layer's RX queue before the radio is turned off.
 void setPLMEChannel(int channel)
          Passthrough to allow direct access to the physical layer facility for setting the radio channel.
 void setPLMETransmitPower(int power)
          Passthrough to allow direct access to the physical layer facility for setting the power.
 void setReceiveQueueLengthToDropBroadcastPackets(int maxPackets)
          Set the maximum number of packets that that can be in the MAC layer's RX queue before it starts discarding broadcast packets.
 

Method Detail

getNullPacketAfterAckWait

int getNullPacketAfterAckWait()
Returns:
the count of times we saw rx data waiting when polling for ack but didn't subsequently get an ACK packet

getChannelAccessFailure

int getChannelAccessFailure()
Returns:
the count of times there was a channel access failure

getNoAck

int getNoAck()
Returns:
the count of times we timed out waiting for an ack

getWrongAck

int getWrongAck()
Returns:
the count of times we got an ack that wasn't the one we expected

getRxError

int getRxError()
Returns:
the count of times we got a badly formed packet

resetErrorCounters

void resetErrorCounters()
Reset the NullPacketAfterAckWait, ChannelAccessFailure, NoAck, WrongAck and RxError counters to zero.


setPLMEChannel

void setPLMEChannel(int channel)
Passthrough to allow direct access to the physical layer facility for setting the radio channel.

Parameters:
channel - number (between 11 and 26)

setPLMETransmitPower

void setPLMETransmitPower(int power)
Passthrough to allow direct access to the physical layer facility for setting the power.

Parameters:
power - an integer in the range -32..+31

getPLMETransmitPower

int getPLMETransmitPower()
Passthrough to allow direct access to the physical layer facility for querying the power.

Returns:
current power setting
See Also:
I802_15_4_PHY.plmeGet(int)

setMaxReceiveQueueLength

void setMaxReceiveQueueLength(int maxPackets)
Set the maximum number of packets that can be in the MAC layer's RX queue before the radio is turned off. The radio will remain off until the queue size drops below the value set in setReceiveQueueLengthToDropBroadcastPackets(int)

Parameters:
maxPackets -

setReceiveQueueLengthToDropBroadcastPackets

void setReceiveQueueLengthToDropBroadcastPackets(int maxPackets)
Set the maximum number of packets that that can be in the MAC layer's RX queue before it starts discarding broadcast packets. Note that until the limit in setMaxReceiveQueueLength(int) is reached point-to-point packets will still be received.

Parameters:
maxPackets -

getMaxReceiveQueueLength

int getMaxReceiveQueueLength()
Get the maximum number of packets that can be in the MAC layer's RX queue before the radio is turned off. The radio will remain off until the queue size drops below the value of getReceiveQueueLengthToDropBroadcastPackets().

Returns:
the number of packets

getReceiveQueueLengthToDropBroadcastPackets

int getReceiveQueueLengthToDropBroadcastPackets()
Get the maximum number of packets that that can be in the MAC layer's RX queue before it starts discarding broadcast packets. Note that until the limit in getMaxReceiveQueueLength() is reached point-to-point packets will still be received.

Returns:
the number of packets

SunSPOT API V5.0


Copyright � 2006-2008 Sun Microsystems, Inc. All Rights Reserved.