Skip to main content

MT

Mobile Terminated Messages to the Device

Structure​

  • status - If the Message was successfully decoded - true/false
  • error[] - Where false, one or more reason for failure (if known)
    • ERROR_UNKNOWN
    • ERROR_NO_PAYLOAD
    • ERROR_PAYLOAD_TOO_LONG
    • ERROR_ENCRYPTED_NO_KEY
    • ERROR_ENCRYPTED_BAD_KEY
    • ERROR_PAYLOAD_INVALID
    • ERROR_PAYLOAD_INVALID_SIZE
  • messages[] - one or more P6 Message as decoded from the payload
    • mt - Mobile Terminated Message
      • encrypted - If the Message should be encrypted - true/false
      • type
        • MT_MESSAGE_TEXT
        • MT_MESSAGE_CONNECT
        • MT_MESSAGE_RAW
        • MT_MESSAGE_ACKNOWLEDGEMENT
        • MT_MESSAGE_SERIAL_MESSAGE
        • MT_MESSAGE_SET_GEOFENCE_CENTRE
        • MT_MESSAGE_START_WATCHING_ME
        • MT_MESSAGE_STOP_WATCHING_ME
        • MT_MESSAGE_SET_POLYFENCE_ATTRIBUTE
        • MT_MESSAGE_SET_POLYFENCE
        • MT_MESSAGE_FILE_RETRIEVAL_REQUEST
        • MT_MESSAGE_SOFTWARE_UPDATE_REQUEST
        • MT_MESSAGE_GET_PROPERTIES
        • MT_MESSAGE_SET_PROPERTIES
        • MT_MESSAGE_CONFIG_GET
        • MT_MESSAGE_CONFIG_SET
        • MT_MESSAGE_RTU
      • message

Messages​

Set Geofence Centre​

[geofence]

{
  "latlng": {
    "latitude": 51.093221,
    "longitude": -1.804758
  },
  "radius": "GEOFENCE_RADIUS_50"
}

The radius option are:

  • GEOFENCE_RADIUS_25
  • GEOFENCE_RADIUS_50
  • GEOFENCE_RADIUS_100
  • GEOFENCE_RADIUS_250
  • GEOFENCE_RADIUS_1000
  • GEOFENCE_RADIUS_2000
  • GEOFENCE_RADIUS_3000

Set Polyfence​

[polyfence]

{
  "polyfences": [
    {
      "geofenceId": 1,
      "vertices": [
        {
          "latitude": 51.094982,
          "longitude": -1.832206
        },
        {
          "latitude": 51.095375,
          "longitude": -1.842442
        },
        {
          "latitude": 51.100387,
          "longitude": -1.839213
        }
      ]
    },
    {
      "geofenceId": 2,
      "vertices": [
        {
          "latitude": 50.662197,
          "longitude": -1.623907
        },
        {
          "latitude": 53.804631,
          "longitude": 1.874809
        },
        {
          "latitude": 49.21661,
          "longitude": 5.437531
        },
        {
          "latitude": 44.825913,
          "longitude": -0.63214
        }
      ]
    }
  ]
}

Set Polyfence Attribute​

[polyfenceAttributes]

{
  "polyfenceId": 2,
  "behaviour": "POLYFENCE_BEHAVIOUR_ENTRY_EXIT",
  "altitudeFloor": 0,
  "altitudeCeiling": 4000,
  "start": {
    "year": 2023,
    "month": 10,
    "day": 9,
    "hour": 15,
    "minute": 10,
    "second": 18
  },
  "stop": {
    "year": 2025,
    "month": 10,
    "day": 9,
    "hour": 15,
    "minute": 10,
    "second": 18
  },
  "slowSpeed": 0.5,
  "normalIridium" : {
    "trackingFrequency": "TRACKING_FREQUENCY_MINUTES_5",
    "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
    "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
  },
  "normalCellular" : {
    "trackingFrequency": "TRACKING_FREQUENCY_NOT_SPECIFIED",
    "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
    "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
  },
  "slowIridium" : {
    "trackingFrequency": "TRACKING_FREQUENCY_MINUTES_60",
    "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
    "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
  },
  "slowCellular" : {
    "trackingFrequency": "TRACKING_FREQUENCY_NOT_SPECIFIED",
    "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
    "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
  }
}

The polyfence behaviour attribute options are:

  • POLYFENCE_BEHAVIOUR_ENTRY_EXIT
  • POLYFENCE_BEHAVIOUR_ENTRY
  • POLYFENCE_BEHAVIOUR_EXIT
  • POLYFENCE_BEHAVIOUR_ENTRY_THEN_DISABLE
  • POLYFENCE_BEHAVIOUR_ENTRY_EXIT_OTHER

Polyfence attributes normalIridium, normalCellular, slowIridium, slowCellular contain the same options.

{
  "trackingFrequency": "TRACKING_FREQUENCY_MINUTES_5=",
  "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
  "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
}

