iBKS SDK para Android

RESUMEN

Este documento explica cómo configurar todas las herramientas necesarias para comenzar a usar iBKS SDK.

PÚBLICO

Este documento está enfocado principalmente a desarrolladores de software Android con conocimientos básicos de configuración de beacons.

IMPORTANTE

Requisitos del SO: Android 5.0 o superior

  1. Antes de comenzar
  2. Vamos a jugar
    1. Crear proyecto
    2. Permisos de la app
      1. Ubicación
      2. Bluetooth
      3. Internet
    3. Registro EID
    4. Compilar tu proyecto
    5. Comenzar con un proyecto de ejemplo

1. Antes de comenzar

Este SDK te ayudará a gestionar iBKS Beacons con tu propia APP Android en unos pocos pasos sencillos.

Todo lo que necesitas:

  • Android Studio
  • Dispositivo Android con versión 5.0 o superior.
  • Al menos un iBKS Beacon con versión FW “EDSTEID V5.2016.06.29.1” o superior.
  • repositorio de github:
    • Documento iBKS SDK para Android Manual de Referencia
    • Proyecto de Ejemplo iBKS SDK

2. Vamos a jugar

2.1. Crear proyecto

Primero que nada, crea un nuevo proyecto en Android Studio y añade el iBKS SDK al build.gradle (Módulo:app) declarando la siguiente dependencia (verifica la última versión aquí):

compile 'com.accent_systems.ibks-sdk:ibks-sdk:1.0.1'

La minSdkVersion de la app debe ser 21 o superior porque hay algunas funciones de Bluetooth que no funcionan para versiones más antiguas del SDK de Android.

2.2. Permisos de la app

Para gestionar Bluetooth en Android es necesario solicitar los permisos del usuario.

2.2.1. Ubicación

Si la versión de Android es 6.0 o superior es necesario solicitar permiso de ubicación. Para hacer esto, es necesario añadir el permiso en AndroidManifest.xml

<uses-permission android_name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android_name="android.permission.ACCESS_FINE_LOCATION" />
2.2.2. Bluetooth

Para usar Bluetooth en un dispositivo Android, lo primero que hay que hacer es verificar si el dispositivo que ejecuta la app tiene Bluetooth Low Energy (los beacons trabajan con este tipo de Bluetooth) y si está habilitado. Para habilitar Bluetooth es necesario añadir el permiso en AndroidManifest.xml

<uses-permission android_name="android.permission.BLUETOOTH" />
<uses-permission android_name="android.permission.BLUETOOTH_ADMIN" />
2.2.3. Internet

Para usar algunas funciones que requieren acceso a Internet, es necesario añadir permisos en AndroidManifest.xml

<uses-permission android_name="android.permission.INTERNET" />

2.3. Registro EID

Si deseas usar el registro EID en tu APP, sigue estos pasos:

  1. Inicia sesión en Google Console Developers
  2. Habilita Proximity Beacon API
  3. Crea las Credenciales para tu APP:
    • Clave API de Android para tu paquete.
    • ID de Cliente OAuth para tu paquete.

Es posible que necesites esperar algunos minutos u horas para obtener acceso a la API.

Los usuarios de tu APP no necesitan crear Credenciales pero también deben habilitar la Proximity Beacon API en su cuenta.

2.4. Compilar tu proyecto

Ahora, compila tu proyecto y estás listo para jugar con iBKS-SDK.

Recomendamos echar un vistazo al Proyecto de Ejemplo iBKS SDK antes de comenzar con tu propio proyecto para familiarizarte con iBKS-SDK.

2.5. Comenzar con un proyecto de ejemplo

En la documentación de iBKS SDK, encontrarás el “Proyecto de Ejemplo iBKS SDK”. Este ejemplo te muestra cómo realizar las tareas principales en una APP Bluetooth como:

  • Escanear dispositivos
  • Conectar dispositivos
  • Leer/Escribir características
  • Configurar/Obtener Eddystone Slots
  • Registrar beacon EID
  • Obtener EID en Claro
  • Configurar/Obtener iBeacon Slots
  • Configurar/Obtener Características del servicio Global
  • Obtener cuenta de cliente e Id de proyecto de Google
  • Parsear datos de publicidad

La App “Proyecto de Ejemplo iBKS SDK” comienza con un escaneo de dispositivos Bluetooth. Cuando se hace clic en un elemento de la lista, la app establece la conexión con el beacon que te permite realizar cualquiera de las tareas mencionadas anteriormente. Sigue los siguientes pasos para comenzar a jugar:

  1. Descarga el proyecto
  2. Abre el proyecto con Android Studio
  3. Compila el proyecto
  4. Prueba el ejemplo en tu dispositivo móvil