Files
sics/site_ansto/manual/dbSICSch34_fermi_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

574 lines
30 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>SKF Fermi 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 Mirrortron/SKF fermi chopper is a SICS script context object???. </para>
<para>There are 2 choppers, the master chopper which uses the prefix <command>mch</command>
and the slave chopper <command>sch</command>. There should be 2 parts, the script
context object, which has the name <command>/instrument/fermi_chopper</command> and the
2 driveable interfaces to the object, which have the names <command>mchs</command> for
speed and <command>mchp</command> for phase. Hence you can <command>drive</command> and
<command>run</command> the <command>mchs</command> and <command>mchp</command>. With
the master/slave chopper setup, the slave indicates the controller is in PHASE CONTROL
MODE to a master controller. This is required if the slave controller is operating
sub-synchronously to the REFERENCE parameter. </para>
<para>To get other parameters use <command>hget</command> or
<command>/instrument/fermi_chopper/</command>. <command>hset</command> doesn't work
for these nodes. </para>
<variablelist>
<varlistentry>
<term><command>drive mchs</command>
<replaceable> rpm</replaceable>
</term>
<listitem>
<para>Units: RPM</para>
<para>Runs the fermi chopper to <replaceable>rpm</replaceable></para>
<para>Allowed values <command>mchs</command> (master), <command>schs</command>
(slave)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>drive mchp</command>
<replaceable> phase</replaceable>
</term>
<listitem>
<para>Units: ns???</para>
<para>Allowed values <command>mchp</command> (master), <command>schp</command>
(slave)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hlist /instrument/fermi_chopper</command>
</term>
<listitem>
<para>Lists all the <command>fermi_chopper</command> nodes</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset
/instrument/fermi_chopper/</command><replaceable>chopper</replaceable>/<replaceable>node</replaceable>
<replaceable>val</replaceable>
</term>
<listitem>
<para>Set <replaceable>val</replaceable> on a <replaceable>node</replaceable> of
<replaceable>chopper</replaceable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/node</replaceable></term>
<listitem>
<para>Get the value of a <replaceable>chopper/node</replaceable></para>
</listitem>
</varlistentry>
</variablelist>
<para>The fermi chopper is under the
<computeroutput>/instrument/fermi_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.-mirrortron-skf"
>MIRRORTRON/SKF chopper manual</uri> in the NBI content management system.</para>
<para><command>/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable> e.g.
/instrument/fermi_chopper/mch. Contains all the chopper specific parameters</para>
<variablelist>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>device_error</command>
</term>
<listitem>
<para>CHECK this section ???. Inherited from velocity selector documentation</para>
<para>Description???</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>rotation_speed</command>
</term>
<listitem>
<para>Units = rpm</para>
<para>Get the actual speed</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>phase_veto_count</command>
</term>
<listitem>
<para>VETO is the number of TDC pulses that have fallen outside the veto window
or occurred when a Reference Loss alarm was present since the veto count was
last reset.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>phase_nonveto_count</command></term>
<listitem>
<para>NON_VETO is the number of TDC pulses that fall inside the veto window
without Reference Loss alarm being present since the veto count was last
reset</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>phase_acc</command>
</term>
<listitem>
<para>Units = µs</para>
<para>PHASE ACCURACY is calculated as the mean value of phase errors. PHASE
ACCURACY should equal the PHASE DELAY motor parameter when the machine is
phased locked</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>phase_rep</command>
</term>
<listitem>
<para>Units = µs</para>
<para>PHASE REPEATABILITY is the standard deviation of phase.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>phase_ok</command>
</term>
<listitem>
<para>Units = %</para>
<para>PHASE OK is the percentage of TDC pulses that fall in a time window
centered around the Reference-In pulse adjusted for PHASE DELAY. The width
of time window is defined by the VETO WINDOW parameter.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>vetowin100ns</command>
</term>
<listitem>
<para>Units = 100ns</para>
<para>This command sets the VETO WINDOW parameter in volatile memory. (This
parameter returns to its default value when the controller is
re-powered.)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>vetowin50ns</command>
</term>
<listitem>
<para>Units = 50ns</para>
<para>This command sets the VETO WINDOW parameter in volatile memory. (This
parameter returns to its default value when the controller is re-powered.)
Although the parameter is sent with resolution of 10ns, it will be rounded
and used with precision of 50ns. </para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>mode</command>
</term>
<listitem>
<para>Sets the MOTOR CONTROL MODE (0=RPM, 1=PHASE)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>speed_setpt</command>
</term>
<listitem>
<para>Units = RPM</para>
<para>This command sets RUN SPEED set point parameter value in non-volatile
memory. This only sets this value, it does not run the motor to this value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>prop_gain</command></term>
<listitem>
<para>Sets the motor control proportional gain parameter and saves it in
non-volatile memory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>int_gain</command></term>
<listitem>
<para>Sets the motor control integral gain parameter and saves it in
non-volatile memory</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>phase_gain</command></term>
<listitem>
<para>Sets the motor control phase gain parameter and saves it in non-volatile
memory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>ref_delay</command></term>
<listitem>
<para>Units = ms</para>
<para>Sets the phasing time delay and saves it in non-volatile memory</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>ref_period</command></term>
<listitem>
<para>Units = ns</para>
<para>Sets the reference period and saves it in non-volatile memory</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>sync_srce</command></term>
<listitem>
<para>Sets the sync source (0=external, 1=internal)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>motdir</command></term>
<listitem>
<para>Sets the motor direction (0=CW, 1=CCW)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hset hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>idle_toggle</command></term>
<listitem>
<para>???</para>
</listitem>
</varlistentry>
</variablelist>
<para><command>/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status</command>
e.g. /instrument/fermi_chopper/mch/system_status. Contains the system status, which are
chopper specific. <command>hget</command> only. </para>
<para>These are read-only binary, allowed values 0 or 1.</para>
<variablelist>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/avc_on</command></term>
<listitem>
<para>gets the ??? 1=true, 0=false</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/motdir</command></term>
<listitem>
<para>gets the motor direction (0=CW, 1=CCW)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/phase_locked</command></term>
<listitem>
<para>1=TDC signal is locked to reference signal. This corresponds to the PHASE
LOCK relay contact.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/lev_complete</command></term>
<listitem>
<para>1=Rotor is Levitated</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/alarm</command></term>
<listitem>
<para>1=Shutdown is latched. The state of this bit matches the status of the
front panel Fault LED and the SHUTDOWN relay contact.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/run</command></term>
<listitem>
<para>1=Permission to run motor. This is given when the RUN bit is set and the
SHUTDOWN bit is not set. This indicates levitation complete AND position
shutdown alarms are enabled. It matches the status of the RUN relay
contact.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/up_to_speed</command></term>
<listitem>
<para>1=Speed is within 1% of the OPERATING SPEED parameter</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>system_status/ok</command></term>
<listitem>
<para>1=Controller is able and ready to levitate, or is levitating. This
corresponds with the REALY LED flashing or being steady green</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<command>/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status</command>
e.g. /instrument/fermi_chopper/mch/intlck_status. Contains the interlock status. Check
here if a chopper won't do as it is commanded. To run a chopper, all these status must
be 0. <command>hget</command> only. </para>
<para>These are read-only binary, allowed values 0 or 1.</para>
<variablelist>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/test_mode</command></term>
<listitem>
<para>1=Test mode active (rotation prevented).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/cc_shutdown_req</command></term>
<listitem>
<para>1= Motor controller requests shutdown of levitation controller because it
has detected a shutdown condition.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/dsp_summ_shtdwn</command></term>
<listitem>
<para>1= DSP Summary Shutdown. Levitation controller request a motor
shutdown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/cooling_loss</command></term>
<listitem>
<para>1 = Cooling Loss Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/spd_sensor_loss</command></term>
<listitem>
<para>1 = Speed Sensor Loss Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/ref_sig_loss</command></term>
<listitem>
<para>1 = Reference Signal Loss</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/over_temp</command></term>
<listitem>
<para>1= Motor Over Temperature Shutdown or RTD Over Temperature
Shutdown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/vac_fail</command></term>
<listitem>
<para>1 = Vacuum Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/overspeed_or_breakfail</command></term>
<listitem>
<para>1 = Over Speed Trip Shutdown or Motor Brake Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/cc_wd_fail</command></term>
<listitem>
<para>1 = Customer Card Watch Dog Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/ext_fault</command></term>
<listitem>
<para>1 = External Fault Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/ups_fail</command></term>
<listitem>
<para>1= UPS Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/emerg_stop</command></term>
<listitem>
<para>1 = Emergency Stop Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/pos_alarm</command></term>
<listitem>
<para>1 = Position Shutdown on one of the bearing axis</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/osc_fail</command></term>
<listitem>
<para>1 = Oscillator Fail Shutdown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>intlck_status/dsp_wd_fail</command></term>
<listitem>
<para>1 = DSP Watch Dog Fail Shutdown</para>
</listitem>
</varlistentry>
</variablelist>
<para><command>/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/</command>
e.g. /instrument/fermi_chopper/mch/control. Contains the settable parameters that
control the chopper. </para>
<variablelist>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/device_error</command></term>
<listitem>
<para>??? is this the overall error state</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_vetowin100</command></term>
<listitem>
<para>1= Motor controller requests shutdown of levitation controller because it
has detected a shutdown condition.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_vetowin50</command></term>
<listitem>
<para>1= DSP Summary Shutdown. Levitation controller request a motor
shutdown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_mode</command></term>
<listitem>
<para>1 = Cooling Loss Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_rotspeed</command></term>
<listitem>
<para>1 = Speed Sensor Loss Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_prop_gain</command></term>
<listitem>
<para>1 = Reference Signal Loss</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_int_gain</command></term>
<listitem>
<para>1= Motor Over Temperature Shutdown or RTD Over Temperature
Shutdown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_phase_gain</command></term>
<listitem>
<para>1 = Vacuum Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_ref_delay</command></term>
<listitem>
<para>1 = Over Speed Trip Shutdown or Motor Brake Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_ref_period</command></term>
<listitem>
<para>1 = Customer Card Watch Dog Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_sync_source</command></term>
<listitem>
<para>1 = External Fault Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/set_motor_dir</command></term>
<listitem>
<para>1= UPS Fail Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/start</command></term>
<listitem>
<para>1 = Emergency Stop Shutdown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/stop</command></term>
<listitem>
<para>1 = Position Shutdown on one of the bearing axis</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/idle_toggle</command></term>
<listitem>
<para>1 = Oscillator Fail Shutdown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hget
/instrument/fermi_chopper/</command><replaceable>chopper/</replaceable><command>control/reset</command></term>
<listitem>
<para>1 = DSP Watch Dog Fail Shutdown</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>