System Interface Guide

This guide provides an overview of the system's web interface, including how to query for data and send commands to the system. The system's web interface allows you to interact with the system remotely, providing telemetry data and control over various system functions.

There are two access levels for all the API endpoints and commands:

READONLY_WEB_USER Has access to basic commands but not certain restricted advanced commands
ADMIN_WEB_USER Full access to the system and all its various commands and functions

Querying For Data

To retrieve telemetry data from the system's web UI, you can query the Telemetry Endpoints. The system will return a specific JSON payload from the given URL. Below is an example of how to make the request using both curl and Python.

Using cURL

You can use curl to send a request with Digest Authentication and bypass SSL certificate checks. The command below retrieves the telemetry data:


JSON=$(curl -k --digest -u admin:nextmove https://192.168.1.222/positionStatus.json)
echo $JSON

This will store the JSON response in the JSON variable and then print it to the console.

Using Python

If you prefer to perform the same request in Python, you can use the requests library with Digest Authentication. Here's how you can do it:


import requests
from requests.auth import HTTPDigestAuth
json = None
response = requests.get("https://192.168.1.222/positionStatus.json", auth=HTTPDigestAuth("admin", "nextmove"), verify=False)
if response.status_code == 200:
    json = response.json()
print(json)

This Python code does the same as the curl command, returning and printing the JSON response from the endpoint. The complete list of endpoints you can pull telemetry from are as follows:

JSON endpoint URL	Description
positionStatus.json	Provides real-time status information about the current state of the device, including position / velocity data in various coorindate systems, compassing data, radio and motor status, along with various track state information.
GPSAPStatus.json	Returns the status of the GPS satellite connection, and fix status, then the autopeak settings for the current scan and peak configuration.
update_settings.json	Endpoint to update various system or device settings. It typically contains key-value pairs for configuration parameters.
settings.json	Retrieves the current system or device settings. This includes configuration details such as user preferences, network settings, and operational modes.
stored_locations.json	Provides a list of locations that have been previously stored, including their coordinates and relevant metadata.
list_track.json	Returns the names of all the stored list tracks currently in the system
Satellite_Data.json	Returns an array of all the stored satellite ephemerous data in the system broken out into their components
autoPeakSettings.json	Endpoint that retrieves the current autopeak settings, but specifically the ones related to radio connectivity such as SNMP or IP settings.

Sending Commands

All commands are sent to the endpoint parse_post.json as POST requests with the JSON payloads documented below under API Endpoints and Commands. Some commands require that the user type be ADMIN_WEB_USER, and some of them can be sent as a READONLY_WEB_USER. The default admin nextmove user is already an admin. Using cURL You can use curl to send a POST request with Digest Authentication, bypassing SSL certificate checks. The command below sends a simple command to the endpoint:


curl -k --digest -u admin:nextmove -H "Content-Type: application/json" -X POST -d '{"goto_stow": true}' https://192.168.1.222/parse_post.json

Using Python You can perform the same POST request in Python using the requests library. Here’s how to do it:


import requests
from requests.auth import HTTPDigestAuth

payload = {"goto_stow": True}
response = requests.post("https://192.168.1.222/parse_post.json", json=payload, auth=HTTPDigestAuth("admin", "nextmove"), verify=False)

if response.status_code == 200:
   print("successfully sent stow command")

API Endpoints and Commands

{
  "set_speed": {
    "Az": "int",   // e.g., (10 - 100 as a percentage of the max pwm)
    "El": "int",
    "Ux": "int",
    "persist_speed": "boolean" // (Save this speed in the database to persist across reboots)
  }
}

{
  "trackVars": {
    "az_offset": "float",  // e.g., 0.1234 (in degrees)
    "el_offset": "float",
    "time_offset": "float",
    "entry_el": "float",  // (entry elevation)
    "exit_el": "float"    // (exit elevation)
  }
}

{
  "delete_location": {
    "idx": "int"  // Location index to delete
  }
}

{
  "gyro_calibrate": {}
}

{
  "set_rssi": {
    "value": "float",  // e.g., -70.5 (dBm)
    "lock": "int"      // e.g., 1 (modem lock locked) or 0 (modem lock unlocked)
  }
}

{
  "update_web_user_authorization": {
    "idx": "int",           // User index
    "authorization": "int"  // New authorization level (e.g., 0 for READONLY, 1 for ADMIN)
  }
}

{
  "service_settings": {
    "mapping_service": "int"  // e.g., 1 (service type ID)
  }
}

{
  "reboot": {}
}

{
  "reset_positioner": {}
}

{
  "SNMP_Radio_Config": [
    {
      "idx": 1,
      "mfg_id": 4,
      "OID_String": "1.3.6.1.4.1.17713.9.12.12.0",
      "period": 0.1,
      "divisor": 10,
      "oid_function": 0,
      "one_time": false
    },
    {
      "idx": 2,
      "mfg_id": 11,
      "OID_String": "1.3.6.1.4.1",
      "period": 0.1,
      "divisor": 1,
      "oid_function": 0,
      "one_time": false
    }
  ],
  "SNMP_OID_Function": [
    {
      "idx": -1,
      "name": "None",
      "deletable": false
    },
    {
      "idx": 0,
      "name": "RSSI",
      "deletable": false
    },
    {
      "idx": 1,
      "name": "Connection State",
      "deletable": false
    },
    {
      "idx": 2,
      "name": "Link ID",
      "deletable": false
    },
    {
      "idx": 3,
      "name": "Reset",
      "deletable": false
    }
  ],
  "radio": {
    "connType": 1,
    "RadioMfg": 11,
    "RadioIP": "192.168.1.55",
    "communityStr": "public",
    "SNMPVer": 0,
    "analog_slope": 1,
    "analog_intercept": 1
  }
}