Stellar ControlMission control · by Stellar Systems v0.1.0

API Reference

Models

The data structures sent to and returned by the API.

Alarm#

An alarm and its current state.

alarmrequired

string

Alarm: its name, or the measure of the limits.

componentrequired

string

Component.

instance

string

Component instance.

targetrequired

string

Target.

recordrequired

AlarmRecord

Current state.

AlarmRecord · 10 fields
active_since

string

Start of the activation.

by

string

Operator of the last transition, when not the condition.

cause

AlarmCause

Cause of the last transition.

changed_at

string

Last transition.

previous

AlarmState

State before the last transition.

seqrequired

integer · uint64

Number of the last transition, from 1; the transition event bears it.

≥ 0

severity

one of AlarmSeverity | null

Severity of the activation; kept while cleared and unacknowledged.

shelved_until

string

End of the shelving: until then, the alarm triggers no reaction.

staterequired

AlarmState

State.

value

any

Value of the measure at the last transition, for the alarm of its limits.

AlarmCause#

Cause of an alarm transition.

one of string | string | string | string

AlarmEvent#

Transition of an alarm, on stellar.alarm.evt.<target>.<component>.<instance>.<alarm> (stream ALARMS, Nats-Msg-Id <target>.<component>.<instance>.<alarm>-<seq>).

alarmrequired

string

Alarm: its name, or the measure of the limits.

atrequired

string

Time of the transition.

by

string

Operator, for an acknowledgement or a shelving.

causerequired

AlarmCause

Cause.

componentrequired

string

Component.

instance

string

Component instance.

previousrequired

AlarmState

State before.

seqrequired

integer · uint64

Number of the transition.

≥ 0

severity

one of AlarmSeverity | null

Severity of the activation.

shelved_until

string

End of the shelving in progress.

staterequired

AlarmState

State after.

targetrequired

string

Target.

value

any

Value of the measure, for the alarm of its limits.

AlarmRecord#

Current state of an alarm, in stellar_alarms under <target>.<component>.<instance>.<alarm>.

active_since

string

Start of the activation.

by

string

Operator of the last transition, when not the condition.

cause

AlarmCause

Cause of the last transition.

changed_at

string

Last transition.

previous

AlarmState

State before the last transition.

seqrequired

integer · uint64

Number of the last transition, from 1; the transition event bears it.

≥ 0

severity

one of AlarmSeverity | null

Severity of the activation; kept while cleared and unacknowledged.

shelved_until

string

End of the shelving: until then, the alarm triggers no reaction.

staterequired

AlarmState

State.

value

any

Value of the measure at the last transition, for the alarm of its limits.

AlarmRef#

An alarm of a target: (component, instance, alarm).

alarmrequired

string

Alarm: its name, or the measure of the limits.

componentrequired

string

Component.

instance

string

Component instance.

Alarms#

Body of GET /v1/alarms.

alarmsrequired

array of Alarm

Alarms, by key order.

Alarm · 5 fields
alarmrequired

string

Alarm: its name, or the measure of the limits.

componentrequired

string

Component.

instance

string

Component instance.

targetrequired

string

Target.

recordrequired

AlarmRecord

Current state.

AlarmRecord · 10 fields
active_since

string

Start of the activation.

by

string

Operator of the last transition, when not the condition.

cause

AlarmCause

Cause of the last transition.

changed_at

string

Last transition.

previous

AlarmState

State before the last transition.

seqrequired

integer · uint64

Number of the last transition, from 1; the transition event bears it.

≥ 0

severity

one of AlarmSeverity | null

Severity of the activation; kept while cleared and unacknowledged.

shelved_until

string

End of the shelving: until then, the alarm triggers no reaction.

staterequired

AlarmState

State.

value

any

Value of the measure at the last transition, for the alarm of its limits.

AlarmSeverity#

Severity of an alarm.

one of string | string

AlarmState#

State of an alarm (spec « Alarmes »).

one of string | string | string | string

Answer#

Body of POST /v1/runs/{id}/answers.

pathrequired

string

Step asking, as in its asked or decision_required event.

acceptedrequired

boolean

Whether the operator confirms.

value

any

Typed answer, or decision: replay, skip, fail or abort.

ArgumentView#

An argument of a telecommand.

namerequired

string

Name.

description

string

Description, from the catalogue.

typerequired

string

Type.

unit

string

Unit.

valuesrequired

array of string

Values of an enum.

range

array of number · double

Accepted range.

default

string

Value when omitted, as written.

AuthSettings#

Reply of GET /v1/auth/config.

oidc

one of SignIn | null

BindingDetail#

A link bound to an instance, and the consumer of the telecommands it takes.

targetrequired

string

Target.

linkrequired

string

Link.

driverrequired

string

Driver bound.

transport

string

Transport bound, when the link has one.

gatewayrequired

string

Gateway bound.

configrequired

string

Configuration revision of the target.

config_currentrequired

boolean

Whether it is the current configuration.

encoderequired

string

Subject of the telecommands to encode.

uplinkrequired

string

Subject of the frames to uplink.

consumer

one of ConsumerStats | null

BoundView#

Instances bound to a link.

driverrequired

string

Driver instance.

transport

string

Transport instance, when the link has one.

gatewayrequired

string

Gateway instance.

CatalogueView#

Body of GET /v1/targets/{target}/catalogue.

platformrequired

string

Platform, package@version.

componentsrequired

array of ComponentView

Components.

ComponentView · 5 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

instancesrequired

array of string

Instances of a multi-instance component.

measuresrequired

array of MeasureView

Measures, derived ones included.

MeasureView · 7 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

typerequired

string

Type.

unit

string

Unit.

soft

array of number · double

Soft limits, [low, high].

hard

array of number · double

Hard limits.

derivedrequired

boolean

Whether derived from other measures.

telecommandsrequired

array of TelecommandView

Telecommands.

TelecommandView · 5 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

argsrequired

array of ArgumentView

Arguments.

ArgumentView · 7 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

typerequired

string

Type.

unit

string

Unit.

valuesrequired

array of string

Values of an enum.

range

array of number · double

Accepted range.

default

string

Value when omitted, as written.

changes_staterequired

boolean

Whether it changes the on-board state.

hazardousrequired

boolean

Whether it needs a confirmation.

Change#

What changed.

string

ComponentView#

A component of a catalogue.

namerequired

string

Name.

description

string

Description, from the catalogue.

instancesrequired

array of string

Instances of a multi-instance component.

measuresrequired

array of MeasureView

Measures, derived ones included.

MeasureView · 7 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

typerequired

string

Type.

unit

string

Unit.

soft

array of number · double

Soft limits, [low, high].

hard

array of number · double

Hard limits.

derivedrequired

boolean

