Description

Functions to control the probe settings of an oscilloscope channel.

Probes connected to an input channel usually attenuate the input signal. Specialized probes or signal converters can also amplify the input signal and/or apply an offset to it. Probe gain and offset settings are available to compensate the measured values for the gain and offset applied by the probe or converter. The channel will then give the original signal values.

When e.g. a X10 attenuating oscilloscope probe is connected, the channel will measure a 10 times smaller value of the input signal. By setting the probe gain to 10, the measured values will be multiplied by 10 to compensate.

By default probe gain is set to 1x and probe offset to 0.

Functions
double	ScpChGetProbeGain (LibTiePieHandle_t hDevice, uint16_t wCh)
	Get the currently set channel probe gain for a specified channel. More...

double	ScpChSetProbeGain (LibTiePieHandle_t hDevice, uint16_t wCh, double dProbeGain)
	Set the channel probe gain for a specified channel. More...

double	ScpChGetProbeOffset (LibTiePieHandle_t hDevice, uint16_t wCh)
	Get the currently set channel probe offset for a specified channel. More...

double	ScpChSetProbeOffset (LibTiePieHandle_t hDevice, uint16_t wCh, double dProbeOffset)
	Set the channel probe offset for a specified channel. More...

Function Documentation

double ScpChGetProbeGain	(	LibTiePieHandle_t	hDevice,
		uint16_t	wCh
	)

Get the currently set channel probe gain for a specified channel.

Parameters

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

Returns: The currently set probe gain.

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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpChSetProbeGain; ScpChGetDataValueRange; ScpChGetDataValueMin; ScpChGetDataValueMax

Since: 0.4.0

double ScpChSetProbeGain	(	LibTiePieHandle_t	hDevice,
		uint16_t	wCh,
		double	dProbeGain
	)

Set the channel probe gain for a specified channel.

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	wCh	The channel number identifying the channel, `0` to `ScpGetChannelCount() - 1`.
[in]	dProbeGain	The required probe gain, `-1e6 <=` gain `<= 1e6, != 0`.

Returns: The actually set probe gain.

Status values

INVALID_VALUE	The requested probe gain value is invalid.
VALUE_CLIPPED	The requested probe gain value is outside the valid range and clipped to the closest limit.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpChGetProbeGain; ScpChGetDataValueRange; ScpChGetDataValueMin; ScpChGetDataValueMax

Since: 0.4.0

double ScpChGetProbeOffset	(	LibTiePieHandle_t	hDevice,
		uint16_t	wCh
	)

Get the currently set channel probe offset for a specified channel.

The probe offset value is in Volt, Ampere or Ohm, depending on the input coupling

Parameters

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

Returns: The currently set probe offset.

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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpChSetProbeOffset; ScpChGetDataValueRange; ScpChGetDataValueMin; ScpChGetDataValueMax

Since: 0.4.4

double ScpChSetProbeOffset	(	LibTiePieHandle_t	hDevice,
		uint16_t	wCh,
		double	dProbeOffset
	)

Set the channel probe offset for a specified channel.

The probe offset value is in Volt, Ampere or Ohm, depending on the input coupling

Parameters

[in]	hDevice	A device handle identifying the oscilloscope.
[in]	wCh	The channel number identifying the channel, `0` to `ScpGetChannelCount() - 1`.
[in]	dProbeOffset	The required probe offset, `-1e6 <=` offset `<= 1e6`.

Returns: The actually set probe offset.

Status values

VALUE_CLIPPED	The requested probe offset value is outside the valid range and clipped to the closest limit.
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_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

See also: ScpChGetProbeOffset; ScpChGetDataValueRange; ScpChGetDataValueMin; ScpChGetDataValueMax

Since: 0.4.4