Rock Seven Products

The Product Developer Hub

Welcome to the Product developer hub. You'll find comprehensive guides and documentation to help you start working with Product as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides
Suggest Edits

Introduction

 

We offer a 'push' HTTP API which will post every mobile-originated message from a device to your own web service.

We also offer some HTTP endpoints that you can use to get/set configuration, and send messages to a device.

These are the IP addresses you will need to whitelist so that we can send data through your firewall: 109.74.196.135 and 212.71.235.32

 

The Push API will send every mobile-originated message from a device to your own web service as an HTTP POST.

The parameters included in the POST can vary depending on the type of device and the type of message, as described below.

You may configure multiple Push API endpoints via the Rock 7 Core user interface. Please contact your account manager if you require any assistance.

JSON or Form-Encoded

The format of the POST can be either a form-encoded post, where the parameters below will be encoded as if submitted from an HTML form.

Alternatively (and preferably) we can send a JSON document in the POST body. Here's an example:

{
  "averageCog": 0,
  "iridium_latitude": 42.0588,
  "device_type": "TIGERSHARK",
  "lon": 19.09065,
  "sog": 0.0,
  "source": "GPS",
  "battery": 82,
  "cep": 5,
  "momsn": 337,
  "id": "rLzVjdQqPgkanllZloYlnpRyKbJZONAG",
  "power": false,
  "transmit_time": "2019-01-31T14:00:13Z",
  "lat": 42.09897,
  "txAt": "2019-01-31T14:00:13Z",
  "pdop": 1.25,
  "temp": 8.0,
  "alt": 6,
  "transport": "IRIDIUM",
  "trigger": "BURST",
  "iridium_longitude": 19.0618,
  "averageSog": 0.0,
  "at": "2019-01-31T14:00:00Z",
  "serial": 21341,
  "cog": 0,
  "JWT": "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJSb2NrIDciLCJpYXQiOjE1NDg5NTIzMzIsImFsdCI6IjYiLCJhdCI6IjIwMTktMDEtMzFUMTQ6MDA6MDBaIiwiYXZlcmFnZUNvZyI6IjAiLCJhdmVyYWdlU29nIjoiMC4wIiwiYmF0dGVyeSI6IjgyIiwiY2VwIjoiNSIsImNvZyI6IjAiLCJkZXZpY2VfdHlwZSI6IlRJR0VSU0hBUksiLCJpZCI6InJMelZqZFFxUGdrYW5sbFpsb1lsbnBSeUtiSlpPTkFHIiwiaXJpZGl1bV9sYXRpdHVkZSI6IjQyLjA1ODgiLCJpcmlkaXVtX2xvbmdpdHVkZSI6IjE5LjA2MTgiLCJsYXQiOiI0Mi4wOTg5NyIsImxvbiI6IjE5LjA5MDY1IiwibW9tc24iOiIzMzciLCJwZG9wIjoiMS4yNSIsInBvd2VyIjoiZmFsc2UiLCJzZXJpYWwiOiIyMTM0MSIsInNvZyI6IjAuMCIsInNvdXJjZSI6IkdQUyIsInRlbXAiOiI4LjAiLCJ0cmFuc21pdF90aW1lIjoiMjAxOS0wMS0zMVQxNDowMDoxM1oiLCJ0cmFuc3BvcnQiOiJJUklESVVNIiwidHJpZ2dlciI6IkJVUlNUIiwidHhBdCI6IjIwMTktMDEtMzFUMTQ6MDA6MTNaIn0.fxLTO4KCy-94rxVhVWrOWdXNgdWR9FLqBlBjtO2uJQlo_njbIOuiU_M8CAv4f1lon6IbbTPen4mRiSIR26S8gn3TUvPdIzzq769bVQBGNiywmwDXZbCJC3-gFi07vcvpyeXPnaEegS1M-Acd-bsC9ORzGeGTSRz5Mp9uajCJ_BSUM7ljMiZajZ6WPoVTgPwTrJ9BdUuz78qipdEQRUW1qdoubkl21SyMYRonB39CMXkA4MTrbITM1g_3viGBVglijIyVh2fumLErYP5SvwfVxNXDSuC5LFHqIszojc3gf5xwuR-fCt4CbzL_I7lOCuct3_kRiYGbUSDpU5Ytp6e1wA"
}

