BUG: enum_strs do not match PV values

[prjemian]

For certain area detector instances, we define custom strings for the $(P):cam1:FrameType mbbo record. The values correspond to HDF5 paths where images are to be written.

Ophyd 1.2.0 ignores these customizations.

Expected Behavior

In [n]: adsimdet.cam.frame_type.enum_strs
Out[n]: ('/detector/images', '/detector/darks', '/detector/flats', 'DblCorrelation')```

Given these definitions made before starting ipython/ophyd session:

In [1]: adsimdet.cam.frame_type.pvname
Out[1]: 'otzSIM1:cam1:FrameType_RBV'

In [2]: !caget otzSIM1:cam1:FrameType.{ZR,ON,TW,TH,FR}ST
otzSIM1:cam1:FrameType.ZRST    /detector/images
otzSIM1:cam1:FrameType.ONST    /detector/darks
otzSIM1:cam1:FrameType.TWST    /detector/flats
otzSIM1:cam1:FrameType.THST    DblCorrelation
otzSIM1:cam1:FrameType.FRST    

Current Behavior

In [3]: adsimdet.cam.frame_type.enum_strs
Out[3]: ('Normal', 'Background', 'FlatField', 'DblCorrelation')

Possible Solution

don't assume values for enum_strs

Steps to Reproduce (for bugs)

see above

Context

Tomography wants to save data according to its Data Exchange format for tomoPy where images, darks, and flats are separate datasets in the same HDF5 group, all in one file. The technique to configure area detector is explained in this document.

(note: I'm picking different HDF5 path names here than the DX standard. Only for developer's version of this file support.)

Your Environment

BlueSky executable path: /home/oxygen/JEMIAN/Apps/BlueSky/bin
Python 3.6.2 :: Continuum Analytics, Inc.
conda 4.5.4
pip 10.0.1 from /home/oxygen/JEMIAN/Apps/BlueSky/lib/python3.6/site-packages/pip (python 3.6)
starting ipython with profile: bluesky
Python 3.6.2 |Continuum Analytics, Inc.| (default, Jul 20 2017, 13:51:32) 
Type 'copyright', 'credits' or 'license' for more information
IPython 6.4.0 -- An enhanced Interactive Python. Type '?' for help.

IPython profile: bluesky
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/00-0-checks.py
BlueSky version: 1.3.3
Ophyd version: 1.2.0
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/00-startup.py
Loading metadata history from /home/oxygen/JEMIAN/.config/bluesky/bluesky_history.db
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/01-databroker.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/02-pyepics.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/10-devices.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/11-motors.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/15-hkl.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/20-detectors.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/20-signals.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/21-tunable-motors.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/25-areadetector.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/50-plans.py
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/60-metadata.py
Metadata dictionary:
RE.md['BLUESKY_VERSION'] = 1.3.3
RE.md['OPHYD_VERSION'] = 1.2.0
RE.md['beamline_id'] = developer
RE.md['login_id'] = jemian@otz.aps.anl.gov
RE.md['pid'] = 29219
RE.md['proposal_id'] = None
RE.md['purpose'] = documentation
RE.md['scan_id'] = 201
/home/oxygen18/JEMIAN/.ipython/profile_bluesky/startup/80-callbacks.py

[prjemian]

Resolved: There are two mbbo records to set: "FrameType" and "FrameType_RBV". Likely the latter (from the _RBV) is shown with adsimdet.cam.frame_type.enum_strs. One must remember that changes must be made to both these mbbo records.