Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outvoltage)
	Retrieves the sampled voltage from the specified A/D channel data register. The sampled voltage is scaled per the voltage range and polarity register value.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetVoltageAll (int32_t cardIndex, int32_t module, int32_t arraysize, float64_t p_outvoltageall[])
	Retrieves the sampled voltage from all of the A/D channels. The sampled voltage is scaled per the voltage range and polarity register value.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetRMSVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outvoltage)
	Retrieves the calculated RMS voltage from the specified A/D channel data register. The calculated RMS voltage is scaled per the LSB value.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetCurrent (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outcurrent)
	Retrieves the measured current from the specified A/D channel data register. The measured current is scaled with full scale range from 0 - 25 mA.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetCurrentAll (int32_t cardIndex, int32_t module, int32_t arraysize, float64_t p_outcurrentall[])
	Retrieves the measured current from all of the A/D channels. The measured current is scaled with full scale range from 0 - 25 mA.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_SetLatch (int32_t cardIndex, int32_t module, bool_t latched)
	Latches or unlatch all A/D channels.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetLatch (int32_t cardIndex, int32_t module, bool_t *p_outlatched)
	Retrieves the Latch state (latched or unlatched) of all A/D channels.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type, nai_status_bit_t *p_outstatusBit)
	Retrieves the A/D BIT or Open Status for the specified A/D channel. Reading any status bit will unlatch the entire register. BIT Status and Open Status is part of the background testing and the status register may be checked or polled at any given time.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type)
	Clears the A/D Status corresponding to the specified A/D Status type for the specified A/D channel.

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_AD_SetRange (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_range_mode_t mode, float64_t range)
	Sets the range and polarity for the specified A/D channel as follows:

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetRange (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_range_mode_t p_outmode, float64_t p_outrange)
	Retrieves the range and polarity for the specified A/D channel as follows:

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_SetSampleRate (int32_t cardIndex, int32_t module, uint32_t rate)
	Sets the sampling clock rate for the specified A/D module. The sampling clock rate can be specified from 2000Hz to 200 KHz with the LSB equal to 1 Hz. Note: AD1/AD2/AD3 max frequency is 256kHz, AD4/AD5/AD6/ is 400kHz distributed among active channels.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetSampleRate (int32_t cardIndex, int32_t module, uint32_t *p_outrate)
	Retrieves the sampling clock rate for the specified A/D module. The sampling clock rate can be specified from 2000Hz to 200 KHz with the LSB equal to 1 Hz.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_SetBreakFrequency (int32_t cardIndex, int32_t module, int32_t channel, uint32_t freq)
	Sets the filter break frequency for the specified A/D channel. The break frequency is the 3 db point of a single pole low pass filter. The break frequency can be specified between 10 Hz to 10 KHz with LSB equal to 1 Hz. Zero disables the filter.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetBreakFrequency (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outfreq)
	Retrieves the filter break frequency for the specified A/D channel. The break frequency is the 3 db point of a single pole low pass filter. The break frequency can be between 10 Hz to 10 KHz with LSB equal to 1 Hz. Zero indicates a disabled filter.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_SetMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_mode_t mode)
	Sets the mode for the specified A/D channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_GetMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_mode_t *p_outmode)
	Retrieves the mode for the specified A/D channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_AD_SetFloatingPointOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t offset)
	Sets the HW floating point offset for the specified A/D 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_AD_GetFloatingPointOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outoffset)
	Retrieves the HW floating point offset for the specified A/D 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_AD_SetFloatingPointScaleFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t scaleFactor)
	Sets the HW floating point scale factor for the specified A/D 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_AD_GetFloatingPointScaleFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outscaleFactor)
	Retrieves the HW floating point scale factor for the specified A/D 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_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ad_status_type_t	type )

Clears the A/D Status corresponding to the specified A/D Status type for the specified A/D 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]).
type	: (Input) Status Type: refer to nai_ad_status_type_t definition.

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 type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_GetBreakFrequency()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetBreakFrequency	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	p_outfreq )

Retrieves the filter break frequency for the specified A/D channel. The break frequency is the 3 db point of a single pole low pass filter. The break frequency can be between 10 Hz to 10 KHz with LSB equal to 1 Hz. Zero indicates a disabled filter.

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_outfreq	: (Output) 0 - 10,000 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_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ 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_GetCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetCurrent	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	p_outcurrent )

Retrieves the measured current from the specified A/D channel data register. The measured current is scaled with full scale range from 0 - 25 mA.

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_outcurrent	: (Output) Current reading in amps.

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_GetCurrentAll()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetCurrentAll	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	arraysize,
		float64_t	p_outcurrentall[] )

