01 – Introduction: requirements, code examples and more

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 custommers.
Situm WYF comes with ready-to-integrate prebuilt screens so you can show floorplans, user geolocation, routes and more.

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.

Android
Capacitor
iOS

* 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:

  1. 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).
  2. To create an account in Situm Dashboard.
  3. To create an API KEY (that you will use in your application). 
  4. 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.
  5. 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 / FrameworkCode 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”
Capacitorhttps://github.com/situmtech/situm-capacitor-plugin-wayfinding-getting-started
https://github.com/situmtech/situm-capacitor-wayfinding
Cordovahttps://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 / FrameworkDocs Link
Android (native)Android Javadoc
iOS (native)iOS Appledoc
Capacitorhttps://github.com/situmtech/situm-capacitor-plugin-wayfinding#api
CordovaCordova 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/FrameworkSourceRepository Link
Android (native)Situm repositoryhttps://repo.situm.es/ui/repos/tree/General/libs-release-local%2Fes%2Fsitum%2Fsitum-wayfinding
iOS (native)Cocoa Podshttps://cocoapods.org/pods/SitumWayfinding
iOS (native)Situm repositoryhttps://repo.situm.es/ui/repos/tree/General/libs-release-local%2FiOS%2FSitumWayfinding
Capacitornpmhttps://www.npmjs.com/package/situm-capacitor-plugin-wayfinding
CapacitorGithubhttps://github.com/situmtech/situm-capacitor-plugin-wayfinding
Cordovanpmhttps://www.npmjs.com/package/situm-cordova-plugin-wayfinding
CordovaGithubhttps://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 / FramerworkChangelog Link
Android (native)https://situm.com/docs/01-android-wyf-changelog/
iOS (native)https://situm.com/docs/02-ios-wyf-changelog/
Capacitorhttps://github.com/situmtech/situm-capacitor-plugin-wayfinding/blob/master/CHANGELOG.md
Cordovahttps://situm.com/docs/03-cordova-wyf-changelog/

Subscribe to our newsletter

BASIC INFORMATION ON DATA PROTECTION

Data controller: SITUM TECHNOLOGIES, S.L.
Contact: Data controller: situm@situm.es
Responsible for protection: dpo@situm.es
Purpose and legal basis: To manage the sending of SITUM newsletters only with consent.
Legitimation: Express consent of the interested party.
Recipients: The data will not be passed on to third parties with the exception of legal obligations.
Retention period: As long as the interested party remains subscribed to the newsletter (a link to unsubscribe will be available in each newsletter sent by Situm).
Rights: The interested party may at any time revoke their consent, as well as exercise their rights of opposition, access, conservation, rectification, limitation, deletion of data and not be subject to a decision based only on automated data processing, by writing to SITUM at the addresses indicated.
Additional Information: You can consult additional and detailed information on Data Protection in our privacy policy.

Please, download your copy here

Thank you for downloading our whitepaper. Please do not hesitate to contact us if you would like to know more about how our solutions can help your business. Download whitepaper


Close window