FreeRTOS BLE Mobile SDK for Android

Maven Central

Introduction

Using the Android SDK for FreeRTOS Bluetooth Devices, you can create mobile applications that do the following:

System requirements

Setting Up the SDK

  1. Set the SDK as a dependency for the application.

Option 1: install from maven In your app's build.gradle file, add the following into dependencies block: (replace x.y.z with Maven Central)

    implementation('software.amazon.freertos:amazonfreertossdk:x.y.z')

Option 2: Build the sdk locally. In your app's build.gradle file, add the following into dependencies block:

    implementation project(':amazonfreertossdk')

In project's settings.gradle file, add ':amazonfreertossdk'

    include ':app', ':amazonfreertossdk'
  1. In your app's AndroidManifest.xml file, add following permissions:
<uses-permission android:name="android.permission.BLUETOOTH"/>
    <!-- initiate device discovery and manipulate bluetooth settings -->
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
    <!-- allow scan BLE -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

    <!-- AWS Mobile SDK -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Contents

BLE Helper Functions

The SDK includes some functions that help you perform BLE operations with FreeRTOS devices:

    startScanDevices
    stopScanDevices
    connectToDevice
    disconnectFromDevice

Once the connection to the device is established, you get an AmazonFreeRTOSDevice object, and you can use this object to do WiFi provisioning or Mqtt proxy.

WiFi Provisioning Service

Provision the WiFi credential on the FreeRTOS device through the app. It provides 4 functions:

    ListNetwork
    SaveNetwork
    EditNetwork
    DeleteNetwork

MQTT Proxy Service

The MQTT proxy service controls the MQTT proxy. It allows the device to send and receive MQTT messages from the AWS IoT cloud through the phone, when this feature is enabled.

You can find the documentation for these functions in documentation.

Demo Application

The SDK includes a demo application that demonstrates some of the main features of the SDK. You can find the demo in app.

License

This library is licensed under the Apache 2.0 License.