ThingPark X Location Engine API - Feed/Binder module
Welcome to the ThingPark X Location Engine Binder API reference documentation. The purpose of this API is to provide the best experience for all developers who intend to interface with ThingPark geolocation features.
In order to get acquainted with the API, you can use the convenient online client Swagger-UI.
To use the API from your application, you can generate client code using the API’s OpenAPI contract.
Below are descriptions and examples for all operations exposed by this API.
Feed operations
Feed operations are used to provide geolocation data (coordinates, payload, solver input) for further processing.
Feed request
Feeds the platform with geolocation data. Data is then dispatched and processed based on available information.
HTTP Endpoint
POST /feeds
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| Feed | body | Feed | true | Contents of the feed request. |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | Feed request performed successfully. | |
| 400 | Bad request - Invalid Feed object. | |
| 401 | Unauthorized - invalid api key. | |
| 403 | Validation Error - device association check failure. |
BinderConfig operations
Binder configuration operations are used to configure connection between ThingPark Location Engine and LoRa operators. Currently only the ThingPark Location Engine can be configured to push downlink commands to a target HTTP server.
Binder configurations retrieval
Retrieves the list of existing binder configurations.
HTTP Endpoint
GET /binderConfigs
Responses
| Code | Type | Description |
|---|---|---|
| 200 | BinderConfig array | Binder with their configurations retrieved successfully. |
Binder configuration creation
Creates a new binder configuration.
HTTP Endpoint
POST /binderConfigs
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| BinderConfig | body | BinderConfig | true | Contents of the binder configuration to create. |
Responses
| Code | Type | Description |
|---|---|---|
| 201 | BinderConfig | Binder configuration created successfully. |
| 400 | Bad request - Invalid BinderConfig object. |
Binder configurations deletion
Deletes the all the binder configurations corresponding to the provided user.
HTTP Endpoint
DELETE /binderConfigs
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| deviceEUI | query | String | true | the device EUI of the binder configs. |
| dxProfileId | query | String | false | Mandatory in case of B2B operator token. In case of B2B subscriber token, it can be left empty, or the same as in the token. |
| customerId | query | String | false | Mandatory in case of B2B operator token. In case of B2B subscriber token, it can be left empty, or the same as in the token. |
| parentRealmId | query | String | false | Mandatory in case of B2C operator token. |
| realmId | query | String | false | Mandatory in case of B2C operator token. |
| userId | query | String | false | Mandatory in case of B2C operator token. |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | Binder configurations are deleted successfully. | |
| 400 | Bad request - BinderConfig object not found. | |
| 401 | Permission denied - User doesn’t have access to this BinderConfig. |
Binder configuration retrieval
Retrieves the binder configuration corresponding to the provided ref.
HTTP Endpoint
GET /binderConfigs/{binderConfigRef}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| binderConfigRef | path | String | true | Ref of the binder configuration to retrieve. |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | BinderConfig | Binder configuration retrieved successfully. |
| 401 | Permission denied - User doesn’t have access to this BinderConfig. |
Binder configuration update
Updates the binder configuration corresponding to the provided ref.
HTTP Endpoint
PUT /binderConfigs/{binderConfigRef}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| binderConfigRef | path | String | true | Ref of the binder configuration to update. |
| BinderConfig | body | BinderConfig | true | Contents of the binder configuration to update. |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | BinderConfig | Binder configuration updated successfully. |
| 400 | Bad request - Missing ref in BinderConfig object, or BinderConfig not found. | |
| 401 | Permission denied - User doesn’t have access to this BinderConfig. |
Binder configuration deletion
Deletes the binder configuration corresponding to the provided ref.
HTTP Endpoint
DELETE /binderConfigs/{binderConfigRef}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| binderConfigRef | path | String | true | Ref of the binder configuration to delete. |
Responses
| Code | Type | Description |
|---|---|---|
| 204 | Binder configuration deleted successfully. | |
| 400 | Bad request - BinderConfig object not found. | |
| 401 | Permission denied - User doesn’t have access to this BinderConfig. |
Resources
BinderConfig
Resource representing a configuration binding downlink tracker commands.
| Attribute | Type | Description |
|---|---|---|
| callbackURL | String | HTTP url of the target server to which the tracker command should be sent as a callback to the downlink. |
| ref | String | Ref of the module configuration. Generated by the system upon creation. |
| deviceEUIList | String | List of devices EUI managed by the module. Device EUIs must be separated by commas. If the field is *, the config applies to all the trackers of the customer/subscriber. * is not allowed for end users |
ConfigFlags
| Attribute | Type | Description |
|---|---|---|
| framePendingMechanism | Boolean | -false: Frame pending mechanism is disabled. -true: Frame pending mechanism is enabled. Factory default value. (Supported from Asset Tracker 1.7.0) |
| buttonPressToTurnDeviceOff | Boolean | -false: Cannot turn OFF device with a button press. -true: Can turn OFF device with a button press. Factory default value.(Supported from Asset Tracker 1.7.0) |
| doubleClickIsSosModeOrAlert | Boolean | -false: Double button click triggers an Alert. -true: Double button click starts SOS mode, another double click stops it. Factory default value. (Supported from Asset Tracker 1.7.0) |
| downlinkSetParameterConfirmation | Boolean | -false: Confirmation uplink mechanism is disabled. -true: Confirmation uplink mechanism is enabled. Factory default value. (Supported from Asset Tracker 1.7.0) |
| wifiPayloadWithNoCypher | Boolean | -false: Wifi payload is cyphered. -true: Wifi payload is not cyphered. Factory default value. (Supported from Asset Tracker 1.7.0) |
| bleAdvertisingAtStart | Boolean | -false: BLE advertising is disabled. Factory default value. -true: BLE advertising is enabled. (Supported from Asset Tracker 1.7.0) |
| selectWifiScanOrGeolocStartMessage | Boolean | -false: Enable geoloc start event message when starting a geoloc sequence. -true: Enable Wifi scan when starting a geoloc sequence. Factory default value. (Supported from Asset Tracker 1.7.3) |
| ledBlinkWithGpsFix | Boolean | -false: No blink when a GPS fix is received. Factory default value. -true: LED Blink when a GPS fix is received. (Supported from Asset Tracker 1.7.3) |
| startMotionEventUplink | Boolean | -false: Start Motion event payload is disabled. Factory default value. -true: Start Motion event payload is enabled. (Supported from Asset Tracker 1.8.0) |
| endMotionEventUplink | Boolean | -false: End Motion event payload is disabled. Factory default value. -true: End Motion event payload is enabled. (Supported from Asset Tracker 1.8.0) |
| otaJoinWhenLeavingModeOff | Boolean | -false: Disable OTA join when leaving mode OFF. Factory default value. -true: Enable OTA join when leaving mode OFF. (Supported from Asset Tracker 1.8.0) |
| rejectAsymmetricBlePairing | Boolean | -false: Accept asymmetric BLE pairing. Factory default value. -true: Reject asymmetric BLE pairing. (Supported from Asset Tracker 1.8.0) |
| enableLongWifiPayload | Boolean | -false: Long wifi payload is disabled. Factory default value. -true: Long wifi payload is enabled. (Supported from Asset Tracker 1.9.0) |
| collectionLongReport | Boolean | false: The usual payload size is used (36 bytes). true: The number of entries carried in the uplink is larger and use a payload size of 91 bytes. (Supported from Asset Tracker 2.0) |
| autoStart | Boolean | false: Once LoRa join succeeds, the user needs to make another long press to actually start in the configured operating mode. true: Once LoRa join succeeds, the device automatically starts without requiring a long press. (Supported from Asset Tracker 2.0) |
EnableDatarate
A bitmap representing each DR to select for the transmission. You Can configure DR from DR0 to DR7. If no DR is selected, default DR will be minimum available DR for the current band. (Supported from Asset Tracker 1.9.0).
| Attribute | Type | Description |
|---|---|---|
| dr0 | Boolean | -false: dr0 is disabled. -true: dr0 is enabled. |
| dr1 | Boolean | -false: dr1 is disabled. -true: dr1 is enabled. |
| dr2 | Boolean | -false: dr2 is disabled. -true: dr2 is enabled. |
| dr3 | Boolean | -false: dr3 is disabled. -true: dr3 is enabled. |
| dr4 | Boolean | -false: dr4 is disabled. -true: dr4 is enabled. |
| dr5 | Boolean | -false: dr5 is disabled. -true: dr5 is enabled. |
| dr6 | Boolean | -false: dr6 is disabled. -true: dr6 is enabled. |
| dr7 | Boolean | -false: dr7 is disabled. -true: dr7 is enabled. |
Feed
Resource representing a feed to be processed by ThingPark Location. When defining a feed, ‘deviceEUI’ and 'time’ attributes are mandatory. Either 'coordinates’ attribute or 'solverInput’ attribute should then be defined. The optional 'payload’ attribute can be defined to obtain additional feed information from the encoded payload for supported devices.
| Attribute | Type | Description |
|---|---|---|
| deviceEUI | String | Unique device identifier. |
| customerId | String | Unique customer identifier sent through Operator Interface. |
| time | Date | Time associated with the device position (e.g. time of arrival to the base station), in ISO 8601 format. |
| b2cFlag | Boolean | Optional flag indicating if the message should be processed on behalf of a B2C app end user |
| modelCfg | String | Internal property used for routing purposes. |
| coordinates | double array | Device coordinates, to be used 'as is’ in the platform. Expected value is an array of coordinates as per the GeoJSON specification, i.e. [longitude, latitude, altitude]. |
| coordinatesType | String | Type of solver that originated device coordinates sent in “coordinates” property. Possible values are 'MOBILE_DEVICE_COORDINATES’, ‘RSSI_SOLVER_COORDINATES’ and 'TDOA_SOLVER_COORDINATES’. |
| coordinatesAccuracy | BigDecimal | Accuracy in meters of the position provided in “coordinates” property |
| incomingSubscriberId | String | External Suscriber ID to be transparently handled by ThingPark Location. |
| trackerOutput | TrackerAsAssetTracker | |
| trackerParameters | Resouce representing the tracker’s parameters to be set | |
| solverInput | FeedInputForGenericSolver | |
| payload | FeedPayload | |
| customerData | Customer Data from Actility Operator |
FeedInputForAgpsSolver
Resource extending RawPositionByGenericSolver with additional information provided by the AGPS solver.
| Attribute | Type | Description |
|---|---|---|
| solverInputType | String | Type of solver input eventually extending the FeedInputForGenericSolver resource to allow more specific attributes to be provided. |
| sequenceNumber | Long | Sequence number of the device uplink. |
| port | Integer | LoRa port used by the device. |
| receptionTime | Date | Time associated with the reception of the device uplink, in ISO 8601 format. |
| SF | Integer | Spreading factor value of the device. |
| packets | FeedPacket array | List of packets received by base stations and related to the device uplink. |
| dynamicMotionState | String | Motion state provided by the device. Possible values are 'MOVING’, 'STATIC’ and 'UNKNOWN’. |
| temperatureMeasure | Float | Temperature measured by the device in celsius degrees. |
| accelerometerMeasures | float array | Proper acceleration measured by the device in m/s2. Expected value is an array of measures per axis, i.e. [x, y, z]. |
| gyroscopeMeasures | float array | Rotational motion measured by the device in degrees/s. Expected value is an array of measures per axis, i.e. [roll, pitch, yaw]. |
| barometerMeasure | Float | Atmospheric pressure measured by the device in mb. |
| lastContext | String | This optional attribute contains the Base64 encoded binary solver state returned with the last calculated position. This attribute may be required if the target solver is configured in stateless mode and this is not the first request for a given deviceEUI. |
FeedInputForGenericSolver
Resource representing generic information which can be used as input by a solver. To be eventually inherited to define more specific solver input resources. The 'solverInputType’ discriminator attribute indicates which type of resource is defined.
| Attribute | Type | Description |
|---|---|---|
| solverInputType | String | Type of solver input eventually extending the FeedInputForGenericSolver resource to allow more specific attributes to be provided. |
| sequenceNumber | Long | Sequence number of the device uplink. |
| port | Integer | LoRa port used by the device. |
| receptionTime | Date | Time associated with the reception of the device uplink, in ISO 8601 format. |
| SF | Integer | Spreading factor value of the device. |
| packets | FeedPacket array | List of packets received by base stations and related to the device uplink. |
| dynamicMotionState | String | Motion state provided by the device. Possible values are 'MOVING’, 'STATIC’ and 'UNKNOWN’. |
| temperatureMeasure | Float | Temperature measured by the device in celsius degrees. |
| accelerometerMeasures | float array | Proper acceleration measured by the device in m/s2. Expected value is an array of measures per axis, i.e. [x, y, z]. |
| gyroscopeMeasures | float array | Rotational motion measured by the device in degrees/s. Expected value is an array of measures per axis, i.e. [roll, pitch, yaw]. |
| barometerMeasure | Float | Atmospheric pressure measured by the device in mb. |
| lastContext | String | This optional attribute contains the Base64 encoded binary solver state returned with the last calculated position. This attribute may be required if the target solver is configured in stateless mode and this is not the first request for a given deviceEUI. |
FeedInputForGpsSolver
Resource extending RawPositionByGenericSolver with additional information provided by the GPS solver.
| Attribute | Type | Description |
|---|---|---|
| solverInputType | String | Type of solver input eventually extending the FeedInputForGenericSolver resource to allow more specific attributes to be provided. |
| sequenceNumber | Long | Sequence number of the device uplink. |
| port | Integer | LoRa port used by the device. |
| receptionTime | Date | Time associated with the reception of the device uplink, in ISO 8601 format. |
| SF | Integer | Spreading factor value of the device. |
| packets | FeedPacket array | List of packets received by base stations and related to the device uplink. |
| dynamicMotionState | String | Motion state provided by the device. Possible values are 'MOVING’, 'STATIC’ and 'UNKNOWN’. |
| temperatureMeasure | Float | Temperature measured by the device in celsius degrees. |
| accelerometerMeasures | float array | Proper acceleration measured by the device in m/s2. Expected value is an array of measures per axis, i.e. [x, y, z]. |
| gyroscopeMeasures | float array | Rotational motion measured by the device in degrees/s. Expected value is an array of measures per axis, i.e. [roll, pitch, yaw]. |
| barometerMeasure | Float | Atmospheric pressure measured by the device in mb. |
| lastContext | String | This optional attribute contains the Base64 encoded binary solver state returned with the last calculated position. This attribute may be required if the target solver is configured in stateless mode and this is not the first request for a given deviceEUI. |
FeedInputForTdoaRssiSolver
Resource extending FeedInputForGenericSolver with additional information to be used for TDoA / RSSI solver resolution.
| Attribute | Type | Description |
|---|---|---|
| solverInputType | String | Type of solver input eventually extending the FeedInputForGenericSolver resource to allow more specific attributes to be provided. |
| sequenceNumber | Long | Sequence number of the device uplink. |
| port | Integer | LoRa port used by the device. |
| receptionTime | Date | Time associated with the reception of the device uplink, in ISO 8601 format. |
| SF | Integer | Spreading factor value of the device. |
| packets | FeedPacket array | List of packets received by base stations and related to the device uplink. |
| dynamicMotionState | String | Motion state provided by the device. Possible values are 'MOVING’, 'STATIC’ and 'UNKNOWN’. |
| temperatureMeasure | Float | Temperature measured by the device in celsius degrees. |
| accelerometerMeasures | float array | Proper acceleration measured by the device in m/s2. Expected value is an array of measures per axis, i.e. [x, y, z]. |
| gyroscopeMeasures | float array | Rotational motion measured by the device in degrees/s. Expected value is an array of measures per axis, i.e. [roll, pitch, yaw]. |
| barometerMeasure | Float | Atmospheric pressure measured by the device in mb. |
| lastContext | String | This optional attribute contains the Base64 encoded binary solver state returned with the last calculated position. This attribute may be required if the target solver is configured in stateless mode and this is not the first request for a given deviceEUI. |
| algorithm | String | Algorithm to be used by the solver. Possible values are 'TDOA’, 'RSSI’ or 'TDOA_RSSI’ (both). |
| staticMotionIndicator | String | Statically configured device motion indicator. Possible values are 'NEAR_STATIC’, 'WALKING’, 'BICYCLE’, 'VEHICLE’ and 'RANDOM’. |
| updateRequired | Boolean | Indicates if the device location should be updated. Default value is false. |
| resetRequired | Boolean | Indicates to reset EKF filter state when previous state is no more relevant, i.e. when device (re)JOINs network. Default value is false. |
FeedInputForWifiSolver
Resource extending FeedInputForGenericSolver with additional information to be used for WiFi solver resolution.
| Attribute | Type | Description |
|---|---|---|
| solverInputType | String | Type of solver input eventually extending the FeedInputForGenericSolver resource to allow more specific attributes to be provided. |
| sequenceNumber | Long | Sequence number of the device uplink. |
| port | Integer | LoRa port used by the device. |
| receptionTime | Date | Time associated with the reception of the device uplink, in ISO 8601 format. |
| SF | Integer | Spreading factor value of the device. |
| packets | FeedPacket array | List of packets received by base stations and related to the device uplink. |
| dynamicMotionState | String | Motion state provided by the device. Possible values are 'MOVING’, 'STATIC’ and 'UNKNOWN’. |
| temperatureMeasure | Float | Temperature measured by the device in celsius degrees. |
| accelerometerMeasures | float array | Proper acceleration measured by the device in m/s2. Expected value is an array of measures per axis, i.e. [x, y, z]. |
| gyroscopeMeasures | float array | Rotational motion measured by the device in degrees/s. Expected value is an array of measures per axis, i.e. [roll, pitch, yaw]. |
| barometerMeasure | Float | Atmospheric pressure measured by the device in mb. |
| lastContext | String | This optional attribute contains the Base64 encoded binary solver state returned with the last calculated position. This attribute may be required if the target solver is configured in stateless mode and this is not the first request for a given deviceEUI. |
| networks | FeedNetwork array | List of WiFi networks identified around the device. |
FeedNetwork
Resource representing a generic network.
| Attribute | Type | Description |
|---|---|---|
| SSID | String | SSID of the network. |
| RSSI | Float | RSSI in cBm. |
FeedPacket
Resource representing a generic packet received by a base station.
| Attribute | Type | Description |
|---|---|---|
| baseStationId | String | Id of the base station (aka LRR or gateway) which received the uplink. |
| antennaId | Integer | Id of the base station antenna which received the uplink. Possible values are 0 (main), 1 (diversity for mono-sector LRRs), or 0 to 2 (for tri-sector LRRs). |
| antennaCoordinates | double array | Coordinates of the base station antenna. Expected value is an array of coordinates as per the GeoJSON specification, i.e. [longitude, latitude, altitude]. |
| antennaHeight | Float | Height of the base station’s antenna in cm. |
| SNR | Float | Signal to Noise ratio in dB. |
| RSSI | Float | RSSI in cBm. |
| barometerMeasure | Float | Atmospheric pressure measured by the base station in mb. |
| arrivalSeconds | Integer | Coarse arrival time on the antenna in seconds. |
| arrivalAdditionalNanos | Integer | Additional nanoseconds completing the arrival time second. |
FeedPayload
Resource representing a payload to be used to obtain tracker-specific location information.
| Attribute | Type | Description |
|---|---|---|
| deviceProfileId | String | Id of the profile associated with the device, used for decoding properly the payload. |
| payloadEncoded | String | Binary device payload encoded as an hexadecimal string. |
TrackerAsAssetTracker
Resource representing tracker information obtained directly from the tracker, to be used 'as is’. Currently it only supports Abeeway’s Asset Tracker.
| Attribute | Type | Description |
|---|---|---|
| firmwareVersion | String | MCU firmware version of the tracker. |
| bleFirmwareVersion | String | BLE firmware version of the tracker. |
| eventType | String | The possible values for an event message are: -'UNKNOWN’: Not supported value. - 'GEOLOC_START’: The event message is sent when the tracker begins a geolocation sequence. - 'MOTION_START’: The event message is sent when the tracker begins a motion. -'MOTION_END’: The event message is sent when the end of a motion is detected. -'BLE_CONNECTED’: The event message is sent when a tracker is bonded and BLE connected to a another BLE device. -'BLE_DISCONNECTED’: The event message is sent when a tracker is bonded and BLE disconnected to a another BLE device. -'TEMPERATURE_ALERT’: The event message is sent if the measured temperature is below or above a configured threshold.(Supported from Asset Tracker 1.9.0). -'BLE_BOND_DELETED’: The event message is sent when the bond is deleted on the tracker.(Supported from Asset Tracker 1.9.0) - 'SOS_MODE_START’ (Supported from Asset Tracker 2.2.0) - 'SOS_MODE_END’ (Supported from Asset Tracker 2.2.0) - 'ANGLE_DETECTION’: The event message is sent when the tracker angular position reaches a configured critical angle between a reference vector and the current measured vector.(Supported from Asset Tracker 2.2.0). - 'GEOFENCING’: The event message is sent each time a new area is entered. (Supported from Asset Tracker 2.2.0) |
| trackingMode | String | Tracking mode applied by the tracker. Possible values are: - 'OFF’: Everything is turned OFF to achieve the lowest possible power consumption. - 'STAND_BY’: The tracker is in idle state. It can use periodic reporting if it is activated, and answers to On-Demand position requests. - 'MOTION_TRACKING’: Tracking state only when moving. - 'PERMANENT_TRACKING’: Always in tracking state. - 'MOTION_START_END_TRACKING’: Motion start and end events. - 'ACTIVITY_TRACKING’: The tracker focuses on detecting movements. Every motion detection increases a counter. - 'UNKNOWN’: Not supported value. |
| dynamicMotionState | String | Motion state provided by the device. Possible values are 'MOVING’, 'STATIC’ and 'UNKNOWN’. |
| temperatureMeasure | Float | Temperature measured by the device in celsius degrees. |
| gpsScanMode | String | GPS scan mode (for power efficiency) applied by the tracker. Not implemented yet. |
| sensorMode | String | Sensor mode applied by the tracker. This field is deprecated. Instead refer to geolocSensorProfile and oneshotGeolocMethod. |
| periodicPositionInterval | Integer | Interval in seconds of the periodic position report (Supported from Asset Tracker 1.7.0, called 'periodic_pos_period’ in configuration file). A value of 0 means reporting is disabled, a value of -1 means the setting is unknown. |
| batteryLevel | Integer | Percentage of available battery of the tracker. |
| batteryStatus | String | Represents the battery status. Possible values are: - 'UNKNOWN’: Not supported value. - 'CHARGING’: The battery is charging. - 'OPERATING’: In this case, the battery level indicates the battery usage. |
| sosFlag | Boolean | SOS Flag of the tracker |
| activityReportingWindow | integer array | Periodic activity reporting contains the data of activity during 6 windows of the configured period ('periodicActivityPeriod’), one window being 1/6th of Periodic Activity Period. |
| activityCount | Integer | Activity counter, in case of trackingMode it is 'ACTIVITY_TRACKING’. |
| nbOfShocks | Integer | Number of shocks having an accelerometer value above the configured threshold(“shockDetection”). |
| accelerometerShockData | integer array | Values measured on X, Y, and Z axes of the accelerometer, corresponding to the biggest shock detected during this period, i.e. [x-axis, y-axis, z-axis]. |
| trackerOrientation | integer array | Represents the orientation of the tracker. It is provided only in 'MOTION_END’ event message, i.e. [x-axis, y-axis, z-axis]. |
| trackingUlPeriod | Integer | Interval in seconds for position messages while in tracking state (Supported from Asset Tracker 1.7.0, called “ul_period” in configuration file). |
| loralivePeriod | Integer | Interval in seconds for heartbeat messages in idle state (Supported from Asset Tracker 1.7.0, called “lora_period” in configuration file). |
| energyStatusPeriod | Integer | Interval in seconds of energy status messages (Supported from Asset Tracker 1.7.0, called “pw_stat_period” in configuration file). |
| geolocSensorProfile | String | (Called 'geoloc_sensor’ in configuration file) The geolocation technology to be used for geolocation scans in operating mode. The possible technolgy values are: - 'UNKNOWN’: Not supported value. - 'WIFI_ONLY’: Only the WIFI technology is used (Supported from Asset Tracker 1.7.0). - 'GPS_ONLY’: Only the GPS technology is used (Supported from Asset Tracker 1.7.0). - 'XGPS_ONLY’: Only the Low Power GPS and GPS technologies are used (Supported from Asset Tracker 1.7.0). - 'WIFI_FALLBACK_XGPS’: Swap on failure, alternate WIFI and xGPS (do not use). - 'SELF_GOVERNING_HISTORY’: Self governing with history (do not use). - 'SELF_GOVERNING_TIMEOUT’: Self governing with timeout (superseded by technology WGPS_WXGPS_TIMEOUT). - 'WGPS_ONLY’: The WIFI technology is used first. If the result is not OK, swap to GPS technology in one geolocation cycle (Supported from Asset Tracker 1.7.0). - 'WXGPS_ONLY’: The WIFI technology is used fisrt. If the result is not considered OK, swap to XGPS technology in one geolocation cycle (Supported from Asset Tracker 1.7.0). - 'WGPS_WXGPS_FAILURE’: 'WGPS/WXGPS’, change on failure (Supported from Asset Tracker 1.7.0). - 'WGPS_WXGPS_TIMEOUT’: 'WGPS/WXGPS’, change on timeout (Supported from Asset Tracker 1.7.0). - 'BLE’: BLE beacon scan only (Supported from Asset Tracker 1.7.0). - 'BGPS_ONLY’: The BLE technology is used first. If the result is not OK, swap to low power GPS technology in one geolocation cycle. (Supported from Asset Tracker 1.8.0). - 'BXGPS_ONLY’: The BLE technology is used first. If the result is not OK, swap to low power GPS technology in one geolocation cycle. (Supported from Asset Tracker 2.2.0). |
| oneshotGeolocMethod | String | (Called 'geoloc_method’ in configuration file) The geolocation technology to used for geolocation scans only for the periodic and on-demand positions. The possible technolgy values are: - 'UNKNOWN’: Not supported value. - 'WIFI’: Only the WIFI technology is used (Supported from Asset Tracker 1.7.0). - 'GPS’: Only the GPS technology is used (Supported from Asset Tracker 1.7.0). - 'XGPS’: Only the low power GPS technology is used (Supported from Asset Tracker 1.7.0). - 'WGPS’: The WIFI technology is used first. If the result is not OK, swap to GPS technology (Supported from Asset Tracker 1.7.0). - 'WXGPS’: The WIFI technology is used first. If the result is not OK, swap to low power GPS technology (Supported from Asset Tracker 1.7.0). - 'BLE’: BLE beacon scan only (Supported from Asset Tracker 1.7.0). - 'BGPS’: The BLE technology is used first. If the result is not OK, swap to low power GPS technology in one geolocation cycle. (Supported from Asset Tracker 1.8.0). - 'BXGPS_ONLY’: The BLE technology is used first. If the result is not OK, swap to low power GPS technology in one geolocation cycle. (Supported from Asset Tracker 2.2.0). |
| extAntennaProfile | String | The GPS antenna to be used when starting the GPS.( called 'antenna’ in configuration file). * From Asset Tracker 1.7.0 to Asset Tracker 1.9.0: Possible values are: -'UNKNOWN’: Unknown value. -'UNSUPPORTED’: Not supported value. - 'PRINTED’: use only PRINTED antenna for GPS scans. - 'CERAMIC’: use only ceramic antenna for GPS scans. - 'DYNAMIC’: automatic selection, use ceramic antenna only when facing the sky. * From Asset Tracker 2.0: Only the value CERAMIC is supported. |
| motionStartEndNbTx | Integer | Number of position messages to send after motion events in Start/End tracking mode (Supported from Asset Tracker 1.7.0, called 'motion_nb_pos’ in configuration file). |
| gpsTimeout | Integer | Time in seconds for GPS geoloc timeout (Supported from Asset Tracker 1.7.0, called 'gps_timeout’ in configuration file). |
| xgpsTimeout | Integer | Time in seconds for XGPS geoloc timeout(Supported from Asset Tracker 1.7.0, called 'agps_timeout’ in configuration file). |
| gpsEHPE | Integer | Horizontal error in meters to decide if a GPS fix in GPS geoloc is acceptable (Supported from Asset Tracker 1.7.0, called 'gps_ehpe’ in configuration file). |
| gpsConvergence | Integer | Time in seconds to decide a GPS fix if GPS geoloc has converged for enough time (Supported from Asset Tracker 1.7.0, called 'gps_convergence’ in configuration file). |
| configFlags | ConfigFlags | |
| transmitStrat | String | Different transmission strategies, applied when the device is in motion (Supported from Asset Tracker 1.7.0, called 'transmit_strat’ in configuration file): -'UNKNOWN’: Not supported value. -'SINGLE_FIXED’: always transmit using the predefined datarate (from provisioning). -'SINGLE_RANDOM_DATARATE’: Single transmission, applied to (SF7-12) using Central Limit Theorem. -'DOUBLE_RANDOM_DATARATE’: Double transmission of the same frame using a fast (SF7-8) then a slow datarate (SF9-12), using Central Limit Theorem. -'DOUBLE_FIXED’: first transmission at SF7 or SF8, then at predefined datarate (from provisioning). -'NETWORK_ADR’: Adaptive DataRate, selected by the network. In static, Network ADR is applied. -'CUSTOM_STRATEGY’: Activate the strategy defined with transmitStratCustom parameter. |
| bleBeaconCount | Integer | This parameter is used only for a micro tracker. It represents the maximum number of BLE beacons to report, Range 1..4. |
| bleBeaconTimeout | Integer | This parameter is used only for a micro tracker. Time in seconds for BLE Beacon geoloc timeout (Supported from Asset Tracker 1.7.0, called 'ble_beacon_timeout’ in configuration file) |
| gpsStandbyTimeout | Integer | Time in seconds for the GPS to stay in standby mode after being turned ON. At the timeout, the GPS is turned OFF.When 0, the GPS always stays in standby mode (Supported from Asset Tracker 1.7.0, called 'gps_standby_timeout’ in configuration file). |
| confirmedUlBitmap | Integer | Confirmed uplink bitmap for specific Messages type. For example, to configure confirmed uplinks for message type 0x00 and 0x03: 2^0 + 2^3 = 9. You need to set 9 (Supported from Asset Tracker 1.7.0, called 'confirmed_ul_bitmap’ in configuration file). For more details, please refer firmware reference document. |
| confirmedUlRetry | Integer | The number of retries for each confirmed uplink, when confirmation is not received (Supported from Asset Tracker 1.7.0, called 'confirmed_ul_retry’ in configuration file). |
| motionSensitivity | Integer | It is a specific accelerometer configuration. 0 is the default configuration. 1-100 configures the accelerometer in low sensitivity from 1 to 100%. (Supported from Asset Tracker 1.8.0, called 'motion_sensitivity’ in configuration file). |
| shockDetection | Integer | This parameter provides the configuration of shock detection global vector. It has a range of 0-199, with a step of 20mG (Supported from Asset Tracker 1.8.0, called 'shock_detection’ in configuration file). |
| periodicActivityPeriod | Integer | Time in seconds to report periodic activity. As the activity is reported on 6 windows, this value has to be a multiple of 6. When 0, the reporting is disabled (Supported from Asset Tracker 1.8.0, called 'periodic_activity_period’ in configuration file). |
| motionDuration | Integer | Time in seconds for motion duration, minimum time between a start and an end motion event (Supported from Asset Tracker 1.8.0, called 'motion_duration’ in configuration file). |
| bleRssiFilter | Integer | RSSI value to filter BLE beacons with BLE-GPS geolocation mode (Supported from Asset Tracker 1.8.0, called 'ble_rssi_filter’ in configuration file). |
| temperatureHigh | Float | Configure the high threshold temperature. 255 = disabled (Supported from Asset Tracker 1.9.0, called 'temperature_high’ in configuration file) |
| temperatureLow | Float | Configure the low threshold temperature. 255 = disabled (Supported from Asset Tracker 1.9.0, called 'temperature_low’ in configuration file) |
| temperatureAction | String | Configure the action to be done when entering critical state: (Supported from Asset Tracker 1.9.0, called 'temperature_action’ in configuration file): - 'UNKNOWN’: Not supported value. - 'NO_ACTION’: No action. - 'TEMPERATURE_HIGH’: Geolocation disabled if temperature_high is reached. - 'TEMPERATURE_LOW’: Geolocation disabled if temperature_low is reached. - 'TEMPERATURE_LOW_TEMPERATURE_HIGH’: Geolocation disabled if temperature_low or temperature_high is reached. |
| bleBond | String | BLE Bond status (Supported from Asset Tracker 1.9.0). - 'UNKNOWN’:Unknown state. - 'NOT_BONDED’: The tracker in not bonded. - 'BONDED’:The tracker is bonded. |
| transmitStratCustom | TransmitStratCustom | |
| measuredTemperature | TrackerAsAssetTracker_measuredTemperature | |
| batteryCapacity | Integer | The battery capacity in mAh (Supported from Asset Tracker 2.0). |
| reedSwitchConfiguration | String | The reed switch configuration. (Supported from Asset Tracker 2.0). - 'UNKNOWN’:Unknown configuration. - 'DISABLE_REED_SWITCH’ - 'NORMAL_REED_SWITCH’ - 'BUTTON_REED_SWITCH’ - 'OTHER_REED_SWITCH’ |
| collectionScanType | String | Provide the type of the collection to be done.(Supported from Asset Tracker 2.0). - 'UNKNOWN’:Unknown collection scan type. - 'NO_COLLECTION_SCAN’: No collection scan - 'BLE_BEACONS’:The collection will be done and BLE beacons will be reported. - 'WIFI_BSSID’: The collection will be done and WIFI BSSIDs will be reported. |
| collectionBLEFilterType | String | BLE filter type used for BLE collection only (Supported from Asset Tracker 2.0). - 'UNKNOWN’: Unknown collection BLE filter type. - 'NO_FILTER’: MAC addresses reported in the collection uplink. - 'EDDYSTONE_UID’: Beacons ID reported in the collection uplink - 'EDDYSTONE_URL’: Eddystone URL only. MAC addresses reported in the collection uplink. - 'ALL_EDDYSTONE’: MAC addresses reported in the collection uplink - 'IBEACON_ONLY’: Beacon IDs reported in the collection uplink - 'ALTBEACON_ONLY’: Beacon IDs reported in the collection uplink |
| collectionBLEFilterMain1 | Integer | BLE main filter part 1 used for BLE collection only (Supported from Asset Tracker 2.0). |
| collectionBLEFilterMain2 | Integer | BLE main filter part 2 used for BLE collection only (Supported from Asset Tracker 2.0). |
| collectionBLEFilterSecValue | Integer | Value used for the BLE secondary filter (BLE collection only) (Supported from Asset Tracker 2.0). |
| collectionBLEFilterSecMask | Integer | Mask used for the BLE secondary filter (BLE collection only) (Supported from Asset Tracker 2.0). |
| collectionNbEntry | Integer | Provide the number of entries in the collection (Supported from Asset Tracker 2.0). |
| networkTimeoutCheck | Integer | LoRa network monitoring. A timer using this duration is restarted after each last downlink received. Once elapsed, the tracker includes a link check request in all of this uplink. Once the answer is received, the timer restarts. A null value disables this monitoring. Duration expressed in seconds. (Supported from Asset Tracker 2.0) |
| networkTimeoutReset | Integer | LoRa network monitoring. A timer using this duration is restarted after each last downlink received. Once elapsed, the tracker resets. Duration expressed in seconds.(Supported from Asset Tracker 2.0) |
| gnssConstellation | String | Select the GNSS constellation set to be used for making fixes. Possible values are : - 'UNKNOWN’ - 'GPS_ONLY’ - 'GLONASS_ONLY’ - 'GPS_GLONASS’ - 'GPS_GALILEO’ - 'GPS_GLONASS_GALILEO’ - 'BEIDOU_ONLY’ - 'GPS_BEIDOU’ (Supported from Asset Tracker 2.0) |
| profile | String | The profile of the tracker. Should use the format |
TrackerAsAssetTracker_measuredTemperature
Provides data about the measured temperature for the event message “TEMPERATURE_ALERT”(Supported from Asset Tracker 1.9.0).
| Attribute | Type | Description |
|---|---|---|
| state | String | The state of temperature. Possible values are: -'UNKNOWN’:Not supported value. -'NORMAL’ -'NORMAL’ -'HIGH’ -'LOW’ -'FEATURE_NOT_ACTIVATED’ |
| max | Float | Maximum temperature measured by the device |
| min | Float | Minimum temperature measured by the device |
| highCounter | Integer | From the time a high temperature event is sent, this counter is incremented every 10 minutes (can be used to calculate the over temperature time). |
| lowCounter | Integer | From the time a low temperature event is sent, this counter is incremented every 10 minutes (can be used to calculate the under temperature time). |
TransmitStratCustom
| Attribute | Type | Description |
|---|---|---|
| ADREnabled | Boolean | ADR activation in static (Supported from Asset Tracker 1.9.0) -false: ADR is enabled.Factory default value. -true: ADR is disabled. |
| transmissionType | String | Transmission type (Supported from Asset Tracker 1.9.0) -'SINGLE’: single transmission Factory default value. -'DOUBLE’: double transmission. |
| firstTransmissionDatarateDistribution | String | First transmission data rate distribution (Supported from Asset Tracker 1.9.0). Possible values are: -'UNKNOWN’: Not supported value. -'RANDOM’: Factory default value. -'BELL’ -'RING’ |
| secondTransmissionDatarateDistribution | String | Second transmission data rate distribution (Supported from Asset Tracker 1.9.0). Possible values are: -'UNKNOWN’: Not supported value. -'RANDOM’: Factory default value. -'BELL’ -'RING’ |
| firstTransmissionDatarate | EnableDatarate | |
| secondTransmissionDatarate | EnableDatarate |