Files
sics/site_ansto/manual/dbSICSch32_platypus_disk_chopper.xml
Nick Hauser cbcd98c10c Manual copied from ANSTO branch and committed to RELEASE-3_0 branch.
This directory was accidentally omitted from the merge-release branch during the PSI code merge.
2013-10-28 11:22:59 +11:00

307 lines
14 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>Astrium Disk Chopper. Under construction.</title><author>
<personname>Nick Hauser</personname>
</author>
<date>2009-03-31 15:50</date>
</info>
<sect1>
<title>Commands</title>
<para>This chapter is untested documentation. It was inherited from the velocity selector
documentation, with alterations based on an email from Ferdi to Andy on 11th May 2011. </para>
<para>The Astrium Disk Chopper is a SICS script context object???. There should be 2 parts,
the script context object, which has the name
<command>/instrument/disk_chopper</command> and the 2 driveable interfaces to the
object, which have the names <command>chopper_speed</command> and
<command>chopper_phase</command>. Hence you can <command>drive</command> and
<command>run</command>
<command>chopper_speed</command> and <command>chopper_phase</command>. To get other
parameters use <command>hget</command> or <command>/instrument/disk_chopper/</command>.
<command>hset</command> doesn't work for these nodes. </para>
<variablelist>
<varlistentry>
<term><command>run chopper_speed</command>
<replaceable> rpm</replaceable>
</term>
<listitem>
<para>Not implemented</para>
<para>Units: RPM</para>
<para>Runs the disk chopper to <replaceable>rpm</replaceable></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>drive chopper_phase</command>
<replaceable> phase_angle</replaceable>
</term>
<listitem>
<para>Not implemented</para>
<para>Units: Angstroms</para>
<para>Is the same as <command>run</command> but it blocks the client that
requested the <command>drive</command> from issuing commands until the task
has finished.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget /instrument/disk_chopper/ch1/state </command></term>
<listitem>
<para>Get the state of chopper 1 <command>ch1</command>. The normal operating
state under SICS control is <computeroutput>CONTROL</computeroutput>.
Check???</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hlist /instrument/disk_chopper</command>
</term>
<listitem>
<para>Lists all the <command>disk_chopper</command> nodes</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset
/instrument/disk_chopper/</command><replaceable>chopper</replaceable>/<replaceable>node</replaceable>
<replaceable>val</replaceable>
</term>
<listitem>
<para>Not implemented</para>
<para>Set <replaceable>val</replaceable> on a <replaceable>node</replaceable> of
<replaceable>chopper</replaceable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/node</replaceable></term>
<listitem>
<para>Get the value of a <replaceable>chopper/node</replaceable></para>
</listitem>
</varlistentry>
</variablelist>
<para>The disk chopper is under the
<computeroutput>/instrument/disk_chopper</computeroutput> node in hipadaba, which is
where it will be found when using the Gumtree TableTree. This complies with the NeXus
standard. </para>
</sect1>
<sect1>
<title>Parameters</title>
<para>For more detailed description of these parameter, please see the <uri
xlink:href="http://cms.nbi.ansto.gov.au/devices/chopper">ASTRIUM chopper
manual</uri> in the NBI content management system.</para>
<para>There are 2 levels in the tree. </para>
<para><command>/instrument/disk_chopper/</command> This level contains the frequently used
speed and phase values for each chopper, and the overall error state.</para>
<para><command>/instrument/disk_chopper/</command><replaceable>chopper/</replaceable> e.g.
/instrument/disk_chopper/ch1. The lower level contains all the chopper specific
parameters</para>
<variablelist>
<title>Chopper general commands</title>
<varlistentry>
<term><command>hget /instrument/disk_chopper/device_error</command>
</term>
<listitem>
<para>to do ???</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget /instrument/disk_chopper/geometry</command>
</term>
<listitem>
<para>to do ???</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/<replaceable>ch1speed</replaceable></command>
</term>
<listitem>
<para>Units: RPM</para>
<para>Actual speed ???</para>
<para>Allowable values:</para>
<para><option>ch1speed</option></para>
<para><option>ch2speed</option></para>
<para><option>ch3speed</option></para>
<para><option>ch4speed</option></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/<replaceable>ch1phase</replaceable></command>
</term>
<listitem>
<para>Units: degrees</para>
<para>Phase referenced to ???</para>
<para>Allowable values:</para>
<para><option>ch1phase</option></para>
<para><option>ch2phase</option></para>
<para><option>ch3phase</option></para>
<para><option>ch4phase</option></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hlist
/instrument/disk_chopper/<replaceable>ch1</replaceable>/</command>
</term>
<listitem>
<para>Specific chopper nodes</para>
<para>Allowable values:</para>
<para><option>ch1</option></para>
<para><option>ch2</option></para>
<para><option>ch3</option></para>
<para><option>ch4</option></para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<title>Chopper specific commands</title>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>state</command>
</term>
<listitem>
<para>CHECK this section ???. Inherited from velocity selector documentation</para>
<para>Privilege = User</para>
<para>Get the state.</para>
<para><option>IDLING</option> Is not being controlled. Should be at zero rpm.???
Check</para>
<para><option>RESET</option> A reset has been issued by the disk chopper client
program </para>
<para><option>CONTROL</option> Control has been requested by SICS or the disk
chopper client program</para>
<para><option>BRAKING</option> The disk chopper has the brake applied due to an
<command>hset setstate brake</command> request, the
<guibutton>Brake</guibutton> button applied on the disk chopper client
program, or due to a fault condition</para>
<para><option>POWERLOSS MEASUREMENT</option>
<guibutton>Powerloss measurement </guibutton>button applied on the disk
chopper client program </para>
<para><option>EMERGENCY STOP</option>
<guibutton>Emergency stop</guibutton> button applied on the disk chopper
client program </para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>aspeed</command>
</term>
<listitem>
<para>Units = rpm</para>
<para>Get the actual speed</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>aphase</command>
</term>
<listitem>
<para>Units = degrees</para>
<para>Get the actual phase</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>aveto</command></term>
<listitem>
<para>Get the veto state</para>
<para>Returned values:</para>
<para><option>nok</option> not OK</para>
<para><option>ok</option> OK</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>dir</command>
</term>
<listitem>
<para>Units = Celsius</para>
<para>Get the cooling water inlet temperature</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>flowr</command>
</term>
<listitem>
<para>Units = litres/min</para>
<para>Get the cooling water flow rate</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>rspeed</command>
</term>
<listitem>
<para>Units = rpm</para>
<para>Get the requested speed</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>rphase</command>
</term>
<listitem>
<para>Units = degrees</para>
<para>Get the requested phase</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>mtemp</command>
</term>
<listitem>
<para>Units = Celsius</para>
<para>Get the ???? temperature </para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>wtemp</command>
</term>
<listitem>
<para>Units = Celsius</para>
<para>Get the cooling water outlet temperature </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>mvacu</command>
</term>
<listitem>
<para>Units = 10<superscript>-3</superscript>bar</para>
<para>Get the vacuum</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>monit</command></term>
<listitem>
<para>????</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>mvibr</command></term>
<listitem>
<para>Units = mm/s ???</para>
<para>Get the vibration</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>date</command></term>
<listitem>
<para>???</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/disk_chopper/</command><replaceable>chopper/</replaceable><command>time</command></term>
<listitem>
<para>???</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>