PB Command-Line Interface¶

This page provides usage instructions and examples for the PandoraBox command line (“pb”). These commands let you control PANDORA’s various subsystems—such as the shutter, monochromator, flip mounts, Keysight electrometers, spectrometer, and Zaber stages—individually.

Prerequisites:¶

Before running any pb command, configure your terminal:

# Change directory to your PANDORA root folder
cd ${HOME}/Documents/dev/versions/v2.0/PANDORA/

# Add the pandora folder to your PYTHONPATH
export PYTHONPATH="${PWD}:${PYTHONPATH}"

# Create an alias so you can call pb anywhere
alias pb="python ${HOME}/Documents/dev/versions/v2.0/PANDORA/pandora/commands/pb.py"

You will then be able to use the pb command from any directory in your terminal session.

Overview¶

To see all available commands and options, type:

pb -h

The output lists all subcommands and general usage:

usage: pb.py [-h]
             {measure-pandora-throughput,measure-pandora-throughput-beta,
              measure-pandora-tput-final,measure-pandora-charge,
              set-wavelength,get-wavelength,open-shutter,close-shutter,
              get-keysight-readout,get-spectrometer-readout,flip,zaber,mount}
             ...

PandoraBox Command-Line Interface (commands)

positional arguments:
  measure-pandora-throughput      Measure throughput (current mode)
  measure-pandora-throughput-beta Enhanced throughput with dark measurements
  measure-pandora-tput-final      Production throughput with overflow handling
  measure-pandora-charge          Charge accumulation measurement (coulomb mode)
  set-wavelength                  Set monochromator wavelength
  get-wavelength                  Get current wavelength
  open-shutter                    Open the shutter
  close-shutter                   Close the shutter
  get-keysight-readout            Get electrometer readout
  get-spectrometer-readout        Get spectrometer readout
  flip                            Control flip mounts
  zaber                           Control Zaber stages
  mount                           Control iOptron telescope mount

options:
  -h, --help    show this help message and exit

Use pb <command> --help for additional details on each command’s options.

Note

For detailed documentation on the wavelength scan measurement commands (measure-pandora-throughput, measure-pandora-charge, etc.), see Wavelength Scan Measurements.

Shutter Commands¶

To control the shutter, you can open or close it:

pb open-shutter
pb close-shutter

You may also add --verbose for more detailed console output:

pb open-shutter --verbose

Monochromator¶

To set the monochromator to a specific wavelength (in nanometers):

pb set-wavelength 500

To retrieve the current wavelength:

pb get-wavelength

Flip Mounts¶

Flip mounts are controlled with the flip subcommand. You can turn a mount on or off or query its current state:

pb flip (mount_name) --on
pb flip (mount_name) --off
pb flip (mount_name) --state

To list all flip mount names recognized by the system:

pb flip --listNames

Example usage:

pb flip pd2 --on
pb flip second-order-filter --off

Keysight Electrometers¶

The Keysight B2980 series electrometers support multiple measurement modes:

CURR (Current mode): Measures instantaneous current in amperes
CHAR (Charge mode): Measures accumulated charge in coulombs using the integrating capacitor

Current Mode (Default)

Retrieve Keysight electrometer data in current mode:

pb get-keysight-readout <exptime> [--name K1|K2] [--rang0 <value>]
                                [--nplc <int>] [--autoRange]
                                [--verbose]

Where:

exptime is the measurement duration (in seconds).
--name K1 or --name K2 selects which Keysight electrometer (default: K1).
--rang0 2e-9 sets a specific measurement range.
--autoRange automatically determines the optimum measurement range.
--nplc 10 sets the integration time in terms of line cycles (default = 10).
--verbose prints additional console output.

Examples:

pb get-keysight-readout 2 --rang0 2e-9
pb get-keysight-readout 2 --name K2 --autoRange
pb get-keysight-readout 2 --name K2 --rang0 2e-9 --verbose

Charge Mode (Coulomb Meter)

The B2985B/B2987B electrometers support charge measurement mode, which integrates current over time using a feedback capacitor. This is useful for measuring total accumulated charge from photodiodes or other charge-generating devices.

Available charge ranges:

