/  Yamcs HTTP API  /  Packets  /  Subscribe Containers

Subscribe ContainersΒΆ

Subscribe to containers

WebSocket

This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.

Use the message type containers.

Input Type

interface SubscribeContainersRequest {

  // Yamcs instance name.
  instance: string;

  // Processor name.
  processor: string;

  // Container names to subscribe to.
  names: string[];
}

Output Type

interface ContainerData {

  // Container name.
  name: string;

  // When the container's packet was generated (packet time)
  generationTime: string;  // RFC 3339 timestamp

  // Whent the container's packet was received by Yamcs
  receptionTime: string;  // RFC 3339 timestamp

  // Container bytes
  binary: string;  // Base64

  // Sequence count - it is generated by the link when the container is injected into Yamcs.
  // In case this is part of a sub-container, the sequence count is the one from the encompassing container
  seqCount: number;
}