NSLS-II / nslsii

NSLS-II related devices
BSD 3-Clause "New" or "Revised" License
10 stars 21 forks source link

simplify Xspress3 component hierarchy #149

Closed jklynch closed 2 years ago

jklynch commented 2 years ago

This PR proposes a simplification of the Xspress3 component hierarchy from this:

xs.channels.channel01.mcarois.mcaroi01

to this:

xs.channel01.mcaroi01
tacaswell commented 2 years ago

How are we doing API change notes for nslsii? There is a very high chance that this will break profiles on the floor. Doing a low-fidelity search turns up

$ ack '\.channels\.chan[0-9]' --python -l
nsls-ii-xpd/profile_collection/acceptance_tests/02-count-scalers.py
nsls-ii-xpd/profile_collection/acceptance_tests/03-tth_cal.py
nsls-ii-xpd/profile_collection/startup/20-scalers.py
nsls-ii-xpd/profile_collection_germ/acceptance_tests/02-count-scalers.py
nsls-ii-xpd/profile_collection_germ/acceptance_tests/03-tth_cal.py
nsls-ii-xpd/profile_collection_germ/startup/20-scalers.py
nsls-ii-srx/profile_collection/startup/30-scaler.py
nsls-ii-csx/xf23id1_profiles/profile_collection/acceptance_tests/01-count.py
nsls-ii-csx/xf23id1_profiles/profile_collection/startup/90-softGluescalar.py
nsls-ii-csx/xf23id1_profiles_simulated/profile_simulated/acceptance_tests/02-dscan-eta.py
nsls-ii-csx/xf23id1_profiles_simulated/profile_simulated/acceptance_tests/03-diff-beam.py
nsls-ii-hxn/profile_collection/startup/22-scalers.py
nsls-ii-tes/profile_collection/startup/25-sclr.py
nsls-ii-six/profile_collection/startup/23-detectors.py
nsls-ii-bmm/profile_collection/startup/BMM/struck.py
nsls-ii-bmm/profile_collection/startup/BMM/user_ns/detectors.py
nsls-ii-bmm/profile_collection/startup/BMM/xdi.py
nsls-ii-xfm/profile_collection/startup/20-scaler.py

(just searching for \.channels\. also catches the strucks. Luckily scruck sub-devices are named as 'channel{:02d}' and the xspress3 are named as 'chan{d}').

It may be worth putting in properties at the top level for obj.channels and .obj.mcarois that will warn + redirect?

tacaswell commented 2 years ago

On discussion with @jklynch it was pointed out that this is the new Community IOC ophyd object that is only on the floor at BMM, not the old quatum detector IOC (that is in nslsii.detectors.xspress3 vs nslsii/areadetector/xspress3.py which this PR is changing).

tacaswell commented 2 years ago

Needs a note in https://github.com/NSLS-II/nslsii/blob/master/docs/source/release-history.rst and our next release on this should be 0.4

tacaswell commented 2 years ago

@jklynch Promises to update the release history right away.