com.neovisionaries.bluetooth.ble.advertising

Class Ucode

java.lang.Object

com.neovisionaries.bluetooth.ble.advertising.ADStructure

com.neovisionaries.bluetooth.ble.advertising.ADManufacturerSpecific

com.neovisionaries.bluetooth.ble.advertising.Ucode

All Implemented Interfaces:

Serializable

public class Ucode
extends ADManufacturerSpecific

ucode: 128-bit ID for real objects.

ucode (written in lower case) is a global ID system defined by T-Engine Forum. The specification has been adopted as ITU-T H.642.

This class represents Bluetooth LE ucode Marker which is an AD structure to convey a ucode in BLE advertising packets.

Since:

1.1

See Also:

Packet Format Specification for Bluetooth LE ucode Marker [01.A0.01] (in Japanese), Ucode system, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Ucode() Constructor which creates an instance with version=3, ucode=all-zeros, status=0, power=0, count=0.
Ucode(int length, int type, byte[] data, int companyId) Constructor.

Method Summary

Modifier and Type	Method and Description
static Ucode	create(int length, int type, byte[] data, int companyId) Create a Ucode instance.
int	getCount() Get the transmission count.
int	getInterval() Get the transmission interval in milliseconds.
int	getPower() Get the transmission power in dBm.
int	getStatus() Get the status.
String	getUcode() Get the ucode.
int	getVersion() Get the version of the packet format of Bluetooth LE ucode Marker.
boolean	isBatteryLow() Get the flag value that indicates whether the battery is low or not.
void	setCount(int count) Set the transmission count.
void	setPower(int power) Set the transmission power in dBm.
void	setStatus(int status) Set the status.
void	setUcode(String ucode) Set the ucode.
void	setVersion(int version) Set the version of the packet format of Bluetooth LE ucode Marker.
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

Ucode

public Ucode()

Constructor which creates an instance with version=3, ucode=all-zeros, status=0, power=0, count=0.

Ucode

public Ucode(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 Bluetooth LE ucode Marker.

companyId - The company ID. The value should always be 0x019A (T-Engine Forum).

Throws:

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

Method Detail

getVersion

public int getVersion()

Get the version of the packet format of Bluetooth LE ucode Marker.

Returns:

The version number.

setVersion

public void setVersion(int version)

Set the version of the packet format of Bluetooth LE ucode Marker.

Parameters:

version - The version number. The value should be in the range from 0 to 255.

Throws:

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

getUcode

public String getUcode()

Get the ucode.

Returns:

The string representation of the ucode. It consists of 32 upper-case hex letters.

setUcode

public void setUcode(String ucode)

Set the ucode.

Parameters:

ucode - The string representation of the ucode. It must consist of 32 hex letters.

Throws:

IllegalArgumentException - ucode is null or it does not consist of 32 hex letters.

getStatus

public int getStatus()

Get the status.

The meanings of the bits are as follows.

7	6	5	4	3	2	1	0
Reserved	Reserved	Low Battery	1	Transmission Interval

Combinations of the bits of Transmission Interval have the following meanings.

Bits	Interval (ms)
0b0000	10
0b0001	20
0b0010	40
0b0011	80
0b0100	160
0b0101	320
0b0110	640
0b0111	1280
0b1000	2560
0b1001	5120
Others	10240

Returns:

The status.

setStatus

public void setStatus(int status)

Set the status.

Parameters:

status - The status.

isBatteryLow

public boolean isBatteryLow()

Get the flag value that indicates whether the battery is low or not.

The returned value is the boolean representation of the Low Battery bit of the status.

Returns:

The flag value that indicates whether the battery is low or not.

getInterval

public int getInterval()

Get the transmission interval in milliseconds.

The returned value is calculated from the bits of Transmission Interval in the status.

Returns:

The transmission interval in milliseconds.

getPower

public int getPower()

Get the transmission power in dBm.

Returns:

The transmission power in dBm.

setPower

public void setPower(int power)

Set the transmission power in dBm.

Parameters:

power - The transmission power in dBm. The valid range is from -128 to 127.

Throws:

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

getCount

public int getCount()

Get the transmission count.

The value of the transmission count field is incremented per transmission. Note that the next value of 0xFF is 0x00.

Returns:

The transmission count.

setCount

public void setCount(int count)

Set the transmission count.

Parameters:

count - The transmission count. The value should be in the range from 0x00 to 0xFF.

Throws:

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

create

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

Create a Ucode instance.

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

	Value	Description
Company ID	0x9A 0x01	The company ID assigned to T-Engine Forum. (Little Endian)
Version	1-byte unsigned number	The version number of Bluetooth LE ucode Marker.
Ucode	16-byte data	Ucode in the little endian order.
Status	1-byte data	Bit flags that represents the status of the peripheral device.
Transmission Power	1-byte signed number.	Transmission power in dBm.
Transmission Count	1-byte unsigned number.	The counter value incremented per transmission.
Reserved	3-byte zeros.	Reserved for future use.

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 0x019A which represents T-Engine Forum

Returns:

A Ucode instance. null is returned if the length of data is less than 22.

toString

public String toString()

Overrides:

toString in class ADManufacturerSpecific