Tracking frequency options are:

  • TRACKING_FREQUENCY_NOT_SPECIFIED
  • TRACKING_FREQUENCY_CONTINUOUS
  • TRACKING_FREQUENCY_MINUTES_5
  • TRACKING_FREQUENCY_MINUTES_10
  • TRACKING_FREQUENCY_MINUTES_15
  • TRACKING_FREQUENCY_MINUTES_20
  • TRACKING_FREQUENCY_MINUTES_30
  • TRACKING_FREQUENCY_MINUTES_60
  • TRACKING_FREQUENCY_MINUTES_90
  • TRACKING_FREQUENCY_MINUTES_120
  • TRACKING_FREQUENCY_MINUTES_180
  • TRACKING_FREQUENCY_MINUTES_240
  • TRACKING_FREQUENCY_MINUTES_360
  • TRACKING_FREQUENCY_MINUTES_480
  • TRACKING_FREQUENCY_MINUTES_720
  • TRACKING_FREQUENCY_BURST
  • TRACKING_FREQUENCY_MINUTES_1
  • TRACKING_FREQUENCY_MINUTES_2
  • TRACKING_FREQUENCY_MINUTES_3
  • TRACKING_FREQUENCY_MINUTES_4
  • TRACKING_FREQUENCY_MINUTES_1440
  • TRACKING_FREQUENCY_MINUTES_6
  • TRACKING_FREQUENCY_MINUTES_8
  • TRACKING_FREQUENCY_MINUTES_12
  • TRACKING_FREQUENCY_SECONDS_15
  • TRACKING_FREQUENCY_SECONDS_30

Burst frequency options are:

  • BURST_FREQUENCY_NOT_ACTIVE
  • BURST_FREQUENCY_MINUTES_1
  • BURST_FREQUENCY_MINUTES_2
  • BURST_FREQUENCY_MINUTES_5
  • BURST_FREQUENCY_MINUTES_10
  • BURST_FREQUENCY_MINUTES_15
  • BURST_FREQUENCY_MINUTES_30
  • BURST_FREQUENCY_MINUTES_60

Burst fix frequency options are:

  • BURST_FIX_FREQUENCY_NOT_ACTIVE
  • BURST_FIX_FREQUENCY_SECONDS_5
  • BURST_FIX_FREQUENCY_SECONDS_10
  • BURST_FIX_FREQUENCY_SECONDS_15
  • BURST_FIX_FREQUENCY_SECONDS_20
  • BURST_FIX_FREQUENCY_SECONDS_30
  • BURST_FIX_FREQUENCY_MINUTES_1
  • BURST_FIX_FREQUENCY_MINUTES_2
  • BURST_FIX_FREQUENCY_MINUTES_5
  • BURST_FIX_FREQUENCY_MINUTES_10
  • BURST_FIX_FREQUENCY_MINUTES_15
  • BURST_FIX_FREQUENCY_MINUTES_20

Connect Message​

[connect]

{
  "deviceId": "MzQ1MzI0NTUzOTg0MzU=",
  "appId": "NjM0c2g3NWcyNA==",
  "message": "Y29ubmVjdGVkLi4u"
}

Watch Confirmation​

[watchConfirmation]

{
  "watching": true
}

Text Message​

[textMessage]

{
  "acknowledge": true,
  "rawMessage": true,
  "encoding": "ENCODING_WESTERN_1252",
  "messageId": 46765473,
  "message": "Example MT text Message"
}

Encoding options are:

  • ENCODING_WESTERN_1252
  • ENCODING_CYRILLIC_1251

Server Acknowledgement​

[serverAcknowledgement]

{
  "momsn": 43557636
}

Get Config​

getConfig

{
  "blocks": [
    "CONFIG_BLOCK_TRACKING",
    "CONFIG_BLOCK_MAILBOX",
    "CONFIG_BLOCK_SYSTEM",
    "CONFIG_BLOCK_GPS"
  ]
}

Blocks options are:

  • CONFIG_BLOCK_DEBUG
  • CONFIG_BLOCK_TRACKING
  • CONFIG_BLOCK_MAILBOX
  • CONFIG_BLOCK_USER_MODE
  • CONFIG_BLOCK_ALERT
  • CONFIG_BLOCK_BLUETOOTH
  • CONFIG_BLOCK_SYSTEM
  • CONFIG_BLOCK_GPS
  • CONFIG_BLOCK_SCREEN
  • CONFIG_BLOCK_GPS_LOGGING
  • CONFIG_BLOCK_USER_CUSTOMISATION
  • CONFIG_BLOCK_FACTORY_SETTINGS
  • CONFIG_BLOCK_EXTERNAL_SETTINGS
  • CONFIG_BLOCK_AIRBORNE

Set Config​

[setConfig]

{
  "config": {
    "tracking": {
      "requestPosition": true,
      "activitySenseMode": "ACTIVITY_SENSE_MODE_AWAY_FROM_HOME",
      "trackingStatus": "TRACKING_NOT_SPECIFIED",
      "activitySenseThreshold": "ACTIVITY_SENSE_THRESHOLD_NOT_SPECIFIED",
      "signalLossChecking": "SIGNAL_LOSS_NOT_SPECIFIED",
      "positionBlockFormat": "POSITION_BLOCK_FORMAT_NOT_SPECIFIED"
    },
    "mailbox": {
      "checkFrequency": "MAILBOX_CHECK_MINUTES_5",
      "checkStatus": "MAILBOX_CHECKING_NOT_SPECIFIED"
    }
  }
}

The set config message is large and has multiple blocks as described below. The JSON above is an example with 2 blocks.

[tracking]​

