6.2 Commands

6.2.1 Command Formats

6.2.1.1 ASCII commands

Two ASCII formats are allowed for command parameters: the Fixed format and the Named Parameters format. These two formats are accepted by both the Engineering User Interface and the Command Interpreters.

The two formats cannot be mixed.

The following rules apply to both formats:

· If a parameter accepts more than one value, the values shall be separated by spaces.

· Integer and real values shall be written in any format recognised by scanf function.

· String values shall be optionally enclosed between double quotes. If the string is enclosed between double quotes, double quote inside the string shall be escaped with a `\' character.
Strings containing space characters must be enclosed between double quotes.
String values are not allowed to start with a dash ("-"). This is reserved for parameter names. The only exceptions are values being a number or enumerated values.

· Logical parameters always default to FALSE.

· Parameter names and enumerated string values are not case sensitive.

Fixed format

Parameters in Fixed format consist of a string containing a sequence of parameter values separated by commas.

Parameters are position dependant, the order being defined in the CDT.

Space characters can be inserted before and after the commas.

Defaulted parameters can be left empty.

Logical values shall have the value TRUE or FALSE, corresponding to ccsTRUE and ccsFALSE.

Example:

12 13, 0x00ff,:motor.sensor(1:4) :motor.sensor(2:4), "\"quote\", TRUE, -1.2e4

Named Parameter format

Parameters in Named Parameters format consist of a string containing a sequence of pairs of parameter name and value.

Parameter names and values are separated by one or more space characters.

Parameters names are defined in the CDT.

Parameter names must be prepended with the `-' character, e.g. a parameter of name list shall be given as -list.

For repeated parameters, several values may follow the parameter name.

Parameters can be given in any order. If a parameter is given twice, only the last occurrence counts.

For defaulted parameters, the name can be left out or it can be given without value.

Logical values shall be input as -flag, where flag is the parameter name, indicating that the value is TRUE.

Example:

-list :motor.sensor(1:4) :motor.sensor(2:4) -check -newValue 1

6.2.1.2 Formatted binary

Commands with parameters in "formatted binary" format can be sent from the Engineering User Interface. For this format, the Engineering User Interface shall use the Command Definition tables to convert the ASCII string typed by the user into a binary representation.

Parameters described in the Command Definition files are of three types: String, Integer, Real or Logical.

