Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
Get StatusΒΆ
Get the TCO status
Returns the TCO status comprising the currently used coefficients, the last computed deviation and the last received samples.
URI Template
GET /api/tco/{instance}/{serviceName}/status
{instance}
Yamcs instance name.
{serviceName}
Service name.
Response Type
//If the TCO is used only for verifying the synchronization, the message will
// contain only the validity, accuracy and deviation.
interface TcoStatus {
//Currently used coefficients.
// If not present, the synchronization is not established
coefficients: TcoCoefficients;
//The time when the coefficients have been computed
coefficientsTime: string; // RFC 3339 timestamp
//The last computed deviation
deviation: number;
//The last accumulated samples
//These are not necessary those from which the coefficients
//have been calculated because the coefficients will only
//be recalculated when the deviation is higher than the accuracy settings
samples: TcoSample[];
}
Related Types
interface TcoCoefficients {
utc: string; // RFC 3339 timestamp
obt: string; // String decimal
gradient: number;
offset: number;
}
//Sample association between UTC and Onboard time.
//This is computed by the TCO service after adjusting for internal
//delays and time of flight.
interface TcoSample {
utc: string; // RFC 3339 timestamp
obt: string; // String decimal
}