SitumSDK Class Reference

Inherits from NSObject
Declared in SitumSDK.h

Overview

  • The Situm Framework (SitumSDK.framework) provides information about the buildings supporting indoor location services as well as location data of a user inside a building. The framework uses a multi-sensor approach to find the user’s location inside a building. *
  • @discussion As a developer, if you follow the Up and Running section, you only need to
  • include the SitumSDK.h file in your proyect
  • in order to work with the APIs. This can be done with the following #import <SitumSDK/SitumSDK.h> * *
    1. Up and Running

  • In the next section you will see how to include and configure your project so you can work with the SitumSDK framework. *
  • Adding SitumSDK framework to your project

  • Drag and drop the framework to your project file structure.
  • Make sure you enable Copy Items if needed option.
  • Also you should check the Add to targets option and verify that your project target is selected. *
  • You will also need to include the Core Motion framework. *
  • External Dependencies

  • Additionally, you will have to include some external dependencies. *
  • GCDAsyncUdpSocket - Under the external-dependencies folder inside the general framework folder you can see the header and implementation files you should add to your project. Drag and drop them to your project and make sure you enable the Copy Items if needed option. *
  • Configuring your API Key

  • In order to work with the APIs you should insert your developer API Key: *
    1. Select AppDelegate.h from the project navigator.
    1. include the line: #import <Situm/Situm.h> before the interface section.
    1. In your didFinishLaunchingWithOptions: method insert the call [SITServices provideAPIKey:@“APIKey” forEmail:@“email”] where you should replace the @“APIKey” string with your developer API Key you can find at https://dashboard.situm.es/accounts/profile
  • IMPORTANT: Additional configuration:

  • Add libc++.tbd, libz.tbd, CoreLocation and CoreMotion to Link Binary With Libraries section of the build phases tab of the Settings pane.
  • Additionally you should include the following key in your Info.plist file:
  • NSLocationWhenInUseUsageDescription or NSLocationAlwaysUsageDescription with the following value “Location is required to find out where you are” or a custom message that you like.