org.eclipse.kura.bluetooth.le.beacon

Interface BluetoothLeBeaconAdvertiser<T extends BluetoothLeBeacon>

@ProviderType
public interface BluetoothLeBeaconAdvertiser<T extends BluetoothLeBeacon>

BluetoothLeBeaconAdvertising allows to manage the advertising mechanism for Bluetooth LE beacons.

Since:

1.3

Method Summary

Modifier and Type	Method and Description
BluetoothLeAdapter	getAdapter() Get the bluetooth adapter this advertiser is associated to.
void	startBeaconAdvertising() Start Beacon advertising.
void	stopBeaconAdvertising() Stop Beacon advertising.
void	updateBeaconAdvertisingData(T beacon) Set the data in to the Beacon advertising packet.
void	updateBeaconAdvertisingInterval(java.lang.Integer min, java.lang.Integer max) Set the minimum and maximum Beacon advertising interval.

Method Detail

startBeaconAdvertising

void startBeaconAdvertising()
                     throws KuraBluetoothCommandException

Start Beacon advertising. If the advertising has been already started or an error is detected, this method throws a KuraBluetoothCommandException.

Throws:

KuraBluetoothCommandException

stopBeaconAdvertising

void stopBeaconAdvertising()
                    throws KuraBluetoothCommandException

Stop Beacon advertising. If the advertising has been already stopped or an error is detected, this method throws a KuraBluetoothCommandException.

Throws:

KuraBluetoothCommandException

updateBeaconAdvertisingInterval

void updateBeaconAdvertisingInterval(java.lang.Integer min,
                                     java.lang.Integer max)
                              throws KuraBluetoothCommandException

Set the minimum and maximum Beacon advertising interval. Both intervals are computed as Nx0.625 ms, where N can vary from 14 to 65534. So, the minimum and maximum intervals are in the range 8.75ms - 40.9s. Note that further limitations can be introduced by the hardware Bluetooth controller.

Parameters:

min - Minimum time interval between advertises

max - Maximum time interval between advertises

Throws:

KuraBluetoothCommandException

updateBeaconAdvertisingData

void updateBeaconAdvertisingData(T beacon)
                          throws KuraBluetoothCommandException

Set the data in to the Beacon advertising packet.

Parameters:

beacon - An instance of BluetoothLeBeacon class

Throws:

KuraBluetoothCommandException

getAdapter

BluetoothLeAdapter getAdapter()

Get the bluetooth adapter this advertiser is associated to.

Returns:

BluetoothLeAdapter