{
  "requestPosition": true,
  "activitySenseMode": "ACTIVITY_SENSE_MODE_POWER",
  "trackingStatus": "TRACKING_ON",
  "activitySenseThreshold": "ACTIVITY_SENSE_THRESHOLD_20",
  "signalLossChecking": "SIGNAL_LOSS_OFF",
  "positionBlockFormat": "POSITION_BLOCK_FORMAT_STANDARD",
  "iridiumContext": {
    "trackingFrequency": "TRACKING_FREQUENCY_MINUTES_5",
    "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
    "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
  },
  "cellularContext": {
    "trackingFrequency": "TRACKING_FREQUENCY_MINUTES_5",
    "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
    "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
  },
  "distressContext": {
    "trackingFrequency": "TRACKING_FREQUENCY_MINUTES_5",
    "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
    "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
  }
}

Activity sense modes:

  • ACTIVITY_SENSE_MODE_NOT_SPECIFIED
  • ACTIVITY_SENSE_MODE_OFF
  • ACTIVITY_SENSE_MODE_POWER
  • ACTIVITY_SENSE_MODE_BUMP
  • ACTIVITY_SENSE_MODE_SOG
  • ACTIVITY_SENSE_MODE_BUMP_AND_SOG
  • ACTIVITY_SENSE_MODE_AWAY_FROM_HOME

Tracking statuses:

  • TRACKING_NOT_SPECIFIED
  • TRACKING_OFF
  • TRACKING_ON

Activity sense threshold options are:

  • ACTIVITY_SENSE_THRESHOLD_NOT_SPECIFIED
  • ACTIVITY_SENSE_THRESHOLD_X where X is from 0 to 62. e.g. ACTIVITY_SENSE_THRESHOLD_55

Signal loss checking options are:

  • SIGNAL_LOSS_NOT_SPECIFIED
  • SIGNAL_LOSS_OFF
  • SIGNAL_LOSS_ON

Position block format options are:

  • POSITION_BLOCK_FORMAT_NOT_SPECIFIED
  • POSITION_BLOCK_FORMAT_STANDARD
  • POSITION_BLOCK_FORMAT_COMPACT
  • POSITION_BLOCK_FORMAT_PSTAR
  • POSITION_BLOCK_FORMAT_AES

Context Options: iridiumContext, cellularContext, and distressContext are made of the same format:

{
  "trackingFrequency": "TRACKING_FREQUENCY_MINUTES_5",
  "burstFrequency": "BURST_FREQUENCY_NOT_ACTIVE",
  "burstFixFrequency": "BURST_FIX_FREQUENCY_NOT_ACTIVE"
}

Tracking frequency options are:

  • TRACKING_FREQUENCY_NOT_SPECIFIED
  • TRACKING_FREQUENCY_CONTINUOUS
  • TRACKING_FREQUENCY_MINUTES_5
  • TRACKING_FREQUENCY_MINUTES_10
  • TRACKING_FREQUENCY_MINUTES_15
  • TRACKING_FREQUENCY_MINUTES_20
  • TRACKING_FREQUENCY_MINUTES_30
  • TRACKING_FREQUENCY_MINUTES_60
  • TRACKING_FREQUENCY_MINUTES_90
  • TRACKING_FREQUENCY_MINUTES_120
  • TRACKING_FREQUENCY_MINUTES_180
  • TRACKING_FREQUENCY_MINUTES_240
  • TRACKING_FREQUENCY_MINUTES_360
  • TRACKING_FREQUENCY_MINUTES_480
  • TRACKING_FREQUENCY_MINUTES_720
  • TRACKING_FREQUENCY_BURST
  • TRACKING_FREQUENCY_MINUTES_1
  • TRACKING_FREQUENCY_MINUTES_2
  • TRACKING_FREQUENCY_MINUTES_3
  • TRACKING_FREQUENCY_MINUTES_4
  • TRACKING_FREQUENCY_MINUTES_1440
  • TRACKING_FREQUENCY_MINUTES_6
  • TRACKING_FREQUENCY_MINUTES_8
  • TRACKING_FREQUENCY_MINUTES_12
  • TRACKING_FREQUENCY_SECONDS_15
  • TRACKING_FREQUENCY_SECONDS_30

Burst frequency options are:

  • BURST_FREQUENCY_NOT_ACTIVE
  • BURST_FREQUENCY_MINUTES_1
  • BURST_FREQUENCY_MINUTES_2
  • BURST_FREQUENCY_MINUTES_5
  • BURST_FREQUENCY_MINUTES_10
  • BURST_FREQUENCY_MINUTES_15
  • BURST_FREQUENCY_MINUTES_30
  • BURST_FREQUENCY_MINUTES_60

Burst fix frequency options are:

  • BURST_FIX_FREQUENCY_NOT_ACTIVE
  • BURST_FIX_FREQUENCY_SECONDS_5
  • BURST_FIX_FREQUENCY_SECONDS_10
  • BURST_FIX_FREQUENCY_SECONDS_15
  • BURST_FIX_FREQUENCY_SECONDS_20
  • BURST_FIX_FREQUENCY_SECONDS_30
  • BURST_FIX_FREQUENCY_MINUTES_1
  • BURST_FIX_FREQUENCY_MINUTES_2
  • BURST_FIX_FREQUENCY_MINUTES_5
  • BURST_FIX_FREQUENCY_MINUTES_10
  • BURST_FIX_FREQUENCY_MINUTES_15
  • BURST_FIX_FREQUENCY_MINUTES_20

[mailbox]​