Parameters in "formatted binary" format shall be written into a binary buffer one after the other, without alignment for integer of real values. Strings shall be terminated by `\0', integers shall be written as vltINT32 (4 bytes) bits, real values shall be written as vltDOUBLE (8 bytes) and logicals as vltLOGICAL (1 byte).

6.2.1.3 Unformatted binary

Command with parameters in "unformatted binary" format cannot be sent from the Engineering User Interface.

The parameters are contained into a binary data structure known by both the source process and the destination process.

The command definition table syntax is defined in section 2.12.

Cmd Interpreter cmdLoadTable

CMDLOAD

Request a Command Interpreter to load new Command Definition and Command Configuration tables.

ASCII

· path name of Command Definition table (string)
· path name of Command Configuration table (string)

EMPTY

Cmd Interpreter cmdSetTestError

CMDSERR

Set error number to be returned with the next command.

ASCII

· error number (integer)

EMPTY

Database dbAliasToName

DBATON

Get the point name corresponding to the given alias..

ASCII

· point alias (string, maximum 19 characters)

ASCII

· point name (string)

Database dbDisRemoteAccess

DBDREM

Disable the access to remote databases.

EMPTY

EMPTY

Database dbDisSim

DBDSIM

Disable the simulation of remote database access.

EMPTY

EMPTY

Database dbEnRemoteAccess

DBEREM

Enable the access to remote databases.

EMPTY

EMPTY

Database dbEnSim

DBESIM

Enable the simulation of remote database access.

EMPTY

EMPTY

Database dbGetAlias

DBGALS

Get the alias of a point.

ASCII

· point name (string, maximum 255 characters)

ASCII

· point alias (string)

Database dbGetAttrInfo

DBGAINF

Get information about an attribute.

ASCII

· attribute name (string, maximum 255 characters)

ASCII

· type of attribute (string: "Scalar", "Vector", "Table)
· number of fields (integer)
· number of records (integer)
· size in bytes of a record (integer)
· number of records used (integer)
· list of types of element (string: "dbLOGICAL", etc.)

Database dbGetAttrNames

DBGANAM

Get the list of attributes in a point.

ASCII

· point name (string, maximum 255 characters)

ASCII

· number of attributes (integer), then for each attribute:
· ain (integer)
· attribute name (string)

Database dbGetAttrNumber

DBGANUM

Get the number of attributes in a point.

ASCII

· point name (string, maximum 255 characters)

ASCII

· number of attributes (integer)

Database dbGetCwp

DBGCWP

Get the current working point in a remote database.

EMPTY

ASCII

· point name (string)

Database dbGetDirAddr

DBGDIRA

Get the direct address of a database point or attribute.

ASCII

· symbolic name (string, maximum 255 characters)

ASCII

· addressing level (string: "plin", "ain", "record", "field")
· plin (integer)
· ain (integer)
· start record (integer)
· end record (integer)
· start field (integer)
· end field (integer)

Database dbGetFamily

DBGFAM

Get plin of parent and children points.

ASCII

· point name (string, maximum 255 characters)

ASCII

· plin of point (integer)
· plin of parent point (integer)
· number of children (integer), followed by list of:
· children plin (integer)

Database dbGetFamilyNames

DBGFAMN

Get name of parent and children points.

ASCII

· point name (string, maximum 255 characters)
· type of symbolic addresses in reply (string: "Absolute", "Relative" or "Alias")

ASCII

· name of parent point (string)
· number of children (integer), followed by list of:
· children name (string)

Database dbGetFieldNames

DBGFNAM

Get field names of table attribute.

ASCII

· attribute name (string, maximum 255 characters)

ASCII

· number of fields (integer), followed by:
· list of field names (string),
· list of field types (string)

Database dbGetParent

DBGPAR

Get plins of parent point.

ASCII

· point name (string, maximum 255 characters)

ASCII

· plin of parent point (integer)

Database dbLoad

DBLOAD

Load the definition of the local database from disk.

ASCII

· path name of root directory (string)

EMPTY

Database dbLoadBranch

DBLDB

Load the definition of a branch of the local database from disk. The current definition is replaced by the new one.

ASCII

· path name of branch root directory (string)
· branch root point name (string, maximum 255 characters)

EMPTY

Database dbLockAttr

DBLCKA

Lock an attribute in a remote database for writing.

ASCII

· attribute name (string, maximum 255 characters)

EMPTY

Database dbLockPoint

DBLCKP

Lock a point in a remote database for read and write access. All the attributes inside the point are locked.

ASCII

· point name (string, maximum 255 characters)
· time-out for retry, in seconds (integer), not implemented on LCUs

EMPTY

Database dbRead

DBREADS

Read a remote scalar database attribute. The attribute is accessed by symbolic name.

ASCII

· attribute name (string, maximum 255 characters)

ASCII

· attribute value

Database dbReadSymbolic

DBREAD

Read a remote database attribute. The attribute is accessed by symbolic name.
This command is also used by the LCU Common Software to access a remote database. The remote database can reside on a workstation (CCS on-line database) or another LCU.

UNFORMATTED BINARY

· database attribute definition:

typedef struct {

dbSYMADDRESS name; /* Name of entry in database */

vltUINT16 maxLen; /* Maximum number of bytes to return */

} dbDBREAD_PARAM;

UNFORMATTED BINARY

· data description:

typedef struct {

dbATTRTYPE attrType, /* Type of attribute */

vltUINT16 bufLen, /* Number of bytes returned for values*/

} dbDBREAD_REPLY;

· type(s) of the value(s) returned (array of dbTYPE), terminated by dbUNDEFINED,
· value(s) of the requested database entry (array of char), the user will
have to know the format of the database entry requested

Database dbSetCwp

DBSCWP

Set the current working point in a remote database.

ASCII

· point name (string, maximum 255 characters)

EMPTY

Database dbUnload

DBULOAD

Unload the definition of the local database to disk.

ASCII

· path name of root directory (string)

EMPTY

Database dbUnloadBranch

DBULDB

Unload the definition of a branch of the local database to disk.

ASCII

· path name of branch root directory (string)
· branch root point name (string, maximum 255 characters)

EMPTY

Database dbUnlockAttr

DBULCKA

Unlock an attribute in a remote database.

ASCII

· attribute name (string, maximum 255 characters)

EMPTY

Database dbUnlockPoint

DBULCKP

Unlock a locked point in a remote database.

ASCII

· point name (string, maximum 255 characters)

EMPTY

Database dbWrite

DBWRITS

Write a remote scalar database attribute. The attribute is accessed by symbolic name.

ASCII

· attribute name (dbSYMADDRESS)

ASCII

· value of attribute to be written

EMPTY

Database dbWriteSymbolic

DBWRIT

Write a remote database attribute. The attribute is accessed by symbolic name.

UNFORMATTED BINARY

· database attribute definition and value:

typedef struct {

dbSYMADDRESS name; /* Name of entry in database */

dbATTRTYPE attrType; /* Type of attribute */

vltUINT16 recCnt; /* Number of records written */

vltUINT16 bufLen; /* Number of bytes in buffer of values*/

} dbDBWRIT_PARAM;

· type(s) of the value(s) written (array of dbTYPE), terminated by dbUNDEFINED,
· value(s) of the written database entry (array of char), the user will
have to know the format of the database entry to write

UNFORMATTED BINARY

· number of bytes written (vltINT32)

Error System errGetFirstBuffer

ERRFRST

At boot time of an LCU, error logging is not enabled until an ERRSTRT command is received. Errors logged during this period are not lost but recorded into a specific start-up error buffer (until the start-up error buffer is full). The ERRFRST command retrieves the start-up error buffer. If a log is recorded in the buffer, the reply is sent as a log message and no normal reply is sent.

EMPTY

UNFORMATTED BINARY

As ERRSTRT

Error System errStartLogging

ERRSTRT

When LCC receives this command all error logs will be sent to the originator of the command. Buffered log data will be sent as reply messages.
The parameter is the process name under which error log servers are registered in the Message System. It is used only when an error stack is received by the LCU in an error reply and the environment name in the stack does not match the environment name of the current error log server. In this case, the LCU will attempt to send the error logging related to that stack to the process whose name is given by the parameter running on the environment given in the stack.

ASCII

· name of error log server process (string, maximum 19 characters)

UNFORMATTED BINARY

· number of errors (vltUINT16)
For each error:
· error definition header:

typedef struct { /* Reply for ERRSTRT command */

ccsTIMEVAL timeStamp; /* Time stamp (UTC) of the error */

ccsSTACK_ID stackId; /* Error stack identifier */

vltUINT16 seqNumber; /* Sequence number in the stack */

ccsPROCNAME processName; /* Name of process that found error */

ccsMODULEID moduleId; /* Name of module that found error */

ccsLOC_ID locId; /* Name of function where error was */

/* found */

vltUINT16 errorNumber; /* Error number */

ccsPROCNUM procNum; /* Procnum of process reporting error*/

vltUINT8 fill[1]; /* Filling characters to have same */

/* structure length on WS and LCU */

} errERRSTRT_REPLY_HEADER;

· error dynamic parameters (null terminated string)

Error System errStopLogging

ERRSTOP

Stop the logging of error messages.

EMPTY

EMPTY

Event Monitoring evtAttach

EVTATT

Request event reports for a database parameter.
For a scalar attribute (or an element of a vector or table), the trigger condition specifies when events are generated: for any write, when the value changes or when the value changes more than the given deadband.
For vectors and table attributes, events are generated for any write.
Event reports are sent as specific messages (msgTYPE_EVENT) in which the message header is followed by the evtEVTREQ_REPLY event report structure, defined in evt.h header file common to CCS and LCC.

ASCII

· parameter name (string, maximum 255 characters)
· trigger condition (string: "AnyWrite", "NotEqual" or "Deadband")

ASCII

Event identifier:
· environment name (string)
· event number (integer)
· filter (integer)

Event Monitoring evtAttachAlarm

EVTATTA

Request abnormal event reports for a database parameter.
Abnormal event reports are sent as specific messages (msgTYPE_ALARM) in which the message header is followed by the evtEVTREQA_REPLY event report structure, defined in evt.h header file common to CCS and LCC.

ASCII

· parameter name (string, maximum 255 characters)

ASCII

Event identifier:
· environment name (string)
· event number (integer)
· filter (integer), not used on LCUs, a zero value is always returned.

Event Monitoring evtConfig

EVTCNF

Configure a database parameter for monitoring.
Values of limits and deadband must be of the same type as the configured parameters. If optional limit is not defined, no alarms for the limit will be generated.

ASCII

· parameter name (string, maximum 255 characters)
· value for high high limit (string, optional)
· value for high limit (string, optional)
· value for low limit (string, optional)
· value for low low limit (string, optional)
· value for deadband (string, optional)

EMPTY

Event Monitoring evtConfigAbnormal

EVTCNFA

Configure a database parameter for abnormal event monitoring.
If an optional alarm number is not defined, no alarm is generated for the corresponding limit.

ASCII

· parameter name (string, maximum 255 characters)
· alarm number for High High limit (integer, optional)
· alarm number for High limit (integer, optional)
· alarm number for Low limit (integer, optional)
· alarm number for Low Low limit (integer, optional)

EMPTY

Event Monitoring evtDetach

EVTDET

Cancel the request of a specific event.

ASCII

Event identifier:
· environment name (string, maximum 7 characters), defaulted with empty
string (target environment),
· event number (integer)
· filter (integer), not used on LCUs, defaulted with a zero value

EMPTY

Event Monitoring evtDisAlarm

EVTDA

Disable the sending of abnormal event reports to the calling process.

EMPTY

EMPTY

Event Monitoring evtDisAllAlarm

EVTDAA

Disable the sending of abnormal event reports to all processes.

EMPTY

EMPTY

Event Monitoring evtDisAllEvent

EVTDAE

Disable the sending of event reports to all processes.

EMPTY

EMPTY

Event Monitoring evtDisEvent

EVTDE

Disable the sending of event reports to the calling process.

EMPTY

EMPTY

Event Monitoring evtEnAlarm

EVTEA

Enable the sending of abnormal event reports to the calling process.

EMPTY

EMPTY

Event Monitoring evtEnAllAlarm

EVTEAA

Enable the sending of abnormal event reports to all processes.

EMPTY

EMPTY

Event Monitoring evtEnAllEvent

EVTEAE

Enable the sending of event reports to all processes.

EMPTY

EMPTY

Event Monitoring evtEnEvent

EVTEE

Enable the sending of event reports to the calling process.

EMPTY

EMPTY

Event Monitoring evtGetAlarmConfig

EVTGCFA

Get the abnormal event monitoring configuration of a database parameter.
The value `-1' is returned for alarm numbers not configured.

