com.digi.xbee.api.packet.bluetooth

Class BluetoothUnlockPacket

java.lang.Object

com.digi.xbee.api.packet.XBeePacket

com.digi.xbee.api.packet.XBeeAPIPacket

com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

public class BluetoothUnlockPacket
extends XBeeAPIPacket

This class represents a Bluetooth Unlock packet. Packet is built using the parameters of the constructor.

The Bluetooth Unlock packet is used to authenticate a connection on the Bluetooth interface and unlock the processing of AT command frames.

The unlock process is an implementation of the SRP (Secure Remote Password) algorithm using the RFC5054 1024-bit group and the SHA-256 hash algorithm. The value of I is fixed to the username apiservice.

Upon completion, each side will have derived a shared session key which is used to communicate in an encrypted fashion with the peer. Additionally, a Modem Status frame - 0x8A with the status code 0x32 (Bluetooth Connected) is sent through the UART (if AP = 1 or 2). When an unlocked connection is terminated, a Modem Status frame with the status code 0x33 (Bluetooth Disconnected) is sent through the UART.

Since:

1.3.0

See Also:

BluetoothUnlockResponsePacket, XBeeAPIPacket

Field Summary

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

NO_FRAME_ID

Constructor Summary

Constructors

Constructor and Description
BluetoothUnlockPacket(SrpStep srpStep, byte[] data) Class constructor.

Method Summary

Modifier and Type	Method and Description
static BluetoothUnlockPacket	createPacket(byte[] payload) Creates a new BluetoothUnlockPacket object from the given payload.
LinkedHashMap<String,String>	getAPIPacketParameters() Returns a map with the XBee packet parameters and their values.
byte[]	getAPIPacketSpecificData() Returns the XBee API packet specific data.
byte[]	getData() Retrieves the SRP data.
SrpStep	getSrpStep() Retrieves the SRP step.
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(byte[] data) Sets the SRP data.
void	setSrpStep(SrpStep srpStep) Sets the SRP step.

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

BluetoothUnlockPacket

public BluetoothUnlockPacket(SrpStep srpStep,
                             byte[] data)

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

Parameters:

srpStep - The SRP step.

data - Data contained in the packet.

Throws:

NullPointerException - if srpStep == null or if data == null.

Method Detail

createPacket

public static BluetoothUnlockPacket createPacket(byte[] payload)

Creates a new BluetoothUnlockPacket object from the given payload.

Parameters:

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

Returns:

Parsed Bluetooth Unlock packet.

Throws:

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

getAPIPacketSpecificData

public byte[] getAPIPacketSpecificData()

Description copied from class: XBeeAPIPacket

Returns the XBee API packet specific data.

This does not include the frame ID if it is needed.

Returns:

The XBee API packet data.

getData

public byte[] getData()

Retrieves the SRP data.

Returns:

The SRP data.

See Also:

setData(byte[])

getSrpStep

public SrpStep getSrpStep()

Retrieves the SRP step.

Returns:

The SRP step.

See Also:

setSrpStep(SrpStep), SrpStep

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(byte[] data)

Sets the SRP data.

Parameters:

data - The new SRP data.

Throws:

NullPointerException - if data == null.

See Also:

getData()

setSrpStep

public void setSrpStep(SrpStep srpStep)

Sets the SRP step.

Parameters:

srpStep - The new SRP step.

Throws:

NullPointerException - if srpStep == null.

See Also:

getSrpStep(), SrpStep