Functions for controlling the amplitude and amplitude range of a generator. More...
Modules | |
| Amplitude range | |
| Functions for controlling the amplitude range of a generator. | |
Functions | |
| TIEPIE_HW_API tiepie_hw_bool | tiepie_hw_generator_has_amplitude (tiepie_hw_handle handle) |
| Check whether the current signal type of a specified generator supports controlling the signal amplitude. | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_amplitude_min (tiepie_hw_handle handle) |
| Get the minimum signal amplitude for the current signal type of a specified generator. | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_amplitude_max (tiepie_hw_handle handle) |
| Get the maximum signal amplitude for the current signal type of a specified generator. | |
| TIEPIE_HW_API double | tiepie_hw_generator_get_amplitude (tiepie_hw_handle handle) |
| Get the currently set signal amplitude of a specified generator. | |
| TIEPIE_HW_API double | tiepie_hw_generator_set_amplitude (tiepie_hw_handle handle, double amplitude) |
| Set the signal amplitude of a specified generator. | |
Detailed Description
Functions for controlling the amplitude and amplitude range of a generator.
The amplitude of a generator can be set between a minimum and a maximum value. Use tiepie_hw_generator_get_amplitude_min() and tiepie_hw_generator_get_amplitude_max() to get the amplitude limits.
Amplitude and Offset combined cannot exceed the minimum and maximum output value of the generator. Setting a larger amplitude will clip the amplitude to a valid value.
A generator has one or more output ranges, use tiepie_hw_generator_set_amplitude_range() to set the required range or tiepie_hw_generator_set_amplitude_auto_ranging to enable amplitude auto ranging.
By default the amplitude is set to: 1 V and auto ranging is enabled.
When signal type DC is active, amplitude is not available. Use tiepie_hw_generator_has_amplitude() to check whether amplitude is available for the currently set signal type.
Function Documentation
◆ tiepie_hw_generator_has_amplitude()
| TIEPIE_HW_API tiepie_hw_bool tiepie_hw_generator_has_amplitude | ( | tiepie_hw_handle | handle | ) |
Check whether the current signal type of a specified generator supports controlling the signal amplitude.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- TIEPIE_HW_BOOL_TRUE if supported, TIEPIE_HW_BOOL_FALSE if not.
- Status values
TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle. TIEPIE_HW_STATUS_OBJECT_GONE TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED TIEPIE_HW_STATUS_SUCCESS
- See also
- tiepie_hw_generator_get_amplitude_min
- tiepie_hw_generator_get_amplitude_max
- tiepie_hw_generator_get_amplitude
- tiepie_hw_generator_set_amplitude
- Since
- 1.0
◆ tiepie_hw_generator_get_amplitude_min()
| TIEPIE_HW_API double tiepie_hw_generator_get_amplitude_min | ( | tiepie_hw_handle | handle | ) |
Get the minimum signal amplitude for the current signal type of a specified generator.
When amplitude auto ranging is enabled, the minimum value of all amplitude ranges is returned. When amplitude auto ranging is disabled, the minimum value for the currently set amplitude range is returned.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The minimum signal amplitude in Volt.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The current signal type does not support signal amplitude. TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle. TIEPIE_HW_STATUS_OBJECT_GONE TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED TIEPIE_HW_STATUS_SUCCESS
- See also
- tiepie_hw_generator_get_amplitude_max
- tiepie_hw_generator_get_amplitude
- tiepie_hw_generator_set_amplitude
- Since
- 1.0
◆ tiepie_hw_generator_get_amplitude_max()
| TIEPIE_HW_API double tiepie_hw_generator_get_amplitude_max | ( | tiepie_hw_handle | handle | ) |
Get the maximum signal amplitude for the current signal type of a specified generator.
When amplitude auto ranging is enabled, the maximum value for the highest amplitude range is returned. When amplitude auto ranging is disabled, the maximum value for the currently set amplitude range is returned.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The maximum signal amplitude in Volt.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The current signal type does not support signal amplitude. TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle. TIEPIE_HW_STATUS_OBJECT_GONE TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED TIEPIE_HW_STATUS_SUCCESS
- See also
- tiepie_hw_generator_get_amplitude_min
- tiepie_hw_generator_get_amplitude
- tiepie_hw_generator_set_amplitude
- Since
- 1.0
◆ tiepie_hw_generator_get_amplitude()
| TIEPIE_HW_API double tiepie_hw_generator_get_amplitude | ( | tiepie_hw_handle | handle | ) |
Get the currently set signal amplitude of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator.
- Returns
- The currently set signal amplitude in Volt.
- Status values
TIEPIE_HW_STATUS_NOT_SUPPORTED The current signal type does not support signal amplitude. TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle. TIEPIE_HW_STATUS_OBJECT_GONE TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED TIEPIE_HW_STATUS_SUCCESS
- See also
- tiepie_hw_generator_get_amplitude_min
- tiepie_hw_generator_get_amplitude_max
- tiepie_hw_generator_set_amplitude
- Since
- 1.0
◆ tiepie_hw_generator_set_amplitude()
| TIEPIE_HW_API double tiepie_hw_generator_set_amplitude | ( | tiepie_hw_handle | handle, |
| double | amplitude | ||
| ) |
Set the signal amplitude of a specified generator.
- Parameters
-
[in] handle A device handle identifying the generator. [in] amplitude The requested signal amplitude.
- Returns
- The actually set signal amplitude.
- Status values
TIEPIE_HW_STATUS_VALUE_CLIPPED The requested amplitude is outside the valid range and clipped to the closest limit. TIEPIE_HW_STATUS_VALUE_MODIFIED The requested amplitude is within the valid range but not available. The closest valid value is set. TIEPIE_HW_STATUS_INVALID_VALUE The requested amplitude is < 0.TIEPIE_HW_STATUS_NOT_SUPPORTED The current signal type does not support signal amplitude. TIEPIE_HW_STATUS_NOT_CONTROLLABLE TIEPIE_HW_STATUS_INVALID_HANDLE The handle is not a valid generator handle. TIEPIE_HW_STATUS_OBJECT_GONE TIEPIE_HW_STATUS_LIBRARY_NOT_INITIALIZED TIEPIE_HW_STATUS_SUCCESS
- Remarks
- Setting the amplitude may change the amplitude range when amplitude auto ranging is enabled.
- Setting the amplitude may cause a new waveform pattern to be uploaded when signal type Square wave is active, shortly interrupting the output signal.
- See also
- tiepie_hw_generator_get_amplitude_min
- tiepie_hw_generator_get_amplitude_max
- tiepie_hw_generator_get_amplitude
- Since
- 1.0
