/  Yamcs HTTP API  /  Packets  /  Stream Packets

Stream PacketsΒΆ

Streams back packets

Warning

This method uses server-streaming. Yamcs sends an unspecified amount of data using chunked transfer encoding.

URI Template

POST /api/stream-archive/{instance}:streamPackets
{instance}

Yamcs instance name.

Request Body

interface StreamPacketsRequest {
  start: string;  // RFC 3339 timestamp
  stop: string;  // RFC 3339 timestamp
  name: string[];
}

Response Type

interface TmPacketData {

  // Raw packet binary
  packet: string;  // Base64

  // Storage discriminator in case of distinct packets
  // with the same name and generation time
  sequenceNumber: number;

  // Packet name
  id: NamedObjectId;

  // When the packet was generated
  generationTime: string;  // RFC 3339 timestamp

  // When the signal has been received on ground
  earthReceptionTime: string;  // RFC 3339 timestamp

  // When the packet was received by Yamcs
  receptionTime: string;  // RFC 3339 timestamp

  // Name of the Yamcs link where this packet was received from
  link: string;

  // Packet size in bytes
  size: number;
}

Related Types

// Used by external clients to identify an item in the Mission Database
// If namespace is set, then the name is that of an alias, rather than
// the qualified name.
interface NamedObjectId {
  name: string;
  namespace: string;
}