Alarm#
An alarm and its current state.
alarmrequiredstring
Alarm: its name, or the measure of the limits.
componentrequiredstring
Component.
instancestring
Component instance.
targetrequiredstring
Target.
recordrequiredCurrent state.
AlarmRecord · 10 fields
active_since string
Start of the activation.
bystring
Operator of the last transition, when not the condition.
causeCause of the last transition.
changed_at string
Last transition.
previousState before the last transition.
seqrequiredinteger · uint64
Number of the last transition, from 1; the transition event bears it.
severityone 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.
staterequiredState.
valueany
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>).
alarmrequiredstring
Alarm: its name, or the measure of the limits.
atrequiredstring
Time of the transition.
bystring
Operator, for an acknowledgement or a shelving.
causerequiredCause.
componentrequiredstring
Component.
instancestring
Component instance.
previousrequiredState before.
seqrequiredinteger · uint64
Number of the transition.
severityone of AlarmSeverity | null
Severity of the activation.
shelved_until string
End of the shelving in progress.
staterequiredState after.
targetrequiredstring
Target.
valueany
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.
bystring
Operator of the last transition, when not the condition.
causeCause of the last transition.
changed_at string
Last transition.
previousState before the last transition.
seqrequiredinteger · uint64
Number of the last transition, from 1; the transition event bears it.
severityone 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.
staterequiredState.
valueany
Value of the measure at the last transition, for the alarm of its limits.
AlarmRef#
An alarm of a target: (component, instance, alarm).
alarmrequiredstring
Alarm: its name, or the measure of the limits.
componentrequiredstring
Component.
instancestring
Component instance.
Alarms#
Body of GET /v1/alarms.
alarmsrequiredarray of Alarm
Alarms, by key order.
Alarm · 5 fields
alarmrequiredstring
Alarm: its name, or the measure of the limits.
componentrequiredstring
Component.
instancestring
Component instance.
targetrequiredstring
Target.
recordrequiredCurrent state.
AlarmRecord · 10 fields
active_since string
Start of the activation.
bystring
Operator of the last transition, when not the condition.
causeCause of the last transition.
changed_at string
Last transition.
previousState before the last transition.
seqrequiredinteger · uint64
Number of the last transition, from 1; the transition event bears it.
severityone 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.
staterequiredState.
valueany
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.
pathrequiredstring
Step asking, as in its asked or decision_required event.
acceptedrequiredboolean
Whether the operator confirms.
valueany
Typed answer, or decision: replay, skip, fail or abort.
ArgumentView#
An argument of a telecommand.
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
typerequiredstring
Type.
unitstring
Unit.
valuesrequiredarray of string
Values of an enum.
rangearray of number · double
Accepted range.
defaultstring
Value when omitted, as written.
AuthSettings#
Reply of GET /v1/auth/config.
oidcone of SignIn | null
BindingDetail#
A link bound to an instance, and the consumer of the telecommands it takes.
targetrequiredstring
Target.
linkrequiredstring
Link.
driverrequiredstring
Driver bound.
transportstring
Transport bound, when the link has one.
gatewayrequiredstring
Gateway bound.
configrequiredstring
Configuration revision of the target.
config_current requiredboolean
Whether it is the current configuration.
encoderequiredstring
Subject of the telecommands to encode.
uplinkrequiredstring
Subject of the frames to uplink.
consumerone of ConsumerStats | null
BoundView#
Instances bound to a link.
driverrequiredstring
Driver instance.
transportstring
Transport instance, when the link has one.
gatewayrequiredstring
Gateway instance.
CatalogueView#
Body of GET /v1/targets/{target}/catalogue.
platformrequiredstring
Platform, package@version.
componentsrequiredarray of ComponentView
Components.
ComponentView · 5 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
instancesrequiredarray of string
Instances of a multi-instance component.
measuresrequiredarray of MeasureView
Measures, derived ones included.
MeasureView · 7 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
typerequiredstring
Type.
unitstring
Unit.
softarray of number · double
Soft limits, [low, high].
hardarray of number · double
Hard limits.
derivedrequiredboolean
Whether derived from other measures.
telecommandsrequiredarray of TelecommandView
Telecommands.
TelecommandView · 5 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
argsrequiredarray of ArgumentView
Arguments.
ArgumentView · 7 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
typerequiredstring
Type.
unitstring
Unit.
valuesrequiredarray of string
Values of an enum.
rangearray of number · double
Accepted range.
defaultstring
Value when omitted, as written.
changes_state requiredboolean
Whether it changes the on-board state.
hazardousrequiredboolean
Whether it needs a confirmation.
Change#
What changed.
string
ComponentView#
A component of a catalogue.
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
instancesrequiredarray of string
Instances of a multi-instance component.
measuresrequiredarray of MeasureView
Measures, derived ones included.
MeasureView · 7 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
typerequiredstring
Type.
unitstring
Unit.
softarray of number · double
Soft limits, [low, high].
hardarray of number · double
Hard limits.
derivedrequiredboolean
Whether derived from other measures.
telecommandsrequiredarray of TelecommandView
Telecommands.
TelecommandView · 5 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
argsrequiredarray of ArgumentView
Arguments.
ArgumentView · 7 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
typerequiredstring
Type.
unitstring
Unit.
valuesrequiredarray of string
Values of an enum.
rangearray of number · double
Accepted range.
defaultstring
Value when omitted, as written.
changes_state requiredboolean
Whether it changes the on-board state.
hazardousrequiredboolean
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 »).
activerequiredboolean
Whether a client is pulling the consumer now.
atrequiredstring
Computation.
at_risk requiredboolean
Whether the retention is about to remove messages the connector has not read.
connectorrequiredstring
Connector.
consumerrequiredstring
Durable consumer.
fillnumber · double
Filling of the stream against its max_bytes; None when not bounded by volume.
kindrequiredstring
Kind of data.
lag_seconds requirednumber · 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.
pendingrequiredinteger · uint64
Messages not delivered yet.
reasonstring
Why.
retention_seconds number · double
Maximum age of the stream, in seconds; None when not bounded by age.
streamrequiredstring
JetStream stream.
unackedrequiredinteger · uint64
Messages delivered and not acknowledged.
ConnectorsView#
Body of GET /v1/connectors.
connectorsrequiredarray of ConnectorView
Connectors of the topology.
ConnectorView · 5 fields
namerequiredstring
Name.
datarequiredarray of string
Kinds of data.
targetsrequiredarray of string
Targets.
instanceone of InstanceView | null
lagsrequiredarray of ConnectorLag
Lag of each consumer created.
ConnectorLag · 14 fields
activerequiredboolean
Whether a client is pulling the consumer now.
atrequiredstring
Computation.
at_risk requiredboolean
Whether the retention is about to remove messages the connector has not read.
connectorrequiredstring
Connector.
consumerrequiredstring
Durable consumer.
fillnumber · double
Filling of the stream against its max_bytes; None when not bounded by volume.
kindrequiredstring
Kind of data.
lag_seconds requirednumber · 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.
pendingrequiredinteger · uint64
Messages not delivered yet.
reasonstring
Why.
retention_seconds number · double
Maximum age of the stream, in seconds; None when not bounded by age.
streamrequiredstring
JetStream stream.
unackedrequiredinteger · uint64
Messages delivered and not acknowledged.
ConnectorView#
An output connector: as declared, its instance, and the lag of its consumers.
namerequiredstring
Name.
datarequiredarray of string
Kinds of data.
targetsrequiredarray of string
Targets.
instanceone of InstanceView | null
lagsrequiredarray of ConnectorLag
Lag of each consumer created.
ConnectorLag · 14 fields
activerequiredboolean
Whether a client is pulling the consumer now.
atrequiredstring
Computation.
at_risk requiredboolean
Whether the retention is about to remove messages the connector has not read.
connectorrequiredstring
Connector.
consumerrequiredstring
Durable consumer.
fillnumber · double
Filling of the stream against its max_bytes; None when not bounded by volume.
kindrequiredstring
Kind of data.
lag_seconds requirednumber · 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.
pendingrequiredinteger · uint64
Messages not delivered yet.
reasonstring
Why.
retention_seconds number · double
Maximum age of the stream, in seconds; None when not bounded by age.
streamrequiredstring
JetStream stream.
unackedrequiredinteger · uint64
Messages delivered and not acknowledged.
ConsumerStats#
Statistics of a durable consumer.
namerequiredstring
Name.
deliveredrequiredinteger · int64
Messages delivered and acknowledged.
pendingrequiredinteger · int64
Messages waiting to be delivered.
ack_pending requiredinteger
Messages delivered and not acknowledged yet.
redeliveredrequiredinteger
Messages delivered again.
last_active string · date-time
Last delivery.
CurrentValue#
Current value of a measure.
componentrequiredstring
Component.
instancestring
Instance of a multi-instance component.
measurerequiredstring
Measure or derived measure.
samplerequiredLatest sample.
Sample · 6 fields
deliveryrequiredstring
realtime or deferred; deferred when any input of a derived measure is.
ground_time requiredstring
Ground reception time, reference of freshness; for a derived measure, that of its oldest input.
linkrequiredstring
Link of the frame; for a derived measure, that of its most recent input.
rawany
Raw value of a measure calibrated by the MCS.
timerequiredstring
Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.
valuerequiredany
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.
targetrequiredstring
Target.
framestring
The frame in hexadecimal (56 4f 4c 54, spaces allowed); or text.
textstring
The frame as text, for a text protocol (VOLT 28.0); or frame.
linkstring
Link, when not the default one.
environmentstring
Environment, which selects the parameters of the link.
driverstring
Driver instance to ask, when not the one bound to the link.
Decoded#
Reply of POST /v1/decode.
targetrequiredstring
Target.
linkrequiredstring
Link.
driverrequiredstring
Driver instance that decoded it.
environmentstring
Environment of the parameters of the link.
samplesrequiredarray of DecodedSample
Samples, in the order the driver gives them.
DecodedSample · 7 fields
componentrequiredstring
Component.
instancestring
Instance of a multi-instance component.
measurerequiredstring
Measure.
rawrequiredany
Raw value, as the driver gives it.
valueany
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.
unitstring
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.
componentrequiredstring
Component.
instancestring
Instance of a multi-instance component.
measurerequiredstring
Measure.
rawrequiredany
Raw value, as the driver gives it.
valueany
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.
unitstring
Unit of the measure.
onboard_time string
On-board time, when the frame carries it.
Directory#
Body of GET /v1/targets/{target}/files.
componentrequiredstring
Component of the on-board directory.
filesrequiredarray of OnboardFile
Files, by identifier.
OnboardFile · 7 fields
idrequiredstring
Identifier.
file_type string
Type (lttm, log…).
sizeinteger · int64
Size, in bytes.
checksumstring
Checksum, hexadecimal.
generationinteger · int64
Generation: a file rewritten on board gets the next one.
transferstring
State of its transfer.
listed_at string · date-time
Last listing.
DownloadRequest#
Body of POST /v1/transfers.
targetrequiredstring
Target.
file_id requiredstring
File, by its on-board identifier.
priorityinteger · int32
Priority: higher first.
DriverDetail#
What a driver implements, against the current configuration.
codecrequiredstring
Codec.
cataloguerequiredstring
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.
telecommandsrequiredarray of string
Telecommands covered, component.telecommand.
measuresrequiredarray of string
Measures covered, component.measure.
missing_telecommands requiredarray of string
Telecommands of the catalogue it does not cover.
missing_measures requiredarray 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.
targetrequiredstring
Target.
telecommandrequiredstring
Telecommand: its name alone when unique in the platform, else component.name.
instancestring
Instance of a multi-instance component, or file id for files.
argsmap of InputArg
Arguments: 100 V, enum values, booleans, hexadecimal bytes.
linkstring
Link, when not the default one.
environmentstring
Environment, which selects the parameters of the link.
driverstring
Driver instance to ask, when not the one bound to the link: a driver being developed.
Encoded#
Reply of POST /v1/encode.
targetrequiredstring
Target.
linkrequiredstring
Link.
driverrequiredstring
Driver instance that encoded it.
environmentstring
Environment of the parameters of the link.
telecommandrequiredstring
The telecommand, as written: tcu[TCU1].set_mode.
argsrequiredmap of any
Its arguments, resolved: numbers in the unit of their argument, defaults applied.
framerequiredstring
The frame, in hexadecimal: the frame of the medium on a link without transport, the unit the driver hands to the transport otherwise.
sizerequiredinteger
Its size, in bytes.
textstring
The frame as text, when it is printable text (SCPI and other text protocols).
Entry#
An entry of the journal.
atrequiredstring · date-time
When the reconciler made the change.
targetrequiredstring
Target.
linkstring
Link, for a change of a link.
changerequiredWhat changed.
driverstring
Driver bound after the change.
transportstring
Transport bound after the change.
gatewaystring
Gateway bound after the change.
configstring
Configuration revision of the target after the change.
reasonsarray of string
Why, in the words of the readiness: the reasons of the target or of the link.
EnvironmentPolicy#
Policies of an environment.
allow_draft requiredboolean
Whether draft packages are accepted.
human_orchestration one of HumanOrchestrationView | null
ErrorBody#
Body of an error response.
errorsrequiredarray of ErrorItem
Every error found.
ErrorItem · 3 fields
coderequiredstring
Stable code.
messagerequiredstring
Message for the operator.
helpstring
Suggested fix.
ErrorItem#
One error.
coderequiredstring
Stable code.
messagerequiredstring
Message for the operator.
helpstring
Suggested fix.
Evidence#
A sample a condition was judged on.
componentrequiredstring
Component.
ground_time requiredstring
Ground reception time.
instancestring
Instance.
measurerequiredstring
Measure.
targetrequiredstring
Target.
timerequiredstring
Time of the sample.
valuerequiredany
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.
faults:
- {target: chamber, fault: vacuum_leak, at: {step: Plateau, after: 10 s}, off: {after: 60 s}}targetrequiredstring
Role of the target, as in targets.
faultrequiredstring
Fault, as the simulation of the target names it.
atWhen it is switched on: after the start of the run, or of the first entry in a step.
Trigger · 2 fields
stepstring
Step whose first entry starts the delay: its name (Plateau), or its path (TVAC cycle / Plateau).
afterstring
Delay.
offone of Trigger | null
GatewayDetail#
What a gateway offers.
tagsrequiredarray of string
Tags.
uplinkone of LinkCapability | null
downlinkone of LinkCapability | null
Health#
Health of an instance.
one of string | string
Heartbeat#
Heartbeat, published on stellar.ctl.hb.<kind>.<instance> every period.
healthrequiredHealth.
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.
reasonstring
Why the instance is degraded.
sent_at requiredstring
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.
componentrequiredstring
Component.
instancestring
Instance of a multi-instance component.
measurerequiredstring
Measure or derived measure.
samplesrequiredarray 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
deliveryrequiredstring
realtime or deferred; deferred when any input of a derived measure is.
ground_time requiredstring
Ground reception time, reference of freshness; for a derived measure, that of its oldest input.
linkrequiredstring
Link of the frame; for a derived measure, that of its most recent input.
rawany
Raw value of a measure calibrated by the MCS.
timerequiredstring
Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.
valuerequiredany
Physical value: number in the unit of the measure, boolean, enum value, hexadecimal bytes;
null when a temporal derived measure becomes unknown (empty window).
thinnedrequiredboolean
Whether samples were left out to keep limit.
truncatedrequiredboolean
Whether the window holds more samples than are read at once: only its start is read.
HumanOrchestrationView#
Rules of human orchestration of an environment.
identityrequiredstring
How operators are identified: declared or jwt.
hazardous_confirmation requiredarray of string
Roles confirming a hazardous telecommand, in order: operator, supervisor.
hazardous_requires_plan requiredboolean
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.
namerequiredstring
Name.
kindrequiredstring
value, file_id or content.
typestring
Type, or file type for file_id.
unitstring
Unit.
valuesrequiredarray of string
Values of an enum.
InstanceDetail#
Body of GET /v1/instances/{kind}/{instance}.
kindrequiredstring
Kind: driver, gateway, or an MCS component.
instancerequiredstring
Instance name.
softwarerequiredstring
Software.
versionrequiredstring
Version.
registered_at requiredstring · date-time
Registration.
last_seen requiredstring · date-time
Last registration or heartbeat.
aliverequiredboolean
Whether heard within three heartbeat periods.
healthone of Health | null
reasonstring
Why degraded.
link_available boolean
For a gateway: whether its link is available.
cataloguestring
For a driver: catalogue implemented, name@version.
tagsrequiredarray of string
For a gateway: tags.
uplinkstring
For a gateway: uplink and downlink types and theoretical rates.
downlinkstring
Downlink.
framesstring
For a transport: what it frames and produces, csp1 → can.
boundrequiredarray of string
Links bound to it: <target>.<link>.
heartbeat_period_ms requiredinteger · int64
Heartbeat period, in milliseconds.
public_key requiredstring
Public key of its nkey.
driverone of DriverDetail | null
gatewayone of GatewayDetail | null
statusone of Status | null
status_error string
Why the status could not be asked.
bindingsrequiredarray of BindingDetail
Links bound to it.
BindingDetail · 10 fields
targetrequiredstring
Target.
linkrequiredstring
Link.
driverrequiredstring
Driver bound.
transportstring
Transport bound, when the link has one.
gatewayrequiredstring
Gateway bound.
configrequiredstring
Configuration revision of the target.
config_current requiredboolean
Whether it is the current configuration.
encoderequiredstring
Subject of the telecommands to encode.
uplinkrequiredstring
Subject of the frames to uplink.
consumerone of ConsumerStats | null
InstancesView#
Body of GET /v1/instances.
instancesrequiredarray of InstanceView
Instances registered, drivers and gateways first.
InstanceView · 16 fields
kindrequiredstring
Kind: driver, gateway, or an MCS component.
instancerequiredstring
Instance name.
softwarerequiredstring
Software.
versionrequiredstring
Version.
registered_at requiredstring · date-time
Registration.
last_seen requiredstring · date-time
Last registration or heartbeat.
aliverequiredboolean
Whether heard within three heartbeat periods.
healthone of Health | null
reasonstring
Why degraded.
link_available boolean
For a gateway: whether its link is available.
cataloguestring
For a driver: catalogue implemented, name@version.
tagsrequiredarray of string
For a gateway: tags.
uplinkstring
For a gateway: uplink and downlink types and theoretical rates.
downlinkstring
Downlink.
framesstring
For a transport: what it frames and produces, csp1 → can.
boundrequiredarray of string
Links bound to it: <target>.<link>.
InstanceView#
An instance registered with the reconciler.
kindrequiredstring
Kind: driver, gateway, or an MCS component.
instancerequiredstring
Instance name.
softwarerequiredstring
Software.
versionrequiredstring
Version.
registered_at requiredstring · date-time
Registration.
last_seen requiredstring · date-time
Last registration or heartbeat.
aliverequiredboolean
Whether heard within three heartbeat periods.
healthone of Health | null
reasonstring
Why degraded.
link_available boolean
For a gateway: whether its link is available.
cataloguestring
For a driver: catalogue implemented, name@version.
tagsrequiredarray of string
For a gateway: tags.
uplinkstring
For a gateway: uplink and downlink types and theoretical rates.
downlinkstring
Downlink.
framesstring
For a transport: what it frames and produces, csp1 → can.
boundrequiredarray of string
Links bound to it: <target>.<link>.
Journal#
Body of GET /v1/reconciler/events.
eventsrequiredarray of Entry
Entries, newest first.
Entry · 9 fields
atrequiredstring · date-time
When the reconciler made the change.
targetrequiredstring
Target.
linkstring
Link, for a change of a link.
changerequiredWhat changed.
driverstring
Driver bound after the change.
transportstring
Transport bound after the change.
gatewaystring
Gateway bound after the change.
configstring
Configuration revision of the target after the change.
reasonsarray of string
Why, in the words of the readiness: the reasons of the target or of the link.
truncatedrequiredboolean
Whether older entries of the window were left out by the limit.
LeaseView#
Runs holding a target.
runsrequiredarray of string
Runs.
sharedrequiredboolean
Whether shared by runs that do not change the on-board state.
LinkCapability#
Physical link in one direction.
link_type requiredstring
Link type: rf, can, rs422, ethernet, sim…
rate_bps requiredinteger · uint64
Theoretical throughput, in bits per second.
LinkView#
A link, as declared and as bound.
namerequiredstring
Name.
defaultrequiredboolean
Whether it is the default link.
driverrequiredstring
Driver required: package@versions.
transportstring
Transport required, when the link has one: package@versions.
gatewayrequiredstring
Gateway required: an instance, or any(tag: …).
boundone of BoundView | null
availableboolean
Whether its gateway reports the link available (in pass, station in service).
MeasureView#
A measure.
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
typerequiredstring
Type.
unitstring
Unit.
softarray of number · double
Soft limits, [low, high].
hardarray of number · double
Hard limits.
derivedrequiredboolean
Whether derived from other measures.
ModeRequest#
Body of PUT /v1/targets/{target}/mode.
moderequiredstring
Mode to set.
ModeView#
Body of GET and PUT /v1/targets/{target}/mode.
targetrequiredstring
Target.
modestring
Mode the target is in; None when the topology declares no modes.
defaultstring
Default mode of the topology.
modesrequiredarray of string
Modes of the topology, in their order.
sincestring · date-time
When the mode was last set; None for the default mode never set.
bystring
Who set it.
runstring
Run that set it, at the end of a configure.
NatsCredentials#
Reply of POST /v1/auth/nats.
jwtrequiredstring
NATS user JWT.
expiresrequiredinteger · int64
Expiry (seconds since the epoch).
NatsRequest#
Body of POST /v1/auth/nats.
public_key requiredstring
Public nkey of the user (U…) the credentials are for.
OnboardFile#
A file of the on-board directory, as last listed.
idrequiredstring
Identifier.
file_type string
Type (lttm, log…).
sizeinteger · int64
Size, in bytes.
checksumstring
Checksum, hexadecimal.
generationinteger · int64
Generation: a file rewritten on board gets the next one.
transferstring
State of its transfer.
listed_at string · date-time
Last listing.
ParametersView#
Body of GET /v1/targets/{target}/parameters.
targetrequiredstring
Target.
modestring
Mode the target is in.
environmentstring
Environment of the values; None: without overrides.
parametersrequiredarray of ParameterView
Parameters of its components, in the order of the catalogue.
ParameterView · 9 fields
namerequiredstring
Written in full: rf.tx_baudrate, tcu[TCU1].anode_voltage.
componentrequiredstring
Component.
instancestring
Instance of a multi-instance component.
parameterrequiredstring
Parameter.
unitstring
Unit of its values.
valueany
Value in the mode of the target; None without one.
valuesrequiredmap of any
Values by mode.
setstring
Telecommand setting it, configure sends.
readbackone of Readback | null
ParameterView#
A parameter of a target and its values.
namerequiredstring
Written in full: rf.tx_baudrate, tcu[TCU1].anode_voltage.
componentrequiredstring
Component.
instancestring
Instance of a multi-instance component.
parameterrequiredstring
Parameter.
unitstring
Unit of its values.
valueany
Value in the mode of the target; None without one.
valuesrequiredmap of any
Values by mode.
setstring
Telecommand setting it, configure sends.
readbackone of Readback | null
Pass#
A pass of a target over a ground station, in stellar_passes under <target>.<id>.
aosrequiredstring
Acquisition of signal (UTC).
feederstring
Feeder that wrote it, set by the MCS.
idrequiredstring
Stable identifier, given by the feeder.
losrequiredstring
Loss of signal (UTC).
max_elevation requiredstring
Maximum elevation (47.3 deg).
protocolstring
Protocol (ccsds, csp, dvb-s2…).
ratesone of PassRates | null
Expected rates.
sourcerequiredSource.
stationrequiredstring
Ground station.
statusrequiredStatus.
targetrequiredstring
Target.
transceiverstring
On-board transceiver (sband, xband…).
updated_at string
Last update, set by the MCS.
uplinkboolean
Whether telecommands can be sent; a receive-only pass refuses any send.
Passes#
Body of GET /v1/passes.
passesrequiredarray of PassView
Passes, by AOS.
PassView · 2 fields
passrequiredPass.
Pass · 15 fields
aosrequiredstring
Acquisition of signal (UTC).
feederstring
Feeder that wrote it, set by the MCS.
idrequiredstring
Stable identifier, given by the feeder.
losrequiredstring
Loss of signal (UTC).
max_elevation requiredstring
Maximum elevation (47.3 deg).
protocolstring
Protocol (ccsds, csp, dvb-s2…).
ratesone of PassRates | null
Expected rates.
sourcerequiredSource.
stationrequiredstring
Ground station.
statusrequiredStatus.
targetrequiredstring
Target.
transceiverstring
On-board transceiver (sband, xband…).
updated_at string
Last update, set by the MCS.
uplinkboolean
Whether telecommands can be sent; a receive-only pass refuses any send.
gatewayone of PassGateway | null
PassFilter#
Passes a rule applies to.
min_elevation string
Lowest maximum elevation (20 deg).
stationstring
Ground station.
statusone of PassStatus | null
Status of the pass (booked).
uplinkboolean
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_at requiredstring
Time of the check.
gatewaystring
Gateway registered for the station, healthy.
reasonstring
Why none is.
PassRates#
Expected rates of a pass.
downlinkstring
Downlink rate (2 Mbps).
uplinkstring
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.
passrequiredPass.
Pass · 15 fields
aosrequiredstring
Acquisition of signal (UTC).
feederstring
Feeder that wrote it, set by the MCS.
idrequiredstring
Stable identifier, given by the feeder.
losrequiredstring
Loss of signal (UTC).
max_elevation requiredstring
Maximum elevation (47.3 deg).
protocolstring
Protocol (ccsds, csp, dvb-s2…).
ratesone of PassRates | null
Expected rates.
sourcerequiredSource.
stationrequiredstring
Ground station.
statusrequiredStatus.
targetrequiredstring
Target.
transceiverstring
On-board transceiver (sband, xband…).
updated_at string
Last update, set by the MCS.
uplinkboolean
Whether telecommands can be sent; a receive-only pass refuses any send.
gatewayone of PassGateway | null
Pending#
A question or a decision waiting for an operator.
pathrequiredstring
Step asking.
kindrequiredstring
ask or decision.
promptrequiredstring
Question, or why a decision is needed.
rolestring
Role whose confirmation is awaited, for a hazardous telecommand.
PlanValidation#
Validation of a plan by a supervisor: what was validated, which any change invalidates.
aosrequiredstring
AOS of the pass validated.
atrequiredstring
Time of the validation.
byrequiredstring
Supervisor.
irrequiredstring
Hash of the resolved run validated: procedure, inputs, targets.
losrequiredstring
LOS of the pass validated.
passrequiredstring
Pass.
ProceduresView#
Body of GET /v1/procedures.
proceduresrequiredarray of ProcedureView
Procedures of every library.
ProcedureView · 9 fields
namerequiredstring
Name.
descriptionstring
Description, from the library.
libraryrequiredstring
Library package: the library of a run request.
versionrequiredstring
Library version.
rolesrequiredarray of RoleView
Roles and their platform.
RoleView · 2 fields
namerequiredstring
Name.
platformrequiredstring
Platform package.
inputsrequiredarray of InputView
Inputs.
InputView · 5 fields
namerequiredstring
Name.
kindrequiredstring
value, file_id or content.
typestring
Type, or file type for file_id.
unitstring
Unit.
valuesrequiredarray of string
Values of an enum.
allowed_in requiredarray of string
Environments where it may run; empty when not restricted.
max_duration requiredstring
Longest duration.
hazardousrequiredboolean
Whether it sends a hazardous telecommand.
ProcedureView#
A procedure, as a run request names it.
namerequiredstring
Name.
descriptionstring
Description, from the library.
libraryrequiredstring
Library package: the library of a run request.
versionrequiredstring
Library version.
rolesrequiredarray of RoleView
Roles and their platform.
RoleView · 2 fields
namerequiredstring
Name.
platformrequiredstring
Platform package.
inputsrequiredarray of InputView
Inputs.
InputView · 5 fields
namerequiredstring
Name.
kindrequiredstring
value, file_id or content.
typestring
Type, or file type for file_id.
unitstring
Unit.
valuesrequiredarray of string
Values of an enum.
allowed_in requiredarray of string
Environments where it may run; empty when not restricted.
max_duration requiredstring
Longest duration.
hazardousrequiredboolean
Whether it sends a hazardous telecommand.
Readback#
The readback of a parameter.
measurerequiredstring
Measure.
sampleone of Sample | null
matchesboolean
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.
upsertedrequiredarray of string
Passes written, as stored.
cancelledrequiredarray 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.
sourcerequiredSource of the snapshot.
targetrequiredstring
Target.
fromrequiredstring · date-time
Start of the interval.
torequiredstring · date-time
End of the interval.
passesrequiredarray of Pass
Every pass of the source in the interval.
Pass · 15 fields
aosrequiredstring
Acquisition of signal (UTC).
feederstring
Feeder that wrote it, set by the MCS.
idrequiredstring
Stable identifier, given by the feeder.
losrequiredstring
Loss of signal (UTC).
max_elevation requiredstring
Maximum elevation (47.3 deg).
protocolstring
Protocol (ccsds, csp, dvb-s2…).
ratesone of PassRates | null
Expected rates.
sourcerequiredSource.
stationrequiredstring
Ground station.
statusrequiredStatus.
targetrequiredstring
Target.
transceiverstring
On-board transceiver (sband, xband…).
updated_at string
Last update, set by the MCS.
uplinkboolean
Whether telecommands can be sent; a receive-only pass refuses any send.
Resume#
Body of POST /v1/runs/{id}/resume.
choicerequiredstring
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.
namerequiredstring
Name.
platformrequiredstring
Platform package.
Rules#
Body of GET /v1/schedule-rules.
rulesrequiredarray of ScheduleRule
Rules, by identifier.
ScheduleRule · 10 fields
bystring
Who created it.
environmentstring
Environment; by default the last environment of the target.
filterPasses it applies to.
PassFilter · 4 fields
min_elevation string
Lowest maximum elevation (20 deg).
stationstring
Ground station.
statusone of PassStatus | null
Status of the pass (booked).
uplinkboolean
Whether the pass must allow the uplink.
idrequiredstring
Identifier.
inputsobject
Input values, as written in a run request.
librarystring
Library of the procedure, when several have a procedure of that name.
runrequiredstring
Procedure.
startrequiredstring
Start relative to the AOS: aos, aos + 30 s.
targetrequiredstring
Target of the passes.
targetsrequiredmap of string
Target of each role.
RunEvent#
An event of a run, published on stellar.run.evt.<run_id>: the log of the run.
atrequiredstring
Time of the event.
runrequiredstring
Run.
seqrequiredinteger · uint64
Position in the log, from 1.
RunReply#
Body of the reply to a launched run.
runrequiredstring
Identifier of the run.
irrequiredstring
Hash of the resolved run in stellar_ir.
warningsarray 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.
runrequiredstring
Procedure.
librarystring
Library of the procedure, when several have a procedure of that name.
environmentrequiredstring
Environment.
targetsrequiredmap of string
Target of each role.
inputsmap of InputArg
Input values.
planstring
Pass the run is planned on, set by the scheduler.
faultsarray of FaultRequest
Faults of the simulations to switch on during the run: simulated targets only.
FaultRequest · 4 fields
targetrequiredstring
Role of the target, as in targets.
faultrequiredstring
Fault, as the simulation of the target names it.
atWhen it is switched on: after the start of the run, or of the first entry in a step.
Trigger · 2 fields
stepstring
Step whose first entry starts the delay: its name (Plateau), or its path (TVAC cycle / Plateau).
afterstring
Delay.
offone of Trigger | null
Runs#
Body of GET /v1/runs.
runsrequiredarray of RunSummary
Runs, newest first.
RunSummary · 12 fields
runrequiredstring
Run.
procedurerequiredstring
Procedure.
stepstring
Step running or last run.
suspendedrequiredboolean
Whether it is suspended.
pendingone of Pending | null
finishedboolean
Outcome, once finished.
reasonstring
Why it failed.
environmentrequiredstring
Environment.
targetsrequiredmap of string
Target of each role.
bystring
Who launched it.
started_at string · date-time
Start.
updated_at string · date-time
Last event.
RunStatus#
State of a run, from its log.
runrequiredstring
Run.
procedurerequiredstring
Procedure.
stepstring
Step running or last run.
suspendedrequiredboolean
Whether it is suspended.
pendingone of Pending | null
finishedboolean
Outcome, once finished.
reasonstring
Why it failed.
RunSummary#
A run in the list of the recent runs.
runrequiredstring
Run.
procedurerequiredstring
Procedure.
stepstring
Step running or last run.
suspendedrequiredboolean
Whether it is suspended.
pendingone of Pending | null
finishedboolean
Outcome, once finished.
reasonstring
Why it failed.
environmentrequiredstring
Environment.
targetsrequiredmap of string
Target of each role.
bystring
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>.
deliveryrequiredstring
realtime or deferred; deferred when any input of a derived measure is.
ground_time requiredstring
Ground reception time, reference of freshness; for a derived measure, that of its oldest input.
linkrequiredstring
Link of the frame; for a derived measure, that of its most recent input.
rawany
Raw value of a measure calibrated by the MCS.
timerequiredstring
Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.
valuerequiredany
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.
bystring
Who created it.
environmentstring
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.
idrequiredstring
Identifier.
inputsobject
Input values, as written in a run request.
irstring
Hash of the resolved run, set by the MCS.
librarystring
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.
passrequiredstring
Pass.
reasonsarray of string
Why at risk, cancelled or missed.
runrequiredstring
Procedure.
run_id string
Run submitted, set by the MCS.
sendsboolean
Whether the run sends telecommands, set by the MCS.
startrequiredstring
Start relative to the AOS: aos, aos + 30 s.
stateState, set by the MCS.
targetstring
Target of the pass, set by the MCS.
targetsrequiredmap of string
Target of each role.
updated_at string
Last change.
validationone 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>.
bystring
Who created it.
environmentstring
Environment; by default the last environment of the target.
filterPasses it applies to.
PassFilter · 4 fields
min_elevation string
Lowest maximum elevation (20 deg).
stationstring
Ground station.
statusone of PassStatus | null
Status of the pass (booked).
uplinkboolean
Whether the pass must allow the uplink.
idrequiredstring
Identifier.
inputsobject
Input values, as written in a run request.
librarystring
Library of the procedure, when several have a procedure of that name.
runrequiredstring
Procedure.
startrequiredstring
Start relative to the AOS: aos, aos + 30 s.
targetrequiredstring
Target of the passes.
targetsrequiredmap of string
Target of each role.
Schedules#
Body of GET /v1/schedules.
schedulesrequiredarray of Schedule
Schedules, by start.
Schedule · 20 fields
bystring
Who created it.
environmentstring
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.
idrequiredstring
Identifier.
inputsobject
Input values, as written in a run request.
irstring
Hash of the resolved run, set by the MCS.
librarystring
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.
passrequiredstring
Pass.
reasonsarray of string
Why at risk, cancelled or missed.
runrequiredstring
Procedure.
run_id string
Run submitted, set by the MCS.
sendsboolean
Whether the run sends telecommands, set by the MCS.
startrequiredstring
Start relative to the AOS: aos, aos + 30 s.
stateState, set by the MCS.
targetstring
Target of the pass, set by the MCS.
targetsrequiredmap of string
Target of each role.
updated_at string
Last change.
validationone 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.
forrequiredstring
SignIn#
How the web console signs its users in at the identity provider.
issuerrequiredstring
OpenID Connect issuer: its discovery document is <issuer>/.well-known/openid-configuration.
client_id requiredstring
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.
organizationstring
Organization (Logto) whose token the console asks for, its audience
urn:logto:organization:<organization>; none: the token of the sign-in itself.
scopesrequiredarray 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.
namerequiredstring
Name, such as platform-v3-ccsds.
versionrequiredstring
Semantic version, such as 3.1.0.
Status#
Reply to the status control verb.
boundrequiredboolean
Whether the instance holds a JWT issued by the reconciler.
heartbeatrequiredLast heartbeat content.
Heartbeat · 4 fields
healthrequiredHealth.
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.
reasonstring
Why the instance is degraded.
sent_at requiredstring
Emission time.
instancerequiredstring
Instance.
kindrequiredstring
Kind.
softwarerequiredSoftware.
Software · 2 fields
namerequiredstring
Name, such as platform-v3-ccsds.
versionrequiredstring
Semantic version, such as 3.1.0.
started_at requiredstring
Start time.
StoredContent#
Reply of POST /v1/uploads.
hashrequiredstring
Hexadecimal SHA-256: the value of a file input.
sizerequiredinteger · int64
Size, in bytes.
Submission#
Body of POST /v1/tc.
targetrequiredstring
Target.
telecommandrequiredstring
Telecommand: its name alone when unique in the platform, else component.name.
instancestring
Instance of a multi-instance component, or file id for files.
argsmap of InputArg
Arguments: 100 V, enum values, booleans, hexadecimal bytes.
linkstring
Link, when not the default one.
environmentstring
Environment, which selects the parameters of the link; required when the link overrides them by environment and the target is engaged in several.
idstring
Identifier chosen by the client, to make the submission idempotent.
SubmissionReply#
Body of the reply to an accepted submission.
idrequiredstring
Identifier of the telecommand.
duplicaterequiredboolean
Whether the same identifier was already submitted: nothing new is sent.
Switch#
Body of PUT /v1/sim/{gateway}/faults/{fault}.
activerequiredboolean
TargetView#
A target and its state.
namerequiredstring
Name.
platformrequiredstring
Platform, package@version.
environmentsrequiredarray of string
Environments where it can be engaged.
linksrequiredarray of LinkView
Links.
LinkView · 7 fields
namerequiredstring
Name.
defaultrequiredboolean
Whether it is the default link.
driverrequiredstring
Driver required: package@versions.
transportstring
Transport required, when the link has one: package@versions.
gatewayrequiredstring
Gateway required: an instance, or any(tag: …).
boundone of BoundView | null
availableboolean
Whether its gateway reports the link available (in pass, station in service).
readyboolean
Whether it can be engaged; None when the reconciler published nothing yet.
reasonsrequiredarray of string
Why it is not ready.
configstring
Configuration revision it runs with.
leaseone of LeaseView | null
TcEvent#
A transition of a telecommand, published on stellar.tc.evt.<target>.<tc_id>.
atrequiredstring
Time of the transition.
conformingboolean
For an ECHO event: whether the echo conforms.
detailstring
Explanation: failed precondition, error of the driver or the gateway, echo…
staterequiredNew state.
tcrequiredstring
Telecommand.
telecommandone of TcRef | null
For a PENDING event: the telecommand, for sent_at in derived measures.
TcRef#
A telecommand of a component instance.
componentrequiredstring
Component.
instancestring
Instance.
telecommandrequiredstring
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.
targetrequiredstring
Target of the telecommand.
eventrequiredThe event.
TcEvent · 6 fields
atrequiredstring
Time of the transition.
conformingboolean
For an ECHO event: whether the echo conforms.
detailstring
Explanation: failed precondition, error of the driver or the gateway, echo…
staterequiredNew state.
tcrequiredstring
Telecommand.
telecommandone of TcRef | null
For a PENDING event: the telecommand, for sent_at in derived measures.
TelecommandView#
A telecommand.
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
argsrequiredarray of ArgumentView
Arguments.
ArgumentView · 7 fields
namerequiredstring
Name.
descriptionstring
Description, from the catalogue.
typerequiredstring
Type.
unitstring
Unit.
valuesrequiredarray of string
Values of an enum.
rangearray of number · double
Accepted range.
defaultstring
Value when omitted, as written.
changes_state requiredboolean
Whether it changes the on-board state.
hazardousrequiredboolean
Whether it needs a confirmation.
ThroughputReport#
Throughput of a gateway for one target, published on stellar.metrics.<gateway>.<target>.
downlink_bps requirednumber · double
Mean downlink throughput over the window, in bits per second.
downlink_bytes requiredinteger · uint64
Bytes received from the target since the gateway started.
uplink_bps requirednumber · double
Mean uplink throughput over the window, in bits per second.
uplink_bytes requiredinteger · uint64
Bytes sent to the target since the gateway started.
window_ms requiredinteger · uint64
Length of the window, in milliseconds.
ThroughputView#
A throughput report of a gateway for one target.
downlink_bps requirednumber · double
Mean downlink throughput over the window, in bits per second.
downlink_bytes requiredinteger · uint64
Bytes received from the target since the gateway started.
uplink_bps requirednumber · double
Mean uplink throughput over the window, in bits per second.
uplink_bytes requiredinteger · uint64
Bytes sent to the target since the gateway started.
window_ms requiredinteger · uint64
Length of the window, in milliseconds.
targetrequiredstring
Target.
atrequiredstring · date-time
Reception by the API.
TopologyView#
Body of GET /v1/topology.
configrequiredstring
Current configuration revision.
environmentsrequiredarray of string
Environments.
policiesrequiredmap of EnvironmentPolicy
Policies of each environment.
EnvironmentPolicy · 2 fields
allow_draft requiredboolean
Whether draft packages are accepted.
human_orchestration one of HumanOrchestrationView | null
targetsrequiredarray of TargetView
Targets.
TargetView · 8 fields
namerequiredstring
Name.
platformrequiredstring
Platform, package@version.
environmentsrequiredarray of string
Environments where it can be engaged.
linksrequiredarray of LinkView
Links.
LinkView · 7 fields
namerequiredstring
Name.
defaultrequiredboolean
Whether it is the default link.
driverrequiredstring
Driver required: package@versions.
transportstring
Transport required, when the link has one: package@versions.
gatewayrequiredstring
Gateway required: an instance, or any(tag: …).
boundone of BoundView | null
availableboolean
Whether its gateway reports the link available (in pass, station in service).
readyboolean
Whether it can be engaged; None when the reconciler published nothing yet.
reasonsrequiredarray of string
Why it is not ready.
configstring
Configuration revision it runs with.
leaseone of LeaseView | null
Transfer#
A file transfer, in stellar_transfers under <target>.<file_id>.<generation>.
bystring
Who asked for it.
checksumstring
Checksum of the whole file, hexadecimal, as listed.
created_at requiredstring
Creation.
directionDirection.
file_id requiredstring
File identifier.
file_type string
Type of the file (lttm…).
generationrequiredinteger · uint64
Generation of the file.
priorityinteger · int32
Priority: higher first.
reasonstring
Why corrupted or superseded.
receivedarray of array of integer · uint64
Ranges received, [start, end) in bytes, sorted and disjoint.
sizerequiredinteger · uint64
Size, in bytes.
sourcestring
Content uploaded: its hexadecimal SHA-256 in [UPLOADS_STORE].
stateState.
targetrequiredstring
Target.
updated_at requiredstring
Last change.
TransferDirection#
Direction of a transfer.
one of string | string
Transfers#
Body of GET /v1/transfers.
transfersrequiredarray of Transfer
Transfers, by priority then age.
Transfer · 15 fields
bystring
Who asked for it.
checksumstring
Checksum of the whole file, hexadecimal, as listed.
created_at requiredstring
Creation.
directionDirection.
file_id requiredstring
File identifier.
file_type string
Type of the file (lttm…).
generationrequiredinteger · uint64
Generation of the file.
priorityinteger · int32
Priority: higher first.
reasonstring
Why corrupted or superseded.
receivedarray of array of integer · uint64
Ranges received, [start, end) in bytes, sorted and disjoint.
sizerequiredinteger · uint64
Size, in bytes.
sourcestring
Content uploaded: its hexadecimal SHA-256 in [UPLOADS_STORE].
stateState.
targetrequiredstring
Target.
updated_at requiredstring
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.
stepstring
Step whose first entry starts the delay: its name (Plateau), or its path (TVAC cycle / Plateau).
afterstring
Delay.
Values#
Body of GET /v1/targets/{target}/values.
valuesrequiredarray of CurrentValue
Current values, by key order.
CurrentValue · 4 fields
componentrequiredstring
Component.
instancestring
Instance of a multi-instance component.
measurerequiredstring
Measure or derived measure.
samplerequiredLatest sample.
Sample · 6 fields
deliveryrequiredstring
realtime or deferred; deferred when any input of a derived measure is.
ground_time requiredstring
Ground reception time, reference of freshness; for a derived measure, that of its oldest input.
linkrequiredstring
Link of the frame; for a derived measure, that of its most recent input.
rawany
Raw value of a measure calibrated by the MCS.
timerequiredstring
Time of the sample: on-board time when known, else ground reception time; for a derived measure, that of its most recent input.
valuerequiredany
Physical value: number in the unit of the measure, boolean, enum value, hexadecimal bytes;
null when a temporal derived measure becomes unknown (empty window).