libtiepie-hw

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-hw 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-hw library contains functions to control all aspects of the device list and the (sub) devices.

libtiepie-hw function name prefixes

All functions are prefixed, so it is easily determined where the function can be used for. They all have the prefix tiepie_hw_ and then most have a sub prefix indicating which section it relates to.

Sub prefix	Description
none	Common Library initialization/deinitialization/version related functions
devicelist_	Device list related functions
devicelistitem_	Listed devices related functions
devicelistitemcombined_	Listed combined devices related functions
object_	Common object related functions
device_	Common device related functions
device_trigger_	Device trigger related functions
device_trigger_input_	Device trigger inputs related functions
device_trigger_output_	Device trigger outputs related functions
oscilloscope_	Oscilloscope related functions
oscilloscope_trigger_	Oscilloscope trigger related functions
oscilloscope_channel_	Oscilloscope channel related functions
oscilloscope_channel_trigger_	Oscilloscope channel trigger related functions
generator_	Generator related functions
network_	Network related functions
network_servers_	Servers related functions
server_	Server related functions
pointerarray_	Helper functions for bypassing limitations of some programming languages

Using libtiepie-hw

When using libtiepie-hw, 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.