com.neovisionaries.bluetooth.ble.advertising

Class IBeacon

java.lang.Object

com.neovisionaries.bluetooth.ble.advertising.ADStructure

com.neovisionaries.bluetooth.ble.advertising.ADManufacturerSpecific

com.neovisionaries.bluetooth.ble.advertising.IBeacon

All Implemented Interfaces:

Serializable

public class IBeacon
extends ADManufacturerSpecific

iBeacon.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IBeacon() Constructor which creates an instance with UUID=all-zeros, major=0, minor=0, and power=0.
IBeacon(int length, int type, byte[] data, int companyId) Constructor.

Method Summary

Modifier and Type	Method and Description
static IBeacon	create(int length, int type, byte[] data, int companyId) Create an IBeacon instance.
int	getMajor() Get the major number.
int	getMinor() Get the minor number.
int	getPower() Get the power.
UUID	getUUID() Get the proximity UUID.
void	setMajor(int major) Set the major number.
void	setMinor(int minor) Set the minor number.
void	setPower(int power) Set the power.
void	setUUID(UUID uuid) Set the proximity UUID.
String	toString()

Methods inherited from class com.neovisionaries.bluetooth.ble.advertising.ADManufacturerSpecific

getCompanyId, setCompanyId

Methods inherited from class com.neovisionaries.bluetooth.ble.advertising.ADStructure

getData, getLength, getType, setData, setLength, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IBeacon

public IBeacon()

Constructor which creates an instance with UUID=all-zeros, major=0, minor=0, and power=0.

IBeacon

public IBeacon(int length,
               int type,
               byte[] data,
               int companyId)

Constructor.

Parameters:

length - The length of the AD structure.

type - The AD type. The value should always be 0xFF (Manufacturer Specific Data).

data - The AD data whose format is iBeacon.

companyId - The company ID. The value should always be 0x004C (Apple, Inc.).

Throws:

IllegalArgumentException - data is null or the length of data is less than 25.

Method Detail

getUUID

public UUID getUUID()

Get the proximity UUID.

Returns:

The proximity UUID.

setUUID

public void setUUID(UUID uuid)

Set the proximity UUID.

Parameters:

uuid - The proximity UUID. The value must not be null.

Throws:

IllegalArgumentException - The given value is null.

getMajor

public int getMajor()

Get the major number.

Returns:

The major number.

setMajor

public void setMajor(int major)

Set the major number.

Parameters:

major - The major number. The value should be in the range from 0 to 65535.

Throws:

IllegalArgumentException - The given value is out of the valid range.

getMinor

public int getMinor()

Get the minor number.

Returns:

The minor number.

setMinor

public void setMinor(int minor)

Set the minor number.

Parameters:

minor - The minor number. The value should be in the range from 0 to 65535.

Throws:

IllegalArgumentException - The given value is out of the valid range.

getPower

public int getPower()

Get the power.

Returns:

The power.

setPower

public void setPower(int power)

Set the power.

Parameters:

power - The power. The value should be in the range from -128 to 127.

Throws:

IllegalArgumentException - The given value is out of the valid range.

create

public static IBeacon create(int length,
                             int type,
                             byte[] data,
                             int companyId)

Create an IBeacon instance.

The format of data should be as described in the following table.

	Value	Description
Company ID	0x4C 0x00	The company ID assigned to Apple, Inc. (Little Endian)
Format ID	0x02 0x15	The format ID which represents iBeacon
Proximity UUID	16-byte data	Proximity UUID
Major number	2-byte data	Major number (Big Endian)
Minor number	2-byte data	Minor number (Big Endian)
Power	1-byte data	The 2's complement of the calibrated Tx Power

Parameters:

length - The length of the AD structure.

type - The AD type. The value should always be 0xFF which represents Manufacturer Specific Data.

data - The AD type. The value of the first two bytes is the company ID.

companyId - The company ID. The value should always be 0x004C which represents Apple, Inc.

Returns:

An IBeacon instance. null is returned if the length of data is less than 25.

toString

public String toString()

Overrides:

toString in class ADManufacturerSpecific