Software Library API naibrd 2.24.0
See all documentation at naii.docs.com

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToAngle (uint32_t modId, uint32_t rawData, float64_t *p_outAngle)
 Converts raw angle data to an angle value in degrees.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToAngleRaw (uint32_t modId, float64_t angle, uint32_t *p_outRawData)
 Converts Angle value to raw angle value.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToVelocity (uint32_t modId, uint32_t rawData, float64_t velScale, float64_t *p_outVelocity)
 Converts raw velocity data to a velocity value in RPS.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToFrequency (uint32_t modId, uint32_t rawData, float64_t *p_outFreq)
 Converts raw frequency data to a frequency value represented as a 64 bit float.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToVoltage (uint32_t modId, uint32_t rawData, float64_t *p_outVoltage)
 Converts raw voltage data to a voltage value represented as a 64 bit float.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToVoltageRaw (uint32_t modId, float64_t voltage, uint32_t *p_outRawData)
 Converts scaled voltage value to raw voltage data.
 

Detailed Description

Function Documentation

◆ naibrd_SD_ConvertToAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToAngle ( uint32_t modId,
uint32_t rawData,
float64_t * p_outAngle )

Converts raw angle data to an angle value in degrees.

Parameters
modId: (Input) SD Module ID.
rawData: (Input) Raw angle data.
p_outAngle: (Output) Angle value in degrees.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ConvertToAngleRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToAngleRaw ( uint32_t modId,
float64_t angle,
uint32_t * p_outRawData )

Converts Angle value to raw angle value.

Parameters
modId: (Input) SD Module ID.
angle: (Input) Angle value.
p_outRawData: (Output) Raw angle value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_VALUE when invalid angle parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ConvertToFrequency()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToFrequency ( uint32_t modId,
uint32_t rawData,
float64_t * p_outFreq )

Converts raw frequency data to a frequency value represented as a 64 bit float.

Parameters
modId: (Input) SD Module ID.
rawData: (Input) Raw frequency value.
p_outFreq: (Output) Frequency value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ConvertToVelocity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToVelocity ( uint32_t modId,
uint32_t rawData,
float64_t velScale,
float64_t * p_outVelocity )

Converts raw velocity data to a velocity value in RPS.

Parameters
modId: (Input) SD Module ID.
rawData: (Input) Raw velocity data.
velScale: (Input) Velocity scale data.
p_outVelocity: (Output) Velocity value in RPS.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_VALUE when invalid velScale parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ConvertToVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToVoltage ( uint32_t modId,
uint32_t rawData,
float64_t * p_outVoltage )

Converts raw voltage data to a voltage value represented as a 64 bit float.

Parameters
modId: (Input) SD Module ID.
rawData: (Input) Raw Voltage Data.
p_outVoltage: (Output) Voltage value as a float.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ConvertToVoltageRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ConvertToVoltageRaw ( uint32_t modId,
float64_t voltage,
uint32_t * p_outRawData )

Converts scaled voltage value to raw voltage data.

Parameters
modId: (Input) SD Module ID.
voltage: (Input) Scaled Voltage value.
p_outRawData: (Output) Raw voltage value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.