Software Library API naibrd 1.62
See all documentation at naii.docs.com
|
Functions | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
Enables/disables status reporting for the specified D/A channel. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable) |
Retrieves the enabled/disabled state of status reporting for the specified D/A channel. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetRange (int32_t cardIndex, int32_t module, int32_t channel, nai_da_data_type_t type, nai_da_range_mode_t mode, float64_t range) |
Sets the range and polarity for the specified D/A channel. There is no current mode for DA2. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetRange (int32_t cardIndex, int32_t module, int32_t channel, nai_da_data_type_t type, nai_da_range_mode_t *outmode, float64_t *outrange) |
Retrieves the range and polarity for the specified D/A channel. There is no current mode for DA2. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetOutputTrigger (int32_t cardIndex, int32_t module, int32_t channel, uint32_t trigger) |
Sets the output data trigger for the specified D/A channel. DA output voltages can be programmed to change only with a synchronizing trigger, or constantly update based on the D/A Data register. This control is on a channel-by-channel basis. The whole system (not just the module) has two trigger lines that are shared and can be used for any D/A channel. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetOutputTrigger (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outtrigger) |
Retrieves the output data trigger for the specified D/A channel. DA output voltages can be programmed to change only with a synchronizing trigger, or constantly update based on the D/A Data register. This control is on a channel-by-channel basis. The whole system (not just the module) has two trigger lines that are shared and can be used for any D/A channel. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetSignalModeSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_da_signal_mode_t mode) |
Sets the Single Ended or Differential mode configuration for the specified D/A channel. When in single ended mode, the pair of channels operate independently of each other. When in differential mode, the respective channels act as a pair with the output centered around zero (in bi-polar mode) or centered around half of full scale (in uni-polar mode). Feature available only on F5 modules. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetSignalModeSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_da_signal_mode_t *outmode) |
Retrieves the Single Ended or Differential mode configuration for the specified D/A channel. When in single ended mode, the pair of channels operate independently of each other. When in differential mode, the respective channels act as a pair with the output centered around zero (in bi-polar mode) or centered around half of full scale (in uni-polar mode). Feature available only on F5 modules. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetOpMode (int32_t cardIndex, int32_t module, int32_t channel, nai_da_data_type_t opmode) |
Sets the specified channel on the D/A into Voltage, or Current mode. Voltage mode is the standard and default operating mode. Current mode allows the user to specify a FIXED current output which will vary the voltage as necessary to maintain this output current. Feature available only on DA1 and DA3 modules. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetOpMode (int32_t cardIndex, int32_t module, int32_t channel, nai_da_data_type_t *outopmode) |
Retrieves the mode set on the specified channel on the D/A (Voltage Mode, or Current Mode). Voltage mode is the standard and default operating mode. Current mode allows the user to specify a FIXED current output which will vary the voltage as necessary to maintain this output current. Feature available only on DA1 and DA3 modules. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetBandwidthSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_da_bandwidth_t bandwidth) |
Sets the bandwidth of the specified channel on the D/A. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetBandwidthSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_da_bandwidth_t *outbandwidth) |
Retrieves the bandwidth of the specified channel on the D/A. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetFloatingPointOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t offset) |
Sets the HW floating point offset for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetFloatingPointOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outoffset) |
Retrieves the HW floating point offset for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_SetFloatingPointScaleFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t scaleFactor) |
Sets the HW floating point scale factor for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_DA_GetFloatingPointScaleFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outscaleFactor) |
Retrieves the HW floating point scale factor for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details. | |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetBandwidthSelect | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_bandwidth_t * | outbandwidth ) |
Retrieves the bandwidth of the specified channel on the D/A.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
outbandwidth | : (Output) bandwidth select - refer to nai_da_bandwidth_t. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetChanStatusEnable | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
bool_t * | outenable ) |
Retrieves the enabled/disabled state of status reporting for the specified D/A channel.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
outenable | : (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFloatingPointOffset | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float64_t * | outoffset ) |
Retrieves the HW floating point offset for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
outoffset | : (Output) Floating-point offset read from register. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFloatingPointScaleFactor | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float64_t * | outscaleFactor ) |
Retrieves the HW floating point scale factor for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
outscaleFactor | : (Output) Floating-point scale factor setting read from register. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetOpMode | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_data_type_t * | outopmode ) |
Retrieves the mode set on the specified channel on the D/A (Voltage Mode, or Current Mode). Voltage mode is the standard and default operating mode. Current mode allows the user to specify a FIXED current output which will vary the voltage as necessary to maintain this output current. Feature available only on DA1 and DA3 modules.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
outopmode | : (Output) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetOutputTrigger | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
uint32_t * | outtrigger ) |
Retrieves the output data trigger for the specified D/A channel. DA output voltages can be programmed to change only with a synchronizing trigger, or constantly update based on the D/A Data register. This control is on a channel-by-channel basis. The whole system (not just the module) has two trigger lines that are shared and can be used for any D/A channel.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
outtrigger | : (Output) Output Trigger Control. - NAI_DA_OUT_TRG_CONST_UPDATE - NAI_DA_OUT_TRG_DONT_UPDATE - NAI_DA_OUT_TRG_TRG1_POS_SLOPE - NAI_DA_OUT_TRG_TRG1_NEG_SLOPE - NAI_DA_OUT_TRG_TRG2_POS_SLOPE - NAI_DA_OUT_TRG_TRG2_NEG_SLOPE |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetRange | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_data_type_t | type, | ||
nai_da_range_mode_t * | outmode, | ||
float64_t * | outrange ) |
Retrieves the range and polarity for the specified D/A channel. There is no current mode for DA2.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
type | : (Input) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t. |
outmode | : (Output) NAI_DA_RANGE_MODE_BIPOLAR or NAI_DA_RANGE_MODE_UNIPOLAR. |
outrange | : (Output) Voltage range in volts / Current range in mA . |
Voltage Mode DA1 Volt ---------------------------------- Unipolar/Bipolar 10.00 V Unipolar/Bipolar 5.00 V Unipolar/Bipolar 2.50 V Unipolar/Bipolar 1.25 V Current Mode DA1 Current ------------------------------------------------- Bipolar 25.000 mA Bipolar 12.500 mA Bipolar 6.250 mA Bipolar 3.125 mA Voltage Mode DA2 Volt ------------------------------- Bipolar 2.5 V Unipolar/Bipolar 5 V Unipolar/Bipolar 10 V
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetSignalModeSelect | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_signal_mode_t * | outmode ) |
Retrieves the Single Ended or Differential mode configuration for the specified D/A channel. When in single ended mode, the pair of channels operate independently of each other. When in differential mode, the respective channels act as a pair with the output centered around zero (in bi-polar mode) or centered around half of full scale (in uni-polar mode). Feature available only on F5 modules.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
outmode | : (Output) NAI_DA_SIGNAL_MODE_SINGLE or NAI_DA_SIGNAL_MODE_DIFF. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetBandwidthSelect | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_bandwidth_t | bandwidth ) |
Sets the bandwidth of the specified channel on the D/A.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
bandwidth | : (Input) bandwidth select - refer to nai_da_bandwidth_t. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetChanStatusEnable | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
bool_t | enable ) |
Enables/disables status reporting for the specified D/A channel.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
enable | : (Input) 0 to disable or 1 to enable status reporting for a channel. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFloatingPointOffset | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float64_t | offset ) |
Sets the HW floating point offset for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
offset | : (Input) Floating-point offset setting to set. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFloatingPointScaleFactor | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float64_t | scaleFactor ) |
Sets the HW floating point scale factor for the specified D/A channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
scaleFactor | : (Input) Floating-point scale factor setting to set. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetOpMode | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_data_type_t | opmode ) |
Sets the specified channel on the D/A into Voltage, or Current mode. Voltage mode is the standard and default operating mode. Current mode allows the user to specify a FIXED current output which will vary the voltage as necessary to maintain this output current. Feature available only on DA1 and DA3 modules.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
opmode | : (Input) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetOutputTrigger | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
uint32_t | trigger ) |
Sets the output data trigger for the specified D/A channel. DA output voltages can be programmed to change only with a synchronizing trigger, or constantly update based on the D/A Data register. This control is on a channel-by-channel basis. The whole system (not just the module) has two trigger lines that are shared and can be used for any D/A channel.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
trigger | : (Input) Output Trigger Control. - NAI_DA_OUT_TRG_CONST_UPDATE - NAI_DA_OUT_TRG_DONT_UPDATE - NAI_DA_OUT_TRG_TRG1_POS_SLOPE - NAI_DA_OUT_TRG_TRG1_NEG_SLOPE - NAI_DA_OUT_TRG_TRG2_POS_SLOPE - NAI_DA_OUT_TRG_TRG2_NEG_SLOPE |
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetRange | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_data_type_t | type, | ||
nai_da_range_mode_t | mode, | ||
float64_t | range ) |
Sets the range and polarity for the specified D/A channel. There is no current mode for DA2.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
type | : (Input) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t. |
mode | : (Input) NAI_DA_GEN3_RANGE_MODE_BIPOLAR or NAI_DA_GEN3_RANGE_MODE_UNIPOLAR or NAI_DA_GEN5_RANGE_MODE_BIPOLAR or NAI_DA_GEN5_RANGE_MODE_UNIPOLAR. |
range | : (Input) Voltage range in volts / Current range in mA . |
Voltage Mode DA1 Volt ---------------------------------- Unipolar/Bipolar 10.00 V Unipolar/Bipolar 5.00 V Unipolar/Bipolar 2.50 V Unipolar/Bipolar 1.25 V Current Mode DA1 Current ------------------------------------------------- Bipolar 25.000 mA Bipolar 12.500 mA Bipolar 6.250 mA Bipolar 3.125 mA Voltage Mode DA2 Volt ------------------------------- Bipolar 2.5 V Unipolar/Bipolar 5 V Unipolar/Bipolar 10 V
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetSignalModeSelect | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_da_signal_mode_t | mode ) |
Sets the Single Ended or Differential mode configuration for the specified D/A channel. When in single ended mode, the pair of channels operate independently of each other. When in differential mode, the respective channels act as a pair with the output centered around zero (in bi-polar mode) or centered around half of full scale (in uni-polar mode). Feature available only on F5 modules.
cardIndex | : (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1). |
module | : (Input) Module Number of the module to access (1 - [max modules for board]). |
channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
mode | : (Input) NAI_DA_SIGNAL_MODE_SINGLE or NAI_DA_SIGNAL_MODE_DIFF. |