The JWT parameter is signed so that you can verify that the message was sent by Rock 7. The public key is:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlaWAVJfNWC4XfnRx96p9cztBcdQV6l8aKmzAlZdpEcQR6MSPzlgvihaUHNJgKm8t5ShR3jcDXIOI7er30cIN4/9aVFMe0LWZClUGgCSLc3rrMD4FzgOJ4ibD8scVyER/sirRzf5/dswJedEiMte1ElMQy2M6IWBACry9u12kIqG0HrhaQOzc6Tr8pHUWTKft3xwGpxCkV+K1N+9HCKFccbwb8okRP6FFAMm5sBbw4yAu39IVvcSL43Tucaa79FzOmfGs5mMvQfvO1ua7cOLKfAwkhxEjirC0/RYX7Wio5yL6jmykAHJqFG2HT0uyjjrQWMtoGgwv9cIcI7xbsDX6owIDAQAB
-----END PUBLIC KEY-----

Response

It is essential that your web service implementation of the Push API endpoint responds correctly. Our service requires an HTTP 200 response to indicate successful delivery - our service will then consider the message to be delivered, and no further retry attempts will be made.

Any other HTTP response will be considered a ‘temporary‘ failure, and our service will exponentially back off and retry for up to 1 week.

POST parameters

The table below describes the parameters which MAY be included.

Note that if the trigger parameter is set to CONFIG_REPORT, then you may also receive all/any of the configuration parameters described in the Get Configuration

Parameter
Description
Example/Possible Values

id

Unique ID for this report

PAjovqQGZaLRENlxJpMmnlKkpxwgdzDY

transport

Message transport method

IRIDIUM, GPRS, OTHER

imei

IMEI of Iridium device (only present for ROCKBLOCK device types)

15 digits

device_type

Type of device. This may be set to LEOPARD which refers to the family of products including
RockSTAR and Yellowbrick v3. TIGERSHARK refers to the family of devices including RockFLEET
and YB3i. GRIFFIN refers to RockAIR

LEOPARD
ROCKBLOCK
TIGERSHARK
GRIFFIN

serial

The serial number of the device.

An integer

momsn

The MOMSN of the SBD transmission. The MOMSN is a counter stored in the Iridium device,
incremented upon transmission.

An integer

transmit_time

Timestamp that the message was transmitted.

e.g. 2014-02-14T13:55:16Z

at

GPS timestamp of transmitted position.

e.g. 2014-02-14T13:54:48Z

iridium_longitude

The approximate longitude of the device, derived by the Iridium satellites.

e.g. -5.1841

iridium_latitude

The approximate latitude of the device, derived by the Iridium satellites.

e.g. 50.9009

cep

The accuracy, in km, of the Iridium derived position.

An integer

trigger

The reason for this transmission to have been triggered.

ROUTINE
MANUAL
ACTIVATION
DEACTIVATION
CONFIG_REPORT
WAYPOINT
MESSAGE
ACKNOWLEDGE
BLUETOOTH_LOSS
COLLISION
COUNTDOWN
DEAD_MAN
GEOFENCE
BUTTON
CANCEL_ALERT
POWER_LOSS
POWER_GAIN
TEMPERATURE
GENERIC
BLE_RAW
MAILBOX_CHECK
APP_MESSAGE
WATCHING_START_REQUEST
WATCHING_STOP_REQUEST

source

An indicator of whether the transmission includes a valid GPS fix.

GPS
IRIDIUM

lat

GPS latitude

50.88886

lon

GPS longitude

-1.29198

sog

Speed over ground (in knots)

e.g. 0.1

cog

Course over ground

