marnberg/AferoJavaSDK

SDK for creating Java/Android-based Afero clients

author	title	date	status
Tony Myles	AferoJavaSDK	2019-Sept-20	1.4.5

AferoJavaSDK

An SDK for interacting with the Afero service and peripheral platform.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

Getting Started

Specifying the Repository

The SDK binaries are hosted on JFrog. To specify the repo use the following Gradle repository reference.

    repositories {
        maven {
            url "https://afero.jfrog.io/afero/afero-java-sdk"
            artifactUrls "https://afero.jfrog.io/afero/hubby-android"
        }
    }

Specifying the Modules

The SDK is composed of four separate modules.

The afero-sdk-core module is required for base functionality such as interacting with the Afero Cloud and manipulating devices.

    implementation 'io.afero.sdk:afero-sdk-core:1.4.5'

The afero-sdk-client-retrofit2 module provides an optional implementation of the AferoClient REST API interface using Retrofit2 and okhttp3. If you choose not to include this module in your project, you will need to develop your own implementation of AferoClient using your preferred http client library.

    implementation 'io.afero.sdk:afero-sdk-client-retrofit2:1.4.5'

The afero-sdk-android module is required for Android development.

    implementation 'io.afero.sdk:afero-sdk-android:1.4.5'

The afero-sdk-softhub module is required for soft hub functionality on Android.

    implementation 'io.afero.sdk:afero-sdk-softhub:1.4.5'
    implementation "io.afero.sdk:hubby:1.0.844@aar"

License

MIT & ARM Permissive Binary