Retrieves the measured current from all of the A/D channels. The measured current is scaled with full scale range from 0 - 25 mA.

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]).
arraysize	: (Input) Size of the p_outcurrentall array. If specified size is less than max channels, the voltages returned will be for channel 1 to size.
p_outcurrentall	: (Output) Current readings in amps for all channels.

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_GetFloatingPointOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetFloatingPointOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outoffset )

Retrieves the HW floating point offset for the specified A/D 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]).
outoffset	: (Output) Floating-point offset read from register.

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_GetFloatingPointScaleFactor()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetFloatingPointScaleFactor	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outscaleFactor )

Retrieves the HW floating point scale factor for the specified A/D 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]).
outscaleFactor	: (Output) Floating-point scale factor setting read from register.

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_GetLatch()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetLatch	(	int32_t	cardIndex,
		int32_t	module,
		bool_t *	p_outlatched )

Retrieves the Latch state (latched or unlatched) of all A/D channels.

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_outlatched	: (Output) Latched(1) or Unlatched(0) A/D channels.

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_AD_GetMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ad_mode_t *	p_outmode )

Retrieves the mode for the specified A/D 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]).
p_outmode	: (Output) NAI_AD_MODE_VOLTAGE or NAI_AD_MODE_CURRENT.

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_GetRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetRange	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ad_range_mode_t *	p_outmode,
		float64_t *	p_outrange )

Retrieves the range and polarity for the specified A/D channel as follows:

                                                                      Register Value
       C4      C2      C1      KA  AD1/AD4/ADE AD5 AD2/AD6/ADF  Unipolar Mode   Bipolar Mode
     --------------------------------------------------------------------------------------------
     50.00   40.00     N/A     N/A     N/A     N/A     N/A          0x0A           0x1A
     25.00   20.00     N/A     N/A     N/A     N/A     N/A          0x09           0x19
     12.50   10.00   10.00   10.00   10.00   50.00   100.00         0x00*          0x10
      6.25    5.00    5.00    5.00    5.00   25.00    50.00         0x01*          0x11
       N/A     N/A    2.50     N/A    2.50   12.50    25.00         0x02           0x12
       N/A     N/A    1.25     N/A    1.25    6.25    12.50         0x03           0x13
     --------------------------------------------------------------------------------------------
     *Not supported on KA module (only bipolar mode).

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_outmode	: (Output) NAI_AD_RANGE_MODE_UNIPOLAR or NAI_AD_RANGE_MODE_BIPOLAR.
p_outrange	: (Output) Voltage range in volts.

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_GetRMSVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetRMSVoltage	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	p_outvoltage )

Retrieves the calculated RMS voltage from the specified A/D channel data register. The calculated RMS voltage is scaled per the LSB value.

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_outvoltage	: (Output) Voltage reading in volts.

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_GetSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetSampleRate	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t *	p_outrate )

Retrieves the sampling clock rate for the specified A/D module. The sampling clock rate can be specified from 2000Hz to 200 KHz with the LSB equal to 1 Hz.

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_outrate	: (Output) A/D sampling rate in Hz (valid clock rate is 2000Hz to 200 KHz).

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_AD_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ad_status_type_t	type,
		nai_status_bit_t *	p_outstatusBit )

Retrieves the A/D BIT or Open Status for the specified A/D channel. Reading any status bit will unlatch the entire register. BIT Status and Open Status is part of the background testing and the status register may be checked or polled at any given time.

A BIT status value of 0 (zero) indicates "Normal" and a value of 1 (one) indicates a non-compliant
A/D conversion (outside 0.2% Full Scale accuracy specification).

Open Status capabilities apply only to C1 and AD4 modules. An Open status value of 0 (zero) indicates "Normal" and a
value of 1 (one) indicates an open or disconnect to the input. An open is detected within 10 seconds and will
latch the corresponding bit in the Open Status register.

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]).
type	: (Input) Status Type: refer to nai_ad_status_type_t definition.
p_outstatusBit	: (Output) 0 for Normal, 1 BIT failure or Open Detected.

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 type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_GetVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetVoltage	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	p_outvoltage )

Retrieves the sampled voltage from the specified A/D channel data register. The sampled voltage is scaled per the voltage range and polarity register value.

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_outvoltage	: (Output) Voltage reading in volts.

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_GetVoltageAll()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetVoltageAll	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	arraysize,
		float64_t	p_outvoltageall[] )

Retrieves the sampled voltage from all of the A/D channels. The sampled voltage is scaled per the voltage range and polarity register value.

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]).
arraysize	: (Input) Size of the p_outvoltageall array. If specified size is less than max channels, the voltages returned will be for channel 1 to size.
p_outvoltageall	: (Output) Voltage reading in volts for all channels.

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_SetBreakFrequency()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetBreakFrequency	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	freq )