ASCII

· parameter name (string, maximum 255 characters)

ASCII

· alarm number for High High limit (integer)
· alarm number for High limit (integer)
· alarm number for Low limit (integer)
· alarm number for Low Low limit (integer)

Event Monitoring evtGetAlarmList

EVTGA

Get the list of database parameters and/or signals for which abnormal event reports are reported to a given process.

ASCII

· environment name of process (string, maximum 7 characters), empty string defaults
to source environment
· process name (string, maximum 19 characters), empty string defaults to source
process

ASCII

· number of items (integer), followed by list of event descriptions:
· parameter and/or signal name (string)
· name of process receiving the event (string)
· environment name of process receiving the event (string)
· event number (string)

Event Monitoring evtGetAllAlarmList

EVTGAA

Get the list of database parameters and/or signals for which abnormal event reports are reported, for all processes.

EMPTY

ASCII

· number of items (integer), followed by list of event descriptions:
· parameter and/or signal name (string)
· name of process receiving the event (string)
· environment name of process receiving the event (string)
· event number (string)

Event Monitoring evtGetAllEventList

EVTGAE

Get the list of database parameters and/or signals for which events are sent.

EMPTY

ASCII

· number of items (integer), followed by list of event descriptions:
· parameter and/or signal name (string)
· name of process receiving the event (string)
· environment name of process receiving the event (string)
· event number (string)
· trigger condition (string)

