NEWFIRM INSTRUMENT CONTROL SYSTEM (NICS)

DRAMA Streams and Commands

History
-------
v1.0.0:
 - 22-Jan-2004 P. N. Daly (pnd@noao.edu)
 - original version

Instrument File (nics.inst)
---------------------------
nics
nics DRAMA nics enable

Dictionary (nics.dict)
----------------------
ready		0
wait		1
resume		0
pause		0
break		0 -cmd pause
breakPoint	0
abort		0
title		1
set		2
iadd		2
fadd		2
nics_cover	1 -t nics -tout 30 -end ready
nics_exit	0 -t nics -tout 30
nics_filter	1 -t nics -tout 30 -end ready
nics_fw1	1 -t nics -tout 30 -end ready
nics_fw2	1 -t nics -tout 30 -end ready
nics_help	0 -t nics -tout 30
nics_init    	0 -t nics -tout 30
nics_status	0 -t nics -tout 30
nics_version	0 -t nics -tout 30
endDictionary

Notes:
------

At the time of writing the known filter names and positions are
J, H, Ks, cold dark slide (CDS), blanked off (Blank) and open (Open).

 Pos     FW1     FW2
  1      Open    Open
  2      CDS     CDS
  3      Blank   Blank
  4      Blank   Blank
  5      Open    J
  6      Open    H
  7      Open    Ks
  8      Blank   Blank

Given a filter name, NICC will look up that filter's wheel number and position
in its database, move the appropriate wheel to place the selected filter in the
light path, and move the other wheel to its "Open" position (position 1).

The "Blank" position is nominally associated with setting both filter
wheels to position 8 so that no light reaches the detector.

The "Open" position is nominally associated with setting both filter
wheels to position 1 so that all light reaches the detector.

The numeric value of a filter wheel that is in transit between positions,
and not in any of the 8 defined positions, will be reported as "0".
The filter name in this case will be reported as "between".

DRAMA:
------

The named DRAMA actions result in the following results:

 Action(s):
  Dtcl> drama::obey nics_cover open
 Result:
  Opens the environmental cover

 Action(s):
  Dtcl> drama::obey nics_cover close
 Result:
  Closes the environmental cover

 Action(s):
  Dtcl> drama::obey nics_fw1 4
 Result:
  Moves filter wheel 1 to position 4
 Comment(s):
  Not expected to be used in higher-level software

 Action(s):
  Dtcl> drama::obey nics_fw2 7
 Result:
  Moves filter wheel 1 to position 7
 Comment(s):
  Not expected to be used in higher-level software

 Action(s):
  Dtcl> drama::obey nics_filter J
 Result:
  FW1->1 FW2->5
 Comment(s):
  If FW1 is already in an open position, do not move FW1

 Action(s):
  Dtcl> drama::obey nics_filter H
 Result:
  FW1->1 FW2->6
 Comment(s):
  If FW1 is already in an open position, do not move FW1

 Action(s):
  Dtcl> drama::obey nics_filter Ks
 Result:
  FW1->1 FW2->7
 Comment(s):
  If FW1 is already in an open position, do not move FW1

 Action(s):
  Dtcl> drama::obey nics_filter CDS
 Result:
  FW1->2 FW2->2

 Action(s):
  Dtcl> drama::obey nics_filter Blank
 Result:
  FW1->8 FW2->8
 Comment(s):
  If FW1 is already in a blank position, do not move FW1
  If FW2 is already in a blank position, do not move FW2

 Action(s):
  Dtcl> drama::obey nics_filter Open
 Result:
  FW1->1 FW2->1
 Comment(s):
  If FW1 is already in an open position, do not move FW1
  If FW2 is already in an open position, do not move FW2