Developers

blukii-sdk

blukii-sdk is the library for discovery and connection based configuration of blukii modules.

Documentation and support

To learn about the usage of the library classes please find the library’s javadoc documentation.

We recommend you to start with the following documentation pages where you can find some sample code fragments:

For further question please contact the blukii developer support at support@blukii.com.

Feature Licensing

Since version 4.0.0 a developer API key is mandatory for using blukii-sdk. You can create a free basic API key at blukii Manager on your Account settings section API KEYS.

Basic API key allows to use the following blukii-sdk features:

For advanced features the API key has to assigned to additional fee-based permissions:

Please contact the blukii developer support at support@blukii.com for requesting additional permissions.

Getting started

Please follow the instructions for using the blukii-sdk in your Android Studio project.

Android version

The minimum Android version is 4.4 Kitkat (API level 19) and the device has to support Bluetooth LE 4.0 or later.

Gradle settings

The blukii-sdk can be easily integrated by adding the following parts to your module’s build.gradle:

android {
  ...
  compileOptions {
      sourceCompatibility JavaVersion.VERSION_1_8
      targetCompatibility JavaVersion.VERSION_1_8
  }
  ...
}
...
dependencies {
  ...
  implementation 'com.blukii:blukii-sdk:4.2.0'
  ...
}

Permissions

You need to insert the following permissions to your AndroidManifest.xml:

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.BLUETOOTH" />
    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />

For Apps with targetSdkVersion 23 (Android 6) and later you need to add the following permission:

    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

For Apps with targetSdkVersion 31 (Android 12) and later you need to add the following permission:

    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

For Apps with targetSdkVersion 29 (Android 10) and later that should use discovery in background you additionally have to handle the following permission in combination with ACCESS_FINE_LOCATION. Therefore please read Google’s manual about access to device location in the background.

    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

The javadoc documentation of class discovery/BlukiiClient contains sample code snippets for requesting permissions in your app.

API key setting

You need to insert the following meta-data part to application settings of your AndroidManifest.xml:

    <application
        android:name=".YourApp"
        ...
        >

        <meta-data android:name="com.blukii.sdk.API_KEY"
            android:value="<your API key>"/>

        ...
    </application>

Ready

Now you are ready to start developing your blukii App!

The library’s javadoc documentation should help you to understand developing based on blukii technology.

Changelog

Version 4.2.0

Version 4.1.0

Version 4.0.2

Version 4.0.1

Version 4.0.0

Version 3.1.2

Version 3.1.1

Version 3.1.0

Version 3.0.1

Version 3.0.0

Version 2.0.2

Version 2.0.1

Version 2.0.0

Version 1.0.3

Version 1.0.2

Version 1.0.1

First version