Whether derived from other measures.

telecommandsrequired

array of TelecommandView

Telecommands.

TelecommandView · 5 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

argsrequired

array of ArgumentView

Arguments.

ArgumentView · 7 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

typerequired

string

Type.

unit

string

Unit.

valuesrequired

array of string

Values of an enum.

range

array of number · double

Accepted range.

default

string

Value when omitted, as written.

changes_staterequired

boolean

Whether it changes the on-board state.

hazardousrequired

boolean

Whether it needs a confirmation.

ConnectorLag#

Lag of the consumer of one kind of data of an output connector, published by the leader of the reconciler on stellar.metrics.connector.<name> (spec « Connecteurs de sortie »).

activerequired

boolean

Whether a client is pulling the consumer now.

atrequired

string

Computation.

at_riskrequired

boolean

Whether the retention is about to remove messages the connector has not read.

connectorrequired

string

Connector.

consumerrequired

string

Durable consumer.

fill

number · double

Filling of the stream against its max_bytes; None when not bounded by volume.

kindrequired

string

Kind of data.

lag_secondsrequired

number · double

Age of that message, in seconds: 0 when the connector is up to date.

oldest_unread

string

Storage of the oldest message not acknowledged, when there is one.

pendingrequired

integer · uint64

Messages not delivered yet.

≥ 0

reason

string

Why.

retention_seconds

number · double

Maximum age of the stream, in seconds; None when not bounded by age.

streamrequired

string

JetStream stream.

unackedrequired

integer · uint64

Messages delivered and not acknowledged.

≥ 0

ConnectorsView#

Body of GET /v1/connectors.

connectorsrequired

array of ConnectorView

Connectors of the topology.

ConnectorView · 5 fields
namerequired

string

Name.

datarequired

array of string

Kinds of data.

targetsrequired

array of string

Targets.

instance

one of InstanceView | null

lagsrequired

array of ConnectorLag

Lag of each consumer created.

ConnectorLag · 14 fields
activerequired

boolean

Whether a client is pulling the consumer now.

atrequired

string

Computation.

at_riskrequired

boolean

Whether the retention is about to remove messages the connector has not read.

connectorrequired

string

Connector.

consumerrequired

string

Durable consumer.

fill

number · double

Filling of the stream against its max_bytes; None when not bounded by volume.

kindrequired

string

Kind of data.

lag_secondsrequired

number · double

Age of that message, in seconds: 0 when the connector is up to date.

oldest_unread

string

Storage of the oldest message not acknowledged, when there is one.

pendingrequired

integer · uint64

Messages not delivered yet.

≥ 0

reason

string

Why.

retention_seconds

number · double

Maximum age of the stream, in seconds; None when not bounded by age.

streamrequired

string

JetStream stream.

unackedrequired

integer · uint64

Messages delivered and not acknowledged.

≥ 0

ConnectorView#

An output connector: as declared, its instance, and the lag of its consumers.

namerequired

string

Name.

datarequired

array of string

Kinds of data.

targetsrequired

array of string

Targets.

instance

one of InstanceView | null

lagsrequired

array of ConnectorLag

Lag of each consumer created.

ConnectorLag · 14 fields
activerequired

boolean

Whether a client is pulling the consumer now.

atrequired

string

Computation.

at_riskrequired

boolean

Whether the retention is about to remove messages the connector has not read.

connectorrequired

string

Connector.

consumerrequired

string

Durable consumer.

fill

number · double

Filling of the stream against its max_bytes; None when not bounded by volume.

kindrequired

string

Kind of data.

lag_secondsrequired

number · double

Age of that message, in seconds: 0 when the connector is up to date.

oldest_unread

string

Storage of the oldest message not acknowledged, when there is one.

pendingrequired

integer · uint64

Messages not delivered yet.

≥ 0

reason

string

Why.

retention_seconds

number · double

Maximum age of the stream, in seconds; None when not bounded by age.

streamrequired

string

JetStream stream.

unackedrequired

integer · uint64

Messages delivered and not acknowledged.

≥ 0

ConsumerStats#

Statistics of a durable consumer.

namerequired

string

Name.

deliveredrequired

integer · int64

Messages delivered and acknowledged.

≥ 0

pendingrequired

integer · int64

Messages waiting to be delivered.

≥ 0

ack_pendingrequired

integer

Messages delivered and not acknowledged yet.

≥ 0

redeliveredrequired

integer

Messages delivered again.

≥ 0

last_active

string · date-time

Last delivery.

CurrentValue#

Current value of a measure.

componentrequired

string

Component.

instance

string

Instance of a multi-instance component.

measurerequired

string

Measure or derived measure.

samplerequired

Sample

Latest sample.

Sample · 6 fields
deliveryrequired

string

realtime or deferred; deferred when any input of a derived measure is.

ground_timerequired

string

Ground reception time, reference of freshness; for a derived measure, that of its oldest input.

linkrequired

string

Link of the frame; for a derived measure, that of its most recent input.

raw

any

Raw value of a measure calibrated by the MCS.

timerequired

string

Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.

valuerequired

any

Physical value: number in the unit of the measure, boolean, enum value, hexadecimal bytes; null when a temporal derived measure becomes unknown (empty window).

DecodeBody#

Body of POST /v1/decode: a frame received on a link of a target, and the driver to ask.

targetrequired

string

Target.

frame

string

The frame in hexadecimal (56 4f 4c 54, spaces allowed); or text.

text

string

The frame as text, for a text protocol (VOLT 28.0); or frame.

link

string

Link, when not the default one.

environment

string

Environment, which selects the parameters of the link.

driver

string

Driver instance to ask, when not the one bound to the link.

Decoded#

Reply of POST /v1/decode.

targetrequired

string

Target.

linkrequired

string

Link.

driverrequired

string

Driver instance that decoded it.

environment

string

Environment of the parameters of the link.

samplesrequired

array of DecodedSample

Samples, in the order the driver gives them.

DecodedSample · 7 fields
componentrequired

string

Component.

instance

string

Instance of a multi-instance component.

measurerequired

string

Measure.

rawrequired

any

Raw value, as the driver gives it.

value

any

Value in the unit of the measure, through its calibration; None when the catalogue has no such measure or the calibration does not cover the raw value.

unit

string

Unit of the measure.

onboard_time

string

On-board time, when the frame carries it.

DecodedSample#

A sample of a decoded frame: the raw value of the driver, and its value calibrated by the catalogue of the target.

componentrequired

string

Component.

instance

string

Instance of a multi-instance component.

measurerequired

string

Measure.

rawrequired

any

Raw value, as the driver gives it.

value

any

Value in the unit of the measure, through its calibration; None when the catalogue has no such measure or the calibration does not cover the raw value.

