==========================
  PROGRAM >> HVCONTROL <<                        PHENIX ONCS group;
==========================                       updated program description:
                                                 Johann M. Heuser, 6/6/2000


This program was developed for the use of controlling high voltage systems
and testing the high voltage modules as a part of Phenix project.
HVCONTROL is a debugging program that runs on crate controllers (IOCs). It 
does not make use of the classes or EPICS at all -- instead, it sends LeCroy 
mainframe commands, similiar to the ones used in a serial connection, to the 
mainframe via the ARCNET.  HVCONTROL is arranged to be a bit more user-friendly 
than a VT100 serial port session, and is generally preferrable.  This program 
requires that the IOC be booted with a separate file that doesn't load the 
EPICS records; the IOC has a driver and this program loaded onto it instead.  
This program is run while remotely logged onto the IOC. 

This program won't work properly with mainframes that have more than 99 slots.
It is ... assuming that 1458 high voltage mainframes are used.
      ... assuming that the max number of submodules in a module is 2.
      ... assuming that the max number of channels in a submodules is 24.
If any of these values are needed to be changed, please go to the source 
code file "HiV.h" and change some of the defined values.



path on phoncs:
===============
/export/software/oncs/epics/R3.13.0.beta11/epicsB/app/hvcontrol
          --> hvcontrol's source code

/export/software/oncs/epics/R3.13.0.beta11/epicsB/app/hvcontrol/ioc
           --> load_hvcontrol_iocondev3  (west arm)
           --> load_hvcontrol_iocondev5  (east arm)
           --> load_hvcontrol_iocondeve  (test stand)
 
---------------------------------------------------------------------------


How to use the program:
=======================
0, restart the IOC and proceed with the next steps from the boot prompt.

1, remote-shell to the IOC that you will be working on:
   e.g.  rsh iocondev3

2, go to the right directory, use VxWorks syntax:
   cd "/export/software/oncs/epics/R3.13.0.beta11/epicsB/app/hvcontrol/ioc"

3, load the matching file >>load_hvcontrol_iocondev#<< to VxWorks:
   e.g. <load_hvcontrol_iocondev3

4, run the program by typing "hvcontrol"; see the program's command 
   list below.

5, When you finished working with HVCONTROL, you need to reboot the crate 
   controller again to load EPICS.


HVCONTROL Commands:
===================

      chmf: to change the current working main frame ! 
      cd  : go back to the main frame from looking at a specific slot! 
      cd slot : select which specific slot you wan to look at! 
      clear : clear the screen! 
      direct mode : this allows you to enter original MF commands       !!! seems
                    directly,if you want to enter MF commands directly  !!! NOT
                    without going into the direct mode, you can simply  !!! to work
                    put a "/" in the front of the command.              !!! properly!!!
      echo off : no direct reply from MF is showing on STO 
      echo on : direct reply from MF will be showing on STO 
      empty slots : list all the empty slots in the current mainframe. 
      empty slots (m1)-(m2) : list all the empty slots in mainframe (m1) 
                              to mainframe (m2) 
      hvoff : turn off the high voltage 
      hvoff all : turn off the high voltage for all the mainframes 
      hvoff (m1)-(m2) : turn off the high voltage from mainframe (m1) to 
                        mainframe (m2) 
      hvon : turn on the high voltage 
      hvon all: turn on the high voltage for all the mainframes 
      hvon (m1)-(m2): turn on the high voltage from mainframe (m1) to 
                      mainframe (m2) 
      hvstatus : return the high voltage status of the current main frame 
      list : if a specific slot is chosen, then list all channles information 
             in the slot,else list all the slots information in the current 
             main frame. 
      list mainframes : list all the mainframes on the network and its high 
                        voltage status. 
      list modules : lists all the existing slots in the main frame with 
                     their informations 
      list slot (slot number) : lists all channles information of the 
                                specified slot 
      list slot (s1)-(s2) (option): lists all channels information of the slots 
                                    range from(s1) to (s2). (option) is the 
                                    submodule number of the slots. 
      normal mode: back to normal mode from direct mode 
      set slot (s1)-(s2) (submodule number) (property) (value): set the property 
                                                                of the submodules 
                                                                in the slots from 
                                                                s1 to s2 to (value) 
      set (submodule number) (channel number) (property) (value): set the property 
                                                                  of the channel in 
                                                                  the specified 
                                                                  submodule to value,
                                                                  assuming that the 
                                                                  user is looking at 
                                                                  a specific slot. 
      set (submodule number) (c1)-(c2) (property) (value): set the property of a range 
                                                  `         of channels from c1 to c2 
                                                           in the specified submodule 
                                                           to value. Assuming that the 
                                                           user is looking at a specific 
                                                           slot 
      quit : quit the program ! 


----------------------------------------------------------------------------------------
example:   hvcontrol
           list
           chmf
           17
           cd slot 13
           list
           set 0 0-2 SOT 6
           list
           quit
----------------------------------------------------------------------------------------