ntn Requests

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

Notecard Firmware Version:

ntn.config

Supported on

CellCell+WiFiSkyloWiFi

Returns the configuration and identity of the satellite (NTN) module: the network it is provisioned for, its modem, its SKU and ordering code, and the firmware it is running.

None

Example

JSON

{
  "req": "ntn.config"
}

C/C++

J *req = NoteNewRequest("ntn.config");

NoteRequest(req);

Python

req = {"req": "ntn.config"}
rsp = card.Transaction(req)

Request the configuration and firmware version of the paired Starnote or integrated satellite modem.

Response Members

`body`

object

The satellite module's configuration.

`err`

string

This member is present if an error occurred, for example when no satellite module is connected: {"err":"no NTN module is connected {no-ntn-module}"}

Example Response

{
  "body": {
    "device": "skylo:901980000000000",
    "mtu": 256,
    "modem": "CC660DLSAAR01A03_01.001.01.001",
    "policy": "10TPM",
    "sku": "NTN-SKY1",
    "ordering_code": "AZ",
    "apn": "blues.prod",
    "band": "0",
    "channel": "0",
    "org": "Blues Inc",
    "product": "Starnote",
    "target": "Starnote",
    "version": "starnote-s-10.2.2.17790",
    "ver_major": 10,
    "ver_minor": 2,
    "ver_patch": 2,
    "ver_build": 17790,
    "built": "Sep 03 2026 12:40:29"
  }
}

Response from a Notecard paired with a Starnote for Skylo.

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

Response when the Notecard has no paired Starnote and no integrated satellite modem.

ntn.gps

Supported on

CellCell+WiFiSkyloWiFi

On a Notecard paired with a Starnote, this controls whether the Notecard supplies a location it already knows to the Starnote for satellite use. It does not, by default.

On Notecard for Skylo, the satellite radio and the GPS/GNSS are part of the same module, and by default that module gets its own GPS/GNSS fix while it registers. This request controls whether the Notecard instead passes the module a location it already knows (typically a fixed location set with card.location.mode), which lets the module skip its own fix and register faster.

`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.

Enable Notecard GPS Override

JSON

{
  "req": "ntn.gps",
  "on": true
}

C/C++

J *req = NoteNewRequest("ntn.gps");
JAddBoolToObject(req, "on", true);

NoteRequest(req);

Python

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.

Do Not Supply the Notecard's Location

JSON

{
  "req": "ntn.gps",
  "off": true
}

C/C++

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

NoteRequest(req);

Python

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

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

Query Current GPS Configuration

JSON

{
  "req": "ntn.gps"
}

C/C++

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

NoteRequest(req);

Python

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

Request current GPS/GNSS location configuration.

Response Members

`off`

boolean

Returned and true if the Notecard does not supply its location to the NTN module (a paired Starnote, or Notecard for Skylo's satellite module). The module relies solely on its own GPS/GNSS.

`on`

boolean

Returned and true if the Notecard supplies a location it already knows to the NTN module (a paired Starnote, or Notecard for Skylo's satellite module).

Example Response

{
  "off": true
}

Response indicating the Notecard does not supply its location, so the NTN module relies solely on its own GPS/GNSS (default).

{
  "on": true
}

Response indicating the Notecard supplies a location it already knows to the NTN module.

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.

None

Example

JSON

{
  "req": "ntn.reset"
}

C/C++

J *req = NoteNewRequest("ntn.reset");

NoteRequest(req);

Python

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.

Starnote Quickstart

ntn.status

Supported on

CellCell+WiFiWiFi

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

None

Example

JSON

{
  "req": "ntn.status"
}

C/C++

J *req = NoteNewRequest("ntn.status");

NoteRequest(req);

Python

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}"}. See Notecard Error and Status Codes for a full list of status codes and their meanings.

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.

{
  "status": "{ntn-idle}{ntn-power}{ntn-gps}{ntn-connected}"
}

Response showing a connected satellite module with its GPS/GNSS powered on.

note Requests var Requests