MTVMS

Note

This page is generated by python script generate_cet.py.

Back to table

Commands

changeSamplePeriod

Description: Change sampling period.

EFDB_Topic:

MTVMS_command_changeSamplePeriod

period

IDL_Type:

int

Units:

ms

Description: New sample period in milliseconds.

disable

Description: Transition from state Enabled to Disabled.

EFDB_Topic:

SALGeneric_command_disable

Category:

csc

enable

Description: Transition from state Disabled to Enabled.

EFDB_Topic:

SALGeneric_command_enable

Category:

csc

exitControl

Description: Transition from state Standby to Offline. Most CSCs will quit, but CSCs that support the enterControl command will keep running.

EFDB_Topic:

SALGeneric_command_exitControl

Category:

csc

setLogLevel

Description: Set the logging level.

EFDB_Topic:

SALGeneric_command_setLogLevel

Category:

csc

level

IDL_Type:

int

Units:

unitless

Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem

IDL_Type:

string

Units:

unitless

Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.

standby

Description: Transition from state Offline/Available, Disabled or Fault to Standby.

EFDB_Topic:

SALGeneric_command_standby

Category:

csc

start

Description: Transition from state Standby to Disable, in a specified configuration.

EFDB_Topic:

SALGeneric_command_start

Category:

csc

configurationOverride

IDL_Type:

string

Units:

unitless

Description:

Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:

• “foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.

• “:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.

• “bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.

Enumerations

SummaryStates:

• DisabledState=1

• EnabledState=2

• FaultState=3

• OfflineState=4

• StandbyState=5

TimeSynchronization:

• NotStarted=0

• ResponderWaiting=1

• ResponderSynced=2

• ControllerReady=3

• ControllerRunning=4

• SynchronizationFailed=5

Events

fpgaState

Description: Current FPGA configuration and state.

EFDB_Topic:

MTVMS_logevent_fpgaState

period

IDL_Type:

int

Units:

ms

Description: Configured acquisition period.

outputType

IDL_Type:

int

Units:

unitless

Description: Configured output type (min/max/average/statistics).

ready

IDL_Type:

boolean

Units:

unitless

Description: True if VMS device FPGA is ready to start acqusition.

timeouted

IDL_Type:

boolean

Units:

unitless

Description: True if VMS FPGA loop timeouted during execution.

stopped

IDL_Type:

boolean

Units:

unitless

Description: True if VMS FPGA was stopped.

fifoFull

IDL_Type:

boolean

Units:

unitless

Description: True if VMS FPGA FIFO is full, signalling data was stopped.

timeSynchronization

Description: Time synchronization status and base offset value.

EFDB_Topic:

MTVMS_logevent_timeSynchronization

state

IDL_Type:

short

Units:

unitless

Description:

Time synchronization state. Different strategies are employed for controller (the CSC running on cRIO sending time synchronization pulses) and receivers (the CSC running on cRIOs receiving time synchronization pulses). Please consult ts_vmsfpga README for state transitions.

baseClockOffset

IDL_Type:

double

Units:

second

Description:

Current offset between base clocks and TAI clocks. Published first by the controller, receivers just sends out what was received from the controller.

configurationApplied

Description: Information about this CSC’s current configuration overrides.

EFDB_Topic:

SALGeneric_logevent_configurationApplied

Category:

configurable

configurations

IDL_Type:

string

Units:

unitless

Description: A comma-separated list of configurations applied. If configuration comes from a clone of a git repo, or similar directory, then it will be a list of file names, without the file extension. Ignore whitespace after commas.

version

IDL_Type:

string

Units:

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url

IDL_Type:

string

Units:

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL. This should always match the same-named field in configurationsAvailable.

schemaVersion

IDL_Type:

string

Units:

unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”. This should always match the same-named field in configurationsAvailable.

otherInfo

IDL_Type:

string

Units:

unitless

Description: A comma-separated list of event topics (without the logevent prefix) used to publish the entire set of configuration parameters loaded by this CSC, and any other pertinent information. Ignore whitespace after commas.

configurationsAvailable

Description: Available configuration overrides for this CSC.

EFDB_Topic:

SALGeneric_logevent_configurationsAvailable

Category:

configurable

overrides

IDL_Type:

string

Units:

unitless

Description: Available overrides as a comma-separated list. Each entry is a possible value of the configurationOverride field of the start command. Ignore whitespace after commas.

version

IDL_Type:

string

Units:

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url

IDL_Type:

string

Units:

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL.

schemaVersion

IDL_Type:

string

Units:

unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”.

errorCode

Description: Output when this CSC goes into the Fault state as an explanation of the problem.

EFDB_Topic:

SALGeneric_logevent_errorCode

Category:

csc

errorCode

IDL_Type:

long

Units:

unitless

Description: A numeric error code.

errorReport

IDL_Type:

string

Units:

unitless

