Table of Contents

Locating Examples

Examples for how to use the Semiconductor Test Library (STL) are available on GitHub and are also installed with STS Software.

Reference the GitHub location for the latest version of the examples or to browse the example code source online. When on a system with STS Software installed, reference the examples from their installed location. The installed version of an example matches the state of the example at the time of the STL release consumed by the installed STS Software version. Refer to the STS Software Version Compatibility table for more details.

Note

You must build the code solutions for examples downloaded from GitHub before you can run them. The installed examples are pre-compiled and ready to run.

There are different styles of examples, each organized within their own sub-directory. Refer to the sections below to learn more about each style of example.

Note

Each example includes documentation in the form of a README.md markdown file. Markdown files are human-readable plain-text documents you can view using any text editor, including Notepad.

Code Snippet Examples

Code snippet examples demonstrate how to use specific API methods or implement coding concepts.

  • Example use cases are represented by individual static methods within separate static class files that are organized by high-level categories, such as instrument abstraction and data abstraction.
  • The example methods are not designed to run independently. Example methods have contextual requirements that are described within the example method summary or code comments.
Note

Code snippet style examples were the only example style available for v24.5.0, v24.5.1, and v25.0.0 releases of the Semiconductor Test Library.

Sequence Examples

Sequence examples demonstrate how to program instrumentation or implement code-level or sequence-level concepts within an STS test sequence.

  • Each example provides a single TestStand sequence file that runs within the TestStand Sequence Editor. The sequence file may include sub-sequences or steps with code modules for specific use cases, scenarios, or high-level concepts. Code modules are not designed to run independently outside of the relevant example sequence.
  • Any requirements for understanding or running the example are documented in an accompanying README.md. Context is also provided in sequence comments or inline code statements.
  • Example sequences run in offline mode with simulated hardware or with actual hardware, depending on the documented requirements.
Note

Sequence style examples are available as of the v25.5 release of the Semiconductor Test Library (STL). Unless documented otherwise, they can be leveraged with previous STL versions. Refer to the documentation accompanying the specific example for details.

Test Program Examples

Test Program examples demonstrate mock test programs for testing specific DUT types.

  • The supported DUT type, requirements, and assumptions are documented in an accompanying README.md.
  • Each test program contains fully-documented code implementations. Each test method has code-level summary documentation.
  • Test programs run in offline mode with simulated hardware.
Note

Test program style examples are available as of the v25.5 release of the Semiconductor Test Library (STL). Unless documented otherwise, they can be leveraged with previous STL versions. Refer to the documentation accompanying the specific example for details.

Edit this page