MO
Mobile Originated (MO) Messages from the Device
Structure
status- If the Message was successfully decoded - true/falseerror[]- Where false, one or more reason for failure (if known)ERROR_UNKNOWNERROR_NO_PAYLOADERROR_PAYLOAD_TOO_LONGERROR_ENCRYPTED_NO_KEYERROR_ENCRYPTED_BAD_KEYERROR_PAYLOAD_INVALIDERROR_PAYLOAD_INVALID_SIZE
messages[]- one or more P6 Message as decoded from the payloadmo- Mobile Originated (MO) Messageencrypted- If the Message was encrypted - true/falsealertStatus- If the Device was in Alert mode - true/falsepowerStatus- If the Device was attached to external power - true/falsewatchStatus- If the Device was in Watch Modetype- what type of Message has been sentMO_MESSAGE_AUTO_POSITION_REPORTMO_MESSAGE_POWER_POSITION_REPORTMO_MESSAGE_MANUAL_POSITION_REPORTMO_MESSAGE_ALERT_HIGH_PRIORITYMO_MESSAGE_POWER_POSITION_REPORT_NO_FIXMO_MESSAGE_AUTO_POSITION_REPORT_NO_FIXMO_MESSAGE_ALERT_HIGH_PRIORITY_NO_FIXMO_MESSAGE_MANUAL_POSITION_REPORT_NO_FIXMO_MESSAGE_ALERT_POWER_LOSSMO_MESSAGE_ALERT_BLUETOOTH_LOSSMO_MESSAGE_ALERT_COUNTDOWN_TIMERMO_MESSAGE_ALERT_DEAD_MANMO_MESSAGE_ALERT_TEMPERATUREMO_MESSAGE_ALERT_OUTSIDE_GEOFENCEMO_MESSAGE_ALERT_COLLISIONMO_MESSAGE_ALERT_GENERICMO_MESSAGE_ALERT_POLYFENCEMO_MESSAGE_AUTO_POSITION_REPORT_COMPACTMO_MESSAGE_AUTO_POSITION_REPORT_AESMO_MESSAGE_ALERT_POWER_LOSS_NO_FIXMO_MESSAGE_ALERT_BLUETOOTH_LOSS_NO_FIXMO_MESSAGE_ALERT_COUNTDOWN_TIMER_NO_FIXMO_MESSAGE_ALERT_DEAD_MAN_NO_FIXMO_MESSAGE_ALERT_TEMPERATURE_NO_FIXMO_MESSAGE_ALERT_OUTSIDE_GEOFENCE_NO_FIXMO_MESSAGE_ALERT_COLLISION_NO_FIXMO_MESSAGE_ALERT_GENERIC_NO_FIXMO_MESSAGE_BEACON_SEENMO_MESSAGE_BEACON_SEEN_NO_FIXMO_MESSAGE_BURST_POSITION_REPORTMO_MESSAGE_BURST_POSITION_REPORT_COMPACTMO_MESSAGE_BURST_POSITION_REPORT_AESMO_MESSAGE_TEXT_MESSAGE_MOMO_MESSAGE_TEXT_MESSAGE_MO_NO_FIXMO_MESSAGE_CONNECT_MESSAGE_MOMO_MESSAGE_WAYPOINT_REPORTMO_MESSAGE_START_WATCHING_MEMO_MESSAGE_START_WATCHING_ME_NO_FIXMO_MESSAGE_STOP_WATCHING_MEMO_MESSAGE_RAW_MESSAGE_MOMO_MESSAGE_ACKNOWLEDGEMENT_MOMO_MESSAGE_ACKNOWLEDGEMENT_MO_AUTOMO_MESSAGE_MULTIPLE_MESSAGE_WRAPPERMO_MESSAGE_DEACTIVATION_NO_FIXMO_MESSAGE_DEACTIVATIONMO_MESSAGE_SERIAL_MESSAGE_MOMO_MESSAGE_SERIAL_MESSAGE_MO_NO_POSITIONMO_MESSAGE_STOP_WATCHING_ME_NO_FIXMO_MESSAGE_CONFIG_SENDMO_MESSAGE_SEND_PROPERTIESMO_MESSAGE_ODOMETERMO_MESSAGE_RTU
message- Object containing the decoded Message and associated propertiesposition- Position ReportburstPositionPosition Report (Burst)alert- Alert (i.e. Red Button)genericAlert- Generic AlertpolyfenceAlert- Polyfence AlerttextMessage- Text (Screen) MessageconnectMessage- App (Connect) MessagerawMessage- App (Raw) MessageserialMessage- Serial Message (RockFLEET)waypoint- Waypoint MessagebeaconSeen- BLE Beacon Seen Alertacknowledgement- Alert Acknowledgement Messageconfig- Configuration Messageproperties- Properties MessagemultipartMessage- Multipart Message WrapperodometerMessage- Odometer Messagertu- RTU 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_2DNAVIGATION_MODE_3DNAVIGATION_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_ACTIVEBURST_FIX_FREQUENCY_SECONDS_5BURST_FIX_FREQUENCY_SECONDS_10BURST_FIX_FREQUENCY_SECONDS_15BURST_FIX_FREQUENCY_SECONDS_20BURST_FIX_FREQUENCY_SECONDS_30BURST_FIX_FREQUENCY_MINUTES_1BURST_FIX_FREQUENCY_MINUTES_2BURST_FIX_FREQUENCY_MINUTES_5BURST_FIX_FREQUENCY_MINUTES_10BURST_FIX_FREQUENCY_MINUTES_15BURST_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_LOSSEVENT_BLUETOOTH_LOSSEVENT_COUNTDOWN_TIMEREVENT_DEAD_MAN_SWITCHEVENT_TEMPERATURE_EXCEEDANCEEVENT_OUTSIDE_GEOFENCEEVENT_COLLISIONEVENT_START_WATCHING_MEEVENT_STOP_WATCHING_MEEVENT_DEACTIVATIONEVENT_POWER_RESETEVENT_POWER_MANUAL_BUTTON_PRESS
Navigation Modes:
NAVIGATION_MODE_2DNAVIGATION_MODE_3DNAVIGATION_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_2DNAVIGATION_MODE_3DNAVIGATION_MODE_GLONASS
Alert Event IDs:
ALERT_EVENT_SWITCH_A_RISING_EDGEALERT_EVENT_SWITCH_A_FALLING_EDGEALERT_EVENT_SWITCH_B_RISING_EDGEALERT_EVENT_SWITCH_B_FALLING_EDGEALERT_EVENT_SWITCH_C_RISING_EDGEALERT_EVENT_SWITCH_C_FALLING_EDGEALERT_EVENT_SWITCH_D_RISING_EDGEALERT_EVENT_SWITCH_D_FALLING_EDGEALERT_EVENT_SWITCH_E_RISING_EDGEALERT_EVENT_SWITCH_E_FALLING_EDGEALERT_EVENT_BUTTON_ALERTALERT_EVENT_BUTTON_ALERT_CANCELALERT_EVENT_HOVER_ENTRYALERT_EVENT_HOVER_EXITALERT_EVENT_TRACKING_SUSPENDALERT_EVENT_AUTO_TRACKING_RESUMEALERT_EVENT_EXCESSIVE_DESCENT_ALERTALERT_EVENT_EXCESSIVE_ASCENT_ALERTALERT_EVENT_FLIGHT_TAKEOFFALERT_EVENT_FLIGHT_LANDINGALERT_EVENT_MANUAL_TRACKING_RESUMEALERT_EVENT_FLIGHT_MOVINGALERT_EVENT_FLIGHT_STOPPEDALERT_EVENT_GEOFENCE_HOMEALERT_EVENT_GEOFENCE_AWAYALERT_EVENT_ODOMETER_STARTALERT_EVENT_ODOMETER_STOPALERT_EVENT_RESERVED_49ALERT_EVENT_WAYPOINT_AALERT_EVENT_WAYPOINT_BALERT_EVENT_WAYPOINT_CALERT_EVENT_WAYPOINT_DALERT_EVENT_SELF_TESTALERT_EVENT_GPS_SIGNAL_LOSSALERT_EVENT_GPS_SIGNAL_RESTOREDALERT_EVENT_SBD_SIGNAL_LOSSALERT_EVENT_SBD_SIGNAL_RESTOREDALERT_EVENT_CONNECT_WAYPOINT_AALERT_EVENT_CONNECT_WAYPOINT_BALERT_EVENT_CONNECT_WAYPOINT_CALERT_EVENT_CONNECT_WAYPOINT_DALERT_EVENT_CONNECT_WAYPOINT_EALERT_EVENT_CONNECT_WAYPOINT_FALERT_EVENT_CONNECT_WAYPOINT_GALERT_EVENT_CONNECT_WAYPOINT_HALERT_EVENT_CONNECT_WAYPOINT_IALERT_EVENT_CONNECT_WAYPOINT_JALERT_EVENT_CONNECT_WAYPOINT_KALERT_EVENT_CONNECT_WAYPOINT_LALERT_EVENT_CONNECT_WAYPOINT_MALERT_EVENT_CONNECT_WAYPOINT_NALERT_EVENT_CONNECT_WAYPOINT_OALERT_EVENT_CONNECT_WAYPOINT_PALERT_EVENT_CONNECT_WAYPOINT_QALERT_EVENT_CONNECT_WAYPOINT_RALERT_EVENT_CONNECT_WAYPOINT_SALERT_EVENT_CONNECT_WAYPOINT_TALERT_EVENT_CONNECT_WAYPOINT_UALERT_EVENT_CONNECT_WAYPOINT_VALERT_EVENT_CONNECT_WAYPOINT_WALERT_EVENT_CONNECT_WAYPOINT_XALERT_EVENT_CONNECT_WAYPOINT_YALERT_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_EDGEPOLYFENCE_BOUNDARY_HEIGHT
Polyfence Transitions:
P6_POLYFENCE_TRANSITION_OUTP6_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_1252ENCODING_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_1252ENCODING_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_1252ENCODING_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_2DNAVIGATION_MODE_3DNAVIGATION_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,
"gprsStrategy": "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_UNKNOWNPCB_TYPE_LEOPARD_MK2PCB_TYPE_LEOPARD_MK3PCB_TYPE_TIGERSHARKPCB_TYPE_GRIFFINPCB_TYPE_GRIFFIN_REV_DPCB_TYPE_SOLARPCB_GRIFFIN_4GPCB_TIGERSHARK_4G
Activity sense modes:
ACTIVITY_SENSE_MODE_NOT_SPECIFIEDACTIVITY_SENSE_MODE_OFFACTIVITY_SENSE_MODE_POWERACTIVITY_SENSE_MODE_BUMPACTIVITY_SENSE_MODE_SOGACTIVITY_SENSE_MODE_BUMP_AND_SOGACTIVITY_SENSE_MODE_AWAY_FROM_HOME
Tracking statuses:
TRACKING_NOT_SPECIFIEDTRACKING_OFFTRACKING_ON
Activity sense threshold options are:
ACTIVITY_SENSE_THRESHOLD_NOT_SPECIFIEDACTIVITY_SENSE_THRESHOLD_Xwhere X is from 0 to 62. e.g.ACTIVITY_SENSE_THRESHOLD_55
Signal loss checking options are:
SIGNAL_LOSS_NOT_SPECIFIEDSIGNAL_LOSS_OFFSIGNAL_LOSS_ON
Position block format options are:
POSITION_BLOCK_FORMAT_NOT_SPECIFIEDPOSITION_BLOCK_FORMAT_STANDARDPOSITION_BLOCK_FORMAT_COMPACTPOSITION_BLOCK_FORMAT_PSTARPOSITION_BLOCK_FORMAT_AES
Check frequency options are:
MAILBOX_CHECK_NOT_SPECIFIEDMAILBOX_CHECK_MINUTES_5MAILBOX_CHECK_MINUTES_10MAILBOX_CHECK_MINUTES_15MAILBOX_CHECK_MINUTES_20MAILBOX_CHECK_MINUTES_30MAILBOX_CHECK_MINUTES_60MAILBOX_CHECK_MINUTES_90MAILBOX_CHECK_MINUTES_120MAILBOX_CHECK_MINUTES_180MAILBOX_CHECK_MINUTES_240MAILBOX_CHECK_MINUTES_360MAILBOX_CHECK_MINUTES_480MAILBOX_CHECK_MINUTES_720
Check status option are:
MAILBOX_CHECKING_NOT_SPECIFIEDMAILBOX_CHECKING_OFFMAILBOX_CHECKING_ON
User mode options are:
USER_MODE_NOT_SPECIFIEDUSER_MODE_LOCKEDUSER_MODE_MESSAGE_ONLYUSER_MODE_BASICUSER_MODE_STANDARDUSER_MODE_PROFESSIONALUSER_MODE_CORPORATE
Timer alert statuses:
TIMER_ALERT_NOT_SPECIFIEDTIMER_ALERT_OFFTIMER_ALERT_ON
Dead man switch statuses:
DEADMANS_SWITCH_NOT_SPECIFIEDDEADMANS_SWITCH_OFFDEADMANS_SWITCH_ON
Timer alert timeout options:
TIMER_ALERT_TIMEOUT_NOT_SPECIFIEDTIMER_ALERT_TIMEOUT_MINUTES_5TIMER_ALERT_TIMEOUT_MINUTES_10TIMER_ALERT_TIMEOUT_MINUTES_15TIMER_ALERT_TIMEOUT_MINUTES_30TIMER_ALERT_TIMEOUT_HOURS_1TIMER_ALERT_TIMEOUT_HOURS_2TIMER_ALERT_TIMEOUT_HOURS_4
Dead man frequency options:
DEAD_MAN_FREQUENCY_NOT_SPECIFIEDDEAD_MAN_FREQUENCY_MINUTES_5DEAD_MAN_FREQUENCY_MINUTES_10DEAD_MAN_FREQUENCY_MINUTES_15DEAD_MAN_FREQUENCY_MINUTES_30DEAD_MAN_FREQUENCY_HOURS_1DEAD_MAN_FREQUENCY_HOURS_2DEAD_MAN_FREQUENCY_HOURS_4
Temperature alert statuses:
TEMPERATURE_ALERT_NOT_SPECIFIEDTEMPERATURE_ALERT_OFFTEMPERATURE_ALERT_ON
Temperature check frequency options:
TEMP_CHECK_FREQUENCY_NOT_SPECIFIEDTEMP_CHECK_FREQUENCY_MINUTES_1TEMP_CHECK_FREQUENCY_MINUTES_2TEMP_CHECK_FREQUENCY_MINUTES_3TEMP_CHECK_FREQUENCY_MINUTES_5TEMP_CHECK_FREQUENCY_MINUTES_10TEMP_CHECK_FREQUENCY_MINUTES_15TEMP_CHECK_FREQUENCY_MINUTES_30
Cold and Hot temperature options:
TEMPERATURE_NOT_SPECIFIEDTEMPERATURE_NEGATIVE_40TEMPERATURE_NEGATIVE_35TEMPERATURE_NEGATIVE_30TEMPERATURE_NEGATIVE_25TEMPERATURE_NEGATIVE_20TEMPERATURE_NEGATIVE_15TEMPERATURE_NEGATIVE_10TEMPERATURE_NEGATIVE_5TEMPERATURE_0TEMPERATURE_POSITIVE_5TEMPERATURE_POSITIVE_10TEMPERATURE_POSITIVE_15TEMPERATURE_POSITIVE_20TEMPERATURE_POSITIVE_25TEMPERATURE_POSITIVE_30TEMPERATURE_POSITIVE_35TEMPERATURE_POSITIVE_40TEMPERATURE_POSITIVE_45TEMPERATURE_POSITIVE_50
Geofence check frequency options:
GEOFENCE_CHECK_FREQUENCY_NOT_SPECIFIEDGEOFENCE_CHECK_FREQUENCY_MINUTES_1GEOFENCE_CHECK_FREQUENCY_MINUTES_2GEOFENCE_CHECK_FREQUENCY_MINUTES_3GEOFENCE_CHECK_FREQUENCY_MINUTES_5GEOFENCE_CHECK_FREQUENCY_MINUTES_10GEOFENCE_CHECK_FREQUENCY_MINUTES_15GEOFENCE_CHECK_FREQUENCY_MINUTES_30
Geofence alert modes:
GEOFENCE_ALERT_MODE_NOT_SPECIFIEDGEOFENCE_ALERT_MODE_OFFGEOFENCE_ALERT_MODE_GEO_ONGEOFENCE_ALERT_MODE_POLY_ON
Power alert status:
POWER_ALERT_NOT_SPECIFIEDPOWER_ALERT_OFFPOWER_ALERT_ON
Geofence radius:
GEOFENCE_RADIUS_NOT_SPECIFIEDGEOFENCE_RADIUS_25GEOFENCE_RADIUS_50GEOFENCE_RADIUS_100GEOFENCE_RADIUS_250GEOFENCE_RADIUS_1000GEOFENCE_RADIUS_2000GEOFENCE_RADIUS_3000
Collision alert statuses:
COLLISION_ALERT_NOT_SPECIFIEDCOLLISION_ALERT_OFFCOLLISION_ALERT_ON
Collision duration:
COLLISION_DURATION_NOT_SPECIFIEDCOLLISION_DURATION_1COLLISION_DURATION_2COLLISION_DURATION_5COLLISION_DURATION_10COLLISION_DURATION_20
Collision threshold:
COLLISION_THRESHOLD_NOT_SPECIFIEDCOLLISION_THRESHOLD_1COLLISION_THRESHOLD_2COLLISION_THRESHOLD_4COLLISION_THRESHOLD_8COLLISION_THRESHOLD_12COLLISION_THRESHOLD_16
Bluetooth status options:
BLUETOOTH_STATUS_NOT_SPECIFIEDBLUETOOTH_STATUS_OFFBLUETOOTH_STATUS_ONBLUETOOTH_STATUS_ON_ADVERTISE_MODEBLUETOOTH_STATUS_ON_SCANNER_MODEBLUETOOTH_STATUS_ON_HEART_RATE_MODE
Scanner sensitivity options:
SCANNER_SENSITIVITY_NOT_SPECIFIEDSCANNER_SENSITIVITY_LEVEL_0SCANNER_SENSITIVITY_LEVEL_1SCANNER_SENSITIVITY_LEVEL_2SCANNER_SENSITIVITY_LEVEL_3SCANNER_SENSITIVITY_LEVEL_4SCANNER_SENSITIVITY_LEVEL_5SCANNER_SENSITIVITY_LEVEL_6
BLE raw options:
BLE_RAW_NOT_SPECIFIEDBLE_RAW_OFFBLE_RAW_ON
Logging mode options:
LOGGING_MODE_NOT_SPECIFIEDLOGGING_MODE_OFFLOGGING_MODE_SD_CARDLOGGING_MODE_EXTERNAL_PORTLOGGING_MODE_BLUETOOTH
GPRS strategy options:
GPRS_STRATEGY_NOT_SPECIFIEDGPRS_STRATEGY_NEVERGPRS_STRATEGY_ALWAYSGPRS_STRATEGY_PREFERRED
External power options:
EXTERN_POWER_MODE_NOT_SPECIFIEDEXTERN_POWER_MODE_UNLIMITEDEXTERN_POWER_MODE_LIMITEDEXTERN_POWER_MODE_UNLIMITED_ACTIVATE
GPS modes:
GPS_MODE_NOT_SPECIFIEDGPS_MODE_2DGPS_MODE_3D
GPS hot statuses:
GPS_HOT_NOT_SPECIFIEDGPS_HOT_ONGPS_HOT_OFF
P6 Early Wakeup options:
EARLY_WAKEUP_NOT_SPECIFIEDEARLY_WAKEUP_SECONDS_20EARLY_WAKEUP_SECONDS_40EARLY_WAKEUP_SECONDS_60EARLY_WAKEUP_MINUTES_2EARLY_WAKEUP_MINUTES_3EARLY_WAKEUP_MINUTES_4
Fixes required options:
FIXES_REQUIRED_NOT_SPECIFIEDFIXES_REQUIRED_1FIXES_REQUIRED_5FIXES_REQUIRED_10FIXES_REQUIRED_20
Battery Select options:
BATTERY_NOT_SPECIFIEDBATTERY_MODEL_ABATTERY_MODEL_B
Screen lock status options:
SCREEN_LOCK_NOT_SPECIFIEDSCREEN_LOCK_OFFSCREEN_LOCK_ON
Stealth mode options:
STEALTH_MODE_NOT_SPECIFIEDSTEALTH_MODE_OFFSTEALTH_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
}
RTU Message
RTU was previously referred to as SenseSwitch. Message structures remain the same but legacy labels will need to be updated.
[rtu]
Contains one of:
channelSettingReport- A report on the current settings for a channelgroupValueTransmission- One or more input value readingscurrentOutputSettingReport- A report on the current output settings for a channelalert- 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_DISABLEDCHANNEL_MODE_DIGITAL_OUTPUTCHANNEL_MODE_ANALOGUE_INPUT_0_TO_10_VCHANNEL_MODE_ANALOGUE_INPUT_4_TO_20_MACHANNEL_MODE_DIGITAL_INPUT_ALERT_ENABLEDCHANNEL_MODE_OFFCHANNEL_MODE_BATTERYCHANNEL_MODE_RAW
Time Sensitivity options:
TIME_SENSITIVITY_INSTANTTIME_SENSITIVITY_2XTIME_SENSITIVITY_3XTIME_SENSITIVITY_4X
Sampling Period options:
SAMPLING_PERIOD_2_SECONDSSAMPLING_PERIOD_5_SECONDSSAMPLING_PERIOD_10_SECONDSSAMPLING_PERIOD_15_SECONDSSAMPLING_PERIOD_20_SECONDSSAMPLING_PERIOD_25_SECONDSSAMPLING_PERIOD_30_SECONDSSAMPLING_PERIOD_45_SECONDSSAMPLING_PERIOD_1_MINUTESAMPLING_PERIOD_2_MINUTESAMPLING_PERIOD_3_MINUTESAMPLING_PERIOD_4_MINUTESAMPLING_PERIOD_5_MINUTESAMPLING_PERIOD_10_MINUTESAMPLING_PERIOD_15_MINUTESAMPLING_PERIOD_20_MINUTESAMPLING_PERIOD_30_MINUTESAMPLING_PERIOD_60_MINUTESAMPLING_PERIOD_90_MINUTESAMPLING_PERIOD_120_MINUTESAMPLING_PERIOD_180_MINUTESAMPLING_PERIOD_240_MINUTESAMPLING_PERIOD_360_MINUTESAMPLING_PERIOD_480_MINUTESAMPLING_PERIOD_720_MINUTESAMPLING_PERIOD_COV_TRIGGEREDSAMPLING_PERIOD_NEVER
Unit options:
UNIT_VOLTSUNIT_MILLIAMPSUNIT_DIGITALUNIT_PERCENTUNIT_RAW
Alert Type options:
ALERT_TYPE_DIGITAL_HIGHALERT_TYPE_DIGITAL_LOWALERT_TYPE_ANALOGUE_OUTSIDE_TRIPALERT_TYPE_ANALOGUE_INSIDE_TRIP