Situm WYF is a Plug-and-play UX component that will allow you to bring wayfinding capabilities to your apps in no-time. It includes, out of the box:
- Cartography visualization: floorplans, points of interest (POIs), and geofences.
- POI search directory, so you can easily build a search bar for any important places of your building.
- Indoor & outdoor geolocation, plus wayfinding with different types of route settings (shortest route, accesible routes only, etc.).
- Turn-by-turn wayfinding directions. 3 flavors available: visual indications, text directions and voice directions (for people with visual impairments).
- Geotriggered notifications: send a greeting to your visitors or a geopromotion to your customers.
Situm WYF is available as a module for Android, iOS, Capacitor and Cordova* (React Native not available at the moment). Since it is based on Situm SDK, its requirements with regard to devices, OS/Framework versions and architectures are the same as those of Situm SDK.
* We don’t recommend using Cordova at the moment. Use Capacitor instead.
How do I get started? #
In order to start building apps with Situm WYF, you will need:
- Previous development experience in the platform where your app will run (Android, iOS, Cordova, React Native), plus a development environment up & running (including a compatible smartphone).
- To create an account in Situm Dashboard.
- To create an API KEY (that you will use in your application).
- A Situm building up & running for testing purpuses. We recommend you to create a building where you can perform your tests (e.g. your office), calibrate it and test the positioning and wayfinding using our Situm Mapping Tool.
- Optionally, you may need BLE beacons in some cases.
We recommend you to take a look at our code examples.
Try WYF module with AVD #
If you want to test your app in an AVD you need to use one that has the Google APIs enabled. In the AVD manager you can see which ones have it enabled in the target section.
Useful links #
In this section, we list some of the most useful links when working with Situm WYF.
Code Examples #
We have a wide list of code examples that will show you how to implement the most common use cases with Situm WYF. All the following code examples are structured as aof a mobile app whose code you may download, examine, compile, modify and execute. You will find instructions, and an explanation of each example / use case, inside each Github repository.
| OS / Framework | Code Examples Link |
|---|---|
| Android (native) | https://github.com/situmtech/situm-android-wayfinding-getting-started |
| iOS (native) | https://github.com/situmtech/ios-swift-library-wayfinding (Swift): Check the “Example project within the repository” |
| Capacitor | https://github.com/situmtech/situm-capacitor-plugin-wayfinding-getting-started https://github.com/situmtech/situm-capacitor-wayfinding |
| Cordova | https://github.com/situmtech/situm-cordova-getting-started |
Docs (SDK public interfaces documentation) #
We also have a thourough documentation of most methods and classes of each Situm WYF module.
| OS / Framework | Docs Link |
|---|---|
| Android (native) | Android Javadoc |
| iOS (native) | iOS Appledoc |
| Capacitor | https://github.com/situmtech/situm-capacitor-plugin-wayfinding#api |
| Cordova | Cordova Wayfinding Plugin Github Cordova JSDoc |
Repositories #
In order to use Situm WYF in your applications, the first thing you will need to do is to include Situm WYF in your project dependencies. After that, you will be able to compile your project (including Situm WYF ) and start using its many functionalities.
Situm WYF dependencies are made available through public repositories so that they can be downloaded from the internet and included in your project without effort.
| OS/Framework | Source | Repository Link |
|---|---|---|
| Android (native) | Situm repository | https://repo.situm.es/ui/repos/tree/General/libs-release-local%2Fes%2Fsitum%2Fsitum-wayfinding |
| iOS (native) | Cocoa Pods | https://cocoapods.org/pods/SitumWayfinding |
| iOS (native) | Situm repository | https://repo.situm.es/ui/repos/tree/General/libs-release-local%2FiOS%2FSitumWayfinding |
| Capacitor | npm | https://www.npmjs.com/package/situm-capacitor-plugin-wayfinding |
| Capacitor | Github | https://github.com/situmtech/situm-capacitor-plugin-wayfinding |
| Cordova | npm | https://www.npmjs.com/package/situm-cordova-plugin-wayfinding |
| Cordova | Github | https://github.com/situmtech/situm-cordova-plugin-wayfinding |
Changelogs (Situm WYF version reference) #
Every few days, Situm releases a new Situm WYF version with minor updates, bug corrections, security updates, new functionalities and so on. Every Situm WYF has a Changelog file where we keep track of every version released and a brief description of each version’s changes.
| OS / Framerwork | Changelog Link |
|---|---|
| Android (native) | https://situm.com/docs/01-android-wyf-changelog/ |
| iOS (native) | https://situm.com/docs/02-ios-wyf-changelog/ |
| Capacitor | https://github.com/situmtech/situm-capacitor-plugin-wayfinding/blob/master/CHANGELOG.md |
| Cordova | https://situm.com/docs/03-cordova-wyf-changelog/ |
