Changeset 655 for pvMail

Timestamp:

Nov 25, 2011 2:54:42 PM (14 years ago)

Author:

jemian

Message:

CLI version is ready for regular testing, GUI version not started

Location:

pvMail

Files:

• .pydevproject (modified) (1 diff)
• src (modified) (1 prop)
• src/ca_utils/df.py (deleted)
• src/ca_utils/pvMail.py (modified) (2 diffs)
• src/pyEpics (modified) (1 prop)
• src/pyEpics/pvMail.py (modified) (7 diffs)
• src/pyEpics/test.db (modified) (1 diff)

pvMail/.pydevproject ¶

@@ -6 +6 @@
 <path>/pvMail/src</path>
 </pydev_pathproperty>
-<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.5</pydev_property>
+<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.7</pydev_property>
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
 </pydev_project>

pvMail/src/ca_utils/pvMail.py ¶

@@ -384 +384 @@
             # Get email addresses set by user
             emailWidgets = (self.eEmail1, self.eEmail2, self.eEmail3)
-            who = [self.widgetGet(w).strip() for w in emailWidgets]
+            who = [self.widgetGet(w).strip() for w in emailWidgets]
 
             TrigPV = str(self.widgetGet(self.eTrig))
@@ -425 +425 @@
                     # popen is deprecated since Python 2.6
                     # use subprocess module instead
-                    cmd = fmt[arch] % ( subject, recipient )
-                    self.setStatus(cmd)
-                    #print cmd
+                    cmd = fmt[arch] % ( subject, recipient )
+                    self.setStatus(cmd)
+                    #print cmd
                     os.popen(cmd)
-                    self.setStatus("To: " + recipient)
+                    self.setStatus("To: " + recipient)
                     time.sleep(0.2)
         

pvMail/src/pyEpics/pvMail.py ¶

@@ -45 +45 @@
     05.09.07  kag  Initial alpha version.  Needs testing.
     2009-12-02 prj: converted to use wxPython (no Tkinter or Pmw)
