Abeeway Trackers and ThingPark Location Documentation

https://docs.thingpark.com/thingpark-location/
Admin
This documentation provides comprehensive information and guidance for configuring and utilizing...
Tokens:170,184
Snippets:1,721
Trust Score:8.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Node-RED Locally

Source: https://docs.thingpark.com/thingpark-location/connecting-your-lorawan-network-server/provisioning-your-trackers-on-third-party-network-servers/using-the-node-red-network-interface-translator/Installation

Use this command in your command prompt to install the Node-RED package globally on your local machine.

```bash
npm install -g --unsafe-perm node-red
```

--------------------------------

### Configuration File Example

Source: https://docs.thingpark.com/thingpark-location/firmware/AT3_v1.3/configuration

Illustrates the structure of a complete AT3 configuration file, including version and parameter settings.

```plaintext
CONFIGURATION
VERSION 1.0.0.1
P0102=900
P0200= 800
P0201 =300
P0205 = 0x125
P020b = {02,85,00,00,00}
END
```

--------------------------------

### Version Format Example

Source: https://docs.thingpark.com/thingpark-location/firmware/configuration

Specifies the format for the configuration version number, which consists of four fields: Major.minor.iteration.user.

```text
VERSION 1.0.0.1
```

--------------------------------

### Example Network Firmware Update Command

Source: https://docs.thingpark.com/thingpark-location/firmware/AT3_v1.3/firmware-update

An example of the `dfu network` command, specifying the server, port, and a signed firmware file path for an AT3 MCT Cellular release.

```bash
dfu network raw.githubusercontent.com 443 /AbeewayUser/hosting/main/at3-mctcell-release_v1.3-192-*.bin.sign
```

--------------------------------

### Example: Set to Motion Tracking Mode

Source: https://docs.thingpark.com/thingpark-location/firmware/AT2_v2.6/downlink-messages/operational-mode-configuration

Example of a downlink message to set the operating mode to 'motion track' with an acknowledge token of 3.

```text
0x020301
```

--------------------------------

### Run Node-RED Locally

Source: https://docs.thingpark.com/thingpark-location/connecting-your-lorawan-network-server/provisioning-your-trackers-on-third-party-network-servers/using-the-node-red-network-interface-translator/Installation

Execute this command in your command prompt to start the Node-RED server on your local machine.

```bash
node-red
```

--------------------------------

### SOS Mode Start Event Payload Example

Source: https://docs.thingpark.com/thingpark-location/integrating-your-application-with-thingpark-location/tpxle-sample-payloads/tpxle-output-event-sos-mode-start

This JSON object represents a typical payload received when a device enters SOS Mode Start. It includes details about the device's profile, confirmed uplink settings, and the source of the message.

```json
{
    "deviceProfile" : {
        "defaultProfile" : "UNKNOWN",
        "dynamicProfile" : "Unknown",
        "unknown" : 0,
        "periodicPositionPeriod" : 3600,
        "confirmedUplink" : {
            "framePending" : false,
            "position" : false,
            "energyStatus" : false,
            "healthStatus" : false,
            "heartbeat" : false,
            "activityStatus" : false,
            "configuration" : false,
            "shockDetection" : false,
            "shutdown" : false,
            "event" : false,
            "scanCollection" : false,
            "extendedPosition" : false,
            "debug" : false,
            "confirmedUlBitmap" : 0,
            "confirmedUlRetry" : 3
        },
        "confirmedUlBitmap" : 0,
        "confirmedUlRetry" : 3
    },
    "messageSource" : "LORA",
    "downlinkUrl" : "https://community.thingpark.io/iot-flow/downlinkMessages/6f7b1b1a-5887-447d-a734-014a4e6926a9"
}
```

--------------------------------

### ThingPark Location Event SOS Mode Start Payload Example

Source: https://docs.thingpark.com/thingpark-location/integrating-your-application-with-thingpark-location/tpxle-sample-payloads/tpxle-output-event-sos-mode-start

