com.idevicesinc.sweetblue.utils

Class BleScanRecord

java.lang.Object

com.idevicesinc.sweetblue.utils.BleScanRecord

All Implemented Interfaces:

UsesCustomNull

public final class BleScanRecord
extends java.lang.Object
implements UsesCustomNull

Class used to store information from a BLE scan record. This class can also be used to create a scan record.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BleScanRecord.Option Enumeration for advertising options

Field Summary

Fields

Modifier and Type	Field and Description
static BleScanRecord	NULL

Constructor Summary

Constructors

Constructor and Description
BleScanRecord() Basic constructor to use if you are building a scan record to advertise.
BleScanRecord(Pointer<java.lang.Integer> advFlags, Pointer<java.lang.Integer> txPower, java.util.List<java.util.UUID> serviceUuids, boolean uuidCompleteList, java.util.List<ManufacturerData> mfgData, java.util.Map<java.util.UUID,byte[]> serviceData, java.lang.String localName, boolean shortName) Constructor used internally when a BleDevice is discovered.
BleScanRecord(Pointer<java.lang.Integer> advFlags, Pointer<java.lang.Integer> txPower, java.util.List<java.util.UUID> serviceUuids, boolean uuidCompleteList, short mfgId, byte[] mfgData, java.util.Map<java.util.UUID,byte[]> serviceData, java.lang.String localName, boolean shortName) Old Constructor used to be used internally when a BleDevice is discovered.
BleScanRecord(java.util.UUID serviceUuid)
BleScanRecord(java.util.UUID[] serviceUuids, BleScanRecord.Option... options)
BleScanRecord(java.util.UUID serviceUuid, BleScanRecord.Option... options)
BleScanRecord(java.util.UUID serviceUuid, byte[] serviceData)
BleScanRecord(java.util.UUID serviceUuid, byte[] serviceData, BleScanRecord.Option... options)

Method Summary

Modifier and Type	Method and Description
BleScanRecord	addManufacturerData(short manId, byte[] data) Add some manufacturer data, along with the given manufacturer id to the backing List.
BleScanRecord	addServiceData(java.util.Map<java.util.UUID,byte[]> data) Set the service data for this BleScanRecord instance.
BleScanRecord	addServiceData(java.util.UUID uuid, byte[] data) Add the given UUID and data to this instance's service data map.
BleScanRecord	addServiceUuid(java.util.UUID uuid) Overload of addServiceUuid(UUID, BleUuid.UuidSize), which sets the size to BleUuid.UuidSize.SHORT, if it can fit, otherwise it will default to BleUuid.UuidSize.FULL
BleScanRecord	addServiceUuid(java.util.UUID uuid, BleUuid.UuidSize size) Add a UUID with the given BleUuid.UuidSize to this instance's UUID list.
BleScanRecord	addServiceUUIDs(java.util.List<java.util.UUID> uuids) Add the given List of UUIDs to this instance's UUID list.
byte[]	buildPacket() Build a byte[] scan record from the data stored in this instance.
BleScanRecord	clearServiceData() Clear all service data that may be in this BleScanRecord instance.
BleScanRecord	clearServiceUUIDs() Clears any service UUIDs in this instance.
Pointer<java.lang.Integer>	getAdvFlags() Get the advertising flags for this instance.
byte[]	getManufacturerData() Get the manufacturer data from this instance.
java.util.List<ManufacturerData>	getManufacturerDataList() Returns a List of all manufacturer data parsed in the scan record.
short	getManufacturerId() Get the manufacturer Id from this BleScanRecord instance.
java.lang.String	getName() Returns the device name
java.util.Map<java.util.UUID,byte[]>	getServiceData() Returns a Map of the service data in this instance.
java.util.List<java.util.UUID>	getServiceUUIDS() Returns a list of service UUIDs.
Pointer<java.lang.Integer>	getTxPower() Gets the Tx power
boolean	hasUuid(java.util.UUID uuid) Returns true if this advertising packet contains the uuid given.
boolean	includesDeviceName() Returns whether the resulting advertising packet will have the device name included or not.
boolean	includesTxPowerLevel() Returns whether the resulting advertising packet will have the TX Power level included or not.
boolean	isConnectable() Returns whether the resulting advertising packet will have the connectable flag set or not.
boolean	isNull() Returns true if this instance is considered null.
boolean	isShortName() Returns whether the name is a shortened version or not.
BleScanRecord	setAdvFlags(byte... flags) Convenience method to set the advertising flags, which allows you to pass in every flag you want, and this method will OR them together for you.
BleScanRecord	setAdvFlags(byte mask) Set the advertising flags.
BleScanRecord	setManufacturerDataList(java.util.List<ManufacturerData> list) Sets this BleScanRecord's manufacturer data list.
BleScanRecord	setName(java.lang.String name) Overload of setName(String, boolean), which defaults to a complete name (not short).
BleScanRecord	setName(java.lang.String name, boolean shortName) Set the device name, and if it's a shortened name or not.
BleScanRecord	setOptions(BleScanRecord.Option... options) Set the options for this scan record.
BleScanRecord	setTxPower(byte power) Set the TX power

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final BleScanRecord NULL

Constructor Detail

BleScanRecord

public BleScanRecord()

Basic constructor to use if you are building a scan record to advertise.

BleScanRecord

public BleScanRecord(java.util.UUID serviceUuid)

BleScanRecord

public BleScanRecord(java.util.UUID serviceUuid,
                     byte[] serviceData)

BleScanRecord

public BleScanRecord(java.util.UUID serviceUuid,
                     byte[] serviceData,
                     BleScanRecord.Option... options)

BleScanRecord

public BleScanRecord(java.util.UUID serviceUuid,
                     BleScanRecord.Option... options)

