Added watsonmarlow323 device for i22 ppump. #575

barnettwilliam · 2024-05-24T13:27:02Z

Added Watson Marlow 323 pump device for use on I22 - draft PR for concept review.

This device depends on an updated support module interface (support/watson-marlow) that was made more consistent while making this change - release TBC.

Instructions to reviewer on how to test:

TBC
Confirm that device is operable

Checks for reviewer

Would the PR title make sense to a scientist on a set of release notes
If a new device has been added does it follow the standards
If changing the API for a pre-existing device, ensure that any beamlines using this device have updated their Bluesky plans accordingly
Have the connection tests for the relevant beamline(s) been run via dodal connect ${BEAMLINE}

callumforrester

Looking good, thanks @barnettwilliam

I've made a few comments, mostly minor stuff.

You also need to rebase against main and fix the linting.
You can run ruff format and ruff check --fix to do that.
̶A̶d̶d̶i̶t̶i̶o̶n̶a̶l̶l̶y̶,̶ ̶i̶f̶ ̶y̶o̶u̶ ̶u̶s̶e̶ ̶v̶s̶c̶o̶d̶e̶,̶ ̶I̶ ̶r̶e̶c̶o̶m̶m̶e̶n̶d̶ ̶c̶o̶p̶y̶/̶p̶a̶s̶t̶i̶n̶g̶ ̶i̶n̶ ̶[̶t̶h̶i̶s̶ ̶s̶e̶t̶t̶i̶n̶g̶s̶ ̶d̶i̶r̶e̶c̶t̶o̶r̶y̶]̶(̶h̶t̶t̶p̶s̶:̶/̶/̶g̶i̶t̶h̶u̶b̶.̶c̶o̶m̶/̶D̶i̶a̶m̶o̶n̶d̶L̶i̶g̶h̶t̶S̶o̶u̶r̶c̶e̶/̶p̶y̶t̶h̶o̶n̶-̶c̶o̶p̶i̶e̶r̶-̶t̶e̶m̶p̶l̶a̶t̶e̶/̶t̶r̶e̶e̶/̶m̶a̶i̶n̶/̶.̶v̶s̶c̶o̶d̶e̶)̶ ̶(̶i̶t̶'̶s̶ ̶g̶i̶t̶i̶g̶n̶o̶r̶e̶d̶)̶ ̶t̶o̶ ̶m̶a̶k̶e̶ ̶i̶t̶ ̶a̶u̶t̶o̶ ̶f̶o̶r̶m̶a̶t̶ ̶e̶t̶c̶.̶
Scratch that, wrong repo, sorry! You should already have the settings so just need to make sure your environment is set up correctly. We recommend using the dev container: https://dev-portal.diamond.ac.uk/guide/containers/tutorials/devcontainer/

callumforrester · 2024-05-30T06:32:41Z

src/dodal/devices/watsonmarlow323.py

+     STOPPED = "STOP"
+     STARTED = "START"
+
+class WatsonMarlow323(StandardReadable):


Nit: I would prefer a name that gives some suggestion as to what it does, maybe:

Suggested change

class WatsonMarlow323(StandardReadable):

class WatsonMarlow323Pump(StandardReadable):

Renamed as suggested also updated filenames in 417aaa1.

callumforrester · 2024-05-30T06:34:28Z

tests/devices/unit_tests/test_watsonmarlow323.py

+        },
+    )
+
+async def assert_reading(


Should: There is a utility function in ophyd-async that does this, you can just import that

Example: https://github.com/DiamondLightSource/dodal/blob/main/tests/devices/unit_tests/test_undulator.py

Updated to use the ophyd-async definition as suggested in 417aaa1, assert_reading() is defined in test_slits.py the file I initially looked at when creating the test for this device.

callumforrester · 2024-05-30T06:34:54Z

src/dodal/devices/watsonmarlow323.py

+     """Watson Marlow 323 Pump device"""
+     def __init__(self, prefix: str, name: str= "") -> None:
+
+          self.enabled = epics_signal_r(WatsonMarlow323Enable, prefix + "DISABLE")


I haven't read the manual, but is this PV really read-only?

Checking this its not read only so I've made it rw in 417aaa1.

callumforrester · 2024-05-30T06:36:00Z

src/dodal/devices/watsonmarlow323.py

+class WatsonMarlow323Direction(str, Enum):
+     CW = "CW"
+     CCW = "CCW"


Nit: More meaningful names would be good here, we need to retain the cryptic acronyms on the epics side, but the ophyd side can have long, descriptive names e.g.

Suggested change

class WatsonMarlow323Direction(str, Enum):

CW = "CW"

CCW = "CCW"

class WatsonMarlow323Direction(str, Enum):

CLOCKWISE = "CW"

COUNTER_CLOCKWISE = "CCW"

Updated names in 417aaa1

barnettwilliam · 2024-05-31T07:32:31Z

Thanks @callumforrester I've incorporated your suggested changes, rebased, and linted. Also, made enabled a readable signal based on @DiamondJoseph's comments following chat on Wed.

I just need to test this with an actual device to confirm it communicates correctly after which I'll undraft and submit.

DiamondJoseph

Looks sensible

DiamondJoseph · 2024-05-29T15:23:49Z

src/dodal/beamlines/i22.py

+def ppump(
+    wait_for_connection: bool = True, 
+    fake_with_ophyd_sim: bool = False
+) -> WatsonMarlow323:
+    return device_instantiation(
+        WatsonMarlow323,
+        "ppump",
+        "-EA-PUMP-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim
+    )


Please also add a fake_with_ophyd_sim: bool = True equivalent to p38.py, such that it can be kept in a simulated mirror state of i22 (we will make it use the same beamline module file eventually)

Fixed in 6d5ae3f

@barnettwilliam not quite, you've made the i22.py one fake_with_ophyd_sim = True, that needs to be False, and another device_instantiation added to p38.py with fake_with_ophyd_sim = True

Oops, thanks corrected in d21684d

src/dodal/beamlines/i22.py

DiamondJoseph · 2024-05-31T07:42:17Z

src/dodal/beamlines/i22.py

+def ppump(
+    wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False
+) -> WatsonMarlow323Pump:
+    return device_instantiation(
+        WatsonMarlow323Pump,
+        "ppump",
+        "-EA-PUMP-01:",
+        wait_for_connection,
+        fake_with_ophyd_sim,
+    )


Please also add to p38.py with fake_with_ophyd_sim: bool = True

As per #575 (comment), fixed in 6d5ae3f.

DiamondJoseph · 2024-05-31T07:44:21Z

src/dodal/devices/watsonmarlow323_pump.py

+            read_pv=prefix + "DISABLE",
+            write_pv=prefix + "DISABLE",


write_pv isn't required if they're both the same.

Fixed in 6d5ae3f

DiamondJoseph · 2024-05-31T07:46:08Z

src/dodal/devices/watsonmarlow323_pump.py

+        self.limit_high = epics_signal_rw(
+            float, read_pv=prefix + "SET:SPD.DRVH", write_pv=prefix + "SET:SPD.DRVH"
+        )
+        self.limit_low = epics_signal_rw(
+            float, read_pv=prefix + "SET:SPD.DRVL", write_pv=prefix + "SET:SPD.DRVL"
+        )


Limits (and units, precision...) will propagate with the speed signal once this change is merged, these signals shouldn't be required: as is, it's not clear what they are the limits of, but when the change is merged they'll become metadata on the speed signal.

Ok I'll remove these when bluesky/ophyd-async#137 is merged

Rebased and fixed in 84824ca.

src/dodal/devices/watsonmarlow323_pump.py

DominicOram · 2024-05-31T14:00:10Z

src/dodal/beamlines/i22.py

+
+
+@skip_device
+def ppump(


Is this deliberately double p? If so what does the first p stand for?

Interjecting here, the double p matches what's on i22's synoptic (it feels like matching the synoptic name <-> bluesky name makes sense?).

The p is for peristaltic pump, as opposed to spump which is a syringe pump.

Might make sense to add a comment somewhere though with the "peristaltic pump" expanded out.

Can we put this in the docstring? Otherwise people will (rightly) think it looks like a typo

Or could call the device peristaltic_pump

I prefer peristaltic_pump. It's up to the scientist though, do they have strong views?

Added docstring description in 6d5ae3f, I'll find out what the scientists would prefer as the device name.

…nd used ophyd-async assert_reading utility function for tests.

…skip device, enabled fake_with_ophyd_sim, and don't specify read write pv if they are the same.

…ir corresponding signal.

DiamondJoseph · 2024-07-01T08:36:28Z

src/dodal/devices/watsonmarlow323_pump.py

+        self.enabled = epics_signal_rw(
+            WatsonMarlow323PumpEnable,
+            prefix + "DISABLE",
+        )
+
+        self.direction = epics_signal_rw(
+            WatsonMarlow323PumpDirection,
+            read_pv=prefix + "INFO:DIR",
+            write_pv=prefix + "SET:DIR",
+        )
+        self.state = epics_signal_rw(
+            WatsonMarlow323PumpState,
+            read_pv=prefix + "INFO:RUN",
+            write_pv=prefix + "SET:RUN",
+        )
+        self.speed = epics_signal_rw(
+            float, read_pv=prefix + "INFO:SPD", write_pv=prefix + "SET:SPD"
+        )
+
+        self.set_readable_signals(
+            read=[self.state, self.speed, self.direction],
+            config=[
+                self.enabled,
+            ],
+        )
+


nit: this could be done with the add_children_as_readables context, which is now the recommended way to do it in the ophyd-async docs

DiamondJoseph

nit, but otherwise looks good

barnettwilliam requested a review from callumforrester May 28, 2024 11:54

DiamondJoseph self-requested a review May 29, 2024 15:22

callumforrester requested changes May 30, 2024

View reviewed changes

barnettwilliam force-pushed the watson-marlow-323 branch from 417aaa1 to c2790bf Compare May 30, 2024 16:58

DiamondJoseph requested changes May 31, 2024

View reviewed changes

callumforrester mentioned this pull request May 31, 2024

Clearer documentation on how to use the reading context manager in a StandardReadable bluesky/ophyd-async#349

Open

DominicOram reviewed May 31, 2024

View reviewed changes

William Barnett and others added 6 commits July 1, 2024 08:56

Added watsonmarlow323 device for i22 ppump.

d75ddf9

Changes from code review: improved naming, made enabled read/write, a…

78ca479

…nd used ophyd-async assert_reading utility function for tests.

Fixed linting errors.

48697ab

Changes from code review: added device details to docstring, removed …

18d5c70

…skip device, enabled fake_with_ophyd_sim, and don't specify read write pv if they are the same.

Change from code review: added simulated pump to p38.

07ccf47

Change from code review: Removed limits that are now propagted by the…

84824ca

…ir corresponding signal.

barnettwilliam force-pushed the watson-marlow-323 branch from d21684d to 84824ca Compare July 1, 2024 08:10

DiamondJoseph reviewed Jul 1, 2024

View reviewed changes

DiamondJoseph approved these changes Jul 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added watsonmarlow323 device for i22 ppump. #575

Added watsonmarlow323 device for i22 ppump. #575

barnettwilliam commented May 24, 2024

callumforrester left a comment •

edited

Loading

callumforrester May 30, 2024

barnettwilliam May 30, 2024

callumforrester May 30, 2024

barnettwilliam May 30, 2024

callumforrester May 30, 2024

barnettwilliam May 30, 2024

callumforrester May 30, 2024

barnettwilliam May 30, 2024

barnettwilliam commented May 31, 2024

DiamondJoseph left a comment

DiamondJoseph May 29, 2024

barnettwilliam Jun 3, 2024

DiamondJoseph Jun 3, 2024

barnettwilliam Jun 3, 2024

DiamondJoseph May 31, 2024

barnettwilliam Jun 3, 2024

DiamondJoseph May 31, 2024

barnettwilliam Jun 3, 2024

DiamondJoseph May 31, 2024

barnettwilliam May 31, 2024

barnettwilliam Jul 1, 2024

DominicOram May 31, 2024

Tom-Willemsen May 31, 2024 •

edited

Loading

DominicOram May 31, 2024

callumforrester May 31, 2024

DominicOram May 31, 2024

barnettwilliam Jun 3, 2024

DiamondJoseph Jul 1, 2024

DiamondJoseph left a comment

	class WatsonMarlow323(StandardReadable):
	class WatsonMarlow323Pump(StandardReadable):

Added watsonmarlow323 device for i22 ppump. #575

Are you sure you want to change the base?

Added watsonmarlow323 device for i22 ppump. #575

Conversation

barnettwilliam commented May 24, 2024

Instructions to reviewer on how to test:

Checks for reviewer

callumforrester left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

barnettwilliam commented May 31, 2024

DiamondJoseph left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tom-Willemsen May 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DiamondJoseph left a comment

Choose a reason for hiding this comment

callumforrester left a comment •

edited

Loading

Tom-Willemsen May 31, 2024 •

edited

Loading