Skip to main content

MO

Mobile Originated (MO) Messages from 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
    • mo - Mobile Originated (MO) Message
      • encrypted - If the Message was encrypted - true/false
      • alertStatus - If the Device was in Alert mode - true/false
      • powerStatus - If the Device was attached to external power - true/false
      • watchStatus - If the Device was in Watch Mode
      • type - what type of Message has been sent
        • MO_MESSAGE_AUTO_POSITION_REPORT
        • MO_MESSAGE_POWER_POSITION_REPORT
        • MO_MESSAGE_MANUAL_POSITION_REPORT
        • MO_MESSAGE_ALERT_HIGH_PRIORITY
        • MO_MESSAGE_POWER_POSITION_REPORT_NO_FIX
        • MO_MESSAGE_AUTO_POSITION_REPORT_NO_FIX
        • MO_MESSAGE_ALERT_HIGH_PRIORITY_NO_FIX
        • MO_MESSAGE_MANUAL_POSITION_REPORT_NO_FIX
        • MO_MESSAGE_ALERT_POWER_LOSS
        • MO_MESSAGE_ALERT_BLUETOOTH_LOSS
        • MO_MESSAGE_ALERT_COUNTDOWN_TIMER
        • MO_MESSAGE_ALERT_DEAD_MAN
        • MO_MESSAGE_ALERT_TEMPERATURE
        • MO_MESSAGE_ALERT_OUTSIDE_GEOFENCE
        • MO_MESSAGE_ALERT_COLLISION
        • MO_MESSAGE_ALERT_GENERIC
        • MO_MESSAGE_ALERT_POLYFENCE
        • MO_MESSAGE_AUTO_POSITION_REPORT_COMPACT
        • MO_MESSAGE_AUTO_POSITION_REPORT_AES
        • MO_MESSAGE_ALERT_POWER_LOSS_NO_FIX
        • MO_MESSAGE_ALERT_BLUETOOTH_LOSS_NO_FIX
        • MO_MESSAGE_ALERT_COUNTDOWN_TIMER_NO_FIX
        • MO_MESSAGE_ALERT_DEAD_MAN_NO_FIX
        • MO_MESSAGE_ALERT_TEMPERATURE_NO_FIX
        • MO_MESSAGE_ALERT_OUTSIDE_GEOFENCE_NO_FIX
        • MO_MESSAGE_ALERT_COLLISION_NO_FIX
        • MO_MESSAGE_ALERT_GENERIC_NO_FIX
        • MO_MESSAGE_BEACON_SEEN
        • MO_MESSAGE_BEACON_SEEN_NO_FIX
        • MO_MESSAGE_BURST_POSITION_REPORT
        • MO_MESSAGE_BURST_POSITION_REPORT_COMPACT
        • MO_MESSAGE_BURST_POSITION_REPORT_AES
        • MO_MESSAGE_TEXT_MESSAGE_MO
        • MO_MESSAGE_TEXT_MESSAGE_MO_NO_FIX
        • MO_MESSAGE_CONNECT_MESSAGE_MO
        • MO_MESSAGE_WAYPOINT_REPORT
        • MO_MESSAGE_START_WATCHING_ME
        • MO_MESSAGE_START_WATCHING_ME_NO_FIX
        • MO_MESSAGE_STOP_WATCHING_ME
        • MO_MESSAGE_RAW_MESSAGE_MO
        • MO_MESSAGE_ACKNOWLEDGEMENT_MO
        • MO_MESSAGE_ACKNOWLEDGEMENT_MO_AUTO
        • MO_MESSAGE_MULTIPLE_MESSAGE_WRAPPER
        • MO_MESSAGE_DEACTIVATION_NO_FIX
        • MO_MESSAGE_DEACTIVATION
        • MO_MESSAGE_SERIAL_MESSAGE_MO
        • MO_MESSAGE_SERIAL_MESSAGE_MO_NO_POSITION
        • MO_MESSAGE_STOP_WATCHING_ME_NO_FIX
        • MO_MESSAGE_CONFIG_SEND
        • MO_MESSAGE_SEND_PROPERTIES
        • MO_MESSAGE_ODOMETER
        • MO_MESSAGE_SENSE_SWITCH
      • message - Object containing the decoded Message and associated properties
        • position - Position Report
        • burstPosition Position Report (Burst)
        • alert - Alert (i.e. Red Button)
        • genericAlert - Generic Alert
        • polyfenceAlert - Polyfence Alert
        • textMessage - Text (Screen) Message
        • connectMessage - App (Connect) Message
        • rawMessage - App (Raw) Message
        • serialMessage - Serial Message (RockFLEET)
        • waypoint - Waypoint Message
        • beaconSeen - BLE Beacon Seen Alert
        • acknowledgement - Alert Acknowledgement Message
        • config - Configuration Message
        • properties - Properties Message
        • multipartMessage - Multipart Message Wrapper
        • odometerMessage - Odometer Message
        • senseSwitch - SenseSwitch Message

