LibTiePie  0.6.1
Library for interfacing TiePie engineering instruments

Description

Functions to control the trigger settings of an input channel.

Depending on the settings of the oscilloscope, a channel trigger may not be supported or temporarily unavailable. In streaming measure mode, channel trigger is not supported, use ScpChHasTrigger() to check if triggering is supported in the currently set measure mode. When channel trigger is supported, it can be temporarily unavailable due to other settings like e.g. sample frequency, resolution and/or the number of enabled channels, use ScpChTrIsAvailable() to check if the trigger is available.

To use a channel as trigger source, the channel must be enabled.

Modules

 Enabled
 The enabled state of a channel trigger determines whether a channel is selected as trigger source.
 
 Kind
 The channel trigger kind property is used to control how the channel trigger responds to the channel input signal.
 
 Level mode
 Functions for controlling the trigger level mode.
 
 Level
 The channel trigger level property is used to control at which level(s) the channel trigger responds to the channel input signal.
 
 Hysteresis
 The channel trigger hysteresis property is used to control the sensitivity of the trigger system.
 
 Condition
 Some trigger kinds require an additional condition to indicate how the channel trigger must respond to the input signal.
 
 Time
 The Time property determines how long a specific condition must last for the channel trigger to respond.
 

Functions

bool8_t ScpChHasTrigger (LibTiePieHandle_t hDevice, uint16_t wCh)
 Check whether the specified channel has trigger support with the currently selected measure mode. More...
 
bool8_t ScpChTrIsAvailable (LibTiePieHandle_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 (LibTiePieHandle_t hDevice, uint16_t wCh)
 Check whether the channel trigger caused a trigger. More...
 

Function Documentation

bool8_t ScpChHasTrigger ( LibTiePieHandle_t  hDevice,
uint16_t  wCh 
)

Check whether the specified channel has trigger support with the currently selected measure mode.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
BOOL8_TRUE if the channel has trigger support, BOOL8_FALSE otherwise.
Status values
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.4.2
bool8_t ScpChTrIsAvailable ( LibTiePieHandle_t  hDevice,
uint16_t  wCh 
)

Check whether the channel trigger for the specified channel is available, with the current oscilloscope settings.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
BOOL8_TRUE if available, BOOL8_FALSE otherwise.
Status values
INVALID_CHANNEL The requested channel number is invalid.
INVALID_HANDLE The handle is not a valid oscilloscope handle.
OBJECT_GONE The object indicated by the handle is no longer available.
LIBRARY_NOT_INITIALIZEDThe library is not initialized, see LibInit().
SUCCESS The function executed successfully.
Since
0.4.4
bool8_t ScpChTrIsTriggered ( LibTiePieHandle_t  hDevice,
uint16_t  wCh 
)

Check whether the channel trigger caused a trigger.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]wChThe channel number identifying the channel, 0 to ScpGetChannelCount() - 1.
Returns
BOOL8_TRUE if the channel trigger caused a trigger, BOOL8_FALSE otherwise.
See also
ScpIsTriggered
ScpIsTimeOutTriggered
ScpIsForceTriggered
ScpTrInIsTriggered
Since
0.5