Subscribe Algorithm StatusΒΆ
Receive algorithm status updates
WebSocket
This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.
Use the message type algorithm-status.
Input Type
// Request message for `SubscribeAlgorithmStatus`.
interface SubscribeAlgorithmStatusRequest {
// Yamcs instance name
instance: string;
// Processor name
processor: string;
// Algorithm name
name: string;
}
Output Type
interface AlgorithmStatus {
//true if the algorithm is active
active: boolean;
//true if the tracing has been enabled
traceEnabled: boolean;
// how many times the algorithm ran (successfully or with error)
runCount: number;
// when the algorithm was last run
lastRun: string; // RFC 3339 timestamp
// how many times the algorithm ran with errors
errorCount: number;
// Error message in case the algorithm produced an error.
errorMessage: string;
// Error time in case the algorithm produced an error.
errorTime: string; // RFC 3339 timestamp
//total execution time in nanoseconds
execTimeNs: string; // String decimal
}