Skip to main content

Send Configuration (POST)

https://core.rock7.com/API2/SendConfig/{serial}
ParameterTypeDescriptionExample/Possible Values
PATH PARAMS
serialstringSerial number of Rock7 deviceAdd a path param
QUERY PARAMS
trackingStatestringControls routine tracking reportson, off
trackingFreqstringTracking frequency (Iridium Satellite context)15s, 30s, 1, 2, 3, 4, 5, 6, 8, 10, 12, 15, 20, 30, 60, 90, 120, 180, 240, 360, 480, 720, 1440, burst
trackingBurstFixFreqstringHow often will a position fix be acquired when in burst mode, in seconds5, 10, 15, 20, 30, 60, 120, 300, 600, 900, 1200
trackingBurstTransmitFreqstringHow often will a set of fixes be transmitted, when in burst mode, in minutes1, 2, 5, 10, 15, 30, 60
trackingCellularFreqstringTracking frequency (Cellular context)15s, 30s, 1, 2, 3, 4, 5, 6, 8, 10, 12, 15, 20, 30, 60, 90, 120, 180, 240, 360, 480, 720, 1440, burst
trackingCellularBurstFixFreqstringsee trackingBurstFixFreq, for Cellular context5, 10, 15, 20, 30, 60, 120, 300, 600, 900, 1200
trackingCellularBurstTransmitFreqstringsee trackingBurstTransmitFreq, for Cellular context1, 2, 5, 10, 15, 30, 60
trackingDistressFreqstringTracking frequency (Distress context)15s, 30s, 1, 2, 3, 4, 5, 6, 8, 10, 12, 15, 20, 30, 60, 90, 120, 180, 240, 360, 480, 720, 1440, burst
trackingDistressBurstFixFreqstringsee trackingBurstFixFreq, for Distress context5, 10, 15, 20, 30, 60, 120, 300, 600, 900, 1200
trackingDistressBurstTransmitFreqstringsee trackingBurstTransmitFreq, for Cellular context1, 2, 5, 10, 15, 30, 60
gpsFixesRequiredstringNumber of good fixes required before a position is considered valid (default 5)1, 5, 10, 20
activitySenseModestringoff, power, bump, sog, bump_sog
activitySenseThresholdstringmin: 18, max: 54
requestPingstringset to yes to request a position reportyes
positionBlockFormatstringstandard, compact
mailboxStatestringControls routine mailbox checkson, off
mailboxFreqstringMailbox check frequency, in minutes5, 10, 15, 20, 30, 60, 90, 120, 180, 240, 360, 480, 720
systemClearMessagesstringDelete all messages in the inboxyes
alertTimerStatestringTimer alert functionon, off
alertTimerTimeoutstringTimeout, in minutes5, 10, 15, 30, 60, 120, 240
alertDeadManStatestringDead Man alert functionon, off
alertDeadManTimeoutstringTimeout, in minutes5, 10, 15, 30, 60, 120, 240
alertTemperatureStatestringTemperature alert functionon, off
alertTemperatureFreqstringFrequency of temperature measurements1, 2, 3, 5, 10, 15, 30
alertTemperatureColdstring-40, -35, -30, -25, -20, -15, -10, -5, 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50
alertTemperatureHotstring-40, -35, -30, -25, -20, -15, -10, -5, 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50
alertGeofenceStatestringGeofence alert functionon, off
alertGeofenceFreqstringFrequency of geofence check1, 2, 3, 5, 10, 15, 30
alertGeofenceCentrestringset to yes to reset the centre of the geofence alert to the current positionyes
alertGeofenceRadiusstringGeofence alert radius, in metres25, 50, 100, 250, 1000, 2000, 3000
alertPowerLossStatestringPower loss alert functionon, off
alertCollisionStatestringCollision alert functionon, off
alertCollisionDurationstring1, 2, 5, 10, 20
alertCollisionThresholdstring1, 2, 4, 8, 12, 16
bluetoothStatestringBluetooth mode of operationoff, on, advertise, scan
beaconIdstringBluetooth beacon ID, if bluetooth state is set to advertise.0 to 255
sensitivitystringBluetooth scanner sensitivity0 (far far away) to 6 (touch)
systemLoggingstringEnable/Disable System Logging to SD Cardon, off
systemDeleteLogstringDelete System Log from SD Cardyes
systemGprsStrategystringCellular network strategynever, preferred, always
systemExternalPowerModestringPower Modelimited, unlimited, unlimited+activation
systemFactoryResetstringReset all configurable settings to Factory Defaultsyes
gpsAccuracystringGPS accuracy required2D, 3D
gpsHotModestringEnable/Disable GPS Hoton, off
gpsEarlynessstringHow many seconds does the GPS switch on before the scheduled transmission time20, 40, 60, 120, 180, 240
screenLockStatestringon, off
screenLockPinstringScreen unlock code0000 to 9999
screenLockStealthModeStatestringStealth Modeon, off
gpsLoggingStatestringon, off
gpsLoggingDeleteLogstringset to yes to delete position logsyes
gpsLoggingNewSegmentstringset to yes to start a new position log fileyes
ParameterTypeDescriptionExample/Possible Values
gpsLoggingPeriodstringPosition log frequency1, 5, 10, 30, 60, 300, 600, 900, 1200, 1800, 3600
dynamicPlatformModelstringPORTABLE, AUTOMOTIVE, MARINE, AIRBORNE
flightStatusAlertModestringoff, hover, fixed-wing
autoResumeStatestringon, off
autoResumeRadiusstring2000, 3000, 5000, 10000
alitudeRateAlertModestringDEPRECATED: Use altitudeRateAlertMode instead
altitudeRateAlertModestringoff, descent, ascent, both
descentAlertTimestringSeconds5, 10, 15, 20, 25, 30
descentAlertSpeedstringFeet-per-minute1000, 1500, 2000, 2500, 3000
ascentAlertTimestringSeconds5, 10, 15, 20, 25, 30
ascentAlertSpeedstringFeet-per-minute1000, 1500, 2000, 2500, 3000
vRotatestring0 to 255 knots
vStallstring0 to 127 knots - must be <80% of vRotate

Example with Parameters

curl --request POST \
--url 'https://core.rock7.com/API2/SendConfig/12345?trackingState=on&trackingFreq=15&username=myUsername&password=myPassword' \
--header 'accept: application/xml'