libtiepie  0.3.0
 All Files Functions Typedefs Groups
Control

Functions

bool8_t GenIsControllable (TpDeviceHandle_t hDevice)
bool8_t GenGetOutputOn (TpDeviceHandle_t hDevice)
bool8_t GenSetOutputOn (TpDeviceHandle_t hDevice, bool8_t bOutputOn)
void GenStart (TpDeviceHandle_t hDevice)
void GenStop (TpDeviceHandle_t hDevice)
bool8_t GenIsBurstActive (TpDeviceHandle_t hDevice)
uint64_t GenGetBurstCount (TpDeviceHandle_t hDevice)
uint64_t GenGetBurstCountMax (TpDeviceHandle_t hDevice)
uint64_t GenSetBurstCount (TpDeviceHandle_t hDevice, uint64_t qwBurstCount)
uint32_t GenGetModes (TpDeviceHandle_t hDevice)
uint32_t GenGetModesEx (TpDeviceHandle_t hDevice, uint32_t dwSignalType)
uint32_t GenGetMode (TpDeviceHandle_t hDevice)
uint32_t GenSetMode (TpDeviceHandle_t hDevice, uint32_t dwMode)
uint32_t GenGetSignalTypes (TpDeviceHandle_t hDevice)
uint32_t GenGetSignalType (TpDeviceHandle_t hDevice)
uint32_t GenSetSignalType (TpDeviceHandle_t hDevice, uint32_t dwSignalType)
double GenGetAmplitudeMax (TpDeviceHandle_t hDevice)
double GenGetAmplitudeMin (TpDeviceHandle_t hDevice)
double GenGetAmplitude (TpDeviceHandle_t hDevice)
double GenSetAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
double GenVerifyAmplitude (TpDeviceHandle_t hDevice, double dAmplitude)
void GenGetFrequencyMinMax (TpDeviceHandle_t hDevice, uint32_t dwMode, double *pMin, double *pMax)
double GenGetFrequencyMin (TpDeviceHandle_t hDevice)
double GenGetFrequencyMax (TpDeviceHandle_t hDevice)
double GenGetFrequency (TpDeviceHandle_t hDevice)
double GenSetFrequency (TpDeviceHandle_t hDevice, double dFrequency)
double GenVerifyFrequency (TpDeviceHandle_t hDevice, double dFrequency)
double GenVerifyFrequencyEx (TpDeviceHandle_t hDevice, double dFrequency, uint32_t dwMode)
double GenGetOffsetMin (TpDeviceHandle_t hDevice)
double GenGetOffsetMax (TpDeviceHandle_t hDevice)
double GenGetOffset (TpDeviceHandle_t hDevice)
double GenSetOffset (TpDeviceHandle_t hDevice, double dOffset)
double GenVerifyOffset (TpDeviceHandle_t hDevice, double dOffset)
double GenGetPhase (TpDeviceHandle_t hDevice)
double GenSetPhase (TpDeviceHandle_t hDevice, double dPhase)
double GenVerifyPhase (TpDeviceHandle_t hDevice, double dPhase)
double GenGetSymmetry (TpDeviceHandle_t hDevice)
double GenSetSymmetry (TpDeviceHandle_t hDevice, double dSymmetry)
double GenVerifySymmetry (TpDeviceHandle_t hDevice, double dSymmetry)

Detailed Description


Function Documentation

double GenGetAmplitude ( TpDeviceHandle_t  hDevice)

Get current signal amplitude

Parameters:
hDevicea device handle
Returns:
generator amplitude
double GenGetAmplitudeMax ( TpDeviceHandle_t  hDevice)

Get maximum signal amplitude

Parameters:
hDevicea device handle
Returns:
maximum generator amplitude
double GenGetAmplitudeMin ( TpDeviceHandle_t  hDevice)

Get minimum signal amplitude

Parameters:
hDevicea device handle
Returns:
minimum generator amplitude
uint64_t GenGetBurstCount ( TpDeviceHandle_t  hDevice)
Parameters:
hDevicea device handle
Returns:
uint64_t GenGetBurstCountMax ( TpDeviceHandle_t  hDevice)
Parameters:
hDevice
Returns:
double GenGetFrequency ( TpDeviceHandle_t  hDevice)

Get current signal/sample frequency

Parameters:
hDevicea device handle
Returns:
current signal/sample frequency
double GenGetFrequencyMax ( TpDeviceHandle_t  hDevice)

Get maximum signal/sample frequency

Parameters:
hDevicea device handle
Returns:
minimum signal/sample frequency
double GenGetFrequencyMin ( TpDeviceHandle_t  hDevice)

Get minimum signal/sample frequency

Parameters:
hDevicea device handle
Returns:
minimum signal/sample frequency
void GenGetFrequencyMinMax ( TpDeviceHandle_t  hDevice,
uint32_t  dwMode,
double *  pMin,
double *  pMax 
)
Parameters:
hDevice
dwMode
pMin
pMax
uint32_t GenGetMode ( TpDeviceHandle_t  hDevice)

Get generator mode

See also:
Generator modes
Parameters:
hDevicea device handle
Returns:
current generator mode, a FM_* value
uint32_t GenGetModes ( TpDeviceHandle_t  hDevice)

Get generator modes

See also:
Generator modes
Parameters:
hDevicea device handle
Returns:
available generator modes, a set of FM_* values
uint32_t GenGetModesEx ( TpDeviceHandle_t  hDevice,
uint32_t  dwSignalType 
)

