Some special custom fields trigger certain behaviours or enable certain functionalities. Below, the custom fields are explained according to the application level.
Internationalization custom-fields #
Please take a look at Situm Dashboard Internationalization section to know more about how to use custom fields to internationalize cartography elements.
Map Viewer custom-fields #
In addition to what’s explained here, our Map Viewer has its own set of custom-fields. Take a look at them here.
Building custom-fields #
To do this we go to the left sidebar and click Buildings:
Later we select the edit building button, located next to the Cartography title on the top menu:
Finally, we click on Other Fields, and a button will appear , which when we click on it, the key and value options will appear to insert the custom field:
For this level there are the following modes:
Setting a building’s beacon filters #
Situm SDK, by default, only uses beacons with Situm UUID. If you want to use your own beacons, add a custom field with a key called beacons_uuids, and also add the list of beacon identifiers as a value of this key.
Example for one beacon filter:
Key | Value |
---|---|
beacons_uuids | 059e0694-60d0-4c48-a6cd-ef4ee2987a93 |
Example for multiple beacon filters (separated by commas):
Key | Value |
---|---|
beacons_uuids | 4afa9e5b-1445-4525-a5e2-3fa25ba98656,b05ab4c0-5e3e-4007-ade1-e6593f86b644 |
To check that they are scanned correctly, in the Positioning menu, the number of WiFi APs and BLE beacons scanned is updated in real-time (1). By clicking on the dialog, you may see all the BLE beacon (2). In Layout you can see the number of uuidd if the beacon isn´t of Situm.
Activating WiFi enterprise mode #
On certain corporate buildings, routers can emit on different MAC addresses, where the last hexadecimal digit changes. If this happens, it is necessary to activate the WiFi enterprise mode, in order to guarantee accurate location information. In order to activate this mode, it is necessary to create a custom field with a key called wifi_virtual_mac_support and a value of true.
Key | Value |
---|---|
wifi_virtual_mac_support | true |
Deactivate the GPS Indoor Mode (Calibrated & Uncalibrated) #
Both methods can be deactivated by setting the following custom-field at the building level: use_gps = False. This will cause Situm to not use GPS at all (regardless of how the app is configured).
Key | Value |
---|---|
use_gps | false |
Random Forest #
Allows you to enable/disable the Wifi / BLE classifier for a building. It is used to give a better positioning in the change of plants with the SDK. These are true by default, if floor changes do not work properly, disabling them may improve transitions.
Wifi classifier :
Key | Value |
---|---|
use_wifi_floor_classifier | true/false |
BLE classifier:
Key | Value |
---|---|
use_ble_floor_classifier | true/false |
Asset Localization #
It allows filtering the devices to be positioned in the asset location service (location).
It allows to indicate a non-sliding temporary size, in minutes, that will be used to group positions.
Filter devices:
Key | Value |
---|---|
filter-beacon | List of macs in hexadecimal separated by commas |
Time window size:
Key | Value |
---|---|
update_window_minutes | Integer representing the window size in minutes that will be used to group positions |
Geofence custom-fields #
To add a custom Geofence field we go to Cartography-> Geofences:
When we click on Other fields, the button will appear , the key and value options will appear to insert the custom field:
It allows modifying the positioning behaviour by indicating to the Real-Time Locating System that it should apply different behaviours in the area defined by the fence. Important: To apply the changes it is necessary to force the retraining of the model:
Activating the Uncalibrated Indoor Geolocation Mode #
This method is used in 90% of the buildings. It can also be called enhanced GPS because, in addition to the GPS signal provided by Google, it adds the phone’s sensors, which provides greater accuracy.
To activate it go to the dashboard and you can add configuration fences for a building.
To do this, a fence must be created in the area/plant in which you want to use that configuration parameter, with a custom field, whose key is trainer_metadata and a valid JSON value with the desired configuration parameter.
Generally used with “passable” to use GPS in uncalibrated areas. If the GPS gives the position in this area it reduces the confidence in the Wi-Fi.
Example:
Key | Value |
---|---|
trainer_metadata | {"passable":"true", "use_gps":"true"} |
Random Forest #
Apply or not the RF weighing WiFi / BLE to the particles of the plant and defined area:
Wifi RF :
Key | Value |
---|---|
use_rf_wifi | true/false |
BLE RF:
Key | Value |
---|---|
use_ble_floor_classifier | true/false |
Passable #
Defines an area as passable or non-passable on the navigation map.
- Set the value to true if you want the GPS to be heavier in a certain area with good GPS accuracy and low WiFi.
- Set the value to false, for example, to separate 2 areas with different uses or activities. For example to separate two zones that when calibrating by rail width have come together.
Key | Value |
---|---|
passable | true/false |
Weight Factor #
Refers to the weight factor or weighting factor that is assigned to different elements or variables in a positioning algorithm. This factor determines the relative importance of each element or variable in the final position calculation.
When positioning, a variety of signals or information are used to determine the location of an object or device. These signals may include GPS signal strength, time measurements, radio signals, and other relevant data. Each of these signals or data may have a different accuracy or reliability.
The weight factor is used to assign a weight to each signal or data based on its accuracy or reliability.
Key | Value |
---|---|
weight_factor | float |
Stationary Alarms #
- max_stay_time: Configuration of the maximum time (in seconds) that a user can spend inside a geofence before triggering the alarm.
- time_outside_limit: Following the request to be able to also parameterize the time to leave the geofence before resetting the counter we have created this parameter. That is, setting the maximum time (in seconds) that a user can leave the geofence before closing the session.
Key | Value |
---|---|
max_stay_time | integer |
time_outside_limit | integer |
The following configuration has been used mostly in COVID times and for enclosures where you want to control the number of people inside:
Capacity control in MRM Tracker #
Below we see the configurable options that notify users by notification when the capacity is going to be exceeded:
Max Capacity:
A maximum number of people can be in the geofence.
Key | Value |
---|---|
max_capacity | integer |
Warning Capacity Threshold:
Percentage of capacity at which the user is notified.
Key | Value |
---|---|
warning_capacity_threshold | integer |
POI custom-fields #
To add a custom POIS field we go to Cartography-> Points of interest:
When we click on Other fields, the button will appear , 2 fields will appear to enter Key and Value:
Organization level #
In addition to these, the Situm Team can implement others such as:
MRM Tracker Configuration PIN #
When a user tries to access the configuration section of the MRM Tracker, the system will ask them to enter a PIN to access. For this to happen we will put in Key pin_config and in Value the numerical value.
When you try to enter the configuration of the App, the following screen will appear:
MRM Tracker Logout PIN #
When a user tries to log out of the MRM Tracker, it will ask for a PIN in order to perform that action. To configure it we will put in Key pin_logout and in Value the numerical value.