e.g. 302

alt

GPS altitude (in metres)

e.g. 22

temp

Temperature (degrees Celsius)

e.g. 4.5

battery

Battery level, in percent

e.g. 99

power

Indicates presence of external DC power

true, false

message

A text message sent from the device.

e.g. All fine

ack_request

The id of a text message sent FROM the device, to be used when acknowledging.

e.g. 123

message_ack

The id of a text message previously sent TO the device, which the device is acknowledging.

e.g. 321

alert

Indicator of whether or not this transmission was triggered by an alert condition.

true
false

waypoint

The name of the waypoint, as selected by the device user.

e.g. Bridge

appMessageAddress

The comma-separated list of addresses for recipients specified by the user of an i360 CONNECT
App.

someone@gmail.com, 4477701233321

appMessageContent

The message content for a message sent using the i360 CONNECT App

beacons

The comma-separated list of beacons that have been observed

DA01:6969,A10A:EF01

ext_ref

An External Reference can be set in the CORE to help identify devices with a user defined ID.

Returns user specified reference

Iridium position reports

We can report transmissions to you that may not have a valid GPS fix. Typically this happens if it has a poor view of the sky, but there are other occasions when it will transmit a message without a GPS position. In this case, we do get an approximate position from the Iridium network. This ranges in accuracy - often it can be within a few km, or it may be 200km out.

There is a source="GPS" or source="IRIDIUM" parameter in every <position/> element. If it's an Iridium position, you won't get sog, cog or alt parameters.

You will get a cep="123" parameter, which indicates the accuracy (in km) of the reported position.
It's necessary for us to tell you about Iridium positions, because it is possible that the tracker can report an alert with no GPS fix.

If a tracker transmits an 'alert' message, you will now see an alert='true' parameter, as well as an alertType="BUTTON" parameter. The alertType parameter could have any of these values:

Value
Meaning

BUTTON

The user has pressed the red alert button

BT_LOST

The bluetooth connection has been lost

COLLISION

A collision alert

COUNTDOWN

The countdown timer has timed-out

DEAD_MAN

The dead-man timer wasn't reset in time

GEOFENCE

The tracker has moved too far from it's geofence centre

CANCEL

The user has cancelled any previous alerts (this is a menu option on the tracker).

POWER

External power (5V) has been disconnected or re-connected

TEMPERATURE

Temperature outside preset range.

POLYFENCE

The tracker has transmitted because it crossed a polyfence boundary.

SWITCH_A_RISING
SWITCH_A_FALLING
SWITCH_B_RISING
SWITCH_B_FALLING
SWITCH_C_RISING
SWITCH_C_FALLING
SWITCH_D_RISING
SWITCH_D_FALLING
SWITCH_E_RISING
SWITCH_E_FALLING

Activity occurred on an external input

HOVER_ENTRY
HOVER_EXIT

RockAIR specific feature - hover detection events

TAKE_OFF
LANDING
STOPPED
MOVING

RockAIR specific feature - events for fixed-wing aircraft to represent stopped (on blocks), moving (off-blocks), take-off and landing.

TRACKING_SUSPEND
TRACKING_AUTO_RESUME
TRACKING_MANUAL_RESUME

Suspend/resume events

EXCESSIVE_DESCENT_RATE
EXCESSIVE_ASCENT_RATE

Excessive rate of change of altitude events

WAYPOINT_A
WAYPOINT_B
WAYPOINT_C
WAYPOINT_D

Waypoint events

Suggest Edits

Send message (to RockSTAR/YB3 display)

 

Query Auth

 Authentication is required for this endpoint.
posthttps://core.rock7.com/API2/SendMessage/serial
curl --request POST \
  --url https://core.rock7.com/API2/SendMessage/serial
var request = require("request");