Messages

Depending on the type of Message, one of the following sixteen Message objects will be populated...

Position Report

[position]

The most widely consumed Message type, representing a single tracking position report.

{
"standard": {
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 11,
"minute": 56,
"second": 0
},
"timeDelta": 42960,
"dayOfYear": 39,
"latlng": {
"latitude": 50.87769,
"longitude": -1.2520900000000097
},
"altitude": 27,
"course": 0,
"speed": 0.0,
"navigationMode": "NAVIGATION_MODE_3D",
"battery": 96,
"pdop": 1.25,
"temperature": 26
}
}

Navigation Modes:

  • NAVIGATION_MODE_2D
  • NAVIGATION_MODE_3D
  • NAVIGATION_MODE_GLONASS

Position Report (Burst)

[burstPosition]

{
"basePosition": {
"compact": {
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 10,
"second": 17
},
"latlng": {
"latitude": 51.093221,
"longitude": -1.804758
},
"battery": 75,
"timeDelta": 0
}
},
"interval": "BURST_FIX_FREQUENCY_SECONDS_30",
"deltas": [
{
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 10,
"second": 47
},
"latitudeDelta": 0.276,
"longitudeDelta": -0.02,
"altitudeDelta": 0,
"altitude": 0
},
{
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 11,
"second": 17
},
"latitudeDelta": 0.552,
"longitudeDelta": -0.04,
"altitudeDelta": 0,
"altitude": 0
},
{
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 11,
"second": 47
},
"latitudeDelta": 0.8280000000000001,
"longitudeDelta": -0.06,
"altitudeDelta": 0,
"altitude": 0
},
{
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 12,
"second": 17
},
"latitudeDelta": 1.104,
"longitudeDelta": -0.08,
"altitudeDelta": 0,
"altitude": 0
}
]
}

Burst fix frequency (interval) 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

Alert (i.e. Red Button)

[alert]

{
"type": "EVENT_BLUETOOTH_LOSS",
"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
}
}
}

Alert Types:

  • EVENT_POWER_LOSS
  • EVENT_BLUETOOTH_LOSS
  • EVENT_COUNTDOWN_TIMER
  • EVENT_DEAD_MAN_SWITCH
  • EVENT_TEMPERATURE_EXCEEDANCE
  • EVENT_OUTSIDE_GEOFENCE
  • EVENT_COLLISION
  • EVENT_START_WATCHING_ME
  • EVENT_STOP_WATCHING_ME
  • EVENT_DEACTIVATION
  • EVENT_POWER_RESET
  • EVENT_POWER_MANUAL_BUTTON_PRESS

Navigation Modes:

  • NAVIGATION_MODE_2D
  • NAVIGATION_MODE_3D
  • NAVIGATION_MODE_GLONASS

Generic Alert

[genericAlert]

{
"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
}
},
"eventId": "ALERT_EVENT_SWITCH_B_FALLING_EDGE",
"deltaTime": 45,
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 10,
"second": 17
}
}

Navigation Modes:

  • NAVIGATION_MODE_2D
  • NAVIGATION_MODE_3D
  • NAVIGATION_MODE_GLONASS

