LibTiePie  0.5
Library for interfacing TiePie engineering instruments
 All Files Functions Typedefs Macros Modules Pages
libtiepie.h File Reference

Header for libtiepie. More...

#include "stdint.h"

Go to the source code of this file.

Macros

#define LIBTIEPIE_LINUX
 
#define LIBTIEPIE_VERSION_MAJOR   0
 
#define LIBTIEPIE_VERSION_MINOR   5
 
#define LIBTIEPIE_VERSION_RELEASE   0
 
#define LIBTIEPIE_VERSION_NUMBER   "0.5.0"
 
#define LIBTIEPIE_VERSION   "0.5.0"
 
#define LIBTIEPIE_REVISION   6687
 
#define ARN_COUNT   3
 Number of auto resolution modes. More...
 
#define ARB_DISABLED   0
 
#define ARB_NATIVEONLY   1
 
#define ARB_ALL   2
 
#define AR_UNKNOWN   0
 Unknown/invalid mode. More...
 
#define AR_DISABLED   ( 1 << ARB_DISABLED )
 Resolution does not automatically change. More...
 
#define AR_NATIVEONLY   ( 1 << ARB_NATIVEONLY )
 Highest possible native resolution for the current sample frequency is used. More...
 
#define AR_ALL   ( 1 << ARB_ALL )
 Highest possible native or enhanced resolution for the current sample frequency is used. More...
 
#define ARM_NONE   0
 
#define ARM_ALL   ( ( 1 << ARN_COUNT ) - 1 )
 
#define ARM_ENABLED   ( ARM_ALL & ~AR_DISABLED )
 
#define CKN_COUNT   5
 Number of couplings. More...
 
#define CKB_DCV   0
 Volt DC. More...
 
#define CKB_ACV   1
 Volt AC. More...
 
#define CKB_DCA   2
 Ampere DC. More...
 
#define CKB_ACA   3
 Ampere AC. More...
 
#define CKB_OHM   4
 Ohm. More...
 
#define CK_UNKNOWN   0
 Unknown/invalid coupling. More...
 
#define CK_DCV   ( 1 << CKB_DCV )
 Volt DC. More...
 
#define CK_ACV   ( 1 << CKB_ACV )
 Volt AC. More...
 
#define CK_DCA   ( 1 << CKB_DCA )
 Ampere DC. More...
 
#define CK_ACA   ( 1 << CKB_ACA )
 Ampere AC. More...
 
#define CK_OHM   ( 1 << CKB_OHM )
 Ohm. More...
 
#define CKM_NONE   0
 
#define CKM_V   ( CK_DCV | CK_ACV )
 Volt. More...
 
#define CKM_A   ( CK_DCA | CK_ACA )
 Ampere. More...
 
#define CKM_OHM   ( CK_OHM )
 Ohm. More...
 
#define CKM_ASYMMETRICRANGE   ( CKM_OHM )
 0 to +Range More...
 
#define CKM_SYMMETRICRANGE   ( CKM_V | CKM_A )
 -Range to +Range More...
 
#define CON_COUNT   3
 Number of clock output types. More...
 
#define COB_DISABLED   0
 No clock output. More...
 
#define COB_SAMPLE   1
 Sample clock. More...
 
#define COB_FIXED   2
 Fixed clock. More...
 
#define CO_DISABLED   ( 1 << COB_DISABLED )
 No clock output. More...
 
#define CO_SAMPLE   ( 1 << COB_SAMPLE )
 Sample clock. More...
 
#define CO_FIXED   ( 1 << COB_FIXED )
 Fixed clock. More...
 
#define COM_ALL   ( ( 1 << CON_COUNT ) - 1 )
 
#define COM_ENABLED   ( COM_ALL & ~CO_DISABLED )
 
#define CSN_COUNT   2
 Number of clock sources. More...
 
#define CSB_EXTERNAL   0
 External clock. More...
 
#define CSB_INTERNAL   1
 Internal clock. More...
 
#define CS_EXTERNAL   ( 1 << CSB_EXTERNAL )
 External clock. More...
 
#define CS_INTERNAL   ( 1 << CSB_INTERNAL )
 Internal clock. More...
 
#define FMN_COUNT   2
 Number of frequency modes. More...
 
#define FMB_SIGNALFREQUENCY   0
 
#define FMB_SAMPLEFREQUENCY   1
 
#define FM_UNKNOWN   0x00000000
 
#define FM_SIGNALFREQUENCY   ( 1 << FMB_SIGNALFREQUENCY )
 
#define FM_SAMPLEFREQUENCY   ( 1 << FMB_SAMPLEFREQUENCY )
 
#define FMM_NONE   0x00000000
 
#define FMM_ALL   ( ( 1 << FMN_COUNT ) - 1 )
 
#define GMN_COUNT   12
 Number of generator modes. More...
 
#define GMB_CONTINUOUS   0
 
#define GMB_BURST_COUNT   1
 
#define GMB_GATED_PERIODS   2
 
#define GMB_GATED   3
 
#define GMB_GATED_PERIOD_START   4
 
#define GMB_GATED_PERIOD_FINISH   5
 
#define GMB_GATED_RUN   6
 
#define GMB_GATED_RUN_OUTPUT   7
 
#define GMB_BURST_SAMPLE_COUNT   8
 
#define GMB_BURST_SAMPLE_COUNT_OUTPUT   9
 
#define GMB_BURST_SEGMENT_COUNT   10
 
#define GMB_BURST_SEGMENT_COUNT_OUTPUT   11
 
#define GM_UNKNOWN   0
 
#define GM_CONTINUOUS   ( 1 << GMB_CONTINUOUS )
 
#define GM_BURST_COUNT   ( 1 << GMB_BURST_COUNT )
 
#define GM_GATED_PERIODS   ( 1 << GMB_GATED_PERIODS )
 
#define GM_GATED   ( 1 << GMB_GATED )
 
#define GM_GATED_PERIOD_START   ( 1 << GMB_GATED_PERIOD_START )
 
#define GM_GATED_PERIOD_FINISH   ( 1 << GMB_GATED_PERIOD_FINISH )
 
#define GM_GATED_RUN   ( 1 << GMB_GATED_RUN )
 
#define GM_GATED_RUN_OUTPUT   ( 1 << GMB_GATED_RUN_OUTPUT )
 
#define GM_BURST_SAMPLE_COUNT   ( 1 << GMB_BURST_SAMPLE_COUNT )
 
#define GM_BURST_SAMPLE_COUNT_OUTPUT   ( 1 << GMB_BURST_SAMPLE_COUNT_OUTPUT )
 
#define GM_BURST_SEGMENT_COUNT   ( 1 << GMB_BURST_SEGMENT_COUNT )
 
#define GM_BURST_SEGMENT_COUNT_OUTPUT   ( 1 << GMB_BURST_SEGMENT_COUNT_OUTPUT )
 
#define GMM_NONE   0
 
#define GMM_BURST_COUNT   ( GM_BURST_COUNT )
 
#define GMM_GATED   ( GM_GATED_PERIODS | GM_GATED | GM_GATED_PERIOD_START | GM_GATED_PERIOD_FINISH | GM_GATED_RUN | GM_GATED_RUN_OUTPUT )
 
#define GMM_BURST_SAMPLE_COUNT   ( GM_BURST_SAMPLE_COUNT | GM_BURST_SAMPLE_COUNT_OUTPUT )
 
#define GMM_BURST_SEGMENT_COUNT   ( GM_BURST_SEGMENT_COUNT | GM_BURST_SEGMENT_COUNT_OUTPUT )
 
#define GMM_REQUIRE_TRIGGER   ( GMM_GATED | GMM_BURST_SAMPLE_COUNT | GMM_BURST_SEGMENT_COUNT )
 Generator modes that require an enabeld trigger input. More...
 
#define GMM_ALL   ( ( 1ULL << GMN_COUNT ) - 1 )
 
#define GMM_SIGNALFREQUENCY   ( GMM_ALL & ~GMM_BURST_SAMPLE_COUNT )
 Supported generator modes when frequency mode is signal frequency. More...
 
#define GMM_SAMPLEFREQUENCY   ( GMM_ALL )
 Supported generator modes when frequency mode is sample frequency. More...
 
#define GMM_SINE   ( GMM_SIGNALFREQUENCY )
 Supported generator modes when signal type is sine. More...
 
#define GMM_TRIANGLE   ( GMM_SIGNALFREQUENCY )
 Supported generator modes when signal type is triangle. More...
 
#define GMM_SQUARE   ( GMM_SIGNALFREQUENCY )
 Supported generator modes when signal type is square. More...
 
#define GMM_DC   ( GM_CONTINUOUS )
 Supported generator modes when signal type is DC. More...
 
