Project

General

Profile

BPMCLI

This section describes the operation of the bpmcli utility which provides an interface to bpmd from the linux command line.

Usage:

$ bpmcli command [command_arguments]

The command and command_arguments are described in the sections below.

abort

Aborts the current measurement.

Usage:

$ bpmcli abort
Options:
  • None

arm

Arms the DAQ modules for the measurement specification given with -i.

Usage:

$ bpmcli arm -i measurement_spec_index
Options:
  • -i (required) : Measurement specification index

config_reload

Re-loads bpmd.conf.

Usage:

$ bpmcli config_reload

dump

Dumps measurement reading contents to stdout in CSV format.

Usage:

$ bpmcli dump -r reading_type [-i reading_index] [-b bpm_1,bpm_2,...] [-nmthuos]
Options:
  • -r (required) : Reading type, may be: closed_orbit, flash_orbit, flash_turn, raw or tbt
  • -i (optional) : Reading index. If not provided the reading with the latest triggered time-stamp will be selected
  • -b (optional) : Comma separated list of BPMs to include in output. If not provided all BPMs will be included (which could be a lot of data!)
  • -n (optional) : Include intensity (scaled) in output
  • -m (optional) : Include A and B plate magnitude (in raw ADC counts) in output
  • -t (optional) : Include turn numbers in output
  • -h (optional) : Include reading and measurement header information in output
  • -u (optional) : Include un-scaled position and intensity (if -n present) in output
  • -o (optional) : Sample number to begin dump at
  • -s (optional) : Number of samples to dump
  • -x (optional) : Include hex-encoded position

readout

Instructs bpmd to read data from the DAQ modules and store it in a reading object.

Usage:

$ bpmcli readout -r reading_type [-t turn_1,turn_2,...] [-a turns_to_average] [-f first_turn] [-n number_of_samples] [-s turns_to_skip]
Options:
  • -r (required) : Reading type, may be: closed_orbit, flash_orbit, flash_turn, raw or tbt
  • -t (required for smooth_orbit readout) : Smooth orbit breakpoints (comma-separated list of turn numbers)
  • -a (optional) : Number of turns to average into one sample (default: 1)
  • -f (optional) : Turn number to begin readout at (default: 0)
  • -n (optional) : Number of samples to produce (default: unlimited)
  • -s (optional) : Turns to skip between readouts (default: 0)

show

Displays bpmd operating and debugging information.

Usage:

$ bpmcli show [-acdmprs]
Options:
  • -a (optional) : Show all sections (same as -cdmprs or not providing any arguments)
  • -c (optional) : Show machine context
  • -d (optional) : Show DAQ system
  • -m (optional) : Show measurement table
  • -p (optional) : Show BPM table
  • -r (optional) : Show reading tables
  • -s (optional) : Show measurement specification table

Note: If no option is given then -a is assumed

shutdown

Instructs bpmd to shut down.

Usage:

$ bpmcli shutdown

An alternative to shutdown bpmd is to send SIGKILL to the bpmd process.

$ killall bpmd
Options:
  • None

sm_disable

Disables the state machine.

Usage:

$ bpmcli sm_disable

sm_enable

Enable the state machine.

Usage:

$ bpmcli sm_enable [-e tclk_event1,tclk_event2,...] [-n cycles]
Options:
  • -e (optional) - Comma separated list of machine cycle reset events
  • -n (optional) - Number of machine cycles to process before disabling the state machine