TiePie TP112 Operating and maintenance manual

Programmer's Manual

TiePie DLLs

for: TP112 TiePieSCOPE HS508

TP208 TiePieSCOPE HS801 AWG

TP508 Handyprobe HP2

TP801 AWG ISA Handyscope HS2

TP801 AWG PCI Handyscope HS3

TE6100 Handyscope HS4 (DIFF)

Revision 1.26

Table of contents 3

Table of contents

Table of contents ............................................. 3

Introduction ................................................. 7

How can I... ................................................. 9

Understand the codes .................................... 9

Error codes ...................................... 9

Defined constants ................................. 9

Open / Close the instrument .............................. 11

Search and Initialize the Instrument ................... 11

Close the Instrument .............................. 11

Get information about my instrument ....................... 12

Get the calibration date ............................ 12

Get the instrument serial number ..................... 12

Determine the available input sensitivities ............... 13

Determine the available input resolutions ............... 13

Get the number of input channels .................... 14

Get the maximum sampling frequency ................. 14

Get the maximum record length ..................... 14

Check for availability of DC hardware offset adjustment .... 15

Check for a square wave generator ................... 15

Check for a function generator ....................... 15

Get the maximum amplitude of the function generator ..... 16

Perform a measurement ................................. 17

Start a measurement .............................. 17

Check if the hardware is measuring ................... 17

Abort a running measurement ....................... 17

Read the trigger status ............................. 18

Read the measurement status ....................... 18

Force a trigger ................................... 18

Retrieve the data ....................................... 19

Get the data from a specific channel in binary format ....... 19

Get the date from a specific channel in Volts ............. 19

Get all digital input values ........................... 20

Get one sample of the digital input values ............... 20

Example of use of the routines ....................... 21

Setup for streaming measurements ......................... 23

Using DataReady callback function .................... 23

Using DataReady event ............................ 23

Setting up streaming measurements ................... 24

4Table of contents

Getting the current transfer mode .................... 24

Performing streaming measurements .................. 25

Control the input resolution .............................. 26

Set the input resolution ............................ 26

Get the current input resolution ...................... 26

Control the instrument configuration ........................ 27

Set the instrument configuration ...................... 27

Get the current instrument configuration ............... 27

Control which channels are measured ....................... 28

Get the current measure mode ...................... 28

Set the measure mode ............................ 28

Control the time base .................................. 29

Get the current record length ....................... 29

Set the record length .............................. 29

Get the current number of post samples ............... 30

Set the number of post samples ...................... 30

Get the current sampling frequency ................... 31

Set the sampling frequency .......................... 31

Get the sample clock status ......................... 32

Set the sample clock status .......................... 32

Control the analog input channels .......................... 33

Get the current input sensitivity ...................... 33

Set the input sensitivity ............................. 33

Get the current auto ranging status .................... 34

Set the auto ranging status .......................... 34

Get the current input coupling ....................... 35

Set the input coupling ............................. 35

Get the current DC level value ...................... 36

Set the DC level value ............................. 36

Control the trigger system ................................ 37

Get the current trigger source ....................... 37

Set the trigger source .............................. 37

Get the current trigger mode ........................ 38

Set the trigger mode .............................. 38

Get the current trigger mode for a specific channel ........ 39

Set the trigger mode for a specific channel .............. 39

Get the current trigger level ......................... 40

Set the trigger level ............................... 40

Get the current trigger hysteresis ..................... 41

Set the trigger hysteresis ........................... 41

Select the PXI external trigger signals .................. 42

Get the current used PXI external trigger signals .......... 42

Set the PXI external trigger slopes .................... 43

Get the current PXI external trigger slopes .............. 43

Table of contents 5

Control the digital outputs ................................ 44

Set the digital outputs .............................. 44

Get the current status of the digital outputs .............. 44

Control the Square Wave generator ........................ 45

Get the current square wave generator frequency ........ 45

Set the square wave generator frequency ............... 45

Control the Arbitrary Waveform Generator .................. 46

Set the generator mode ............................ 46

Get the current generator mode ..................... 46

Set the generator signal type ........................ 47

Get the current generator signal type .................. 47

Set the generator amplitude ......................... 48

Get the current generator amplitude .................. 48

Set the generator DC Offset ........................ 49

Get the current generator DC Offset .................. 49

Set the generator signal symmetry .................... 50

Get the current generator signal symmetry .............. 50

Set the generator frequency ......................... 51

Get the current generator frequency .................. 51

Set the generator trigger source ...................... 52

Get the current generator trigger source ............... 52

Fill the function generator waveform memory ........... 53

Set the generator output state ....................... 54

Get the current generator output state ................. 54

Set the generator enabled state ...................... 55

Get the current generator output state ................. 55

Generate bursts .................................. 56

Use the I2Cbus ....................................... 57

Get the I2Cbus speed ............................. 57

Set the I2Cbus speed .............................. 57

Write data to the I2Cbus ........................... 58

Read data from the I2Cbus ......................... 59

Perform resistance measurements .......................... 60

Setup resistance measurements ...................... 60

Retrieve the resistance values ........................ 60

Deprecated routines ......................................... 61

Get the maximum sampling frequency ................. 61

Start a measurement .............................. 61