unit

string

Unit of the measure.

onboard_time

string

On-board time, when the frame carries it.

Directory#

Body of GET /v1/targets/{target}/files.

componentrequired

string

Component of the on-board directory.

filesrequired

array of OnboardFile

Files, by identifier.

OnboardFile · 7 fields
idrequired

string

Identifier.

file_type

string

Type (lttm, log…).

size

integer · int64

Size, in bytes.

≥ 0

checksum

string

Checksum, hexadecimal.

generation

integer · int64

Generation: a file rewritten on board gets the next one.

≥ 0

transfer

string

State of its transfer.

listed_at

string · date-time

Last listing.

DownloadRequest#

Body of POST /v1/transfers.

targetrequired

string

Target.

file_idrequired

string

File, by its on-board identifier.

priority

integer · int32

Priority: higher first.

DriverDetail#

What a driver implements, against the current configuration.

codecrequired

string

Codec.

cataloguerequired

string

Catalogue and the versions it fits, name@requirement.

catalogue_version

string

The newest version of that catalogue in the current configuration satisfying the requirement, against which its coverage is measured; None when there is none.

telecommandsrequired

array of string

Telecommands covered, component.telecommand.

measuresrequired

array of string

Measures covered, component.measure.

missing_telecommandsrequired

array of string

Telecommands of the catalogue it does not cover.

missing_measuresrequired

array of string

Measures of the catalogue it does not cover.

EncodeBody#

Body of POST /v1/encode: a telecommand as for POST /v1/tc, and the driver to ask.

targetrequired

string

Target.

telecommandrequired

string

Telecommand: its name alone when unique in the platform, else component.name.

instance

string

Instance of a multi-instance component, or file id for files.

args

map of InputArg

Arguments: 100 V, enum values, booleans, hexadecimal bytes.

link

string

Link, when not the default one.

environment

string

Environment, which selects the parameters of the link.

driver

string

Driver instance to ask, when not the one bound to the link: a driver being developed.

Encoded#

Reply of POST /v1/encode.

targetrequired

string

Target.

linkrequired

string

Link.

driverrequired

string

Driver instance that encoded it.

environment

string

Environment of the parameters of the link.

telecommandrequired

string

The telecommand, as written: tcu[TCU1].set_mode.

argsrequired

map of any

Its arguments, resolved: numbers in the unit of their argument, defaults applied.

framerequired

string

The frame, in hexadecimal: the frame of the medium on a link without transport, the unit the driver hands to the transport otherwise.

sizerequired

integer

Its size, in bytes.

≥ 0

text

string

The frame as text, when it is printable text (SCPI and other text protocols).

Entry#

An entry of the journal.

atrequired

string · date-time

When the reconciler made the change.

targetrequired

string

Target.

link

string

Link, for a change of a link.

changerequired

Change

What changed.

one of bound unbound rebound ready not_ready revision

driver

string

Driver bound after the change.

transport

string

Transport bound after the change.

gateway

string

Gateway bound after the change.

config

string

Configuration revision of the target after the change.

reasons

array of string

Why, in the words of the readiness: the reasons of the target or of the link.

EnvironmentPolicy#

Policies of an environment.

allow_draftrequired

boolean

Whether draft packages are accepted.

human_orchestration

ErrorBody#

Body of an error response.

errorsrequired

array of ErrorItem

Every error found.

ErrorItem · 3 fields
coderequired

string

Stable code.

messagerequired

string

Message for the operator.

help

string

Suggested fix.

ErrorItem#

One error.

coderequired

string

Stable code.

messagerequired

string

Message for the operator.

help

string

Suggested fix.

Evidence#

A sample a condition was judged on.

componentrequired

string

Component.

ground_timerequired

string

Ground reception time.

instance

string

Instance.

measurerequired

string

Measure.

targetrequired

string

Target.

timerequired

string

Time of the sample.

valuerequired

any

Value.

FaultRequest#

A fault of the simulation of a target to switch on during the run, then off: to rehearse the recovery of a procedure, its if failed blocks and the reactions to alarms.

YAML
faults:
  - {target: chamber, fault: vacuum_leak, at: {step: Plateau, after: 10 s}, off: {after: 60 s}}
targetrequired

string

Role of the target, as in targets.

faultrequired

string

Fault, as the simulation of the target names it.

at

Trigger

When it is switched on: after the start of the run, or of the first entry in a step.

Trigger · 2 fields
step

string

Step whose first entry starts the delay: its name (Plateau), or its path (TVAC cycle / Plateau).

after

string

Delay.

off

one of Trigger | null

GatewayDetail#

What a gateway offers.

tagsrequired

array of string

Tags.

uplink

one of LinkCapability | null

downlink

one of LinkCapability | null

Health#

Health of an instance.

one of string | string

Heartbeat#

Heartbeat, published on stellar.ctl.hb.<kind>.<instance> every period.

healthrequired

Health

Health.

link_available

boolean

For a gateway: whether its link is available (satellite in view, station in service). A gateway without this notion always reports true.

reason

string

Why the instance is degraded.

sent_atrequired

string

Emission time.

History#

Body of GET /v1/targets/{target}/values/history: the samples of one measure over a window, as the compute stage published them in the stream PARAMS.

componentrequired

string

Component.

instance

string

Instance of a multi-instance component.

measurerequired

string

Measure or derived measure.

samplesrequired

array of Sample

Samples in the order they were published: real-time ones by time, deferred ones when they came down. With more than limit in the window, one in every few is kept, the last one always.

Sample · 6 fields
deliveryrequired

string

realtime or deferred; deferred when any input of a derived measure is.

ground_timerequired

string

Ground reception time, reference of freshness; for a derived measure, that of its oldest input.

linkrequired

string

Link of the frame; for a derived measure, that of its most recent input.

raw

any

Raw value of a measure calibrated by the MCS.

timerequired

string

Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.

valuerequired

any

Physical value: number in the unit of the measure, boolean, enum value, hexadecimal bytes; null when a temporal derived measure becomes unknown (empty window).

thinnedrequired

boolean

Whether samples were left out to keep limit.

truncatedrequired

boolean

Whether the window holds more samples than are read at once: only its start is read.

HumanOrchestrationView#

Rules of human orchestration of an environment.

identityrequired

string

How operators are identified: declared or jwt.

hazardous_confirmationrequired

array of string

Roles confirming a hazardous telecommand, in order: operator, supervisor.

hazardous_requires_planrequired

boolean

Whether runs with a hazardous telecommand must be planned on a pass.

InputArg#

An input value as written: 28 V, TCU2, true, 3.

one of boolean | number · double | string

InputView#

An input of a procedure.

namerequired

string

Name.

kindrequired

string

value, file_id or content.

type

string