{
  "checkFrequency": "MAILBOX_CHECK_MINUTES_5",
  "checkStatus": "MAILBOX_CHECKING_NOT_SPECIFIED",
  "gprsStrategy": "GPRS_STRATEGY_NEVER",
  "externalPowerMode": "EXTERN_POWER_MODE_LIMITED"
}
warning

GPRS Strategy and External Power Mode should only be included in this block for firmware versions 3.8.7 (RockFLEET, RockBLOCK RTU) or 3.13.2 (RockSTAR) or later. For earlier firmware versions, these options can be found in the system config.*

Check frequency options are:

  • MAILBOX_CHECK_NOT_SPECIFIED
  • MAILBOX_CHECK_MINUTES_5
  • MAILBOX_CHECK_MINUTES_10
  • MAILBOX_CHECK_MINUTES_15
  • MAILBOX_CHECK_MINUTES_20
  • MAILBOX_CHECK_MINUTES_30
  • MAILBOX_CHECK_MINUTES_60
  • MAILBOX_CHECK_MINUTES_90
  • MAILBOX_CHECK_MINUTES_120
  • MAILBOX_CHECK_MINUTES_180
  • MAILBOX_CHECK_MINUTES_240
  • MAILBOX_CHECK_MINUTES_360
  • MAILBOX_CHECK_MINUTES_480
  • MAILBOX_CHECK_MINUTES_720

Check status option are:

  • MAILBOX_CHECKING_NOT_SPECIFIED
  • MAILBOX_CHECKING_OFF
  • MAILBOX_CHECKING_ON

GPRS strategy options:

  • GPRS_STRATEGY_NOT_SPECIFIED
  • GPRS_STRATEGY_NEVER
  • GPRS_STRATEGY_ALWAYS
  • GPRS_STRATEGY_PREFERRED

External power options:

  • EXTERN_POWER_MODE_NOT_SPECIFIED
  • EXTERN_POWER_MODE_UNLIMITED
  • EXTERN_POWER_MODE_LIMITED
  • EXTERN_POWER_MODE_UNLIMITED_ACTIVATE

[alertSettings]​

{
  "timerAlertStatus": "TIMER_ALERT_OFF",
  "deadMansSwitchStatus": "DEADMANS_SWITCH_ON",
  "timerAlertTimeout": "TIMER_ALERT_TIMEOUT_MINUTES_5",
  "deadManFrequency": "DEAD_MAN_FREQUENCY_MINUTES_5",
  "temperatureAlertStatus": "TEMPERATURE_ALERT_NOT_SPECIFIED",
  "coldTemperature": "TEMPERATURE_NEGATIVE_40",
  "tempCheckFrequency": "TEMP_CHECK_FREQUENCY_MINUTES_3",
  "hotTemperature": "TEMPERATURE_POSITIVE_50",
  "geofenceCheckFrequency": "GEOFENCE_CHECK_FREQUENCY_MINUTES_1",
  "geofenceAlertMode": "GEOFENCE_ALERT_MODE_GEO_ON",
  "geofenceSetCentre": true,
  "powerAlertStatus": "POWER_ALERT_ON",
  "geofenceRadius": "GEOFENCE_RADIUS_250",
  "collisionAlertStatus": "COLLISION_ALERT_ON",
  "collisionDuration": "COLLISION_DURATION_5",
  "collisionThreshold": "COLLISION_THRESHOLD_8"
}

Timer alert statuses:

  • TIMER_ALERT_NOT_SPECIFIED
  • TIMER_ALERT_OFF
  • TIMER_ALERT_ON

Dead man switch statuses:

  • DEADMANS_SWITCH_NOT_SPECIFIED
  • DEADMANS_SWITCH_OFF
  • DEADMANS_SWITCH_ON

Timer alert timeout options:

  • TIMER_ALERT_TIMEOUT_NOT_SPECIFIED
  • TIMER_ALERT_TIMEOUT_MINUTES_5
  • TIMER_ALERT_TIMEOUT_MINUTES_10
  • TIMER_ALERT_TIMEOUT_MINUTES_15
  • TIMER_ALERT_TIMEOUT_MINUTES_30
  • TIMER_ALERT_TIMEOUT_HOURS_1
  • TIMER_ALERT_TIMEOUT_HOURS_2
  • TIMER_ALERT_TIMEOUT_HOURS_4

Dead man frequency options:

  • DEAD_MAN_FREQUENCY_NOT_SPECIFIED
  • DEAD_MAN_FREQUENCY_MINUTES_5
  • DEAD_MAN_FREQUENCY_MINUTES_10
  • DEAD_MAN_FREQUENCY_MINUTES_15
  • DEAD_MAN_FREQUENCY_MINUTES_30
  • DEAD_MAN_FREQUENCY_HOURS_1
  • DEAD_MAN_FREQUENCY_HOURS_2
  • DEAD_MAN_FREQUENCY_HOURS_4

Temperature alert statuses:

  • TEMPERATURE_ALERT_NOT_SPECIFIED
  • TEMPERATURE_ALERT_OFF
  • TEMPERATURE_ALERT_ON

