Description

The channel trigger hysteresis property is used to control the sensitivity of the trigger system.

The number of available trigger hystereses depends on the currently set trigger kind. Use ScpChTrGetHysteresisCount() to determine the number of trigger hystereses for the currently set trigger kind.

The trigger hysteresis is set as a floating point value between 0 and 1, corresponding to a percentage of the full scale input range:

0.0 (0%) equals 0 Volt (no hysteresis)
0.5 (50%) equals full scale
1.0 (100%) equals 2 * full scale.

By default the trigger hysteresis is set to 0.05 (5%) of the full-scale range.

Functions
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...

Function Documentation

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.

Parameters

hDevice	A device handle identifying the oscilloscope.
wCh	The channel number identifying the channel, `0` to `ScpGetChannelCount() - 1`.

Returns: The number of available trigger hystereses for the currently set trigger kind.

Status values

NOT_SUPPORTED	The indicated channel does not support trigger with the current settings.
INVALID_CHANNEL	The requested channel number is not valid.
INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
SUCCESS	The function executed successfully.

See also: ScpChTrGetKind; ScpChTrGetHysteresis; ScpChTrSetHysteresis

Since: 0.4.1

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.

Parameters

hDevice	A device handle identifying the oscilloscope.
wCh	The channel number identifying the channel, `0` to `ScpGetChannelCount() - 1`.
dwIndex	The trigger hysteresis index, `0` to `ScpChTrGetHysteresisCount() - 1`.

Returns: The currently set trigger hysteresis value, a number between 0 and 1.

Status values

NOT_SUPPORTED	The indicated channel does not support trigger (hysteresis) with the current settings.
INVALID_INDEX	The trigger hysteresis index is invalid.
INVALID_CHANNEL	The requested channel number is not valid.
INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
SUCCESS	The function executed successfully.

See also: ScpChTrGetHysteresisCount; ScpChTrSetHysteresis

Since: 0.4.1

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.

Parameters

hDevice	A device handle identifying the oscilloscope.
wCh	The channel number identifying the channel, `0` to `ScpGetChannelCount() - 1`.
dwIndex	The trigger hysteresis index, `0` to `ScpChTrGetHysteresisCount() - 1`.
dHysteresis	The required trigger hysteresis value, a number between `0` and `1`.

Returns: The actually set trigger hysteresis value, a number between 0 and 1.

Status values

VALUE_CLIPPED	The requested trigger hysteresis is outside the valid range and clipped to the closest limit.
NOT_SUPPORTED	The indicated channel does not support trigger (hysteresis) with the current settings.
INVALID_INDEX	The trigger hysteresis index is invalid.
INVALID_CHANNEL	The requested channel number is not valid.
INVALID_HANDLE	The handle is not a valid oscilloscope handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
SUCCESS	The function executed successfully.

See also: ScpChTrGetHysteresisCount; ScpChTrGetHysteresis

Since: 0.4.1

Description

Functions

Function Documentation