Type, or file type for file_id.

unit

string

Unit.

valuesrequired

array of string

Values of an enum.

InstanceDetail#

Body of GET /v1/instances/{kind}/{instance}.

kindrequired

string

Kind: driver, gateway, or an MCS component.

instancerequired

string

Instance name.

softwarerequired

string

Software.

versionrequired

string

Version.

registered_atrequired

string · date-time

Registration.

last_seenrequired

string · date-time

Last registration or heartbeat.

aliverequired

boolean

Whether heard within three heartbeat periods.

health

one of Health | null

reason

string

Why degraded.

link_available

boolean

For a gateway: whether its link is available.

catalogue

string

For a driver: catalogue implemented, name@version.

tagsrequired

array of string

For a gateway: tags.

uplink

string

For a gateway: uplink and downlink types and theoretical rates.

downlink

string

Downlink.

frames

string

For a transport: what it frames and produces, csp1 → can.

boundrequired

array of string

Links bound to it: <target>.<link>.

heartbeat_period_msrequired

integer · int64

Heartbeat period, in milliseconds.

≥ 0

public_keyrequired

string

Public key of its nkey.

driver

one of DriverDetail | null

gateway

one of GatewayDetail | null

status

one of Status | null

status_error

string

Why the status could not be asked.

bindingsrequired

array of BindingDetail

Links bound to it.

BindingDetail · 10 fields
targetrequired

string

Target.

linkrequired

string

Link.

driverrequired

string

Driver bound.

transport

string

Transport bound, when the link has one.

gatewayrequired

string

Gateway bound.

configrequired

string

Configuration revision of the target.

config_currentrequired

boolean

Whether it is the current configuration.

encoderequired

string

Subject of the telecommands to encode.

uplinkrequired

string

Subject of the frames to uplink.

consumer

one of ConsumerStats | null

InstancesView#

Body of GET /v1/instances.

instancesrequired

array of InstanceView

Instances registered, drivers and gateways first.

InstanceView · 16 fields
kindrequired

string

Kind: driver, gateway, or an MCS component.

instancerequired

string

Instance name.

softwarerequired

string

Software.

versionrequired

string

Version.

registered_atrequired

string · date-time

Registration.

last_seenrequired

string · date-time

Last registration or heartbeat.

aliverequired

boolean

Whether heard within three heartbeat periods.

health

one of Health | null

reason

string

Why degraded.

link_available

boolean

For a gateway: whether its link is available.

catalogue

string

For a driver: catalogue implemented, name@version.

tagsrequired

array of string

For a gateway: tags.

uplink

string

For a gateway: uplink and downlink types and theoretical rates.

downlink

string

Downlink.

frames

string

For a transport: what it frames and produces, csp1 → can.

boundrequired

array of string

Links bound to it: <target>.<link>.

InstanceView#

An instance registered with the reconciler.

kindrequired

string

Kind: driver, gateway, or an MCS component.

instancerequired

string

Instance name.

softwarerequired

string

Software.

versionrequired

string

Version.

registered_atrequired

string · date-time

Registration.

last_seenrequired

string · date-time

Last registration or heartbeat.

aliverequired

boolean

Whether heard within three heartbeat periods.

health

one of Health | null

reason

string

Why degraded.

link_available

boolean

For a gateway: whether its link is available.

catalogue

string

For a driver: catalogue implemented, name@version.

tagsrequired

array of string

For a gateway: tags.

uplink

string

For a gateway: uplink and downlink types and theoretical rates.

downlink

string

Downlink.

frames

string

For a transport: what it frames and produces, csp1 → can.

boundrequired

array of string

Links bound to it: <target>.<link>.

Journal#

Body of GET /v1/reconciler/events.

eventsrequired

array of Entry

Entries, newest first.

Entry · 9 fields
atrequired

string · date-time

When the reconciler made the change.

targetrequired

string

Target.

link

string

Link, for a change of a link.

changerequired

Change

What changed.

one of bound unbound rebound ready not_ready revision

driver

string

Driver bound after the change.

transport

string

Transport bound after the change.

gateway

string

Gateway bound after the change.

config

string

Configuration revision of the target after the change.

reasons

array of string

Why, in the words of the readiness: the reasons of the target or of the link.

truncatedrequired

boolean

Whether older entries of the window were left out by the limit.

LeaseView#

Runs holding a target.

runsrequired

array of string

Runs.

sharedrequired

boolean

Whether shared by runs that do not change the on-board state.

LinkCapability#

Physical link in one direction.

link_typerequired

string

Link type: rf, can, rs422, ethernet, sim…

rate_bpsrequired

integer · uint64

Theoretical throughput, in bits per second.

≥ 0

LinkView#

A link, as declared and as bound.

namerequired

string

Name.

defaultrequired

boolean

Whether it is the default link.

driverrequired

string

Driver required: package@versions.

transport

string

Transport required, when the link has one: package@versions.

gatewayrequired

string

Gateway required: an instance, or any(tag: …).

bound

one of BoundView | null

available

boolean

Whether its gateway reports the link available (in pass, station in service).

MeasureView#

A measure.

namerequired

string

Name.

description

string

Description, from the catalogue.

typerequired

string

Type.

unit

string

Unit.

soft

array of number · double

Soft limits, [low, high].

hard

array of number · double

Hard limits.

derivedrequired

boolean

Whether derived from other measures.

ModeRequest#

Body of PUT /v1/targets/{target}/mode.

moderequired

string

Mode to set.

ModeView#

Body of GET and PUT /v1/targets/{target}/mode.

targetrequired

string

Target.

mode

string

Mode the target is in; None when the topology declares no modes.

default

string

Default mode of the topology.

modesrequired

array of string

Modes of the topology, in their order.

since

string · date-time

When the mode was last set; None for the default mode never set.

by

string

Who set it.

run

string

Run that set it, at the end of a configure.

NatsCredentials#

Reply of POST /v1/auth/nats.

jwtrequired

string

NATS user JWT.

expiresrequired

integer · int64

Expiry (seconds since the epoch).

NatsRequest#

Body of POST /v1/auth/nats.

public_keyrequired

string

Public nkey of the user (U…) the credentials are for.

OnboardFile#

A file of the on-board directory, as last listed.

idrequired

string

Identifier.

file_type

string

Type (lttm, log…).

size

integer · int64

Size, in bytes.

≥ 0

checksum

string

Checksum, hexadecimal.

generation

integer · int64

Generation: a file rewritten on board gets the next one.

≥ 0

transfer

string

State of its transfer.

listed_at

string · date-time

Last listing.

ParametersView#

Body of GET /v1/targets/{target}/parameters.

targetrequired

string

Target.

mode

string

Mode the target is in.

environment

string

