Software Library API naibrd 1.62
See all documentation at naii.docs.com
Conversion Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToData32 (uint32_t modId, nai_da_data_type_t type, nai_da_range_mode_t mode, nai_da_range_t range, uint32_t rawdata, float64_t *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, nai_da_data_type_t type, nai_da_range_mode_t mode, nai_da_range_t range, float64_t data, uint32_t *outrawdata)
 Calculates the raw data for the given mode, range and voltage/current.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToRange (int32_t cardIndex, int32_t module, nai_da_data_type_t type, uint32_t rawdata, nai_da_range_mode_t *outmode, float64_t *outrange)
 Returns 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_ConvertToRangeRaw (int32_t cardIndex, int32_t module, nai_da_data_type_t type, nai_da_range_mode_t mode, float64_t range, uint32_t *outrawdata)
 Returns 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,
nai_da_data_type_t type,
nai_da_range_mode_t mode,
nai_da_range_t range,
uint32_t rawdata,
float64_t * 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.
type: (Input) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t.
mode: (Input) NAI_DA_RANGE_MODE_BIPOLAR or NAI_DA_RANGE_MODE_UNIPOLAR.
range: (Input) Range Code.
rawdata: (Input) Raw Data Code.
outdata: (Output) Voltage in volts or Current 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,
nai_da_data_type_t type,
nai_da_range_mode_t mode,
nai_da_range_t range,
float64_t data,
uint32_t * outrawdata )

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

Parameters
modId: (Input) D/A Module ID.
type: (Input) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t.
mode: (Input) NAI_DA_RANGE_MODE_BIPOLAR or NAI_DA_RANGE_MODE_UNIPOLAR.
range: (Input) Range Code.
data: (Input) Voltage in volts or Current in mA.
outrawdata: (Output) raw data code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_VALUE when invalid mode parameter is specified.

◆ naibrd_DA_ConvertToRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToRange ( int32_t cardIndex,
int32_t module,
nai_da_data_type_t type,
uint32_t rawdata,
nai_da_range_mode_t * outmode,
float64_t * outrange )

Returns 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      V
0x01                Unipolar        10     V
0x02                Bipolar         2.5    V
0x03                Bipolar         5      V
0x04                Bipolar         10     V
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]).
type: (Input) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t.
rawdata: (Input) Raw Data Code.
outmode: (Output) NAI_DA_GEN5_RANGE_MODE_UNIPOLAR or NAI_DA_GEN5_RANGE_MODE_BIPOLAR.
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_ConvertToRangeRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ConvertToRangeRaw ( int32_t cardIndex,
int32_t module,
nai_da_data_type_t type,
nai_da_range_mode_t mode,
float64_t range,
uint32_t * outrawdata )

Returns 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      V
0x01                Unipolar        10     V
0x02                Bipolar         2.5    V
0x03                Bipolar         5      V
0x04                Bipolar         10     V
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]).
type: (Input) Type of data to set (Voltage or Current) - refer to nai_da_data_type_t.
mode: (Input) NAI_DA_GEN5_RANGE_MODE_UNIPOLAR or NAI_DA_GEN5_RANGE_MODE_BIPOLAR.
range: (Input) Voltage range in volts or Current in mA.
outrawdata: (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.