Situm WYF is a Plug-and-play UX component that will allow you to bring wayfinding capabilities to your apps in no-time. If you integrate it, your application will be able to:
- Show a navigation screen with cartography visualization
- Show a POI search bar
- Generate indoor & outdoor geolocation
- Provide wayfinding, turn-by-turn indications.
- …and more.
Here’s a glimpse of how your app might look like.
Situm WYF is available for Android & iOS native, with plugins available for React Native, Capacitor and Cordova as well (we don’t recommend using Cordova, use Capacitor instead).
If you’re using any other platform, such as Flutter or Xamarin, you’ll also be able to integrate Situm WYF in your app by just wrapping the native Android & iOS native modules.
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 purposes. 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” |
| React Native | https://github.com/situmtech/situm-react-native-wayfinding-getting-started |
| Capacitor | https://github.com/situmtech/situm-capacitor-plugin-wayfinding-getting-started https://github.com/situmtech/situm-capacitor-wayfinding |
| Flutter | https://github.com/situmtech/flutter-wayfinding/tree/master/example |
| 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 |
| React Native | https://github.com/situmtech/react-native-wayfinding#usage |
| Capacitor | https://github.com/situmtech/situm-capacitor-plugin-wayfinding#api |
| Flutter | https://github.com/situmtech/flutter-wayfinding |
| 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 |
| React Native | npm | https://www.npmjs.com/package/@situm/react-native-wayfinding |
| React Native | Github | https://github.com/situmtech/react-native-wayfinding |
| Capacitor | npm | https://www.npmjs.com/package/situm-capacitor-plugin-wayfinding |
| Capacitor | Github | https://github.com/situmtech/situm-capacitor-plugin-wayfinding |
| Flutter | Github | https://github.com/situmtech/flutter-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 / Framework | Changelog Link |
|---|---|
| Android (native) | https://situm.com/docs/android-wyf-changelog/ |
| iOS (native) | https://situm.com/docs/ios-wyf-changelog/ |
| React Native | N.A. |
| Capacitor | https://github.com/situmtech/situm-capacitor-plugin-wayfinding/blob/master/CHANGELOG.md |
| Flutter | https://github.com/situmtech/flutter-wayfinding/blob/master/CHANGELOG.md |
| Cordova | https://situm.com/docs/03-cordova-wyf-changelog/ |