Get generator modes

See also:
Generator modes
Parameters:
hDevicea device handle
dwSignalTypea ST_* signal type
Returns:
available generator modes of signal type, a set of FM_* values
double GenGetOffset ( TpDeviceHandle_t  hDevice)

Get current signal offset

Parameters:
hDevicea device handle
Returns:
current generator offset in Volts
double GenGetOffsetMax ( TpDeviceHandle_t  hDevice)

Get maximum signal offset

Parameters:
hDevicea device handle
Returns:
maximum generator offset in Volts
double GenGetOffsetMin ( TpDeviceHandle_t  hDevice)

Get minimum signal offset

Parameters:
hDevicea device handle
Returns:
minimum generator offset in Volts
bool8_t GenGetOutputOn ( TpDeviceHandle_t  hDevice)

Check if generator output is on

Parameters:
hDevicea device handle
Returns:
1 if output is on, 0 if output is off.
double GenGetPhase ( TpDeviceHandle_t  hDevice)
Parameters:
hDevicea device handle
Returns:
uint32_t GenGetSignalType ( TpDeviceHandle_t  hDevice)

Get the currently selected signal type.

See also:
Signal types
Parameters:
hDevicea device handle
Returns:
the currently selected signal type, a ST_* value
uint32_t GenGetSignalTypes ( TpDeviceHandle_t  hDevice)

Get available signal types.

See also:
Signal types
Parameters:
hDevicea device handle
Returns:
available signal types, set of ST_* values
double GenGetSymmetry ( TpDeviceHandle_t  hDevice)

Get current signal symmetry

Parameters:
hDevicea device handle
Returns:
current signal symmetry 0...1
bool8_t GenIsBurstActive ( TpDeviceHandle_t  hDevice)

Check if burst is active

Parameters:
hDevice
Returns:
1 if active 0 otherwise
bool8_t GenIsControllable ( TpDeviceHandle_t  hDevice)
Parameters:
hDevicea device handle
Returns:
1 if controllable, 0 otherwise.
double GenSetAmplitude ( TpDeviceHandle_t  hDevice,
double  dAmplitude 
)

Set signal amplitude

Parameters:
hDevicea device handle
dAmplitudegenerator amplitude
Returns:
generator amplitude
uint64_t GenSetBurstCount ( TpDeviceHandle_t  hDevice,
uint64_t  qwBurstCount 
)
Parameters:
hDevice
qwBurstCount
Returns:
double GenSetFrequency ( TpDeviceHandle_t  hDevice,
double  dFrequency 
)

Set signal/sample frequency

Parameters:
hDevicea device handle
dFrequencysignal/sample frequency
Returns:
current signal/sample frequency
uint32_t GenSetMode ( TpDeviceHandle_t  hDevice,
uint32_t  dwMode 
)

Set generator mode

See also:
Generator modes
Parameters:
hDevicea device handle
dwModegenerator mode, a FM_* value
Returns:
current generator mode, a FM_* value
double GenSetOffset ( TpDeviceHandle_t  hDevice,
double  dOffset 
)

Set signal offset

Parameters:
hDevicea device handle
dOffsetgenerator offset in Volts
Returns:
current generator offset in Volts
bool8_t GenSetOutputOn ( TpDeviceHandle_t  hDevice,
bool8_t  bOutputOn 
)

Enable or disable generator output

Parameters:
hDevicea device handle
bOutputOn?
Returns:
1 if output is on, 0 if output is off.
double GenSetPhase ( TpDeviceHandle_t  hDevice,
double  dPhase 
)
Parameters:
hDevicea device handle
dPhase
Returns:
uint32_t GenSetSignalType ( TpDeviceHandle_t  hDevice,
uint32_t  dwSignalType 
)

Sets the signal type of the generator.

See also:
Signal types
Parameters:
hDevicea device handle
dwSignalTypesignal type, a ST_* value
Returns:
the currently selected signal type, a ST_* value
double GenSetSymmetry ( TpDeviceHandle_t  hDevice,
double  dSymmetry 
)

Set signal symmetry

Parameters:
hDevicea device handle
dSymmetrysignal symmetry 0...1
Returns:
current signal symmetry 0...1
void GenStart ( TpDeviceHandle_t  hDevice)

Start generator

Parameters:
hDevicea device handle
void GenStop ( TpDeviceHandle_t  hDevice)

Stop generator

Parameters:
hDevicea device handle
double GenVerifyAmplitude ( TpDeviceHandle_t  hDevice,
double  dAmplitude 
)
Parameters:
hDevice
dAmplitude
Returns:
double GenVerifyFrequency ( TpDeviceHandle_t  hDevice,
double  dFrequency 
)
Parameters:
hDevice
dFrequency
Returns:
double GenVerifyFrequencyEx ( TpDeviceHandle_t  hDevice,
double  dFrequency,
uint32_t  dwMode 
)
Parameters:
hDevice
dFrequency
dwMode
Returns:
double GenVerifyOffset ( TpDeviceHandle_t  hDevice,
double  dOffset 
)
Parameters:
hDevice
dOffset
Returns:
double GenVerifyPhase ( TpDeviceHandle_t  hDevice,
double  dPhase 
)
Parameters:
hDevice
dPhase
Returns:
double GenVerifySymmetry ( TpDeviceHandle_t  hDevice,
double  dSymmetry 
)
Parameters:
hDevice
dSymmetry
Returns: