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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToData32 (uint32_t modId, naibrd_da_mode_t mode, naibrd_da_polarity_t polarity, float64_t range, int32_t bufferLength, const uint32_t *p_rawData, float64_t **pp_outdata)
 Calculates the voltage in volts, or current in mA, for the given mode, range and raw data.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToDataRaw32 (uint32_t modId, naibrd_da_mode_t mode, naibrd_da_polarity_t polarity, float64_t range, int32_t bufferLength, const float64_t *p_data, uint32_t **pp_outrawData)
 Calculates the raw data for the given mode, range and voltage/current.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToRange32 (uint32_t modId, naibrd_da_mode_t mode, uint32_t rawRangePolarity, naibrd_da_polarity_t *p_outpolarity, float64_t *p_outrange)
 Returns (by reference) the unipolar/bipolar mode and voltage range associated with the D/A Module ID and raw data code.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToRangeRaw32 (uint32_t modId, naibrd_da_mode_t mode, naibrd_da_polarity_t polarity, float64_t range, uint32_t *p_outrawRangePolarity)
 Returns (by reference) the raw data code associated with the D/A Module ID and the unipolar/bipolar mode and voltage range.
 

Detailed Description

Function Documentation

◆ naibrd_DA_ConvertToData32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToData32 ( uint32_t modId,
naibrd_da_mode_t mode,
naibrd_da_polarity_t polarity,
float64_t range,
int32_t bufferLength,
const uint32_t * p_rawData,
float64_t ** pp_outdata )

Calculates the voltage in volts, or current in mA, for the given mode, range and raw data.

Parameters
modId: (Input) D/A Module ID.
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) Range Code.
bufferLength: (Input) Number of elements to convert in p_rawData.
p_rawData: (Input) Raw Data Code.
pp_outdata: (Output) Voltages in volts or Currents in mA.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_VALUE when invalid mode parameter is specified.

◆ naibrd_DA_ConvertToDataRaw32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToDataRaw32 ( uint32_t modId,
naibrd_da_mode_t mode,
naibrd_da_polarity_t polarity,
float64_t range,
int32_t bufferLength,
const float64_t * p_data,
uint32_t ** pp_outrawData )

Calculates the raw data for the given mode, range and voltage/current.

Parameters
modId: (Input) D/A Module ID.
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) Range Code.
bufferLength: (Input) Number of elements to convert in p_data.
p_data: (Input) Voltage in volts or Current in mA.
pp_outrawData: (Output) raw data code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_VALUE when invalid mode parameter is specified.

◆ naibrd_DA_ConvertToRange32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToRange32 ( uint32_t modId,
naibrd_da_mode_t mode,
uint32_t rawRangePolarity,
naibrd_da_polarity_t * p_outpolarity,
float64_t * p_outrange )

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

* DA1 Voltage
* Raw Data Code        Mode           DA1 Volt
* -------------------------------------------------
* 0x00/0x10      Unipolar/Bipolar     10.00 V
* 0x01/0x11      Unipolar/Bipolar      5.00 V
* 0x02/0x12      Unipolar/Bipolar      2.50 V
* 0x03/0x13      Unipolar/Bipolar      1.25 V
*
* DA1 Current
* Raw Data Code       Mode            DA1 Current
* -------------------------------------------------
* 0x10                Bipolar         25.000 mA
* 0x11                Bipolar         12.500 mA
* 0x12                Bipolar          6.250 mA
* 0x13                Bipolar          3.125 mA
*
* DA3 Voltage
* Raw Data Code        Mode           DA3 Volt     DA3 mAmp
* ---------------------------------------------------------
* 0x00                Unipolar        20.00 V      50.00 mA
* 0x01                Unipolar        40.00 V      100.0 mA
* 0x02                Bipolar         10.00 V      25.00 mA
* 0x03                Bipolar         20.00 V      50.00 mA
* 0x04                Bipolar         40.00 V      100.0 mA
*
* DA2 Voltage
* Raw Data Code        Mode           DA2 Volt
* ---------------------------------------------
* 0x00                Unipolar         5.00 V
* 0x01                Unipolar        10.00 V
* 0x02                Bipolar          2.50 V
* 0x03                Bipolar          5.00 V
* 0x04                Bipolar         10.00 V
*
*
*
*
Parameters
modId: (Input) D/A Module ID.
mode: (Input) Type of data to set (Voltage or Current) - refer to naibrd_da_mode_type_t.
rawRangePolarity: (Input) Raw Data Code.
p_outpolarity: (Output) NAIBRD_DA_POLARITY_UNIPOLAR or NAIBRD_DA_POLARITY_BIIPOLAR.
p_outrange: (Output) Voltage range in volts or Current in mA.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid raw data range or type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_ConvertToRangeRaw32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToRangeRaw32 ( uint32_t modId,
naibrd_da_mode_t mode,
naibrd_da_polarity_t polarity,
float64_t range,
uint32_t * p_outrawRangePolarity )

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

* DA1 Voltage
* Raw Data Code        Mode           DA1 Volt
* -------------------------------------------------
* 0x00/0x10      Unipolar/Bipolar     10.00 V
* 0x01/0x11      Unipolar/Bipolar      5.00 V
* 0x02/0x12      Unipolar/Bipolar      2.50 V
* 0x03/0x13      Unipolar/Bipolar      1.25 V
*
* DA1 Current
* Raw Data Code       Mode            DA1 Current
* -------------------------------------------------
* 0x10                Bipolar         25.000 mA
* 0x11                Bipolar         12.500 mA
* 0x12                Bipolar          6.250 mA
* 0x13                Bipolar          3.125 mA
*
* DA3
* Raw Data Code        Mode           DA3 Volt     DA3 mAmp
* ---------------------------------------------------------
* 0x00                Unipolar        20.00 V      50.00 mA
* 0x01                Unipolar        40.00 V      100.0 mA
* 0x02                Bipolar         10.00 V      25.00 mA
* 0x03                Bipolar         20.00 V      50.00 mA
* 0x04                Bipolar         40.00 V      100.0 mA
*
*
* DA2 Voltage
* Raw Data Code        Mode           DA2 Volt
* ---------------------------------------------
* 0x00                Unipolar         5.00 V
* 0x01                Unipolar        10.00 V
* 0x02                Bipolar          2.50 V
* 0x03                Bipolar          5.00 V
* 0x04                Bipolar         10.00 V
*
*
*
Parameters
modId: (Input) D/A Module ID.
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 or Current in mA.
p_outrawRangePolarity: (Output) Raw Data Code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid mode, range or type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.