Alert Event IDs:

  • ALERT_EVENT_SWITCH_A_RISING_EDGE
  • ALERT_EVENT_SWITCH_A_FALLING_EDGE
  • ALERT_EVENT_SWITCH_B_RISING_EDGE
  • ALERT_EVENT_SWITCH_B_FALLING_EDGE
  • ALERT_EVENT_SWITCH_C_RISING_EDGE
  • ALERT_EVENT_SWITCH_C_FALLING_EDGE
  • ALERT_EVENT_SWITCH_D_RISING_EDGE
  • ALERT_EVENT_SWITCH_D_FALLING_EDGE
  • ALERT_EVENT_SWITCH_E_RISING_EDGE
  • ALERT_EVENT_SWITCH_E_FALLING_EDGE
  • ALERT_EVENT_BUTTON_ALERT
  • ALERT_EVENT_BUTTON_ALERT_CANCEL
  • ALERT_EVENT_HOVER_ENTRY
  • ALERT_EVENT_HOVER_EXIT
  • ALERT_EVENT_TRACKING_SUSPEND
  • ALERT_EVENT_AUTO_TRACKING_RESUME
  • ALERT_EVENT_EXCESSIVE_DESCENT_ALERT
  • ALERT_EVENT_EXCESSIVE_ASCENT_ALERT
  • ALERT_EVENT_FLIGHT_TAKEOFF
  • ALERT_EVENT_FLIGHT_LANDING
  • ALERT_EVENT_MANUAL_TRACKING_RESUME
  • ALERT_EVENT_FLIGHT_MOVING
  • ALERT_EVENT_FLIGHT_STOPPED
  • ALERT_EVENT_GEOFENCE_HOME
  • ALERT_EVENT_GEOFENCE_AWAY
  • ALERT_EVENT_ODOMETER_START
  • ALERT_EVENT_ODOMETER_STOP
  • ALERT_EVENT_RESERVED_49
  • ALERT_EVENT_WAYPOINT_A
  • ALERT_EVENT_WAYPOINT_B
  • ALERT_EVENT_WAYPOINT_C
  • ALERT_EVENT_WAYPOINT_D
  • ALERT_EVENT_SELF_TEST
  • ALERT_EVENT_GPS_SIGNAL_LOSS
  • ALERT_EVENT_GPS_SIGNAL_RESTORED
  • ALERT_EVENT_SBD_SIGNAL_LOSS
  • ALERT_EVENT_SBD_SIGNAL_RESTORED
  • ALERT_EVENT_CONNECT_WAYPOINT_A
  • ALERT_EVENT_CONNECT_WAYPOINT_B
  • ALERT_EVENT_CONNECT_WAYPOINT_C
  • ALERT_EVENT_CONNECT_WAYPOINT_D
  • ALERT_EVENT_CONNECT_WAYPOINT_E
  • ALERT_EVENT_CONNECT_WAYPOINT_F
  • ALERT_EVENT_CONNECT_WAYPOINT_G
  • ALERT_EVENT_CONNECT_WAYPOINT_H
  • ALERT_EVENT_CONNECT_WAYPOINT_I
  • ALERT_EVENT_CONNECT_WAYPOINT_J
  • ALERT_EVENT_CONNECT_WAYPOINT_K
  • ALERT_EVENT_CONNECT_WAYPOINT_L
  • ALERT_EVENT_CONNECT_WAYPOINT_M
  • ALERT_EVENT_CONNECT_WAYPOINT_N
  • ALERT_EVENT_CONNECT_WAYPOINT_O
  • ALERT_EVENT_CONNECT_WAYPOINT_P
  • ALERT_EVENT_CONNECT_WAYPOINT_Q
  • ALERT_EVENT_CONNECT_WAYPOINT_R
  • ALERT_EVENT_CONNECT_WAYPOINT_S
  • ALERT_EVENT_CONNECT_WAYPOINT_T
  • ALERT_EVENT_CONNECT_WAYPOINT_U
  • ALERT_EVENT_CONNECT_WAYPOINT_V
  • ALERT_EVENT_CONNECT_WAYPOINT_W
  • ALERT_EVENT_CONNECT_WAYPOINT_X
  • ALERT_EVENT_CONNECT_WAYPOINT_Y
  • ALERT_EVENT_CONNECT_WAYPOINT_Z

Note - there are a series of internal reserved

Polyfence Alert

[polyfenceAlert]

{
"position": {
"compact": {
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 10,
"second": 17
},
"latlng": {
"latitude": 51.093221,
"longitude": -1.804758
},
"battery": 75,
"timeDelta": 0
}
},
"polyfenceId": 2,
"boundary": "POLYFENCE_BOUNDARY_EDGE",
"transition": "P6_POLYFENCE_TRANSITION_IN"
}

Polyfence Boundaries:

  • POLYFENCE_BOUNDARY_EDGE
  • POLYFENCE_BOUNDARY_HEIGHT

Polyfence Transitions:

  • P6_POLYFENCE_TRANSITION_OUT
  • P6_POLYFENCE_TRANSITION_IN

- Text (Screen) Message

[textMessage]

