Edit Processor¶

Update a processor

URI Template

PATCH /api/processors/{instance}/{processor}

{instance}: Yamcs instance name
{processor}: Processor name

Request Body

// Request message for `EditProcessor`.
interface EditProcessorRequest {

  // The state this replay processor should be updated to. Either ``paused`` or
  // ``running``.
  state: string;

  // The time where the processing needs to jump towards. Must be a date string
  // in ISO 8601 format.
  seek: string;  // RFC 3339 timestamp

  // The speed of the processor. One of:
  // * ``afap``
  // * a speed factor relative to the original speed. Example: ``2x``
  // * a fixed delay value in milliseconds. Example: ``2000``
  speed: string;

  // New start time
  start: string;  // RFC 3339 timestamp

  // New stop time
  stop: string;  // RFC 3339 timestamp

  // Continue replaying from ``start`` after having reached ``stop``.
  loop: boolean;
}