com.digi.xbee.api.packet.wifi

Class RemoteATCommandWifiPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

public class RemoteATCommandWifiPacket
extends XBeeAPIPacket

This class represents a Remote AT Command Request (Wi-Fi) packet. Packet is built using the parameters of the constructor or providing a valid API payload.

Used to query or set module parameters on a remote device. 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 node.

Remote Command options are set as a bitfield.

If configured, command response is received as a RemoteATCommandResponseWifi packet.

Since:

1.2.0

See Also:

RemoteATCommandResponseWifiPacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static RemoteATCommandWifiPacket	createPacket(byte[] payload) Creates a new RemoteATCommandWifiPacket 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.
Inet4Address	getDestinationAddress() Retrieves the IP destination address.
byte[]	getParameter() Returns the AT command parameter.
String	getParameterAsString() Returns the AT command parameter as String.
int	getTransmitOptions() Returns the transmit options bitfield.
boolean	isBroadcast() Returns whether or not the packet is a broadcast packet.
boolean	needsAPIFrameID() Returns whether the API packet needs API Frame ID or not.
void	setParameter(byte[] parameter) Sets the AT command parameter.
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, 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

RemoteATCommandWifiPacket

public RemoteATCommandWifiPacket(int frameID,
                                 Inet4Address destAddress,
                                 int transmitOptions,
                                 String command,
                                 byte[] parameter)

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

Parameters:

frameID - The Frame ID.

destAddress - IP 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 < 0 or if transmitOptions > 255.

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

See Also:

RemoteATCommandWifiPacket(int, Inet4Address, int, String, String), RemoteATCommandOptions, Inet4Address

RemoteATCommandWifiPacket

public RemoteATCommandWifiPacket(int frameID,
                                 Inet4Address destAddress,
                                 int transmitOptions,
                                 String command,
                                 String parameter)

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

Parameters:

frameID - The Frame ID.

destAddress - IP 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 < 0 or if transmitOptions > 255.

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

See Also:

RemoteATCommandWifiPacket(int, Inet4Address, int, String, byte[]), RemoteATCommandOptions, Inet4Address

Method Detail

createPacket

public static RemoteATCommandWifiPacket createPacket(byte[] payload)

Creates a new RemoteATCommandWifiPacket object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to a Remote AT Command Requst (Wi-Fi) packet (0x07). The byte array must be in OperatingMode.API mode.

Returns:

Parsed Remote AT Command Request (Wi-Fi) packet.

Throws:

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

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.

getDestinationAddress

public Inet4Address getDestinationAddress()

Retrieves the IP destination address.

Returns:

The IP destination address.

See Also:

Inet4Address

getParameter

public byte[] getParameter()

Returns the AT command parameter.

Returns:

The AT command parameter.

See Also:

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

getParameterAsString

public String getParameterAsString()

Returns the AT command parameter as String.

Returns:

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

See Also:

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

getTransmitOptions

public int getTransmitOptions()

Returns the transmit options bitfield.

Returns:

Transmit options bitfield.

See Also:

RemoteATCommandOptions

isBroadcast

public boolean isBroadcast()

Description copied from class: XBeeAPIPacket

Returns whether or not the packet is a broadcast packet.

Specified by:

isBroadcast in class XBeeAPIPacket

Returns:

true if the packet is a broadcast packet, false otherwise.

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.

Parameters:

parameter - The AT command parameter.

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[])