software.amazon.freertos.amazonfreertossdk

Class AmazonFreeRTOSDevice

java.lang.Object

software.amazon.freertos.amazonfreertossdk.AmazonFreeRTOSDevice

public class AmazonFreeRTOSDevice
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
void	deleteNetwork(DeleteNetworkReq deleteNetworkReq, NetworkConfigCallback callback) Sends a DeleteNetworkReq command to the connected BLE device.
void	editNetwork(EditNetworkReq editNetworkReq, NetworkConfigCallback callback) Sends an EditNetworkReq command to the connected BLE device.
boolean	equals(java.lang.Object obj)
void	getBrokerEndpoint(DeviceInfoCallback callback) Get the current broker endpoint on the device.
void	getDeviceVersion(DeviceInfoCallback callback) Get the AmazonFreeRTOS library software version running on the device.
void	getMtu(DeviceInfoCallback callback) Get the current mtu value between device and Android phone.
void	listNetworks(ListNetworkReq listNetworkReq, NetworkConfigCallback callback) Sends a ListNetworkReq command to the connected BLE device.
void	saveNetwork(SaveNetworkReq saveNetworkReq, NetworkConfigCallback callback) Sends a SaveNetworkReq command to the connected BLE device.

Methods inherited from class java.lang.Object

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

Method Detail

listNetworks

public void listNetworks(ListNetworkReq listNetworkReq,
                         NetworkConfigCallback callback)

Sends a ListNetworkReq command to the connected BLE device. The available WiFi networks found by the connected BLE device will be returned in the callback as a ListNetworkResp. Each found WiFi network should trigger the callback once. For example, if there are 10 available networks found by the BLE device, this callback will be triggered 10 times, each containing one ListNetworkResp that represents that WiFi network. In addition, the order of the callbacks will be triggered as follows: the saved networks will be returned first, in decreasing order of their preference, as denoted by their index. (The smallest non-negative index denotes the highest preference, and is therefore returned first.) For example, the saved network with index 0 will be returned first, then the saved network with index 1, then index 2, etc. After all saved networks have been returned, the non-saved networks will be returned, in the decreasing order of their RSSI value, a network with higher RSSI value will be returned before one with lower RSSI value.

Parameters:

listNetworkReq - The ListNetwork request

callback - The callback which will be triggered once the BLE device sends a ListNetwork response.

saveNetwork

public void saveNetwork(SaveNetworkReq saveNetworkReq,
                        NetworkConfigCallback callback)

Sends a SaveNetworkReq command to the connected BLE device. The SaveNetworkReq contains the network credential. A SaveNetworkResp will be sent by the BLE device and triggers the callback. To get the updated order of all networks, call listNetworks again.

Parameters:

saveNetworkReq - The SaveNetwork request.

callback - The callback that is triggered once the BLE device sends a SaveNetwork response.

editNetwork

public void editNetwork(EditNetworkReq editNetworkReq,
                        NetworkConfigCallback callback)

Sends an EditNetworkReq command to the connected BLE device. The EditNetwork request is used to update the preference of a saved network. It contains the current index of the saved network to be updated, and the desired new index of the save network to be updated to. Both the current index and the new index must be one of those saved networks. Behavior is undefined if an index of an unsaved network is provided in the EditNetworkReq. To get the updated order of all networks, call listNetworks again.

Parameters:

editNetworkReq - The EditNetwork request.

callback - The callback that is triggered once the BLE device sends an EditNetwork response.

deleteNetwork

public void deleteNetwork(DeleteNetworkReq deleteNetworkReq,
                          NetworkConfigCallback callback)

Sends a DeleteNetworkReq command to the connected BLE device. The saved network with the index specified in the delete network request will be deleted, making it a non-saved network again. To get the updated order of all networks, call listNetworks again.

Parameters:

deleteNetworkReq - The DeleteNetwork request.

callback - The callback that is triggered once the BLE device sends a DeleteNetwork response.

getMtu

public void getMtu(DeviceInfoCallback callback)

Get the current mtu value between device and Android phone. This method returns immediately. The request to get mtu value is asynchronous through BLE command. The response will be delivered through DeviceInfoCallback.

Parameters:

callback - The callback to notify app of current mtu value.

getBrokerEndpoint

public void getBrokerEndpoint(DeviceInfoCallback callback)

Get the current broker endpoint on the device. This broker endpoint is used to connect to AWS IoT, hence, this is also the AWS IoT endpoint. This method returns immediately. The request is sent asynchronously through BLE command. The response will be delivered through DeviceInfoCallback.

Parameters:

callback - The callback to notify app of current broker endpoint on device.

getDeviceVersion

public void getDeviceVersion(DeviceInfoCallback callback)

Get the AmazonFreeRTOS library software version running on the device. This method returns immediately. The request is sent asynchronously through BLE command. The response will be delivered through DeviceInfoCallback.

Parameters:

callback - The callback to notify app of current software version.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object