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 Server Manual
Yamcs Release Notes
Source Code Documentation
Download this Document
InitializeΒΆ
Initialize COP-1 in case state is UNITIALIZED
URI Template
POST /api/cop1/{instance}/{link}:initialize
{instance}
Yamcs instance name.
{link}
Link name.
Request Body
interface InitializeRequest {
type: InitializationType;
// Timeout in milliseconds for initialize with CLCW check
clcwCheckInitializeTimeout: string; // String decimal
//vR value for initialize with set V(R)
vR: number;
}
Related Types
enum InitializationType {
// CLCW will be expected from the remote system and used to initiate the vS
WITH_CLCW_CHECK = "WITH_CLCW_CHECK",
// Initiate without waiting for CLCW
WITHOUT_CLCW_CHECK = "WITHOUT_CLCW_CHECK",
// This causes a BC Unlock frame to be sent to the remote system.
UNLOCK = "UNLOCK",
// Initiate AD with set V(R). This will cause a BC frame to be sent to the remote system
SET_VR = "SET_VR",
}