/amv-access-sdk-android

Primary LanguageJava

Build Status Jitpack

amv-access-sdk-android

getting started

setup

git clone https://github.com/amvnetworks/amv-access-sdk-android.git

build

./gradlew clean build

ide

  • Open the project in Android Studio
  • minSdkVersion for android is 23
  • gradle version 4.3

As this project uses Project Lombok make sure you have the IntelliJ Lombok Plugin installed and annotation processing enabled.

modules

This repository currently consists of three modules.

amv-access-sdk-spi

A module consisting of interfaces and simple base classes which represents the basic requirements and concepts needed in concrete implementations.

amv-hm-access-sdk

The first (and currently only) implementation of amv-access-sdk-spi.

app

A working example app and demo implementation which uses amv-hm-access-sdk. It can be used to get started quickly with your own app.

example app

To successfully start the example app you have to add a file named application.properties in app/src/main/assets. See the file application.properties.template and change the values to your needs.

integration

In order to integrate the sdk into your own app you need two things:

  • api credentials to successfully register a device with a backend service
  • an implementation of the amv-access-sdk-spi module

Currently there is only one such implementation which is amv-hm-access-sdk. You can always refer to the example application which can be found in the app/ directory. Also, you can contact a developer if you need further information.

Step 1. Add the following lines to your root build.gradle at the end of repositories:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Step 2. Add the libs/ folder to your apps repositories:

    repositories {
        ...
        flatDir {
            dirs 'libs'
        }
    }

Step 3. Copy the hmkit-android-*.aar file from amv-hm-access-sdk/libs/ to your own libs/ directory.

Step 4. Add the dependency:

dependencies {
    ...
    implementation(name: 'hmkit-android', version: '1.0.11', ext: 'aar')
    implementation 'com.github.amvnetworks.amv-access-sdk-android:amv-hm-access-sdk:v0.0.1'
}