ntn Requests
Use a compatible Notecard to interface with a paired Starnote device for NTN (satellite) communications.
ntn.gps CellCell+WiFiWiFi
Determines whether a Notecard should override a paired Starnote's GPS/GNSS location with its own GPS/GNSS location. The paired Starnote uses its own GPS/GNSS location by default.
on
boolean (optional)
When true
, a Starnote will use the GPS/GNSS location from its paired
Notecard, instead of its own GPS/GNSS location.
off
boolean (optional)
When true
, a paired Starnote will use its own GPS/GNSS location. This is
the default configuration.
{
"req": "ntn.gps",
"on": true
}
J *req = NoteNewRequest("ntn.gps");
JAddBoolToObject(req, "on", true);
NoteRequest(req);
req = {"req": "ntn.gps"}
req["on"] = True
rsp = card.Transaction(req)
Response Members
on
boolean
Returned and true
if a Starnote will use the GPS/GNSS location from
its paired Notecard.
off
boolean
Returned and true
if a paired Starnote will use its own GPS/GNSS
location.
{"off":true}
ntn.reset CellCell+WiFiWiFi
Once a Notecard is connected to a Starnote device, the presence of a physical
Starnote is stored in a permanent configuration that is not affected by a
card.restore
request. This request clears this configuration and allows you to return
to testing NTN mode over cellular or Wi-Fi.
{
"req": "ntn.reset"
}
J *req = NoteNewRequest("ntn.reset");
NoteRequest(req);
req = {"req": "ntn.reset"}
rsp = card.Transaction(req)
Response Members
{}
means success.{}
ntn.status CellCell+WiFiWiFi
Displays the current status of a Notecard's connection to a paired Starnote.
{
"req": "ntn.status"
}
J *req = NoteNewRequest("ntn.status");
NoteRequest(req);
req = {"req": "ntn.status"}
rsp = card.Transaction(req)
Response Members
err
string
This member is present if any errors have occurred while connecting to a paired Starnote, for example:
{"err":"no NTN module is connected {no-ntn-module}"}
status
string
Details about a Notecard's connection to a paired Starnote, for example:
{"status":"{ntn-idle}{ntn-unknown-location}"}
{"status":"{ntn-idle}"}