Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 2.48 KB

README.md

File metadata and controls

50 lines (36 loc) · 2.48 KB

Uplink Android SDK

SDK for using the uplink bridge from android.

Architecture

The project has two main modules:

Configurator app

This app provides the uplink service that can be used to communicate with the backend. Other apps can bind to this service and use it to communicate with the selected backend. This app also provides the authorization configuration for the uplink bridge, which you have to select using the application UI.

Client SDK

The client sdk can be used by app developers to communicate with the uplink service. It handles all the low level messaging details and provides a simple high level interface for the app developers. The configurator app must be installed on the device and the service must be started before the clients can connect to it, otherwise exceptions will be throws during initialization.

API

The io.bytebeam.uplink.Uplink class (from the lib module) provides the client side api for this sdk. These are the steps to use this library:

  1. Instantiate the Uplink class, providing an implementation of UplinkStateCallback. This will be used to notify the app about the state of the uplink bridge. This constructor may throw the following exceptions:
    1. ConfiguratorNotInstalledException
    2. UplinkServiceNotRunningException You may also use the static boolean Uplink.configuratorAvailable(Context) and static boolean Uplink.serviceRunning(Context) methods to query the uplink setup.
  2. Once the service is ready, you can use the methods on the Uplink instance to communicate with the backend:

    1. Uplink.subscribe(ActionSubscriber) - Subscribe to action targeting this device.

    2. Uplink.sendData(UplinkPayload) - Send some data to the backend.

    3. Uplink.respondToAction(ActionResponse) - Respond to an action that the device received from the backend.

      Each of these methods can throw an UplinkTerminatedException if the uplink service is terminated for some reason (the user stops it or the device configuration is changed). If that happens, the clients need to wait for some time, and attempt reconnecting to the service. The example app \shows how to do that.

  3. The application must properly dispose the Uplink instance when it is no longer needed using the dispose method.

Generate .aar

The client sdk can be exported as an aar package that can be easily loaded into an Android project by running the following command:

./gradlew :lib:build