Get all measurement data in Volts .................... 61

Get one sample of the measurement data, in Volts ........ 62

Get all measurement data, binary ..................... 62

Get one sample of the measurement data, binary ......... 62

Retrieve the measured data in binary format ............. 62

6Table of contents

Retrieve the measured data in Volts ................... 63

Get the current sampling frequency ................... 63

Set the sampling frequency .......................... 63

Get the current trigger timeout value .................. 63

Set the trigger timeout value ........................ 64

Introduction 7

Introduction

This manual describes the available functions in the DLLs for the various TiePie

engineering measuring instruments.

For each instrument, a specific DLL is available. All DLLs have the same routines

and the same programming interface.

Since all instruments have different specifications, a number of functions are

available to determine the specifications of the instrument, like e.g. maximum

sampling frequency, maximum record length, number of channels etc.

Not all instruments have the same functionality as other instruments, like e.g. the

availability of a function generator or digital inputs and outputs. When a certain

function is called and the instrument does not support that functionality, the

routine will return an error code indicating that the functionality is not suppor-

ted.

Since the initial development of the DLLs, many routines have been added to

the DLL, to improve the performance of performing measurements using the

DLL. Several of those routines are replacing older routines, but are not entirely

compatible. To avoid that existing software would no longer function, the old

routines are still available in the DLL, but are marked in the manual as being

obsolete. It is advised to stop using these routines and use the new routines

instead.

8 Introduction

How can I... 9

How can I...

Understand the codes

Error codes

Most routines in the DLL return a status value, that indicates whether the routi-

ne was executed successfully or not. In case of a non successfull execution, the

returb value will indicate the possible cause of the error. The following codes

are used:

Code Names Code Values

Hexadecimal Binary

E_NO_ERRORS = 0x0000;/*0000000000000000*/

E_NO_HARDWARE = 0x0001;/*0000000000000001*/

E_NOT_INITIALIZED = 0x0002;/*0000000000000010*/

E_NOT_SUPPORTED = 0x0004;/*0000000000000100*/

E_NO_GENERATOR = 0x0008;/*0000000000001000*/

E_INVALID_CHANNEL = 0x0010;/*0000000000010000*/

E_INVALID_VALUE = 0x0020;/*0000000000100000*/

E_I2C_ERROR = 0x0040;/*0000000001000000*/

E_I2C_INVALID_ADDRESS = 0x0080;/*0000000010000000*/

E_I2C_INVALID_SIZE = 0x0100;/*0000000100000000*/

E_I2C_NO_ACKNOWLEDGE = 0x0200;/*0000001000000000*/

Defined constants

For several programming environments declaration files (header files) are availa-

ble. These files contain declarations for all the available functions in the DLL, but

also declarations of many used constants, like for trigger sources.

It is recommended that the constants from these declaration files are used in the

application that uses the DLL. When in a future release of the DLL some values

have changed, they will be adapted in the declaration file as well, so the applicati-

on only needs to be recompiled, it will not affect the rest of the program.

All channel related routines use a channel parameter to indicate for which chan-

nel the value is meant:

10 How can I...

lCh1 = 1

lCh2 = 2

lCh3 = 3

lCh4 = 4

The routines that deal with the MeasureMode use different values:

mmCh1 = 1

mmCh2 = 2

mmCh3 = 4

mmCh4 = 8

This manual suits for next models

Table of contents

Other TiePie Test Equipment manuals

TiePie

TiePie Handyscope TP450 User manual

TiePie

TiePie Handyscope HS5 series User manual

TiePie

TiePie WiFiScope WS6 User manual

TiePie

TiePie Handyprobe HP3 User manual

TiePie

TiePie Handyscope HS6 DIFF Series User manual

TiePie

TiePie Handyscope TP450 User manual

TiePie

TiePie Handyscope HS4 User manual

TiePie

TiePie WiFiScope WS6 User manual

TiePie

TiePie GMTO ATS5004D User manual

TiePie

TiePie Handyscope HS5 series User manual

TiePie

TiePie Handyscope HS3 User manual

TiePie

TiePie Handyscope HS4 User manual

TiePie

TiePie TP-EMI-HS6 User manual

Popular Test Equipment manuals by other brands

SMART

SMART KANAAD SBT XTREME 3G Series user manual

Agilent Technologies

Agilent Technologies BERT Serial Getting started

Agilent Technologies

Agilent Technologies N3280A user guide

Vernier

Vernier Go Direct Voltage manual

Lifeloc

Lifeloc R.A.D.A.R. quick start guide

Fluke

Fluke T5-600 Service information

Mercury

Mercury TSL01 user manual

MAHA

MAHA MBT Series Original operating instructions

Fuji Electric

Fuji Electric P-61 instruction manual

ETC

ETC SealerAtor user manual

Skyfine

Skyfine ETHYWAY V2 user manual

Appion

Appion G5 Twin Operation manual

PCB Piezotronics

PCB Piezotronics 8159-0112A Installation and operating manual

BW Technologies

BW Technologies MicroDock II user manual

Sun Nuclear

Sun Nuclear 1027 user guide

Biomark

Biomark HPR LITE READER user manual

Hioki

Hioki 3169-20 instruction manual

Ashcroft

Ashcroft ATE-100 operating manual