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

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

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

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

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

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

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

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

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

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
}

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

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
}