Software Library API naibrd 1.62
See all documentation at naii.docs.com
|
Functions | |
NAIBRDFUNC nai_status_t | naibrd_PWM_SetDutyLimit (int32_t cardIndex, int32_t module, int32_t channel, float32_t dutyLimitPercent) |
Sets the output stage's duty cycle. Range is 0.0 to 50.0. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetDutyLimit (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outdutyLimitPercent) |
Retrieves the output stage's duty cycle. Range is 0.0 to 50.0. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetDriveMode (int32_t cardIndex, int32_t module, nai_pwm_drive_mode_t mode) |
Sets the PWM Drive Mode. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetDriveMode (int32_t cardIndex, int32_t module, nai_pwm_drive_mode_t *p_outmode) |
Retrieves the PWM Drive Mode. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetSource (int32_t cardIndex, int32_t module, nai_pwm_source_t source) |
Sets the PWM Source. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetSource (int32_t cardIndex, int32_t module, nai_pwm_source_t *p_outsource) |
Retrieves the PWM Source. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetCurrentLimit (int32_t cardIndex, int32_t module, int32_t channel, float32_t limit_mA) |
Sets the Current Limit for the PWM channel. The Current Limit value must between 0 and +9.995 Amps. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetCurrentLimit (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outlimit_mA) |
Retrieves the Current Limit for the PWM channel. The Current Limit value must between 0 and +9.995 Amps. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetInputScale (int32_t cardIndex, int32_t module, int32_t channel, int32_t scale) |
Sets the Input Scale (Kc) for the PWM channel. The Input Scale value must be between -32768 (gain = -1) and 32767 (gain = 1). Setting a negative gain value will result in the polarity reversal of the command. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetInputScale (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outscale) |
Retrieves the Input Scale (Kc) for the PWM channel. The Input Scale value must be between -32768 (gain = -1) and 32767 (gain = 1). A negative gain value will result in the polarity reversal of the command. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetGlobalGain (int32_t cardIndex, int32_t module, int32_t channel, int32_t gain) |
Sets the Global Gain (Kg) for the PWM channel. The Global Gain value must be between -32768 (gain = -10) and 32767 (gain = 10). Setting a negative gain value will result in the polarity reversal of the error term. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetGlobalGain (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outgain) |
Retrieves the Global Gain (Kg) for the PWM channel. The Global Gain value must be between -32768 (gain = -10) and 32767 (gain = 10). A negative gain value will result in the polarity reversal of the error term. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetIntegralGain (int32_t cardIndex, int32_t module, int32_t channel, int32_t gain) |
Sets the Integral Gain (Ki) for the PWM channel. The Integral Gain value must be between -32768 (gain = -1) and 32767 (gain = 1). Setting a negative gain value will result in the polarity reversal of the error term. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetIntegralGain (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outgain) |
Retrieves the Integral Gain (Ki) for the PWM channel. The Integral Gain value must be between -32768 (gain = -1) and 32767 (gain = 1). A negative gain value will result in the polarity reversal of the error term. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetProportionalGain (int32_t cardIndex, int32_t module, int32_t channel, int32_t gain) |
Sets the Proportional Gain (Kp) for the PWM channel. The Proportional Gain value must be between -32768 (gain = -2) and 32767 (gain = 2). Setting a negative gain value will result in the polarity reversal of the error term. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetProportionalGain (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outgain) |
Retrieves the Proportional Gain (Kp) for the PWM channel. The Proportional Gain value must be between -32768 (gain = -1) and 32767 (gain = 1). A negative gain value will result in the polarity reversal of the error term.. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_SetPITermLimit (int32_t cardIndex, int32_t module, int32_t channel, int32_t limit) |
Sets the PI Terminal Limit for the PWM channel. The PI Terminal Limit value must be greater than 0 and less than 65536. | |
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PWM_GetPITermLimit (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outlimit) |
Retrieves the PI Terminal Limit for the PWM channel. The PI Terminal Limit value must be greater than 0 and less than 65536. | |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetCurrentLimit | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float32_t * | p_outlimit_mA ) |
Retrieves the Current Limit for the PWM channel. The Current Limit value must between 0 and +9.995 Amps.
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_outlimit_mA | : (Output) Current Limit in milliamps. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDriveMode | ( | int32_t | cardIndex, |
int32_t | module, | ||
nai_pwm_drive_mode_t * | p_outmode ) |
Retrieves the PWM Drive Mode.
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_outmode | : (Output) NAI_PWM_CURRENT_DRIVE or NAI_PWM_VOLTAGE_DRIVE. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetDutyLimit | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float32_t * | p_outdutyLimitPercent ) |
Retrieves the output stage's duty cycle. Range is 0.0 to 50.0.
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_outdutyLimitPercent | : (Output) duty limit percent. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetGlobalGain | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t * | p_outgain ) |
Retrieves the Global Gain (Kg) for the PWM channel. The Global Gain value must be between -32768 (gain = -10) and 32767 (gain = 10). A negative gain value will result in the polarity reversal of the error term.
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_outgain | : (Output) Global Gain. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetInputScale | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t * | p_outscale ) |
Retrieves the Input Scale (Kc) for the PWM channel. The Input Scale value must be between -32768 (gain = -1) and 32767 (gain = 1). A negative gain value will result in the polarity reversal of the command.
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_outscale | : (Output) Input Scale. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetIntegralGain | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t * | p_outgain ) |
Retrieves the Integral Gain (Ki) for the PWM channel. The Integral Gain value must be between -32768 (gain = -1) and 32767 (gain = 1). A negative gain value will result in the polarity reversal of the error term.
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_outgain | : (Output) Global Gain. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetPITermLimit | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t * | p_outlimit ) |
Retrieves the PI Terminal Limit for the PWM channel. The PI Terminal Limit value must be greater than 0 and less than 65536.
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_outlimit | : (Output) PI Terminal Limit. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetProportionalGain | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t * | p_outgain ) |
Retrieves the Proportional Gain (Kp) for the PWM channel. The Proportional Gain value must be between -32768 (gain = -1) and 32767 (gain = 1). A negative gain value will result in the polarity reversal of the error term..
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_outgain | : (Output) Proportional Gain. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetSource | ( | int32_t | cardIndex, |
int32_t | module, | ||
nai_pwm_source_t * | p_outsource ) |
Retrieves the PWM Source.
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_outsource | : (Output) NAI_PWM_SOURCE_SERIAL or NAI_PWM_SOURCE_OTHER. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetCurrentLimit | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float32_t | limit_mA ) |
Sets the Current Limit for the PWM channel. The Current Limit value must between 0 and +9.995 Amps.
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]). |
limit_mA | : (Input) Current Limit in milliamps. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetDriveMode | ( | int32_t | cardIndex, |
int32_t | module, | ||
nai_pwm_drive_mode_t | mode ) |
Sets the PWM Drive Mode.
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]). |
mode | : (Input) NAI_PWM_CURRENT_DRIVE or NAI_PWM_VOLTAGE_DRIVE. |
NAIBRDFUNC nai_status_t naibrd_PWM_SetDutyLimit | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float32_t | dutyLimitPercent ) |
Sets the output stage's duty cycle. Range is 0.0 to 50.0.
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]). |
dutyLimitPercent | : (Input) duty limit percent. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetGlobalGain | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t | gain ) |
Sets the Global Gain (Kg) for the PWM channel. The Global Gain value must be between -32768 (gain = -10) and 32767 (gain = 10). Setting a negative gain value will result in the polarity reversal of the error term.
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]). |
gain | : (Input) Global Gain. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetInputScale | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t | scale ) |
Sets the Input Scale (Kc) for the PWM channel. The Input Scale value must be between -32768 (gain = -1) and 32767 (gain = 1). Setting a negative gain value will result in the polarity reversal of the command.
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]). |
scale | : (Input) Input Scale. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetIntegralGain | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t | gain ) |
Sets the Integral Gain (Ki) for the PWM channel. The Integral Gain value must be between -32768 (gain = -1) and 32767 (gain = 1). Setting a negative gain value will result in the polarity reversal of the error term.
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]). |
gain | : (Input) Integral Gain. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetPITermLimit | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t | limit ) |
Sets the PI Terminal Limit for the PWM channel. The PI Terminal Limit value must be greater than 0 and less than 65536.
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]). |
limit | : (Input) PI Terminal Limit. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetProportionalGain | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
int32_t | gain ) |
Sets the Proportional Gain (Kp) for the PWM channel. The Proportional Gain value must be between -32768 (gain = -2) and 32767 (gain = 2). Setting a negative gain value will result in the polarity reversal of the error term.
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]). |
gain | : (Input) Proportional Gain. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetSource | ( | int32_t | cardIndex, |
int32_t | module, | ||
nai_pwm_source_t | source ) |
Sets the PWM Source.
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]). |
source | : (Input) NAI_PWM_SOURCE_SERIAL or NAI_PWM_SOURCE_OTHER. |