Skip to content

outputObject

Each element of the output stream’s OUT array (see errorObject) is a single message carrying exactly one of the following:

{
"gear": <integer> | null,
"tag": <integer> | null,
"timeDelta": <integer> | null,
"optimised": <bool> | null,
"primed": <bool> | null,
"paused": <object> | null,
"simpleSolns": <object> | null,
"ERROR": <string> | null,
"warning": <object> | null,
}
update updateObject
An atomic update to the schedule of stops — the most common message.
gear integer
The current optimisation gear level.
tag integer
Echoes the tag supplied on an input transaction.
timeDelta integer
Offset (seconds) between Spiral’s internal clock and real time.
optimised bool
Signals the schedule has reached an optimised state.
primed bool
Signals the solver is primed and ready.
paused object
Present (with detail) when optimisation is paused.
simpleSolns object
Simple-solution summary data.
ERROR string
An error message.
warning object
A warning message.