#define GMM_NOISE   ( GM_CONTINUOUS | GM_GATED )
 Supported generator modes when signal type is noise. More...
 
#define GMM_ARBITRARY   ( GMM_SIGNALFREQUENCY | GMM_SAMPLEFREQUENCY )
 Supported generator modes when signal type is arbitrary. More...
 
#define GMM_PULSE   ( GMM_SIGNALFREQUENCY & ~GMM_BURST_SEGMENT_COUNT )
 Supported generator modes when signal type is pulse. More...
 
#define GSN_COUNT   4
 The number of generator status flags. More...
 
#define GSB_STOPPED   0
 
#define GSB_RUNNING   1
 
#define GSB_BURSTACTIVE   2
 
#define GSB_WAITING   3
 
#define GS_STOPPED   ( 1 << GSB_STOPPED )
 The signal generation is stopped. More...
 
#define GS_RUNNING   ( 1 << GSB_RUNNING )
 The signal generation is running. More...
 
#define GS_BURSTACTIVE   ( 1 << GSB_BURSTACTIVE )
 The generator is operating in burst mode. More...
 
#define GS_WAITING   ( 1 << GSB_WAITING )
 The generator is waiting for a burst to be started. More...
 
#define GSM_NONE   0
 
#define GSM_ALL   ( ( 1UL << GSN_COUNT ) - 1 )
 
#define MMN_COUNT   2
 Number of measure modes. More...
 
#define MMB_STREAM   0
 Stream mode bit number. More...
 
#define MMB_BLOCK   1
 Block mode bit number. More...
 
#define MMM_NONE   0
 
#define MMM_ALL   ( ( 1 << MMN_COUNT ) - 1 )
 
#define MM_UNKNOWN   0
 Unknown/invalid mode. More...
 
#define MM_STREAM   ( 1 << MMB_STREAM )
 Stream mode. More...
 
#define MM_BLOCK   ( 1 << MMB_BLOCK )
 Block mode. More...
 
#define STN_COUNT   7
 Number of signal types. More...
 
#define STB_SINE   0
 
#define STB_TRIANGLE   1
 
#define STB_SQUARE   2
 
#define STB_DC   3
 
#define STB_NOISE   4
 
#define STB_ARBITRARY   5
 
#define STB_PULSE   6
 
#define ST_UNKNOWN   0
 
#define ST_SINE   ( 1 << STB_SINE )
 
#define ST_TRIANGLE   ( 1 << STB_TRIANGLE )
 
#define ST_SQUARE   ( 1 << STB_SQUARE )
 
#define ST_DC   ( 1 << STB_DC )
 
#define ST_NOISE   ( 1 << STB_NOISE )
 
#define ST_ARBITRARY   ( 1 << STB_ARBITRARY )
 
#define ST_PULSE   ( 1 << STB_PULSE )
 
#define STM_NONE   0
 
#define STM_AMPLITUDE   ( ST_SINE | ST_TRIANGLE | ST_SQUARE | ST_NOISE | ST_ARBITRARY | ST_PULSE )
 
#define STM_OFFSET   ( ST_SINE | ST_TRIANGLE | ST_SQUARE | ST_DC | ST_NOISE | ST_ARBITRARY | ST_PULSE )
 
#define STM_FREQUENCY   ( ST_SINE | ST_TRIANGLE | ST_SQUARE | ST_NOISE | ST_ARBITRARY | ST_PULSE )
 
#define STM_PHASE   ( ST_SINE | ST_TRIANGLE | ST_SQUARE | ST_ARBITRARY | ST_PULSE )
 
#define STM_SYMMETRY   ( ST_SINE | ST_TRIANGLE | ST_SQUARE )
 
#define STM_WIDTH   ( ST_PULSE )
 
#define STM_DATALENGTH   ( ST_ARBITRARY )
 
#define STM_DATA   ( ST_ARBITRARY )
 
#define TCN_COUNT   3
 Number of trigger conditions. More...
 
#define TCB_NONE   0
 
#define TCB_SMALLER   1
 
#define TCB_LARGER   2
 
#define TC_UNKNOWN   0
 
#define TC_NONE   ( 1 << TCB_NONE )
 
#define TC_SMALLER   ( 1 << TCB_SMALLER )
 
#define TC_LARGER   ( 1 << TCB_LARGER )
 
#define TCM_NONE   0
 No conditions. More...
 
#define TCM_ALL   ( ( 1 << TCN_COUNT ) - 1 )
 All conditions. More...
 
#define TCM_ENABLED   ( TCM_ALL & ~TC_NONE )
 All conditions except TC_NONE. More...
 
#define TH_ALLPRESAMPLES   0xffffffffffffffffULL
 Trigger hold off to all presamples valid More...
 
#define TRIGGER_IO_ID(pgid, sgid, fid)   ( ( DN_MAIN << TIOID_SHIFT_DN ) | ( ( pgid ) << TIOID_SHIFT_PGID ) | ( ( sgid ) << TIOID_SHIFT_SGID ) | ( ( fid ) << TIOID_SHIFT_FID ) )
 
#define COMBI_TRIGGER_IO_ID(dn, tiid)   ( ( ( dn ) << TIOID_SHIFT_DN ) | ( ( tiid ) & ( ( 1 << TIOID_SHIFT_DN ) - 1 ) ) )
 
#define DN_MAIN   0
 The device itself. More...
 
#define DN_SUB_FIRST   1
 First sub device in a combined device. More...
 
#define DN_SUB_SECOND   2
 Second sub device in a combined device. More...
 
#define PGID_OSCILLOSCOPE   1
 Oscilloscope. More...
 
#define PGID_GENERATOR   2
 Generator. More...
 
#define PGID_EXTERNAL_DSUB   3
 External D-sub. More...
 
#define SGID_MAIN   0
 The oscilloscope or function generator itself. More...
 
#define SGID_CHANNEL1   1
 
#define SGID_CHANNEL2   2
 
#define SGID_PIN1   1
 
#define SGID_PIN2   2
 
#define SGID_PIN3   3
 
#define FID_SCP_TRIGGERED   0
 
#define FID_GEN_START   0
 
#define FID_GEN_STOP   1
 
#define FID_GEN_NEW_PERIOD   2
 
#define FID_EXT_TRIGGERED   0
 
#define TIOID_SHIFT_PGID   20
 
#define TIOID_SHIFT_DN   24
 
#define TIOID_SHIFT_SGID   8
 
#define TIOID_SHIFT_FID   0
 
#define TIID_INVALID   0
 
#define TIID_EXT1   TRIGGER_IO_ID( PGID_EXTERNAL_DSUB , SGID_PIN1 , FID_EXT_TRIGGERED )
 
#define TIID_EXT2   TRIGGER_IO_ID( PGID_EXTERNAL_DSUB , SGID_PIN2 , FID_EXT_TRIGGERED )
 
#define TIID_EXT3   TRIGGER_IO_ID( PGID_EXTERNAL_DSUB , SGID_PIN3 , FID_EXT_TRIGGERED )
 
#define TIID_GENERATOR_START   TRIGGER_IO_ID( PGID_GENERATOR , SGID_MAIN , FID_GEN_START )
 
#define TIID_GENERATOR_STOP   TRIGGER_IO_ID( PGID_GENERATOR , SGID_MAIN , FID_GEN_STOP )
 
#define TIID_GENERATOR_NEW_PERIOD   TRIGGER_IO_ID( PGID_GENERATOR , SGID_MAIN , FID_GEN_NEW_PERIOD )
 
#define TOID_INVALID   0
 
#define TOID_EXT1   TRIGGER_IO_ID( PGID_EXTERNAL_DSUB , SGID_PIN1 , FID_EXT_TRIGGERED )
 
#define TOID_EXT2   TRIGGER_IO_ID( PGID_EXTERNAL_DSUB , SGID_PIN2 , FID_EXT_TRIGGERED )
 
#define TOID_EXT3   TRIGGER_IO_ID( PGID_EXTERNAL_DSUB , SGID_PIN3 , FID_EXT_TRIGGERED )
 
#define TKN_COUNT   9
 Number of trigger kinds. More...
 
#define TKB_RISINGEDGE   0
 
#define TKB_FALLINGEDGE   1
 
#define TKB_INWINDOW   2
 
#define TKB_OUTWINDOW   3
 
#define TKB_ANYEDGE   4
 
#define TKB_ENTERWINDOW   5
 
#define TKB_EXITWINDOW   6
 
#define TKB_PULSEWIDTHPOSITIVE   7
 
#define TKB_PULSEWIDTHNEGATIVE   8
 
#define TK_UNKNOWN   0
 Unknown/invalid trigger kind. More...
 
