Get Configuration (GET)

https://core.rock7.com/API2/GetConfig/{serial}

Parameter	Type	Description	Example/Possible Values
PATH PARAMS
serial	string	required Serial number of RockSTAR/YB3 device	Add a path param

Response Parameters

INFO
software	string	Firmware version of device	X.Y.Z
pcb	string	Device type	Griffin, Tigershark, Leopard
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

TRACKING
state	string	Controls routine tracking reports	on, off
freq	string	Tracking 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
burstFixFreq	string	How often will a position fix be acquired when in burst mode, in seconds	5, 10, 15, 20, 30, 60, 120, 300, 600, 900, 1200
burstTransmitFreq	string	How often will a set of fixes be transmitted, when in burst mode, in minutes	1, 2, 5, 10, 15, 30, 60
cellFreq	string	Tracking frequency (Cellular context)	see trackingFreq for expected values
cellBurstFixFreq	string	see trackingBurstFixFreq, for Cellular context	5, 10, 15, 20, 30, 60, 120, 300, 600, 900, 1200
cellBurstTransmitFreq	string	see trackingBurstTransmitFreq, for Cellular context	1, 2, 5, 10, 15, 30, 60
distressFreq	string	Tracking frequency (Distress context)	see trackingFreq for expected values
distressBurstFixFreq	string	see trackingBurstFixFreq, for Distress context	5, 10, 15, 20, 30, 60, 120, 300, 600, 900, 1200
distressBurstTransmitFreq	string	see trackingBurstTransmitFreq, for Cellular context	1, 2, 5, 10, 15, 30, 60
activitySenseMode	string	The current Activity Sense mode	off, power, bump, sog, bump_sog, away_from_home
activitySenseThreshold	string	The current Activity Sense threshold	min: 18, max: 54
positionBlockFormat	string		standard, compact
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

MAILBOX STATE
state	string	Controls routine mailbox checks	on, off
freq	string	Mailbox check frequency, in minutes	5, 10, 15, 20, 30, 60, 90, 120, 180, 240, 360, 480, 720
externalPowerMode	string	Power Mode	limited, unlimited, unlimited+activation
gprsStrategy	string	Cellular network strategy	never, preferred, always

Mailbox State

GPRS Strategy and External Power Mode are only be included in this block for firmware versions 3.8.7 (RockFLEET, RockAIR) or 3.13.2 (RockSTAR) or later. For earlier firmware versions, these options can be found in SYSTEM STATE.