{
"position": {
"compact": {
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 10,
"second": 17
},
"latlng": {
"latitude": 51.093221,
"longitude": -1.804758
},
"battery": 75,
"timeDelta": 0
}
},
"alert": false,
"acknowledge": true,
"encoding": "ENCODING_WESTERN_1252",
"message": "example text message"
}

Encoding options are:

  • ENCODING_WESTERN_1252
  • ENCODING_CYRILLIC_1251

- App (Connect) Message

[connectMessage]

{
"position": {
"compact": {
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 10,
"second": 17
},
"latlng": {
"latitude": 51.093221,
"longitude": -1.804758
},
"battery": 75,
"timeDelta": 0
}
},
"alert": false,
"acknowledge": true,
"encoding": "ENCODING_WESTERN_1252",
"message": "example text message"
}

Encoding options are:

  • ENCODING_WESTERN_1252
  • ENCODING_CYRILLIC_1251

App (Raw) Message

[rawMessage]

{
"message": "QW4gZXhhbXBsZSByYXcgbWVzc2FnZSBmcm9tIEhlbnJ5IENvb3Blcg=="
}

Serial Message (RockFLEET)

[connectMessage]

{
"position": {
"null": {
}
},
"message": "QVQrQkdGREc="
}

Waypoint Message

[waypoint]

{
"position": {
"compact": {
"at": {
"year": 2023,
"month": 10,
"day": 9,
"hour": 15,
"minute": 10,
"second": 17
},
"latlng": {
"latitude": 51.093221,
"longitude": -1.804758
},
"battery": 75,
"timeDelta": 0
}
},
"encoding": "ENCODING_WESTERN_1252",
"name": "Old Sarum"
}

Encoding options are:

  • ENCODING_WESTERN_1252
  • ENCODING_CYRILLIC_1251

BLE Beacon Seen Alert

[beaconSeen]

{
"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
}
},
"major": 653,
"minor": 352
}

Navigation Modes:

  • NAVIGATION_MODE_2D
  • NAVIGATION_MODE_3D
  • NAVIGATION_MODE_GLONASS

Alert Acknowledgement Message

[acknowledgement]

{
"mtmsn": 446362576
}

Configuration Message

[config]

{
"config": {
"debug": {
"version": {
"major": 1,
"minor": 7,
"patch": 2
},
"pcb": "PCB_GRIFFIN_4G"
},
"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"
},
"userMode": {
"userMode": "USER_MODE_PROFESSIONAL"
},
"alertSettings": {
"timerAlertStatus": "TIMER_ALERT_NOT_SPECIFIED",
"deadMansSwitchStatus": "DEADMANS_SWITCH_NOT_SPECIFIED",
"timerAlertTimeout": "TIMER_ALERT_TIMEOUT_NOT_SPECIFIED",
"deadManFrequency": "DEAD_MAN_FREQUENCY_NOT_SPECIFIED",
"temperatureAlertStatus": "TEMPERATURE_ALERT_NOT_SPECIFIED",
"coldTemperature": "TEMPERATURE_NEGATIVE_20",
"tempCheckFrequency": "TEMP_CHECK_FREQUENCY_MINUTES_1",
"hotTemperature": "TEMPERATURE_POSITIVE_50",
"geofenceCheckFrequency": "GEOFENCE_CHECK_FREQUENCY_NOT_SPECIFIED",
"geofenceAlertMode": "GEOFENCE_ALERT_MODE_NOT_SPECIFIED",
"geofenceSetCentre": false,
"powerAlertStatus": "POWER_ALERT_NOT_SPECIFIED",
"geofenceRadius": "GEOFENCE_RADIUS_NOT_SPECIFIED",
"collisionAlertStatus": "COLLISION_ALERT_NOT_SPECIFIED",
"collisionDuration": "COLLISION_DURATION_NOT_SPECIFIED",
"collisionThreshold": "COLLISION_THRESHOLD_NOT_SPECIFIED"
},
"bluetooth": {
"status": "BLUETOOTH_STATUS_OFF",
"beaconId": 0,
"scannerSensitivity": "SCANNER_SENSITIVITY_NOT_SPECIFIED",
"bleRaw": "BLE_RAW_NOT_SPECIFIED"
},
"system": {
"factoryReset": false,
"loggingMode": "LOGGING_MODE_NOT_SPECIFIED",
"deleteLogFile": true,
"clearMsgStore": false,
"clearPolyfence": false,
"deactivate": false,
"gprsStategy": "GPRS_STRATEGY_NOT_SPECIFIED",
"externalPowerMode": "EXTERN_POWER_MODE_NOT_SPECIFIED"
},
"gps": {
"gpsMode": "GPS_MODE_2D",
"gpsHotStatus": "GPS_HOT_NOT_SPECIFIED",
"earlyWakeup": "EARLY_WAKEUP_NOT_SPECIFIED",
"fixesRequired": "FIXES_REQUIRED_NOT_SPECIFIED",
"batterySelect": "BATTERY_NOT_SPECIFIED"
},
"screenLock": {
"screenLockStatus": "SCREEN_LOCK_OFF",
"stealthModeStatus": "STEALTH_MODE_NOT_SPECIFIED",
"pin": 0
}
}
}

