homechevron_rightDocschevron_rightAPI Referencechevron_rightNotecard APIchevron_rightntn Requests - API Reference

ntn Requests

Use a compatible Notecard to interface with a paired Starnote device for NTN (satellite) communications.

ntn.gps

Supported on
CellCell+WiFiSkyloWiFi

On a Notecard paired with a Starnote, this controls whether the Starnote uses a location known to the paired Notecard instead of acquiring one with its own GPS/GNSS module. It does not, by default.

On Notecard for Skylo, the satellite radio and the GPS/GNSS are part of the same module. This request controls whether the Notecard uses a known location (typically a fixed location set with card.location.mode), instead of acquiring a new location for NTN use.

Arguments

off

boolean (optional)

When true, the Notecard does not supply its location to the NTN module. This is the default configuration.

on

boolean (optional)

When true, the Notecard supplies its location to the NTN module. If the Notecard does not yet know its location, none is supplied, and this setting has no effect until a location becomes available.

{
  "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)

Configure the Notecard to supply the location it already knows to the NTN module.

{
  "req": "ntn.gps",
  "off": true
}
J *req = NoteNewRequest("ntn.gps");
JAddBoolToObject(req, "off", true);

NoteRequest(req);
req = {"req": "ntn.gps"}
req["off"] = True
rsp = card.Transaction(req)

Configure the Notecard to not supply its location to the NTN module (default).

{
  "req": "ntn.gps"
}
J *req = NoteNewRequest("ntn.gps");

NoteRequest(req);
req = {"req": "ntn.gps"}
rsp = card.Transaction(req)

Request current GPS/GNSS location configuration.

Response Members

off

boolean

Returned and true if a paired Starnote will use its own GPS/GNSS location.

on

boolean

Returned and true if a Starnote will use the GPS/GNSS location from its paired Notecard.

Example Response
{
  "off": true
}

Response indicating Starnote is using its own GPS/GNSS location (default).

{
  "on": true
}

Response indicating Starnote is using paired Notecard's GPS/GNSS location.

ntn.reset

Supported on
CellCell+WiFiSkyloWiFi

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 the existing NTN configuration, allowing you to return to testing NTN mode over cellular or WiFi, and enables the Starnote to be paired with a different Notecard device.

Arguments
None
{
  "req": "ntn.reset"
}
J *req = NoteNewRequest("ntn.reset");

NoteRequest(req);
req = {"req": "ntn.reset"}
rsp = card.Transaction(req)

Clear Starnote configuration to return to testing NTN mode over cellular or WiFi.

Response Members
None: an empty object {} means success.

ntn.status

Supported on
CellCell+WiFiWiFi

Displays the current status of a Notecard's connection to a paired Starnote.

Arguments
None
{
  "req": "ntn.status"
}
J *req = NoteNewRequest("ntn.status");

NoteRequest(req);
req = {"req": "ntn.status"}
rsp = card.Transaction(req)

Request current status of Notecard's connection to paired Starnote.

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}"}

Example Response
{
  "status": "{ntn-idle}"
}

Response showing Starnote connection in idle state.

{
  "err": "no NTN module is connected {no-ntn-module}"
}

Response showing error when no NTN module is connected.

{
  "status": "{ntn-idle}{ntn-unknown-location}"
}

Response showing detailed status including location information.