TC Frame Link¶

Usage¶

dataLinks:
    class: org.yamcs.mqtt.MqttTcFrameLink
    # MQTT connection parameters
    brokers:
       - tcp://test.mosquitto.org:1883
    topic: yamcs-tc-frames
    # other MQTT options
    # other frame link options

Options¶

brokers (List of strings)

Required. The list of MQTT brokers to connect to. The MQTT client will attempt to connect to each broker in the list, one by one, until a connection is successfully established. The brokers can be specified using either the format tcp://host:port for unencrypted connections or ssl://host:port for encrypted connections.

username (string)

The username to use when connecting to the MQTT broker. If not specified an annonymous connection will be performed. Default: not specified

password (string)

Required when the username is specified. The password to use when connecting to the MQTT broker. If not specified an annonymous connection will be performed. Default: not specified

clientId (string)

The client ID to use for the MQTT connection. This is used by the broker to identify the client. The broker will refuse the connection if another client witht he same clientId is already connected. If you are using two links you have to specify a different clientId for each (or just leave the default randomly assigned clientId). If not specified, it will be automatically generated using a random value.

connectionTimeoutSecs

The maximum time, in seconds, to wait for a connection to the MQTT broker before timing out. Default: 5

autoReconnect (boolean)

If set to true, the client will automatically attempt to reconnect to the broker if the connection is lost. Default: true

keepAliveSecs (integer)

The keep-alive interval, in seconds, for the MQTT connection. This is the maximum period between communications with the broker before the connection is considered lost. Default: 60

topic (string)

Required The name of the topic to which the TC frames are sent. Default: not specified

converterClassName:

The name of the class implementing org.yamcs.mqtt.FrameToMqttConverter that is used to create the MQTT message from the binary frame data. By default (if not specified) the converter sets the payload of the MQTT message as the binary frame data.

converterArgs

The configuration that will be passed to the init method of the converter.