BleScanRecord

public BleScanRecord(java.util.UUID[] serviceUuids,
                     BleScanRecord.Option... options)

BleScanRecord

public BleScanRecord(Pointer<java.lang.Integer> advFlags,
                     Pointer<java.lang.Integer> txPower,
                     java.util.List<java.util.UUID> serviceUuids,
                     boolean uuidCompleteList,
                     short mfgId,
                     byte[] mfgData,
                     java.util.Map<java.util.UUID,byte[]> serviceData,
                     java.lang.String localName,
                     boolean shortName)

Old Constructor used to be used internally when a BleDevice is discovered. Now, BleScanRecord(Pointer, Pointer, List, boolean, List, Map, String, boolean) is used instead.

BleScanRecord

public BleScanRecord(Pointer<java.lang.Integer> advFlags,
                     Pointer<java.lang.Integer> txPower,
                     java.util.List<java.util.UUID> serviceUuids,
                     boolean uuidCompleteList,
                     java.util.List<ManufacturerData> mfgData,
                     java.util.Map<java.util.UUID,byte[]> serviceData,
                     java.lang.String localName,
                     boolean shortName)

Constructor used internally when a BleDevice is discovered.

Method Detail

clearServiceData

public final BleScanRecord clearServiceData()

Clear all service data that may be in this BleScanRecord instance. See also clearServiceUUIDs().

addServiceData

public final BleScanRecord addServiceData(java.util.Map<java.util.UUID,byte[]> data)

Set the service data for this BleScanRecord instance.

setOptions

public final BleScanRecord setOptions(BleScanRecord.Option... options)

Set the options for this scan record. This only applies when this class is used with BleServer to advertise itself.

See Also:

BleScanRecord.Option

isConnectable

public final boolean isConnectable()

Returns whether the resulting advertising packet will have the connectable flag set or not.

includesTxPowerLevel

public final boolean includesTxPowerLevel()

Returns whether the resulting advertising packet will have the TX Power level included or not.

includesDeviceName

public final boolean includesDeviceName()

Returns whether the resulting advertising packet will have the device name included or not.

clearServiceUUIDs

public final BleScanRecord clearServiceUUIDs()

Clears any service UUIDs in this instance.

addServiceUUIDs

public final BleScanRecord addServiceUUIDs(java.util.List<java.util.UUID> uuids)

Add the given List of UUIDs to this instance's UUID list.

addServiceData

public final BleScanRecord addServiceData(java.util.UUID uuid,
                                          byte[] data)

Add the given UUID and data to this instance's service data map.

addServiceUuid

public final BleScanRecord addServiceUuid(java.util.UUID uuid,
                                          BleUuid.UuidSize size)

Add a UUID with the given BleUuid.UuidSize to this instance's UUID list.

addServiceUuid

public final BleScanRecord addServiceUuid(java.util.UUID uuid)

Overload of addServiceUuid(UUID, BleUuid.UuidSize), which sets the size to BleUuid.UuidSize.SHORT, if it can fit, otherwise it will default to BleUuid.UuidSize.FULL

addManufacturerData

public final BleScanRecord addManufacturerData(short manId,
                                               byte[] data)

Add some manufacturer data, along with the given manufacturer id to the backing List.

setManufacturerDataList

public final BleScanRecord setManufacturerDataList(java.util.List<ManufacturerData> list)

Sets this BleScanRecord's manufacturer data list. This creates a new list from the one given.

setName

public final BleScanRecord setName(java.lang.String name)

Overload of setName(String, boolean), which defaults to a complete name (not short).

setName

public final BleScanRecord setName(java.lang.String name,
                                   boolean shortName)

Set the device name, and if it's a shortened name or not.

getManufacturerId

public final short getManufacturerId()

Get the manufacturer Id from this BleScanRecord instance. This is a convenience method. This simply returns the first item in the List holding all manufacturer data.

See Also:

getManufacturerDataList()

getManufacturerData

public final byte[] getManufacturerData()

Get the manufacturer data from this instance. This is a convenience method. This simply returns the first item in the List holding all manufacturer data.

See Also:

getManufacturerDataList()

getManufacturerDataList

public final java.util.List<ManufacturerData> getManufacturerDataList()

Returns a List of all manufacturer data parsed in the scan record.

setAdvFlags

public final BleScanRecord setAdvFlags(byte mask)

Set the advertising flags. This method expects a byte bitmask (so all flags are already OR'd).

setAdvFlags

public final BleScanRecord setAdvFlags(byte... flags)

Convenience method to set the advertising flags, which allows you to pass in every flag you want, and this method will OR them together for you.

getAdvFlags

public final Pointer<java.lang.Integer> getAdvFlags()

Get the advertising flags for this instance.

setTxPower

public final BleScanRecord setTxPower(byte power)

Set the TX power

getTxPower

public final Pointer<java.lang.Integer> getTxPower()

Gets the Tx power

getServiceUUIDS

public final java.util.List<java.util.UUID> getServiceUUIDS()

Returns a list of service UUIDs. This ONLY includes UUIDs that do NOT have any data associated with them. See also getServiceData().

getServiceData

public final java.util.Map<java.util.UUID,byte[]> getServiceData()

Returns a Map of the service data in this instance. See also getServiceUUIDS().

getName

public final java.lang.String getName()

Returns the device name

isShortName

public final boolean isShortName()

Returns whether the name is a shortened version or not.

isNull

public final boolean isNull()

Returns true if this instance is considered null.

Specified by:

isNull in interface UsesCustomNull

buildPacket

public final byte[] buildPacket()

Build a byte[] scan record from the data stored in this instance.

hasUuid

public boolean hasUuid(java.util.UUID uuid)

Returns true if this advertising packet contains the uuid given.