cli Module

Source code documentation for EPICS cli

Watch an EPICS PV. Send email when it changes from 0 to 1

class PvMail.cli.PvMail(config=None)

Bases: threading.Thread

Watch an EPICS PV (using PyEpics interface) and send an email when the PV changes from 0 to 1.

basicChecks()

check for valid inputs, raise exceptions as discovered, otherwise no return result

do_restart()

restart watching for triggers

do_start()

start watching for triggers

do_stop()

stop watching for triggers

receiveMessageMonitor(value, **kw)

respond to EPICS CA monitors on message PV

receiveTriggerMonitor(value, **kw)

respond to EPICS CA monitors on trigger PV

testConnect(pvname, timeout=5.0)

create PV, wait for connection, return connection state (True | False)

adapted from PyEpics __createPV() method

PvMail.cli.SendMessage(pvm, agent_db, reporter=None)

construct and send the message

Parameters:pvm (obj) – instance of PvMail object on which to report

PvMail.cli.cli(results, config=None)

command-line interface to the PvMail class

Parameters:

• results (obj) – default parameters from argparse, see main()
• config (obj) – email configuration from ini_config.Config()

PvMail.cli.getUserName(db)

PvMail.cli.gui(results, config=None)

graphical user interface to the PvMail class

Parameters:

• results (obj) – default parameters from argparse, see main()
• config (obj) – email configuration from ini_config.Config()

PvMail.cli.logger(message)

log a message or report from PvMail

Parameters:message (str) – words to be logged

PvMail.cli.main()

parse command-line arguments and choose which interface to use