sanipy is a friendly command-line tool for epics connection testing.
It has two commands (check, compare and goto), each with a few option switches (described in sanipy COMMAND -h).
The data folder contains some example channel lists and output files for testing.
sanipy is available from the PSI anaconda channel:
conda install -c paulscherrerinstitute sanipyAt PSI, it is already installed in the GFA Python 3.7 environment, which can be accessed via
source /opt/gfa/python 3.7Reads a list of PV names from plain text file (comments starting with # are allowed, even recommended) and tests each channel for connection, alarm status and severity.
By default, the connection tests are performed in parallel. For each channel, the result will be printed as soon as it arrived. Thus, the output is ordered by response time. For debugging purposes, the parallelization of the tests can be turned off (-s/--serial), in which case the output is printed in alphabetical order (note that in serial mode each broken channel has to time out before the next channel is tested, in which case the total execution time can become very long).
There is a command-line switch to suppress the output (-q/--quiet) and to set the connection time out in seconds (-t/--timeout).
The test result can be written to a comma-separated values (csv) file by giving a filename to the -o/--output switch (.csv is automatically appended to the filename if missing).
sanipy check data/test_chans_good.txt
sanipy check data/test_chans_bad.txt
Successful connections will be marked in green, failed connection in red, and alarm states will be printed in yellow.
Reads two csv files produced via check, and prints the differences (if any). Again, .csv is automatically appended to the filenames if missing.
Values are, on the one hand, likely to change between checks. However, this change does, on the other hand, not necessarily indicate a problem. Thus, there is a switch (-v/--ignore-values) to ignore them in the comparison.
sanipy compare data/test1.csv data/test4 --ignore-values
sanipy compare data/test1.csv data/test3
Entries that are identical in both files will not be shown. Differences will be printed as LEFT | RIGHT.
Reads a csv file produced via check, and puts each stored non-NaN value into the respective PV. The command-line switches -q, -s and -t work identically to their check counterparts. Additionally, there is a switch (-a/--ignore-alarm) that allows to ignore PVs (i.e., not put their values) that have been in an alarm state during the check.