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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToVoltageRange (uint32_t modid, nai_ad_range_t rawdata, nai_ad_range_mode_t *p_outmode, float64_t *p_outrange)
 Returns 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_ConvertToVoltageRangeRaw (uint32_t modid, nai_ad_range_mode_t mode, float64_t range, nai_ad_range_t *p_outrawdata)
 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_ConvertToVoltage (uint32_t modid, nai_ad_range_t range, uint32_t rawdata, float64_t *p_outvoltage)
 Calculates the voltage in volts associated with the A/D Module ID and given range and raw data.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToLevelD0 (uint32_t modid, nai_ad_range_t range, uint32_t rawdata, float64_t *p_outlevel)
 Calculates the voltage/current associated with the A/D Module ID and given range and raw data for D0.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToVoltageRaw (uint32_t modid, nai_ad_range_t range, float64_t voltage, uint32_t *p_outrawdata)
 Calculates the raw voltage associated with the A/D Module ID and given range and voltage.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToLevelRawD0 (uint32_t modid, nai_ad_range_t range, float64_t level, uint32_t *p_outrawdata)
 Calculates the raw voltage/current associated with the A/D Module ID and given range and voltage for D0.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToCurrentRange (uint32_t modid, nai_ad_range_t rawdata, nai_ad_range_mode_t *p_outmode, float64_t *p_outrange)
 Returns the unipolar/bipolar mode and current range associated with the A/D Module ID and raw data code.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToCurrentRangeRaw (uint32_t modid, nai_ad_range_mode_t mode, float64_t range, nai_ad_range_t *p_outrawdata)
 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_ConvertToCurrent (uint32_t modid, nai_ad_range_t range, uint32_t rawdata, float64_t *p_outcurrent)
 Calculates the current in Amps associated with the A/D Module ID and given range and raw data.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToCurrentRaw (uint32_t modid, nai_ad_range_t range, float64_t current, uint32_t *p_outrawdata)
 Calculates the raw current associated with the A/D Module ID and given range and current.
 

Detailed Description


Function Documentation

◆ naibrd_AD_ConvertToCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToCurrent ( uint32_t modid,
nai_ad_range_t range,
uint32_t rawdata,
float64_t * p_outcurrent )

Calculates the current in Amps associated with the A/D Module ID and given range and raw data.

Parameters
modid: (Input) A/D Module ID.
range: (Input) Range Code.
rawdata: (Input) Raw Data Code.
p_outcurrent: (Output) Current in amps.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToCurrentRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToCurrentRange ( uint32_t modid,
nai_ad_range_t rawdata,
nai_ad_range_mode_t * p_outmode,
float64_t * p_outrange )

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

                                           Current (mAmps)
     Raw Data Code           Mode          AD3/AD4    ADG
     -------------------------------------------------------
       0x00/0x10       Unipolar/Bipolar     25.00    25.00
       0x01/0x11       Unipolar/Bipolar      N/A     12.50
Parameters
modid: (Input) A/D Module ID.
rawdata: (Input) Raw Data Code.
p_outmode: (Output) NAI_AD_RANGE_MODE_UNIPOLAR or NAI_AD_RANGE_MODE_BIPOLAR.
p_outrange: (Output) Current range in mA.
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_ConvertToCurrentRangeRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToCurrentRangeRaw ( uint32_t modid,
nai_ad_range_mode_t mode,
float64_t range,
nai_ad_range_t * p_outrawdata )

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

                                           Current (mAmps)
     Raw Data Code           Mode          AD3/AD4    ADG
     -------------------------------------------------------
       0x00/0x10       Unipolar/Bipolar     25.00    25.00
       0x01/0x11       Unipolar/Bipolar      N/A     12.50
Parameters
modid: (Input) A/D Module ID.
mode: (Input) NAI_AD_RANGE_MODE_UNIPOLAR or NAI_AD_RANGE_MODE_BIPOLAR.
range: (Input) Current range in amps.
p_outrawdata: (Output) Raw Data Code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid mode and/or range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToCurrentRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToCurrentRaw ( uint32_t modid,
nai_ad_range_t range,
float64_t current,
uint32_t * p_outrawdata )

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

Parameters
modid: (Input) A/D Module ID.
range: (Input) Range Code.
current: (Input) Current in amps.
p_outrawdata: (Output) raw data code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToLevelD0()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToLevelD0 ( uint32_t modid,
nai_ad_range_t range,
uint32_t rawdata,
float64_t * p_outlevel )

