Scenario files#
A scenario file is one YAML file under data/facility/scenarios/; the file
name is the scenario name. This page lists what the file may hold. Applying
and writing scenarios is in Scenarios.
Keys#
Every key is optional.
Key |
Meaning |
|---|---|
|
What the scenario shows. |
|
|
|
|
|
|
|
|
|
The entries the scenario narrates, each with |
|
Slow shared signals, and the channels that follow them. |
|
Per-channel noise while the scenario is active, replacing the noise
the channel’s record in |
|
|
|
Past agent sessions, |
Select readings to still#
Any scenario can still a family of readings by selecting it from the facility file’s own records. Each selection names a model or a place, and the build resolves it to plain addresses:
still:
- {model: <model>, engine_role: monitor}
- {place: <place>, signal: <signal>}
- <address>
model: channels a wiring record of that model names, or on a device of that model.place: channels on that place or on a place under it.group: channels on a device of that group.signal: channels stating thatsignal.engine_role: channels whose wiring record has that engine role (setpoint,readback,monitororoutput).plane: channels whose wiring record has that plane.
A channel must match every key of a selection. The build stops on a selection that names neither a model nor a place. It also stops on a selection that matches no float channel. A matched channel that is not a float is left out.
Archive events#
Each entry under archiver names a channel and its events. Each event
has a shape and one position.
The shape is one of these:
step, withto.ramp, withto.spike, withamplitudeandwidth, a Gaussian sigma in seconds.burst, withamplitude, reached at the event and then decaying exponentially overdecay_s. An optional slower tailtail_decay_scarriestail_shareof it.loss, withamount, dropped at the event. Only the channel’s top-off refills it.
The position is one of these:
at_offset: seconds from the apply-time anchor. A ramp ends atuntil_offset.at_time: a dailyHH:MM:SSin the facility time zone.at_when:{days_ago, time}. It places the event at the instant a logbook entry’swhennames.
at_time and at_when take every shape but ramp.
A step on a float channel may end with until, until_offset or
until_when. The end must match the step’s position and come later than it.
After the end, the channel returns to its baseline. A daily at_time step
does not end.
Channel faults#
Fault |
Names |
Setpoint read |
Setpoint write |
Readback or reading read |
Severity |
|---|---|---|---|---|---|
|
a setpoint |
the value last written, its start value before any write |
accepted, held, forwarded to nothing |
wired: the model where it was; otherwise its held value, with no echo |
none |
|
a reading (a readback or a |
n/a |
n/a |
the value served when the fault became active; no motion, no model update |
none |
|
any channel |
the value last written |
accepted, held, forwarded to nothing |
float: not-a-number; any other type: the value served when the fault became active |
|
A disconnected setpoint’s readback is the disconnected reading. A setpoint
that is its own readback reads its demand and reports udf itself.
A channel fault holds in both venues of the simulator
(Two venues). offline, a read that never answers, is not one of
these faults.
On an injection chain (An injection chain) a stuck or
disconnected request starts no shot, and a frozen reading raises no
monitor event while the fault is active. Applying a scenario mid-shot
abandons the shot: the chain restarts at the new scenario’s start state.