Scan Support

The Scan Server can execute a sequence of scan commands. Several scan configurations can be submitted to the server. Ongoing scans can be monitored, paused, resumed, aborted.

Setup

Prepare CSS

Get Python client and examples

Run Demo IOC

cd PyScanClient/example/ioc
. runIoc.sh

Run Scan Server

Run or export the org.csstudio.scan.server/scan-server.product.

The default settings in org.csstudio.scan.server/plugin_customization.ini configure it for 'localhost', sufficient for initial tests. For a production setup, you need to set the EPICS connection parameters and move the log database location to a directory outside of /tmp.

The ScanServer product can be run with command-line option

   -console
or
   -console 4884
for the (network) console. Type "help" in the console to see ScanServer commands.

If the ScanServer is run on a host that is different from the CSS client that later accesses it, make sure that its ports are accessible via the firewall. By default, the scan server REST interface uses port 4810. Use /etc/sysconfig/iptables to enable that port for TCP access.

Access Scan Server Web Interface

Open a web browser for the URL http://localhost:4810/index.html. In particular, follow the links to submit a scan and then monitor its progress.

This REST API is the underlying interface to the scan server. While it can be used to debug the system, it is more practical to access it via the CSS Scan UI and the PyScanClient.

Interact with Scan Server from CSS and Python

Configure the CS-Studio product as follows after its initial start:

Things to try:

For more on the CS-Studio scan UI see ../org.csstudio.scan.ui/doc/scansystem.html

For more on the PyScanClient see its documentation.