libtiepie-hw Documentation

Introduction

The libtiepie-hw library is a library for using TiePie engineering USB instruments through third party software.

Supported instruments

WiFiScopes	Handyscopes	Automotive Test WiFi Scopes	Automotive Test Scopes
WiFiScope WS6 DIFF	Handyscope HS6 DIFF	ATS610004DW-XMSG	ATS610004D-XMSG
		ATS605004DW-XMS	ATS605004D-XMS
WiFiScope WS6	Handyscope HS6
WiFiScope WS5	Handyscope HS5
WiFiScope WS4 DIFF	Handyscope HS4 DIFF	ATS5004DW	ATS5004D
	Handyscope HS4
	Handyscope HS3
	Handyprobe HP3
	Handyscope TP450

Library structure

LibTiePie maintains a Device list, containing all available supported devices. Possible devices are oscilloscopes and generators. Instruments can contain multiple devices, e.g. the Handyscope HS5 and WiFiScope WS5 contain an oscilloscope and a generator.

Devices can contain sub devices. E.g. devices contain trigger systems, oscilloscopes contain channels, channels contain channel trigger systems.

The LibTiePie library contains functions to control all aspects of the device list and the (sub) devices.

LibTiePie function name prefixes

All functions are prefixed, so it is easily determined where the function can be used for.

Prefix	Description
Lib	Common Library initialization/deinitialization/version related functions
Lst	Device list related functions
Obj	Common object related functions
Dev	Common device related functions
DevTrIn	Device trigger input related functions
DevTrOut	Device trigger output related functions
Scp	Oscilloscope related functions
ScpCh	Oscilloscope channel related functions
ScpChTr	Oscilloscope channel trigger related functions
Gen	Generator related functions
Hlp	Helper functions for bypassing limitations of some programming languages

Using LibTiePie

When using LibTiePie, to control instruments and perform measurements, the following steps are required:

• Initialize the library
• Update the device list
• Open the required device(s)
• Setup the Oscilloscope
  • Setup the oscilloscope channels
  • Setup the oscilloscope timebase
  • Setup the trigger (channels and device)
• Setup the Generator
• Start a measurement
• Wait for the measurement to be ready
• Retrieve the measured data
• Close the device(s)
• Exit the library

Error handling

On each function call a status flag is set, use tiepie_hw_get_last_status() to read the status flag. See also Status return codes.