Environment of the values; None: without overrides.

parametersrequired

array of ParameterView

Parameters of its components, in the order of the catalogue.

ParameterView · 9 fields
namerequired

string

Written in full: rf.tx_baudrate, tcu[TCU1].anode_voltage.

componentrequired

string

Component.

instance

string

Instance of a multi-instance component.

parameterrequired

string

Parameter.

unit

string

Unit of its values.

value

any

Value in the mode of the target; None without one.

valuesrequired

map of any

Values by mode.

set

string

Telecommand setting it, configure sends.

readback

one of Readback | null

ParameterView#

A parameter of a target and its values.

namerequired

string

Written in full: rf.tx_baudrate, tcu[TCU1].anode_voltage.

componentrequired

string

Component.

instance

string

Instance of a multi-instance component.

parameterrequired

string

Parameter.

unit

string

Unit of its values.

value

any

Value in the mode of the target; None without one.

valuesrequired

map of any

Values by mode.

set

string

Telecommand setting it, configure sends.

readback

one of Readback | null

Pass#

A pass of a target over a ground station, in stellar_passes under <target>.<id>.

aosrequired

string

Acquisition of signal (UTC).

contributions

array of Pass

Contribution of each source to a merged pass, set by the MCS.

See Pass

feeder

string

Feeder that wrote it, set by the MCS.

idrequired

string

Stable identifier, given by the feeder.

losrequired

string

Loss of signal (UTC).

max_elevationrequired

string

Maximum elevation (47.3 deg).

protocol

string

Protocol (ccsds, csp, dvb-s2…).

rates

one of PassRates | null

Expected rates.

sourcerequired

PassSource

Source.

stationrequired

string

Ground station.

statusrequired

PassStatus

Status.

targetrequired

string

Target.

transceiver

string

On-board transceiver (sband, xband…).

updated_at

string

Last update, set by the MCS.

uplink

boolean

Whether telecommands can be sent; a receive-only pass refuses any send.

Passes#

Body of GET /v1/passes.

passesrequired

array of PassView

Passes, by AOS.

PassView · 2 fields
passrequired

Pass

Pass.

Pass · 15 fields
aosrequired

string

Acquisition of signal (UTC).

contributions

array of Pass

Contribution of each source to a merged pass, set by the MCS.

See Pass

feeder

string

Feeder that wrote it, set by the MCS.

idrequired

string

Stable identifier, given by the feeder.

losrequired

string

Loss of signal (UTC).

max_elevationrequired

string

Maximum elevation (47.3 deg).

protocol

string

Protocol (ccsds, csp, dvb-s2…).

rates

one of PassRates | null

Expected rates.

sourcerequired

PassSource

Source.

stationrequired

string

Ground station.

statusrequired

PassStatus

Status.

targetrequired

string

Target.

transceiver

string

On-board transceiver (sband, xband…).

updated_at

string

Last update, set by the MCS.

uplink

boolean

Whether telecommands can be sent; a receive-only pass refuses any send.

gateway

one of PassGateway | null

PassFilter#

Passes a rule applies to.

min_elevation

string

Lowest maximum elevation (20 deg).

station

string

Ground station.

status

one of PassStatus | null

Status of the pass (booked).

uplink

boolean

Whether the pass must allow the uplink.

PassGateway#

Gateway of a pass, checked by the reconciler before the AOS, in stellar_pass_gateways under <target>.<id>.

checked_atrequired

string

Time of the check.

gateway

string

Gateway registered for the station, healthy.

reason

string

Why none is.

PassRates#

Expected rates of a pass.

downlink

string

Downlink rate (2 Mbps).

uplink

string

Uplink rate (64 kbps).

PassSource#

Source of a pass.

one of string | string

PassStatus#

Status of a pass.

one of string | string | string

PassView#

A pass and the gateway checked for it.

passrequired

Pass

Pass.

Pass · 15 fields
aosrequired

string

Acquisition of signal (UTC).

contributions

array of Pass

Contribution of each source to a merged pass, set by the MCS.

See Pass

feeder

string

Feeder that wrote it, set by the MCS.

idrequired

string

Stable identifier, given by the feeder.

losrequired

string

Loss of signal (UTC).

max_elevationrequired

string

Maximum elevation (47.3 deg).

protocol

string

Protocol (ccsds, csp, dvb-s2…).

rates

one of PassRates | null

Expected rates.

sourcerequired

PassSource

Source.

stationrequired

string

Ground station.

statusrequired

PassStatus

Status.

targetrequired

string

Target.

transceiver

string

On-board transceiver (sband, xband…).

updated_at

string

Last update, set by the MCS.

uplink

boolean

Whether telecommands can be sent; a receive-only pass refuses any send.

gateway

one of PassGateway | null

Pending#

A question or a decision waiting for an operator.

pathrequired

string

Step asking.

kindrequired

string

ask or decision.

promptrequired

string

Question, or why a decision is needed.

role

string

Role whose confirmation is awaited, for a hazardous telecommand.

PlanValidation#

Validation of a plan by a supervisor: what was validated, which any change invalidates.

aosrequired

string

AOS of the pass validated.

atrequired

string

Time of the validation.

byrequired

string

Supervisor.

irrequired

string

Hash of the resolved run validated: procedure, inputs, targets.

losrequired

string

LOS of the pass validated.

passrequired

string

Pass.

ProceduresView#

Body of GET /v1/procedures.

proceduresrequired

array of ProcedureView

Procedures of every library.

ProcedureView · 9 fields
namerequired

string

Name.

description

string

Description, from the library.

libraryrequired

string

Library package: the library of a run request.

versionrequired

string

Library version.

rolesrequired

array of RoleView

Roles and their platform.

RoleView · 2 fields
namerequired

string

Name.

platformrequired

string

Platform package.

inputsrequired

array of InputView

Inputs.

InputView · 5 fields
namerequired

string

Name.

kindrequired

string

value, file_id or content.

type

string

Type, or file type for file_id.

unit

string

Unit.

valuesrequired

array of string

Values of an enum.

allowed_inrequired

array of string

Environments where it may run; empty when not restricted.

max_durationrequired

string

Longest duration.

hazardousrequired

boolean

Whether it sends a hazardous telecommand.

ProcedureView#

A procedure, as a run request names it.

namerequired

string

Name.

description

string

Description, from the library.

libraryrequired

string

Library package: the library of a run request.

versionrequired

string

Library version.

rolesrequired

array of RoleView

Roles and their platform.

RoleView · 2 fields
namerequired

string

Name.

platformrequired

string

Platform package.

inputsrequired

array of InputView

Inputs.

InputView · 5 fields
namerequired

string

Name.

kindrequired

string

value, file_id or content.

type

string

Type, or file type for file_id.

