diff --git a/documentation/areaDetectorDoc.html b/documentation/areaDetectorDoc.html index aed6060..04da88e 100755 --- a/documentation/areaDetectorDoc.html +++ b/documentation/areaDetectorDoc.html @@ -26,6 +26,7 @@
  • asynNDArrayDriver
  • ADDriver
  • ADStdDriverParams
  • +
  • MEDM screens
  • Plugins @@ -755,6 +756,13 @@ typedef enum ADTriggerInternal, ADTriggerExternal } ADTriggerMode_t; + +typedef enum { + ADFileModeSingle, + ADFileModeCapture, + ADFileModeStream +} ADFileMode_t; +

    It also defines parameters that all area detector drivers should implement if possible. @@ -795,7 +803,8 @@ typedef enum - Parameter Definitions in ADStdDriverParams.h and EPICS Record Definitions in ADBase.template + Parameter Definitions in ADStdDriverParams.h and EPICS Record Definitions in ADBase.template + (file-related records are in NDFile.template) @@ -1293,7 +1302,7 @@ typedef enum - File saving parameters + File saving parameters (records are defined in NDFile.template) @@ -1472,9 +1481,11 @@ epicsSnprintf( WRITE_FILE - $(P)$(R)WriteFile + $(P)$(R)WriteFile
    + $(P)$(R)WriteFile_RBV - longout + abusy
    + bi @@ -1488,9 +1499,81 @@ epicsSnprintf( READ_FILE - $(P)$(R)ReadFile + $(P)$(R)ReadFile
    + $(P)$(R)ReadFile_RBV - longout + abusy
    + bi + + + + ADFileWriteMode + + asynInt32 + + r/w + + File saving mode (Single, Capture, Stream)(ADFileMode_t) + + WRITE_MODE + + $(P)$(R)FileWriteMode
    + $(P)$(R)FileWriteMode_RBV + + mbbo
    + mbbi + + + + ADFileCapture + + asynInt32 + + r/w + + Start (1) or stop (0) file capture or streaming + + CAPTURE + + $(P)$(R)FileCapture
    + $(P)$(R)FileCapture_RBV + + abusy
    + bi + + + + ADNumCapture + + asynInt32 + + r/w + + Number of frames to acquire in capture or streaming mode + + NUM_CAPTURE + + $(P)$(R)FileNumCapture
    + $(P)$(R)FileNumCapture_RBV + + longout
    + longin + + + + ADNumCaptured + + asynInt32 + + r/o + + Number of frames currently acquired capture or streaming mode + + NUM_CAPTURED + + $(P)$(R)FileNumCaptured_RBV + + longin @@ -1642,7 +1725,7 @@ epicsSnprintf( r/w - Shutter mode (None, detector-controlled or EPICSS-controlled) (ADShutterMode_t) + Shutter mode (None, detector-controlled or EPICS-controlled) (ADShutterMode_t) SHUTTER_MODE @@ -1876,17 +1959,42 @@ epicsSnprintf( +

    + MEDM screens

    The following is the MEDM screen that provides access to the parameters in ADStdDriverParams through records in ADBase.template. This is a top-level MEDM screen that will work with any areaDetector driver. Note however that many drivers will not implement - all of these parameters, so detector-specific MEDM screens should generally be created - that only display the EPICS PVs for the features implemented for that detector. + all of these parameters, and there will usually be detector-specific parameters not shown + in this screen, so detector-specific MEDM screens should generally be created + that display the EPICS PVs for the features implemented for that detector.

    ADBase.adl

    ADBase.png
    +

    + The following is the MEDM screen that provides access to the file-related + parameters in ADStdDriverParams through records in NDFile.template. + This screen is for use with detector drivers that directly implement file I/O. +

    +
    +

    + NDFile.adl

    + NDFile.png
    +

    + The following is the MEDM screen that provides access to the EPICS shutter + parameters in ADStdDriverParams through records in ADBase.template. + This screen allows one to define the EPICS PVs to open the shutter, close the shutter, + and determine the shutter status. The values of these PVs for open and close drive + and status can also be + defined. Note that in many cases the same PV will be used for open and close drive, + but in some cases (e.g. APS safety shutters) different PVs are used for open and close. +

    +
    +

    + ADEpicsShutter.adl

    + ADEpicsShutter.png

    Plugins