libtiepie-hw  1.2.5
Auto resolution mode

Functions to control the auto resolution mode. More...

Collaboration diagram for Auto resolution mode:

Functions

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_auto_resolution_modes (tiepie_hw_handle handle)
 Get the supported auto resolution modes of the specified oscilloscope. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_auto_resolution_mode (tiepie_hw_handle handle)
 Get the current auto resolution mode of the specified oscilloscope. More...
 
TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_set_auto_resolution_mode (tiepie_hw_handle handle, uint32_t value)
 Set the auto resolution mode of the specified oscilloscope. More...
 

Detailed 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 rate. Use tiepie_hw_oscilloscope_get_auto_resolution_modes() to determine the available auto resolution modes. Possible auto resolution modes are:

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

Changing the sample rate may change the resolution if auto resolution mode is TIEPIE_HW_ARM_NATIVEONLY or TIEPIE_HW_ARM_ALL.

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

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

Function Documentation

◆ tiepie_hw_oscilloscope_get_auto_resolution_modes()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_auto_resolution_modes ( tiepie_hw_handle  handle)

Get the supported auto resolution modes of the specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
The supported auto resolution modes, a set of OR-ed TIEPIE_HW_ARM_* values, TIEPIE_HW_ARM_DISABLED when unsuccessful.
Status values
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_get_auto_resolution_mode
tiepie_hw_oscilloscope_set_auto_resolution_mode
Since
1.0

◆ tiepie_hw_oscilloscope_get_auto_resolution_mode()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_get_auto_resolution_mode ( tiepie_hw_handle  handle)

Get the current auto resolution mode of the specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
Returns
The currently selected auto resolution mode, a TIEPIE_HW_ARM_* value, TIEPIE_HW_ARM_UNKNOWN when unsuccessful.
Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED Auto resolution is not supported by the hardware.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_get_auto_resolution_modes
tiepie_hw_oscilloscope_set_auto_resolution_mode
Since
1.0

◆ tiepie_hw_oscilloscope_set_auto_resolution_mode()

TIEPIE_HW_API uint32_t tiepie_hw_oscilloscope_set_auto_resolution_mode ( tiepie_hw_handle  handle,
uint32_t  value 
)

Set the auto resolution mode of the specified oscilloscope.

Parameters
[in]handleA device handle identifying the oscilloscope.
[in]valueThe required auto resolution mode, a TIEPIE_HW_ARM_* value.
Returns
The actually set auto resolution mode, a TIEPIE_HW_ARM_* value, TIEPIE_HW_ARM_UNKNOWN when unsuccessful.
Status values
TIEPIE_HW_STATUS_INVALID_VALUE
TIEPIE_HW_STATUS_NOT_SUPPORTED Auto resolution is not supported by the hardware.
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid oscilloscope handle.
TIEPIE_HW_STATUS_OBJECT_GONE
TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED
TIEPIE_HW_STATUS_SUCCESS
See also
tiepie_hw_oscilloscope_get_auto_resolution_modes
tiepie_hw_oscilloscope_get_auto_resolution_mode
Since
1.0