Temperature check frequency options:

  • TEMP_CHECK_FREQUENCY_NOT_SPECIFIED
  • TEMP_CHECK_FREQUENCY_MINUTES_1
  • TEMP_CHECK_FREQUENCY_MINUTES_2
  • TEMP_CHECK_FREQUENCY_MINUTES_3
  • TEMP_CHECK_FREQUENCY_MINUTES_5
  • TEMP_CHECK_FREQUENCY_MINUTES_10
  • TEMP_CHECK_FREQUENCY_MINUTES_15
  • TEMP_CHECK_FREQUENCY_MINUTES_30

Cold and Hot temperature options:

  • TEMPERATURE_NOT_SPECIFIED
  • TEMPERATURE_NEGATIVE_40
  • TEMPERATURE_NEGATIVE_35
  • TEMPERATURE_NEGATIVE_30
  • TEMPERATURE_NEGATIVE_25
  • TEMPERATURE_NEGATIVE_20
  • TEMPERATURE_NEGATIVE_15
  • TEMPERATURE_NEGATIVE_10
  • TEMPERATURE_NEGATIVE_5
  • TEMPERATURE_0
  • TEMPERATURE_POSITIVE_5
  • TEMPERATURE_POSITIVE_10
  • TEMPERATURE_POSITIVE_15
  • TEMPERATURE_POSITIVE_20
  • TEMPERATURE_POSITIVE_25
  • TEMPERATURE_POSITIVE_30
  • TEMPERATURE_POSITIVE_35
  • TEMPERATURE_POSITIVE_40
  • TEMPERATURE_POSITIVE_45
  • TEMPERATURE_POSITIVE_50

Geofence check frequency options:

  • GEOFENCE_CHECK_FREQUENCY_NOT_SPECIFIED
  • GEOFENCE_CHECK_FREQUENCY_MINUTES_1
  • GEOFENCE_CHECK_FREQUENCY_MINUTES_2
  • GEOFENCE_CHECK_FREQUENCY_MINUTES_3
  • GEOFENCE_CHECK_FREQUENCY_MINUTES_5
  • GEOFENCE_CHECK_FREQUENCY_MINUTES_10
  • GEOFENCE_CHECK_FREQUENCY_MINUTES_15
  • GEOFENCE_CHECK_FREQUENCY_MINUTES_30

Geofence alert modes:

  • GEOFENCE_ALERT_MODE_NOT_SPECIFIED
  • GEOFENCE_ALERT_MODE_OFF
  • GEOFENCE_ALERT_MODE_GEO_ON
  • GEOFENCE_ALERT_MODE_POLY_ON

Power alert status:

  • POWER_ALERT_NOT_SPECIFIED
  • POWER_ALERT_OFF
  • POWER_ALERT_ON

Geofence radius:

  • GEOFENCE_RADIUS_NOT_SPECIFIED
  • GEOFENCE_RADIUS_25
  • GEOFENCE_RADIUS_50
  • GEOFENCE_RADIUS_100
  • GEOFENCE_RADIUS_250
  • GEOFENCE_RADIUS_1000
  • GEOFENCE_RADIUS_2000
  • GEOFENCE_RADIUS_3000

Collision alert statuses:

  • COLLISION_ALERT_NOT_SPECIFIED
  • COLLISION_ALERT_OFF
  • COLLISION_ALERT_ON

Collision duration:

  • COLLISION_DURATION_NOT_SPECIFIED
  • COLLISION_DURATION_1
  • COLLISION_DURATION_2
  • COLLISION_DURATION_5
  • COLLISION_DURATION_10
  • COLLISION_DURATION_20

Collision threshold:

  • COLLISION_THRESHOLD_NOT_SPECIFIED
  • COLLISION_THRESHOLD_1
  • COLLISION_THRESHOLD_2
  • COLLISION_THRESHOLD_4
  • COLLISION_THRESHOLD_8
  • COLLISION_THRESHOLD_12
  • COLLISION_THRESHOLD_16

[bluetooth]​

{
  "status": "BLUETOOTH_STATUS_OFF",
  "beaconId": 123,
  "scannerSensitivity": "SCANNER_SENSITIVITY_LEVEL_0",
  "bleRaw": "BLE_RAW_ON"
}

Bluetooth status options:

  • BLUETOOTH_STATUS_NOT_SPECIFIED
  • BLUETOOTH_STATUS_OFF
  • BLUETOOTH_STATUS_ON
  • BLUETOOTH_STATUS_ON_ADVERTISE_MODE
  • BLUETOOTH_STATUS_ON_SCANNER_MODE
  • BLUETOOTH_STATUS_ON_HEART_RATE_MODE

Scanner sensitivity options:

  • SCANNER_SENSITIVITY_NOT_SPECIFIED
  • SCANNER_SENSITIVITY_LEVEL_0
  • SCANNER_SENSITIVITY_LEVEL_1
  • SCANNER_SENSITIVITY_LEVEL_2
  • SCANNER_SENSITIVITY_LEVEL_3
  • SCANNER_SENSITIVITY_LEVEL_4
  • SCANNER_SENSITIVITY_LEVEL_5
  • SCANNER_SENSITIVITY_LEVEL_6

BLE raw options:

  • BLE_RAW_NOT_SPECIFIED
  • BLE_RAW_OFF
  • BLE_RAW_ON

[system]​

{
  "factoryReset": true,
  "loggingMode": "LOGGING_MODE_EXTERNAL_PORT",
  "deleteLogFile": true,
  "clearMsgStore": true,
  "clearPolyfence": true,
  "deactivate": true,
  "gprsStrategy": "GPRS_STRATEGY_NEVER",
  "externalPowerMode": "EXTERN_POWER_MODE_LIMITED"
}
warning

