9.11 ARD-Backup-Client

The ARD-Backup-Client is a customer specific logical device which controls a backup transmit chain located an another M&C system using a proprietary UDP based remote control protocol. The remote backup transmit chain may be controlled by a third party M&C system implementing this protocol or by a sat-nms M&C using the ARD-Backup-Server logical device.

The ARD-Backup-Client shows some state information about the remote transmit chain in it's device window and provides buttons to switch this chain to antenna or to load. Beside this, buttons are provided to increment or decrement the chain's transmit power in steps of 1 or 0.5 dB.

Device window pages

The following table shows which device window pages are available with this individual device type. Tool-bar functions not mentioned here are described at the general description of device windows .

Configuration parameters

At the maintenance page of the device window there are a couple of configuration parameters which must be set to integrate the device into the VLC/M&C.

parameter description
chainName The name of the backup transmit chain at the remote M&C. This name is used in the communication protocol to address the chain to be controlled. Typical values are 'SZ1' or 'SZ2'
listenPort The port number at which the ARD-Backup-Client listens for status messages from the remote M&C. This port number must match the 'clientPort' set at it's counterpart.
serverPort The port number to which the ARD-Backup-Client sends any command messages. This port must match the 'listenPort' set at the server side.
serverIP The IP address of the remote M&C.
key The key used by the communication protocol to encrypt/decrypt messages. The key is a 256 digit hexadecimal string. Normally there is no need to change this parameter.
wgsId The device name of the wave guide switch used to switch the signal either to antenna or to load. The ARD-Backup-Client expects this device to provide a 'position' parameter which controls the switch position.
wgsXlate A comma separated list of two switch positions. The first position indicates 'LOAD', the second one 'ANTENNA'. If for example the switch routes the signal to antenna for position 'A', wgsXlate must be set to 'B,A'.
powerDetectId The ID of a parameter which indicates if there is transmit power detected after the wave guide switch. The ARD-Backup-Client expect this to be a boolean type value with 'true' indicating the presence of transmit power at the antenna.

Fault flags

The device provides a 'faults.99' fault flag which indicates that the communication to the remote M&C is broken. The flag is raised if there was no valid status message received for 5 seconds.

Remarks

The device uses it's device thread to detect communication timeouts. For this reason, the device should be configured as the only device at a 'null' interface with an idle time of 1000 msecs.

Variables defined by this device driver

name type flags range
info.driver TEXT R/O StringRange R/O
lowLevel.cmd TEXT StringRange
lowLevel.reply TEXT R/O StringRange R/O
faults.99 ALARM R/O AlarmFlagRange R/O (Communication)
faults.commstat TEXT R/O StringRange R/O
info.type TEXT R/O StringRange R/O
info.frame TEXT R/O StringRange R/O
config.chainName TEXT SAVE SETUP StringRange
config.listenPort INTEGER SAVE SETUP IntegerRange (0 .. 0)
config.serverPort INTEGER SAVE SETUP IntegerRange (0 .. 0)
config.serverIP TEXT SAVE SETUP StringRange
config.localIP TEXT SAVE SETUP StringRange
config.key TEXT SAVE SETUP StringRange
config.wgsId TEXT SAVE SETUP StringRange
config.wgsXlate TEXT SAVE SETUP StringRange
config.powerDetectId TEXT SAVE SETUP StringRange
pwrInc05 TEXT NOPRESET StringRange
pwrInc10 TEXT NOPRESET StringRange
pwrDec05 TEXT NOPRESET StringRange
pwrDec10 TEXT NOPRESET StringRange
toRemote TEXT NOPRESET StringRange
toLocal TEXT NOPRESET StringRange
state.name TEXT R/O StringRange R/O
state.wgs TEXT R/O StringRange R/O
state.wgsText TEXT R/O StringRange R/O
state.upconverter TEXT R/O StringRange R/O
state.modulator TEXT R/O StringRange R/O
state.hpa TEXT R/O StringRange R/O
state.powerDetect BOOLEAN R/O BooleanRange R/O (true false)
state.hpaPower FLOAT R/O DoubleRange R/O (0 .. 0)
state.modCod TEXT R/O StringRange R/O
state.frequency FLOAT R/O DoubleRange R/O (0.000 .. 0.000)
state.symbolRate FLOAT R/O DoubleRange R/O (0.000000 .. 0.000000)
state.dataRate FLOAT R/O DoubleRange R/O (0.000000 .. 0.000000)
state.asiMode TEXT R/O StringRange R/O
state.eirp FLOAT R/O DoubleRange R/O (0.0 .. 0.0)
state.eirpFault BOOLEAN R/O BooleanRange R/O (true false)
state.summaryFault TEXT R/O StringRange R/O
state.operationLocked BOOLEAN R/O BooleanRange R/O (true false)
state.message TEXT R/O StringRange R/O
state.toggle BOOLEAN R/O BooleanRange R/O (true false)
state.rawmsg TEXT R/O StringRange R/O
localWgs TEXT R/O StringRange R/O
remoteWgs TEXT R/O StringRange R/O
localPowerDetect TEXT R/O StringRange R/O
remotePowerDetect TEXT R/O StringRange R/O