This JSON object represents a typical payload for an SOS Mode Start event from a device integrated with ThingPark Location. It contains comprehensive details about the device, event, and its context.

```json
{
  "deviceEUI" : "20635f028100003e",
  "time" : "2022-09-02T07:41:46.596Z",
  "customerId" : "100009247",
  "modelCfg" : "1:TPX_ba3df8fb-bc93-45ee-aa0d-b2f873b9bbc6",
  "dxProfileId" : "community-api",
  "coordinates" : [ 103.92496472, 1.31509533, 0.0 ],
  "age" : 19,
  "validityState" : "PREVIOUS",
  "horizontalAccuracy" : 30,
  "incomingSubscriberId" : "100009247",
  "processedFeed" : {
    "SF" : 10,
    "deviceProfileId" : "ABEEWAY/MICRO",
    "payloadEncoded" : "0a583293a007",
    "sequenceNumber" : 18502,
    "receptionTime" : "2022-09-02T07:41:46.596Z",
    "dynamicMotionState" : "STATIC",
    "temperatureMeasure" : 30.364706,
    "processedPacket" : {
      "SNR" : 8.75,
      "RSSI" : -87.0,
      "baseStationId" : "100008CE",
      "antennaCoordinates" : [ 103.924858, 1.314996 ]
    },
    "port" : 18
  },
  "resolvedTracker" : {
    "firmwareVersion" : "2.3.1",
    "bleFirmwareVersion" : "3.3.3",
    "messageType" : "EVENT",
    "shutdownCause" : "UNKNOWN",
    "trackingMode" : "PERMANENT_TRACKING",
    "gpsScanMode" : "UNKNOWN",
    "sensorMode" : "UNKNOWN",
    "periodicPositionInterval" : 3600,
    "batteryLevel" : 50,
    "batteryStatus" : "OPERATING",
    "sosFlag" : true,
    "activityCount" : -1,
    "trackingUlPeriod" : 30,
    "loralivePeriod" : 600,
    "energyStatusPeriod" : 0,
    "geolocSensorProfile" : "WIFI_ONLY",
    "oneshotGeolocMethod" : "GPS",
    "extAntennaProfile" : "UNKNOWN",
    "motionStartEndNbTx" : -1,
    "gpsTimeout" : -1,
    "xgpsTimeout" : -1,
    "gpsEHPE" : 20,
    "gpsConvergence" : 30,
    "transmitStrat" : "CUSTOM_STRATEGY",
    "bleBeaconCount" : -1,
    "bleBeaconTimeout" : -1,
    "gpsStandbyTimeout" : -1,
    "confirmedUlBitmap" : 0,
    "confirmedUlRetry" : 3,
    "motionSensitivity" : -1,
    "shockDetection" : -1,
    "periodicActivityPeriod" : -1,
    "motionDuration" : -1,
    "bleRssiFilter" : -1,
    "temperatureHigh" : -1.0,
    "temperatureLow" : -1.0,
    "temperatureAction" : "UNKNOWN",
    "bleBond" : "UNKNOWN",
    "transmitStratCustom" : {
      "ADREnabled" : false,
      "transmissionType" : "SINGLE",
      "firstTransmissionDatarateDistribution" : "RANDOM",
      "secondTransmissionDatarateDistribution" : "RANDOM",
      "firstTransmissionDatarate" : {
        "dr0" : false,
        "dr1" : false,
        "dr2" : true,
        "dr3" : false,
        "dr4" : false,
        "dr5" : false,
        "dr6" : false,
        "dr7" : false
      },
      "secondTransmissionDatarate" : {
        "dr0" : false,
        "dr1" : false,
        "dr2" : false,
        "dr3" : false,
        "dr4" : false,
        "dr5" : false,
        "dr6" : false,
        "dr7" : false
      }
    },
    "batteryCapacity" : -1,
    "reedSwitchConfiguration" : "UNKNOWN",
    "collectionScanType" : "UNKNOWN",
    "collectionBLEFilterType" : "UNKNOWN",
    "collectionBLEFilterMain1" : -1,
    "collectionBLEFilterMain2" : -1,
    "collectionBLEFilterSecValue" : -1,
    "collectionBLEFilterSecMask" : -1,
    "collectionNbEntry" : -1,
    "networkTimeoutCheck" : -1,
    "networkTimeoutReset" : -1
  },
  "uplinkPayload" : {
    "messageType" : "EVENT",
    "trackingMode" : "PERMANENT_TRACKING",
    "batteryLevel" : 50,
    "batteryStatus" : "OPERATING",
    "ackToken" : 10,
    "periodicPosition" : false,
    "temperatureMeasure" : 30.4,
    "sosFlag" : 1,
    "appState" : 1,
    "dynamicMotionState" : "STATIC",
    "onDemand" : false,
    "payload" : "0a583293a007",
    "deviceConfiguration" : {
      "mode" : "PERMANENT_TRACKING"
    },
    "eventType" : "SOS_MODE_START"
  },
  "resolvedTrackerParameters" : {
    "mode" : "PERMANENT_TRACKING",
    "firmwareVersion" : "2.3.1",
    "bleFirmwareVersion" : "3.3.3",
    "trackingUlPeriod" : 30,
    "geolocSensorProfile" : "WIFI_ONLY",
    "oneshotGeolocMethod" : "GPS",
    "gpsEhpe" : 20,
    "gpsConvergence" : 30,
    "transmitStrat" : "CUSTOM_STRATEGY",
    "loralivePeriod" : 600,
    "energyStatusPeriod" : 0,
    "periodicPositionInterval" : 3600,
    "transmitStratCustom" : {
      "adrEnabled" : 0,
      "transmissionType" : "SINGLE",
      "firstTransmissionDatarateDistribution" : "RANDOM",
      "secondTransmissionDatarateDistribution" : "RANDOM",
      "firstTransmissionDatarate" : {
        "dr0" : 0,
        "dr1" : 0,
        "dr2" : 1,
        "dr3" : 0,
        "dr4" : 0,
        "dr5" : 0,
        "dr6" : 0,
        "dr7" : 0
      },
      "secondTransmissionDatarate" : {
        "dr0" : 0,
        "dr1" : 0,
        "dr2" : 0,
        "dr3" : 0,
        "dr4" : 0,
        "dr5" : 0,
        "dr6" : 0,
        "dr7" : 0
      }
    }
  }
}
```

