Android Cubeacon Sample Project
Switch branches/tags
Nothing to show
Clone or download
Latest commit b4bd97e Aug 8, 2018

README.md

Cubeacon SDK for Android

Overview

Cubeacon SDK for Android is a library to allow interaction with any beacons. The SDK system requirements are Android 4.3 or above and Bluetooth Low Energy.

Cubeacon SDK allows for:

  • Beacon ranging (scans beacons and optionally filters them by their properties).
  • Beacon monitoring (monitors regions for those devices that have entered/exited a region).

Learn more at:

Installation

  1. Download cubeacon-x.y.z.aar from Github release page.

  2. Then copy it to your libs directory.

  3. On your build.gradle within app module, add this lines below before dependencies tag

    repositories{
        flatDir {
            dirs 'libs'
        }
    }
    

    Then add compile 'com.eyro.cubeacon:cubeacon:x.y.z@aar' into your dependecies.

  4. Create custom application class and add the following code to the onCreate() method to initialize the Cubeacon SDK.

    Cubeacon.initialize(this);

    Don't forget to add your custom application class into AndroidManifest.xml

    (Optional) You can add some custom setup :

    • Enable Cubeacon SDK debug logging when in development mode by calling Logger.setLogLevel(LogLevel) before initialize SDK.
    • You can choose LogLevel from : NONE, ASSERT, DEBUG, ERROR, INFO, WARN, or VERBOSE.

Basic Usage

  1. Ranging for beacons
  2. Monitoring beacon
  3. Bootstrap Region Monitoring
  4. Show notification

Changelog

Read about detailed changelog here