v4

• AUTO_TARGETS
• AUTO_TARGET
• NEW_COLUMN
• TARGET
• ADD_SHOW_ON_STARTUP
• GROUP
• TARGET Modifiers
  • SCREEN
  • SCREEN Modifiers
    • SHOW_ON_STARTUP
  • GROUP Modifiers
    • GROUP_SCREEN
• Command Line Parameters

Telemetry Viewer

This document describes Telemetry Viewer configuration file and command line parameters.

For documentation on how to build Telemetry Screens and how to configure the screen widgets please see the Telemetry Screens.

AUTO_TARGETS

Add all screens defined in the screens directory of each target folder

Automatically added screens are grouped by target name in the display. For example, all the screens defined in config/targets/COSMOS/screens will be added to a single drop down selection labeled COSMOS.

AUTO_TARGET

Add all screens defined in the screens directory of the specified target folder

Screens are grouped by target name in the display. For example, all the screens defined in config/targets/COSMOS/screens will be added to a single drop down selection labeled COSMOS.

If AUTO_TARGETS is used this keyword does nothing

Parameter	Description	Required
Target	Name of the target Valid Values: Any Target Name	True

NEW_COLUMN

Creates a new column of drop down selections in Telemetry Viewer

All the AUTO_TARGET or SCREEN keywords after this keyword will be added to a new column in the GUI.

TARGET

Used in conjunction with the SCREEN keyword to define individual screens within a target’s screen directory.

Parameter	Description	Required
Target	Name of the target Valid Values: Any Target Name	True

ADD_SHOW_ON_STARTUP

Adds show on startup to any screen that has already been defined

Screens that are discoverd by AUTO_TARGETS or AUTO_TARGET aren’t explicitly defined. Thus this keyword is used to add show on startup.

Parameter	Description	Required
Target Name	Target Name of the screen Valid Values: Any Target Name	True
Screen Name	Name of the screen. This is equal to the screen’s filename without the .txt extension.	True
X Position	Position in pixels to draw the left edge of the screen on the display. If not supplied the screen will be centered. If supplied, the Y position must also be supplied.	False
Y position	Position in pixels to draw the top edge of the screen on the display. If not supplied the screen will be centered. If supplied, the X position must also be supplied.	False

GROUP

Create a new drop down group of screens in the GUI

Parameter	Description	Required
Group Name	The text to display in front of the drop down list of screens	True

TARGET Modifiers

The following keywords must follow a TARGET keyword.

SCREEN

Adds the specified screen from the specified target

Parameter	Description	Required
File Name	Name of the file containing the telemetry screen definition. The filename will be upcased and used in the GUI drop down selection.	True
X Position	Position in pixels to draw the left edge of the screen on the display. If not supplied the screen will be centered. If supplied, the Y position must also be supplied.	False
Y position	Position in pixels to draw the top edge of the screen on the display. If not supplied the screen will be centered. If supplied, the X position must also be supplied.	False

SCREEN Modifiers

The following keywords must follow a SCREEN keyword.

SHOW_ON_STARTUP

Causes the previously defined SCREEN to be automatically displayed when Telemetry Viewer starts

GROUP Modifiers

The following keywords must follow a GROUP keyword.

GROUP_SCREEN

Define a screen in the given group drop down

Parameter	Description	Required
Target Name	Target Name of the screen Valid Values: Any Target Name	True
Screen Name	Name of the screen. This is equal to the screen’s filename without the .txt extension.	True
X Position	Position in pixels to draw the left edge of the screen on the display. If not supplied the screen will be centered. If supplied, the Y position must also be supplied.	False
Y position	Position in pixels to draw the top edge of the screen on the display. If not supplied the screen will be centered. If supplied, the X position must also be supplied.	False

Command Line Parameters

Usage: ruby TlmViewer [options]

    -h, --help                       Show this message
    -v, --version                    Show version
        --system FILE                Use an alternative system.txt file
    -c, --config FILE                Use the specified configuration file
        --stylesheet FILE            Use the specified stylesheet

Window Size Options:
        --minimized                  Start the tool minimized
        --maximized                  Start the tool maximized
        --defaultsize                Start the tool in its default size
        --stay-on-top                Force the tool to stay on top of all other windows

Window X & Y Position Options:
  Positive values indicate a position from the top and left of the screen.
  Negative values indicate a position from the bottom and right of the screen.
  A value of -1 indicates to place the right or bottom side of the window
  next to the right or bottom edge of the screen.
    -x, --xpos VALUE                 Window X position
    -y, --ypos VALUE                 Window Y position

Window Width and Height Options:
  Specifing width and height will force the specified dimension.
  Otherwise the window will layout according to its defaults.
    -w, --width VALUE                Window width
    -t, --height VALUE               Window height

Telemetry Viewer Specific Options:
    -s, --screen SCREEN_NAME         Start up the specified screen
    -n, --nolisten                   Don't listen for requests
    -p, --production                 Run Telemetry Viewer in production mode which disables the edit buttons.
        --replay                     Run Telemetry Viewer in Replay mode