com.digi.xbee.api.packet.cellular

Class TXSMSPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.cellular.TXSMSPacket

public class TXSMSPacket
extends XBeeAPIPacket

This class represents a TX (Transmit) SMS packet. Packet is built using the parameters of the constructor or providing a valid API payload.

A TX SMS message will cause the cellular module to send an SMS.

Since:

1.2.0

See Also:

RXSMSPacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
TXSMSPacket(int frameID, String phoneNumber, String data) Class constructor.

Method Summary

Modifier and Type	Method and Description
static TXSMSPacket	createPacket(byte[] payload) Creates a new TXSMSPacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
String	getData() Returns the data to send.
String	getPhoneNumber() Returns the phone number.
byte[]	getPhoneNumberByteArray() Returns the phone number byte array.
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	setData(String data) Sets the data to send.
void	setPhoneNumber(String phoneNumber) Sets the phone number.

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

TXSMSPacket

public TXSMSPacket(int frameID,
                   String phoneNumber,
                   String data)

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

Parameters:

frameID - Frame ID.

phoneNumber - Phone number. Only numbers and '+' prefix allowed.

data - Data to send as body of the SMS message.

Throws:

IllegalArgumentException - if frameID < 0 or if frameID > 255 or if phoneNumber.length() > or if phoneNumber is invalid.

NullPointerException - if phoneNumber == null.

Method Detail

createPacket

public static TXSMSPacket createPacket(byte[] payload)

Creates a new TXSMSPacket object from the given payload.

Parameters:

payload - The API frame payload. It must start with the frame type corresponding to a TX SMS packet (0x1F). The byte array must be in OperatingMode.API mode.

Returns:

Parsed TX SMS packet.

Throws:

IllegalArgumentException - if payload[0] != APIFrameType.TX_SMS.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.

getData

public String getData()

Returns the data to send.

Returns:

Data to send.

See Also:

setData(String)

getPhoneNumber

public String getPhoneNumber()

Returns the phone number.

Returns:

The phone number.

See Also:

getPhoneNumberByteArray(), setPhoneNumber(String)

getPhoneNumberByteArray

public byte[] getPhoneNumberByteArray()

Returns the phone number byte array.

Returns:

The phone number byte array.

See Also:

getPhoneNumber(), setPhoneNumber(String)

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.

setData

public void setData(String data)

Sets the data to send.

Parameters:

data - Data to send.

See Also:

getData()

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

Sets the phone number.

Only numbers and '+' prefix allowed.

Parameters:

phoneNumber - The phone number.

Throws:

IllegalArgumentException - if phoneNumber.length() > or if phoneNumber is invalid.

NullPointerException - if phoneNumber == null.

See Also:

getPhoneNumber(), getPhoneNumberByteArray()