#define TK_RISINGEDGE   ( 1ULL << TKB_RISINGEDGE )
 Rising edge. More...
 
#define TK_FALLINGEDGE   ( 1ULL << TKB_FALLINGEDGE )
 Falling edge. More...
 
#define TK_INWINDOW   ( 1ULL << TKB_INWINDOW )
 Inside window. More...
 
#define TK_OUTWINDOW   ( 1ULL << TKB_OUTWINDOW )
 Outside window. More...
 
#define TK_ANYEDGE   ( 1ULL << TKB_ANYEDGE )
 Any edge. More...
 
#define TK_ENTERWINDOW   ( 1ULL << TKB_ENTERWINDOW )
 Enter window. More...
 
#define TK_EXITWINDOW   ( 1ULL << TKB_EXITWINDOW )
 Exit window. More...
 
#define TK_PULSEWIDTHPOSITIVE   ( 1ULL << TKB_PULSEWIDTHPOSITIVE )
 Positive pulse width. More...
 
#define TK_PULSEWIDTHNEGATIVE   ( 1ULL << TKB_PULSEWIDTHNEGATIVE )
 Negative pulse width. More...
 
#define TKM_NONE   0
 No trigger kinds. More...
 
#define TKM_EDGE   ( TK_RISINGEDGE | TK_FALLINGEDGE | TK_ANYEDGE )
 All edge triggers. More...
 
#define TKM_WINDOW   ( TK_INWINDOW | TK_OUTWINDOW | TK_ENTERWINDOW | TK_EXITWINDOW )
 All window triggers. More...
 
#define TKM_PULSEWIDTH   ( TK_PULSEWIDTHPOSITIVE | TK_PULSEWIDTHNEGATIVE )
 All pulse width triggers. More...
 
#define TKM_TIME   ( TKM_PULSEWIDTH | TKM_WINDOW )
 All trigger kinds that may have a time property. More...
 
#define TKM_ALL   ( ( 1ULL << TKN_COUNT ) - 1 )
 All trigger kinds. More...
 
#define TO_INFINITY   -1
 No time out. More...
 
#define TOEN_COUNT   3
 Number of trigger output events. More...
 
#define TOEB_GENERATOR_START   0
 
#define TOEB_GENERATOR_STOP   1
 
#define TOEB_GENERATOR_NEWPERIOD   2
 
#define TOE_UNKNOWN   0
 
#define TOE_GENERATOR_START   ( 1 << TOEB_GENERATOR_START )
 
#define TOE_GENERATOR_STOP   ( 1 << TOEB_GENERATOR_STOP )
 
#define TOE_GENERATOR_NEWPERIOD   ( 1 << TOEB_GENERATOR_NEWPERIOD )
 
#define TOEM_NONE   0
 No trigger output events. More...
 
#define TOEM_GENERATOR   ( TOE_GENERATOR_START | TOE_GENERATOR_STOP | TOE_GENERATOR_NEWPERIOD )
 All generator trigger output events. More...
 
#define TOEM_ALL   ( ( 1ULL << TOEN_COUNT ) - 1 )
 All trigger output events. More...
 
#define PID_NONE   0
 Unknown/invalid ID. More...
 
#define PID_COMBI   2
 Combined instrument. More...
 
#define PID_HS4   15
 Handyscope HS4. More...
 
#define PID_HP3   18
 Handyprobe HP3. More...
 
#define PID_HS4D   20
 Handyscope HS4-DIFF. More...
 
#define PID_HS5   22
 Handyscope HS5. More...
 
#define TPDEVICEHANDLE_INVALID   0
 
#define DEVICETYPE_OSCILLOSCOPE   0x00000001
 Oscilloscope. More...
 
#define DEVICETYPE_GENERATOR   0x00000002
 Generator. More...
 
#define DEVICETYPE_I2CHOST   0x00000004
 I2C Host. More...
 
#define DEVICETYPE_COUNT   3
 Number of device types. More...
 
#define IDKIND_PRODUCTID   0x00000001
 dwId parameter is a product id. More...
 
#define IDKIND_INDEX   0x00000002
 dwId parameter is an index. More...
 
#define IDKIND_SERIALNUMBER   0x00000004
 dwId parameter is a serial number. More...
 
#define IDKIND_COUNT   3
 Number of id kinds. More...
 
#define LIBTIEPIESTATUS_SUCCESS   0
 The function executed successfully. More...
 
#define LIBTIEPIESTATUS_VALUE_CLIPPED   1
 One of the parameters of the last called function was outside the valid range and clipped to the closest limit. More...
 
#define LIBTIEPIESTATUS_VALUE_MODIFIED   2
 One of the parameters of the last called function was within the valid range but not available. The closest valid value is set. More...
 
#define LIBTIEPIESTATUS_UNSUCCESSFUL   -1
 An error occurred during execution of the last called function. More...
 
#define LIBTIEPIESTATUS_NOT_SUPPORTED   -2
 The requested functionality is not supported by the hardware. More...
 
#define LIBTIEPIESTATUS_INVALID_HANDLE   -3
 The handle to the device is invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_VALUE   -4
 The requested value is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_CHANNEL   -5
 The requested channel number is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_TRIGGER_SOURCE   -6
 The requested trigger source is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_TYPE   -7
 The device type is invalid. More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_INDEX   -8
 The device index is invalid, must be < LstGetCount(). More...
 
#define LIBTIEPIESTATUS_INVALID_PRODUCT_ID   -9
 There is no device with the requested product ID. More...
 
#define LIBTIEPIESTATUS_INVALID_DEVICE_SERIALNUMBER   -10
 There is no device with the requested serial number. More...
 
#define LIBTIEPIESTATUS_DEVICE_GONE   -11
 The device indicated by the device handle is no longer available. More...
 
#define LIBTIEPIESTATUS_INTERNAL_ADDRESS   -12
 The requested I2C address is an internally used address in the device. More...
 
#define LIBTIEPIESTATUS_NOT_CONTROLLABLE   -13
 The generator is currently not controllable, see GenIsControllable. More...
 
#define LIBTIEPIESTATUS_BIT_ERROR   -14
 The requested I2C operation generated a bit error. More...
 
#define LIBTIEPIESTATUS_NO_ACKNOWLEDGE   -15
 The requested I2C operation generated "No acknowledge". More...
 
#define LIBTIEPIESTATUS_INVALID_CONTAINED_DEVICE_SERIALNUMBER   -16
 A device with the requested serial number is not available in the combined instrument, see LstDevGetContainedSerialNumbers. More...
 
#define LIBTIEPIESTATUS_INVALID_INPUT   -17
 The requested trigger input is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_OUTPUT   -18
 The requested trigger output is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_DRIVER   -19
 The currently installed driver is not supported, see LstDevGetRecommendedDriverVersion(). (Windows only) More...
 
#define LIBTIEPIESTATUS_NOT_AVAILABLE   -20
 With the current settings, the requested functionality is not available. More...
 
#define LIBTIEPIESTATUS_INVALID_FIRMWARE   -21
 The currently used firmware is not supported . More...
 
#define LIBTIEPIESTATUS_INVALID_INDEX   -22
 The requested index is not valid. More...
 
#define LIBTIEPIESTATUS_INVALID_EEPROM   -23
 The instrument's EEPROM content is damaged, please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_INITIALIZATION_FAILED   -24
 The instrument's initialization failed, please contact TiePie engineering support. More...
 
#define LIBTIEPIESTATUS_LIBRARY_NOT_INITIALIZED   -25
 The library is not initialized, see LibInit(). More...
 
#define LIBTIEPIESTATUS_NO_TRIGGER_ENABLED   -26
 The current setup requires a trigger input to be enabled. More...
 
#define CONNECTORTYPE_UNKNOWN   0x00000000
 
#define CONNECTORTYPE_BNC   0x00000001
 
#define CONNECTORTYPE_BANANA   0x00000002
 
#define CONNECTORTYPE_POWERPLUG   0x00000004
 
#define CONNECTORTYPE_COUNT   3
 Number of connector types. More...
 
#define CONNECTORTYPE_MASK   ( CONNECTORTYPE_BNC | CONNECTORTYPE_BANANA | CONNECTORTYPE_POWERPLUG )
 
#define DATARAWTYPE_UNKNOWN   0x00000000
 
#define DATARAWTYPE_INT8   0x00000001
 int8_t More...
 
#define DATARAWTYPE_INT16   0x00000002
 int16_t More...
 
#define DATARAWTYPE_INT32   0x00000004
 int32_t More...
 
#define DATARAWTYPE_INT64   0x00000008
 int64_t More...
 
#define DATARAWTYPE_UINT8   0x00000010
 uint8_t More...
 
#define DATARAWTYPE_UINT16   0x00000020
 uint16_t More...
 