unit

string

Unit.

valuesrequired

array of string

Values of an enum.

allowed_inrequired

array of string

Environments where it may run; empty when not restricted.

max_durationrequired

string

Longest duration.

hazardousrequired

boolean

Whether it sends a hazardous telecommand.

Readback#

The readback of a parameter.

measurerequired

string

Measure.

sample

one of Sample | null

matches

boolean

Whether it has the value of the mode (within the tolerance of the parameter); None without a sample or a value.

Replaced#

What a replace_window did.

upsertedrequired

array of string

Passes written, as stored.

cancelledrequired

array of string

Passes whose contribution of the source was cancelled, as stored.

ReplaceWindow#

Body of POST /v1/passes/replace_window: a complete snapshot of a source for a target over an interval.

sourcerequired

PassSource

Source of the snapshot.

targetrequired

string

Target.

fromrequired

string · date-time

Start of the interval.

torequired

string · date-time

End of the interval.

passesrequired

array of Pass

Every pass of the source in the interval.

Pass · 15 fields
aosrequired

string

Acquisition of signal (UTC).

contributions

array of Pass

Contribution of each source to a merged pass, set by the MCS.

See Pass

feeder

string

Feeder that wrote it, set by the MCS.

idrequired

string

Stable identifier, given by the feeder.

losrequired

string

Loss of signal (UTC).

max_elevationrequired

string

Maximum elevation (47.3 deg).

protocol

string

Protocol (ccsds, csp, dvb-s2…).

rates

one of PassRates | null

Expected rates.

sourcerequired

PassSource

Source.

stationrequired

string

Ground station.

statusrequired

PassStatus

Status.

targetrequired

string

Target.

transceiver

string

On-board transceiver (sband, xband…).

updated_at

string

Last update, set by the MCS.

uplink

boolean

Whether telecommands can be sent; a receive-only pass refuses any send.

Resume#

Body of POST /v1/runs/{id}/resume.

choicerequired

string

replay the step where the run stopped, skip it, fail it (the if failed blocks run), or abort the run.

RoleView#

A role of a procedure.

namerequired

string

Name.

platformrequired

string

Platform package.

Rules#

Body of GET /v1/schedule-rules.

rulesrequired

array of ScheduleRule

Rules, by identifier.

ScheduleRule · 10 fields
by

string

Who created it.

environment

string

Environment; by default the last environment of the target.

filter

PassFilter

Passes it applies to.

PassFilter · 4 fields
min_elevation

string

Lowest maximum elevation (20 deg).

station

string

Ground station.

status

one of PassStatus | null

Status of the pass (booked).

uplink

boolean

Whether the pass must allow the uplink.

idrequired

string

Identifier.

inputs

object

Input values, as written in a run request.

library

string

Library of the procedure, when several have a procedure of that name.

runrequired

string

Procedure.

startrequired

string

Start relative to the AOS: aos, aos + 30 s.

targetrequired

string

Target of the passes.

targetsrequired

map of string

Target of each role.

RunEvent#

An event of a run, published on stellar.run.evt.<run_id>: the log of the run.

atrequired

string

Time of the event.

runrequired

string

Run.

seqrequired

integer · uint64

Position in the log, from 1.

≥ 0

RunReply#

Body of the reply to a launched run.

runrequired

string

Identifier of the run.

irrequired

string

Hash of the resolved run in stellar_ir.

warnings

array of string

What the operator should know: a run that may end after the LOS of the pass in progress.

RunRequest#

A run request, as the API, the CLI and the scheduler write it.

runrequired

string

Procedure.

library

string

Library of the procedure, when several have a procedure of that name.

environmentrequired

string

Environment.

targetsrequired

map of string

Target of each role.

inputs

map of InputArg

Input values.

plan

string

Pass the run is planned on, set by the scheduler.

faults

array of FaultRequest

Faults of the simulations to switch on during the run: simulated targets only.

FaultRequest · 4 fields
targetrequired

string

Role of the target, as in targets.

faultrequired

string

Fault, as the simulation of the target names it.

at

Trigger

When it is switched on: after the start of the run, or of the first entry in a step.

Trigger · 2 fields
step

string

Step whose first entry starts the delay: its name (Plateau), or its path (TVAC cycle / Plateau).

after

string

Delay.

off

one of Trigger | null

Runs#

Body of GET /v1/runs.

runsrequired

array of RunSummary

Runs, newest first.

RunSummary · 12 fields
runrequired

string

Run.

procedurerequired

string

Procedure.

step

string

Step running or last run.

suspendedrequired

boolean

Whether it is suspended.

pending

one of Pending | null

finished

boolean

Outcome, once finished.

reason

string

Why it failed.

environmentrequired

string

Environment.

targetsrequired

map of string

Target of each role.

by

string

Who launched it.

started_at

string · date-time

Start.

updated_at

string · date-time

Last event.

RunStatus#

State of a run, from its log.

runrequired

string

Run.

procedurerequired

string

Procedure.

step

string

Step running or last run.

suspendedrequired

boolean

Whether it is suspended.

pending

one of Pending | null

finished

boolean

Outcome, once finished.

reason

string

Why it failed.

RunSummary#

A run in the list of the recent runs.

runrequired

string

Run.

procedurerequired

string

Procedure.

step

string

Step running or last run.

suspendedrequired

boolean

Whether it is suspended.

pending

one of Pending | null

finished

boolean

Outcome, once finished.

reason

string

Why it failed.

environmentrequired

string

Environment.

targetsrequired

map of string

Target of each role.

by

string

Who launched it.

started_at

string · date-time

Start.

updated_at

string · date-time

Last event.

Sample#

A measure sample, published by the compute stage on stellar.param.<target>.<component>.<instance>.<measure>.

deliveryrequired

string

realtime or deferred; deferred when any input of a derived measure is.

ground_timerequired

string

Ground reception time, reference of freshness; for a derived measure, that of its oldest input.

linkrequired

string

Link of the frame; for a derived measure, that of its most recent input.

raw

any

Raw value of a measure calibrated by the MCS.

timerequired

string

Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.

valuerequired

any

Physical value: number in the unit of the measure, boolean, enum value, hexadecimal bytes; null when a temporal derived measure becomes unknown (empty window).

Schedule#

A run bound to a pass, in stellar_schedule under its identifier.

by

string

Who created it.

environment

string

Environment; by default the last environment of the target of the pass.

fire_at

string

Start time from the current pass, set by the MCS.

idrequired

string

Identifier.

inputs

object

Input values, as written in a run request.

ir

string

Hash of the resolved run, set by the MCS.

library

string

Library of the procedure, when several have a procedure of that name.

max_duration

string

Maximum duration of the run, set by the MCS.

needs_validation

