Library for the JLab Helicity Generator

Author:

• Bryan Moffit
• TJNAF Fast Electronics and Data Acquisition

What is this for?

This is the library for the JLab Helicity Generator. Use it with jvme to configure a Helicity Generator in a VME crate.

What do I do with it?

With your LINUXVME environment variables set, compile and install the library with

make install

Use programs to configure and print helicity control parametrs

In test/ you’ll find some useful programs to get the status of and configure the module.

Compile these with

cd test/
make 

heliStatus

Initialize the library and display the current status of the helicity generator at default address 0xA00000.

--------------------------------------------------------------------------------
STATUS for JLab Helicity Control Board

       month (0x00) = 0x06	         day (0x01) = 0x06
        year (0x02) = 0x17	       state (0x04) = 0x20
     tsettle (0x07) = 0x0e	     tstable (0x09) = 0x1e
       delay (0x0b) = 0x03	     pattern (0x0d) = 0x01
       clock (0x0f) = 0x63

 Mode                            Settle Time (usec)      Stable Time (usec)
  Free Clock                          100.00                33230.00

 Helicity Pattern:
  Quartet

 Reporting Delay:
  4 windows

 Helicity Board Frequency:
  30.00 Hz

 Output Clock:
  20 MHz

 Sequencer State:
  0x20

 Firmware:
  Month:   6   Day:   6   Year:  23

--------------------------------------------------------------------------------

heliConfigure [options]

Configure the helicity generator module with the provided arguments

 -m, --mode {index}                select the clock mode
 -p, --pattern {index}             select the helicity pattern
 -d, --delay {index}               select the helicity delay
 -t, --tsettle {index}             select the tsettle
 -s, --tstable {index}             select the tstable
 -b, --boardclock {index}          select the board clock output
 -l, --list {selections}           list the available selections for {selections}
                                   (e.g. --list mode,pattern,tstable)
 -r, --reset                       reset the module
 -h, --help                        this help message

Exit status:
  0  if OK,
  1  if argument ERROR
  2  if VME Driver ERROR
  3  if helicity generator library ERROR