'''[wiki:GraspSwControllerCmd clvset]'''

[[TracNav(GraspContents)]]

||Command:||'''clvset'''||
||Contexts:||Network socket, serial console, stage2 only||
||Function:||Set up clocking parameters and ADC configuration for next readout||
||Required Parameters:||none.||
||Optional Parameters:|| ||
||'''dev='''||[current] Select dev '''0''' '''1''' or '''all'''||
||'''pg3='''||8 sets of four hex digits to configure serial (row/horizontal) clocking||
||'''pg4='''||8 sets of four hex digits to configure serial RESET, SUMMING WELL, (CCDs), VCLAMP, and ADCTRIG||
||'''ppg4='''||8 sets of four hex digits to configure parallel (vertical) clocking||
||'''adc='''||1 set of four hex digits plus an optional nibble to configure ADC operation||
||'''trig='''||Number of NOPs (10 nsec delay steps) to insert after each crosstrigger sync||
||'''pipeline='''||Number of pipeline pixels resulting from clocking pattern (usually 1)||
||'''prescan='''||Number of device serial prescan pixels to skip (clocked, but not sampled)||
||'''prebias='''||Extra overscan pixels to be read '''after''' xtrig (usually 0)||

=== Example ===

The following is a complete command to configure a typical "4+1" CCD clocking pattern on both clocking engines.  It takes 4 samples of the pedestal level, plus 1 skipped for pipeline purposes, and then 4 samples of the video level, plus 1 skipped for pipeline purposes.

{{{
clvset dev=all ppg4=ecbb:cbb2:bb2e:65d8:5d97:38ba:6622:3154 \
               pg3=340e:40e0:1c03:c070:06c1:0417:649b:0136 \
               pg4=1038:8010:0104:00b0:07c2:0000:3732:08a2 \
               adc=1500:1
}}}

The command must be sent all on one line.

=== Parameter adc= ===

The first, four-digit hex part of the adc= parameter is formed by or-ing several values together:

{{{
I | (C << 8) | (N << 10)
}}}

Where I (the lower 8 bits) specifies extra inter-sample delay time (usually left at 00), C is the number of channels (1 2 or 3) and N is the number of multiple samples to read each time ADCTRIG changes (goes high or low.)

The default behavior of the adc= parameter in single-sampled mode is to read only the "Red" ADC channel.  All digits in the adc= parameter are in hex.  The option last nibble after the colon allows one to select other ADC channels.  It is a bit mask.

||adc=1500||4+1 RED||
||adc=1500:1||4+1 RED||
||adc=1500:2||4+1 GREEN||
||adc=1500:4||4+1 BLUE||

For two-channel mode, the following combinations are valid:

||adc=1600||4+1 RED,GREEN||
||adc=1600:3||4+1 RED,GREEN||
||adc=1600:5||4+1 RED,BLUE||
||adc=1600:6||4+1 GREEN,BLUE||

For three-channel mode, the mask is ignored and all three (RED, GREEN, BLUE) channels are active.

||adc=1700||4+1 RED,GREEN,BLUE||