boolean

Whether a supervisor must validate the plan before it starts: a hazardous telecommand in an environment where the supervisor confirms. Set by the MCS.

default false

passrequired

string

Pass.

reasons

array of string

Why at risk, cancelled or missed.

runrequired

string

Procedure.

run_id

string

Run submitted, set by the MCS.

sends

boolean

Whether the run sends telecommands, set by the MCS.

default false

startrequired

string

Start relative to the AOS: aos, aos + 30 s.

state

ScheduleState

State, set by the MCS.

target

string

Target of the pass, set by the MCS.

targetsrequired

map of string

Target of each role.

updated_at

string

Last change.

validation

one of PlanValidation | null

Validation of the plan, while it holds.

ScheduleRule#

A recurring rule, in stellar_schedule_rules: every pass of target matching filter gets the schedule <rule>-<pass>.

by

string

Who created it.

environment

string

Environment; by default the last environment of the target.

filter

PassFilter

Passes it applies to.

PassFilter · 4 fields
min_elevation

string

Lowest maximum elevation (20 deg).

station

string

Ground station.

status

one of PassStatus | null

Status of the pass (booked).

uplink

boolean

Whether the pass must allow the uplink.

idrequired

string

Identifier.

inputs

object

Input values, as written in a run request.

library

string

Library of the procedure, when several have a procedure of that name.

runrequired

string

Procedure.

startrequired

string

Start relative to the AOS: aos, aos + 30 s.

targetrequired

string

Target of the passes.

targetsrequired

map of string

Target of each role.

Schedules#

Body of GET /v1/schedules.

schedulesrequired

array of Schedule

Schedules, by start.

Schedule · 20 fields
by

string

Who created it.

environment

string

Environment; by default the last environment of the target of the pass.

fire_at

string

Start time from the current pass, set by the MCS.

idrequired

string

Identifier.

inputs

object

Input values, as written in a run request.

ir

string

Hash of the resolved run, set by the MCS.

library

string

Library of the procedure, when several have a procedure of that name.

max_duration

string

Maximum duration of the run, set by the MCS.

needs_validation

boolean

Whether a supervisor must validate the plan before it starts: a hazardous telecommand in an environment where the supervisor confirms. Set by the MCS.

default false

passrequired

string

Pass.

reasons

array of string

Why at risk, cancelled or missed.

runrequired

string

Procedure.

run_id

string

Run submitted, set by the MCS.

sends

boolean

Whether the run sends telecommands, set by the MCS.

default false

startrequired

string

Start relative to the AOS: aos, aos + 30 s.

state

ScheduleState

State, set by the MCS.

target

string

Target of the pass, set by the MCS.

targetsrequired

map of string

Target of each role.

updated_at

string

Last change.

validation

one of PlanValidation | null

Validation of the plan, while it holds.

ScheduleState#

State of a schedule.

one of string | string | string | string | string

Shelve#

Body of POST /v1/alarms/{target}/{alarm}/shelve.

forrequired

string

example 30 min

SignIn#

How the web console signs its users in at the identity provider.

issuerrequired

string

OpenID Connect issuer: its discovery document is <issuer>/.well-known/openid-configuration.

client_idrequired

string

Public client of the console (authorization code with PKCE).

cli_client_id

string

Public client of the CLI (device authorization grant, stellar login), if any.

organization

string

Organization (Logto) whose token the console asks for, its audience urn:logto:organization:<organization>; none: the token of the sign-in itself.

scopesrequired

array of string

Scopes to ask beyond those of OpenID: the roles of the MCS with auth.roles_prefix (stellar:operator), which the provider puts in the token only when asked.

Software#

Software of an instance.

namerequired

string

Name, such as platform-v3-ccsds.

versionrequired

string

Semantic version, such as 3.1.0.

Status#

Reply to the status control verb.

boundrequired

boolean

Whether the instance holds a JWT issued by the reconciler.

heartbeatrequired

Heartbeat

Last heartbeat content.

Heartbeat · 4 fields
healthrequired

Health

Health.

link_available

boolean

For a gateway: whether its link is available (satellite in view, station in service). A gateway without this notion always reports true.

reason

string

Why the instance is degraded.

sent_atrequired

string

Emission time.

instancerequired

string

Instance.

kindrequired

string

Kind.

softwarerequired

Software

Software.

Software · 2 fields
namerequired

string

Name, such as platform-v3-ccsds.

versionrequired

string

Semantic version, such as 3.1.0.

started_atrequired

string

Start time.

StoredContent#

Reply of POST /v1/uploads.

hashrequired

string

Hexadecimal SHA-256: the value of a file input.

sizerequired

integer · int64

Size, in bytes.

≥ 0

Submission#

Body of POST /v1/tc.

targetrequired

string

Target.

telecommandrequired

string

Telecommand: its name alone when unique in the platform, else component.name.

instance

string

Instance of a multi-instance component, or file id for files.

args

map of InputArg

Arguments: 100 V, enum values, booleans, hexadecimal bytes.

link

string

Link, when not the default one.

environment

string

Environment, which selects the parameters of the link; required when the link overrides them by environment and the target is engaged in several.

id

string

Identifier chosen by the client, to make the submission idempotent.

SubmissionReply#

Body of the reply to an accepted submission.

idrequired

string

Identifier of the telecommand.

duplicaterequired

boolean

Whether the same identifier was already submitted: nothing new is sent.

Switch#

Body of PUT /v1/sim/{gateway}/faults/{fault}.

activerequired

boolean

TargetView#

A target and its state.

namerequired

string

Name.

platformrequired

string

Platform, package@version.

environmentsrequired

array of string

Environments where it can be engaged.

linksrequired

array of LinkView

Links.

LinkView · 7 fields
namerequired

string

Name.

defaultrequired

boolean

Whether it is the default link.

driverrequired

string

Driver required: package@versions.

transport

string

Transport required, when the link has one: package@versions.

gatewayrequired

string

Gateway required: an instance, or any(tag: …).

bound

one of BoundView | null

available

boolean

Whether its gateway reports the link available (in pass, station in service).

ready

boolean

Whether it can be engaged; None when the reconciler published nothing yet.

reasonsrequired

array of string

Why it is not ready.

config

string

Configuration revision it runs with.

lease

one of LeaseView | null

TcEvent#

A transition of a telecommand, published on stellar.tc.evt.<target>.<tc_id>.

atrequired

string

Time of the transition.

conforming

boolean

For an ECHO event: whether the echo conforms.

detail

string

Explanation: failed precondition, error of the driver or the gateway, echo…

staterequired

TcState

New state.

tcrequired

string

Telecommand.

telecommand

one of TcRef | null

For a PENDING event: the telecommand, for sent_at in derived measures.