GPRS Strategy and External Power Mode should only be included in this block for firmware versions earlier than 3.8.7 (RockFLEET, RockBLOCK RTU) or 3.13.2 (RockSTAR). For more recent firmware versions, these options can be found in the mailbox config.

Logging mode options:

  • LOGGING_MODE_NOT_SPECIFIED
  • LOGGING_MODE_OFF
  • LOGGING_MODE_SD_CARD
  • LOGGING_MODE_EXTERNAL_PORT
  • LOGGING_MODE_BLUETOOTH

GPRS strategy options:

  • GPRS_STRATEGY_NOT_SPECIFIED
  • GPRS_STRATEGY_NEVER
  • GPRS_STRATEGY_ALWAYS
  • GPRS_STRATEGY_PREFERRED

External power options:

  • EXTERN_POWER_MODE_NOT_SPECIFIED
  • EXTERN_POWER_MODE_UNLIMITED
  • EXTERN_POWER_MODE_LIMITED
  • EXTERN_POWER_MODE_UNLIMITED_ACTIVATE

[gps]​

{
  "gpsMode": "GPS_MODE_3D",
  "gpsHotStatus": "GPS_HOT_ON",
  "earlyWakeup": "EARLY_WAKEUP_SECONDS_60",
  "fixesRequired": "FIXES_REQUIRED_1",
  "batterySelect": "BATTERY_MODEL_A"
}

GPS modes:

  • GPS_MODE_NOT_SPECIFIED
  • GPS_MODE_2D
  • GPS_MODE_3D

GPS hot statuses:

  • GPS_HOT_NOT_SPECIFIED
  • GPS_HOT_ON
  • GPS_HOT_OFF

P6 Early Wakeup options:

  • EARLY_WAKEUP_NOT_SPECIFIED
  • EARLY_WAKEUP_SECONDS_20
  • EARLY_WAKEUP_SECONDS_40
  • EARLY_WAKEUP_SECONDS_60
  • EARLY_WAKEUP_MINUTES_2
  • EARLY_WAKEUP_MINUTES_3
  • EARLY_WAKEUP_MINUTES_4

Fixes required options:

  • FIXES_REQUIRED_NOT_SPECIFIED
  • FIXES_REQUIRED_1
  • FIXES_REQUIRED_5
  • FIXES_REQUIRED_10
  • FIXES_REQUIRED_20

Battery Select options:

  • BATTERY_NOT_SPECIFIED
  • BATTERY_MODEL_A
  • BATTERY_MODEL_B

[screenLock]​

{
  "screenLockStatus": "SCREEN_LOCK_ON",
  "stealthModeStatus": "STEALTH_MODE_ON",
  "pin": 123
}

Screen lock status options:

  • SCREEN_LOCK_NOT_SPECIFIED
  • SCREEN_LOCK_OFF
  • SCREEN_LOCK_ON

Stealth mode options:

  • STEALTH_MODE_NOT_SPECIFIED
  • STEALTH_MODE_OFF
  • STEALTH_MODE_ON

[gpsLogging]​

{
  "gpsLoggingStatus": "GPS_LOGGING_ON",
  "clearFile": true,
  "newSegment": false,
  "gpsLogPeriod": "GPS_LOG_PERIOD_SECONDS_10",
  "gpsDynamicMode": 123
}

GPS logging options:

  • GPS_LOGGING_NOT_SPECIFIED
  • GPS_LOGGING_OFF
  • GPS_LOGGING_ON

GPS log period options:

  • GPS_LOG_PERIOD_NOT_SPECIFIED
  • GPS_LOG_PERIOD_SECONDS_1
  • GPS_LOG_PERIOD_SECONDS_5
  • GPS_LOG_PERIOD_SECONDS_10
  • GPS_LOG_PERIOD_SECONDS_30
  • GPS_LOG_PERIOD_MINUTES_1
  • GPS_LOG_PERIOD_MINUTES_5
  • GPS_LOG_PERIOD_MINUTES_10
  • GPS_LOG_PERIOD_MINUTES_15
  • GPS_LOG_PERIOD_MINUTES_20
  • GPS_LOG_PERIOD_MINUTES_30
  • GPS_LOG_PERIOD_MINUTES_60

GPS dynamic mode options:

  • GPS_DYNAMIC_NOT_SPECIFIED
  • GPS_DYNAMIC_MODE_PORTABLE
  • GPS_DYNAMIC_MODE_AUTOMOTIVE
  • GPS_DYNAMIC_MODE_MARINE
  • GPS_DYNAMIC_MODE_AIR

[externalData]​

{
  "mobWatcher": "MOB_WATCHER_OFF",
  "baudRate": "BAUD_RATE_9600",
  "sampleRate": "SAMPLE_RATE_SECONDS_10",
  "inputSensitivity": "INPUT_SENSITIVITY_FAST",
  "sourceType": "EXTERNAL_SOURCE_MAXIMET_200"
}

Mob watcher options:

  • MOB_WATCHER_NOT_SPECIFIED
  • MOB_WATCHER_OFF
  • MOB_WATCHER_ON

Baud rates:

  • BAUD_RATE_NOT_SPECIFIED
  • BAUD_RATE_4800
  • BAUD_RATE_9600
  • BAUD_RATE_19200
  • BAUD_RATE_38400
  • BAUD_RATE_57600
  • BAUD_RATE_115200

