39b841aee3
converted from a Word document to docbook, for integration into Gumtree help, and to have under source control.
164 lines
8.3 KiB
XML
164 lines
8.3 KiB
XML
<?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><superscript>3</superscript>He</title><author>
|
||
<personname>Ferdi Franceschini</personname>
|
||
</author>
|
||
<date>2008-08-29 16:47</date>
|
||
</info>
|
||
<sect1>
|
||
<title>Introduction</title>
|
||
<para>The system of <superscript>3</superscript>He project consists of a polarizer and analyser which are controlled by
|
||
Labview servers. The two Labview servers run on one machine and communicate with a
|
||
corresponding SICS driver over TCP/IP. The polarizer and analyser share a single NI I/O
|
||
board and a HMP2030 power supply. </para>
|
||
<para>TCP port for polariser – 55011</para>
|
||
<para>TCP port for analyser – 55012 </para>
|
||
</sect1>
|
||
<sect1>
|
||
<title>Configuration</title>
|
||
<para><emphasis role="bold">TBD</emphasis>: How to get this running in SICS</para>
|
||
<para>e.g.</para>
|
||
<para>
|
||
<orderedlist>
|
||
<listitem xmlns:xi="http://www.w3.org/2001/XInclude">
|
||
<para><literal>cd /usr/local/nbi/sics/taipan/</literal></para>
|
||
</listitem>
|
||
<listitem xmlns:xi="http://www.w3.org/2001/XInclude">
|
||
<para><literal>> vim taipan_setup.txt</literal></para>
|
||
</listitem>
|
||
</orderedlist>
|
||
</para>
|
||
<para>0 = off, 1 = on</para>
|
||
<para>Save the file and restart SICS.</para>
|
||
</sect1>
|
||
<sect1>
|
||
<title>Commands</title>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><command>PolTrigger </command><replaceable>val</replaceable></term>
|
||
<listitem>
|
||
<para>Turn the magic box polariser on and off. </para>
|
||
<para>Allowed <replaceable>val</replaceable>
|
||
</para>
|
||
<para><option>0</option> polariser off </para>
|
||
<para><option>1</option> polariser on </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>AnaTrigger </command><replaceable>val</replaceable></term>
|
||
<listitem>
|
||
<para>Turn the magic box analyser on and off. </para>
|
||
<para>Allowed <replaceable>val</replaceable>
|
||
</para>
|
||
<para><option>0</option> analyser off </para>
|
||
<para><option>1</option> analyser on </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>PolRecord</command></term>
|
||
<listitem>
|
||
<para>This command will manually trigger a logging event of the polariser
|
||
parameters:</para>
|
||
<para>amplitude</para>
|
||
<para>frequency </para>
|
||
<para>state</para>
|
||
<para>The data is appended to a dedicated log file. </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>AnaRecord </command><replaceable>val</replaceable></term>
|
||
<listitem>
|
||
<para>This command will manually trigger a logging event of the analyser
|
||
parameters:</para>
|
||
<para>amplitude</para>
|
||
<para>frequency </para>
|
||
<para>state</para>
|
||
<para>The data is appended to a dedicated log file. </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>hmpVolt </command><replaceable>chID val</replaceable></term>
|
||
<listitem>
|
||
<para>Units: V (volt)</para>
|
||
<para>set or get the voltage at channel <replaceable>chID</replaceable>. (???
|
||
which channel does the 3He system use. ). </para>
|
||
<para>If <replaceable>val</replaceable> is not provided, returns the the voltage
|
||
and current setpoints and measurements of channel
|
||
<replaceable>chID</replaceable>. Otherwise it first sets the voltage of
|
||
channel <replaceable>chID</replaceable> to <replaceable>val</replaceable>
|
||
and then as a verification it displays the voltage and current setpoints and
|
||
measurements</para>
|
||
<para>Allowed <replaceable>chID</replaceable> ???</para>
|
||
<para>What is a reasonable voltage ??? </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>hmpCurr </command><replaceable>chID val</replaceable></term>
|
||
<listitem>
|
||
<para>Units: A (ampere)</para>
|
||
<para>set or get the current at channel <replaceable>chID</replaceable>. (???
|
||
which channel does the 3He system use. ). </para>
|
||
<para>If <replaceable>val</replaceable> is not provided, returns the the voltage
|
||
and current setpoints and measurements of channel
|
||
<replaceable>chID</replaceable>. Otherwise it first sets the current of
|
||
channel <replaceable>chID</replaceable> to <replaceable>val</replaceable>
|
||
and then as a verification it displays the voltage and current setpoints and
|
||
measurements</para>
|
||
<para>Allowed <replaceable>chID</replaceable> ???</para>
|
||
<para>What is a reasonable current ??? </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>hmpMeas </command><replaceable>chID </replaceable></term>
|
||
<listitem>
|
||
<para>Units: V (volt) A (ampere)</para>
|
||
<para>get the current and voltage at channel <replaceable>chID</replaceable>. </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>hmpSet </command><replaceable>chID current voltage</replaceable></term>
|
||
<listitem>
|
||
<para>Units: A (ampere) V (volt) </para>
|
||
<para>set the current and voltage at channel <replaceable>chID</replaceable>. (???
|
||
which channel does the 3He system use. ). </para>
|
||
<para>As a verification it displays
|
||
the voltage and current setpoints and measurements</para>
|
||
<para>Allowed <replaceable>chID</replaceable> ???</para>
|
||
<para>What is a reasonable current ??? </para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><command>hmpOutput </command><replaceable>chID state</replaceable></term>
|
||
<listitem>
|
||
<para>get or set the output state at channel <replaceable>chID</replaceable>.</para>
|
||
<para>If <replaceable>state</replaceable> is not provided, returns the output
|
||
state of channel <replaceable>chID</replaceable>. Otherwise it sets the
|
||
output state of channel <replaceable>chID</replaceable> to
|
||
<replaceable>state</replaceable>. </para>
|
||
<para>Allowed <replaceable>state</replaceable></para>
|
||
<para>on off</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</sect1>
|
||
<sect1>
|
||
<title>Parameters</title>
|
||
<para></para>
|
||
</sect1>
|
||
<sect1>
|
||
<title>Description</title>
|
||
<para>Explanation of what a command is doing when it is more than just setting a target
|
||
value. e.g. changing magnetic field in a superconducting magnet. </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>
|