MT
Mobile Terminated Messages to 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 payloadmt- Mobile Terminated Messageencrypted- If the Message should be encrypted - true/falsetypeMT_MESSAGE_TEXTMT_MESSAGE_CONNECTMT_MESSAGE_RAWMT_MESSAGE_ACKNOWLEDGEMENTMT_MESSAGE_SERIAL_MESSAGEMT_MESSAGE_SET_GEOFENCE_CENTREMT_MESSAGE_START_WATCHING_MEMT_MESSAGE_STOP_WATCHING_MEMT_MESSAGE_SET_POLYFENCE_ATTRIBUTEMT_MESSAGE_SET_POLYFENCEMT_MESSAGE_FILE_RETRIEVAL_REQUESTMT_MESSAGE_SOFTWARE_UPDATE_REQUESTMT_MESSAGE_GET_PROPERTIESMT_MESSAGE_SET_PROPERTIESMT_MESSAGE_CONFIG_GETMT_MESSAGE_CONFIG_SETMT_MESSAGE_SENSE_SWITCH
- message
geofence- Set Geofence Centrepolyfence- Set PolyfencepolyfenceAttributes- Set Polyfence Attributeconnect- Connect MessagewatchConfirmation- Watch ConfirmationtextMessage- Text MessageserverAcknowledgement- Server AcknowledgementgetConfig- Get ConfigsetConfig- Set ConfiggetProperties- Get PropertiessetProperties- Set PropertiesgetFile- Request FileserialMessage- Send Serial MessagerawMessage- Send Raw MessagesoftwareUpdate- Request Software Upgrade/DowngradesenseSwitch- Manage Sense Switch
Messages
Set Geofence Centre
[geofence]
{
"latlng": {
"latitude": 51.093221,
"longitude": -1.804758
},
"radius": "GEOFENCE_RADIUS_50"
}
The radius option are:
GEOFENCE_RADIUS_25GEOFENCE_RADIUS_50GEOFENCE_RADIUS_100GEOFENCE_RADIUS_250GEOFENCE_RADIUS_1000GEOFENCE_RADIUS_2000GEOFENCE_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_EXITPOLYFENCE_BEHAVIOUR_ENTRYPOLYFENCE_BEHAVIOUR_EXITPOLYFENCE_BEHAVIOUR_ENTRY_THEN_DISABLEPOLYFENCE_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_SPECIFIEDTRACKING_FREQUENCY_CONTINUOUSTRACKING_FREQUENCY_MINUTES_5TRACKING_FREQUENCY_MINUTES_10TRACKING_FREQUENCY_MINUTES_15TRACKING_FREQUENCY_MINUTES_20TRACKING_FREQUENCY_MINUTES_30TRACKING_FREQUENCY_MINUTES_60TRACKING_FREQUENCY_MINUTES_90TRACKING_FREQUENCY_MINUTES_120TRACKING_FREQUENCY_MINUTES_180TRACKING_FREQUENCY_MINUTES_240TRACKING_FREQUENCY_MINUTES_360TRACKING_FREQUENCY_MINUTES_480TRACKING_FREQUENCY_MINUTES_720TRACKING_FREQUENCY_BURSTTRACKING_FREQUENCY_MINUTES_1TRACKING_FREQUENCY_MINUTES_2TRACKING_FREQUENCY_MINUTES_3TRACKING_FREQUENCY_MINUTES_4TRACKING_FREQUENCY_MINUTES_1440TRACKING_FREQUENCY_MINUTES_6TRACKING_FREQUENCY_MINUTES_8TRACKING_FREQUENCY_MINUTES_12TRACKING_FREQUENCY_SECONDS_15TRACKING_FREQUENCY_SECONDS_30
Burst frequency options are:
BURST_FREQUENCY_NOT_ACTIVEBURST_FREQUENCY_MINUTES_1BURST_FREQUENCY_MINUTES_2BURST_FREQUENCY_MINUTES_5BURST_FREQUENCY_MINUTES_10BURST_FREQUENCY_MINUTES_15BURST_FREQUENCY_MINUTES_30BURST_FREQUENCY_MINUTES_60
Burst fix frequency 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
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_1252ENCODING_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_DEBUGCONFIG_BLOCK_TRACKINGCONFIG_BLOCK_MAILBOXCONFIG_BLOCK_USER_MODECONFIG_BLOCK_ALERTCONFIG_BLOCK_BLUETOOTHCONFIG_BLOCK_SYSTEMCONFIG_BLOCK_GPSCONFIG_BLOCK_SCREENCONFIG_BLOCK_GPS_LOGGINGCONFIG_BLOCK_USER_CUSTOMISATIONCONFIG_BLOCK_FACTORY_SETTINGSCONFIG_BLOCK_EXTERNAL_SETTINGSCONFIG_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.
[debug]
{
"version": {
"major": 1,
"minor": 2,
"patch": 3
},
"pcb": "PCB_TYPE_LEOPARD_MK2"
}
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
[tracking]
{
"requestPosition": true,
"activitySenseMode": "ACTIVITY_SENSE_MODE_POWER",
"trackingStatus": "PCB_TYPE_LEOPARD_MK2",
"iridiumContext": "PCB_TYPE_LEOPARD_MK2",
"cellularContext": "PCB_TYPE_LEOPARD_MK2",
"distressContext": "PCB_TYPE_LEOPARD_MK2",
"activitySenseThreshold": "PCB_TYPE_LEOPARD_MK2",
"signalLossChecking": "PCB_TYPE_LEOPARD_MK2",
"positionBlockFormat": "PCB_TYPE_LEOPARD_MK2"
}
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
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_SPECIFIEDTRACKING_FREQUENCY_CONTINUOUSTRACKING_FREQUENCY_MINUTES_5TRACKING_FREQUENCY_MINUTES_10TRACKING_FREQUENCY_MINUTES_15TRACKING_FREQUENCY_MINUTES_20TRACKING_FREQUENCY_MINUTES_30TRACKING_FREQUENCY_MINUTES_60TRACKING_FREQUENCY_MINUTES_90TRACKING_FREQUENCY_MINUTES_120TRACKING_FREQUENCY_MINUTES_180TRACKING_FREQUENCY_MINUTES_240TRACKING_FREQUENCY_MINUTES_360TRACKING_FREQUENCY_MINUTES_480TRACKING_FREQUENCY_MINUTES_720TRACKING_FREQUENCY_BURSTTRACKING_FREQUENCY_MINUTES_1TRACKING_FREQUENCY_MINUTES_2TRACKING_FREQUENCY_MINUTES_3TRACKING_FREQUENCY_MINUTES_4TRACKING_FREQUENCY_MINUTES_1440TRACKING_FREQUENCY_MINUTES_6TRACKING_FREQUENCY_MINUTES_8TRACKING_FREQUENCY_MINUTES_12TRACKING_FREQUENCY_SECONDS_15TRACKING_FREQUENCY_SECONDS_30
Burst frequency options are:
BURST_FREQUENCY_NOT_ACTIVEBURST_FREQUENCY_MINUTES_1BURST_FREQUENCY_MINUTES_2BURST_FREQUENCY_MINUTES_5BURST_FREQUENCY_MINUTES_10BURST_FREQUENCY_MINUTES_15BURST_FREQUENCY_MINUTES_30BURST_FREQUENCY_MINUTES_60
Burst fix frequency 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
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
[mailbox]
{
"checkFrequency": "MAILBOX_CHECK_MINUTES_5",
"checkStatus": "MAILBOX_CHECKING_NOT_SPECIFIED"
}
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
[userMode]
{
"userMode": "USER_MODE_BASIC"
}
User mode options are:
USER_MODE_NOT_SPECIFIEDUSER_MODE_LOCKEDUSER_MODE_MESSAGE_ONLYUSER_MODE_BASICUSER_MODE_STANDARDUSER_MODE_PROFESSIONALUSER_MODE_CORPORATE
[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_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": "BLUETOOTH_STATUS_OFF",
"beaconId": 123,
"scannerSensitivity": "SCANNER_SENSITIVITY_LEVEL_0",
"bleRaw": "BLE_RAW_ON"
}
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
[system]
{
"factoryReset": true,
"loggingMode": "LOGGING_MODE_EXTERNAL_PORT",
"deleteLogFile": true,
"clearMsgStore": true,
"clearPolyfence": true,
"deactivate": true,
"gprsStategy": "GPRS_STRATEGY_NEVER",
"externalPowerMode": "EXTERN_POWER_MODE_LIMITED"
}
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]
{
"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_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
[screenLock]
{
"screenLockStatus": "SCREEN_LOCK_ON",
"stealthModeStatus": "STEALTH_MODE_ON",
"pin": 123
}
Screen lock status options:
SCREEN_LOCK_NOT_SPECIFIEDSCREEN_LOCK_OFFSCREEN_LOCK_ON
Stealth mode options:
STEALTH_MODE_NOT_SPECIFIEDSTEALTH_MODE_OFFSTEALTH_MODE_ON
[gpsLogging]
{
"gpsLoggingStatus": "GPS_LOGGING_ON",
"clearFile": true,
"newSegment": false,
"gpsLogPeriod": "GPS_LOG_PERIOD_SECONDS_10",
"gpsDynamimcMode": 123
}
GPS logging options:
GPS_LOGGING_NOT_SPECIFIEDGPS_LOGGING_OFFGPS_LOGGING_ON
GPS log period options:
GPS_LOG_PERIOD_NOT_SPECIFIEDGPS_LOG_PERIOD_SECONDS_1GPS_LOG_PERIOD_SECONDS_5GPS_LOG_PERIOD_SECONDS_10GPS_LOG_PERIOD_SECONDS_30GPS_LOG_PERIOD_MINUTES_1GPS_LOG_PERIOD_MINUTES_5GPS_LOG_PERIOD_MINUTES_10GPS_LOG_PERIOD_MINUTES_15GPS_LOG_PERIOD_MINUTES_20GPS_LOG_PERIOD_MINUTES_30GPS_LOG_PERIOD_MINUTES_60
GPS dynamic mode options:
GPS_DYNAMIC_NOT_SPECIFIEDGPS_DYNAMIC_MODE_PORTABLEGPS_DYNAMIC_MODE_AUTOMOTIVEGPS_DYNAMIC_MODE_MARINEGPS_DYNAMIC_MODE_AIR
[userCustomisation]
{
"name": "QW4gZXhhbXBsZSByYXcgbWVzc2FnZSBmcm9tIEhlbnJ5IENvb3Blcg=="
}
[factorySettings]
{
"logo": "QW4gZXhhbXBsZSByYXcgbWVzc2FnZSBmcm9tIEhlbnJ5IENvb3Blcg==",
"serial": 12345
}
Logo options:
LOGO_NOT_SPECIFIEDLOGO_FORCE_SELECTLOGO_YELLOWBRICKLOGO_XMARXLOGO_ROCKSTARLOGO_RENTALLOGO_IRIDIUM_360LOGO_PSTARLOGO_SENSE_SWITCH
[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_SPECIFIEDMOB_WATCHER_OFFMOB_WATCHER_ON
Baud rates:
BAUD_RATE_NOT_SPECIFIEDBAUD_RATE_4800BAUD_RATE_9600BAUD_RATE_19200BAUD_RATE_38400BAUD_RATE_57600BAUD_RATE_115200
Sample rates:
SAMPLE_RATE_NOT_SPECIFIEDSAMPLE_RATE_SECONDS_5SAMPLE_RATE_SECONDS_10SAMPLE_RATE_SECONDS_20SAMPLE_RATE_SECONDS_40SAMPLE_RATE_SECONDS_60
Input sensitivity options:
INPUT_SENSITIVITY_NOT_SPECIFIEDINPUT_SENSITIVITY_FASTINPUT_SENSITIVITY_FAST012INPUT_SENSITIVITY_FAST01INPUT_SENSITIVITY_FAST0INPUT_SENSITIVITY_SLOW
Source types:
EXTERNAL_SOURCE_NOT_SPECIFIEDEXTERNAL_SOURCE_OFFEXTERNAL_SOURCE_NMEAEXTERNAL_SOURCE_HYDROSPHEREEXTERNAL_SOURCE_SERIAL_APIEXTERNAL_SOURCE_MAXIMET_800EXTERNAL_SOURCE_MAXIMET_200EXTERNAL_SOURCE_WAVESEXTERNAL_SOURCE_VOLVO_WTP3_FASTOUTEXTERNAL_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_SPECIFIEDALERT_STATUS_OFFALERT_STATUS_HOVERALERT_STATUS_FIXED_WING
Auto resume statuses:
RESUME_STATUS_NOT_SPECIFIEDRESUME_STATUS_OFFRESUME_STATUS_ON
Auto resume radius options:
RESUME_RADIUS_NOT_SPECIFIEDRESUME_RADIUS_2KMRESUME_RADIUS_3KMRESUME_RADIUS_5KMRESUME_RADIUS_10KM
Ascent descent alert modes:
ALERT_MODE_NOT_SPECIFIEDALERT_MODE_OFFALERT_MODE_DESCENTALERT_MODE_ASCENTALERT_MODE_BOTH
Ascent and Descent alert times:
ALERT_TIME_NOT_SPECIFIEDALERT_TIME_SECONDS_5ALERT_TIME_SECONDS_10ALERT_TIME_SECONDS_15ALERT_TIME_SECONDS_20ALERT_TIME_SECONDS_25ALERT_TIME_SECONDS_30
Ascent and Descent alert speeds:
ALERT_SPEED_NOT_SPECIFIEDALERT_SPEED_1000ALERT_SPEED_1500ALERT_SPEED_2000ALERT_SPEED_2500ALERT_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_LOGFILE_TYPE_GPX
Send Serial Message
{
"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_2DNAVIGATION_MODE_3DNAVIGATION_MODE_GLONASS
Send Raw Message
[rawMessage]
{
"message": "RXhhbXBsZSByYXcgbWVzc2FnZQ=="
}
Request Software Upgrade/Downgrade
[softwareUpdate]
{
"mode": "DOWNGRADE"
}
Modes available:
UPGRADEDOWNGRADE
Sense Switch
[senseSwitch]
Contains one of:
setChannelSetting- A report on the current settings for a channelrequestChannelParameters- Request the settings of a channeltriggerOutputChange- Trigger a change in output for an output channelrequestCurrentChannelOutputSettings- 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": 0.0,
"value": 1
}
To turn off.
{
"channelNumber": 2,
"channelMode": "CHANNEL_MODE_DIGITAL_OUTPUT",
"unit": "UNIT_DIGITAL",
"timePeriod": 0,
"oneShot": 1,
"mark": 100.0,
"value": 0
}
Request Channel Output Settings
{
"channelNumber": 3
}
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_BATTERY
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_PERCENT
Alert Type options:
ALERT_TYPE_DIGITAL_HIGHALERT_TYPE_DIGITAL_LOWALERT_TYPE_ANALOGUE_OUTSIDE_TRIPALERT_TYPE_ANALOGUE_INSIDE_TRIP