--------------------------------

### Initiate FUOTA Update via CLI

Source: https://docs.thingpark.com/thingpark-location/firmware/firmware-update

Use this command to start a firmware update. Replace <server>, <port>, and <file> with your specific details.

```bash
dfu network <server> <port> <file>
```

```bash
dfu network raw.githubusercontent.com 443 /AbeewayUser/hosting/main/at3-mctcell-release_v1.3-192-*.bin.sign
```

--------------------------------

### Display Configuration

Source: https://docs.thingpark.com/thingpark-location/troubleshooting-support/using-cli

Use the 'config show' command to display the current configuration of existing firmware parameters.

```cli
config show
```

--------------------------------

### Gather System and Configuration Information

Source: https://docs.thingpark.com/thingpark-location/use-cases/use-case-gps-positioning

Run these commands to collect essential system, BLE, and configuration details from the tracker. This information is required before sending logs for support.

```bash
system info  
ble info  
config show  
```

--------------------------------

### Position on Demand Message Example

Source: https://docs.thingpark.com/thingpark-location/firmware/AT2_v2.6/downlink-messages/position-on-demand

Example of a Position on Demand message with an acknowledge token of 2. The tracker will respond with a position message.

```text
0x0102
```

--------------------------------

### Display All Available Commands

Source: https://docs.thingpark.com/thingpark-location/troubleshooting-support/using-cli

Use the '?' command to list all available commands in the CLI.

```cli
?
```
Tokens:
Raw