Offline TM Link¶

Offline RAF/RCF service. This link does not retrieve any data by itself. Instead it expects requests to be made using the Request Offline Data HTTP API. As long as it has retrieval requests in the queue, it keeps a connection open and bound to the SLE provider and it starts/stops SLE sessions for each retrieval request. After all the retrievals have been finished, it unbinds and closes the connection to the SLE provider. If a request fails for whatever reason (for example could not connect to SLE provider), it does not reattempt to execute it.

Usage¶

Specify SLE properties in etc/sle.yaml, and add a link entry to etc/yamcs.[instance].yaml:

dataLinks:
    - name: SLE_OFFLINE_IN
      class: org.yamcs.sle.OfflineTmSleLink
      sleProvider: GS1
      # other options

Options¶

sleProvider (string): Required. The name of a provider defined in the etc/sle.yaml configuration file.

service (string)

One of: RAF or RCF.

Depending on this setting and the deliveryMode, one of the entries raf-ontl, raf-onlc, rcf-ontl, rcf-onlc from sle.yaml will be used.

If the RCF service is used, the request sent with the SLE START includes the triplet (TransferFrameVersionNumber, SpacecraftId, VirtualChannelId).

The values for the TransferFrameVersionNumber and SpacecraftId parameters are normally derived from the frame processing configuration but can be overriden by the options below. Overriding them will most likely result in an invalid configuration.

The value of the VirtualChannelId is by default -1 meaning all VCs are requested but can be restricted to only one VC with the option below.

Default: RAF

rcfTfVersion (integer)

If service is set to RCF, this overrides the Transfer Frame Version Number which is otherwise derived from the frameType parameter part of the frame processing configuration.

rcfSpacecraftId (integer)

If service is set to RCF, this overrides the Spacecraft Id which is otherwise the one specified spacecraftId parameter part of the frame processing configuration.

rcfVcId

If service is RCF, this specifies the Virtual Channel requested via RCF. By default it is -1 meaning all Virtual Channels for the defined spacecraft. There is validation that this virtual channel is defined in the virtualChannels parameter part of the frame processing configuration.

frameQuality

If service is RAF, this specifies the frame quality requested in the SLE START invocation. Valid values are goodFramesOnly, erredFramesOnly or allFrames. RCF does not support this option, it only delivers good frames. Default: goodFramesOnly

Note

Other available link options are general frame processing parameters as specified at https://docs.yamcs.org/yamcs-server-manual/links/ccsds-frame-processing.