Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SetCurrent (int32_t cardIndex, int32_t module, int32_t channel, float32_t current_mA)
	Sets the PWM Current Command. The Current value must between -8.5 and +8.496 Amps.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetCurrent (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outcurrent_mA)
	Retrieves the PWM Current Command. The Current value must between -8.5 and +8.496 Amps.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float32_t voltage)
	Sets the PWM Voltage Command. The Voltage value must between -80.0 and +79.9610 Volts.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outvoltage)
	Retrieves the PWM Voltage Command. The Voltage value must between -80.0 and +79.9610 Volts.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SetDriveEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
	Enables or disables the PWM Drive.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetDriveEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
	Retrieves the PWM Drive Enable state.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_ResetDrive (int32_t cardIndex, int32_t module, int32_t channel)
	This register is used to clear all fail conditions related to the channel output in the STATUS REGISTER.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetDACOutput (int32_t cardIndex, int32_t module, int32_t dacChannel, float32_t *p_outvoltage)
	Retrieves the DAC Output. The DAC Output Voltage is between -10.0 and +9.995 Volts.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetADCInput (int32_t cardIndex, int32_t module, int32_t adcChannel, float32_t *p_outvoltage)
	Retrieves the ADC Input. The Voltage value must between -10.24 and +10.24 Volts.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SetADCEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
	Sets the enable or disable state of the ADC input test word for either transmission over the RS␂422 SDLC interface or injection into the PWM module channel control loop summing junctions. Destination of the ADC input is determined in the ADC_INPUT_DESTINATION_SELECT register.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetADCEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
	Retrieves the ADC Input Enable state. This is used to enable or disable the ADC input test word for either transmission over the RS␂422 SDLC interface or injection into the PWM module channel control loop summing junctions. Destination of the ADC input is determined in the ADC_INPUT_DESTINATION_SELECT register.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SetADCSource (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_adc_source_t source)
	Sets the ADC Input Source. This is used to select the destination for the ADC Test Input Word. The available destinations are either the RS-422 SDLC interface or the summing junctions of the PWM Channel Loop Controllers. The purpose is to allow Lab analysis of the PWM loop controller for verification purposes of the loop characteristics.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetADCSource (int32_t cardIndex, int32_t module, int32_t channel, nai_pwm_adc_source_t *p_outsource)
	Retrieves the ADC Input Source. This is used to select the destination for the ADC Test Input Word. The available destinations are either the RS-422 SDLC interface or the summing junctions of the PWM Channel Loop Controllers. The purpose is to allow Lab analysis of the PWM loop controller for verification purposes of the loop characteristics.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetMeasuredCurrent (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outcurrent_mA)
	Retrieves the PWM Channel's measured motor current value. 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_GetMeasuredVoltage (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outvoltage)
	Retrieves the PWM Channel's motor voltage measurement. 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_GetMeasuredInputVoltage (int32_t cardIndex, int32_t module, float32_t *p_outvoltage)
	Retrieves the PWM's Input Voltage Measurement of the +65V on-board supply.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetMeasuredTemperature (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtemp_C)
	Retrieves the PWM Channel's Drive Temperature Measurement.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetMeasuredPSVoltage (int32_t cardIndex, int32_t module, float32_t *p_outvoltage)
	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_GetMeasuredPSCurrent (int32_t cardIndex, int32_t module, float32_t *p_outcurrent)
	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_GetMeasuredPSTemperature (int32_t cardIndex, int32_t module, int32_t *p_outtemp_C)
	Retrieves the PWM on-board Power Supply's Temperature Measurement. Range is -32768..32767 degrees C.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SoftReset (int32_t cardIndex, int32_t module)
	Resets the PWM and PS modules. Upon receiving the soft reset command, both the PWM and PS re-initializes to the power-on state. This routine will write a "1" and wait 1 msec before writing a "0" to initiate the reset. Depending on configuration, the reboot can take up to 3 seconds.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SetBattlefieldOverrideEnable (int32_t cardIndex, int32_t module, bool_t enable)
	Enables or disables the Battlefield Override which is used to lockout all fail-safe features within the PWM and PS. When enabled, no intervention of the protection circuitry to shut the drive off to either PWM channel is allowed (except for Watchdog Timer), however the status of any protection logic shall be updated.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetBattlefieldOverrideEnable (int32_t cardIndex, int32_t module, bool_t *p_outenable)
	Retrieves the Enable state for the Battlefield Override which is used to lockout all fail-safe features within the PWM and PS. When enabled, no intervention of the protection circuitry to shut the drive off to either PWM channel is allowed (except for Watchdog Timer), however the status of any protection logic shall be updated.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_SetPSOverTempOverrideEnable (int32_t cardIndex, int32_t module, bool_t enable)
	Enables or disables the Power Supply Over-temperature Shutdown Override.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetPSOverTempOverrideEnable (int32_t cardIndex, int32_t module, bool_t *p_outenable)
	Retrieves the Enable state for the Power Supply Over-temperature Shutdown Override.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_IsBoardReady (int32_t cardIndex, int32_t module)
	Retrieves the PWM Board Ready Status.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_GetStatusLatched (int32_t cardIndex, int32_t module, nai_pwm_status_t *p_outstatus)
	Retrieves the PWM Latched Status.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_PWM_ClearStatus (int32_t cardIndex, int32_t module)
	Clears the PWM's Latched Status.

