NationalInstruments.STS.TestHeadApi 26.5.0

TestHeadPublicApi

Overview

The TestHeadPublicApi is a C# API designed to control and monitor the STS (Semiconductor Test System). It provides a simple and structured way to interact with the STS through seven core services, each handling specific aspects of the system.

Core Services

• General: Retrieve system information, status, and identification.
• Power: Control and monitor power supplies, subsystems, and distributions.
• DIB: Manage Device Interface Board (DIB) safety and interlocks.
• IO: Control digital I/O lines and air purge functionality.
• Sensor: Monitor temperature, fan, and proximity sensors.
• Device: Manage hardware devices (e.g., MUX silos).
• I2C: Perform low-level I2C communication.

Key Features

• Target Framework: .NET Framework 4.6.2
• Modes of Operation:
  • Simulation Mode (simulate = true): Offline mode for development without hardware
  • Hardware Mode (simulate = false): Connects to STS hardware. If remote IP is not provided, will use SystemController IP defined in STS_Definition.xml.

Quickstart

Option 1: Using NuGet Package

1. Install the package in Visual Studio:

Install-Package NationalInstruments.STS.TestHeadApi

Option 2: Using DLLs Directly

1. Reference this dll in your project: NationalInstruments.STS.TestHeadApi.dll

Using the API

Create a TestHead instance:

// Include required namespace
using NationalInstruments.STS.TestHeadApi;

// Create TestHead instance
var testHead = new TestHeadPublicApi(customTestIp: null, timeoutMs: 5000, simulate: false); // Use true for offline testing

Common Operations:

// System information
var status = testHead.General.GetSystemStatus();
var dateTime = testHead.General.GetDateTime();

// Power control
testHead.Power.Supply("SystemPos12V").Enable();

// Sensor monitoring
var temps = testHead.Sensor.GetTemperatureSensors();

// DIB operations
var dibStatus = testHead.DIB.GetDIBInterlockStatus();

Service Methods

General Service

Power Service

Manages all power-related operations through three main interfaces: Supply, Subsystem, and Distribution.

Note: See Offline Mode in STS Maintenance Software for more information on TesterDefinition.xml

Valid Parameter Names

Power Supplies (valid supplyName)

Note: Multi-channel AUX supply names (e.g., AuxPs1/1,2 or AuxPs1/0:3) will be supported in a future release.

Power Subsystems (valid subsystemName)

Power Distribution (valid distributionName)

Note: Both constants and string literals are supported. Using constants is recommended for type safety.

Three main interfaces

1. Power Supply Interface

Methods

Properties

2. Power Subsystem Interface

Methods

Properties

3. Power Distribution Interface

Properties

DIB Service

IO Service

Sensor Service

DeviceService

I2C Service

Data Types

General Types

Power Types

DIB Types

IO Types

Sensor Types

Device Types

I2C Types

Note: SerialNumberHex is a computed property that returns the hexadecimal representation of SerialNumber (e.g., 0x3039). It is read-only and calculated from the SerialNumber field.