Class BluetoothUnlockPacket

This class represents a Bluetooth Unlock packet.

Inheritance
System.Object
XBeePacket
XBeeAPIPacket
BluetoothUnlockPacket
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: XBeeLibrary.Core.Packet.Bluetooth
Assembly: XBeeLibrary.Core.dll
Syntax
public class BluetoothUnlockPacket : XBeeAPIPacket

Constructors

BluetoothUnlockPacket(SrpPhase, Byte[])

Class constructor. Instantiates a BluetoothUnlockPacket with the given parameters.

Declaration
public BluetoothUnlockPacket(SrpPhase phase, byte[] data)
Parameters
Type Name Description
SrpPhase phase

The SRP phase.
System.Byte[] data

The data.
Exceptions
Type Condition
System.ArgumentException

If phase is UNKNOWN.
System.ArgumentNullException

If data is null.
See Also

Properties

APIPacketParameters

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

Declaration
protected override LinkedDictionary<string, string> APIPacketParameters { get; }
Property Value
Type Description
LinkedDictionary<System.String, System.String>

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

APIPacketSpecificData

Gets the XBee API packet specific data.

Declaration
protected override byte[] APIPacketSpecificData { get; }
Property Value
Type Description
System.Byte[]
Overrides
Remarks

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

Data

The data to send.

Declaration
public byte[] Data { get; }
Property Value
Type Description
System.Byte[]

IsBroadcast

Indicates whether the packet is a broadcast packet.

Declaration
public override bool IsBroadcast { get; }
Property Value
Type Description
System.Boolean
Overrides

NeedsAPIFrameID

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

Declaration
public override bool NeedsAPIFrameID { get; }
Property Value
Type Description
System.Boolean
Overrides

SrpPhase

The SRP Phase.

Declaration
public SrpPhase SrpPhase { get; }
Property Value
Type Description
SrpPhase
See Also

Methods

CreatePacket(Byte[])

Creates a new BluetoothUnlockPacket object from the given payload.

Declaration
public static BluetoothUnlockPacket CreatePacket(byte[] payload)
Parameters
Type Name Description
System.Byte[] 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 API mode.
Returns
Type Description
BluetoothUnlockPacket

Parsed Bluetooth Unlock packet.
Exceptions
Type Condition
System.ArgumentException

If payload[0] != APIFrameType.BLE_UNLOCK.GetValue() or if payload.Length < XBeeLibrary.Core.Packet.Bluetooth.BluetoothUnlockPacket.MIN_API_PAYLOAD_LENGTH.
System.ArgumentNullException

If payload == null.

See Also