2 nC (resolution: 1 fC)
20 nC (resolution: 10 fC)
200 nC (resolution: 100 fC)
2 µC (resolution: 1 pC)

Charge mode is primarily used through the wavelength scan commands (see Wavelength Scan Measurements).

Note

When using charge mode, the feedback capacitor should be discharged (zeroed) before each measurement to start with a clean baseline. The --discharge flag controls this behavior in scan commands.

Spectrometer¶

Obtain a spectrometer reading, including exposure and other parameters:

pb get-spectrometer-readout <exptime> [--scanavg <num_scans>]
                                      [--xtiming 1|2|3]
                                      [--is_plot] [--verbose]

Where:

<exptime> is exposure time in milliseconds.
--scanavg <num_scans> averages multiple scans.
--xtiming <mode> sets the spectrometer resolution mode (default = 3, highest).
--is_plot displays a plot of intensity (counts) vs. wavelength (nm).
--verbose prints additional details.

Example:

pb get-spectrometer-readout 20 --is_plot

Zaber Stages¶

Use the zaber subcommand to query and move Zaber stages:

pb zaber [-h] [--listZaberNames] [--listSlotTable]
         [--move <mm_position>] [--verbose]
         <controller_name> [slot]

Positional Arguments:

controller_name: The name of the Zaber controller (e.g., nd-filter, pinhole, focus).
slot: The slot name (e.g., home, clear, ND20, etc.) if not using --move.

Options:

--listZaberNames: Lists all known Zaber controller names.
--listSlotTable: Lists the slot table for the specified controller.
--move <mm_position>: Moves to a specified position (in mm).
--verbose: Prints extra console output.

Examples:

List all Zaber controllers:
```
pb zaber --listZaberNames
```
Move a Zaber stage to a named slot:
```
pb zaber nd-filter clear
```
Return a Zaber stage to home:
```
pb zaber nd-filter home
```
List slot table for a given controller:
```
pb zaber nd-filter --listSlotTable
```
Move stage to a specific mm position:
```
pb zaber nd-filter --move 20
```

Telescope Mount (iOptron)¶

The mount subcommand controls the iOptron HAZ-series Alt-Az telescope mount. This includes slewing to positions, parking, and safety limit management.

Warning

The mount will not remember its home position across power cycles. If a complete power loss occurs, the mount will set its current position as the new zenith. After power loss, zenith must be reacquired manually. Always check the altitude limit and parking position after power failures.

Available Mount Commands:

pb mount status          # Show current Alt/Az and state
pb mount goto <alt> <az> # Slew to specified position
pb mount home            # Return to zenith position
pb mount park            # Park mount
pb mount unpark          # Unpark mount
pb mount stop            # Emergency stop
pb mount set-park <alt> <az>  # Define parking position
pb mount get-position    # Query current position
pb mount set-alt-limit <deg>  # Set altitude safety limit
pb mount get-alt-limit   # Query altitude limit

Checking Mount Status:

pb mount status

Output example:

Altitude :  45.0000 deg
Azimuth  : 180.0000 deg
State    : Stopped (home)

Slewing to a Position:

# Slew to Alt=45 deg, Az=180 deg
pb mount goto 45 180

# Slew with tracking enabled after completion
pb mount goto 45 180 --track

# Slew and print status after completion
pb mount goto 45 180 --status

Returning Home (Zenith):

pb mount home

Parking and Unparking:

# Park the mount at stored parking position
pb mount park

# Unpark to allow movements
pb mount unpark

Emergency Stop:

To immediately halt all mount motion:

pb mount stop

Setting and Querying Park Position:

# Define a new parking position (moves to position first)
pb mount set-park 45 180

# Define without moving first
pb mount set-park 45 180 --no-move

Safety Limits:

The altitude limit prevents the mount from slewing below a specified angle:

# Set minimum altitude limit to 10 degrees
pb mount set-alt-limit 10

# Query current altitude limit
pb mount get-alt-limit

Note

All mount commands support --verbose for additional console output.

PB Command-Line Interface¶

Prerequisites:¶

Overview¶

Shutter Commands¶

Monochromator¶

Flip Mounts¶

Keysight Electrometers¶

Spectrometer¶

Zaber Stages¶

Telescope Mount (iOptron)¶

Further Reading¶