@situm/cordova 3.1.1 → 3.2.1

package/README.md

@@ -1,32 +1,34 @@
-<div style="text-align:center">
+<p align="center"> <img width="233" src="https://situm.com/wp-content/themes/situm/img/logo-situm.svg" style="margin-bottom:1rem" />
+<h1 align="center">Situm Cordova Plugin</h1>
+</p>
+
+<div align="center" style="text-align:center">
+Situm Cordova Plugin is a set of utilities that allow any developer to build Cordova location based apps using Situm's indoor positioning system. Among many other capabilities, apps developed with Situm Cordova Plugin will be able to:
+</div>
+
+- Obtain information related to buildings where Situm's positioning system is already configured: floorplans, points of interest, geotriggered events, etc.
+- Retrieve the location of the smartphone inside these buildings (position, orientation, and floor where the smartphone is).
+- Compute a route from a point A (e.g. where the smartphone is) to a point B (e.g. any point of interest within the building).
+- Trigger notifications when the user enters a certain area.
+
+<div align="center" style="text-align:center">
 
-# Situm Cordova Plugin
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![npm](https://img.shields.io/npm/v/@situm/cordova.svg)](https://www.npmjs.com/package/@situm/cordova)
 [![npm](https://img.shields.io/npm/dm/@situm/cordova.svg)](https://www.npmjs.com/package/@situm/cordova)
-</div>
-<div style="float:right; margin-left: 1rem;">
 
-[![](https://situm.com/wp-content/themes/situm/img/logo-situm.svg)](https://www.situm.es)
 </div>
 
-Situm Cordova Plugin is a set of utilities that allow any developer to build Cordova location based apps using Situm's indoor positioning system. Among many other capabilities, apps developed with Situm Cordova Plugin will be able to:
-* Obtain information related to buildings where Situm's positioning system is already configured: floorplans, points of interest, geotriggered events, etc.
-* Retrieve the location of the smartphone inside these buildings (position, orientation, and floor where the smartphone is).
-* Compute a route from a point A (e.g. where the smartphone is) to a point B (e.g. any point of interest within the building).
-* Trigger notifications when the user enters a certain area.
-
-
 ## Table of contents
 
-  * [Getting started](#getting-started)
-  * [Versioning](#versioning)
-  * [Submitting contributions](#submitting-contributions)
-  * [License](#license)
-  * [Documentation](#documentation)
-  * [Development](#development)
-  * [More information](#more-information)
-  * [Support information](#support-information)
+- [Getting started](#getting-started)
+- [Versioning](#versioning)
+- [Submitting contributions](#submitting-contributions)
+- [License](#license)
+- [Documentation](#documentation)
+- [Development](#development)
+- [More information](#more-information)
+- [Support information](#support-information)
 
 ---
 
@@ -40,21 +42,21 @@ Situm Cordova Plugin is a set of utilities that allow any developer to build Cor
 
 ## Versioning
 
-Please refer to [CHANGELOG.md](https://github.com/situmtech/situm-cordova-plugin/blob/master/CHANGELOG.md) for a list of notables changes for each version of the plugin.
+Please refer to [CHANGELOG.md](https://github.com/situmtech/cordova/blob/master/CHANGELOG.md) for a list of notables changes for each version of the plugin.
 
-You can also see the [tags on this repository](https://github.com/situmtech/situm-cordova-plugin/tags).
+You can also see the [tags on this repository](https://github.com/situmtech/cordova/tags).
 
 ---
 
 ## Submitting contributions
 
-You will need to sign a Contributor License Agreement (CLA) before making a submission. [Learn more here](https://situm.com/contributions/). 
+You will need to sign a Contributor License Agreement (CLA) before making a submission. [Learn more here](https://situm.com/contributions/).
 
 ---
 
 ## License
 
-Situm-Cordova-Plugin is licensed under [MIT License](https://opensource.org/licenses/MIT). See [LICENSE.txt](https://github.com/situmtech/situm-cordova-plugin/blob/master/LICENSE) file for further details.
+Situm Cordova Plugin is licensed under [MIT License](https://opensource.org/licenses/MIT). See [LICENSE.txt](https://github.com/situmtech/cordova/blob/master/LICENSE) file for further details.
 
 ---
 
@@ -62,12 +64,15 @@ Situm-Cordova-Plugin is licensed under [MIT License](https://opensource.org/lice
 
 - **General documentation**. You can find in our [documentation site](https://situm.com/docs/a-basic-cordova-app/) all the information you need to configure this plugin in your project and get it up and running in no time.
 - **API reference**. Check out the [plugin reference](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/situm) and learn how to use a particular class or method.
-- **Examples**. In [this repo](https://github.com/situmtech/situm-cordova-getting-started) you can find a sample app implementing this plugin. Take a look at how the examples are implemented, so you can figure out how to adapt it to your project.
-- **Cordova Wayfinding plugin**. If you are looking for a wayfinding solution using Cordova, check out [this repo](https://github.com/situmtech/situm-cordova-plugin-wayfinding).
+- **Examples**. In [example/](./example/README.md) you can find a sample app implementing this plugin. Take a look at how the examples are implemented, so you can figure out how to adapt it to your project.
+- **Cordova Wayfinding plugin**. If you are looking for a wayfinding solution using Cordova, check out [this repo](https://github.com/situmtech/cordova).
 
-### Methods 
+### Methods
 
-NOTE: This plugin is currently under development. There may be method not implemented yet. Also there may be some API changes as development progresses.
+> [!NOTE]
+> This plugin is currently under development. There may be method not implemented yet. Also there may be some API changes as development progresses.
+
+### Situm class
 
 #### - setApiKey
 
@@ -80,6 +85,7 @@ cordova.plugins.Situm.setApiKey("SITUM_EMAIL", "SITUM_API_KEY");
 #### - setUserPass
 
 Provides user's email and password. Return true if apiKey was set successfully, otherwise false
+
 ```js
 cordova.plugins.Situm.setUserPass("SITUM_EMAIL", "SITUM_USER_PASS");
 ```
@@ -87,6 +93,7 @@ cordova.plugins.Situm.setUserPass("SITUM_EMAIL", "SITUM_USER_PASS");
 #### - setRemoteConfig
 
 Set the remote configuration state which allows to use the configuration (location request) stored on the web to find the location of the user.
+
 ```js
 cordova.plugins.Situm.setUseRemoteConfig(true);
 ```
@@ -94,15 +101,18 @@ cordova.plugins.Situm.setUseRemoteConfig(true);
 #### - setCacheMaxAge
 
 Sets the maximum age of a cached response in seconds.
+
 ```js
-cordova.plugins.Situm.setCacheMaxAge(1*60*60) // 1 hour
+cordova.plugins.Situm.setCacheMaxAge(1 * 60 * 60); // 1 hour
 ```
 
 #### - startPositioning
 
 Starts the positioning system. In the success callback it can return:
-* [Location](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Location)
-* [LocationStatus](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#LocationStatus)
+
+- [Location](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Location)
+- [LocationStatus](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#LocationStatus)
+
 ```js
   locationOptions = {
       buildingIdentifier = "BUILDING_ID"
@@ -123,8 +133,9 @@ cordova.plugins.Situm.startPositioning(locationOptions, (res: any) => {
 #### - stopPositioning
 
 Stop the positioning system on current active listener.
+
 ```js
-cordova.plugins.Situm.stopPositioning()
+cordova.plugins.Situm.stopPositioning();
 ```
 
 #### - fetchBuildings
@@ -132,23 +143,30 @@ cordova.plugins.Situm.stopPositioning()
 Download all the buildings for the current user.Returns an array of [buildings](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Building)
 
 ```js
-cordova.plugins.Situm.fetchBuildings((res: any) => {
-      // Return an array of buildings
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchBuildings(
+  (res: any) => {
+    // Return an array of buildings
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
-### - fetchBuildingInfo
+#### - fetchBuildingInfo
 
 Download the information (floors, pois, ...) [of a building](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#BuildingInfo)
 
 ```js
-cordova.plugins.Situm.fetchBuildingInfo(building,(res: any) => {
-      // Return the buildingInfo
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchBuildingInfo(
+  building,
+  (res: any) => {
+    // Return the buildingInfo
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - fetchFloorsFromBuilding
@@ -156,11 +174,15 @@ cordova.plugins.Situm.fetchBuildingInfo(building,(res: any) => {
 Download all the [floors](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Floor) of a building.
 
 ```js
-cordova.plugins.Situm.fetchFloorsFromBuilding(building,(res: any) => {
-      // Return an array of floors
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchFloorsFromBuilding(
+  building,
+  (res: any) => {
+    // Return an array of floors
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - fetchIndoorPOIsFromBuilding
@@ -168,11 +190,15 @@ cordova.plugins.Situm.fetchFloorsFromBuilding(building,(res: any) => {
 Download the indoor [POIs](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#POI) of a building.
 
 ```js
-cordova.plugins.Situm.fetchIndoorPOIsFromBuilding(building,(res: any) => {
-      // Return an array of indoor POIs
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchIndoorPOIsFromBuilding(
+  building,
+  (res: any) => {
+    // Return an array of indoor POIs
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - fetchOutdoorPOIsFromBuilding
@@ -180,11 +206,15 @@ cordova.plugins.Situm.fetchIndoorPOIsFromBuilding(building,(res: any) => {
 Download the outdoor [POIs](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#POI) of a building.
 
 ```js
-cordova.plugins.Situm.fetchOutdoorPOIsFromBuilding(building,(res: any) => {
-      // Return an array of outdoor POIs
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchOutdoorPOIsFromBuilding(
+  building,
+  (res: any) => {
+    // Return an array of outdoor POIs
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - fetchEventsFromBuilding
@@ -192,22 +222,30 @@ cordova.plugins.Situm.fetchOutdoorPOIsFromBuilding(building,(res: any) => {
 Download the [events](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#SitumEvent) of a building.
 
 ```js
-cordova.plugins.Situm.fetchEventsFromBuilding(building,(res: any) => {
-      // Return an array of events
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchEventsFromBuilding(
+  building,
+  (res: any) => {
+    // Return an array of events
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
+
 #### - fetchPoiCategories
 
 Get all [POI Categories](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#PoiCategory), download and cache their icons asynchronously.
 
 ```js
-cordova.plugins.Situm.fetchPoiCategories((res: any) => {
-      // Return an array of POI categories
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchPoiCategories(
+  (res: any) => {
+    // Return an array of POI categories
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - fetchMapFromFloor
@@ -215,11 +253,15 @@ cordova.plugins.Situm.fetchPoiCategories((res: any) => {
 Download the map image of a floor.
 
 ```js
-cordova.plugins.Situm.fetchMapFromFloor(floor, (res: any) => {
-      // Return an image as an string encoded in Base64
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchMapFromFloor(
+  floor,
+  (res: any) => {
+    // Return an image as an string encoded in Base64
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - fetchPoiCategoryIconNormal
@@ -227,38 +269,49 @@ cordova.plugins.Situm.fetchMapFromFloor(floor, (res: any) => {
 Get the normal category icon for a POICategory.
 
 ```js
-cordova.plugins.Situm.fetchPoiCategoryIconNormal(category, (res: any) => {
-      // Return an image as an string encoded in Base64
-    }, (err: any) => {
-      // returns error string
-    });
-  ```
+cordova.plugins.Situm.fetchPoiCategoryIconNormal(
+  category,
+  (res: any) => {
+    // Return an image as an string encoded in Base64
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
+```
 
 #### - fetchPoiCategoryIconSelected
 
 Get the selected category icon for a POICategory.
 
 ```js
-cordova.plugins.Situm.fetchPoiCategoryIconSelected(category, (res: any) => {
-      // Return an image as an string encoded in Base64
-    }, (err: any) => {
-      // returns error string
-    });
-  ```
+cordova.plugins.Situm.fetchPoiCategoryIconSelected(
+  category,
+  (res: any) => {
+    // Return an image as an string encoded in Base64
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
+```
 
-  #### - fetchGeofencesFromBuilding
+#### - fetchGeofencesFromBuilding
 
 Get all [geofences](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Geofence) from the building.
 
 ```js
-cordova.plugins.Situm.fetchGeofencesFromBuilding(building, (res: any) => {
-      // Return an array of geofences
-    }, (err: any) => {
-      // returns error string
-    });
+cordova.plugins.Situm.fetchGeofencesFromBuilding(
+  building,
+  (res: any) => {
+    // Return an array of geofences
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
-
 #### - invalidateCache
 
 Invalidate all the resources in the cache.
@@ -272,21 +325,24 @@ cordova.plugins.Situm.invalidateCache();
 Calculates a route between two points. This route is the one that will be used when you call requestNavigationUpdates. If this method is called multiple times the last Route will be used.
 You can change the options to generate the Route with [DirectionOptions](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#DirectionsOptions)
 Returns a [Route](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Route)
+
 ```js
 directionRequest = [
   building, // Building in which you're positioning
   from, // Point where you want to start the route. You can pass a Point or a Location
   to, // Point where you want to finish the route
-  {} // Options to generate the route
-  ]
-
+  {}, // Options to generate the route
+];
 
 cordova.plugins.Situm.requestDirections(
-  directionsRequest, (route: any) => {
-      //Return a Route
-    }, (err: any) => {
-      // returns error string
-    });
+  directionsRequest,
+  (route: any) => {
+    //Return a Route
+  },
+  (err: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - requestNavigationUpdates
@@ -297,31 +353,32 @@ When you start feeding locations you can receive [NavigationProgress](https://de
 ```js
 // Navigation request with example values
 navigationRequest = [
-  distanceToGoalThreshold = 10,
-  distanceToFloorChangeThreshold = 5
-]
+  (distanceToGoalThreshold = 10),
+  (distanceToFloorChangeThreshold = 5),
+];
 cordova.plugins.Situm.requestNavigationUpdates(
   navigationRequest,
-    (navigation: any) => {
-      /**
-       * This callback can return four different things:
-       * 1. A message notifying about the success starting the navigation
-       * 2. A json with the NavigationProgress. The Json will also have a field "type" with the value "progress" so you can know when this happens.
-       * 3. A json with the field "type" and the value "destinationReached". This happens when the navigation finish because you reached the end.
-       * 4. A json with the field "type" and the value "userOutsideRoute". This happens when the user deviate from the route. You can notify them so they return to the correct path.
-       */
-    },
-    (error: any) => {
-      //returns error string
-    });
+  (navigation: any) => {
+    /**
+     * This callback can return four different things:
+     * 1. A message notifying about the success starting the navigation
+     * 2. A json with the NavigationProgress. The Json will also have a field "type" with the value "progress" so you can know when this happens.
+     * 3. A json with the field "type" and the value "destinationReached". This happens when the navigation finish because you reached the end.
+     * 4. A json with the field "type" and the value "userOutsideRoute". This happens when the user deviate from the route. You can notify them so they return to the correct path.
+     */
+  },
+  (error: any) => {
+    //returns error string
+  }
+);
 ```
 
 #### - updateNavigationWithLocation
-    
+
 Usually, position variable should be one of the locations provided by the system on the [startPositioning](#--startpositioning) function.
 
 ```js
-cordova.plugins.Situm.updateNavigationWithLocation(currentLocation)
+cordova.plugins.Situm.updateNavigationWithLocation(currentLocation);
 ```
 
 #### - removeNavigationUpdates
@@ -334,22 +391,22 @@ cordova.plugins.Situm.removeNavigationUpdates();
 
 #### - requestRealTimeUpdates
 
-Emits the [real time](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#RealTimeData) location of devices 
+Emits the [real time](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#RealTimeData) location of devices
 
 ```js
 const request = {
-      building: building, //Building in which you want to be notified
-      pollTime: 3000, // time in milliseconds
-    }
+  building: building, //Building in which you want to be notified
+  pollTime: 3000, // time in milliseconds
+};
 cordova.plugins.Situm.SitumPlugin.requestRealTimeUpdates(
   request,
-    (locations: any) => {
-      // returns the locations of the other devices in real time
-    },
-    (error: any) => {
-      // returns error string
-    }
-    );
+  (locations: any) => {
+    // returns the locations of the other devices in real time
+  },
+  (error: any) => {
+    // returns error string
+  }
+);
 ```
 
 #### - removeRealTimeUpdates
@@ -379,6 +436,7 @@ cordova.plugins.Situm.onEnterGeofences((geofences: any) => {
 #### - onExitGeofences
 
 Get notified about exiting geofences. Take into account the considerations described at [onEnterGeofences](#--onEnterGeofences).
+
 - This callback will return an array of [geofences](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global.html#Geofence)
 
 ```js
@@ -388,6 +446,96 @@ cordova.plugins.Situm.onExitGeofences((geofences: any) => {
 });
 ```
 
+### MapView class
+
+#### - onLoad
+
+Get notified about the \<map-view\> HTMLElement component being loaded.
+
+- This callback will return the controller of MapView, [MapViewController](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/mapviewcontrollerimpl), to start managing the map-view as you may want.
+
+```js
+cordova.plugins.MapView.onLoad((controller: any) => {
+  // Once the MapView was loaded you can start managing our map by:
+
+  // 1. Sending actions like selecting or navigating to a poi in a building:
+  // controller.selectPoi('YOUR_POI_IDENTIFIER');
+  // controller.navigateToPoi('YOUR_POI_IDENTIFIER');
+
+  // 2. Listen to events that take place inside our map like a poi being selected or deselected:
+  controller.onPoiSelected((poiSelectedResult: any) => {
+    console.log("EXAMPLE> onPoiSelected -> ", poiSelectedResult);
+  });
+
+  controller.onPoiDeselected((poiDeselectedResult: any) => {
+    console.log("EXAMPLE> onPoiDeselected -> ", poiDeselectedResult);
+  });
+});
+```
+
+### MapViewController class
+
+#### - selectPoi
+
+Select a POI in the map.
+
+- You can find out what identifier has a certain POI of your building by previously retrieving them with [**cordova.plugins.Situm.fetchIndoorPOIsFromBuilding()**](#--fetchIndoorPOIsFromBuilding)
+
+```js
+cordova.plugins.MapView.onLoad((controller: any) => {
+  // Once the MapView was loaded you can select a POI in our map by calling:
+  controller.selectPoi("YOUR_POI_IDENTIFIER");
+});
+```
+
+#### - navigateToPoi
+
+Navigate to a POI in the map when positioning indoors inside a building.
+
+- You can also specify the route you want to calculate by specifying the accessibilityMode parameter. See the different [accessibility modes](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/mapviewcontrollerimpl#navigateToPoi) you can choose.
+
+```js
+cordova.plugins.MapView.onLoad((controller: any) => {
+  // Once the MapView was loaded you can navigate to a POI in our map.
+  // Make sure to call this method once the user is positioning indoors in your building,
+  // otherwise this method will have no effect.
+  controller.navigateToPoi("YOUR_POI_IDENTIFIER");
+
+  // controller.navigateToPoi("YOUR_POI_IDENTIFIER", "CHOOSE_SHORTEST");
+});
+```
+
+#### - onPoiSelected
+
+Listen to the selection event of a POI.
+
+- This method will be called when some POI is selected, either by the user clicking a POI inside the MapView or by calling [controller.selectPoi()](#--selectPoi).
+- This callbacks returns a [PoiSelectedResult](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global#PoiSelectedResult).
+
+```js
+cordova.plugins.MapView.onLoad((controller: any) => {
+  // Once the MapView was loaded you can listen to a POI being selected.
+  controller.onPoiSelected((poiSelectedResult: any) => {
+    console.log("EXAMPLE> onPoiSelected -> ", poiSelectedResult);
+  });
+});
+```
+
+#### - onPoiSelected
+
+Listen to listen to a POI being deselected.
+
+- This callbacks returns a [PoiDeselectedResult](https://developers.situm.com/sdk_documentation/cordova/jsdoc/latest/global#PoiDeselectedResult).
+
+```js
+cordova.plugins.MapView.onLoad((controller: any) => {
+  // Once the MapView was loaded you can listen to a POI being deselected.
+  controller.onPoiDeselected((poiDeselectedResult: any) => {
+    console.log("EXAMPLE> onPoiDeselected -> ", poiDeselectedResult);
+  });
+});
+```
+
 ---
 
 ## Development
@@ -395,56 +543,59 @@ cordova.plugins.Situm.onExitGeofences((geofences: any) => {
 ### Run javascript tests
 
     1.  Install mocha and expect.js:
-    
+
     ```javascript
     npm install mocha --save
     npm install expect.js --save
     ```
-    
-    2. In js tests folder run: 
-
-  ```javascript 
-mocha test 
-  ```
 
-#### Dependencies
+    2. In js tests folder run:
 
-  - [mocha](https://www.npmjs.com/package/mocha), needed to run tests.
-  - [expect.js](https://www.npmjs.com/package/expect.js), needed to do assertions.
+```javascript
+mocha test
+```
 
+#### Dependencies
 
+- [mocha](https://www.npmjs.com/package/mocha), needed to run tests.
+- [expect.js](https://www.npmjs.com/package/expect.js), needed to do assertions.
 
 ### Note for Android platform
 
 Situm SDK for Android now compiles and targets sdkVersion 31 (Android 12). To work properly on Android 12 devices and above, the host app must:
-  * Target android api 31 or above. In your project `config.xml` file, add `<preference name="android-targetSdkVersion" value="31" />` to the Android platform configuration.
-  * Request the runtime permissions `ACCESS_COARSE_LOCATION`, `BLUETOOTH_SCAN` and `BLUETOOTH_CONNECT` (plus `ACCESS_FINE_LOCATION` if you are using [Global Mode](https://situm.com/docs/how-does-situm-work/#5-toc-title)). Remember to also add them to the Android platform section of your `config.xml` file:
-  ```xml
-    <config-file parent="/manifest" target="AndroidManifest.xml">
-      <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
-      <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <!-- In Global mode -->
-      <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
-      <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
-    </config-file>
-  ```
-  * Add `android:exported="true"` to all the intent-filtered components of your `AndroidManifest.xml` file. You can add the following configuration to your `config.xml` to automate this process:
-  ```xml
-    <edit-config
-        file="app/src/main/AndroidManifest.xml"
-        target="/manifest/application/activity[@android:name='MainActivity']"
-        mode="merge">
-      <activity android:exported="true"/>
-    </edit-config>
-  ```
-  * Make sure the `widget` root element of your `config.xml` file declares the Android namespace:
-  ```xml
-    <widget id="..." version="..."
-      ...
-      xmlns:android="http://schemas.android.com/apk/res/android">
-  ```
-  * If you find problems, also make sure the Gradle JDK points to version 11 in your project configuration (recommended Android Studio embedded JDK).
 
+- Target android api 31 or above. In your project `config.xml` file, add `<preference name="android-targetSdkVersion" value="31" />` to the Android platform configuration.
+- Request the runtime permissions `ACCESS_COARSE_LOCATION`, `BLUETOOTH_SCAN` and `BLUETOOTH_CONNECT` (plus `ACCESS_FINE_LOCATION` if you are using [Global Mode](https://situm.com/docs/how-does-situm-work/#5-toc-title)). Remember to also add them to the Android platform section of your `config.xml` file:
+
+```xml
+  <config-file parent="/manifest" target="AndroidManifest.xml">
+    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+    <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
+    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+  </config-file>
+```
+
+- Add `android:exported="true"` to all the intent-filtered components of your `AndroidManifest.xml` file. You can add the following configuration to your `config.xml` to automate this process:
+
+```xml
+  <edit-config
+      file="app/src/main/AndroidManifest.xml"
+      target="/manifest/application/activity[@android:name='MainActivity']"
+      mode="merge">
+    <activity android:exported="true"/>
+  </edit-config>
+```
 
+- Make sure the `widget` root element of your `config.xml` file declares the Android namespace:
+
+```xml
+  <widget id="..." version="..."
+    ...
+    xmlns:android="http://schemas.android.com/apk/res/android">
+```
+
+- If you find problems, also make sure the Gradle JDK points to version 11 in your project configuration (recommended Android Studio embedded JDK).
 
 ### Capacitor compatibility
 
@@ -453,20 +604,19 @@ This plugin is compatible with Capacitor 3.0.
 **Issue**: In iOS, there is a known issue with capacitor-cli 3.2.5 and static cordova plugins https://github.com/ionic-team/capacitor/issues/5142. To solve it use a different version of capacitor cli.
 
 If the problem persists, add this plugin to the `staticPlugins` section of your `capacitor.config.json` file:
+
 ```json
 {
-	"cordova": {
-		"staticPlugins": [
-			"@situm/cordova"
-		]
-	}
+  "cordova": {
+    "staticPlugins": ["@situm/cordova"]
+  }
 }
 ```
 
-
 ## More information
 
 More info is available at our [Developers Page](https://situm.com/docs/01-introduction/).
 
 ## Support information
+
 For any question or bug report, please send an email to [support@situm.es](mailto:support@situm.es)