Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
VPX68PW2 Specific Standard Operation Functions
PWM Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDriveMeasureCurrent (int32_t cardIndex, int32_t module, int32_t channel, int32_t drive, float32_t *p_outcurrent_mA)
 Retrieves the PWM Channel's measured motor current value for the specified drive. Overflow or underflow values shall be clamped at the maximum positive or negative values. . The Current value must between -10.0 and +9.9995 Amps.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDriveMeasureVoltage (int32_t cardIndex, int32_t module, int32_t channel, int32_t drive, float32_t *p_outvoltage)
 Retrieves the PWM Channel's measured motor voltage value for the specified drive. Overflow or underflow values shall be clamped at the maximum positive or negative values. The Voltage value must between -80.0 and +79.9610 Volts.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetPSCurrentMeasure (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outpscurrent)
 Retrieves the PWM on-board Power Supply's Current Measurement. The Current value must between 0.0 and 65.984 Amps.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetPSVoltageMeasure (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outpsvoltage)
 Retrieves the PWM Power Suppy's Voltage Measurement. The Voltage value must between -80.0 and +79.9610 Volts. Overflow or underflow values shall be clamped at the maximum positive or negative values.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetInputPSEnable (int32_t cardIndex, int32_t module, bool_t enable)
 Enables or disables the PWM Input PS.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetInputPSEnable (int32_t cardIndex, int32_t module, bool_t *p_outenable)
 Retrieves the PWM Input PS Enable state.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetHallState (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_hall_state_t *p_outhallState)
 Retrieves the state of the PWM hall effect sensor.
 

Detailed Description


Function Documentation

◆ naibrd_PWM_GetDriveMeasureCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDriveMeasureCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t drive,
float32_t * p_outcurrent_mA )

Retrieves the PWM Channel's measured motor current value for the specified drive. Overflow or underflow values shall be clamped at the maximum positive or negative values. . The Current value must between -10.0 and +9.9995 Amps.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
drive: (Input) Drive Number of the drive to access (1 - VPX68PW2_DRIVE_CHANS).
p_outcurrent_mA: (Output) Measured Current in mA .
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetDriveMeasureVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDriveMeasureVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t drive,
float32_t * p_outvoltage )

Retrieves the PWM Channel's measured motor voltage value for the specified drive. Overflow or underflow values shall be clamped at the maximum positive or negative values. The Voltage value must between -80.0 and +79.9610 Volts.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
drive: (Input) Drive Number of the drive to access (1 - VPX68PW2_DRIVE_CHANS).
p_outvoltage: (Output) Measured voltage in volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetHallState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetHallState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_pwm_hall_state_t * p_outhallState )

Retrieves the state of the PWM hall effect sensor.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outhallState: (Output) State of the hall effect sensor of type nai_pwm_hall_state_t.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetInputPSEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetInputPSEnable ( int32_t cardIndex,
int32_t module,
bool_t * p_outenable )

Retrieves the PWM Input PS Enable state.

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]).
p_outenable: (Output) Enables (1) or Disables (0).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetPSCurrentMeasure()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetPSCurrentMeasure ( int32_t cardIndex,
int32_t module,
int32_t channel,
float32_t * p_outpscurrent )

Retrieves the PWM on-board Power Supply's Current Measurement. The Current value must between 0.0 and 65.984 Amps.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outpscurrent: (Output) Measured voltage in volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetPSVoltageMeasure()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetPSVoltageMeasure ( int32_t cardIndex,
int32_t module,
int32_t channel,
float32_t * p_outpsvoltage )

Retrieves the PWM Power Suppy's Voltage Measurement. The Voltage value must between -80.0 and +79.9610 Volts. Overflow or underflow values shall be clamped at the maximum positive or negative values.

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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outpsvoltage: (Output) Measured PS voltage in volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetInputPSEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetInputPSEnable ( int32_t cardIndex,
int32_t module,
bool_t enable )

Enables or disables the PWM Input PS.

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]).
enable: (Input) Enables (1) or Disables (0).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.