org.eclipse.kura.bluetooth

Interface BluetoothAdapter

@ProviderType
public interface BluetoothAdapter

BluetoothAdapter represents the physical Bluetooth adapter on the host machine (ex: hci0).

Method Summary

Modifier and Type	Method and Description
void	disable() Disable the Bluetooth adapter
void	enable() Enable the Bluetooth adapter
void	ExecuteCmd(java.lang.String ogf, java.lang.String ocf, java.lang.String parameter) Execute a command to the given interface.
java.lang.String	getAddress() Get the MAC address of the Bluetooth adapter.
BluetoothDevice	getRemoteDevice(java.lang.String address) Get a remote Bluetooth device based on hardware adress
boolean	isEnabled() Return the status of the adapter
boolean	isLeReady() Return true if the adapter supports Bluetooth LE.
boolean	isScanning() Return true if a lescan is running
void	killLeScan() Kill the process started by startLeScan or startBeaconScan. SIGINT must be sent to the hcitool process.
void	setBeaconAdvertisingData(java.lang.String uuid, java.lang.Integer major, java.lang.Integer minor, java.lang.String companyCode, java.lang.Integer txPower, boolean LELimited, boolean LEGeneral, boolean BR_EDRSupported, boolean LE_BRController, boolean LE_BRHost) Set the data in to the Beacon advertising packet for the given interface.
void	setBeaconAdvertisingInterval(java.lang.Integer min, java.lang.Integer max) Set the Beacon advertising interval for the given interface.
void	startAdvertisementScan(java.lang.String companyName, BluetoothAdvertisementScanListener listener) Starts an asynchronous scan for Bluetooth LE advertisements.
void	startBeaconAdvertising() Start Beacon advertising for the given interface.
void	startBeaconScan(java.lang.String companyName, BluetoothBeaconScanListener listener) Starts an asynchronous scan for Bluetooth LE beacons.
void	startLeScan(BluetoothLeScanListener listener) Starts an asynchronous scan for Bluetooth LE devices.
void	stopBeaconAdvertising() Stop Beacon advertising for the given interface.

Method Detail

getAddress

java.lang.String getAddress()

Get the MAC address of the Bluetooth adapter.

Returns:

The MAC address of the adapter

killLeScan

void killLeScan()

Kill the process started by startLeScan or startBeaconScan.
SIGINT must be sent to the hcitool process. Otherwise the adapter must be toggled (down/up).

isScanning

boolean isScanning()

Return true if a lescan is running

isEnabled

boolean isEnabled()

Return the status of the adapter

Returns:

true if adapter is enabled, false otherwise

isLeReady

boolean isLeReady()

Return true if the adapter supports Bluetooth LE.

Returns:

true if the adapter supports Bluetooth LE, false otherwise

enable

void enable()

Enable the Bluetooth adapter

disable

void disable()

Disable the Bluetooth adapter

startLeScan

void startLeScan(BluetoothLeScanListener listener)

Starts an asynchronous scan for Bluetooth LE devices. Results are relayed through the BluetoothLeScanListener when the scan is complete.

Parameters:

listener - Interface for collecting scan results

startAdvertisementScan

void startAdvertisementScan(java.lang.String companyName,
                            BluetoothAdvertisementScanListener listener)

Starts an asynchronous scan for Bluetooth LE advertisements. Advertisement data is relayed through the BluetoothAdvertisementScanListener as it arrives.

Parameters:

companyName - Hexadecimal string representing the company code

listener - Interface for collecting beacon data.

Since:

1.0.9

startBeaconScan

void startBeaconScan(java.lang.String companyName,
                     BluetoothBeaconScanListener listener)

Starts an asynchronous scan for Bluetooth LE beacons. Beacon data is relayed through the BluetoothBeaconScanListener as it arrives.

Parameters:

companyName - Hexadecimal string representing the company code

listener - Interface for collecting beacon data.

getRemoteDevice

BluetoothDevice getRemoteDevice(java.lang.String address)

Get a remote Bluetooth device based on hardware adress

Parameters:

address - Hardware address of remote device

Returns:

BluetoothDevice

startBeaconAdvertising

void startBeaconAdvertising()

Start Beacon advertising for the given interface.

stopBeaconAdvertising

void stopBeaconAdvertising()

Stop Beacon advertising for the given interface.

setBeaconAdvertisingInterval

void setBeaconAdvertisingInterval(java.lang.Integer min,
                                  java.lang.Integer max)

Set the Beacon advertising interval for the given interface.

Parameters:

min - Minimum time interval between advertises

max - Maximum time interval between advertises

setBeaconAdvertisingData

void setBeaconAdvertisingData(java.lang.String uuid,
                              java.lang.Integer major,
                              java.lang.Integer minor,
                              java.lang.String companyCode,
                              java.lang.Integer txPower,
                              boolean LELimited,
                              boolean LEGeneral,
                              boolean BR_EDRSupported,
                              boolean LE_BRController,
                              boolean LE_BRHost)

Set the data in to the Beacon advertising packet for the given interface.

Parameters:

uuid - Proximity UUID

major - Groups beacons with the same proximity UUID

minor - Differentiates beacons with the same proximity UUID and major value

txPower - Transmitting power \@1m

companyCode - Indicates the manufacturer

LELimited - Indicates LE Limited Discoverable Mode (the device advertises for 30.72s and then stops)

LEGeneral - Indicates LE General Discoverable Mode (the device advertises indefinitely)

BR_EDRSupported - Indicates whether BR/EDR is supported

LE_BRController - Indicates whether LE and BR/EDR Controller operates simultaneously

LE_BRHost - Indicates whether LE and BR/EDR Host operates simultaneously

ExecuteCmd

void ExecuteCmd(java.lang.String ogf,
                java.lang.String ocf,
                java.lang.String parameter)

Execute a command to the given interface.

Parameters:

ogf - OpCode Group Field

ocf - OpCode Command Field

parameter - Parameters passed to the command