Get Configuration

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

Info

Variable Name	Description	Expected Values
software	Firmware version of device	X.Y.Z
pcb	Device type	'Griffin' 'Tigershark' 'Leopard'
reportAt	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

Tracking

Variable Name	Description	Expected Values
state	Controls routine tracking reports.	`on` or `off`
freq	Tracking frequency (Iridium Satellite context)	`continuous` `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	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	How often will a set of fixes be transmitted, when in burst mode, in minutes.	`1` `2` `5` `10` `15` `30` `60`
cellFreq	Tracking frequency (Cellular context)	see `trackingFreq` for expected values
cellBurstFixFreq	see `trackingBurstFixFreq` for Cellular context
cellBurstTransmitFreq	see `trackingBurstFixFreq` for Cellular context
distressFreq	Tracking frequency (Distress context)	see `trackingFreq` for expected values
distressBurstFixFreq	see `trackingBurstFixFreq` for Distress context
distressBurstTransmitFreq	see `trackingBurstTransmitFreq` for Cellular context
activitySenseMode	The current Activity Sense mode.	`off` `power` `bump` `sog` `bump_sog`
activitySenseThreshold	The current Activity Sense threshold.	min: `18`, max: `54`
positionBlockFormat		`standard` or `compact`
reportAt	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

Mailbox State

Variable Name	Description	Expected Values
state	Controls routine mailbox checks	`on` or `off`
freq	Mailbox check frequency, in minutes	`5` `10` `15` `20` `30` `60` `90` `120` `180` `240` `360` `480` `720`
reportAt	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

Alert State


timerState	Timer alert function	`on` or `off`
timerTimeout	Timeout, in minutes	`5` `10` `15` `30` `60` `120` `240`
deadManState	Dead Man alert function	`on` or `off`
deadManTimeout	Timeout, in minutes	`5` `10` `15` `30` `60` `120` `240`
temperatureState	Temperature alert function	`on` or `off`
temperatureFreq	Frequency of temperature measurements, in minutes	`1` `2` `3` `5` `10` `15` `30`
temperatureCold	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	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	Geofence alert function	`off` `Simple` `Polygon`
geofenceFreq	Frequency of geofence check	`1` `2` `3` `5` `10` `15` `30`
geofenceRadius	Geofence alert radius, in metres	`25` `50` `100` `250` `1000` `2000` `3000`
powerLossState	Power loss alert function	`on` or `off`
collisionState	Collision alert function	`on` or `off`
collisionDuration	Minimum duration (in ms) of collision	`1` `2` `5` `10` `20``
collisionThreshold	Minimum threshold (in g's) of collision	`1` `2` `4` `8` `12` `16`
reportAt	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

Bluetooth


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

System


externalPowerMode
gprsStrategy	Cellular network strategy	`never` `preferred` `always`
logging	System logging	`on` or `off`
reportAt	Date/Time of Report	YYYY-MM-DD T HH:MM:SS Z

GPS


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

ScreenLock


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

GPSLogging


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

Factory


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

ExternalData


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

Airborne


flightStatusAlertMode	Type of aircraft	`off` `hover` `fixed-wing`
autoResumeState	State of Tracking Autoresume	`on` or `off`
autoResumeRadius	Tracking Autoresume Radius	`2000` `3000` `5000` `10000`
altitudeRateAlertMode	Type of alert	`off` `descent` `ascent` `both`
descentAlertTime	Time of descent after which Alert will be sent.	Seconds `5` `10` `15` `20` `25` `30`
descentAlertSpeed	Duration of maximum descent ascent rate.	Feet-per-minute: `1000` `1500` `2000` `2500` `3000`
ascentAlertTime	Duration of maximum acceptable ascent rate.	Seconds `5` `10` `15` `20` `25` `30`
ascentAlertSpeed	Maximum acceptable ascent rate.	Feet-per-minute: `1000` `1500` `2000` `2500` `3000`
vRotate	The speed threshold (knots) that causes a takeoff event.	`0` to `255` knots
vStall	The speed threshold (knots) that causes a landing event.	`0` to `127` knots
reportAt		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.

Language

Authorization

Click Try It! to start a request and see the response here!