Sample rates:

  • SAMPLE_RATE_NOT_SPECIFIED
  • SAMPLE_RATE_SECONDS_5
  • SAMPLE_RATE_SECONDS_10
  • SAMPLE_RATE_SECONDS_20
  • SAMPLE_RATE_SECONDS_40
  • SAMPLE_RATE_SECONDS_60

Input sensitivity options:

  • INPUT_SENSITIVITY_NOT_SPECIFIED
  • INPUT_SENSITIVITY_FAST
  • INPUT_SENSITIVITY_FAST012
  • INPUT_SENSITIVITY_FAST01
  • INPUT_SENSITIVITY_FAST0
  • INPUT_SENSITIVITY_SLOW

Source types:

  • EXTERNAL_SOURCE_NOT_SPECIFIED
  • EXTERNAL_SOURCE_OFF
  • EXTERNAL_SOURCE_NMEA
  • EXTERNAL_SOURCE_HYDROSPHERE
  • EXTERNAL_SOURCE_SERIAL_API
  • EXTERNAL_SOURCE_MAXIMET_800
  • EXTERNAL_SOURCE_MAXIMET_200
  • EXTERNAL_SOURCE_WAVES
  • EXTERNAL_SOURCE_VOLVO_WTP3_FASTOUT
  • EXTERNAL_SOURCE_DALIA_FPSO

[airborne]​

{
  "flightAlertStatus": "ALERT_STATUS_HOVER",
  "autoResumeStatus": "RESUME_STATUS_OFF",
  "autoResumeRadius": "RESUME_RADIUS_2KM",
  "ascentDescentAlertMode": "ALERT_MODE_DESCENT",
  "descentAlertTime": "QW4gZXhhbXBs",
  "descentSpeed": "QW4gZXhhbXBs",
  "ascentAlertTime": "QW4gZXhhbXBs",
  "ascentSpeed": "QW4gZXhhbXBs",
  "flightVr": 321,
  "flightVs": 123
}

Flight alert statuses:

  • ALERT_STATUS_NOT_SPECIFIED
  • ALERT_STATUS_OFF
  • ALERT_STATUS_HOVER
  • ALERT_STATUS_FIXED_WING

Auto resume statuses:

  • RESUME_STATUS_NOT_SPECIFIED
  • RESUME_STATUS_OFF
  • RESUME_STATUS_ON

Auto resume radius options:

  • RESUME_RADIUS_NOT_SPECIFIED
  • RESUME_RADIUS_2KM
  • RESUME_RADIUS_3KM
  • RESUME_RADIUS_5KM
  • RESUME_RADIUS_10KM

Ascent descent alert modes:

  • ALERT_MODE_NOT_SPECIFIED
  • ALERT_MODE_OFF
  • ALERT_MODE_DESCENT
  • ALERT_MODE_ASCENT
  • ALERT_MODE_BOTH

Ascent and Descent alert times:

  • ALERT_TIME_NOT_SPECIFIED
  • ALERT_TIME_SECONDS_5
  • ALERT_TIME_SECONDS_10
  • ALERT_TIME_SECONDS_15
  • ALERT_TIME_SECONDS_20
  • ALERT_TIME_SECONDS_25
  • ALERT_TIME_SECONDS_30

Ascent and Descent alert speeds:

  • ALERT_SPEED_NOT_SPECIFIED
  • ALERT_SPEED_1000
  • ALERT_SPEED_1500
  • ALERT_SPEED_2000
  • ALERT_SPEED_2500
  • ALERT_SPEED_3000

Get Properties​

[getProperties]

{
  "propertyTypes": [
    "PROPERTY_APN",
    "PROPERTY_ENDPOINT_ADDRESS_1",
    "PROPERTY_ENDPOINT_ADDRESS_2",
    "PROPERTY_ENDPOINT_ADDRESS_3",
    "PROPERTY_ENDPOINT_PORT_1",
    "PROPERTY_ENDPOINT_PORT_2",
    "PROPERTY_ENDPOINT_PORT_3",
    "PROPERTY_USERNAME",
    "PROPERTY_PASSWORD",
    "PROPERTY_MOBILE_NETWORK_OPERATOR",
    "PROPERTY_RADIO_ACCESS_TECHNOLOGY_PRIORITY"
  ]
}

Set Properties​

[setProperties]

{
  "properties": [
    {
      "type": "PROPERTY_USERNAME",
      "value": "joe.blogs"
    },
    {
      "type": "PROPERTY_RADIO_ACCESS_TECHNOLOGY_PRIORITY",
      "value": "3"
    }
  ]
}

Property type must be from the same list as getProperties above.

Request File​

[getFile]

{
  "date": {
    "year": 2023,
    "month": 1,
    "day": 25
  },
  "type": "FILE_TYPE_LOG",
  "range": 35
}

Types for files:

  • FILE_TYPE_LOG
  • FILE_TYPE_GPX

Send Serial Message​

[serialMessage]

