Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstring for DeviceVector and document how to group devices #183

Merged
merged 6 commits into from
Apr 17, 2024

Conversation

callumforrester
Copy link
Contributor

Add docstring for DeviceVector and document How to Group Devices

Move initial how-to on assembling devices into its own page and add a section about using DeviceVector to make arbitrary-length groups. Add an example to the epics demo with tests.

@@ -43,6 +49,19 @@ def __init__(self, prefix: str, name="") -> None:
super().__init__(name=name)


class SensorGroup(StandardReadable):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the ioc subprocess command at the bottom of the file actually contain all these sensors? I'd like to keep this file and the tutorials in step so that you can always run up an IOC to test the example code...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does now, although I think we should document that process/make it easier. Maybe even add tests to prove that the IOC contains the demo objects. I'll make an issue or two.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done: #193

@callumforrester callumforrester force-pushed the document-device-vector branch 3 times, most recently from 238f37b to 37a38a1 Compare April 11, 2024 17:18
Move initial how-to on assembling devices into its own page and add a
section about using DeviceVector to make arbitrary-length groups. Add an
example to the epics demo with tests.
@callumforrester callumforrester merged commit 6865e87 into main Apr 17, 2024
14 checks passed
@callumforrester callumforrester deleted the document-device-vector branch April 17, 2024 07:27
gilesknap pushed a commit to gilesknap/ophyd-async that referenced this pull request Apr 18, 2024
…esky#183)

* Add docstring for DeviceVector

* Document How to Group Devices

Move initial how-to on assembling devices into its own page and add a
section about using DeviceVector to make arbitrary-length groups. Add an
example to the epics demo with tests.

* Add sensor group to demo IOC

* Test IOC starts

* Add timeout to IOC test

* Only mock with IOC test for now
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants