The sscan module

Documentation

The following documentation is available:

sscanRecord – The sscan record documentation.
scanparmRecord – The scanparm record documentation.
saveData – Configuration and usage of the saveData data-storage client, which writes scan data to disk in MDA format.
MDA Format – Description of the MDA (multidimensional archive) file format written by saveData.
saveData.req – Sample saveData configuration file.
XDR_RFC1014.txt – A description of the XDR (External Data Representation) standard.
Scans.ppt – Powerpoint presentation that describes the sscan module; shows how to use the sscan record; describes saveData’s MDA file format; and explains how EPICS putNotify/ca_put_callback() completion behaves, and how to handle processing chains that don’t satisfy EPICS’ execution-tracing requirements.

Installation and use of the sscan module

Installation and Building

After obtaining a copy of the distribution, it must be installed and built for use at your site. Usually, these steps only need to be performed once.

Clone or download the sscan module source, e.g.:
```
git clone https://github.com/epics-modules/sscan.git
```
Usually this is done in an EPICS ‘support’ directory.
Edit sscan’s configure/RELEASE file and set the paths to your installation of EPICS base and to your versions of other dependent modules.
Run make in the top level directory and check for any compilation errors.

Use of the sscan module in an EPICS IOC

The sscan module is not intended to run an IOC application directly, but rather to contribute code libraries, databases, MEDM displays, etc., to an IOC application. SynApps contains an example IOC application (the xxx module), which pulls software from the sscan module and deploys it in an IOC.

The essential steps in applying sscan-module code in an IOC application (“example”) are the following:

Include the following line in example/configure/RELEASE:
```
SSCAN=<full path to sscan module>
```
Include the following lines in example/exampleApp/src/exampleInclude.dbd:
```
include "sscanSupport.dbd"
include "scanProgressSupport.dbd"
```
Include the following line in example/exampleApp/src/Makefile:
```
example_LIBS += sscan scanProgress
```

Load the databases by including the following lines in st.cmd:

dbLoadRecords("$(SSCAN)/sscanApp/Db/standardScans.db","P=xxx:,MAXPTS1=2000,MAXPTS2=1000,MAXPTS3=1000,MAXPTS4=10,MAXPTSH=2000")
dbLoadRecords("$(SSCAN)/sscanApp/Db/saveData.db","P=xxx:")
dbLoadRecords("$(SSCAN)/sscanApp/Db/scanProgress.db","P=xxx:scanProgress:")

Alternatively, you can use the provided iocsh script:

iocshLoad("$(SSCAN)/iocsh/sscan.iocsh", "PREFIX=xxx:,SSCAN=$(SSCAN)")

If you use autosave, include standardScans_settings.req and saveData_settings.req in your autosave request file:
```
file standardScans_settings.req P=$(P)
file saveData_settings.req P=$(P)
```
Tell saveData how to initialize by editing the file saveData.req, and placing it in the IOC’s startup directory. Usually, the only part of this file that you modify is the section marked [extraPV]. In this section, enter the names of the PVs you want saveData to include in every scan-data file. If a PV is not well described by its record’s .DESC field, you can append your own description.
Initialize saveData by including the following line in st.cmd, after iocInit:
```
saveData_Init("saveData.req", "P=xxx:")
```
Before running any scans, specify where saveData is to write scan-data files. Bring up the medm display scan_saveData.adl and fill in the “File system” and “Subdirectory” fields (i.e., the PVs $(P)saveData_fileSystem and $(P)saveData_subDir).

Suggestions and Comments to: Keenan Lang : (klang@anl.gov)