Updated user documentation. MK

This commit is contained in:
cvs
2000-02-11 15:21:07 +00:00
parent b98f7db7f6
commit af97d16309
26 changed files with 1506 additions and 394 deletions

View File

@ -41,8 +41,8 @@ reasonable default parameters. </p>
<p>
In the SICS model
a sample environment device has in principle two modes of operation. The first
is the drive modus. The device is monitored in this modus when a new value for it
has been requested. The second modus is the monitor modus. This modus is entered
is the drive mode. The device is monitored in this mode when a new value for it
has been requested. The second mode is the monitor mode. This mode is entered
when the device has reached its target value. After that, the device must be
continously monitored throughout any measurement. This is done through the
environment monitor or <b>emon</b>. The emon understands a few commands of its
@ -65,10 +65,10 @@ section discussing the special devices known to the system.
A <a name="error"> sample</a> environment device may fail to stay at its preset value during a
measurement. This condition will usually be detected by the emon. The question
is how to deal with this problem. The requirements for this kind of error
handling are quite differntiated. The SICS model therefore implements several
handling are quite different. The SICS model therefore implements several
strategies for handling sample environment device failure handling.
The strategy to use is selected via variable which can be set by the user for
any sample environment device separatetly. Additional error handling strategies
The strategy to use is selected via a variable which can be set by the user for
any sample environment device separately. Additional error handling strategies
can be added with a modest amount of programming. The error handling strategies currently
implemented are:
<DL>
@ -122,8 +122,12 @@ out of tolerance errors on that device no longer be handled.
<h3><a name="all">General</a>
Commands UnderStood by All Sample Environment Devices</h3>
<p>
Once the evfactory has been run successfully the controller is
installed as an object in SICS. It is accessible as an object then
under the name specified in the evfactory command. All environemnt
object understand the common commands given below.
Please note that each command discussed below MUST be prepended with the name
of the environment device as configured in EVFavtory!
of the environment device as configured in EVFactory!
</p>
<p>
The general commands understood by any environment controller can be subdivided
@ -134,7 +138,8 @@ set if a parameter is specified. For example:
Temperature Tolerance
</BLOCKQUOTE>
prints the value of the variable Tolerance for the environment controller
Temperature.
Temperature. This is in the same units as the controller operates,
i. e. for a temperature controller Kelvin.
<BLOCKQUOTE>
Temperature Tolerance 2.0
</BLOCKQUOTE>
@ -188,11 +193,11 @@ Additionally the following commands are understood:
<DL>
<DT>send par par ...
<DD>Sends everything after send directly to the controller and return its
response. This is a general purpose command which allows to manipulate controllers
response. This is a general purpose command for manipulating controllers
and controller parameters directly. The protocoll for these commands is
documented in the documentation for each controller. Ordinary users should
not tamper with this. This facility is meant for setting up the device with
calibrartion tables etc.
calibration tables etc.
<DT> list
<DD> lists all the parameters for this controller.
<DT> no command, only name.
@ -202,11 +207,16 @@ current value.
<DD> will drive the device to the new value val. Please note that the same
can be achieved by using the drive command.
<DT> name log on
<DD> Switches logging on. If logging is on, at each cycle in the emon the
<DD> Switches logging on. If logging is on, at each cycle in the
<b>emon</b>
the
current value of the environment variable will be recorded together with a
time stamp. Be careful about this, for each log point a bit of memory is
allocated. At some time the memory is exhausted! Log clear frees it again
and log frequency (both below) allows to set the logging time intervall.
allocated. At some time the memory is exhausted! <b>Log clear</b>
frees
it again
and <b>log frequency</b> (both below)
allows to set the logging time intervall.
<DT> name log off
<DD>Switches logging off.
<DT>name log clear
@ -217,12 +227,11 @@ and log frequency (both below) allows to set the logging time intervall.
<DD> This command retrieves all recorded values.
<DT>name log getmean
<DD>Calculates the mean value and the standard deviation for all logged
values and prints it.
values and prints them.
<DT>name log frequency val
<DD> With a parameter sets, without a parameter requests the logging intervall
for the log created. This parameter specifies the time intervall in seconds
between log records. The default is 5 minutes. A value of 0 means a record any
cycle of the SICServer.
between log records. The default is 300 seconds.
<DT>name log file filename
<DD> Starts logging of value data to the file filename. All normal logging to
memory will be
@ -243,8 +252,9 @@ that special device. All of the general commands listed above work as well!
</p>
<h3><a name="itc4">ITC-4</a> and ITC-503 Temperature Controllers</h3>
<p>
These temperature controller are fairly popular at SINQ. It is manufactured by
Oxford Instruments. At the back side of this controller there is a RS-232
These temperature controller are fairly popular at SINQ. They are
manufactured by
Oxford Instruments. At the back of this controller is a RS-232
socket which must be connected to a Macintosh computer running the SINQ
terminal server program via a serial cable. Please make sure with a different
Macintosh or a PC that the serial line is OK and the ITC-4 responding before
@ -261,10 +271,10 @@ ITC-4 is expected to be connected to the serial port channel at the
Macintosh computer computer running the SINQ terminal server program
listening at port port. For example:
<BLOCKQUOTE>
EVFactory new Temp ITC4 lnsp22.psi.ch 4000 6
EVFactory new Temp ITC4 lnsp22.psi.ch 4000 7
</BLOCKQUOTE>
connects Temp to the Macintosh named lnsp22, serial port 5 (6 above is no typo!),
listening at port 4000.
connects Temp to the Macintosh named lnsp22, serial port 6
(7 above is no typo!), listening at port 4000.
</P>
<h4>ITC-4 Additional Parameters</h4>
<p>
@ -273,7 +283,7 @@ The ITC-4 has a few more parameter commands:
<DT>timeout
<DD>Is the timeout for the Macintosh terminal server program waiting for
responses from the ITC-4. Increase this parameter if error messages
containg ?TMO creeping up.
containg ?TMO appear.
<DT> sensor
<DD> Sets the sensor number to be used for reading temperature.
<DT> control
@ -283,7 +293,7 @@ internally for regulating the ITC-4.
<DD>The ITC4 does not understand floating point numbers, the ITC-503 does.
In order to make ITC4's read and write temperatures correctly floating point
values must be multiplied or divided with a magnitude of 10. This parameter
determines the appropriate value for the sensor. Is usually 10 for a sensor
determines the appropriate value for the sensor. It is usually 10 for a sensor
with one value behind the comma or 100 for a sensor with two values after
the comma.
<DT>multiplicator
@ -325,12 +335,15 @@ current one.
<p>
If the ITC-4 <b>does not respond at all</b>, make sure the serial connection to
the Macintosh is working. Use standard RS-232 debugging procedures for doing
this. The not responding may also come up as a failure to connect to the ITC-4
during startup.
this. The not responding message may also come up as a failure to
connect
to the ITC-4 during startup.
</p>
<p> If error messages containing the string <b>?TMO</b> keep creeping up followed
by all signs of command not understood, then increase the timeout. The standard
timeout of 10 microseconds is to short at times.
<p> If error messages containing the string <b>?TMO</b> keep appearing
up followed
by signs that the command has not been understood, then increase the
timeout. The standard
timeout of 10 microseconds can be to short sometimes.
</p>
<p>
You keep on reading <b>wrong values</b> from the ITC4. Mostly off by a
@ -348,9 +361,10 @@ causes for this problem:
<li>The multiplicator for the control sensor was wrong and the ITC4 has now
a set value which is different from your wishes. You should have got error
messages then as you tried to start the ITC4.
<li>The software is reading back wrong temperature because the sensor and
<li>The software is reading back incorrect temperature values
because the sensor and
divisor parameters are badly configured. Try to read the temperature and if
it does have nothing to do with reality, set parameters accordingly.
it does have nothing to do with reality, set the parameters accordingly.
<li>The tolerance parameter is configured so low, that the ITC4 never
manages to stay in that range. Can also be caused by inappropriate PID
parameters in the ITC4.
@ -365,7 +379,7 @@ within the tolerance. That is the temperature value you wanted after all.
</p>
<h3><a name="haake">Haake</a> Waterbath Thermostat</h3>
<p>
This is sort of a buck full of water equipped with a temperature
This is sort of a bucket full of water equipped with a temperature
control system. The RS-232 interface of this device can only be operated at
4800 baud max. This is why it has to be connected to the serial printer port
of the Macintosh serial port server computer. This makes the channel number to
@ -379,7 +393,7 @@ initialisation parameters, second install the device with evfactory. A
command procedure is supplied for the first step. Thus the initialisation
sequence becomes:
<BLOCKQUOTE>
inihaakearray name-o-array macintosh-computer name port channel<br>
inihaakearray name-of-array macintosh-computer name port channel<br>
evfactory new temperature tcl name-of-array
</BLOCKQUOTE>An example for the SANS:
<BLOCKQUOTE>
@ -519,19 +533,19 @@ serial port 6 at lnsp18.
The additional commands understood by the LTC-11 controller are:
<dl>
<dt>temperature sensor
<dd> allows to query the current sensor used for temperature readout.
<dd> queries the current sensor used for temperature readout.
<dt>temperature sensor val
<dd> allows to select the sensor val for temperature readout.
<dd> selects the sensor val for temperature readout.
<dt>temperature controlanalog
<dd> allows to query the sensor used for controlling the analog channel.
<dd> queries the sensor used for controlling the analog channel.
<dt>temperature controlanalog val
<dd> allows to select the sensor val for controlling the analog channel.
<dd> selects the sensor val for controlling the analog channel.
<dt>temperature controlheat
<dd> allows to query the sensor used for controlling the heater channel.
<dd> queries the sensor used for controlling the heater channel.
<dt>temperature controlheat val
<dd> allows to select the sensor val for controlling the heater channel.
<dd> selects the sensor val for controlling the heater channel.
<dt>temperature mode
<DD>Allows to query if the LTC-11 controls the analog or heater channel.
<DD>queries if the LTC-11 is in analog or heater control mode.
</dl>
</p>
<p>
@ -603,3 +617,5 @@ special commands are supported for the EL755.
</p>
</body>
</html>