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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetData (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ad_mode_t mode, float64_t *p_outvoltage)
 Retrieves the measured voltage, current or engineering units (when in FloatingPoint mode) from the specified A/D channel data register. The measured data is scaled per the range and polarity register value. Current is in mAmps.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetLatchChannel (int32_t cardIndex, int32_t module, int32_t channel, bool_t latched)
 Latches or unlatch A/D channels. All channels are latched/unlatched in unison and the channel parameter is ignored except for the ADE, ADF and ADG modules where only the channel specified is affected. For these modules, a channel = 0 will latch/unlatch all channels at once.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetLatchChannel (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outlatched)
 Retrieves the Latch state (latched or unlatched) of A/D channels. All channels are latched/unlatched in unison and the channel parameter is ignored except for the ADE, ADF and ADG modules where only the channel specified is affected. For these modules, a channel = 0 will latch/unlatch all channels at once.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ad_chan_mapped_status_type_t statusType)
 Clears the specified A/D Status for the specified A/D channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ad_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
 Retrieves the specified A/D Status for the specified A/D channel.
 

Detailed Description

Function Documentation

◆ naibrd_AD_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ad_chan_mapped_status_type_t statusType )

Clears the specified A/D Status for the specified A/D channel. 

* A status bit value of 0 (zero) indicates a "Normal/No Error" condition, and a value of 1 (one) indicates an "Error" condition. Real-Time
* statuses set and clear in real-time as their corresponding set/clear conditions are met. Latched statuses set and latch once a real-time
* status is set. Latched statuses are cleared by writing a 1 to the bit that is to be cleared.
*
Note
If any realtime status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.
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]).
statusType: (Input) Status Type: refer to naibrd_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_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ad_chan_mapped_status_type_t statusType,
nai_status_bit_t * p_outstatusBit )

Retrieves the specified A/D Status for the specified A/D channel. 

* A status bit value of 0 (zero) indicates a "Normal/No Error" condition, and a value of 1 (one) indicates an "Error" condition. Real-Time
* statuses set and clear in real-time as their corresponding set/clear conditions are meet. Latched statuses set and latch once a real-time
* status is set. Latched statuses are cleared by writting a 1 to the bit that is to be cleared.
*
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]).
statusType: (Input) Status Type: refer to naibrd_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_GetData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_GetData ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ad_mode_t mode,
float64_t * p_outvoltage )

Retrieves the measured voltage, current or engineering units (when in FloatingPoint mode) from the specified A/D channel data register. The measured data is scaled per the range and polarity register value. Current is in mAmps.

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) mode of the channel (NAIBRD_AD_MODE_VOLTAGE, or NAIBRD_AD_MODE_CURRENT).
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_GetLatchChannel()

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

Retrieves the Latch state (latched or unlatched) of A/D channels. All channels are latched/unlatched in unison and the channel parameter is ignored except for the ADE, ADF and ADG modules where only the channel specified is affected. For these modules, a channel = 0 will latch/unlatch all channels at once.

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_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_SetLatchChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_SetLatchChannel ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t latched )

Latches or unlatch A/D channels. All channels are latched/unlatched in unison and the channel parameter is ignored except for the ADE, ADF and ADG modules where only the channel specified is affected. For these modules, a channel = 0 will latch/unlatch all channels at once.

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]).
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.