com.digi.xbee.api.packet.thread

Class IPv6RemoteATCommandRequestPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

public class IPv6RemoteATCommandRequestPacket
extends XBeeAPIPacket

This class represents an IPv6 Remote AT Command Request packet. Packet is built using the parameters of the constructor.

Used to query or set module parameters on a remote device identified by an IPv6 address. For parameter changes on the remote device to take effect, changes must be applied, either by setting the apply changes options bit, or by sending an AC command to the remote.

Remote Command options are set as a bitfield.

If configured, command response is received as an IPv6 Remote AT Command Response packet. See IPv6RemoteATCommandResponsePacket.

Since:

1.2.1

See Also:

IPv6RemoteATCommandResponsePacket, XBeeAPIPacket

Field Summary

Fields inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
IPv6RemoteATCommandRequestPacket(int frameID, Inet6Address destAddress, int transmitOptions, String command, byte[] parameter) Class constructor.
IPv6RemoteATCommandRequestPacket(int frameID, Inet6Address destAddress, int transmitOptions, String command, String parameter) Class constructor.

Method Summary

Modifier and Type	Method and Description
static IPv6RemoteATCommandRequestPacket	createPacket(byte[] payload) Creates a new IPv6RemoteATCommandRequestPacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
String	getCommand() Returns the AT Command.
Inet6Address	getDestAddress() Retrieves the destination IPv6 address.
byte[]	getParameter() Returns the AT command parameter as byte array.
String	getParameterAsString() Returns the AT command parameter as String.
int	getTransmitOptions() Returns the transmit options bitfield.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setParameter(byte[] parameter) Sets the AT command parameter as byte array.
void	setParameter(String parameter) Sets the AT command parameter as String.

Methods inherited from class com.digi.xbee.api.packet.XBeeAPIPacket

checkFrameID, getAPIData, getFrameID, getFrameType, getFrameTypeValue, getPacketData, isBroadcast, setFrameID

Methods inherited from class com.digi.xbee.api.packet.XBeePacket

equals, generateByteArray, generateByteArrayEscaped, getChecksum, getPacketLength, getParameters, hashCode, parsePacket, parsePacket, toPrettyString, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPv6RemoteATCommandRequestPacket

public IPv6RemoteATCommandRequestPacket(int frameID,
                                        Inet6Address destAddress,
                                        int transmitOptions,
                                        String command,
                                        byte[] parameter)

Class constructor. Instantiates a new IPv6RemoteATCommandRequestPacket object with the given parameters.

Parameters:

frameID - Frame ID.

destAddress - IPv6 address of the destination device.

transmitOptions - Bitfield of supported transmission options.

command - AT command.

parameter - AT command parameter as byte array.

Throws:

IllegalArgumentException - if frameID < 0 or if frameID > 255 or if transmitOptions != or if transmitOptions != .

NullPointerException - if destAddress == null or if command == null.

See Also:

Inet6Address, RemoteATCommandOptions

IPv6RemoteATCommandRequestPacket

public IPv6RemoteATCommandRequestPacket(int frameID,
                                        Inet6Address destAddress,
                                        int transmitOptions,
                                        String command,
                                        String parameter)

Class constructor. Instantiates a new IPv6RemoteATCommandRequestPacket object with the given parameters.

Parameters:

frameID - The Frame ID.

destAddress - IPv6 address of the destination device.

transmitOptions - Bitfield of supported transmission options.

command - AT command.

parameter - AT command parameter as String.

Throws:

IllegalArgumentException - if frameID < 0 or if frameID > 255 or if transmitOptions != or if transmitOptions != .

NullPointerException - if destAddress == null or if command == null.

See Also:

Inet6Address, RemoteATCommandOptions

Method Detail

createPacket

public static IPv6RemoteATCommandRequestPacket createPacket(byte[] payload)

Creates a new IPv6RemoteATCommandRequestPacket object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to an IPv6 Remote AT Command packet (0x1B). The byte array must be in OperatingMode.API mode.

Returns:

Parsed IPv6 Remote AT Command Request packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.IPV6_REMOTE_AT_COMMAND_REQUEST.getValue() or if payload.length < or

NullPointerException - if payload == null.

getAPIPacketParameters

public LinkedHashMap<String,String> getAPIPacketParameters()

Description copied from class: XBeeAPIPacket

Returns a map with the XBee packet parameters and their values.

Returns:

A sorted map containing the XBee packet parameters with their values.

getCommand

public String getCommand()

Returns the AT Command.

Returns:

The AT Command.

getDestAddress

public Inet6Address getDestAddress()

Retrieves the destination IPv6 address.

Returns:

The destination IPv6 address.

See Also:

Inet6Address

getParameter

public byte[] getParameter()

Returns the AT command parameter as byte array.

Returns:

The AT command parameter as byte array.

See Also:

getParameterAsString(), setParameter(String parameter), setParameter(byte[] parameter)

getParameterAsString

public String getParameterAsString()

Returns the AT command parameter as String.

Returns:

The AT command parameter as String, null if not parameter is set.

See Also:

getParameter(), setParameter(String parameter), setParameter(byte[] parameter)

getTransmitOptions

public int getTransmitOptions()

Returns the transmit options bitfield.

Returns:

Transmit options bitfield.

See Also:

RemoteATCommandOptions

needsAPIFrameID

public boolean needsAPIFrameID()

Description copied from class: XBeeAPIPacket

Returns whether the API packet needs API Frame ID or not.

Specified by:

needsAPIFrameID in class XBeeAPIPacket

Returns:

true if the packet needs API Frame ID, false otherwise.

setParameter

public void setParameter(byte[] parameter)

Sets the AT command parameter as byte array.

Parameters:

parameter - The AT command parameter as byte array.

See Also:

getParameter(), getParameterAsString(), setParameter(String)

setParameter

public void setParameter(String parameter)

Sets the AT command parameter as String.

Parameters:

parameter - The AT command parameter as String.

See Also:

getParameter(), getParameterAsString(), setParameter(byte[])