CLI reference

pymanip CLI interface

usage: pymanip [-h]
               {info,list_instruments,list_daq,check_hdf,rebuild_hdf,scan_gpib,oscillo,video}
               ...

command

command

Possible choices: info, list_instruments, list_daq, check_hdf, rebuild_hdf, scan_gpib, oscillo, video

pymanip command

Sub-commands

info

shows the content of a saved pymanip session

pymanip info [-h] [-q] [-l line] [-p varname] session_name

Positional Arguments

session_name: name of the saved session to inspect

Named Arguments

-q, --quiet

do not list content.

Default: False

-l, --line

print specified line of logged data.

-p, --plot

plot the specified variable.

list_instruments

List supported instruments

pymanip list_instruments [-h]

list_daq

List available acquisition cards

pymanip list_daq [-h]

check_hdf

checks dat and hdf files are identical

pymanip check_hdf [-h] [-p varname] session_name

Positional Arguments

session_name: Name of the pymanip acquisition to inspect

Named Arguments

-p, --plot: Plot the specified variable

rebuild_hdf

Rebuilds a pymanip HDF5 file from the ASCII dat file

pymanip rebuild_hdf [-h] input_file output_name

Positional Arguments

input_file: Input ASCII file
output_name: Output MI session name

scan_gpib

Scans for connected instruments on the specified GPIB board (linux-gpib only)

pymanip scan_gpib [-h] [board_number]

Positional Arguments

board_number

GPIB board to scan for connected instruments

Default: 0

oscillo

Use NI-DAQmx and NI-Scope cards as oscilloscope and signal analyser

pymanip oscillo [-h] [-s sampling_freq] [-r volt_range] [-t level] [-T 0]
                [-b daqmx] [-p port]
                [channel_name [channel_name ...]]

Positional Arguments

channel_name: DAQmx channel names

Named Arguments

-s, --sampling

Sampling frequency

Default: 5000.0

-r, --range

Channel volt range

Default: 10.0

-t, --trigger

Trigger level

-T, --trigsource

Trigger source index

Default: 0

-b, --backend

Choose daqmx or scope backend

Default: “daqmx”

-p, --serialport

Arduino Serial port

video

Display video preview for specified camera

pymanip video [-h] [-l] [-i interface] [-b board [board ...]] [-t toolkit]
              [-s slice slice slice slice] [-z zoom] [-T trigger] [-w]
              [-e exposure_ms] [-d bitdepth] [-f framerate] [-r angle]
              [-R roi roi roi roi]
              camera_type

Positional Arguments

camera_type: Camera type: PCO, AVT, Andor, Ximea, IDS, Photometrics

Named Arguments

-l, --list

List available cameras

Default: False

-i, --interface

Specify interface

Default: “”

-b, --board

Camera board address

Default: 0

-t, --toolkit

Graphical toolkit to use: cv or qt

Default: “qt”

-s, --slice

Slice image x0, x1, y0, y1 in pixels

Default: []

-z, --zoom

Zoom factor

Default: 0.5

-T, --Trigger

Trigger mode

Default: -1

-w, --whitebalance

Enable auto white balance (for color cameras)

Default: False

-e, --exposure

Exposure time (ms)

Default: 20

-d, --bitdepth

Bit depth

Default: 12

-f, --framerate

Acquisition framerate in Herz

Default: 10.0

-r, --rotate

Rotate image

Default: 0.0

-R, --ROI

Set Region of Interest xmin, ymin, xmax, ymax