| 1 | .. $Id: index.rst 1094 2012-09-07 19:39:37Z jemian $ |
|---|
| 2 | |
|---|
| 3 | PvMail |
|---|
| 4 | ================================== |
|---|
| 5 | |
|---|
| 6 | http://subversion.xray.aps.anl.gov/admin_bcdaext/pvMail |
|---|
| 7 | |
|---|
| 8 | PvMail was built to watch (monitor) an EPICS PV and send an email |
|---|
| 9 | when the value of that PV changes from 0 to 1. |
|---|
| 10 | |
|---|
| 11 | .. sidebar:: IMPORTANT: |
|---|
| 12 | |
|---|
| 13 | PvMail *only* triggers when the trigger_PV makes a transition from 0 to 1. |
|---|
| 14 | |
|---|
| 15 | * It will ignore transitions (in floating-point PVs) to |
|---|
| 16 | 1.0000... that do not come directly from 0.0000... |
|---|
| 17 | If you wish to watch a PV that presents values other than 0 and 1, |
|---|
| 18 | then use a calculation PV as the trigger which results in a |
|---|
| 19 | transition from 0 to 1. |
|---|
| 20 | * Reset the value of the trigger_PV to 0 to resume watching |
|---|
| 21 | for the next triggered event. |
|---|
| 22 | |
|---|
| 23 | The PV being watched (that *triggers* the sending of the email) |
|---|
| 24 | can be any EPICS record type or field |
|---|
| 25 | that results in a value of 0 (zero) that changes to 1 (one). This |
|---|
| 26 | includes these EPICS records (and possibly more): |
|---|
| 27 | *ai*, *ao*, *bi*, *bo*, *calcout*, *scalcout*, *swait*, ... |
|---|
| 28 | |
|---|
| 29 | When an event causes an email to be triggered, PvMail will retrieve |
|---|
| 30 | the value of another PV that is the first part of the message to be |
|---|
| 31 | sent. Additional metadata will be appended to the message. |
|---|
| 32 | |
|---|
| 33 | .. note:: |
|---|
| 34 | Email is sent using a call to the ``sendmail`` program on the native OS. |
|---|
| 35 | This almost certainly precludes its use on Windows systems. |
|---|
| 36 | The GUI or command-line versions will operate but likely no email |
|---|
| 37 | is sent. Also, the host computer must allow and be configured for |
|---|
| 38 | sending email to the intended recipients. |
|---|
| 39 | |
|---|
| 40 | PvMail provides either a command-line interface or a graphical user |
|---|
| 41 | interface. Both are accessed from the same command, using different |
|---|
| 42 | command-line options. The command-line version is intended to run |
|---|
| 43 | as a background program, it has no user interaction but logs all its |
|---|
| 44 | output into a log file. The GUI version provides a screen to edit |
|---|
| 45 | each of the parameters before the background process is started. |
|---|
| 46 | It also provides buttons to start and stop the background process. |
|---|
| 47 | |
|---|
| 48 | Overview of Contents |
|---|
| 49 | ======================== |
|---|
| 50 | |
|---|
| 51 | .. toctree:: |
|---|
| 52 | :maxdepth: 2 |
|---|
| 53 | |
|---|
| 54 | contents |
|---|
| 55 | glossary |
|---|
| 56 | dependencies |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | *This documentation was built:* |today| |
|---|