var options = { method: 'POST',
  url:
   'https://core.rock7.com/API2/SendMessage/serial' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://core.rock7.com/API2/SendMessage/serial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://core.rock7.com/API2/SendMessage/serial");

xhr.send(data);
import requests

url = "https://core.rock7.com/API2/SendMessage/serial"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

<?xml version="1.0" encoding="UTF-8"?>
<SendMessage><receipt messageId="2110" /></SendMessage>

Path Params

serial
string
required

Serial number of RockFLEET/YB3 device

Query Params

message
string

The message to send to the screen of the device. UTF-8 encoded.

ackRequest
string

set to yes to request a acknowledgement from the device user

 
Suggest Edits

Get Configuration

 

Query Auth

 Authentication is required for this endpoint.
gethttps://core.rock7.com/API2/GetConfig/serial
curl --request GET \
  --url https://core.rock7.com/API2/GetConfig/serial
var request = require("request");

var options = { method: 'GET',
  url:
   'https://core.rock7.com/API2/GetConfig/serial' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://core.rock7.com/API2/GetConfig/serial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://core.rock7.com/API2/GetConfig/serial");

xhr.send(data);
import requests

url = "https://core.rock7.com/API2/GetConfig/serial"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

<?xml version="1.0" encoding="UTF-8"?>
<TrackerData>
  
 <device serial="100007">
   
   <Config>
     
     <Info software="2.8.4" pcb="Griffin" reportAt="2018-07-04T11:31:53Z" />
     
     <Tracking state="off" freq="2" burstFixFreq="1200" burstTransmitFreq="1" cellFreq="30" cellBurstFixFreq="900" cellBurstTransmitFreq="60" distressFreq="30" distressBurstFixFreq="900" distressBurstTransmitFreq="60" activitySenseMode="off" activitySenseThreshold="12" positionBlockFormat="standard" reportAt="2018-07-04T11:31:53Z" />
     
     <Mailbox state="off" freq="60" reportAt="2018-07-04T11:31:53Z" />
     
     <Alert timerState="off" timerTimeout="5" deadManState="off" deadManTimeout="5" 	temperatureState="off" temperatureFreq="1" temperatureCold="10" temperatureHot="40" geofenceState="Polygon" geofenceFreq="1" geofenceRadius="25" powerLossState="off" collisionState="off" collisionDuration="10" collisionThreshold="16" reportAt="2018-07-04T11:31:53Z" />
     
     <Bluetooth state="on" beaconId="0" sensitivity="0" reportAt="2018-07-04T11:31:53Z" />
     
     <System externalPowerMode="unlimited" gprsStrategy="never" logging="on" reportAt="2018-07-04T11:31:53Z" />
     
     <GPS accuracy="2D" hotMode="off" fixesRequired="5" earlyness="20" reportAt="2018-07-04T11:31:53Z" />
     
     <ScreenLock state="off" pin="0784" reportAt="2018-07-04T11:31:53Z" />
   
     <GPSLogging commandAt="2018-07-05T11:14:43Z" />
     
     <Factory serialNumber="34471" reportAt="2018-07-04T11:31:53Z" />
     
     <ExternalData mobWatcher="off" baudRate="19200" sampleRate="20" source="SERIAL-API" debounce="FFFF" reportAt="2018-07-04T11:31:53Z" />
     
     <Airborne flightStatusAlertMode="off" autoResumeState="off" autoResumeRadius="2000" altitudeRateAlertMode="off" descentAlertTime="5" descentAlertSpeed="1000" ascentAlertTime="5" ascentAlertSpeed="1000" vRotate="128" vStall="88" reportAt="2018-07-04T11:31:53Z" />
     
   </Config>
   
  </device>
  
</TrackerData>

Path Params

serial
string
required

Serial number of Rock 7 Device

 

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

on or off

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.

Suggest Edits

Send Configuration

 

Query Auth

 Authentication is required for this endpoint.
posthttps://core.rock7.com/API2/SendConfig/serial
curl --request POST \
  --url https://core.rock7.com/API2/SendConfig/serial
var request = require("request");

var options = { method: 'POST',
  url:
   'https://core.rock7.com/API2/SendConfig/serial' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://core.rock7.com/API2/SendConfig/serial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://core.rock7.com/API2/SendConfig/serial");

xhr.send(data);
import requests

url = "https://core.rock7.com/API2/SendConfig/serial"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serial
string
required

Rock 7 device serial

Query Params

trackingState
string

Controls routine tracking reports
Expected values: on or off

trackingFreq
string

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

trackingBurstFixFreq
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

trackingBurstTransmitFreq
string

How often will a set of fixes be transmitted, when in burst mode, in minutes.
1 2 5 10 15 30 60

trackingCellularFreq
string

Tracking frequency (Cellular context)
see trackingFreq for expected values

trackingCellularBurstFixFreq
string

see trackingBurstFixFreq, for Cellular context

trackingCellularBurstTransmitFreq
string

see trackingBurstTransmitFreq, for Cellular context

trackingDistressFreq
string

Tracking frequency (Distress context)
see trackingFreq for expected values

trackingDistressBurstFixFreq
string

see trackingBurstFixFreq, for Distress context

trackingDistressBurstTransmitFreq
string

see trackingBurstTransmitFreq, for Cellular context

gpsFixesRequired
string

Number of good fixes required before a position is considered valid (default 5)
1 5 10 20

activitySenseMode
string

off power bump sog bump_sog

activitySenseThreshold
string

min: 18, max: 54

requestPing
string

set to yes to request a position report

positionBlockFormat
string

standard or compact

mailboxState
string

Controls routine mailbox checks
on or off

mailboxFreq
string

Mailbox check frequency, in minutes
5 10 15 20 30 60 90 120 180 240 360 480 720

systemClearMessages
string

Delete all messages in the inbox
yes

alertTimerState
string

Timer alert function
on or off

alertTimerTimeout
string

Timeout, in minutes
5 10 15 30 60 120 240

alertDeadManState
string

Dead Man alert function
on or off

alertDeadManTimeout
string

Timeout, in minutes
5 10 15 30 60 120 240

alertTemperatureState
string

Temperature alert function
on or off

alertTemperatureFreq
string

Frequency of temperature measurements
1 2 3 5 10 15 30

alertTemperatureCold
string

-40 -35 -30 -25 -20 -15 -10 -5 0 5 10 15 20 25 30 35 40 45 50

alertTemperatureHot
string

-40 -35 -30 -25 -20 -15 -10 -5 0 5 10 15 20 25 30 35 40 45 50

alertGeofenceState
string

Geofence alert function
on or off

alertGeofenceFreq
string

Frequency of geofence check
1 2 3 5 10 15 30

alertGeofenceCentre
string

set to yes to reset the centre of the geofence alert to the current position

alertGeofenceRadius
string

Geofence alert radius, in metres
25 50 100 250 1000 2000 3000

alertPowerLossState
string

Power loss alert function
on or off

alertCollisionState
string

Collision alert function
on or off

alertCollisionDuration
string

1 2 5 10 20

alertCollisionThreshold
string

1 2 4 8 12 16

bluetoothState
string

Bluetooth mode of operaiton
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)

systemLogging
string

Enable/Disable System Logging to SD Card
on or off

systemDeleteLog
string

Delete System Log from SD Card
yes

systemGprsStrategy
string

Cellular network strategy
never preferred always

systemExternalPowerMode
string

Power Mode
limited unlimited unlimited+activation

systemFactoryReset
string

Reset all configurable settings to Factory Defaults
yes

gpsAccuracy
string

GPS accuracy required
2D or 3D

gpsHotMode
string

Enable/Disable GPS Hot
on or off

gpsEarlyness
string

How many seconds does the GPS switch on before the scheduled transmission time
20 40 60 120 180 240

screenLockState
string

on or off

screenLockPin
string

Screen unlock code
0000 to 9999

screenLockStealthModeState
string

Stealth Mode
on or off

gpsLoggingState
string

on or `off

gpsLoggingDeleteLog
string

set to yes to delete position logs

gpsLoggingNewSegment
string

set to yes to start a new position log file

gpsLoggingPeriod
string

Position log frequency
1 5 10 30 60 300 600 900 1200 1800 3600

dynamicPlatformModel
string

PORTABLE AUTOMOTIVE MARINE AIRBORNE

flightStatusAlertMode
string

off hover fixed-wing

autoResumeState
string

on or off

autoResumeRadius
string

2000 3000 5000 10000

alitudeRateAlertMode
string

off descent ascent both

descentAlertTime
string

Seconds: 5 10 15 20 25 30

descentAlertSpeed
string

Feet-per-minute: 1000 1500 2000 2500 3000

ascentAlertTime
string

Seconds: 5 10 15 20 25 30

ascentAlertSpeed
string

Feet-per-minute: 1000 1500 2000 2500 3000

vRotate
string

0 to 255 knots

vStall
string

0 to 127 knots - must be <80% of vRotate

 
Suggest Edits

Start Watching Me (Confirmation)

 

Query Auth

 Authentication is required for this endpoint.
posthttps://core.rock7.com/API2/SendWatchStartConfirm/serial
curl --request POST \
  --url https://core.rock7.com/API2/SendWatchStartConfirm/serial
var request = require("request");

var options = { method: 'POST',
  url:
   'https://core.rock7.com/API2/SendWatchStartConfirm/serial' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://core.rock7.com/API2/SendWatchStartConfirm/serial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://core.rock7.com/API2/SendWatchStartConfirm/serial");

xhr.send(data);
import requests

url = "https://core.rock7.com/API2/SendWatchStartConfirm/serial"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serial
string
required

Serial number of RockAIR device

 
Suggest Edits

Stop Watching Me (Confirmation)

 

Query Auth

 Authentication is required for this endpoint.
posthttps://core.rock7.com/API2/SendWatchStopConfirm/serial
curl --request POST \
  --url https://core.rock7.com/API2/SendWatchStopConfirm/serial
var request = require("request");

var options = { method: 'POST',
  url:
   'https://core.rock7.com/API2/SendWatchStopConfirm/serial' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://core.rock7.com/API2/SendWatchStopConfirm/serial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://core.rock7.com/API2/SendWatchStopConfirm/serial");

xhr.send(data);
import requests

url = "https://core.rock7.com/API2/SendWatchStopConfirm/serial"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serial
string
required

Serial number of RockAIR device

 
Suggest Edits

Send message (to serial field application)

 

Query Auth

 Authentication is required for this endpoint.
posthttps://core.rock7.com/API2/SendSerialMessage/serial
curl -d "username=xxx&password=yyy&data=8a8c8b" "https://core.rock7.com/API2/SendSerialMessage/2322"
A binary file was returned

You couldn't be authenticated

<?xml version="1.0" encoding="UTF-8"?>
<SendSerialMessage><receipt messageId="21199" /></SendSerialMessage>

Path Params

serial
string
required

Serial number of RockFLEET/YB3 device

Query Params

data
string

The message to send to the connected field application. Hex-encoded binary.

 
Suggest Edits

Send Raw Message (to Connect Framework)

 

Query Auth

 Authentication is required for this endpoint.
posthttps://core.rock7.com/API2/SendRawMessage/serial
curl --request POST \
  --url https://core.rock7.com/API2/SendRawMessage/serial
var request = require("request");

var options = { method: 'POST',
  url:
   'https://core.rock7.com/API2/SendRawMessage/serial' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://core.rock7.com/API2/SendRawMessage/serial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://core.rock7.com/API2/SendRawMessage/serial");

xhr.send(data);
import requests

url = "https://core.rock7.com/API2/SendRawMessage/serial"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

<?xml version="1.0" encoding="UTF-8"?>
<SendRawMessage><receipt messageId="21199" /></SendRawMessage>

Path Params

serial
string
required

Serial number of RockFLEET/YB3 device

Query Params

data
string

The raw message to send. Hex-encoded binary.