Start geolocation poller
- 18 May 2022
- 1 Minute to read
-
DarkLight
-
PDF
Start geolocation poller
- Updated on 18 May 2022
- 1 Minute to read
-
DarkLight
-
PDF
Start polling for device GPS location. Latest location is stored under sensorVars.geolocation.latestValue, with sensorVars.geolocation.values having a list of historical readings. You can define the maximum size of this list with the History size parameter.
The first output is triggered after the poller has started and the first value has been successfully fetched.
Note that the update interval value is treated by iOS and Android more as a recommendation than an exact value.
Input arguments
| Label | Key | Type | Required? | Default | Description |
|---|---|---|---|---|---|
| Update interval | updateInterval |
Number(integer) | Yes | 100 | Interval, in ms, of how often the poller should fetch a new value. |
| History size | historySize |
Number(integer) | Yes | 20 | Maximum number of historical values to store under sensorVars.geolocation.values. |
| High accuracy mode | enableHighAccuracy |
Boolean | Yes | true | If true, a GPS position will be requested. If set to false, a WIFI location will be requested. |
| Distance filter | distanceFilter |
Number | Yes | 1 | Number of meters from the previous location to exceed before returning a new location. Set to 1 to not filter locations. Defaults to 1 |
Output arguments
Number of outputs: 2
No output arguments.
Events
No events.
Errors
| Label | Code | Description |
|---|---|---|
| Unknown error | unknown |
Thrown when calling the native API resulted in an unknown error. |
Was this article helpful?