/  Yamcs HTTP API  /  Packets  /  Subscribe Packets

Subscribe PacketsΒΆ

Subscribe to packets

This subscription is performed at stream or processor level.

The identifier of the packets is not filled in.

WebSocket

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

Use the message type packets.

Input Type

interface SubscribePacketsRequest {

  // Yamcs instance name.
  instance: string;

  // Stream name. This is mutually exclusive with the field ``processor``.
  stream: string;

  // Processor name. This is mutually exclusive with the field ``stream``.
  processor: string;
}

Output 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;
}