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

Update readme doc for Measurement Plug-In Client generator #620

Merged
merged 3 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,10 @@ Note:
Note:

- The Measurement Plug-In Client is compatible with all datatypes supported by the Measurement Plug-In.
- For Enum datatypes, the LabVIEW Client supports only contiguous enums.
- If the Measurement Plug-In uses a LabVIEW UI, ring controls in the UI will be represented as numeric controls in the client, maintaining the same representation.
- For Enum datatype, contiguous enums will be represented as enum control
and sparse enums will be represented as ring control in the client.
- If the Measurement Plug-In uses a LabVIEW UI, ring controls in the UI will be represented as numeric controls in the client,
maintaining the same representation.

---

Expand Down Expand Up @@ -170,7 +172,15 @@ Note:

Note:

- To run `Run Client.vi` without registering the pin map for a pin-based measurement, specify the IOResource name in the configuration control instead of the Pin name.
- To run `Run Client.vi` without registering the pin map for a pin-based measurement,
specify the IOResource name in the configuration control instead of the Pin name.
- The `Run Client.vi` will support both stream and non-stream measurements.
- For non-stream measurements, `Run Client.vi` can be used as a standalone VI
or subVI without any modifications.
- For stream measurements, when used as a subVI within a framework,
`Run Client.vi` will only provide the last successful value of the measurement results.
To obtain all responses from a stream measurement, replicate the logic inside
`Run Client.vi` within the framework.

---

Expand Down
Binary file modified docs/images/Measurement client library files.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/New measurement client dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/Run Client Template VI.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.