Quick start guide

Introduction

In this tutorial, we will guide you step by step to set up your first application using Situm Wayfinding Module. Before starting to write code, we recommend you to set up an account in our Dashboard, retrieve your API KEY and configure your first building.

  1. Go to the sign in form and enter your username and password to sign in.
  2. Go to the account section and on the bottom, click on "generate one" to generate your API KEY.
  3. Go to the buildings section and create your first building.
  4. Download Situm Mapping Tool Android application. With this application you will be able to configure and test Situm's indoor positioning system in your buildings.

Perfect! Now you are ready to develop your first indoor positioning application.

Step 1: Configure our SDK in your Android project

First of all, you must configure Situm SDK in your Android project. This has been already done for you in the sample application, but nonetheless we will walk you to the process.

  • Add the next line to the project build.gradle in the repositories section of allprojects to add our maven repository to the project:
maven { url "https://repo.situm.es/artifactory/libs-release-local" }
  • Then add the Situm SDK library dependency into the section dependencies of the app build.gradle. It’s important to add the transitive = true property to download the Situm SDK dependencies.
compile ('es.situm:situm-sdk:2.61.1@aar') {
    transitive = true
}

Step 2: Initialize the SDK

You must initialize the sdk in the onCreate() method of your Application:

SitumSdk.init(this);

Step 3: Set your credentials

There are two ways to set the credentials, in the AndroidManifest.xml file or programmatically.

Option 1: AndroidManifest.xml file

You can set the credentials (user and API key)in the AndroidManifest.xml file adding the next meta-data fields:

<meta-data
    android:name="es.situm.sdk.API_USER"
    android:value="API_USER_EMAIL" />
<meta-data
    android:name="es.situm.sdk.API_KEY"
    android:value="API_KEY" />

Option 2: programmatically

In the code, you can set the the user and API key with:

SitumSdk.configuration().setApiKey("USER_EMAIL", "API_KEY");

or you can set the user and password with:

SitumSdk.configuration().setUserPass("USER_EMAIL", "PASSWORD");

Congratulations! Now you can start to code using Situm SDK. For more information and code samples, please check our Android Getting Started in Github.