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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToRange (uint32_t modId, naibrd_ad_mode_t mode, naibrd_ad_range_polarity_t rangePolarity, naibrd_ad_polarity_t *p_outpolarity, float64_t *p_outrange)
 Retrieves the unipolar/bipolar mode and voltage range associated with the A/D Module ID and raw data code.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToRangeRaw (uint32_t modId, naibrd_ad_mode_t mode, naibrd_ad_polarity_t polarity, float64_t range, naibrd_ad_range_polarity_t *p_outrangePolarity)
 Returns the raw data code associated with the A/D Module ID and the unipolar/bipolar mode and voltage range.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToData (uint32_t modId, naibrd_ad_mode_t mode, naibrd_ad_range_polarity_t rangePolarity, int32_t bufferLength, const uint32_t *p_rawDataBuffer, float64_t **pp_outvoltageBuffer)
 Calculates the voltage in volts associated with the A/D Module ID, given range and raw data.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToDataRaw (uint32_t modId, naibrd_ad_mode_t mode, naibrd_ad_range_polarity_t rangePolarity, int32_t bufferLength, const float64_t *p_voltages, uint32_t **pp_outrawData)
 Calculates the raw voltage associated with the A/D Module ID, given range and voltage.
 

Detailed Description

Function Documentation

◆ naibrd_AD_ConvertToData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToData ( uint32_t modId,
naibrd_ad_mode_t mode,
naibrd_ad_range_polarity_t rangePolarity,
int32_t bufferLength,
const uint32_t * p_rawDataBuffer,
float64_t ** pp_outvoltageBuffer )

Calculates the voltage in volts associated with the A/D Module ID, given range and raw data.

Parameters
modId: (Input) A/D Module ID.
mode: (Input) A/D Mode refer to naibrd_ad_mode_t type.
rangePolarity: (Input) Range-Polarity Code.
bufferLength: (Input) Number of elements in buffer to convert.
p_rawDataBuffer: (Input) Raw Data.
pp_outvoltageBuffer: (Output) Output Voltages in volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToDataRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToDataRaw ( uint32_t modId,
naibrd_ad_mode_t mode,
naibrd_ad_range_polarity_t rangePolarity,
int32_t bufferLength,
const float64_t * p_voltages,
uint32_t ** pp_outrawData )

Calculates the raw voltage associated with the A/D Module ID, given range and voltage.

Parameters
modId: (Input) A/D Module ID.
mode: (Input) A/D Mode refer to naibrd_ad_mode_t type.
rangePolarity: (Input) Range-Polarity Code.
bufferLength: (Input) Number of elements in buffer to convert.
p_voltages: (Input) Voltages.
pp_outrawData: (Output) Raw outputs.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToRange ( uint32_t modId,
naibrd_ad_mode_t mode,
naibrd_ad_range_polarity_t rangePolarity,
naibrd_ad_polarity_t * p_outpolarity,
float64_t * p_outrange )

Retrieves the unipolar/bipolar mode and voltage range associated with the A/D Module ID and raw data code. 

*                                           ---------- Voltage ----------     - Current -
* Range-Polarity Code       Polarity       AD1/AD4/ADE  AD5   AD2/AD6/ADF    AD3/AD4/ADG*
* ---------------------------------------------------------------------------------------------
*        0x0A/0x1A       Unipolar/Bipolar        N/A      N/A       N/A           N/A
*        0x09/0x19       Unipolar/Bipolar        N/A      N/A       N/A           N/A
*        0x00/0x10       Unipolar/Bipolar       10.00    50.00    100.00        25.00mA
*        0x01/0x11       Unipolar/Bipolar        5.00    25.00     50.00        12.50mA
*        0x02/0x12       Unipolar/Bipolar        2.50    12.50     25.00        6.250mA
*        0x03/0x13       Unipolar/Bipolar        1.25     6.25     12.50        3.125mA
*
* *Notes: AD3 only supports the 25mA range.
*         ADG only supports the 25mA and 12.5mA ranges
*
*
Parameters
modId: (Input) A/D Module ID.
mode: (Input) A/D Mode refer to naibrd_ad_mode_t type.
rangePolarity: (Input) Range-Polarity Code.
p_outpolarity: (Output) NAI_AD_POLARITY_UNIPOLAR or NAI_AD_POLARITY_BIPOLAR.
p_outrange: (Output) Voltage range in volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid raw data range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToRangeRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToRangeRaw ( uint32_t modId,
naibrd_ad_mode_t mode,
naibrd_ad_polarity_t polarity,
float64_t range,
naibrd_ad_range_polarity_t * p_outrangePolarity )

Returns the raw data code associated with the A/D Module ID and the unipolar/bipolar mode and voltage range. 

*                                           ---------- Voltage ----------     - Current -
*  Range-Polarity Code      Polarity        AD1/AD4/ADE  AD5   AD2/AD6/ADF    AD3/AD4/ADG*
*  ---------------------------------------------------------------------------------------------
*        0x0A/0x1A       Unipolar/Bipolar        N/A      N/A       N/A           N/A
*        0x09/0x19       Unipolar/Bipolar        N/A      N/A       N/A           N/A
*        0x00/0x10       Unipolar/Bipolar       10.00    50.00    100.00        25.00mA
*        0x01/0x11       Unipolar/Bipolar        5.00    25.00     50.00        12.50mA
*        0x02/0x12       Unipolar/Bipolar        2.50    12.50     25.00        6.250mA
*        0x03/0x13       Unipolar/Bipolar        1.25     6.25     12.50        3.125mA
*
* *Notes: AD3 only supports the 25mA range.
*         ADG only supports the 25mA and 12.5mA ranges
*
*
Parameters
modId: (Input) A/D Module ID.
mode: (Input) A/D Mode refer to naibrd_ad_mode_t type.
polarity: (Input) NAIBRD_AD_POLARITY_UNIPOLAR or NAIBRD_AD_POLARITY_BIPOLAR.
range: (Input) Voltage range in volts.
p_outrangePolarity: (Output) Raw Data Code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid mode and range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.