man5/lim_conf
Table of Contents
lim_conf - limits processing configuration file
LIMmngr(8)
uses information from this file to determine what parameters to monitor
and how to monitor them.
Each line in the configuration
file is one entry. The file may contain blank lines. Lines starting with
a
# are treated as comment lines.
| is used as a field separator.
Entries
in the configuration file consist of a several fields all of which are
required.
The fields appear in the file in this order: recid, c_lbl, c_ref,
r_lbl, r_ref, ena_lbl, ena_ref, lim_lbl, lim_ref, del_lbl, del_ref, w_size,
tmo, M, and B.
As already mentioned above each field is separated by a "|".
Whitespace, i.e. space characters may be used as padding within a field,
for example to make the lines of the file "line up". The whitespace is removed
when the file is loaded.
Extra whitespace before or after the Label and
RefName fields is removed. However, as usual for AccelNET parameter tagnames
whitespace within a label or refname is significant and must be entered
properly into the configuration file.
Parameters
marked "required" must be supplied with a valid AccelNET tagname.
Parameters
marked "optional" may be supplied with a valid AccelNET tagname or with
"NULL" in both the label and the refname fields.
Parameters not otherwise
marked must be supplied with a valid value.
- recid - required
An integer value used to identify an entry. There must be a unique value
for every entry, however the values do not need to be contiguous. - c_lbl/c_ref
- required
The tagname for the parameter which sets the value of the device being
checked.
- r_lbl/r_ref - required
The tagname for the parameter which reads the value of the device being
checked.
- ena_lbl/ena_ref - optional
The tagname for the parameter which indicates the device is enabled, for
example, the power status control.
The expected values are:
0.0 = off
1.0 = on
If the tagname fields are "NULL" LIMmngr(8)
will treat the entry
as enabled at all times.
- lim_lbl/lim_ref - optional
The tagname for the parameter which indicates the status of the limit check.
This parameter must be writable by LIMmngr(8)
.
The values used to update
the parameter are:
0.0 = In Limit
1.0 = Out of Limit
- del_lbl/del_ref - optional
The tagname for the parameter used to display the difference between the
control and the readback.
This parameter must be writable by LIMmngr(8)
.
- w_size - required
The size of the in-limit window.
- tmo - required
The amount of time (in seconds) to wait before declaring an error.
- M/B
- required
Scaling coefficients used to scale the readback to the control before subtracting
the difference between them.
#
# Example LIMmngr configuration file
#
# This example contains two entries for monitoring an arc power supply.
# One lines monitors CR and the other monitors the VR.
#
# The power supply is current controlled so the CR test is a direct
# comparision between the CC and the CR
#
# The VR test is a bit more subtle. In this case we are assuming
# (somewhat fictiously) a linear relationship between the VR and CC.
# The M and B values are set to scale the VR to the CC.
#
# A single line of the configuration file is much too long to fit
# into the manual page so each line is broken into two parts.
#
# The 1st part of the header and the first part of the two example
# lines are shown together followed by a blank line and the remainder
# of the header lines and the examples.
#
# Normally in the configuration file each of these would be one
# contiguous line.
#
#
#recid|c_lbl |c_ref |r_lbl |r_ref |ena_lbl |ena_ref |
#-----|--------|--------|--------|--------|--------|--------|
1|ARC S1-1|CC |ARC S1-1|CR |ITX S1-1|PwrSR |
2|ARC S1-1|CC |ARC S1-1|VR |ITX S1-1|PwrSR |
lim_lbl |lim_ref |del_lbl |del_ref |w_size |tmo |M |B
--------|--------|--------|--------|--------|----|-----|----
ARC S1-1|LimitCR |ARC S1-1|DeltaCR |0.1 |2 |1.0 |0.0
ARC S1-1|LimitVR |ARC S1-1|DeltaVR |0.1 |2 |0.5 |0.0
LIMmngr.8
$Id: lim_conf.5,v 1.0 2006/05/23 17:42:52 kitchen Exp
$
Table of Contents
NARA 5SDH-2
