PL · Stellar Link

GET/api/v1/pl/aux

Aux#

Responses

200OKapplication/json

availablerequired

boolean

reason

string · nullable

Set when nothing could be mapped — typically satlinkd not running as root, or /dev/mem absent.

regsrequired

array of AuxRegDRO

AuxRegDRO · 5 fields

namerequired

string

addrrequired

string

value

integer · int32 · nullable

≥ 0

docrequired

string

What the value means; present even when the read failed, so a client can show the contract without the number.

error

string · nullable

Why value is absent. Never left implicit: a missing number that does not say why is indistinguishable from a zero.

Request

curl "http://192.168.2.1:8080/api/v1/pl/aux"

import requests

BASE_URL = "http://192.168.2.1:8080"

response = requests.get(f"{BASE_URL}/api/v1/pl/aux")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";

let response = reqwest::Client::new()
    .get(format!("{base_url}/api/v1/pl/aux"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "available": true,
  "reason": "string",
  "regs": [
    {
      "name": "string",
      "addr": "string",
      "value": 0,
      "doc": "string",
      "error": "string"
    }
  ]
}

GET/api/v1/pl/interrupts

Interrupts#

Responses

200OKapplication/json

statusrequired

integer · int32

≥ 0

enablerequired

integer · int32

≥ 0

bitsrequired

array of string

Request

curl "http://192.168.2.1:8080/api/v1/pl/interrupts"

import requests

BASE_URL = "http://192.168.2.1:8080"

response = requests.get(f"{BASE_URL}/api/v1/pl/interrupts")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";

let response = reqwest::Client::new()
    .get(format!("{base_url}/api/v1/pl/interrupts"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "status": 0,
  "enable": 0,
  "bits": [
    "string"
  ]
}

POST/api/v1/pl/interrupts/ack

Ack interrupts#

Request body application/jsonrequired

bitsrequired

integer · int32

≥ 0

Responses

200OKapplication/json

statusrequired

integer · int32

≥ 0

enablerequired

integer · int32

≥ 0

bitsrequired

array of string

Request

curl -X POST "http://192.168.2.1:8080/api/v1/pl/interrupts/ack" \
  -H "Content-Type: application/json" \
  -d '{
  "bits": 0
}'

import requests

BASE_URL = "http://192.168.2.1:8080"

response = requests.post(
    f"{BASE_URL}/api/v1/pl/interrupts/ack",
    json={
        "bits": 0,
    },
)
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";

let response = reqwest::Client::new()
    .post(format!("{base_url}/api/v1/pl/interrupts/ack"))
    .json(&serde_json::json!({
      "bits": 0
    }))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "status": 0,
  "enable": 0,
  "bits": [
    "string"
  ]
}

GET/api/v1/pl/profile-sequencer

Profile sequencer#

Responses

200OKapplication/json

staterequired

integer · int32

≥ 0

statusrequired

integer · int32

≥ 0

err_coderequired

integer · int32

≥ 0

profile_idrequired

integer · int32

≥ 0

state_namerequired

string

Request

curl "http://192.168.2.1:8080/api/v1/pl/profile-sequencer"

import requests

BASE_URL = "http://192.168.2.1:8080"

response = requests.get(f"{BASE_URL}/api/v1/pl/profile-sequencer")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";

let response = reqwest::Client::new()
    .get(format!("{base_url}/api/v1/pl/profile-sequencer"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "state": 0,
  "status": 0,
  "err_code": 0,
  "profile_id": 0,
  "state_name": "string"
}

GET/api/v1/pl/registers/{addr}

Read register#

Path parameters

addrrequired

string

Responses

200OKapplication/json

addrrequired

integer · int32

≥ 0

valuerequired

integer · int32

≥ 0

400invalid addressapplication/json

ApiErrorDRO

Request

curl "http://192.168.2.1:8080/api/v1/pl/registers/<addr>"

import requests

BASE_URL = "http://192.168.2.1:8080"
addr = "<addr>"  # Register address, hex with 0x prefix

response = requests.get(f"{BASE_URL}/api/v1/pl/registers/{addr}")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";
let addr = "<addr>"; // Register address, hex with 0x prefix

let response = reqwest::Client::new()
    .get(format!("{base_url}/api/v1/pl/registers/{addr}"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "addr": 0,
  "value": 0
}

{}

GET/api/v1/pl/status

Status#

Responses

200OKapplication/json

global_ctrlrequired

integer · int32

≥ 0

versionrequired

integer · int32

≥ 0

build_idrequired

integer · int32

≥ 0

cfg_epochrequired

integer · int32

≥ 0

irq_statusrequired

integer · int32

≥ 0

irq_enablerequired

integer · int32

≥ 0

Request

curl "http://192.168.2.1:8080/api/v1/pl/status"

import requests

BASE_URL = "http://192.168.2.1:8080"

response = requests.get(f"{BASE_URL}/api/v1/pl/status")
response.raise_for_status()
print(response.json())

let base_url = "http://192.168.2.1:8080";

let response = reqwest::Client::new()
    .get(format!("{base_url}/api/v1/pl/status"))
    .send()
    .await?
    .error_for_status()?;
let body: serde_json::Value = response.json().await?;
println!("{body:#}");

Response

{
  "global_ctrl": 0,
  "version": 0,
  "build_id": 0,
  "cfg_epoch": 0,
  "irq_status": 0,
  "irq_enable": 0
}