#define DATARAWTYPE_UINT32   0x00000040
 uint32_t More...
 
#define DATARAWTYPE_UINT64   0x00000080
 uint64_t More...
 
#define DATARAWTYPE_FLOAT32   0x00000100
 float More...
 
#define DATARAWTYPE_FLOAT64   0x00000200
 double More...
 
#define DATARAWTYPE_COUNT   10
 Number of raw data types. More...
 
#define DATARAWTYPE_MASK_INT   ( DATARAWTYPE_INT8 | DATARAWTYPE_INT16 | DATARAWTYPE_INT32 | DATARAWTYPE_INT64 )
 
#define DATARAWTYPE_MASK_UINT   ( DATARAWTYPE_UINT8 | DATARAWTYPE_UINT16 | DATARAWTYPE_UINT32 | DATARAWTYPE_UINT64 )
 
#define DATARAWTYPE_MASK_FLOAT   ( DATARAWTYPE_FLOAT32 | DATARAWTYPE_FLOAT64 )
 
#define DATARAWTYPE_MASK_FIXED   ( DATARAWTYPE_MASK_INT | DATARAWTYPE_MASK_UINT )
 
#define BOOL8_FALSE   0
 
#define BOOL8_TRUE   1
 
#define LIBTIEPIE_TRISTATE_UNDEFINED   0
 Undefined. More...
 
#define LIBTIEPIE_TRISTATE_FALSE   1
 False. More...
 
#define LIBTIEPIE_TRISTATE_TRUE   2
 True. More...
 
#define LIBTIEPIE_TRIGGERIO_INDEX_INVALID   0xffff
 
#define LIBTIEPIE_STRING_LENGTH_NULL_TERMINATED   0xffffffff
 
#define LIBTIEPIE_POINTER_ARRAY_MAX_LENGTH   256
 
#define TPVERSION_MAJOR(x)   ( x >> 48 )
 Extract the major number from a TpVersion_t value. More...
 
#define TPVERSION_MINOR(x)   ( ( x >> 32 ) & 0xffff )
 Extract the minor number from a TpVersion_t value. More...
 
#define TPVERSION_RELEASE(x)   ( ( x >> 16 ) & 0xffff )
 Extract the release number from a TpVersion_t value. More...
 
#define TPVERSION_BUILD(x)   ( x & 0xffff )
 Extract the build number from a TpVersion_t value. More...
 
#define TPDATE_YEAR(x)   ( x >> 16 )
 Extract year from a TpDate_t value. More...
 
#define TPDATE_MONTH(x)   ( ( x >> 8 ) & 0xff )
 Extract month from a TpDate_t value. More...
 
#define TPDATE_DAY(x)   ( x & 0xff )
 Extract day from a TpDate_t value. More...
 

Typedefs

typedef void(* TpCallback_t )(void *pData)
 
typedef void(* TpCallbackDeviceList_t )(void *pData, uint32_t dwDeviceTypes, uint32_t dwSerialNumber)
 
typedef int32_t LibTiePieStatus_t
 LibTiePie status code. More...
 
typedef uint32_t TpDeviceHandle_t
 Device handle. More...
 
typedef uint64_t TpVersion_t
 Data type representing a version number. More...
 
typedef uint32_t TpDate_t
 Data type representing a date. More...
 
typedef uint8_t bool8_t
 Boolean value one byte wide. More...
 
typedef uint8_t LibTiePieTriState_t
 TriState value one byte wide. More...
 
typedef void ** LibTiePiePointerArray_t
 Pointer array. More...
 

Functions

void LibInit (void)
 Create and initialize internal resources used by the library. More...
 
bool8_t LibIsInitialized (void)
 Check whether the library's internal resources are initialized. More...
 
void LibExit (void)
 Clear and free internal resources used by the library. More...
 
TpVersion_t LibGetVersion (void)
 Get the library version number. More...
 
const char * LibGetVersionExtra (void)
 Get the library version postfix. More...
 
uint32_t LibGetConfig (uint8_t *pBuffer, uint32_t dwBufferLength)
 Get the library configuration number. More...
 
LibTiePieStatus_t LibGetLastStatus (void)
 Get the last status value. More...
 
const char * LibGetLastStatusStr (void)
 Get the last status value as text. More...
 
void LstUpdate (void)
 Update the device list. More...
 
uint32_t LstGetCount (void)
 Get the number of devices in the device list. More...
 
TpDeviceHandle_t LstOpenDevice (uint32_t dwIdKind, uint32_t dwId, uint32_t dwDeviceType)
 Open a device and get a handle to the device. More...
 
TpDeviceHandle_t LstOpenOscilloscope (uint32_t dwIdKind, uint32_t dwId)
 Open an oscilloscope and get a handle to the oscilloscope. More...
 
TpDeviceHandle_t LstOpenGenerator (uint32_t dwIdKind, uint32_t dwId)
 Open a generator and get a handle to the generator. More...
 
TpDeviceHandle_t LstOpenI2CHost (uint32_t dwIdKind, uint32_t dwId)
 Open an I2C host and get a handle to the I2C host. More...
 
uint32_t LstCreateCombinedDevice (const TpDeviceHandle_t *pDeviceHandles, uint32_t dwCount)
 Create a combined instrument. More...
 
TpDeviceHandle_t LstCreateAndOpenCombinedDevice (const TpDeviceHandle_t *pDeviceHandles, uint32_t dwCount)
 Create and open a combined instrument. More...
 
void LstRemoveDevice (uint32_t dwSerialNumber)
 Remove an instrument from the device list so it can be used by other applications. More...
 
bool8_t LstDevCanOpen (uint32_t dwIdKind, uint32_t dwId, uint32_t dwDeviceType)
 Check whether the listed device can be opened. More...
 
uint32_t LstDevGetProductId (uint32_t dwIdKind, uint32_t dwId)
 Get the product id of the listed device. More...
 
uint32_t LstDevGetName (uint32_t dwIdKind, uint32_t dwId, char *pBuffer, uint32_t dwBufferLength)
 Get the full name of the listed device. More...
 
uint32_t LstDevGetNameShort (uint32_t dwIdKind, uint32_t dwId, char *pBuffer, uint32_t dwBufferLength)
 Get the short name of the listed device. More...
 
uint32_t LstDevGetNameShortest (uint32_t dwIdKind, uint32_t dwId, char *pBuffer, uint32_t dwBufferLength)
 Get the short name of the listed device wihout model postfix. More...
 
TpVersion_t LstDevGetDriverVersion (uint32_t dwIdKind, uint32_t dwId)
 Get the version number of the driver currently used by the listed device. More...
 
TpVersion_t LstDevGetRecommendedDriverVersion (uint32_t dwIdKind, uint32_t dwId)
 Get the version number of the recommended driver for the listed device. More...
 
TpVersion_t LstDevGetFirmwareVersion (uint32_t dwIdKind, uint32_t dwId)
 Get the version number of the firmware currently used by the listed device. More...
 
TpDate_t LstDevGetCalibrationDate (uint32_t dwIdKind, uint32_t dwId)
 Get the calibration date of the listed device. More...
 
uint32_t LstDevGetSerialNumber (uint32_t dwIdKind, uint32_t dwId)
 Get the serial number of the listed device. More...
 
uint32_t LstDevGetTypes (uint32_t dwIdKind, uint32_t dwId)
 Get the device types of the listed device. More...
 
uint32_t LstDevGetContainedSerialNumbers (uint32_t dwIdKind, uint32_t dwId, uint32_t *pBuffer, uint32_t dwBufferLength)
 Get the serial numbers of the individual devices contained in a combined device. More...
 