Sets the filter break frequency for the specified A/D channel. The break frequency is the 3 db point of a single pole low pass filter. The break frequency can be specified between 10 Hz to 10 KHz with LSB equal to 1 Hz. Zero disables the filter.

The break frequency must not be less than 10% of the clock rate frequency. For example, if the clock rate frequency is 2 KHz, the filter break frequency should be no less than 200 Hz.

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]).
freq	: (Input) 0 - 10,000 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_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.
NAI_ERROR_INVALID_VALUE when the break frequency exceeds the sample rate

◆ 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_AD_SetFloatingPointOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetFloatingPointOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	offset )

Sets the HW floating point offset for the specified A/D 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]).
offset	: (Input) Floating-point offset setting 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_AD_SetFloatingPointScaleFactor()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetFloatingPointScaleFactor	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	scaleFactor )

Sets the HW floating point scale factor for the specified A/D 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]).
scaleFactor	: (Input) Floating-point scale factor setting 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_AD_SetLatch()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetLatch	(	int32_t	cardIndex,
		int32_t	module,
		bool_t	latched )

Latches or unlatch all A/D channels.

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]).
latched	: (Input) Latch(1) or Unlatch(0) A/D channels.

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_AD_SetMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ad_mode_t	mode )

Sets the mode for the specified A/D 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]).
mode	: (Input) NAI_AD_MODE_VOLTAGE or NAI_AD_MODE_CURRENT.

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_SetRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetRange	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ad_range_mode_t	mode,
		float64_t	range )

Sets the range and polarity for the specified A/D channel as follows:

                                                                      Register Value
       C4      C2      C1      KA  AD1/AD4/ADE AD5 AD2/AD6/ADF  Unipolar Mode   Bipolar Mode
     --------------------------------------------------------------------------------------------
     50.00   40.00     N/A     N/A     N/A     N/A     N/A          0x0A           0x1A
     25.00   20.00     N/A     N/A     N/A     N/A     N/A          0x09           0x19
     12.50   10.00   10.00   10.00   10.00   50.00   100.00         0x00*          0x10
      6.25    5.00    5.00    5.00    5.00   25.00    50.00         0x01*          0x11
       N/A     N/A    2.50     N/A    2.50   12.50    25.00         0x02           0x12
       N/A     N/A    1.25     N/A    1.25    6.25    12.50         0x03           0x13
     --------------------------------------------------------------------------------------------
     *Not supported on KA module (only bipolar mode).

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) NAI_AD_RANGE_MODE_UNIPOLAR or NAI_AD_RANGE_MODE_BIPOLAR.
range	: (Input) Voltage range in volts, or Current range in Amps (AD4 only).

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_SetSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetSampleRate	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	rate )

Sets the sampling clock rate for the specified A/D module. The sampling clock rate can be specified from 2000Hz to 200 KHz with the LSB equal to 1 Hz. Note: AD1/AD2/AD3 max frequency is 256kHz, AD4/AD5/AD6/ is 400kHz distributed among active channels.

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]).
rate	: (Input) A/D sampling rate in Hz (valid clock rate is 2000Hz to 200 KHz).

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.
NAI_ERROR_INVALID_VALUE the sample rate is out of the recommended range for the break freq setting on one of the channels. The sample rate will be set with the error status returned.

Functions

Detailed Description

Function Documentation

◆ naibrd_AD_ClearStatus()

◆ naibrd_AD_GetBreakFrequency()

◆ naibrd_AD_GetChanStatusEnable()

◆ naibrd_AD_GetCurrent()

◆ naibrd_AD_GetCurrentAll()

◆ naibrd_AD_GetFloatingPointOffset()

◆ naibrd_AD_GetFloatingPointScaleFactor()

◆ naibrd_AD_GetLatch()

◆ naibrd_AD_GetMode()

◆ naibrd_AD_GetRange()

◆ naibrd_AD_GetRMSVoltage()

◆ naibrd_AD_GetSampleRate()

◆ naibrd_AD_GetStatus()

◆ naibrd_AD_GetVoltage()

◆ naibrd_AD_GetVoltageAll()

◆ naibrd_AD_SetBreakFrequency()

◆ naibrd_AD_SetChanStatusEnable()

◆ naibrd_AD_SetFloatingPointOffset()

◆ naibrd_AD_SetFloatingPointScaleFactor()

◆ naibrd_AD_SetLatch()

◆ naibrd_AD_SetMode()

◆ naibrd_AD_SetRange()

◆ naibrd_AD_SetSampleRate()