{
  "position": {
    "standard": {
      "at": {
        "year": 2023,
        "month": 10,
        "day": 9,
        "hour": 15,
        "minute": 10,
        "second": 17
      },
      "timeDelta": 60,
      "dayOfYear": 282,
      "latlng": {
        "latitude": 51.093221,
        "longitude": -1.804758
      },
      "altitude": 153256,
      "course": 98,
      "speed": 12.69,
      "navigationMode": "NAVIGATION_MODE_3D",
      "battery": 99,
      "pdop": 0.0,
      "temperature": 31
    }
  },
  "message": "QVQrR0hESCBLS1Uy"
}

Navigation Modes:

  • NAVIGATION_MODE_2D
  • NAVIGATION_MODE_3D
  • NAVIGATION_MODE_GLONASS

Send Raw Message​

[rawMessage]

{
  "message": "RXhhbXBsZSByYXcgbWVzc2FnZQ=="
}

Request Software Upgrade/Downgrade​

[softwareUpdate]

{
  "mode": "DOWNGRADE"
}

Modes available:

  • UPGRADE
  • DOWNGRADE

RTU​

RTU was previously referred to as SenseSwitch. Message structures remain the same but legacy labels will need to be updated.

[rtu]

Contains one of:

  • setChannelSetting - A report on the current settings for a channel
  • requestChannelParameters - Request the settings of a channel
  • triggerOutputChange - Trigger a change in output for an output channel
  • requestCurrentChannelOutputSettings - Request the current output state of an output channel

Set Channel Settings​

{
  "channelNumber": 0,
  "channelMode": "CHANNEL_MODE_ANALOGUE_INPUT_0_TO_10_V",
  "upperTrip": 9.1,
  "hysteresis": 0.5,
  "lowerTrip": 1.2,
  "timeSensitivity": "TIME_SENSITIVITY_INSTANT",
  "covSensitivity": 10,
  "samplingPeriod": "SAMPLING_PERIOD_10_SECONDS",
  "groupTransmissionSize": 20,
  "unit": "UNIT_VOLTS"
}

Request Channel Parameters​

{
  "channelNumber": 0
}

Trigger Output Change​

To turn on.

{
  "channelNumber": 2,
  "channelMode": "CHANNEL_MODE_DIGITAL_OUTPUT",
  "unit": "UNIT_DIGITAL",
  "timePeriod": 0,
  "oneShot": 1,
  "mark": 100.0,
  "value": 1
}

To turn off.

{
  "channelNumber": 2,
  "channelMode": "CHANNEL_MODE_DIGITAL_OUTPUT",
  "unit": "UNIT_DIGITAL",
  "timePeriod": 0,
  "oneShot": 1,
  "mark": 0.0,
  "value": 0
}

Request Channel Output Settings​

{
  "channelNumber": 3
}

Channel Mode options:

  • CHANNEL_MODE_DIGITAL_INPUT_ALERT_DISABLED
  • CHANNEL_MODE_DIGITAL_OUTPUT
  • CHANNEL_MODE_ANALOGUE_INPUT_0_TO_10_V
  • CHANNEL_MODE_ANALOGUE_INPUT_4_TO_20_MA
  • CHANNEL_MODE_DIGITAL_INPUT_ALERT_ENABLED
  • CHANNEL_MODE_OFF
  • CHANNEL_MODE_BATTERY
  • CHANNEL_MODE_RAW

Time Sensitivity options:

  • TIME_SENSITIVITY_INSTANT
  • TIME_SENSITIVITY_2X
  • TIME_SENSITIVITY_3X
  • TIME_SENSITIVITY_4X

Sampling Period options:

  • SAMPLING_PERIOD_2_SECONDS
  • SAMPLING_PERIOD_5_SECONDS
  • SAMPLING_PERIOD_10_SECONDS
  • SAMPLING_PERIOD_15_SECONDS
  • SAMPLING_PERIOD_20_SECONDS
  • SAMPLING_PERIOD_25_SECONDS
  • SAMPLING_PERIOD_30_SECONDS
  • SAMPLING_PERIOD_45_SECONDS
  • SAMPLING_PERIOD_1_MINUTE
  • SAMPLING_PERIOD_2_MINUTE
  • SAMPLING_PERIOD_3_MINUTE
  • SAMPLING_PERIOD_4_MINUTE
  • SAMPLING_PERIOD_5_MINUTE
  • SAMPLING_PERIOD_10_MINUTE
  • SAMPLING_PERIOD_15_MINUTE
  • SAMPLING_PERIOD_20_MINUTE
  • SAMPLING_PERIOD_30_MINUTE
  • SAMPLING_PERIOD_60_MINUTE
  • SAMPLING_PERIOD_90_MINUTE
  • SAMPLING_PERIOD_120_MINUTE
  • SAMPLING_PERIOD_180_MINUTE
  • SAMPLING_PERIOD_240_MINUTE
  • SAMPLING_PERIOD_360_MINUTE
  • SAMPLING_PERIOD_480_MINUTE
  • SAMPLING_PERIOD_720_MINUTE
  • SAMPLING_PERIOD_COV_TRIGGERED
  • SAMPLING_PERIOD_NEVER

Unit options:

  • UNIT_VOLTS
  • UNIT_MILLIAMPS
  • UNIT_DIGITAL
  • UNIT_PERCENT
  • UNIT_RAW

Alert Type options:

  • ALERT_TYPE_DIGITAL_HIGH
  • ALERT_TYPE_DIGITAL_LOW
  • ALERT_TYPE_ANALOGUE_OUTSIDE_TRIP
  • ALERT_TYPE_ANALOGUE_INSIDE_TRIP