| |
|
|
|
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.
· 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.
Parameters in Fixed format consist of a string containing a sequence of parameter values separated by commas.
Parameters in Named Parameters format consist of a string containing a sequence of pairs of parameter name and value.
Parameter names must be prepended with the `-' character, e.g. a parameter of name list shall be given as -list.
Parameters can be given in any order. If a parameter is given twice, only the last occurrence counts.
Logical values shall be input as -flag, where flag is the parameter name, indicating that the value is TRUE.
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.
DESCRIPTION Request a Command Interpreter to load new Command Definition and Command Configuration tables.
PARMATERS · path name of Command Definition table (string)
· path name of Command Configuration table (string)
REPLY · 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.)
REPLY · number of attributes (integer), then for each attribute:
· ain (integer)
· attribute name (string)
REPLY · addressing level (string: "plin", "ain", "record", "field")
· plin (integer)
· ain (integer)
· start record (integer)
· end record (integer)
· start field (integer)
· end field (integer)
REPLY · plin of point (integer)
· plin of parent point (integer)
· number of children (integer), followed by list of:
· children plin (integer)
PARAMETERS · point name (string, maximum 255 characters)
· type of symbolic addresses in reply (string: "Absolute", "Relative" or "Alias")
REPLY · name of parent point (string)
· number of children (integer), followed by list of:
· children name (string)
REPLY · number of fields (integer), followed by:
· list of field names (string),
· list of field types (string)
DESCRIPTION Load the definition of a branch of the local database from disk. The current definition is replaced by the new one.
PARAMETERS · path name of branch root directory (string)
· branch root point name (string, maximum 255 characters)
DESCRIPTION Lock a point in a remote database for read and write access. All the attributes inside the point are locked.
PARAMETERS · point name (string, maximum 255 characters)
· time-out for retry, in seconds (integer), not implemented on LCUs
DESCRIPTION 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.
· 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
PARAMETERS · path name of branch root directory (string)
· branch root point name (string, maximum 255 characters)
· 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
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
PARAMETERS · parameter name (string, maximum 255 characters)
· trigger condition (string: "AnyWrite", "NotEqual" or "Deadband")
DESCRIPTION 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.
REPLY Event identifier:
· environment name (string)
· event number (integer)
· filter (integer), not used on LCUs, a zero value is always returned.
DESCRIPTION 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.
PARAMETERS · 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)
DESCRIPTION Configure a database parameter for abnormal event monitoring.
If an optional alarm number is not defined, no alarm is generated for the corresponding limit.
PARAMETERS · 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)
PARAMETERS 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
DESCRIPTION Get the abnormal event monitoring configuration of a database parameter.
The value `-1' is returned for alarm numbers not configured.
REPLY · 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)
DESCRIPTION Get the list of database parameters and/or signals for which abnormal event reports are reported to a given process.
PARAMETERS · 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
REPLY · 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)
DESCRIPTION Get the list of database parameters and/or signals for which abnormal event reports are reported, for all processes.
REPLY · 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)
REPLY · 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)
DESCRIPTION Get the event monitoring configuration of a database parameter.
Value `none' is returned for limits or deadband not configured.
REPLY · 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)
DESCRIPTION Get the list of database parameters and/or signals for which events are sent to a given process.
PARAMETERS · 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
REPLY · 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)
PARAMETERS · period (string: "10ms", "100ms", "Sec")
· number of seconds (integer), used only for "Sec"
PARAMETERS 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
PARAMETERS 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
PARAMETERS · 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)
PARAMETERS · 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)
REPLY · 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)
REPLY · 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)
REPLY · number of signals (integer), then for each signal:
· signal name (string)
· signal type (string: "Analog" or "Digital")
· input or output (string: "Input" or "Output")
PARAMETERS · 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.
PARAMETERS · scope (string: "All" or "Specific")
· list of digital signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"
PARAMETERS · scope (string: "All" or "Specific")
· list of digital signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION Get list of the software devices configured in the LCU, including the status of each device.
REPLY · 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")
REPLY · device state (string: "Off", "Loaded", "Stand-by", "On-line")
· simulation status (string "simulation" when in simulation mode, empty when not in
simulation)
REPLY · node name (string)
· node IP address (integer)
· boot node name (string)
· boot node IP address (integer)
REPLY · 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)
REPLY · 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)
DESCRIPTION Get the version of the LCU Common Software. This command is equivalent to the
command VERSION.
DESCRIPTION Get the version of the LCU Common Software. This command is equivalent to the command LCCGVER.
DESCRIPTION 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.
PARAMETERS · 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")
DESCRIPTION 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.
PARAMETERS · 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")
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
REPLY FORMAT · source (string: "File" or "Buffer")
· buffer with file name for "File" source, or attribute values for "Buffer" source
(string). Same buffer format as dbRestore.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
PARAMETERS · device name (string, maximum 19 characters)
· new device state (string: "Loaded", "Stand-by", "On-line")
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
DESCRIPTION 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.
PARAMETERS · scope (string: "All" or "Specific")
· list of analog signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"
PARAMETERS · scope (string: "All" or "Specific")
· list of analog signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"
DESCRIPTION Disable the automatic logging of messages sent and received by all processes or by a specific process.
PARAMETERS · scope (string: "All" or "Specific")
· process name (string, maximum 19 characters), used only when scope is "Specific"
PARAMETERS · scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"
PARAMETERS · scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"
PARAMETERS · scope (string: "All" or "Specific")
· list of analog signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"
PARAMETERS · scope (string: "All" or "Specific")
· list of digital signal names (string, maximum 255 characters, maximum 10 values),
used only when scope is "Specific"
DESCRIPTION Enable the automatic logging of messages sent and received by all processes or by a specific process.
PARAMETERS · scope (string: "All" or "Specific")
· process name (string, maximum 19 characters), used only when scope is "Specific"
PARAMETERS · scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"
PARAM. FORMAT · scope (string: "All" or "Specific")
· list of symbolic database parameter names (string, maximum 255 characters,
maximum 10 values), used only when scope is "Specific"
DESCRIPTION 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.
REPLY · 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"
DESCRIPTION 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.
REPLY · registration status (string: "Registered" or "Not registered")
· procnum (integer), only when process is registered
DESCRIPTION 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.
PARAMETERS · 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
DESCRIPTION Send a BREAK signal to a process. The BREAK handler set by the process when entering the Message System (ccsInit) will be called.
DESCRIPTION Send a KILL signal to a process. The KILL handler set by the process when entering the Message System (ccsInit) will be called.
REPLY · 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")
REPLY · 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")
PARAMETERS · 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)
REPLY · UTC seconds (integer)
· UTC microseconds (integer)
· Time Module mode (string: "UTC", "Local" or "Simulation")
DESCRIPTION Set the Universal Coordinated Time of an LCU. The Time Module must be in Local or Simulation mode.
6.3 Tools
 Quadralay Corporation http://www.webworks.com Voice: (512) 719-3399 Fax: (512) 719-3606 sales@webworks.com |
| |
|
|
|