Skip to content

docs: state the contract of live_mode_available and hardware_averaging - #1426

Merged
seb5g merged 8 commits into
5.3.xfrom
docs/live-mode-averaging-contract
Oct 27, 2026
Merged

seb5g merged 8 commits into
5.3.xfrom
docs/live-mode-averaging-contract

Conversation

@seb5g

@seb5g seb5g commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Before: the Live Mode section of the plugin documentation did not say how the DAQ_Viewer behaves with a plugin that has live_mode_available = True, and nothing said how it relates to hardware_averaging (#1421, fixed by #1422).

After: the section states that the DAQ_Viewer calls grab_data once in live mode and the plugin emits until stop, and a note says the two attributes are independent: live_mode_available tells who repeats the acquisition, hardware_averaging tells who averages. It also warns that a plugin that averages the acquisitions itself (a camera averaging its frames, for instance) must set hardware_averaging = True, otherwise the DAQ_Viewer averages the averaged data again.

How: documentation only (docs/src/developer_folder/instrument_plugins.rst). The wording follows the comments added to DAQ_Viewer_base by #1422 and the tests of viewer_grab_loop_test.py. Not built locally.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Tdiso1u1ZhikSutj2Qs5Cg

@seb5g
seb5g merged commit 29ff70f into 5.3.x Oct 27, 2026
2 checks passed
@seb5g
seb5g deleted the docs/live-mode-averaging-contract branch October 27, 2026 10:44
@seb5g seb5g mentioned this pull request Oct 29, 2026
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