Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Configuration Functions
NAI Board Library - Module Functions » DA Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables/disables status reporting for the specified AD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Retrieves the enabled/disabled state of status reporting for the specified AD channel.
 
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 DA 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 DA channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetRangePolarity (int32_t cardIndex, int32_t module, int32_t channel, naibrd_da_mode_t mode, naibrd_da_polarity_t polarity, 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_GetRangePolarity (int32_t cardIndex, int32_t module, int32_t channel, naibrd_da_mode_t mode, naibrd_da_polarity_t *p_outpolarity, float64_t *p_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_SetOpMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_da_mode_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, naibrd_da_mode_t *p_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_SetUpdateRate (int32_t cardIndex, int32_t module, uint32_t rateHz)
 Sets the update rate (sample rate) in Hz for the module. All channels use the same rate.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetUpdateRate (int32_t cardIndex, int32_t module, uint32_t *p_outrateHz)
 Retrieves the update rate (sample rate) in Hz for the module. All channels use the same rate.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFloatingPointAttribute (int32_t cardIndex, int32_t module, int32_t channel, naibrd_da_floating_point_attribute_t attribute, float64_t value)
 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_GetFloatingPointAttribute (int32_t cardIndex, int32_t module, int32_t channel, naibrd_da_floating_point_attribute_t attribute, float64_t *p_outvalue)
 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.
 

Detailed Description

Function Documentation

◆ naibrd_AD_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outenable )

Retrieves the enabled/disabled state of status reporting for the specified AD channel.

Parameters
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.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables/disables status reporting for the specified AD channel.

Parameters
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.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetChanStatusEnable()

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 DA channel.

Parameters
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.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetFloatingPointAttribute()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFloatingPointAttribute ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_da_floating_point_attribute_t attribute,
float64_t * p_outvalue )

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.

Parameters
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]).
attribute: (Input) Floating-point attribute to read.
p_outvalue: (Output) Floating-point value read.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetOpMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetOpMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_da_mode_t * p_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.

Parameters
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]).
p_outopMode: (Output) Type of data to set (Voltage or Current) - refer to naibrd_da_mode_t.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetRangePolarity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetRangePolarity ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_da_mode_t mode,
naibrd_da_polarity_t * p_outpolarity,
float64_t * p_outrange )

Retrieves the range and polarity for the specified D/A channel. There is no current mode for DA2.

Parameters
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) Type of data to set (Voltage or Current) - refer to naibrd_da_mode_type_t.
p_outpolarity: (Output) NAI_DA_RANGE_MODE_BIPOLAR or NAI_DA_RANGE_MODE_UNIPOLAR.
p_outrange: (Output) Voltage range in volts / Current range in mA .
*
* Voltage Mode:
*  Polarity            DA1 Volt    DA2 Volt    DA3 Volt
* ------------------------------------------------------
* Unipolar/Bipolar     10.00 V     10.00 V     40.00 V
* Unipolar/Bipolar      5.00 V      5.00 V     20.00 V
* Unipolar/Bipolar      2.50 V
* Unipolar/Bipolar      1.25 V
* Bipolar Only           N/A        2.50 V     10.00 V
*
* Current Mode:
*   DA1 Current (mA)        DA3 Current (mA)
* ------------------------------------------------------
*   25.000 (Bipolar)    50.000 (Unipolar/Bipolar)
*   12.500 (Bipolar)    100.00 (Unipolar/Bipolar)
*    6.250 (Bipolar)     25.00 (Bipolar)
*    3.125 (Bipolar)
*
*
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.
  • NAI_ERROR_INVALID MODE when 'type' parameter is invalid.

◆ naibrd_DA_GetUpdateRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetUpdateRate ( int32_t cardIndex,
int32_t module,
uint32_t * p_outrateHz )

Retrieves the update rate (sample rate) in Hz for the module. All channels use the same rate.

Parameters
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]).
p_outrateHz: (output) channels' rate in Hz..
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetChanStatusEnable()

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 DA channel.

Parameters
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.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetFloatingPointAttribute()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFloatingPointAttribute ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_da_floating_point_attribute_t attribute,
float64_t value )

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.

Parameters
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]).
attribute: (Input) Floating-point attribute to set.
value: (Input) Floating-point value to set.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetOpMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetOpMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_da_mode_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.

Parameters
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 naibrd_da_mode_t.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid mode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetRangePolarity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetRangePolarity ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_da_mode_t mode,
naibrd_da_polarity_t polarity,
float64_t range )

Sets the range and polarity for the specified D/A channel. There is no current mode for DA2.

Parameters
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) Type of data to set (Voltage or Current) - refer to naibrd_da_mode_type_t.
polarity: (Input) NAIBRD_DA_RANGE_MODE_BIPOLAR or NAIBRD_DA_RANGE_MODE_UNIPOLAR.
range: (Input) Voltage range in volts / Current range in mA .
*
* Voltage Mode:
*  Polarity            DA1 Volt    DA2 Volt    DA3 Volt
* ------------------------------------------------------
* Unipolar/Bipolar     10.00 V     10.00 V     40.00 V
* Unipolar/Bipolar      5.00 V      5.00 V     20.00 V
* Unipolar/Bipolar      2.50 V
* Unipolar/Bipolar      1.25 V
* Bipolar Only           N/A        2.50 V     10.00 V
*
* Current Mode:
*   DA1 Current (mA)        DA3 Current (mA)
* ------------------------------------------------------
*   25.000 (Bipolar)    50.000 (Unipolar/Bipolar)
*   12.500 (Bipolar)    100.00 (Unipolar/Bipolar)
*    6.250 (Bipolar)     25.00 (Bipolar)
*    3.125 (Bipolar)
*
*
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_MODE when 'type' parameter is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetUpdateRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetUpdateRate ( int32_t cardIndex,
int32_t module,
uint32_t rateHz )

Sets the update rate (sample rate) in Hz for the module. All channels use the same rate.

Parameters
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]).
rateHz: (Input) rate in Hz to set.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.