First commit for Oxford 12T and Oxford Mercury manual chapters

This commit is contained in:
Nick Hauser
2014-04-14 13:20:41 +10:00
parent b2660cd135
commit 6db328f882
2 changed files with 263 additions and 0 deletions

View File

@ -0,0 +1,164 @@
<?xml version="1.0" encoding="UTF-8"?>
<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<info><title>Oxford 12T Magnet and/or Dilution Controller (via Labview App)</title><author>
<personname>Ferdi Franceschini</personname>
</author>
<date>2008-08-29 16:47</date>
</info>
<sect1>
<title>Configuration</title>
<para>For instrument scientists only</para>
<para>At the command line of your ics (instrument control server) computer type</para>
<para><command>runsics stop</command></para>
<para>This stops SICS, in preparation to make configuration changes.</para>
<para><command>configsics</command></para>
<para>This launches an application that will modify the SICS configuration for sample
environment. Follow the instructions at the top of the screen</para>
<para>Select </para>
<para><command>[x] 12tmagnet:</command></para>
<para><command>w</command> to write and exit configsics</para>
<para><command>runsics start</command></para>
<para>This will restart SICS with the new sample environment configuration. </para>
</sect1>
<sect1>
<title>Commands</title>
<annotation><para>from sct_oxford_labview.tcl</para></annotation>
<variablelist>
<varlistentry>
<term><command>oxfordsetfield </command><replaceable>n</replaceable></term>
<listitem>
<para>Set the magnetic field to <replaceable>n</replaceable> Tesla</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>oxfordsetrate </command><replaceable>n</replaceable></term>
<listitem>
<para>Set the magnet field ramp rate to <replaceable>n</replaceable> Tesla /
minute ??? check units</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>oxfordsethtemp </command><replaceable>n</replaceable></term>
<listitem>
<para>Set the Heliox temperature to <replaceable>n</replaceable> K </para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>oxfordsetdtemp </command><replaceable>n</replaceable></term>
<listitem>
<para>Set the Dilution Insert temperature to <replaceable>n</replaceable>
K</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>oxfordseths </command><replaceable>ON/OFF</replaceable></term>
<listitem>
<para>Turn the heater switch <replaceable>ON/OFF</replaceable> ??? </para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1>
<title>Parameters</title>
<variablelist><varlistentry>
<term><command>/sample/magnetic/field </command></term><listitem><para>???</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/magneticFieldCurrent </command></term><listitem><para>Magnet current (amps)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/magneticFieldTesla </command></term><listitem><para>Magnetic field (Tesla)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/start_magnetic </command></term><listitem><para>Start value for a magnetic field ramp (Tesla)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/end_magnetic </command></term><listitem><para>For a magnetic field ramp, this is the end value (Tesla)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/Temp </command></term><listitem><para>Temperature on main control sensor (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/Temp_s1 </command></term><listitem><para>Temperature on sensor 1 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/Temp_s2 </command></term><listitem><para>Temperature on sensor 2 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/Temp_s3 </command></term><listitem><para>Temperature on sensor 3 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/start_temperature_s1 </command></term><listitem><para>Start value for a temperature ramp using sensor 1 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/end_temperature_s1 </command></term><listitem><para>End value for a temperature ramp using sensor 1 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/start_temperature_s2 </command></term><listitem><para>Start value for a temperature ramp using sensor 2 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/end_temperature_s2 </command></term><listitem><para>End value for a temperature ramp using sensor 2 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/start_temperature_s3 </command></term><listitem><para>Start value for a temperature ramp using sensor 3 (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/end_temperature_s3 </command></term><listitem><para>End value for a temperature ramp using sensor 3 (K)</para></listitem>
</varlistentry>
<!-- Setting Magnetic field -->
<varlistentry>
<term><command>/sample/magnetic/fieldSetPoint </command></term><listitem><para>Setpoint for magnetic field (Tesla)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/fieldSetRate </command></term><listitem><para>Magnetic field rate (Tesla/min)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/HelioxTempSetPoint </command></term><listitem><para>Setpoint for Heliox (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/HelioxTempReading </command></term><listitem><para>Temperature reading for Heliox (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/DilutTempSetPoint </command></term><listitem><para>Setpoint for Dilution Insert (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/DilutTempReading </command></term><listitem><para>Temperature reading for Dilution Insert (K)</para></listitem>
</varlistentry>
<!-- If TUNING -->
<varlistentry>
<term><command>/sample/magnetic/set_rate </command></term><listitem><para>Magnetic field rate (Tesla/min)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/set_magneticField </command></term><listitem><para>Setpoint for magnetic field (Tesla)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/set_DiluxTemp </command></term><listitem><para>Setpoint for Dilution Insert (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/set_HelioxTemp </command></term><listitem><para>Setpoint for Heliox (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/magnetic/set_HeaterSwitch </command></term><listitem><para>Turn heater switch ON and OFF</para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1>
<title>Description</title>
<para>No additional descriptions available at this time. </para>
</sect1>
<sect1>
<title>Known Issues</title>
<para>Alerts the user to known operational problems</para>
</sect1>
<sect1>
<title>Troubleshooting</title>
<para>What to do if things go wrong</para>
</sect1>
</chapter>

View File

@ -0,0 +1,99 @@
<?xml version="1.0" encoding="UTF-8"?>
<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<info><title>Oxford Mercury Controller</title><author>
<personname>Ferdi Franceschini</personname>
</author>
<date>2008-08-29 16:47</date>
</info>
<sect1>
<title>Configuration</title>
<para>For instrument scientists only</para>
<para>At the command line of your ics (instrument control server) computer type</para>
<para><command>runsics stop</command></para>
<para>This stop SICS, in preparation to make configuration changes.</para>
<para><command>configsics</command></para>
<para>This launches an application that will modify the SICS configuration for sample
environment. Follow the instructions at the top of the screen </para>
<para>Select </para>
<para><command>[x] mercury_scipi:</command></para>
<para><command>w</command> to write and exit configsics</para>
<para><command>runsics start</command></para>
<para>This will restart SICS with the new sample environment configuration.</para>
</sect1>
<sect1>
<title>Commands</title>
<para>No commands at this time</para>
</sect1>
<sect1>
<title>Parameters</title>
<annotation><para>from sct_oxford_mercury.tcl</para></annotation>
<variablelist>
<varlistentry>
<term><command>/sample/oxford_mercury/Level</command></term><listitem>
<para>This is the root node for the cryogen levels</para>
<para>Under the Level node are the following commands </para></listitem>
</varlistentry>
<varlistentry>
<term><command>Helium</command></term><listitem><para>Level of liquid helium (%)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>Nitrogen</command></term><listitem><para>Level of liquid nitrogen (%)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/oxford_mercury/device_state</command></term><listitem>
<para>This provides the state of the device</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>/sample/oxford_mercury/Loop1</command></term><listitem><para>This is the root node for each Loop. </para>
<para>There are 4 loops for the Mercury: </para>
<para>Loop1</para>
<para>Loop2 </para>
<para>Loop3</para>
<para>Loop4</para>
<para>Under each Loop node are the following commands e.g.
<command>/sample/oxford_mercury/Loop1/setpoint</command></para></listitem>
</varlistentry>
<varlistentry>
<term><command>setpoint</command></term><listitem><para>Setpoint temperature (K)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>sensor</command></term><listitem><para>sensor reading in K</para></listitem>
</varlistentry>
<varlistentry>
<term><command>power</command></term><listitem><para>Heater power (W)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>nick</command></term><listitem><para>what the loop is labelled on screen (e.g. sampletop)</para></listitem>
</varlistentry>
<varlistentry>
<term><command>temp</command></term><listitem><para>Under construction. May be deprecated. TEMP structure</para></listitem>
</varlistentry>
<varlistentry>
<term><command>loop</command></term><listitem>
<para>Under construction. May be deprecated. LOOP structure</para></listitem>
</varlistentry>
<varlistentry>
<term><command>heater</command></term><listitem><para>Under construction. May be deprecated. HTR structure</para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1>
<title>Description</title>
<para>No additional descriptions available at this time. </para>
</sect1>
<sect1>
<title>Known Issues</title>
<para>Alerts the user to known operational problems</para>
</sect1>
<sect1>
<title>Troubleshooting</title>
<para>Check that the Mercury has been set into remote mode using the SCPI protocol. If it
still doesnt talk then the line terminator is probably wrong. Call a SICS developer or
try to fix it through trial and error by changing the line terminator in the
/usr/local/sics/sics_config.ini file</para>
</sect1>
</chapter>