Function Reference

Tecap Switching Programming Interface (TPI)

This section desrcibes the LabVIEW VIs of the Tecap Switching library.

The used LabVIEW version LabVIEW 2014, for older LabVIEW versions please contact support@pickeringtest.com

Tecap_Switching_Example_Start.vi

This VI starts the Tecap Server and Client, opens a given project, boots the system and performs a full reset.

As soon as the "System started" info appears all other Tecap Switching VIs can be used interactively.

Tecap_Switching_Example_Stop.vi

This VI stops the Client and on request stops the Server as well.

The Tecap Engine will then be removed from memory.

This method should be used for a system shut down.

TPI Start Sequence.vi

This VI

- starts the Tecap Server and Client

- opens a given project

- opens the IDE (if selected)

- boots the system (online/offline)

- performs a full reset (if reset is selected or the project is reloaded)

As soon as the "System started" info appears (if Show End Message is on) all other Tecap Switching VIs can be used interactively.

TPI Stop Sequence.vi

This VI

- performs a full reset (if reset is selected)

- stops the Tecap Client

- stops the Tecap Server (if selected) - project gets unloaded

-"System stopped" info appears (if Show End Message is on)

TPI App Close Main Window.vi

Hides the main window of the Tecap Application.

TPI App Show Main Window.vi

Shows the main window of the Tecap Application.

TPI Client Connect.vi

Connects to the Tecap Interop Server. This has to be done first to be able to instruct the server by the other interop API functions.

TPI Client Disconnect.vi

Disconnect the client from the Tecap Interop Server.

TPI Client Is Connected.vi

Checks whether this Client is connected to Tecap Interop Server.

TPI Get Error Code Name.vi

Gets the name of the error code constant.

TPI Get Error Message.vi

Gets the error description for the specified error code.

TPI Get Last Error Code.vi

Gets the error code of the last API call.

TPI Project Close.vi

Closes the currently open project.

TPI Project Get Open File Path Length.vi

Gets the length of the project file path string.

TPI Project Get Open File Path.vi

Gets the file path and name of the currently open project.

TPI Project Is Open.vi

Determines whether a project is open.

TPI Project Open.vi

Opens a Tecap Project from the specified file path.

TPI Server Add Start Arg.vi

Add a start argument that is used to configure Tecap Interop Server when starting.

TPI Server Is Running.vi

Checks whether Tecap Interop Server is up and running.

TPI Server Start.vi

Starts the Tecap Interop Server in the given functional mode.

TPI Server Stop.vi

Stops the Tecap Interop Server, if no other clients are connected.

TPI Switch Connect Endpoints Arr.vi

Directly connects a signal path between the starting endpoint and multiple target endpoints represented in an array.

The Tecap Auto Router will connect the starting endpoint one by one with the given target endpoints while overlapping all of them in an optimal way.

Target Endpoint names are listed in an array.

TPI Switch Connect Endpoints Csv.vi

Directly connects a signal path between the starting endpoint and the multiple target endpoints. The Tecap Auto Router will connect the starting endpoint one by one with the given target endpoints while overlapping all of them in an optimal way.

TPI Switch Connect Relay Group.vi

Connects the specified relay group.

TPI Switch Connect Route.vi

Connects the specified signal route or a group of routes.

TPI Switch Disconnect Endpoints Arr.vi

Directly disconnects and removes a signal path between the specified starting endpoint and the target endpoints represented in an array.

TPI Switch Disconnect Endpoints Csv.vi

Directly disconnects and removes a signal path between the specified endpoints.

TPI Switch Disconnect Relay Group.vi

Disconnects the specified relay group.

TPI Switch Disconnect Route.vi

Disconnects the specified signal route or a group of routes.

TPI Switch Setup Get Endpoint Names.vi

Gets the configured endpoint names of the currently active tester setup.

TPI Switch Setup Get Relay Group Names.vi

Gets the configured relay group names of the currently active tester setup.

TPI Switch Setup Get Route Names.vi

Gets the configured routes names of the currently active tester setup.

TPI Switch Setup Get Endpoint Names Buffer Size.vi

Gets the buffer size of all endpoint names.

TPI Switch Setup Get Route Names Buffer Size.vi

Gets the buffer size for all route names.

TPI Switch Setup Get Relay Group Names Buffer Size.vi

Gets the buffer size of all relay group names.

TPI Switch Set Short Circuit Detection.vi

Enable or disable Short Circuit Detection for Signal Routing. This is valid for static and auto-routed signals.

Enable only possible if the Short Detection Mode is set to "Manually Turn On/Off". Settings under Tecap Switching IDE \Tools\Options\Measurement Center\Switching

TPI Switch Get Short Circuit Detection.vi

Returns the enable status of the Short Circuit Detection for Signal Routing.

TPI System Boot Offline.vi

Boots the Test System with the activated System Setup into Offline State, means the Device Drivers are not initialized and thus no hardware is required. To boot the system a Tester Setup has to be activated first.

TPI System Boot Online.vi

Boots the Test System with the active Tester Setup into Driver Online State. This initializes all Device Drivers. This requires the System Hardware to be connected to the computer and be powered on. To boot the system a Tester Setup has to be activated first.

TPI System Is Booted Offline.vi

Determines whether the Test System is booted in Driver Offline State.

TPI System Is Booted Online.vi

Determines whether the Test System is booted in Driver Online State.

TPI System Is Booted.vi

Determines whether the Test System is booted.

TPI System Reset Full.vi

Resets all instruments states to initial state. If the Test System is booted in Driver Online State this will be applied to the hardware programming it to initial state.

TPI Convert CVI Error Codes.vi

This VI converts error codes from LabWindows/CVI instrument drivers to standard LabVIEW error codes. If an error is detected the VI builds the appropriate error cluster that is readable by one of the error handlers supplied with LabVIEW. Additionally, the VI accomodates instrument specific or user-defined error conditions. See instructions on the front panel.