 |
|
You are here: CLASSE Wiki>ACC/Bunch Web>CBICManPage>HelpInformation (28 Jul 2014, mgs9)Edit Attach
mgs9_cesr106> ../production/bin/cbic -h
CESR Beam Instrumentation Control Application (CBIC)
Version 1.10.19
Command line options:
-h This help information.
-v Version information for this application and its supporting components.
-f <filename> Specify a particular application configuration file to use.
This allows for command-line requesting of different sets of
instruments to bring online in a given session and other startup
options. The file must reside in the current working directory.
If this option is not specified, the default config file
'cbic.conf' will be read from the current working directory
-a <allocation-spec>
Specify an instrument allocation scheme / allocation name pair
to use for this application instance.
-b 'BACK-END' mode. Start program, reading configuration as normal, then drop into
a wait state for an incoming network connection from a manager program,
potentially on a remote host.
Once a connection is established, the manager will have full control of this
program.
-s Go directly into SERVER MODE.
Once all instruments are polled and brought
online, this will place the application into BPM data server mode to allow
3rd party beam position requests. CESRV and orbit are two programs that use
a BPM server to acquire their data.
-c Go directly into CURRENT MONITOR MODE DEFAULT
Intended for bringing a SINGLE instrument online and activating
it to allow continuous bunch-by-bunch current monitoring
The instrument to use for monitoring currents is specified in
the instrument list file with a 'CURRMON' server ID specification.
-e Go directly into CURRENT MONITOR MODE - the OLD version of currmon
Intended for bringing a SINGLE instrument online and activating
it to allow continuous bunch-by-bunch current monitoring
The instrument to use for monitoring currents is specified in
the instrument list file with a 'CURRMON' server ID specification.
-i Use Current Monitor Test Mnemonics instead of the real MPM Database nodes.
-w Go directly into POSITION MONITOR MODE
Intended for bringing a GROUP of instruments online and activating
it to allow continuous position monitoring
-d <#> Set debug verbosity level 0 - 5
Determines the level of detail that debugging and trace printouts
show during operation.
0 means no additional debugging output- equivalent to not using '-d'
5 means maximum detail in debugging output
The application defaults to level 0 if no option is specified.
NOTE: Level 5 prints a LOT of information and may in fact clutter useful
information or scroll it off the screen more rapidly than it may be
productively used. It is recommended that the application is run
in a terminal window with a large scrollback buffer so that runtime
details are not lost.
-k Keyboard input protection override - used for running CBIC with command files.
-l Start with long form of the menu.
-m <#> Enter 'MAINTENANCE MODE' wherein instruments are brought online with a
customizable set of communication checks and parameter reads.
0 means no maintenance mode will be used- equivalent to not using '-m'
1
2
3 Highest supported maintenance mode. Reads in general parameters but
avoids all communication with instruments to allow low level tasks to be
performed. Example: To perform a rapid blanket reset/wakeup of all
instruments after a power cycle of several instruments has taken place,
start up application in maintenance mode 3 and then run the RESET INSTRUMENT
command. Wait about 20 seconds. All instruments should be ready for use.
Exit and start application normally.
-M Enter 'MANAGER MODE' wherein this application will start (remote) instances of
itself in Back-end mode and then connect to them for centralized control.
-T TESTING MANAGER MODE. The same as -M above, but DO NOT spawn copies of each back-end
instance requested. The back-ends will need to be started manually. Used for testing.
-t Trigger-enable mode. The program will set the trigger (data) enable flag in the
CESR database on its own once all instruments are set up and ready to acquire data.
The program then de-asserts the trigger enable once the measurement is complete.
-g Graphical User Interface (GUI) mode. Allows for windowed, graphical
control of some program functions.
-o <#> Set Debug Option mode 1 integer choice
-p <#> Set Debug Option mode 2 to 1
-q <#> Set Debug Option mode 3 to 1
-r <#> Set Debug Option mode 4 floating point choice
-u <#> Set Debug Option mode 5 to 1
********************************************************************************
Helptext for menu options
-1) FIND bTMD
Determine best block turns marker delay settings
0) Change Menu Level(USER,SUPERUSER,EXPERT)
Change Menu Level(USER,SUPERUSER,EXPERT)
1) FIND BUNCH
Determine which bunch bucket in the machine contains charge
(Single bunch only)
2) GET STATUS AND DEBUG
Read back the status and debug structures from each insturment
3) TEST DATA BUFFERS
Test command to verify buffer filling and other things
4) GET TURN-BY-TURN DATA (do cbpm_tbt_[positrons/electrons])
Collect turn-by-turn data
5) GET PROCESSED DATA
Collect data averaged over some number of turns
6) MEASURE 4ns BUNCH CURRENTS (start DEFAULT Current Monitor)
Collect data averaged over some number of turns, calculate sum of buttons, publish in current nodes.
7) FIND cTMD
Calculate the COMMON turns-marker delay setting.
8) GET BETATRON PHASE (Measure Phase)
Collect betatron phase data
9) SAVE TIMING PARAMETERS
Save timing values to disk
10) SAVE PEDESTAL PARAMETERS
Save pedestal values to disk
11) TIME SCAN (do adjust_cbpm_times [pos/ele])
Perform a global delay scan
12) SET GAINS
Set all gain values on board instrument
13) GET TEMPERATURES
Read back all temperature sensors data
14) REREAD PARAMETER FILES
Reload the detector and instrument parameters files.
15) SELECT ACTIVE INSTRUMENTS (List Instruments)
Toggle the activity state of any online instruments
16) IDLE COMMAND
Send the 'IDLE COMMAND' to the instruments.
17) ENTER SERVER MODE (Start Server)
Accept requests via the MPM interface array
18) DUMP MPM INTERFACE STRUCTURE
Dump the contents of the MPM interface array to the screen
19) ACQUIRE PEDESTALS
Acquire pedestal values on all cards, channels, and gain settings for the active timing setup.
20) DUMP RAW DATA
Dump to disk the most recent turn-by-turn data without new acquisition.
21) CHECK PULSE
Read and verify the DSP heartbeat and timing integrity signals.
22) SET TIMING SETUP
Configure the timing setup for each ONLINE instrument.
23) INSTALL UPDATED PARAMETERS
Copy the latest parameter set with outstanding changes in this session to the master operational parameters file.
24) RESET COLDFIRE
Reset the Coldfire communications board
25) PROGRAM FLASH
Reload an instrument's on-board software
26) RESET AND INIT
Reset and reinitialize instruments
27) POWER CYCLE - RESET AND INIT (Cycle Power)
Cycle power before performing reset and init sequence.
28) TIME-IN
Perform a mostly-automated initial timing-in procedure on the instruments.
29) INSTALL ELECTRONIC GAIN CORRECTIONS
Overwrite all relevant gain tables from scale factor file storing in intermediate config file.
30) APPLY GAIN MAPPING CORRECTIONS
Multiply each existing gain scale factor by the provided gain mapping correction values.
31) COMPOSE BUNCH PATTERN (Create Bunch Pattern)
Compose a new bunch pattern graphically.
32) Clear Debug Struct
Clear Debug index and array
33) SCRUB TIMING PARAMS
Scrub all block-dependent timing params to an uninitialized state.
34) COPY TIMING PARAMS A-->B
Copies all timing params from timing block A to block B for calibration work.
35) Diagnostic Dump
Dump full diagnostic information for all active instruments to a file.
36) EXIT (Exit)
Exit this application
37) Enable FG Zero-Crossing Sample Point
Change all active instrument sample points to 0.4ns later for FixedGain zero-crossing measurement.
38) Install Turn-By-Turn Bunch Pattern (Set Bunch Pattern)
Prompt for a bunch pattern and acquire a multibunch turn-by-turn data set.
39) Test Life
Command test running till death or error
40) Calibrate 4ns BUNCH CURRENTS
Calibrate the Current monitor at different gain settings
41) Start Realtime Position Monitor
Start Realtime Position Monitor, showing x,y, and amplitude
42) MEASURE 4ns BUNCH CURRENTS (start OLD VERSION Current Monitor)
Collect data averaged over some number of turns, calculate sum of buttons, publish in current nodes.
43) ENTER SERVER INJECTION MODE (Start Server for Injection)
Accept requests via the MPM interface array
44) COPY TIMING PARAMS A-->B+0.5 nS
Copies all timing params from timing block A to block B plus Constant.
-- MatthewStedinger - 28 Jul 2014
CESR Beam Instrumentation Control Application (CBIC)
Version 1.10.19
Command line options:
-h This help information.
-v Version information for this application and its supporting components.
-f <filename> Specify a particular application configuration file to use.
This allows for command-line requesting of different sets of
instruments to bring online in a given session and other startup
options. The file must reside in the current working directory.
If this option is not specified, the default config file
'cbic.conf' will be read from the current working directory
-a <allocation-spec>
Specify an instrument allocation scheme / allocation name pair
to use for this application instance.
-b 'BACK-END' mode. Start program, reading configuration as normal, then drop into
a wait state for an incoming network connection from a manager program,
potentially on a remote host.
Once a connection is established, the manager will have full control of this
program.
-s Go directly into SERVER MODE.
Once all instruments are polled and brought
online, this will place the application into BPM data server mode to allow
3rd party beam position requests. CESRV and orbit are two programs that use
a BPM server to acquire their data.
-c Go directly into CURRENT MONITOR MODE DEFAULT
Intended for bringing a SINGLE instrument online and activating
it to allow continuous bunch-by-bunch current monitoring
The instrument to use for monitoring currents is specified in
the instrument list file with a 'CURRMON' server ID specification.
-e Go directly into CURRENT MONITOR MODE - the OLD version of currmon
Intended for bringing a SINGLE instrument online and activating
it to allow continuous bunch-by-bunch current monitoring
The instrument to use for monitoring currents is specified in
the instrument list file with a 'CURRMON' server ID specification.
-i Use Current Monitor Test Mnemonics instead of the real MPM Database nodes.
-w Go directly into POSITION MONITOR MODE
Intended for bringing a GROUP of instruments online and activating
it to allow continuous position monitoring
-d <#> Set debug verbosity level 0 - 5
Determines the level of detail that debugging and trace printouts
show during operation.
0 means no additional debugging output- equivalent to not using '-d'
5 means maximum detail in debugging output
The application defaults to level 0 if no option is specified.
NOTE: Level 5 prints a LOT of information and may in fact clutter useful
information or scroll it off the screen more rapidly than it may be
productively used. It is recommended that the application is run
in a terminal window with a large scrollback buffer so that runtime
details are not lost.
-k Keyboard input protection override - used for running CBIC with command files.
-l Start with long form of the menu.
-m <#> Enter 'MAINTENANCE MODE' wherein instruments are brought online with a
customizable set of communication checks and parameter reads.
0 means no maintenance mode will be used- equivalent to not using '-m'
1
2
3 Highest supported maintenance mode. Reads in general parameters but
avoids all communication with instruments to allow low level tasks to be
performed. Example: To perform a rapid blanket reset/wakeup of all
instruments after a power cycle of several instruments has taken place,
start up application in maintenance mode 3 and then run the RESET INSTRUMENT
command. Wait about 20 seconds. All instruments should be ready for use.
Exit and start application normally.
-M Enter 'MANAGER MODE' wherein this application will start (remote) instances of
itself in Back-end mode and then connect to them for centralized control.
-T TESTING MANAGER MODE. The same as -M above, but DO NOT spawn copies of each back-end
instance requested. The back-ends will need to be started manually. Used for testing.
-t Trigger-enable mode. The program will set the trigger (data) enable flag in the
CESR database on its own once all instruments are set up and ready to acquire data.
The program then de-asserts the trigger enable once the measurement is complete.
-g Graphical User Interface (GUI) mode. Allows for windowed, graphical
control of some program functions.
-o <#> Set Debug Option mode 1 integer choice
-p <#> Set Debug Option mode 2 to 1
-q <#> Set Debug Option mode 3 to 1
-r <#> Set Debug Option mode 4 floating point choice
-u <#> Set Debug Option mode 5 to 1
********************************************************************************
Helptext for menu options
-1) FIND bTMD
Determine best block turns marker delay settings
0) Change Menu Level(USER,SUPERUSER,EXPERT)
Change Menu Level(USER,SUPERUSER,EXPERT)
1) FIND BUNCH
Determine which bunch bucket in the machine contains charge
(Single bunch only)
2) GET STATUS AND DEBUG
Read back the status and debug structures from each insturment
3) TEST DATA BUFFERS
Test command to verify buffer filling and other things
4) GET TURN-BY-TURN DATA (do cbpm_tbt_[positrons/electrons])
Collect turn-by-turn data
5) GET PROCESSED DATA
Collect data averaged over some number of turns
6) MEASURE 4ns BUNCH CURRENTS (start DEFAULT Current Monitor)
Collect data averaged over some number of turns, calculate sum of buttons, publish in current nodes.
7) FIND cTMD
Calculate the COMMON turns-marker delay setting.
8) GET BETATRON PHASE (Measure Phase)
Collect betatron phase data
9) SAVE TIMING PARAMETERS
Save timing values to disk
10) SAVE PEDESTAL PARAMETERS
Save pedestal values to disk
11) TIME SCAN (do adjust_cbpm_times [pos/ele])
Perform a global delay scan
12) SET GAINS
Set all gain values on board instrument
13) GET TEMPERATURES
Read back all temperature sensors data
14) REREAD PARAMETER FILES
Reload the detector and instrument parameters files.
15) SELECT ACTIVE INSTRUMENTS (List Instruments)
Toggle the activity state of any online instruments
16) IDLE COMMAND
Send the 'IDLE COMMAND' to the instruments.
17) ENTER SERVER MODE (Start Server)
Accept requests via the MPM interface array
18) DUMP MPM INTERFACE STRUCTURE
Dump the contents of the MPM interface array to the screen
19) ACQUIRE PEDESTALS
Acquire pedestal values on all cards, channels, and gain settings for the active timing setup.
20) DUMP RAW DATA
Dump to disk the most recent turn-by-turn data without new acquisition.
21) CHECK PULSE
Read and verify the DSP heartbeat and timing integrity signals.
22) SET TIMING SETUP
Configure the timing setup for each ONLINE instrument.
23) INSTALL UPDATED PARAMETERS
Copy the latest parameter set with outstanding changes in this session to the master operational parameters file.
24) RESET COLDFIRE
Reset the Coldfire communications board
25) PROGRAM FLASH
Reload an instrument's on-board software
26) RESET AND INIT
Reset and reinitialize instruments
27) POWER CYCLE - RESET AND INIT (Cycle Power)
Cycle power before performing reset and init sequence.
28) TIME-IN
Perform a mostly-automated initial timing-in procedure on the instruments.
29) INSTALL ELECTRONIC GAIN CORRECTIONS
Overwrite all relevant gain tables from scale factor file storing in intermediate config file.
30) APPLY GAIN MAPPING CORRECTIONS
Multiply each existing gain scale factor by the provided gain mapping correction values.
31) COMPOSE BUNCH PATTERN (Create Bunch Pattern)
Compose a new bunch pattern graphically.
32) Clear Debug Struct
Clear Debug index and array
33) SCRUB TIMING PARAMS
Scrub all block-dependent timing params to an uninitialized state.
34) COPY TIMING PARAMS A-->B
Copies all timing params from timing block A to block B for calibration work.
35) Diagnostic Dump
Dump full diagnostic information for all active instruments to a file.
36) EXIT (Exit)
Exit this application
37) Enable FG Zero-Crossing Sample Point
Change all active instrument sample points to 0.4ns later for FixedGain zero-crossing measurement.
38) Install Turn-By-Turn Bunch Pattern (Set Bunch Pattern)
Prompt for a bunch pattern and acquire a multibunch turn-by-turn data set.
39) Test Life
Command test running till death or error
40) Calibrate 4ns BUNCH CURRENTS
Calibrate the Current monitor at different gain settings
41) Start Realtime Position Monitor
Start Realtime Position Monitor, showing x,y, and amplitude
42) MEASURE 4ns BUNCH CURRENTS (start OLD VERSION Current Monitor)
Collect data averaged over some number of turns, calculate sum of buttons, publish in current nodes.
43) ENTER SERVER INJECTION MODE (Start Server for Injection)
Accept requests via the MPM interface array
44) COPY TIMING PARAMS A-->B+0.5 nS
Copies all timing params from timing block A to block B plus Constant.
-- MatthewStedinger - 28 Jul 2014
Edit | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
Topic revision: r1 - 28 Jul 2014, mgs9
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding CLASSE Wiki? Send feedback