Detailed Description

Function Documentation

◆ naibrd_PWM_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_ClearStatus	(	int32_t	cardIndex,
		int32_t	module )

Clears the PWM's Latched Status.

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]).

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_GetADCEnable()

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

Retrieves the ADC Input Enable state. This is used to enable or disable the ADC input test word for either transmission over the RS␂422 SDLC interface or injection into the PWM module channel control loop summing junctions. Destination of the ADC input is determined in the ADC_INPUT_DESTINATION_SELECT register.

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 ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetADCInput()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetADCInput	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	adcChannel,
		float32_t *	p_outvoltage )

Retrieves the ADC Input. The Voltage value must between -10.24 and +10.24 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]).
adcChannel	: (Input) Channel Number of the ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
p_outvoltage	: (Output) ADC Input 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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetADCSource()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetADCSource	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_pwm_adc_source_t *	p_outsource )

Retrieves the ADC Input Source. This is used to select the destination for the ADC Test Input Word. The available destinations are either the RS-422 SDLC interface or the summing junctions of the PWM Channel Loop Controllers. The purpose is to allow Lab analysis of the PWM loop controller for verification purposes of the loop characteristics.

NOTE : Only channel 1 of the ADC debug input is fed into the summing junction of the current loop.

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 ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
p_outsource	: (Output) NAI_PWM_ADC_SOURCE_SERIAL, NAI_PWM_ADC_SOURCE_ETHERNET, NAI_PWM_ADC_SOURCE_PWM_CH1, or NAI_PWM_ADC_SOURCE_PWM_CH2 (for PWMs that support Channel 2).

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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetBattlefieldOverrideEnable()

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

Retrieves the Enable state for the Battlefield Override which is used to lockout all fail-safe features within the PWM and PS. When enabled, no intervention of the protection circuitry to shut the drive off to either PWM channel is allowed (except for Watchdog Timer), however the status of any protection logic shall be updated.

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	: (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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetCurrent()

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

Retrieves the PWM Current Command. The Current value must between -8.5 and +8.496 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_outcurrent_mA	: (Output) Current in milliamps.

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_GetDACOutput()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDACOutput	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	dacChannel,
		float32_t *	p_outvoltage )

Retrieves the DAC Output. The DAC Output Voltage is between -10.0 and +9.995 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]).
dacChannel	: (Input) Channel Number of the DAC channel to access (1 - MAX_PWM_DAC_CHANNELS).
p_outvoltage	: (Output) DAC Output.

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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetDriveEnable()

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

Retrieves the PWM Drive 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]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
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_GetMeasuredCurrent()

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

Retrieves the PWM Channel's measured motor current value. 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]).
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_GetMeasuredInputVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetMeasuredInputVoltage	(	int32_t	cardIndex,
		int32_t	module,
		float32_t *	p_outvoltage )

Retrieves the PWM's Input Voltage Measurement of the +65V on-board supply.

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_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_GetMeasuredPSCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetMeasuredPSCurrent	(	int32_t	cardIndex,
		int32_t	module,
		float32_t *	p_outcurrent )

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]).
p_outcurrent	: (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_GetMeasuredPSTemperature()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetMeasuredPSTemperature	(	int32_t	cardIndex,
		int32_t	module,
		int32_t *	p_outtemp_C )

Retrieves the PWM on-board Power Supply's Temperature Measurement. Range is -32768..32767 degrees C.

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_outtemp_C	: (Output) Measured Temperature in Celsius.

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_GetMeasuredPSVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetMeasuredPSVoltage	(	int32_t	cardIndex,
		int32_t	module,
		float32_t *	p_outvoltage )

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]).
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetMeasuredTemperature()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetMeasuredTemperature	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		int32_t *	p_outtemp_C )

Retrieves the PWM Channel's Drive Temperature Measurement.

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_outtemp_C	: (Output) Measured Temperature in Celsius.

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_GetMeasuredVoltage()

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

Retrieves the PWM Channel's motor voltage measurement. 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]).
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_GetPSOverTempOverrideEnable()

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

Retrieves the Enable state for the Power Supply Over-temperature Shutdown Override.

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	: (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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetStatusLatched()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetStatusLatched	(	int32_t	cardIndex,
		int32_t	module,
		nai_pwm_status_t *	p_outstatus )

Retrieves the PWM Latched Status.

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_outstatus	: (Output) PWM Status - refer to nai_pwm_status_t definition.

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_GetVoltage()

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

Retrieves the PWM Voltage Command. 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]).
p_outvoltage	: (Output) 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_IsBoardReady()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_IsBoardReady	(	int32_t	cardIndex,
		int32_t	module )