Calculates the voltage/current associated with the A/D Module ID and given range and raw data for D0.

Parameters
modid: (Input) A/D Module ID.
range: (Input) Range Code.
rawdata: (Input) Raw Data Code.
p_outlevel: (Output) Voltage 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_ConvertToLevelRawD0()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToLevelRawD0 ( uint32_t modid,
nai_ad_range_t range,
float64_t level,
uint32_t * p_outrawdata )

Calculates the raw voltage/current associated with the A/D Module ID and given range and voltage for D0.

Parameters
modid: (Input) A/D Module ID.
range: (Input) Range Code.
level: (Input) Voltage in volts.
p_outrawdata: (Output) raw data code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToVoltage ( uint32_t modid,
nai_ad_range_t range,
uint32_t rawdata,
float64_t * p_outvoltage )

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

Parameters
modid: (Input) A/D Module ID.
range: (Input) Range Code.
rawdata: (Input) Raw Data Code.
p_outvoltage: (Output) Voltage 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_ConvertToVoltageRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToVoltageRange ( uint32_t modid,
nai_ad_range_t rawdata,
nai_ad_range_mode_t * p_outmode,
float64_t * p_outrange )

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

                                                       Voltage
     Raw Data Code           Mode                 C4      C2      C1      KA  AD1/AD4/ADE  AD5   AD2/AD6/ADF
     --------------------------------------------------------------------------------------------------------
       0x0A/0x1A       Unipolar/Bipolar         50.00   40.00     N/A     N/A     N/A      N/A       N/A
       0x09/0x19       Unipolar/Bipolar         25.00   20.00     N/A     N/A     N/A      N/A       N/A
       0x00/0x10       Unipolar/Bipolar         12.50   10.00   10.00   10.00*   10.00    50.00    100.00
       0x01/0x11       Unipolar/Bipolar          6.25    5.00    5.00    5.00*    5.00    25.00     50.00
       0x02/0x12       Unipolar/Bipolar           N/A     N/A    2.50     N/A     2.50    12.50     25.00
       0x03/0x13       Unipolar/Bipolar           N/A     N/A    1.25     N/A     1.25     6.25     12.50
     *KA module supports only bipolar mode.
Parameters
modid: (Input) A/D Module ID.
rawdata: (Input) Raw Data Code.
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_RANGE when invalid raw data range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToVoltageRangeRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToVoltageRangeRaw ( uint32_t modid,
nai_ad_range_mode_t mode,
float64_t range,
nai_ad_range_t * p_outrawdata )

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

                                                            Voltage
     Raw Data Code           Mode                 C4      C2      C1      KA  AD1/AD4/ADE  AD5   AD2/AD6/ADF
     --------------------------------------------------------------------------------------------------------
       0x0A/0x1A       Unipolar/Bipolar         50.00   40.00     N/A     N/A     N/A      N/A       N/A
       0x09/0x19       Unipolar/Bipolar         25.00   20.00     N/A     N/A     N/A      N/A       N/A
       0x00/0x10       Unipolar/Bipolar         12.50   10.00   10.00   10.00*   10.00    50.00    100.00
       0x01/0x11       Unipolar/Bipolar          6.25    5.00    5.00    5.00*    5.00    25.00     50.00
       0x02/0x12       Unipolar/Bipolar           N/A     N/A    2.50     N/A     2.50    12.50     25.00
       0x03/0x13       Unipolar/Bipolar           N/A     N/A    1.25     N/A     1.25     6.25     12.50
     *KA module supports only bipolar mode.
Parameters
modid: (Input) A/D Module ID.
mode: (Input) NAI_AD_RANGE_MODE_UNIPOLAR or NAI_AD_RANGE_MODE_BIPOLAR.
range: (Input) Voltage range in volts.
p_outrawdata: (Output) Raw Data Code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid mode and/or range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_AD_ConvertToVoltageRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_AD_ConvertToVoltageRaw ( uint32_t modid,
nai_ad_range_t range,
float64_t voltage,
uint32_t * p_outrawdata )

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

Parameters
modid: (Input) A/D Module ID.
range: (Input) Range Code.
voltage: (Input) Voltage in volts.
p_outrawdata: (Output) raw data code.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_RANGE when invalid range is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.