TcRef#

A telecommand of a component instance.

componentrequired

string

Component.

instance

string

Instance.

telecommandrequired

string

Telecommand.

TcState#

State of a telecommand (spec « Cycle de vie d'une TC »).

one of string | string | string | string | string | string | string | string | string | string | string

TcWatched#

An event of a telecommand, with its target: a message of GET /v1/tc/watch.

targetrequired

string

Target of the telecommand.

eventrequired

TcEvent

The event.

TcEvent · 6 fields
atrequired

string

Time of the transition.

conforming

boolean

For an ECHO event: whether the echo conforms.

detail

string

Explanation: failed precondition, error of the driver or the gateway, echo…

staterequired

TcState

New state.

tcrequired

string

Telecommand.

telecommand

one of TcRef | null

For a PENDING event: the telecommand, for sent_at in derived measures.

TelecommandView#

A telecommand.

namerequired

string

Name.

description

string

Description, from the catalogue.

argsrequired

array of ArgumentView

Arguments.

ArgumentView · 7 fields
namerequired

string

Name.

description

string

Description, from the catalogue.

typerequired

string

Type.

unit

string

Unit.

valuesrequired

array of string

Values of an enum.

range

array of number · double

Accepted range.

default

string

Value when omitted, as written.

changes_staterequired

boolean

Whether it changes the on-board state.

hazardousrequired

boolean

Whether it needs a confirmation.

ThroughputReport#

Throughput of a gateway for one target, published on stellar.metrics.<gateway>.<target>.

downlink_bpsrequired

number · double

Mean downlink throughput over the window, in bits per second.

downlink_bytesrequired

integer · uint64

Bytes received from the target since the gateway started.

≥ 0

uplink_bpsrequired

number · double

Mean uplink throughput over the window, in bits per second.

uplink_bytesrequired

integer · uint64

Bytes sent to the target since the gateway started.

≥ 0

window_msrequired

integer · uint64

Length of the window, in milliseconds.

≥ 0

ThroughputView#

A throughput report of a gateway for one target.

downlink_bpsrequired

number · double

Mean downlink throughput over the window, in bits per second.

downlink_bytesrequired

integer · uint64

Bytes received from the target since the gateway started.

≥ 0

uplink_bpsrequired

number · double

Mean uplink throughput over the window, in bits per second.

uplink_bytesrequired

integer · uint64

Bytes sent to the target since the gateway started.

≥ 0

window_msrequired

integer · uint64

Length of the window, in milliseconds.

≥ 0

targetrequired

string

Target.

atrequired

string · date-time

Reception by the API.

TopologyView#

Body of GET /v1/topology.

configrequired

string

Current configuration revision.

environmentsrequired

array of string

Environments.

policiesrequired

map of EnvironmentPolicy

Policies of each environment.

EnvironmentPolicy · 2 fields
allow_draftrequired

boolean

Whether draft packages are accepted.

human_orchestration
targetsrequired

array of TargetView

Targets.

TargetView · 8 fields
namerequired

string

Name.

platformrequired

string

Platform, package@version.

environmentsrequired

array of string

Environments where it can be engaged.

linksrequired

array of LinkView

Links.

LinkView · 7 fields
namerequired

string

Name.

defaultrequired

boolean

Whether it is the default link.

driverrequired

string

Driver required: package@versions.

transport

string

Transport required, when the link has one: package@versions.

gatewayrequired

string

Gateway required: an instance, or any(tag: …).

bound

one of BoundView | null

available

boolean

Whether its gateway reports the link available (in pass, station in service).

ready

boolean

Whether it can be engaged; None when the reconciler published nothing yet.

reasonsrequired

array of string

Why it is not ready.

config

string

Configuration revision it runs with.

lease

one of LeaseView | null

Transfer#

A file transfer, in stellar_transfers under <target>.<file_id>.<generation>.

by

string

Who asked for it.

checksum

string

Checksum of the whole file, hexadecimal, as listed.

created_atrequired

string

Creation.

direction
file_idrequired

string

File identifier.

file_type

string

Type of the file (lttm…).

generationrequired

integer · uint64

Generation of the file.

≥ 0

priority

integer · int32

Priority: higher first.

default 0

reason

string

Why corrupted or superseded.

received

array of array of integer · uint64

Ranges received, [start, end) in bytes, sorted and disjoint.

sizerequired

integer · uint64

Size, in bytes.

≥ 0

source

string

Content uploaded: its hexadecimal SHA-256 in [UPLOADS_STORE].

state
targetrequired

string

Target.

updated_atrequired

string

Last change.

TransferDirection#

Direction of a transfer.

one of string | string

Transfers#

Body of GET /v1/transfers.

transfersrequired

array of Transfer

Transfers, by priority then age.

Transfer · 15 fields
by

string

Who asked for it.

checksum

string

Checksum of the whole file, hexadecimal, as listed.

created_atrequired

string

Creation.

direction
file_idrequired

string

File identifier.

file_type

string

Type of the file (lttm…).

generationrequired

integer · uint64

Generation of the file.

≥ 0

priority

integer · int32

Priority: higher first.

default 0

reason

string

Why corrupted or superseded.

received

array of array of integer · uint64

Ranges received, [start, end) in bytes, sorted and disjoint.

sizerequired

integer · uint64

Size, in bytes.

≥ 0

source

string

Content uploaded: its hexadecimal SHA-256 in [UPLOADS_STORE].

state
targetrequired

string

Target.

updated_atrequired

string

Last change.

TransferState#

State of a transfer (spec « Téléchargement »), the value of files[f].transfer.

one of string | string | string | string | string | string | string

Trigger#

When a scheduled fault switches: after a delay from the start of the run (or from its switching on, for off), or from the first entry in the step step.

step

string

Step whose first entry starts the delay: its name (Plateau), or its path (TVAC cycle / Plateau).

after

string

Delay.

Values#

Body of GET /v1/targets/{target}/values.

valuesrequired

array of CurrentValue

Current values, by key order.

CurrentValue · 4 fields
componentrequired

string

Component.

instance

string

Instance of a multi-instance component.

measurerequired

string

Measure or derived measure.

samplerequired

Sample

Latest sample.

Sample · 6 fields
deliveryrequired

string

realtime or deferred; deferred when any input of a derived measure is.

ground_timerequired

string

Ground reception time, reference of freshness; for a derived measure, that of its oldest input.

linkrequired

string

Link of the frame; for a derived measure, that of its most recent input.

raw

any

Raw value of a measure calibrated by the MCS.

timerequired

string

Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.

valuerequired

any

Physical value: number in the unit of the measure, boolean, enum value, hexadecimal bytes; null when a temporal derived measure becomes unknown (empty window).

↑↓ to moveEnter to open