TM Link¶

Online RAF service. This link binds and starts a SLE session as soon as it is enabled. If the connection goes down it will continually try to re-establish it.

Usage¶

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

dataLinks:
    - name: SLE_IN
      class: org.yamcs.sle.TmSleLink
      sleProvider: GS1
      deliveryMode: timely
      startSleOnEnable: false
      # 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. Default RAF.
deliveryMode (string): Required. One of: complete or timely.
startSleOnEnable (boolean): Whether the SLE session should automatically be STARTed when the link is enabled. If false, enabling the link will only BIND it. Default: true

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

reconnectionIntervalSec (integer)

Select the reconnection interval. If the connection to the SLE provider breaks, Yamcs will attempt to reconnect after that many seconds.

Default: 30 (seconds)

roundRobinIntervalMillis (integer)

If multiple endpoints are specified, this is the amount of time to wait before connecting to the next one. After all endpoints have been exhausted the parameter above applies for connecting againt to the first endpoint in the list. If only one endpoint is specified, this parameter has no effect.

Default: 100 (milliseconds)

Note

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

privateAnnotationParameter (string): If specified, it is the name of a fully qualified binary parameter in the MDB. The parameter will be updated with the private annotation data received via SLE. The data is provided as binary content of the data is specific to each provider/mission. The parameter must exist in the MDB, otherwise Yamcs will not start. The parameter is timestamped with the Earth Reception Time received from the SLE provider.
privateAnnotationStream (string): If specified, it is the name of a stream where a packet containing the data of the private annotation will be sent. The stream must exist (it can be configured in the instance configuration streamConfig -> tm)