ALERT STATE
timerState	string	Timer alert function	on, off
timerTimeout	string	Timeout, in minutes	5, 10, 15, 30, 60, 120, 240
deadManState	string	Dead Man alert function	on, off
deadManTimeout	string	Timeout, in minutes	5, 10, 15, 30, 60, 120, 240
temperatureState	string	Temperature alert function	on, off
temperatureFreq	string	Frequency of temperature measurements, in minutes	1, 2, 3, 5, 10, 15, 30
temperatureCold	string	The temperature below which an alert is sent	-40, -35, -30, -25, -20, -15, -10, -5, 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50
temperatureHot	string	The temperature above which an alert is sent	-40, -35, -30, -25, -20, -15, -10, -5, 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50
geofenceState	string	Geofence alert function	off, Simple Polygon
geofenceFreq	string	Frequency of geofence check	1, 2, 3, 5, 10, 15, 30
geofenceRadius	string	Geofence alert radius, in metres	25, 50, 100, 250, 1000, 2000, 3000
powerLossState	string	Power loss alert function	on, off
collisionState	string	Collision alert function	on, off
collisionDuration	string	Minimum duration (in ms) of collision	1, 2, 5, 10, 20
collisionThreshold	string	Minimum threshold (in g's) of collision	1, 2, 4, 8, 12, 16
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

BLUETOOTH
state	string	Bluetooth mode of operation	off, on, advertise, scan
beaconId	string	Bluetooth beacon ID, if Bluetooth state is set to advertise	0 to 255
sensitivity	string	Bluetooth scanner sensitivity	0 (far far away) to 6 (touch)
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

SYSTEM
externalPowerMode	string		limited, unlimited, unlimited+activation
gprsStrategy	string	Cellular network strategy	never, preferred, always
logging	string	System logging	on, off
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

SYSTEM

GPRS Strategy and External Power Mode are only be included in this block for firmware versions earlier than 3.8.7 (RockFLEET, RockAIR) or 3.13.2 (RockSTAR). For more recent firmware versions, these options can be found in Mailbox State.

GPS
Accuracy	string	GPS accuracy required	2D, 3D
hotMode	string	GPS Hot mode status	on, off
fixesRequired	string	Number of GPS fixes required to send a GPS position	1, 5, 10, 20
earlyness	string	How many seconds does the GPS switch on before the scheduled transmission time	20, 40, 60, 120, 180, 240
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

SCREENLOCK
state	string		on, off
pin	string	Screen unlock code	0000 to 9999
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

GPSLOGGING
commandAt	string	Date/Time of Command	YYYY-MM-DD T HH:MM:SS Z

FACTORY
serialNumber	string	Serial Number of Unit
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

EXTERNALDATA
mobWatcher	string	Man Overboard Watcher	on, off
baudRate	string	External baud rate
sampleRate	string	Sample rate of external data
source	string	External source to stream additional data from
debounce	string
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

AIRBORNE
flightStatusAlertMode	string	Type of aircraft	off, hover, fixed-wing
autoResumeState	string	State of Tracking Autoresume	on, off
autoResumeRadius	string	Tracking Autoresume Radius	2000, 3000, 5000, 10000
altitudeRateAlertMode	string	Type of alert	off, descent, ascent, both
descentAlertTime	string	Time of descent after which Alert will be sent, in seconds	5, 10, 15, 20, 25, 30
descentAlertSpeed	string	Duration of maximum descent ascent rate, in feet-per-minute	1000, 1500, 2000, 2500, 3000
ascentAlertTime	string	Duration of maximum acceptable ascent rate, in seconds	5, 10, 15, 20, 25, 30
ascentAlertSpeed	string	Maximum acceptable ascent rate, in feet-per-minute	1000, 1500, 2000, 2500, 3000
vRotate	string	The speed threshold (knots) that causes a takeoff event	0 to 255 knots
vStall	string	The speed threshold (knots) that causes a landing event	0 to 127 knots - must be <80% of vRotate
reportAt	string	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

Notice that every config element will indicate the time that these options were either sent to or received from the tracker, with a commandAt or reportAt attribute.

Response

<?xml version="1.0" encoding="UTF-8"?>
<TrackerData><device serial="100015"><Config><Info software="3.8.26" pcb="Griffin (4G)" reportAt="2024-07-08T08:17:23Z" /><Tracking state="on" freq="10" burstFixFreq="60" burstTransmitFreq="5" cellFreq="10" cellBurstFixFreq="60" cellBurstTransmitFreq="5" distressFreq="1" distressBurstFixFreq="20" distressBurstTransmitFreq="1" activitySenseMode="away_from_home" activitySenseThreshold="0" positionBlockFormat="standard" signalLossCheckingState="on" reportAt="2024-07-08T08:17:23Z" /><Mailbox state="off" freq="30" externalPowerMode="unlimited" gprsStrategy="preferred_speed" reportAt="2024-07-08T08:17:23Z" /><Alert timerState="off" timerTimeout="5" deadManState="off" deadManTimeout="5" temperatureState="off" temperatureFreq="1" temperatureCold="10" temperatureHot="40" geofenceState="Simple" geofenceFreq="1" geofenceRadius="1000" powerLossState="off" collisionState="off" collisionDuration="10" collisionThreshold="16" reportAt="2024-07-08T08:17:23Z" /><Bluetooth state="on" beaconId="0" sensitivity="0" reportAt="2024-07-08T08:17:23Z" /><System externalPowerMode="unlimited" gprsStrategy="never" logging="off" reportAt="2024-07-08T08:17:23Z" /><GPS accuracy="3D" hotMode="off" fixesRequired="20" earlyness="20" batteryModel="A" reportAt="2024-07-08T08:17:23Z" /><ScreenLock state="off" pin="1234" reportAt="2024-07-08T08:17:23Z" /><GPSLogging state="off" period="5" dynamicPlatformModel="AIRBORNE" reportAt="2024-07-08T08:17:23Z" /><Factory serialNumber="34479" reportAt="2024-07-08T08:17:23Z" /><ExternalData mobWatcher="off" baudRate="19200" sampleRate="20" source="SERIAL-API" debounce="FFFF" reportAt="2024-07-08T08:17:23Z" /><Airborne flightStatusAlertMode="off" autoResumeState="off" autoResumeRadius="2000" altitudeRateAlertMode="off" descentAlertTime="5" descentAlertSpeed="1000" ascentAlertTime="5" ascentAlertSpeed="1000" vRotate="128" vStall="88" reportAt="2024-07-08T08:17:23Z" /></Config></device></TrackerData>