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,
}
-
updateupdateObject - An atomic update to the schedule of stops — the most common message.
-
gearinteger - The current optimisation gear level.
-
taginteger - Echoes the tag supplied on an input transaction.
-
timeDeltainteger - Offset (seconds) between Spiral’s internal clock and real time.
-
optimisedbool - Signals the schedule has reached an optimised state.
-
primedbool - Signals the solver is primed and ready.
-
pausedobject - Present (with detail) when optimisation is paused.
-
simpleSolnsobject - Simple-solution summary data.
-
ERRORstring - An error message.
-
warningobject - A warning message.