Skip to content

Add documentation for Multiplexer connection#441

Open
Shalini-Subramanian wants to merge 12 commits intomainfrom
users/Soliton/user/shasubra/multiplexed-connection-user-guide
Open

Add documentation for Multiplexer connection#441
Shalini-Subramanian wants to merge 12 commits intomainfrom
users/Soliton/user/shasubra/multiplexed-connection-user-guide

Conversation

@Shalini-Subramanian
Copy link
Copy Markdown
Collaborator

What does this Pull Request accomplish?
This PR contains the github documentation for the Multiplexed connection support that will be included as a part of 26.0 release.

Why should this Pull Request be merged?
It contains the public documentation for multiplexed connection which will be added to ni.github.io

What testing has been done?
NA

@Shalini-Subramanian Shalini-Subramanian changed the title doc: Add documentation for Multiplexer connection Add documentation for Multiplexer connection Mar 23, 2026
@Shalini-Subramanian Shalini-Subramanian marked this pull request as ready for review March 26, 2026 06:40
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Copy link
Copy Markdown

@gergelyterenyi-ni gergelyterenyi-ni left a comment

Choose a reason for hiding this comment

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

Tech writer review

Please let me know if you have any questions related to the comments.

Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Copy link
Copy Markdown

@gergelyterenyi-ni gergelyterenyi-ni left a comment

Choose a reason for hiding this comment

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

The updates look good. No further comments. Thank you!

Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Comment thread docs/UserGuide/WorkingWithMultiplexedConnections.md
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated
Copy link
Copy Markdown
Collaborator

@Mattjet27 Mattjet27 left a comment

Choose a reason for hiding this comment

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

@Shalini-Subramanian, after addressing these latest comments, I think this is ready for a final tech writer review. Once the tech writer completes their final review, I'll do one final pass myself. Thanks!

Comment thread docs/UserGuide/WorkingWithMultiplexedConnections.md Outdated
1. **Add the measurement instrument** (for example, a DMM or a DC Power instrument).
2. **Add a multiplexer instrument**.
3. **Set the Multiplexer Type field** to match the type identifier that your code uses when your code calls `GetSwitchNames` and `SetSwitchSession`.
4. **Define the DUT pins** used in the multiplexed connections.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think you may only need the one statement in the important note, simplify it to just, "Using SystemPins or SiteRelays is not supported when defining multiplexed connections with STL."

Comment thread docs/UserGuide/WorkingWithMultiplexedConnections.md Outdated
Comment thread docs/UserGuide/MultiplexedConnectionSupport.md Outdated

Before using multiplexed connections in your test code:

1. (Optional) **Initialize the Relay Driver Module session** with the existing STL `SetupAndCleanupSteps.SetupNIRelayDriverModuleSessions` method. This method is typically in ProcessSetup.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@Shalini-Subramanian, please change "... that test program was created..." to "... the test program was created...", otherwise looks good!

Comment thread docs/UserGuide/WorkingWithMultiplexedConnections.md Outdated
- **Instrument** and **Channel**: The instrument channel that is routed.
- **Multiplexer**: The multiplexer used for routing.
- **Route**: The relay configuration or route name to apply for this pin-site combination.
- **Route**: The relay configuration to apply for this pin-site specific connection.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

pin-site-specific

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.

5 participants