PCB options are:

  • PCB_TYPE_UNKNOWN
  • PCB_TYPE_LEOPARD_MK2
  • PCB_TYPE_LEOPARD_MK3
  • PCB_TYPE_TIGERSHARK
  • PCB_TYPE_GRIFFIN
  • PCB_TYPE_GRIFFIN_REV_D
  • PCB_TYPE_SOLAR
  • PCB_GRIFFIN_4G
  • PCB_TIGERSHARK_4G

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

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

User mode options are:

  • USER_MODE_NOT_SPECIFIED
  • USER_MODE_LOCKED
  • USER_MODE_MESSAGE_ONLY
  • USER_MODE_BASIC
  • USER_MODE_STANDARD
  • USER_MODE_PROFESSIONAL
  • USER_MODE_CORPORATE

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 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

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 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

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

Properties Message

[properties]

{
"properties": [
{
"type": "PROPERTY_APN",
"value": "gc.apn.com"
},
{
"type": "PROPERTY_ENDPOINT_ADDRESS_1",
"value": "/test/device"
},
{
"type": "PROPERTY_ENDPOINT_PORT_1",
"value": "5437"
}
]
}

Multipart Message Wrapper

[multipartMessage]

{
"message": [
"Zmlyc3QgcGFydA==",
"YW5vdGhlciBwYXJ0",
"ZmluYWwgcGFydCBvZiBtZXNzYWdl"
]
}

Odometer Message

[odometerMessage]

{
"odometer": 44574
}

SenseSwitch Message

[senseSwitchMessage]

Contains one of:

  • channelSettingReport - A report on the current settings for a channel
  • groupValueTransmission - One or more input value readings
  • currentOutputSettingReport - A report on the current output settings for a channel
  • alert - An alert triggered by a value passing a defined trip boundary

Channel Setting Report

{
"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"
}

Group Value Transmission

{
"channelNumber": 2,
"channelMode": "CHANNEL_MODE_ANALOGUE_INPUT_4_TO_20_MA",
"groupTransmissionSize": 3,
"samplingPeriod": "SAMPLING_PERIOD_5_SECONDS",
"timestamp": {
"year": 2024,
"month": 8,
"day": 12,
"hour": 11,
"minute": 44,
"second": 52
},
"datum": [
{
"timestamp": {
"year": 2024,
"month": 8,
"day": 12,
"hour": 11,
"minute": 42,
"second": 31
},
"value": 11.2
},
{
"timestamp": {
"year": 2024,
"month": 8,
"day": 12,
"hour": 11,
"minute": 42,
"second": 36
},
"value": 12.4
},
{
"timestamp": {
"year": 2024,
"month": 8,
"day": 12,
"hour": 11,
"minute": 42,
"second": 41
},
"value": 13.1
}
],
"unit": "UNIT_MILLIAMPS"
}

Current Output Setting Report

{
"channelNumber": 2,
"channelMode": "CHANNEL_MODE_DIGITAL_OUTPUT",
"value": 1.0,
"timePeriod": 60,
"oneShot": 0,
"unit": "UNIT_DIGITAL"
}

Alert

{
"channelNumber": 3,
"channelMode": "CHANNEL_MODE_ANALOGUE_INPUT_0_TO_10_V",
"timestamp": {
"year": 2024,
"month": 8,
"day": 12,
"hour": 11,
"minute": 42,
"second": 41
},
"value": 8.9,
"unit": "UNIT_VOLTS",
"alertType": "ALERT_TYPE_ANALOGUE_OUTSIDE_TRIP"
}

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

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

Alert Type options:

  • ALERT_TYPE_DIGITAL_HIGH
  • ALERT_TYPE_DIGITAL_LOW
  • ALERT_TYPE_ANALOGUE_OUTSIDE_TRIP
  • ALERT_TYPE_ANALOGUE_INSIDE_TRIP