-    2011-11-23 prj: converted to use PyEpics and combined GUI and CLI
+    2011-11-23 prj: complete rewrite using PyEpics and combined GUI and CLI
     
 :requires: EPICS system (http://www.aps.anl.gov/epics) 
@@ -54 +54 @@
 '''
 
+
+import argparse
 import datetime
 import epics
@@ -62 +64 @@
 import subprocess
 import sys
-
-
-__version__ = "3.0a"
+import time
+
+
+__version__ = "3.0a." + "$Rev$".split(" ")[1]
 __svnid__ = "$Id$"
+__description__ = "Watch an EPICS PV. Send email when it changes from 0 to 1."
 LOG_FILE = "pvMail.log"
+MESSAGE_FILE = "pvmail_email.txt"
+RETRY_INTERVAL_S = 0.2
+CHECKPOINT_INTERVAL_S = 5.0
 
 
@@ -79 +86 @@
         self.message = "default message"
         self.subject = "pvMail.py"
-        self.triggerPV = "pvMail:trigger"
-        self.messagePV = "pvMail:message"
-        self.email_list = "prjemian@gmail.com"
-        self.message_file = "/tmp/pvmail_email.txt"
+        self.triggerPV = ""
+        self.messagePV = ""
+        self.message_file = MESSAGE_FILE
         self.recipients = []
-        self.sender = "jemian@anl.gov"
+        self.old_value = None
+        self.monitoredPVs = []
+    
+    def basicChecks(self):
+        '''
+        check for valid inputs, 
+        raise exceptions as discovered, 
+        otherwise no return result
+        '''
+        if len(self.recipients) == 0:
+            msg = "need at least one email address for list of recipients"
+            raise RuntimeWarning, msg
+        fmt = "could not connect to %s PV: %s"
+        parts = {'message': self.messagePV, 
+                 'trigger': self.triggerPV}
+        for name, pv in parts.items():
+            if len(pv) == 0:
+                raise RuntimeWarning, "no name for the %s PV" % name
+            if self.testConnect(pv, timeout=0.5) is False:
+                raise RuntimeWarning, fmt % (name, pv)
+        
+    def testConnect(self, pvname, timeout=5.0):
+        '''
+        create PV, 
+        wait for connection, 
+        return connection state (True | False)
+        
+        adapted from PyEpics __createPV() method
+        '''
+        logger("test connect with %s" % pvname)
+        retry_interval_s = 0.0001
+        start_time = time.time()
+        thispv = epics.PV(pvname)
+        thispv.connect()
+        while not thispv.connected:
+            time.sleep(retry_interval_s)
+            epics.ca.poll()
+            if time.time()-start_time > timeout:
+                break
+        return thispv.connected
+    
+    def doStart(self):
+        '''start watching for triggers'''
+        logger("doStart")
+        if len(self.monitoredPVs) == 0:
+            self.basicChecks()
+            epics.camonitor(self.messagePV, callback=self.receiveMessageMonitor)
+            epics.camonitor(self.triggerPV, callback=self.receiveTriggerMonitor)
+            # What happens if either self.messagePV or self.triggerPV
+            # are changed after self.doStart() is called?
+            # Keep a local list of what was initiated.
+            self.monitoredPVs.append(self.messagePV)
+            self.monitoredPVs.append(self.triggerPV)
+    
+    def doStop(self):
+        '''stop watching for triggers'''
+        logger("doStop")
+        for pv in self.monitoredPVs:
+            epics.camonitor_clear(pv)   # no problem if pv was not monitored
+        self.monitoredPVs = []
+    
+    def doRestart(self):
+        '''restart watching for triggers'''
+        self.doStop()
+        self.doStart()
+    
+    def receiveMessageMonitor(self, value, **kw):
+        '''respond to EPICS CA monitors on message PV'''
+        logger("%s = %s" % (self.messagePV, value))
+        self.message = value
+    
+    def receiveTriggerMonitor(self, value, **kw):
+        '''respond to EPICS CA monitors on trigger PV'''
+        logger("%s = %s" % (self.triggerPV, value))
+        if self.old_value == 0:
+            if value == 1:
+                # Cannot use this definition:
+                #     self.trigger = (value == 1)
+                # since the trigger PV just may transition back
+                # to zero before self.doMessageTrigger() runs.
+                self.trigger = True
+        self.old_value = value
     
     def doMessageTrigger(self):
         '''this routine initiates sending the message'''
+        logger("doMessageTrigger")
         self.trigger = False        # triggered event received
-        if (len(self.messagePV) > 0
-           and len(self.triggerPV) > 0
-           and len(self.recipients) > 0):
+        try:
+            self.basicChecks()
             self.message = epics.caget(self.messagePV)
             self.subject = "pvMail.py: " + epics.caget(self.triggerPV)
             sendMail(self.subject, self.message, self.recipients)
+        except:
+            logger(sys.exc_info()[1])
     
     def addMessageTail(self):
@@ -111 +200 @@
         sends a test message, used for development only
         '''
+        logger("send_test_message")
         self.recipients = ["prjemian@gmail.com"]
         self.message = "this is a test\n\n" + self.addMessageTail()
         self.subject = "pvMail development test"
         sendMail(self.subject, self.message, self.recipients)
+
 
 def sendMail(subject, message, recipients):
@@ -139 +230 @@
         # popen is deprecated since Python 2.6
         # use subprocess module instead
+        
+        # THIS DOES NOT WORK CORRECTLY!  
+        #sends mail to /tmp/pvmail_message.txt with no message
         #args = shlex.split(cmd)
-        #subprocess.call(args)  # THIS DOES NOT WORK CORRECTLY!  sends mail to /tmp/pvmail_message.txt with no message
+        #subprocess.call(args)  
 
 
@@ -157 +251 @@
 
 
-if __name__ == '__main__':
-    '''only run the tool from the command line'''
+def basicStartTest():
+    '''simple test of the PvMail class'''
     logging.basicConfig(filename=LOG_FILE,level=logging.INFO)
     logger("startup")
     pvm = PvMail()
+    pvm.recipients = ['prjemian@gmail.com']
+    pvm.triggerPV = "pvMail:trigger"
+    pvm.messagePV = "pvMail:message"
+    retry_interval_s = 0.05
+    end_time = time.time() + 60
+    report_time = time.time() + 5.0
+    pvm.doStart()
+    while time.time() < end_time:
+        if time.time() > report_time:
+            report_time = time.time() + 5.0
+            logger("time remaining: %.1f seconds ..." % (end_time - time.time()))
+        time.sleep(retry_interval_s)
+    pvm.doStop()
+
+
+def basicMailTest():
+    '''simple test sending mail using the PvMail class'''
+    pvm = PvMail()
     pvm.send_test_message()
+
+
+def cli(results):
+    '''
+    command-line interface to the PvMail class
+    
+    :param obj results: default parameters from argparse, see chooser()
+    '''
+    logging.basicConfig(filename=results.log_file, level=logging.INFO)
+    logger("startup")
+
+    pvm = PvMail()
+    pvm.triggerPV = results.trigger_PV
+    pvm.messagePV = results.message_PV
+    pvm.recipients = results.email_addresses.strip().split(" ")
+    pvm.message_file = results.message_file
+    checkpoint_time = time.time() + results.logging_interval
+    pvm.doStart()
+    while True:     # endless loop, kill with ^C or equal
+        if time.time() > checkpoint_time:
+            checkpoint_time = time.time() + results.logging_interval
+            logger("checkpoint")
+        time.sleep(results.sleep_duration)
+    pvm.doStop()        # this will never be called
+
+
+def gui(results):
+    '''
+    graphical user interface to the PvMail class
+    
+    :param obj results: default parameters from argparse, see chooser()
+    '''
+    logging.basicConfig(filename=results.log_file,level=logging.INFO)
+    logger("startup")
+
+    pvm = PvMail()
+    pvm.message_file = results.message_file
+    # TODO: tba
+
+
+def chooser():
+    '''parse command-line and choose which interface to use'''
+    parser = argparse.ArgumentParser(description=__description__)
+
+    parser.add_argument('trigger_PV', action='store',
+                        help="EPICS trigger PV name", default="")
+
+    parser.add_argument('message_PV', action='store',
+                        help="EPICS message PV name", default="")
+
+    parser.add_argument('email_addresses', action='store',
+                        help="email address(es), comma-separated if more than one", 
+                        default="")
+
+    parser.add_argument('-l', action='store', dest='log_file',
+                        help="for logging program progress and comments", 
+                        default=LOG_FILE)
+
+    parser.add_argument('-f', action='store', dest='message_file',
+                        help="temporary file for email message", 
+                        default=MESSAGE_FILE)
+
+    parser.add_argument('-i', action='store', dest='logging_interval', 
+                        type=float,
+                        help="checkpoint reporting interval (s) in log file", 
+                        default=CHECKPOINT_INTERVAL_S)
+
+    parser.add_argument('-r', action='store', dest='sleep_duration', 
+                        type=float,
+                        help="sleep duration (s) in main event loop", 
+                        default=RETRY_INTERVAL_S)
+
+    parser.add_argument('--gui', action='store_true', default=False,
+                        dest='interface',
+                        help='Use the graphical rather than command-line interface')
+
+    parser.add_argument('--version', action='version', version=__version__)
+
+    results = parser.parse_args()
+    print "trigger PV       = " + results.trigger_PV
+    print "message PV       = " + results.message_PV
+    print "email list       = " + str(results.email_addresses.strip().split(","))
+    print "log file         = " + results.log_file
+    print "message file     = " + results.message_file
+    print "logging interval = " + str( results.logging_interval )
+    print "sleep duration   = " + str( results.sleep_duration )
+    print "interface        = " + {False: 'command-line', True: 'GUI'}[results.interface]
+    {False: cli, True: gui}[results.interface](results)     # call the interface
+
+
+if __name__ == '__main__':
+    #  ./pvMail.py  pvMail:trigger pvMail:message prjemian@gmail.com,jemian@anl.gov
+    chooser()

pvMail/src/pyEpics/test.db ¶

@@ -10 +10 @@
 
 #  /APSshare/epics/base-3.14.12.1/bin/linux-x86-el5-debug/softIoc -d test.db
-#  camonitor pvMail:{trigger,message}
+#
+#  IOC:     softIoc -d test.db
+#  client:  camonitor pvMail:{trigger,message}
 
 record(bo, "pvMail:trigger")