Retrieves the PWM Board Ready Status.

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]).

Returns

NAI_SUCCESS when the value in the Board Ready register is set to NAI_GEN3_BOARD_READY.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_READY when the value in the Board Ready register is not set to NAI_GEN3_BOARD_READY.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_ResetDrive()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_ResetDrive	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel )

This register is used to clear all fail conditions related to the channel output in the STATUS REGISTER.

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]).

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_SetADCEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetADCEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	enable )

Sets the enable or disable state of the ADC input test word for either transmission over the RS␂422 SDLC interface or injection into the PWM module channel control loop summing junctions. Destination of the ADC input is determined in the ADC_INPUT_DESTINATION_SELECT register.

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 ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetADCSource()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetADCSource	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_pwm_adc_source_t	source )

Sets the ADC Input Source. This is used to select the destination for the ADC Test Input Word. The available destinations are either the RS-422 SDLC interface or the summing junctions of the PWM Channel Loop Controllers. The purpose is to allow Lab analysis of the PWM loop controller for verification purposes of the loop characteristics.

NOTE : Only channel 1 of the ADC debug input is fed into the summing junction of the current loop.

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 ADC channel to access (1 - MAX_PWM_ADC_CHANNELS).
source	: (Input) NAI_PWM_ADC_SOURCE_SERIAL, NAI_PWM_ADC_SOURCE_ETHRNET, NAI_PWM_ADC_SOURCE_PWM_CH1, or NAI_PWM_ADC_SOURCE_PWM_CH2 (for PWMs that support Channel 2).

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_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetBattlefieldOverrideEnable()

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

Enables or disables the Battlefield Override which is used to lockout all fail-safe features within the PWM and PS. When enabled, no intervention of the protection circuitry to shut the drive off to either PWM channel is allowed (except for Watchdog Timer), however the status of any protection logic shall be updated.

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_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetCurrent	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t	current_mA )

Sets the PWM Current Command. The Current value must between -8.5 and +8.496 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]).
current_mA	: (Input) Current in milliamps.

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_SetDriveEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetDriveEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	enable )

Enables or disables the PWM Drive.

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]).
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.

◆ naibrd_PWM_SetPSOverTempOverrideEnable()

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

Enables or disables the Power Supply Over-temperature Shutdown Override.

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_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetVoltage	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t	voltage )

Sets the PWM Voltage Command. 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]).
voltage	: (Input) 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_INVALID_VALUE when invalid value parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SoftReset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SoftReset	(	int32_t	cardIndex,
		int32_t	module )

Resets the PWM and PS modules. Upon receiving the soft reset command, both the PWM and PS re-initializes to the power-on state. This routine will write a "1" and wait 1 msec before writing a "0" to initiate the reset. Depending on configuration, the reboot can take up to 3 seconds.

The soft reset disables the PWM card�s current controller functionality. Both the drive PWMs and fault reporting is disabled. During reset, read/writes to the defined registers are still possible.

Taking the controller OUT of soft reset will set all defined registers to their DEFAULT 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]).

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.

Functions

Detailed Description

Function Documentation

◆ naibrd_PWM_ClearStatus()

◆ naibrd_PWM_GetADCEnable()

◆ naibrd_PWM_GetADCInput()

◆ naibrd_PWM_GetADCSource()

◆ naibrd_PWM_GetBattlefieldOverrideEnable()

◆ naibrd_PWM_GetCurrent()

◆ naibrd_PWM_GetDACOutput()

◆ naibrd_PWM_GetDriveEnable()

◆ naibrd_PWM_GetMeasuredCurrent()

◆ naibrd_PWM_GetMeasuredInputVoltage()

◆ naibrd_PWM_GetMeasuredPSCurrent()

◆ naibrd_PWM_GetMeasuredPSTemperature()

◆ naibrd_PWM_GetMeasuredPSVoltage()

◆ naibrd_PWM_GetMeasuredTemperature()

◆ naibrd_PWM_GetMeasuredVoltage()

◆ naibrd_PWM_GetPSOverTempOverrideEnable()

◆ naibrd_PWM_GetStatusLatched()

◆ naibrd_PWM_GetVoltage()

◆ naibrd_PWM_IsBoardReady()

◆ naibrd_PWM_ResetDrive()

◆ naibrd_PWM_SetADCEnable()

◆ naibrd_PWM_SetADCSource()

◆ naibrd_PWM_SetBattlefieldOverrideEnable()

◆ naibrd_PWM_SetCurrent()

◆ naibrd_PWM_SetDriveEnable()

◆ naibrd_PWM_SetPSOverTempOverrideEnable()

◆ naibrd_PWM_SetVoltage()

◆ naibrd_PWM_SoftReset()