Situm Android SDK Sample app

Situm SDK is a set of utilities that allow any developer to build location based apps using Situm's indoor positioning system.

This project contains an app to test some basic examples using this SDK, so that you can get an idea of what you can achieve with Situm's tecnology.

---

Table of contents

1. How to run this app
2. Examples
3. Submitting contributions
4. License
5. More information
6. Support information

---

How to run this app

In order to get this examples working you must follow this steps:

1. Create a Situm account, an Api key and a building. Just follow the steps in this link

2. Set your credentials in the app. Go to the AndroidManifest.xml file and add your Situm credentials:

<meta-data
    android:name="es.situm.sdk.API_USER"
    android:value="@string/api_user"/>
<meta-data
    android:name="es.situm.sdk.API_KEY"
    android:value="@string/api_key"/>

3. Set your Google Maps api key in order to run the examples that show a map. Go to the AndroidManifest.xml file and edit this field

<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="@string/google_maps_key"/>

Perfect! You can now test all the examples in this apps.

Remember that, to start positioning, you need to ask your user for the location permissions at runtime. The method LocationPermissions#request() is a basic example of how to handle this situation. Check the official Android documentation for more details on this topic.

---

Examples

1. Positioning: Download the buildings in your account and how to start the positioning in a building.
2. Indoor-Outdoor: Use the indoor-outdoor positioning.
3. Wayfinding: Use the new MapView to draw a building and interact with it.
4. Draw building: Draw the floorplan of a building over a map.
5. Draw position: Draw the position you obtain from the SDK in the map.
6. Animate position: Animate the position and the camera.
7. Draw route: Draw a route between to points over the map.
8. Guide instructions: Give indications when you are going to a point.
9. Draw GeoJSON route: Draw Route as GeoJSON.
10. Draw pois: Draw the pois of a building over the map
11. Point inside geofence: Draw geofences and calculate if a point is inside them.
12. Show realtime: Draw the users that are position inside a building over a map.
13. Poi filtering: Filter the pois with a especific key-value.
14. Update location parameters: Update the parameters of the location on the fly.
15. Fetch resources: Download resources like building info, images, POIs, etc.

---

Versioning

Please refer to CHANGELOG.md for a list of notables changes for each version of the plugin.

You can also see the tags on this repository.

---

Submitting contributions

You will need to sign a Contributor License Agreement (CLA) before making a submission. Learn more here.

---

License

This project is licensed under the MIT - see the LICENSE file for further details.

---

More information

More info is available at our Developers Page.

---

Support information

For any question or bug report, please send an email to support@situm.es