Event Monitoring evtGetConfig

EVTGCF

Get the event monitoring configuration of a database parameter.
Value `none' is returned for limits or deadband not configured.

ASCII

· parameter name (string, maximum 255 characters)

ASCII

· value for high high limit (string)
· value for high limit (string)
· value for low limit (string)
· value for low low limit (string)
· value for deadband (string)

Event Monitoring evtGetEventList

EVTGE

Get the list of database parameters and/or signals for which events are sent to a given process.

ASCII

· environment name of process (string, maximum 7 characters), empty string defaults
to source environment
· process name (string, maximum 19 characters), empty string defaults to source
process

ASCII

· number of items (integer), followed by list of event descriptions:
· parameter and/or signal name (string)
· name of process receiving the event (string)
· environment name of process receiving the event (string)
· event number (string)
· trigger condition (string)

Event Monitoring evtGetSampleRate

EVTGSR

Get the current sampling rate of monitored input signals.

EMPTY

ASCII

· period (string: "10ms", "100ms", "Sec")
· number of seconds (integer), only for "Sec"

Event Monitoring evtSetSampleRate

EVTSSR

Set the sampling rate of monitored input signals.

ASCII

· period (string: "10ms", "100ms", "Sec")
· number of seconds (integer), used only for "Sec"

EMPTY

Event Monitoring evtSingleDisable

EVTSDI

Disable the sending of a specific event. Events are enabled by default.

ASCII

Event identifier:
· environment name (string, maximum 19 characters), defaulted with empty
string (target environment),
· event number (integer)
· filter (integer), not used on LCUs, defaulted with a zero value

EMPTY

Event Monitoring evtSingleEnable

EVTSEN

Enable the sending of a specific event. Events are enabled by default.

ASCII

Event identifier:
· environment name (string, maximum 7 characters), defaulted with empty
string (target environment),
· event number (integer)
· filter (integer), not used on LCUs, defaulted with a zero value

EMPTY

Signals ioChangeBit

BITCHG

Change the state of a single bit output signal.

ASCII

· signal name (string, maximum 255 characters)

EMPTY

Signals ioClearBit

BITCLR

Set a single bit output signal to its inactive state.

ASCII

· signal name (string, maximum 255 characters)

EMPTY

Signals ioConfigAnalog

AIOCNF

Configure an analog signal.

ASCII

· signal name (string, maximum 255 characters)
· device name (string, maximum 19 characters)
· signal number (integer, 0 to 15)
· input or output (string: "Input" or "Output")
· conversion factor (real)
· lower range (real), used only for output signals
· higher range (real), used only for output signals
· gain factor (string: "1", "10", "100", "500"),
· default simulation value (real)

EMPTY

Signals ioConfigCANAnalogSync

AIOCFS

Configure CAN bus analog input signals to use sync.

ASCII

· device name (string, maximum 19 characters)
· first signal(integer: 0 to 15)
· number of signals(integer: 1 to 15)
· sync enable(logical: TRUE for enabling sync)

EMPTY

Signals ioConfigDigital

DIOCNF

Configure a digital signal.

ASCII

· signal name (string, maximum 255 characters)
· device name (string, maximum 19 characters)
· start bit (integer: 0 to 63)
· bit number (integer: 1 to 32)
· input or output (string: "Input" or "Output")
· signal active level (string: "High" or "Low")
· default simulation value (integer)

EMPTY

Signals ioConfigMenDigital

DIOMCNF

Configure a MEN modul digital signal.

ASCII

· device name (string, maximum 19 characters)
· terminator(logical: enable internal termination of signal)
· MEN M58 port(string: "A", "B", "C" or "D")
· input or output (string: "Input" or "Output")
· enable trig(logical: enable the M58 trig signal)
· latch on trig(logical: enable latching of port A, B and C values on trig signal)
· trig on positive transition(logical)

EMPTY

Signals ioGetAnalogConfig

AIOGCNF

Get the configuration of an analog signal

ASCII

· signal name (string, maximum 255 characters)

ASCII

· device name (string)
· signal number (integer)
· input or output (string: "Input" or "Output")
· conversion factor (real)
· lower range (real), used only for output signals
· higher range (real), used only for output signals
· gain factor (real),
· default simulation value (real)

Signals ioGetDigitalConfig

DIOGCNF

Get the configuration of a digital signal.

ASCII

· signal name (string, maximum 255 characters)

ASCII

· device name (string)
· start bit (integer)
· bit number (integer)
· input or output (string: "Input" or "Output")
· signal active level (string: "High" or "Low")
· default simulation value (integer)

Signals ioGetList

IOGLST

Get the list of all configured signals.

EMPTY

ASCII

· number of signals (integer), then for each signal:
· signal name (string)
· signal type (string: "Analog" or "Digital")
· input or output (string: "Input" or "Output")

Signals ioPulseBit

BITPULS

Pulse a single bit output signal.

ASCII

· signal name (string, maximum 255 characters)
· pulse duration in milliseconds (integer), a duration less than one system tick will
produce a short pulse of about 50 microseconds.

EMPTY

Signals ioReadAnalog

AIOREAD

Read value of an analog input signal.

ASCII

· signal name (string, maximum 255 characters)

ASCII

· signal value (real)

Signals ioReadAnalogRaw

AIORRAW

Read value of an analog input signal.

ASCII

· signal name (string, maximum 255 characters)

ASCII

· signal value (real)
· raw value (real)

Signals ioCANSendSync

AIOSYNC

Send a sync signal to a CAN bus node (device).

ASCII

· device name (string, maximum 19characters)

EMPTY

Signals ioReadDigital

DIOREAD

Read value of a digital input signal.

ASCII

· signal name (string, maximum 255 characters)

ASCII

· signal value (integer)

Signals ioEnableInterrupt

DIOENI

Enable interrupts from a Men M58 digital I/O module

ASCII

· device name (string, maximum 19characters)
· routine(integer: adrress of routine to be called on interrupt)
· parameter(integer: value to be passed to user routine)

EMPTY

Signals ioDisableInterrupt

DIODSI

.Disable interrupts from a Men M58 digital I/O module

ASCII

· device name (string, maximum 19characters)

EMPTY

Signals ioSetAnalogSimValue

AIOSSIM

Set the simulation value of an analog input signal.

ASCII

· signal name (string, maximum 255 characters)
· simulation value (real)

EMPTY

Signals ioSetBit

BITSET

Set a single bit output signal to its active state.

ASCII

· signal name (string, maximum 255 characters)

EMPTY

Signals ioSetDigitalSimValue

DIOSSIM

Set the simulation value of a digital input signal.

ASCII

· signal name (string, maximum 255 characters)
· simulation value (integer)

EMPTY

Signals ioStartSampling

IOSTART

Start monitoring of signals.

ASCII

· scope (string: "All" or "Specific")
· list of digital signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"

EMPTY

Signals ioStopSampling

IOSTOP

Stop monitoring of signals.

ASCII

· scope (string: "All" or "Specific")
· list of digital signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"

EMPTY

Signals ioWriteAnalog

AIOWRIT

Write value of an analog output signal.

ASCII

· signal name (string, maximum 255 characters)
· signal value (real)

EMPTY

Signals ioWriteDigital

DIOWRIT

Write value to a digital output signal.

ASCII

· signal name (string, maximum 255 characters)
· signal value (integer)

EMPTY

LCU Management lccCheckConf

LCCCHK

Check the hardware configuration.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure.

EMPTY

EMPTY

LCU Management lccColdStart

LCCCOLD

Perform a cold-start of the LCU. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure.

ASCII

· end mode (string: "Stand-by", "Stand-alone" or "On-line")

EMPTY

LCU Management lccDevExitSim

LCCOSIM

Notify LCC that a software device exits simulation mode. The LCU is taken to the state LOADED.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure.

ASCII

· device name (string, maximum 19 characters)

EMPTY

LCU Management lccDevEnterSim

LCCISIM

Notify LCC that a software device enters simulation mode.

ASCII

· device name (string, maximum 19 characters)

EMPTY

LCU Management lccGetDevTimeout

DEVGTIM

Get LCC's device timeout value.

ASCII

EMPTY

· timeout value in seconds (integer)

LCU Management lccSetDevTimeout

DEVSTIM

Set LCC's device timeout value.

ASCII

· timeout value in seconds (integer)

EMPTY

LCU Management lccDisSim

LCCDSIM

Disable the LCU simulation mode.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command STOPSIM.

EMPTY

EMPTY

LCU Management lccDisSim

STOPSIM

Disable the LCU simulation mode.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCDSIM.

EMPTY

EMPTY

LCU Management lccEnSim

LCCESIM

Set the LCU in simulation mode.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command SIMULAT.

EMPTY

EMPTY

LCU Management lccEnSim

SIMULAT

Set the LCU in simulation mode.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCESIM.

EMPTY

EMPTY

LCU Management lccGetDeviceList

LCCGDEV

Get list of the software devices configured in the LCU, including the status of each device.

EMPTY

ASCII

· number of devices (integer), then for each device:
· device name (string)
· name of process controlling the device (string)
· device status (string: "Off", "Init", "Ready", "Failure")

LCU Management lccGetDeviceState

LCCGDST

Get the state and simulation status of a software device.

ASCII

· device name (string, maximum 19 characters)

ASCII

· device state (string: "Off", "Loaded", "Stand-by", "On-line")
· simulation status (string "simulation" when in simulation mode, empty when not in
simulation)

LCU Management lccGetId

LCCGID

Get the LCU identification.

EMPTY

ASCII

· node name (string)
· node IP address (integer)
· boot node name (string)
· boot node IP address (integer)

LCU Management lccGetStatus

LCCGST

Get the status of the LCU. This command is equivalent to the command STATE.

EMPTY

ASCII

· current mode (string: "Loaded", "Stand-by", "Stand-alone", "On-line")
· operation being performed (string "Cold start", "Warm start", "Shutdown" or empty)
· initialisation phase (string "initialising" or empty)
· simulation mode (string "simulation mode" or empty)
· devices in simulation mode (string "device in simulation" or empty)

LCU Management lccGetStatus

STATE

Get the status of the LCU. This command is equivalent to the command LCCGST.

EMPTY

ASCII

· current mode (string: "Loaded", "Stand-by", "Stand-alone", "On-line")
· operation being performed (string "Cold start", "Warm start", "Shutdown" or empty)
· initialisation phase (string "initialising" or empty)
· simulation mode (string "simulation mode" or empty)
· devices in simulation mode (string "device in simulation" or empty)

LCU Management lccGetVersion

LCCGVER

Get the version of the LCU Common Software. This command is equivalent to the
command VERSION.

EMPTY

ASCII

· version number (string)

LCU Management lccGetVersion

VERSION

Get the version of the LCU Common Software. This command is equivalent to the command LCCGVER.

EMPTY

ASCII

· version number (string)

LCU Management lccInitFull

LCCINIT

Initializes all devices configured in the LCU. Takes the LCU subsystem from any state to state given by endMode.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command INIT.

ASCII

· end mode (string: "Stand-by", "Stand-alone" or "On-line")
· conditional initialization (string: "Yes", "No"), i.e. if value is "Yes" devices previously
initialized are not initialized any more
· continue on error (string: "Yes", "No")

EMPTY

LCU Management lccInitFull

INIT

Initializes all devices configured in the LCU. Takes the LCU subsystem from any state to state given by endMode.
In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCINIT.

ASCII

· end mode (string: "Stand-by", "Stand-alone" or "On-line")
· conditional initialization (string: "Yes", "No"), i.e. if value is "Yes" devices previously
initialized are not initialized any more
· continue on error (string: "Yes", "No")

EMPTY

LCU Management lccNfs

LCCNFS

Return the NFS devices status

EMPTY

ASCII

· NFS device status.

LCU Management lccOnLine

LCCONLN

Set the LCU in on-line mode. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to
the command ONLINE.

EMPTY

EMPTY

LCU Management lccOnLine

ONLINE

Set the LCU in on-line mode. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCONLN.

EMPTY

EMPTY

LCU Management lccPrintEnvTbl

LCCPET

Return the local environment table

EMPTY

ASCII

· local environment table, e.g. all environments known to the LCU.

LCU Management lccPrintLocalTbl

LCCPLT

Return the local process table.

EMPTY

ASCII

· local process table, e.g. all processes registered in the LCU.

LCU Management lccReboot

LCCBOOT

Reboot the LCU.

ASCII

· generate SYSRESET on the VME bus (string: "Yes" or "No")

EMPTY

LCU Management lccReconfigure

LCCRCNF

Stop the LCU and configure the database and the software. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure.

ASCII

· source (string: "File" or "Buffer")
· buffer with file name for "File" source, or attribute values for "Buffer" source
(string). Same buffer format as dbRestore.

EMPTY

LCU Management lccReload

LCCRLD

Stop the LCU and reload given software modules. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure.

ASCII

· name of file containing name of modules to be reloaded (string)

EMPTY

LCU Management lccSelfTest

LCCTEST

Execute the self-test procedure of the LCU. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This
command is equivalent to the command SELFTST.

EMPTY

EMPTY

LCU Management lccSelfTest

SELFTST

Execute the self-test procedure of the LCU. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCTEST.

EMPTY

EMPTY

LCU Management lccSetDeviceState

LCCSDST

Notify LCC that a software device has changed state.

ASCII

· device name (string, maximum 19 characters)
· new device state (string: "Loaded", "Stand-by", "On-line")

EMPTY

LCU Management lccShutdown

LCCSHUT

Perform a shutdown of the LCU. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is
equivalent to the command OFF.

EMPTY

EMPTY

LCU Management lccShutdown

OFF

Perform a shutdown of the LCU. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCSHUT.

EMPTY

EMPTY

LCU Management lccStandAlone

LCCSTAL

Set the LCU in stand-alone mode. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is
equivalent to the command STANDAL.

EMPTY

EMPTY

LCU Management lccStandAlone

STANDAL

Set the LCU in stand-alone mode. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCSTAL.

EMPTY

EMPTY

LCU Management lccStandBy

LCCSTBY

Set the LCU in stand-by mode. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is
equivalent to the command STANDBY.

EMPTY

EMPTY

LCU Management lccStandBy

STANDBY

Set the LCU in stand-by mode. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCSTBY.

EMPTY

EMPTY

LCU Management lccStop

LCCSTOP

Stop the current LCU management operation. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This
command is equivalent to the command STOP.

EMPTY

EMPTY

LCU Management lccStop

STOP

Stop the current LCU management operation. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure. This command is equivalent to the command LCCSTOP.

EMPTY

EMPTY

LCU Management lccStopWatchdog

WDSTOP

Stop the software watchdog.

EMPTY

EMPTY

LCU Management lccWaitFirstInit

LCCWFST

Wait until the next device has initialised or the time-out expires.

ASCII

· time-out in seconds (integer)

ASCII

· device name (string), empty string is returned if all devices have already initialised.

LCU Management lccWaitFullInit

LCCWFUL

Wait until all the devices have initialised or the time-out expires.

ASCII

· time-out in seconds (integer)

EMPTY

LCU Management lccWarmStart

LCCWARM

Perform a warm-start of the LCU. In case of device error, the list of failed devices is returned in the run-time parameters field of the error structure.

ASCII

· end mode (string: "Stand-by", "Stand-alone" or "On-line")

EMPTY

Logging System logCheckStart

LOGCHK

Check if message logging and error logging have been already started.

EMPTY

ASCII

· logging is started (string: "Yes", "No")
· error logging is started (string: "Yes", "No")

Logging System logDisAnalog

LOGDAIO

Disable the automatic logging of change of value of analog signals.

ASCII

· scope (string: "All" or "Specific")
· list of analog signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"

EMPTY

Logging System logDisDigital

LOGDDIO

Disable the automatic logging of change of value of digital signals.

ASCII

· scope (string: "All" or "Specific")
· list of analog signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"

EMPTY

Logging System logDisMsg

LOGDMSG

Disable the automatic logging of messages sent and received by all processes or by a specific process.

ASCII

· scope (string: "All" or "Specific")
· process name (string, maximum 19 characters), used only when scope is "Specific"

EMPTY

Logging System logDisReadDb

LOGDRDB

Disable the automatic logging of read accesses to the database.

ASCII

· scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"

EMPTY

Logging System logDisWriteDb

LOGDWDB

Disable the automatic logging of write accesses to the database.

ASCII

· scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"

EMPTY

Logging System logEnAnalog

LOGEAIO

Enable the automatic logging of change of value of analog signals.

ASCII

· scope (string: "All" or "Specific")
· list of analog signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"

EMPTY

Logging System logEnDigital

LOGEDIO

Enable the automatic logging of change of value of digital signals.

ASCII

· scope (string: "All" or "Specific")
· list of digital signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"

EMPTY

Logging System logEnMsg

LOGEMSG

Enable the automatic logging of messages sent and received by all processes or by a specific process.

ASCII

· scope (string: "All" or "Specific")
· process name (string, maximum 19 characters), used only when scope is "Specific"

EMPTY

Logging System logEnReadDb

LOGERDB

Enable the automatic logging of read accesses to the database.

ASCII

· scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"

EMPTY

Logging System logEnWriteDb

LOGEWDB

Enable the automatic logging of write accesses to the database.

ASCII

· scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"

EMPTY

Logging System logGetFirstBuffer

LOGFRST

At boot time of an LCU, logging is not enabled until a LOGSTRT command is received. Messages logged during this period are not lost but recorded into a specific start-up log buffer (until the start-up log buffer is full). The LOGFRST command retrieves the start-up log buffer. If a log is recorded in the buffer, the reply is sent as a log message and no normal reply is sent.

EMPTY

UNFORMATTED BINARY

As LOGSTRT

Logging System logGetEventList

LOGGLST

Get list of all events enabled for logging.

EMPTY

ASCII

· number of events (integer), then for each event:
· event type (string: "Message", "Read DB", "Write DB", "Analog", "Digital")
· scope (string: "All" or "Specific")
· name of item (string), item is process, database parameter or signal, only when
scope is "Specific"

Logging System logStartLogging

LOGSTRT

When LCC receives this command all log messages, except error log messages (see command ERRSTRT), will be sent to the originator of the command.Buffered log data will be sent as reply messages.

EMPTY

UNFORMATTED BINARY

· number of logs (vltUINT16)
For each log:
· log definition header:

typedef struct { /* Reply for LOGSTRT command */

ccsTIMEVAL timeStamp; /* Time stamp (UTC) of the log */

ccsPROCNAME processName; /* Name of process requesting log */

ccsMODULEID moduleId; /* Name of module requesting log */

vltUINT8 logId; /* Log format definition identifier */

ccsPROCNUM procNum; /* Procnum of process requesting log*/

vltUINT8 fill[2]; /* Filling characters to have same */

/* structure length on WS and LCU */

} logLOGSTRT_REPLY_HEADER;

· log text (null terminated string)

Logging System logStopLogging

LOGSTOP

Stop the sending of logged data.

EMPTY

EMPTY

Message System msgCheckProcess

MSGCHCK

Check that a process is registered in the Message System.

ASCII

· process name (string, maximum 19 characters)

ASCII

· registration status (string: "Registered" or "Not registered")
· procnum (integer), only when process is registered

Message System msgGetProcesses

MSGGPL

Get a list of all registered processes.

EMPTY

ASCII

· number of processes, followed by list of:
· process name (string)
· procnum (integer)

Message System msgScheduleProcess

MSGSCHP

Schedule a process on the remote environment. This message can only be sent to the "msgServer" process running on each environment. It is not handled by Command Interpreters as other commands.

FORMATTED BINARY

· runstring containing the name of the process to schedule followed by optional
arguments (string). For VxWorks environments, the first word of the runstring shall
be the name of the task entry point. A task will be scheduled with the given entry
point and the complete runstring as unique argument. It is the responsibility of the
scheduled process to parse the arguments in the runstring. The runstring must be in
the format "taskName arg1 arg2 arg3", a string within double quotes with task
name and arguments separated by spaces
· task priority for VxWorks environments or flags for Unix environments (integer)
· task options (integer), used only for VxWorks environments
· stack size (integer), used only for VxWorks environments
· task name (string), used only for VxWorks environments

EMPTY

Message System BREAK

BREAK

Send a BREAK signal to a process. The BREAK handler set by the process when entering the Message System (ccsInit) will be called.

EMPTY

EMPTY

Message System KILL

KILL

Send a KILL signal to a process. The KILL handler set by the process when entering the Message System (ccsInit) will be called.

EMPTY

EMPTY

Timers timerCancelRequest

TIMCAN

Cancel a timer request.

ASCII

· request identifier (integer)

EMPTY

Timers timerGetReport

TIMGREP

Get a formatted report of all timers on the time list.

EMPTY

ASCII

· buffer containing formatted report of all times currently on the time list (string)

Timers timerGetStatus

TIMGST

Get the status of the Time Handling Module.

EMPTY

ASCII

· status of timers 0 to 4 (string: "Free" or "Busy")
· status of 10 ms pulse (string: "Free" or "Busy")
· status of 1s pulse (string: "Free" or "Busy")
· Time Module mode (string: "UTC", "Local" or "Simulation")

Timers timerGetTimerStatus

TIMGTST

Get the status of a timer.

ASCII

· timer identifier (integer: 0 to 4)

ASCII

· timer status (string: "Free" or "Busy")
· start status (string: "Started" or "Not started")
· mode (string: "Once Immediate", "Once after Time", "Once after Gate",
"Periodic Immediate", "Periodic after Time", Periodic after Gate", "After Time",
"After Gate", "On UTC" or "Periodic after UTC")
· time of last interrupt (string: "YY-MM-DD HH:MM:SS.xxxxxx")
· time of next interrupt (string: "YY-MM-DD HH:MM:SS.xxxxxx")

Timers timerScheduleTask

TIMSCHE

Schedule a task synchronised to Time Reference System.

ASCII

· name of task entry point (string)
· task priority (integer: 1 to 255)
· task options (integer)
· task stack size (integer)
· task name (string)
· mode of activation ("Once", "Periodic", "UTC" or "Periodic after UTC")
· start time seconds (integer)
· start time milliseconds (integer)
· interval seconds (integer)
· interval milliseconds (integer)

FORMATTED BINARY

· request identifier (integer)

Timers timerSendCommand

TIMSCMD

Send command synchronised to Time Reference System.

UNFORMATTED BINARY

· message scheduling definition:

typedef struct { /* Parameters of TIMSEND command */

timerSCHEDULE_MODE mode; /* Scheduling mode */

ccsTIMEVAL startTime, /* Start time */

ccsTIMEVAL interval, /* Interval of periodic activation */

msgCMD command, /* Command name */

msgCMDID commandId, /* Command identifier */

ccsENVNAME destenv, /* Where to send the command */

ccsPROCNAME destproc, /* To whom: process name */

msgLENGTH buflen, /* Message length */

} timerTIMSCMD_PARAM;

· message body (array of char)

FORMATTED BINARY

· request identifier (integer)

Timers timerSendReply

TIMSRPY

Send reply synchronised to Time Reference System.

UNFORMATTED BINARY

· message scheduling definition:

typedef struct { /* Parameters of TIMSEND command */

timerSCHEDULE_MODE mode; /* Scheduling mode */

ccsTIMEVAL startTime, /* Start time */

ccsTIMEVAL interval, /* Interval of periodic activation */

msgPROCESSID destId; /* Destination of the reply */

msgCMDID commandId; /* Command Id replied to */

const msgCMD command; /* Command replied to */

msgLENGTH buflen; /* Buffer length. Max len = 8kB. */

vltLOGICAL lastReply; /* Flag to indicate if another */

/* reply follows */
} timerTIMSRPY_PARAM;

· message body (array of char)

FORMATTED BINARY

· request identifier (integer)

Time System timsGetMode

TIMGMOD

Get the operating mode of the Time Handling Module.

EMPTY

ASCII

· mode (string: "UTC", "Local" or "Simulation")

Time System timsGetUTC

TIMGUTC

Get the Universal Coordinated Time and the mode of the Time Module from an LCU.

EMPTY

FORMATTED BINARY

· UTC seconds (integer)
· UTC microseconds (integer)
· Time Module mode (string: "UTC", "Local" or "Simulation")

Time System timsSetMode

TIMSMOD

Set the operating mode of the Time Handling Module.

ASCII

· mode (string: "UTC", "Local" or "Simulation")

EMPTY

Time System timsSetUTC

TIMSUTC

Set the Universal Coordinated Time of an LCU. The Time Module must be in Local or Simulation mode.

FORMATTED BINARY

· UTC seconds (integer)
· UTC microseconds (integer)

EMPTY

6.3 Tools

The following pages give the reference pages of the LCU Common Software Tools: lccdt, lccit, lccBoot, lcustatCheck and lcuwdTrig.

Quadralay Corporation http://www.webworks.com Voice: (512) 719-3399 Fax: (512) 719-3606 sales@webworks.com