uint32_t LstCbDevGetProductId (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the product id of a device contained in a combined device. More...
 
uint32_t LstCbDevGetName (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength)
 Get the full name of a device contained in a combined device. More...
 
uint32_t LstCbDevGetNameShort (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength)
 Get the short name of a device contained in a combined device. More...
 
uint32_t LstCbDevGetNameShortest (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber, char *pBuffer, uint32_t dwBufferLength)
 Get the short name without model postfix of a device contained in a combined device. More...
 
TpVersion_t LstCbDevGetDriverVersion (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the driver version of a device contained in a combined device. More...
 
TpVersion_t LstCbDevGetFirmwareVersion (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the firmware version of a device contained in a combined device. More...
 
TpDate_t LstCbDevGetCalibrationDate (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the calibration date of a device contained in a combined device. More...
 
uint16_t LstCbScpGetChannelCount (uint32_t dwIdKind, uint32_t dwId, uint32_t dwContainedDeviceSerialNumber)
 Get the channel count of an oscilloscope contained in a combined oscilloscope. More...
 
void LstSetCallbackDeviceAdded (TpCallbackDeviceList_t pCallback, void *pData)
 Set a callback function which is called when a device is added to the device list. More...
 
void LstSetCallbackDeviceRemoved (TpCallbackDeviceList_t pCallback, void *pData)
 Set a callback function which is called when a device is removed from the device list. More...
 
void LstSetEventDeviceAdded (int fdEvent)
 Set an event file descriptor which is set when a device is added to the device list. More...
 
void LstSetEventDeviceRemoved (int fdEvent)
 Set an event file descriptor which is set when a device is removed from the device list. More...
 
void DevClose (TpDeviceHandle_t hDevice)
 Close a device. More...
 
bool8_t DevIsRemoved (TpDeviceHandle_t hDevice)
 Check whether a device is removed. More...
 
TpVersion_t DevGetDriverVersion (TpDeviceHandle_t hDevice)
 Get the version number of the driver used by the device. More...
 
TpVersion_t DevGetFirmwareVersion (TpDeviceHandle_t hDevice)
 Get the version number of the firmware used by the device. More...
 
TpDate_t DevGetCalibrationDate (TpDeviceHandle_t hDevice)
 Get the calibration date of the device. More...
 
uint32_t DevGetSerialNumber (TpDeviceHandle_t hDevice)
 Get the serial number of the device. More...
 
uint32_t DevGetProductId (TpDeviceHandle_t hDevice)
 Get the product id of the device. More...
 
uint32_t DevGetType (TpDeviceHandle_t hDevice)
 Get the device type. More...
 
uint32_t DevGetName (TpDeviceHandle_t hDevice, char *pBuffer, uint32_t dwBufferLength)
 Get the full name of the device. More...
 
uint32_t DevGetNameShort (TpDeviceHandle_t hDevice, char *pBuffer, uint32_t dwBufferLength)
 Get the short name of the device. More...
 
uint32_t DevGetNameShortest (TpDeviceHandle_t hDevice, char *pBuffer, uint32_t dwBufferLength)
 Get the short name of the device without model postfix. More...
 
void DevSetCallbackRemoved (TpDeviceHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the device is removed. More...
 
void DevSetEventRemoved (TpDeviceHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the device is removed. More...
 
uint16_t DevTrGetInputCount (TpDeviceHandle_t hDevice)
 Get the number of trigger inputs. More...
 
uint16_t DevTrGetInputIndexById (TpDeviceHandle_t hDevice, uint32_t dwId)
 Get the index of a trigger input identified by its ID. More...
 
bool8_t ScpTrInIsTriggered (TpDeviceHandle_t hDevice, uint16_t wInput)
 Check whether the trigger input caused a trigger. More...
 
bool8_t DevTrInGetEnabled (TpDeviceHandle_t hDevice, uint16_t wInput)
 Check whether a device trigger input is enabled. More...
 
bool8_t DevTrInSetEnabled (TpDeviceHandle_t hDevice, uint16_t wInput, bool8_t bEnable)
 To select a device trigger input as trigger source, set trigger input enabled. More...
 
uint64_t DevTrInGetKinds (TpDeviceHandle_t hDevice, uint16_t wInput)
 Get the supported trigger kinds for a specified device trigger input. More...
 
uint64_t DevTrInGetKind (TpDeviceHandle_t hDevice, uint16_t wInput)
 Get the currently selected trigger kind for a specified device trigger input. More...
 
uint64_t DevTrInSetKind (TpDeviceHandle_t hDevice, uint16_t wInput, uint64_t qwKind)
 Set the required trigger kind for a specified device trigger input. More...
 
bool8_t DevTrInIsAvailable (TpDeviceHandle_t hDevice, uint16_t wInput)
 Check whether a device trigger input is available. More...
 
uint32_t DevTrInGetId (TpDeviceHandle_t hDevice, uint16_t wInput)
 Get the id of a specified device trigger input. More...
 
uint32_t DevTrInGetName (TpDeviceHandle_t hDevice, uint16_t wInput, char *pBuffer, uint32_t dwBufferLength)
 Get the name of a specified device trigger input. More...
 
uint16_t DevTrGetOutputCount (TpDeviceHandle_t hDevice)
 Get the number of trigger outputs. More...
 
uint16_t DevTrGetOutputIndexById (TpDeviceHandle_t hDevice, uint32_t dwId)
 Get the index of trigger output identified by its ID. More...
 
bool8_t DevTrOutGetEnabled (TpDeviceHandle_t hDevice, uint16_t wOutput)
 Check whether a trigger output is enabled. More...
 
bool8_t DevTrOutSetEnabled (TpDeviceHandle_t hDevice, uint16_t wOutput, bool8_t bEnable)
 Set trigger output enable. More...
 
uint64_t DevTrOutGetEvents (TpDeviceHandle_t hDevice, uint16_t wOutput)
 Get the supported trigger output events for a specified device trigger output. More...
 
uint64_t DevTrOutGetEvent (TpDeviceHandle_t hDevice, uint16_t wOutput)
 Get the currently selected trigger output event for a specified device trigger output. More...
 
uint64_t DevTrOutSetEvent (TpDeviceHandle_t hDevice, uint16_t wOutput, uint64_t qwEvent)
 Set the trigger output event for a specified device trigger output. More...
 
uint32_t DevTrOutGetId (TpDeviceHandle_t hDevice, uint16_t wOutput)
 Get the id of a specified device trigger output. More...
 
uint32_t DevTrOutGetName (TpDeviceHandle_t hDevice, uint16_t wOutput, char *pBuffer, uint32_t dwBufferLength)
 Get the name of a specified device trigger output. More...
 
uint16_t ScpGetChannelCount (TpDeviceHandle_t hDevice)
 Get the number of channels. More...
 
bool8_t ScpChIsAvailable (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether the channel is available. More...
 
uint32_t ScpChGetConnectorType (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the channel connector type. More...
 
bool8_t ScpChIsDifferential (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether the channel has a differential input. More...
 
double ScpChGetImpedance (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the channel input impedance. More...
 
uint64_t ScpChGetCouplings (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the supported coupling kinds of a specified channel. More...
 
uint64_t ScpChGetCoupling (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the currently set coupling of a specified channel. More...
 
uint64_t ScpChSetCoupling (TpDeviceHandle_t hDevice, uint16_t wCh, uint64_t qwCoupling)
 Set the coupling of a specified channel. More...
 
bool8_t ScpChGetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether a specified channel is currently enabled. More...
 
bool8_t ScpChSetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh, bool8_t bEnable)
 Set channel enable. More...
 
double ScpChGetProbeGain (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the currently set channel probe gain for a specified channel. More...
 
double ScpChSetProbeGain (TpDeviceHandle_t hDevice, uint16_t wCh, double dProbeGain)
 Set the channel probe gain for a specified channel. More...
 
double ScpChGetProbeOffset (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the currently set channel probe offset for a specified channel. More...
 
double ScpChSetProbeOffset (TpDeviceHandle_t hDevice, uint16_t wCh, double dProbeOffset)
 Set the channel probe offset for a specified channel. More...
 
bool8_t ScpChGetAutoRanging (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether auto ranging is enabled for a specified channel. More...
 
bool8_t ScpChSetAutoRanging (TpDeviceHandle_t hDevice, uint16_t wCh, bool8_t bEnable)
 Set auto ranging for a specified channel. More...
 
uint32_t ScpChGetRanges (TpDeviceHandle_t hDevice, uint16_t wCh, double *pList, uint32_t dwLength)
 Get the supported input ranges for a specified channel, with the currently selected coupling. More...
 
double ScpChGetRange (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the currently selected input range for a specified channel. More...
 
double ScpChSetRange (TpDeviceHandle_t hDevice, uint16_t wCh, double dRange)
 Set the input range for a specified channel. More...
 
bool8_t ScpChHasTrigger (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether the specified channel has trigger support with the currently selected measure mode. More...
 
bool8_t ScpChTrIsAvailable (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether the channel trigger for the specified channel is available, with the current oscilloscope settings. More...
 
bool8_t ScpChTrIsTriggered (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether the channel trigger caused a trigger. More...
 
bool8_t ScpChTrGetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether channel trigger for a specified channel is enabled. More...
 
bool8_t ScpChTrSetEnabled (TpDeviceHandle_t hDevice, uint16_t wCh, bool8_t bEnable)
 To select a channel as trigger source, set channel trigger enable. More...
 
uint64_t ScpChTrGetKinds (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the supported channel trigger kinds for a specified channel with the currently selected measure mode. More...
 
uint64_t ScpChTrGetKind (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the currently selected channel trigger kind for a specified channel. More...
 
uint64_t ScpChTrSetKind (TpDeviceHandle_t hDevice, uint16_t wCh, uint64_t qwTriggerKind)
 Set the channel trigger kind for a specified channel. More...
 
uint32_t ScpChTrGetLevelCount (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the number of channel trigger levels for a specified channel with the currently selected trigger kind. More...
 
double ScpChTrGetLevel (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get the currently set channel trigger level value for a specified channel and trigger level. More...
 
double ScpChTrSetLevel (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dLevel)
 Set the channel trigger level value for a specified channel and trigger level. More...
 
uint32_t ScpChTrGetHysteresisCount (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the number of trigger hystereses for a specified channel with the currently selected trigger kind. More...
 
double ScpChTrGetHysteresis (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get the currently set channel trigger hysteresis value for a specified channel and trigger hysteresis. More...
 
double ScpChTrSetHysteresis (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dHysteresis)
 Set the channel trigger hysteresis value for a specified channel and trigger hysteresis. More...
 
uint32_t ScpChTrGetConditions (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the supported trigger conditions for a specified channel with the currently selected trigger kind. More...
 
uint32_t ScpChTrGetCondition (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the current selected trigger condition for a specified channel. More...
 
uint32_t ScpChTrSetCondition (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwCondition)
 Set the trigger condition for a specified channel. More...
 
uint32_t ScpChTrGetTimeCount (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the number of trigger times for the current trigger kind and trigger condition. More...
 
double ScpChTrGetTime (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex)
 Get the current trigger time value for a specified channel and trigger type. More...
 
double ScpChTrSetTime (TpDeviceHandle_t hDevice, uint16_t wCh, uint32_t dwIndex, double dTime)
 Set the required trigger time value for a specified channel and trigger type. More...
 
uint64_t ScpGetData (TpDeviceHandle_t hDevice, float **pBuffers, uint16_t wChannelCount, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get the measurement data for specified channels. More...
 
uint64_t ScpGetData1Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get the measurement data for the first channel. More...
 
uint64_t ScpGetData2Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, float *pBufferCh2, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get the measurement data for the first two channels. More...
 
uint64_t ScpGetData3Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, float *pBufferCh2, float *pBufferCh3, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get the measurement data for the first three channels. More...
 
uint64_t ScpGetData4Ch (TpDeviceHandle_t hDevice, float *pBufferCh1, float *pBufferCh2, float *pBufferCh3, float *pBufferCh4, uint64_t qwStartIndex, uint64_t qwSampleCount)
 Get the measurement data for the first four channels. More...
 
uint64_t ScpGetValidPreSampleCount (TpDeviceHandle_t hDevice)
 Get the number of valid pre samples in the measurement. More...
 
void ScpChGetDataValueRange (TpDeviceHandle_t hDevice, uint16_t wCh, double *pMin, double *pMax)
 Get the minimum and maximum values of the input range the current data was measured with. More...
 
double ScpChGetDataValueMin (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the minimum value of the input range the current data was measured with. More...
 
double ScpChGetDataValueMax (TpDeviceHandle_t hDevice, uint16_t wCh)
 Get the maximum value of the input range the current data was measured with. More...
 
void ScpSetCallbackDataReady (TpDeviceHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the oscilloscope has new measurement data ready. More...
 
void ScpSetCallbackDataOverflow (TpDeviceHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the oscilloscope streaming measurement caused an data overflow. More...
 
void ScpSetCallbackConnectionTestCompleted (TpDeviceHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the oscilloscope connection test is completed. More...
 
void ScpSetCallbackTriggered (TpDeviceHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the oscilloscope is triggered. More...
 
void ScpSetEventDataReady (TpDeviceHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the oscilloscope has new measurement data ready. More...
 
void ScpSetEventDataOverflow (TpDeviceHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the oscilloscope streaming measurement caused an data overflow. More...
 
void ScpSetEventConnectionTestCompleted (TpDeviceHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the oscilloscope connection test is completed. More...
 
void ScpSetEventTriggered (TpDeviceHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the oscilloscope is triggered. More...
 
bool8_t ScpStart (TpDeviceHandle_t hDevice)
 Start a single measurement. More...
 
bool8_t ScpStop (TpDeviceHandle_t hDevice)
 Stop a running measurement. More...
 
bool8_t ScpForceTrigger (TpDeviceHandle_t hDevice)
 Force a trigger. More...
 
uint32_t ScpGetMeasureModes (TpDeviceHandle_t hDevice)
 Get the supported measure modes for a specified oscilloscope. More...
 
uint32_t ScpGetMeasureMode (TpDeviceHandle_t hDevice)
 Get the current measure mode. More...
 
uint32_t ScpSetMeasureMode (TpDeviceHandle_t hDevice, uint32_t dwMeasureMode)
 Set the measure mode. More...
 
bool8_t ScpIsRunning (TpDeviceHandle_t hDevice)
 Check whether the oscilloscope is currently measuring. More...
 
bool8_t ScpIsTriggered (TpDeviceHandle_t hDevice)
 Check whether the oscilloscope has triggered. More...
 
bool8_t ScpIsTimeOutTriggered (TpDeviceHandle_t hDevice)
 Check whether the trigger was caused by the trigger time out. More...
 
bool8_t ScpIsForceTriggered (TpDeviceHandle_t hDevice)
 Check whether the trigger was caused by ScpForceTrigger. More...
 
bool8_t ScpIsDataReady (TpDeviceHandle_t hDevice)
 Check whether new, unread measured data is available. More...
 
bool8_t ScpIsDataOverflow (TpDeviceHandle_t hDevice)
 Check whether a data overflow has occurred. More...
 
uint32_t ScpGetAutoResolutionModes (TpDeviceHandle_t hDevice)
 Get the supported auto resolution modes of the specified oscilloscope. More...
 
uint32_t ScpGetAutoResolutionMode (TpDeviceHandle_t hDevice)
 Get the current auto resolution mode of the specified oscilloscope. More...
 
uint32_t ScpSetAutoResolutionMode (TpDeviceHandle_t hDevice, uint32_t dwAutoResolutionMode)
 Set the auto resolution mode of the specified oscilloscope. More...
 
uint32_t ScpGetResolutions (TpDeviceHandle_t hDevice, uint8_t *pList, uint32_t dwLength)
 Get an array with the supported resolutions of the specified oscilloscope. More...
 
uint8_t ScpGetResolution (TpDeviceHandle_t hDevice)
 Get the current resolution of the specified oscilloscope. More...
 
uint8_t ScpSetResolution (TpDeviceHandle_t hDevice, uint8_t byResolution)
 Set the resolution of the specified oscilloscope. More...
 
bool8_t ScpIsResolutionEnhanced (TpDeviceHandle_t hDevice)
 Check whether the currently selected resolution is enhanced or a native resolution of the hardware. More...
 
uint32_t ScpGetClockSources (TpDeviceHandle_t hDevice)
 Get the supported clock sources of the specified oscilloscope. More...
 
uint32_t ScpGetClockSource (TpDeviceHandle_t hDevice)
 Get the currently selected clock source of the specified oscilloscope. More...
 
uint32_t ScpSetClockSource (TpDeviceHandle_t hDevice, uint32_t dwClockSource)
 Set the clock source of the specified oscilloscope. More...
 
uint32_t ScpGetClockOutputs (TpDeviceHandle_t hDevice)
 Get the supported clock outputs of the specified oscilloscope. More...
 
uint32_t ScpGetClockOutput (TpDeviceHandle_t hDevice)
 Get the currently selected clock output of the specified oscilloscope. More...
 
uint32_t ScpSetClockOutput (TpDeviceHandle_t hDevice, uint32_t dwClockOutput)
 Set the clock output of the specified oscilloscope. More...
 
double ScpGetSampleFrequencyMax (TpDeviceHandle_t hDevice)
 Get the maximum supported sample frequency of a specified oscilloscope. More...
 
double ScpGetSampleFrequency (TpDeviceHandle_t hDevice)
 Get the currently selected sample frequency of a specified oscilloscope. More...
 
double ScpSetSampleFrequency (TpDeviceHandle_t hDevice, double dSampleFrequency)
 Set the sample frequency of a specified oscilloscope. More...
 
uint64_t ScpGetRecordLengthMax (TpDeviceHandle_t hDevice)
 Get the maximum supported record length of a specified oscilloscope. More...
 
uint64_t ScpGetRecordLength (TpDeviceHandle_t hDevice)
 Get the currently selected record length of a specified oscilloscope. More...
 
uint64_t ScpSetRecordLength (TpDeviceHandle_t hDevice, uint64_t qwRecordLength)
 Set the record length of a specified oscilloscope. More...
 
double ScpGetPreSampleRatio (TpDeviceHandle_t hDevice)
 Get the current pre sample ratio of a specified oscilloscope. More...
 
double ScpSetPreSampleRatio (TpDeviceHandle_t hDevice, double dPreSampleRatio)
 Set the pre sample ratio of a specified oscilloscope. More...
 
uint32_t ScpGetSegmentCountMax (TpDeviceHandle_t hDevice)
 Get the maximum supported number of segments of a specified oscilloscope. More...
 
uint32_t ScpGetSegmentCount (TpDeviceHandle_t hDevice)
 Get the currently selected number of segments of a specified oscilloscope. More...
 
uint32_t ScpSetSegmentCount (TpDeviceHandle_t hDevice, uint32_t dwSegmentCount)
 Set the number of segments of a specified oscilloscope. More...
 
bool8_t ScpHasTrigger (TpDeviceHandle_t hDevice)
 Check whether the oscilloscope has trigger support with the currently selected measure mode. More...
 
double ScpGetTriggerTimeOut (TpDeviceHandle_t hDevice)
 Get the currently selected trigger time out in seconds, for a specified oscilloscope. More...
 
double ScpSetTriggerTimeOut (TpDeviceHandle_t hDevice, double dTimeOut)
 Set the trigger time out in seconds, for a specified oscilloscope. More...
 
bool8_t ScpHasTriggerDelay (TpDeviceHandle_t hDevice)
 Check whether the oscilloscope has trigger delay support with the currently selected measure mode. More...
 
double ScpGetTriggerDelayMax (TpDeviceHandle_t hDevice)
 Get the maximum trigger delay in seconds, for the currently selected measure mode and sample frequency. More...
 
double ScpGetTriggerDelay (TpDeviceHandle_t hDevice)
 Get the currently selected trigger delay in seconds, for a specified oscilloscope. More...
 
double ScpSetTriggerDelay (TpDeviceHandle_t hDevice, double dDelay)
 Set trigger delay in seconds, for a specified oscilloscope. More...
 
bool8_t ScpHasTriggerHoldOff (TpDeviceHandle_t hDevice)
 Check whether the oscilloscope has trigger hold off support with the currently selected measure mode. More...
 
uint64_t ScpGetTriggerHoldOffCountMax (TpDeviceHandle_t hDevice)
 Get the maximum trigger hold off count in samples, for a specified oscilloscope. More...
 
uint64_t ScpGetTriggerHoldOffCount (TpDeviceHandle_t hDevice)
 Get the trigger hold off count in samples, for a specified oscilloscope. More...
 
uint64_t ScpSetTriggerHoldOffCount (TpDeviceHandle_t hDevice, uint64_t qwTriggerHoldOffCount)
 Set the trigger hold off count in samples, for a specified oscilloscope. More...
 
bool8_t ScpHasConnectionTest (TpDeviceHandle_t hDevice)
 Check whether the specified oscilloscope supports connection testing. More...
 
bool8_t ScpChHasConnectionTest (TpDeviceHandle_t hDevice, uint16_t wCh)
 Check whether a specified channel of a specified oscilloscope supports connection testing. More...
 
bool8_t ScpStartConnectionTest (TpDeviceHandle_t hDevice)
 Perform a connection test on all enabled channels of a specified oscilloscope. More...
 
bool8_t ScpIsConnectionTestCompleted (TpDeviceHandle_t hDevice)
 Check whether the connection test on a specified oscilloscope is completed. More...
 
uint16_t ScpGetConnectionTestData (TpDeviceHandle_t hDevice, LibTiePieTriState_t *pBuffer, uint16_t wChannelCount)
 Get the connection test result data for a specified oscilloscope. More...
 
uint32_t GenGetConnectorType (TpDeviceHandle_t hDevice)
 Get the output connector type for a specified generator. More...
 
bool8_t GenIsDifferential (TpDeviceHandle_t hDevice)
 Check whether the output of a specified generator is differential. More...
 
double GenGetImpedance (TpDeviceHandle_t hDevice)
 Get the output impedance of a specified generator. More...
 
uint8_t GenGetResolution (TpDeviceHandle_t hDevice)
 Get the DAC resolution of a specified generator. More...
 
double GenGetOutputValueMin (TpDeviceHandle_t hDevice)
 Get the minimum output value of a specified generator. More...
 
double GenGetOutputValueMax (TpDeviceHandle_t hDevice)
 Get the maximum output value of a specified generator. More...
 
bool8_t GenIsControllable (TpDeviceHandle_t hDevice)
 Check whether a specified generator can be controlled. More...
 
uint32_t GenGetStatus (TpDeviceHandle_t hDevice)
 Get the current signal generation status of a specified generator. More...
 
bool8_t GenGetOutputOn (TpDeviceHandle_t hDevice)
 Check whether the output of a specified generator is enabled. More...
 
bool8_t GenSetOutputOn (TpDeviceHandle_t hDevice, bool8_t bOutputOn)
 Enable or disable the output of a specified generator. More...
 
bool8_t GenGetOutputInvert (TpDeviceHandle_t hDevice)
 Check whether the output of a specified generator is inverted. More...
 
bool8_t GenSetOutputInvert (TpDeviceHandle_t hDevice, bool8_t bInvert)
 Enable or disable the output invert of a specified generator. More...
 
bool8_t GenStart (TpDeviceHandle_t hDevice)
 Start the signal generation of a specified generator. More...
 
bool8_t GenStop (TpDeviceHandle_t hDevice)
 Stop the signal generation of a specified generator. More...
 
uint32_t GenGetSignalTypes (TpDeviceHandle_t hDevice)
 Get the supported signal types of a specified generator. More...
 
uint32_t GenGetSignalType (TpDeviceHandle_t hDevice)
 Get the currently selected signal type of a specified generator. More...
 
uint32_t GenSetSignalType (TpDeviceHandle_t hDevice, uint32_t dwSignalType)
 Set the signal type of a specified generator. More...
 
double GenGetAmplitudeMin (TpDeviceHandle_t hDevice)
 Get the minimum signal amplitude for the current signal type of a specified generator. More...
 
double GenGetAmplitudeMax (TpDeviceHandle_t hDevice)
 Get the maximum signal amplitude for the current signal type of a specified generator. More...
 
double GenGetAmplitude (TpDeviceHandle_t hDevice)
 Get the currently set signal amplitude of a specified generator. More...
 
double GenSetAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
 Set the signal amplitude of a specified generator. More...
 
uint32_t GenGetAmplitudeRanges (TpDeviceHandle_t hDevice, double *pList, uint32_t dwLength)
 Get the supported amplitude ranges for a specified generator. More...
 
double GenGetAmplitudeRange (TpDeviceHandle_t hDevice)
 Get the currently set amplitude range for a specified generator. More...
 
double GenSetAmplitudeRange (TpDeviceHandle_t hDevice, double dRange)
 Set the amplitude range for a specified generator. More...
 
bool8_t GenGetAmplitudeAutoRanging (TpDeviceHandle_t hDevice)
 Get the amplitude auto ranging setting for a specified generator. More...
 
bool8_t GenSetAmplitudeAutoRanging (TpDeviceHandle_t hDevice, bool8_t bEnable)
 Set the amplitude auto ranging setting for a specified generator. More...
 
double GenGetOffsetMin (TpDeviceHandle_t hDevice)
 Get the minimum offset for the current signal type, of a specified generator. More...
 
double GenGetOffsetMax (TpDeviceHandle_t hDevice)
 Get the maximum offset for the current signal type, of a specified generator. More...
 
double GenGetOffset (TpDeviceHandle_t hDevice)
 Get the current signal offset of a specified generator. More...
 
double GenSetOffset (TpDeviceHandle_t hDevice, double dOffset)
 Set the signal offset of a specified generator. More...
 
uint32_t GenGetFrequencyModes (TpDeviceHandle_t hDevice)
 Get the supported generator frequency modes of a specified generator. More...
 
uint32_t GenGetFrequencyMode (TpDeviceHandle_t hDevice)
 Get the current generator frequency mode of a specified generator. More...
 
uint32_t GenSetFrequencyMode (TpDeviceHandle_t hDevice, uint32_t dwFrequencyMode)
 Set the generator frequency mode of a specified generator. More...
 
double GenGetFrequencyMin (TpDeviceHandle_t hDevice)
 Get the minimum signal/sample frequency with the current frequency mode, of a specified generator. More...
 
double GenGetFrequencyMax (TpDeviceHandle_t hDevice)
 Get the maximum signal/sample frequency with the current frequency mode and signal type, of a specified generator. More...
 
double GenGetFrequency (TpDeviceHandle_t hDevice)
 Get the current signal/sample frequency, of a specified generator. More...
 
double GenSetFrequency (TpDeviceHandle_t hDevice, double dFrequency)
 Set signal/sample frequency, of a specified generator. More...
 
double GenGetPhaseMin (TpDeviceHandle_t hDevice)
 Get the minimum signal phase of a specified generator. More...
 
double GenGetPhaseMax (TpDeviceHandle_t hDevice)
 Get the maximum signal phase of a specified generator. More...
 
double GenGetPhase (TpDeviceHandle_t hDevice)
 Get the current signal phase of a specified generator. More...
 
double GenSetPhase (TpDeviceHandle_t hDevice, double dPhase)
 Set the signal phase of a specified generator. More...
 
double GenGetSymmetryMin (TpDeviceHandle_t hDevice)
 Get the minimum signal symmetry of a specified generator. More...
 
double GenGetSymmetryMax (TpDeviceHandle_t hDevice)
 Get the maximum signal symmetry of a specified generator. More...
 
double GenGetSymmetry (TpDeviceHandle_t hDevice)
 Get the current signal symmetry of a specified generator. More...
 
double GenSetSymmetry (TpDeviceHandle_t hDevice, double dSymmetry)
 Set the signal symmetry of a specified generator. More...
 
double GenGetWidthMin (TpDeviceHandle_t hDevice)
 Get the minimum pulse width with the current signal frequency, of a specified generator. More...
 
double GenGetWidthMax (TpDeviceHandle_t hDevice)
 Get the maximum pulse width with the current signal frequency, of a specified generator. More...
 
double GenGetWidth (TpDeviceHandle_t hDevice)
 Get the current pulse width, of a specified generator. More...
 
double GenSetWidth (TpDeviceHandle_t hDevice, double dWidth)
 Set the pulse width, of a specified generator. More...
 
uint64_t GenGetDataLengthMin (TpDeviceHandle_t hDevice)
 Get the minimum length of the waveform buffer of a specified generator. More...
 
uint64_t GenGetDataLengthMax (TpDeviceHandle_t hDevice)
 Get the maximum length of the waveform buffer of a specified generator. More...
 
uint64_t GenGetDataLength (TpDeviceHandle_t hDevice)
 Get the length of the currently loaded waveform pattern of a specified generator. More...
 
void GenSetData (TpDeviceHandle_t hDevice, const float *pBuffer, uint64_t qwSampleCount)
 Load a waveform pattern into the waveform buffer of a specified generator. More...
 
uint64_t GenGetModes (TpDeviceHandle_t hDevice)
 Get the supported generator modes for the current signal type and frequency mode of a specified generator. More...
 
uint64_t GenGetModesNative (TpDeviceHandle_t hDevice)
 Get all supported generator modes of a specified generator, regardless of the signal type and frequency mode. More...
 
uint64_t GenGetMode (TpDeviceHandle_t hDevice)
 Get the current generator mode of a specified generator. More...
 
uint64_t GenSetMode (TpDeviceHandle_t hDevice, uint64_t qwGeneratorMode)
 Set the generator mode of a specified generator. More...
 
bool8_t GenIsBurstActive (TpDeviceHandle_t hDevice)
 Check whether a burst is active, of a specified generator. More...
 
uint64_t GenGetBurstCountMin (TpDeviceHandle_t hDevice)
 Get the minimum burst count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstCountMax (TpDeviceHandle_t hDevice)
 Get the maximum burst count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstCount (TpDeviceHandle_t hDevice)
 Get the current burst count for the current generator mode of a specified generator. More...
 
uint64_t GenSetBurstCount (TpDeviceHandle_t hDevice, uint64_t qwBurstCount)
 Set the burst count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSampleCountMin (TpDeviceHandle_t hDevice)
 Get the minimum burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSampleCountMax (TpDeviceHandle_t hDevice)
 Get the maximum burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSampleCount (TpDeviceHandle_t hDevice)
 Get the current burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenSetBurstSampleCount (TpDeviceHandle_t hDevice, uint64_t qwBurstSampleCount)
 Set the burst sample count for the current generator mode of a specified generator. More...
 
uint64_t GenGetBurstSegmentCountMin (TpDeviceHandle_t hDevice)
 Get the minimum burst segment count for the current settings of a specified generator. More...
 
uint64_t GenGetBurstSegmentCountMax (TpDeviceHandle_t hDevice)
 Get the maximum burst segment count for the current settings of a specified generator. More...
 
uint64_t GenGetBurstSegmentCount (TpDeviceHandle_t hDevice)
 Get the current burst segment count of a specified generator. More...
 
uint64_t GenSetBurstSegmentCount (TpDeviceHandle_t hDevice, uint64_t qwBurstSegmentCount)
 Set the burst segment count of a specified generator. More...
 
void GenSetCallbackBurstCompleted (TpDeviceHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the generator burst is completed. More...
 
void GenSetEventBurstCompleted (TpDeviceHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the generator burst is completed. More...
 
void GenSetCallbackControllableChanged (TpDeviceHandle_t hDevice, TpCallback_t pCallback, void *pData)
 Set a callback function which is called when the generator controllable property changes. More...
 
void GenSetEventControllableChanged (TpDeviceHandle_t hDevice, int fdEvent)
 Set an event file descriptor which is set when the generator controllable property changes. More...
 
bool8_t I2CIsInternalAddress (TpDeviceHandle_t hDevice, uint16_t wAddress)
 Check whether an address is used internally. More...
 
bool8_t I2CRead (TpDeviceHandle_t hDevice, uint16_t wAddress, void *pBuffer, uint32_t dwSize, bool8_t bStop)
 Read data from a specified address on the I2C bus, using a specified I2C host. More...
 
bool8_t I2CReadByte (TpDeviceHandle_t hDevice, uint16_t wAddress, uint8_t *pValue)
 Read one byte from a specified address on the I2C bus, using a specified I2C host. More...
 
bool8_t I2CReadWord (TpDeviceHandle_t hDevice, uint16_t wAddress, uint16_t *pValue)
 Read one word from a specified address on the I2C bus, using a specified I2C host. More...
 
bool8_t I2CWrite (TpDeviceHandle_t hDevice, uint16_t wAddress, const void *pBuffer, uint32_t dwSize, bool8_t bStop)
 Write data to a specified address on the I2C bus, using a specified I2C host. More...
 
bool8_t I2CWriteByte (TpDeviceHandle_t hDevice, uint16_t wAddress, uint8_t byValue)
 Write one byte to a specified address on the I2C bus, using a specified I2C host. More...
 
bool8_t I2CWriteByteByte (TpDeviceHandle_t hDevice, uint16_t wAddress, uint8_t byValue1, uint8_t byValue2)
 Write two bytes to a specified address on the I2C bus, using a specified I2C host. More...
 
bool8_t I2CWriteByteWord (TpDeviceHandle_t hDevice, uint16_t wAddress, uint8_t byValue1, uint16_t wValue2)
 Write one byte and one word to a specified address on the I2C bus, using a specified I2C host. More...
 
bool8_t I2CWriteWord (TpDeviceHandle_t hDevice, uint16_t wAddress, uint16_t wValue)
 Write one word to a specified address on the I2C bus, using a specified I2C host. More...
 
double I2CGetSpeedMax (TpDeviceHandle_t hDevice)
 Get the maximum clock speed on the I2C bus controlled by a specified I2C host. More...
 
double I2CGetSpeed (TpDeviceHandle_t hDevice)
 Get the current clock speed on the I2C bus controlled by a specified I2C host. More...
 
double I2CSetSpeed (TpDeviceHandle_t hDevice, double dSpeed)
 Set the clock speed on the I2C bus controlled by a specified I2C host. More...
 
LibTiePiePointerArray_t HlpPointerArrayNew (uint32_t dwLength)
 Create a new pointer array. More...
 
void HlpPointerArraySet (LibTiePiePointerArray_t pArray, uint32_t dwIndex, void *pPointer)
 Set a pointer at a specified index in a specified pointer array. More...
 
void HlpPointerArrayDelete (LibTiePiePointerArray_t pArray)
 Delete an existing pointer array. More...
 

Detailed Description

Header for libtiepie.

Definition in file libtiepie.h.

Macro Definition Documentation

#define LIBTIEPIE_LINUX

Definition at line 51 of file libtiepie.h.

#define LIBTIEPIE_VERSION_MAJOR   0

Definition at line 59 of file libtiepie.h.

#define LIBTIEPIE_VERSION_MINOR   5

Definition at line 60 of file libtiepie.h.

#define LIBTIEPIE_VERSION_RELEASE   0

Definition at line 61 of file libtiepie.h.

#define LIBTIEPIE_VERSION_NUMBER   "0.5.0"

Definition at line 62 of file libtiepie.h.

#define LIBTIEPIE_VERSION   "0.5.0"

Definition at line 63 of file libtiepie.h.

#define LIBTIEPIE_REVISION   6687

Definition at line 64 of file libtiepie.h.