Description: An string providing detailed information about the error.

traceback

IDL_Type:

string

Units:

unitless

Description: An optional stack trace of the error condition.

heartbeat

Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.

EFDB_Topic:

SALGeneric_logevent_heartbeat

Category:

mandatory

heartbeat

IDL_Type:

boolean

Units:

unitless

Description: Deprecated field that you should ignore.

logLevel

Description: Current logging level.

EFDB_Topic:

SALGeneric_logevent_logLevel

Category:

mandatory

level

IDL_Type:

int

Units:

unitless

Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem

IDL_Type:

string

Units:

unitless

Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.

logMessage

Description: A log message.

EFDB_Topic:

SALGeneric_logevent_logMessage

Category:

mandatory

name

IDL_Type:

string

Units:

unitless

Description: Log name.

level

IDL_Type:

int

Units:

unitless

Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.

message

IDL_Type:

string

Units:

unitless

Description: Log message.

traceback

IDL_Type:

string

Units:

unitless

Description: Exception traceback; “” if not an exception.

filePath

IDL_Type:

string

Units:

unitless

Description: Path to source file.

functionName

IDL_Type:

string

Units:

unitless

Description: Function or method name.

lineNumber

IDL_Type:

long

Units:

unitless

Description: Line number in the file specified by filePath.

process

IDL_Type:

long

Units:

unitless

Description: Process ID.

timestamp

IDL_Type:

double

Units:

second

Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.

simulationMode

Description: Current simulation mode.

EFDB_Topic:

SALGeneric_logevent_simulationMode

Category:

csc

mode

IDL_Type:

int

Units:

unitless

Description: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC.

softwareVersions

Description: Current versions of software in use by CSC.

EFDB_Topic:

SALGeneric_logevent_softwareVersions

Category:

mandatory

salVersion

IDL_Type:

string

IDL_Size:

256

Units:

unitless

Description: This is the current version of SAL generation.

xmlVersion

IDL_Type:

string

IDL_Size:

256

Units:

unitless

Description: This is the current version of CSC XML.

openSpliceVersion

IDL_Type:

string

IDL_Size:

256

Units:

unitless

Description: This is the current version of OpenSplice.

cscVersion

IDL_Type:

string

IDL_Size:

256

Units:

unitless

Description: The software version of this CSC.

subsystemVersions

IDL_Type:

string

Units:

unitless

Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within this CSC.

summaryState

Description: Current summary state of this CSC.

EFDB_Topic:

SALGeneric_logevent_summaryState

Category:

csc

summaryState

IDL_Type:

long

Units:

unitless

Description: High level state machine state identifier.

Telemetry

data

Description: VMS (1 sensor, 3 channels) accelerometer data.

EFDB_Topic:

MTVMS_data

timestamp

IDL_Type:

double

Units:

second

Description: Timestamp when data was measured.

sensor

IDL_Type:

short

Units:

unitless

Description: Sensor index.

accelerationX

IDL_Type:

float

Units:

m/s2

Count:

50

Description: Acceleration in x direction.

accelerationY

IDL_Type:

float

Units:

m/s2

Count:

50

Description: Acceleration in y direction.

accelerationZ

IDL_Type:

float

Units:

m/s2

Count:

50

Description: Acceleration in z direction.

miscellaneous

Description: Miscellaneous data.

EFDB_Topic:

MTVMS_miscellaneous

chassisTemperature

IDL_Type:

float

Units:

deg_C

Description: Current chassis temperature.

ticks

IDL_Type:

long long

Units:

unitless

Description: Current chassis ticks.

psd

Description: Acceleration power spectral density (PSD), measured by a 3 axis accelerometer.

EFDB_Topic:

MTVMS_psd

timestamp

IDL_Type:

double

Units:

second

Description: Starting time of data acqusition (TAI Unix seconds) used to compute PSDs.

interval

IDL_Type:

double

Units:

second

Description: Time interval over which PSDs were calculated beginning from the starting time.

minPSDFrequency

IDL_Type:

float

Units:

Hz

Description: PSD minimum frequency.

maxPSDFrequency

IDL_Type:

float

Units:

Hz

Description: PSD maximum frequency.

numDataPoints

IDL_Type:

int

Units:

unitless

Description: Number of valid frequencies. PSD array elements with index greater than or equal to numDataPoints are invalid and can contain any value (0 preferred).

sensor

IDL_Type:

short

Units:

unitless

Description: Sensor index.

accelerationPSDX

IDL_Type:

float

Units:

m2 / (Hz2 s4)

Count:

200

Description: Acceleration PSD in x direction.

accelerationPSDY

IDL_Type:

float

Units:

m2 / (Hz2 s4)

Count:

200

Description: Acceleration PSD in y direction.

accelerationPSDZ

IDL_Type:

float

Units:

m2 / (Hz2 s4)

Count:

200

Description: Acceleration PSD in z direction.