LibTiePie  0.9.8
Library for interfacing TiePie engineering instruments
Auto resolution mode

Description

Functions to control the auto resolution mode.

The resolution can be set manually, but can also be set automatically, based on the selected sample frequency. Use ScpGetAutoResolutionModes() to determine the available auto resolution modes. Possible auto resolution modes are:

When auto resolution mode is set to AR_DISABLED, the selected resolution will determine the maximum available sample frequency of the oscilloscope. When auto resolution mode is enabled, the selected sample frequency will determine the resolution of the oscilloscope.

Changing thesample frequency may change the resolution if auto resolution mode is AR_NATIVEONLY or AR_ALL.

Manually setting a resolution will set auto resolution mode to AR_DISABLED.

By default the auto resolution mode is set to AR_DISABLED for the Handyprobe HP3 and to AR_NATIVEONLY for all other supported instruments.

Functions

uint32_t ScpGetAutoResolutionModes (LibTiePieHandle_t hDevice)
 Get the supported auto resolution modes of the specified oscilloscope. More...
 
uint32_t ScpGetAutoResolutionMode (LibTiePieHandle_t hDevice)
 Get the current auto resolution mode of the specified oscilloscope. More...
 
uint32_t ScpSetAutoResolutionMode (LibTiePieHandle_t hDevice, uint32_t dwAutoResolutionMode)
 Set the auto resolution mode of the specified oscilloscope. More...
 

Function Documentation

uint32_t ScpGetAutoResolutionModes ( LibTiePieHandle_t  hDevice)

Get the supported auto resolution modes of the specified oscilloscope.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
The supported auto resolution modes, a set of OR-ed AR_* values, ARM_NONE when unsuccessful.
Status values
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.
See also
ScpGetAutoResolutionMode
ScpSetAutoResolutionMode
Since
0.4.3
uint32_t ScpGetAutoResolutionMode ( LibTiePieHandle_t  hDevice)

Get the current auto resolution mode of the specified oscilloscope.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
Returns
The currently selected auto resolution mode, a AR_* value, AR_UNKNOWN when unsuccessful.
Status values
NOT_SUPPORTED Auto resolution is not supported by the hardware.
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.
See also
ScpGetAutoResolutionModes
ScpSetAutoResolutionMode
Since
0.4.3
uint32_t ScpSetAutoResolutionMode ( LibTiePieHandle_t  hDevice,
uint32_t  dwAutoResolutionMode 
)

Set the auto resolution mode of the specified oscilloscope.

Parameters
[in]hDeviceA device handle identifying the oscilloscope.
[in]dwAutoResolutionModeThe required auto resolution mode, a AR_* value.
Returns
The actually set auto resolution mode, a AR_* value, AR_UNKNOWN when unsuccessful.
Status values
INVALID_VALUE The requested value is invalid.
NOT_SUPPORTED Auto resolution is not supported by the hardware.
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.
See also
ScpGetAutoResolutionModes
ScpGetAutoResolutionMode
Since
0.4.3