software.amazon.freertos.amazonfreertossdk

Class AmazonFreeRTOSManager

java.lang.Object

software.amazon.freertos.amazonfreertossdk.AmazonFreeRTOSManager

public class AmazonFreeRTOSManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AmazonFreeRTOSManager(android.content.Context context, android.bluetooth.BluetoothAdapter bluetoothAdapter) Construct an AmazonFreeRTOSManager instance.

Method Summary

Modifier and Type	Method and Description
AmazonFreeRTOSDevice	connectToDevice(android.bluetooth.BluetoothDevice btDevice, BleConnectionStatusCallback connectionStatusCallback, AWSCredentialsProvider cp, boolean autoReconnect) Connect to the BLE device, and notify the connection state via BleConnectionStatusCallback.
void	disconnectFromDevice(AmazonFreeRTOSDevice aDevice) Closing BLE connection for the AmazonFreeRTOSDevice, reset all variables, and disconnect from AWS IoT.
AmazonFreeRTOSDevice	getConnectedDevice(java.lang.String macAddr) Get the instance of AmazonFreeRTOSDevice given the mac address of the BLE device
void	setScanFilters(java.util.List<android.bluetooth.le.ScanFilter> filters) Setting the criteria for which exact the BLE devices to scan for.
void	startScanDevices(BleScanResultCallback scanResultCallback) Start scanning of nearby BLE devices.
void	startScanDevices(BleScanResultCallback scanResultCallback, long scanDuration) Start scanning nearby BLE devices for a total duration of scanDuration milliseconds.
void	stopScanDevices() Stop scanning of nearby BLE devices.

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonFreeRTOSManager

public AmazonFreeRTOSManager(android.content.Context context,
                             android.bluetooth.BluetoothAdapter bluetoothAdapter)

Construct an AmazonFreeRTOSManager instance.

Parameters:

context - The app context. Should be passed in by the app that creates a new instance of AmazonFreeRTOSManager.

bluetoothAdapter - BluetoothAdaptor passed in by the app.

Method Detail

setScanFilters

public void setScanFilters(java.util.List<android.bluetooth.le.ScanFilter> filters)

Setting the criteria for which exact the BLE devices to scan for. This overrides the default mScanFilters which is by default set to scan for UUID_AmazonFreeRTOS.

Parameters:

filters - The list of ScanFilter for BLE devices.

startScanDevices

public void startScanDevices(BleScanResultCallback scanResultCallback)

Start scanning of nearby BLE devices. It filters the scan result only with AmazonFreeRTOS service UUID unless setScanFilters was explicitly called. It keeps scanning for a period of AmazonFreeRTOSConstants.class#SCAN_PERIOD ms, then stops the scanning automatically. The scan result is passed back through the BleScanResultCallback. If at the time of calling this API, there's already an ongoing scanning, then this will return immediately without starting another scan.

Parameters:

scanResultCallback - The callback to notify the calling app of the scanning result. The callback will be triggered, every time it finds a BLE device nearby that meets the ScanFilter criteria.

startScanDevices

public void startScanDevices(BleScanResultCallback scanResultCallback,
                             long scanDuration)

Start scanning nearby BLE devices for a total duration of scanDuration milliseconds.

Parameters:

scanResultCallback - The callback to notify the calling app of the scanning result.

scanDuration - The duration of scanning. Keep scanning if 0.

stopScanDevices

public void stopScanDevices()

Stop scanning of nearby BLE devices. If there's no ongoing BLE scanning, then it will return immediately.

connectToDevice

public AmazonFreeRTOSDevice connectToDevice(android.bluetooth.BluetoothDevice btDevice,
                                            BleConnectionStatusCallback connectionStatusCallback,
                                            AWSCredentialsProvider cp,
                                            boolean autoReconnect)

Connect to the BLE device, and notify the connection state via BleConnectionStatusCallback.

Parameters:

connectionStatusCallback - The callback to notify app whether the BLE connection is successful. Must not be null.

btDevice - the BLE device to be connected to.

cp - the AWSCredential used to connect to AWS IoT.

autoReconnect - auto reconnect to device after unexpected disconnect

disconnectFromDevice

public void disconnectFromDevice(AmazonFreeRTOSDevice aDevice)

Closing BLE connection for the AmazonFreeRTOSDevice, reset all variables, and disconnect from AWS IoT.

Parameters:

aDevice - The AmazonFreeRTOSDevice to be disconnected.

getConnectedDevice

public AmazonFreeRTOSDevice getConnectedDevice(java.lang.String macAddr)

Get the instance of AmazonFreeRTOSDevice given the mac address of the BLE device

Parameters:

macAddr - the mac address of the connected BLE device

Returns:

the corresponding AmazonFreeRTOSDevice instance that represents the connected BLE device.