Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Bank Configuration Functions
Discrete Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankSourceSinkCurrent (int32_t cardIndex, int32_t module, int32_t bank, float64_t current)
 Sets Source/Sink Current configuration for the specified Discrete channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankSourceSinkCurrent (int32_t cardIndex, int32_t module, int32_t bank, float64_t *p_outcurrent)
 Retrieves Source/Sink Current configuration for the specified Discrete channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankSourceSinkCurrent_mA (int32_t cardIndex, int32_t module, int32_t bank, float64_t current_mA)
 Sets Source/Sink Current configuration for the specified Discrete channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankSourceSinkCurrent_mA (int32_t cardIndex, int32_t module, int32_t bank, float64_t *p_outcurrent_mA)
 Retrieves Source/Sink Current configuration for the specified Discrete channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankCurrentShareCfg (int32_t cardIndex, int32_t module, int32_t bank, nai_dt_cursharecfg_t config)
 Sets the current share configuration for the specified Discrete channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankCurrentShareCfg (int32_t cardIndex, int32_t module, int32_t bank, nai_dt_cursharecfg_t *p_outconfig)
 Retrieves the current share configuration for the specified Discrete channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankPullUpDownCfg (int32_t cardIndex, int32_t module, int32_t bank, nai_dt_pullconfig_t config)
 Sets the Pull-Up/Down Current Configuration for the specified Discrete channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankPullUpDownCfg (int32_t cardIndex, int32_t module, int32_t bank, nai_dt_pullconfig_t *p_outconfig)
 Retrieves the Pull-Up/Down Current Configuration for the specified Discrete channel bank.
 

Detailed Description


Function Documentation

◆ naibrd_DT_GetBankCurrentShareCfg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankCurrentShareCfg ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_dt_cursharecfg_t * p_outconfig )

Retrieves the current share configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
p_outconfig: (Output) Current Share Cfg: NAI_DT_CURSHARECFG_NONE, NAI_DT_CURSHARECFG_SH12_IND34, NAI_DT_CURSHARECFG_SH123_IND4, NAI_DT_CURSHARECFG_SH34_IND12, NAI_DT_CURSHARECFG_SH12_SH34, or NAI_DT_CURSHARECFG_ALL
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetBankPullUpDownCfg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankPullUpDownCfg ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_dt_pullconfig_t * p_outconfig )

Retrieves the Pull-Up/Down Current Configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
p_outconfig: (Output) Pull-Up/Down Current Cfg: NAI_DT_PULLCONFIG_PULLUP or NAI_DT_PULLCONFIG_PULLDOWN.
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetBankSourceSinkCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankSourceSinkCurrent ( int32_t cardIndex,
int32_t module,
int32_t bank,
float64_t * p_outcurrent )

Retrieves Source/Sink Current configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
p_outcurrent: (Output) Current (0 - 0.005) in Amps
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetBankSourceSinkCurrent_mA()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankSourceSinkCurrent_mA ( int32_t cardIndex,
int32_t module,
int32_t bank,
float64_t * p_outcurrent_mA )

Retrieves Source/Sink Current configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
p_outcurrent_mA: (Output) Current (0 - 5) 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetBankCurrentShareCfg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankCurrentShareCfg ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_dt_cursharecfg_t config )

Sets the current share configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
config: (Input) Current Share Cfg: NAI_DT_CURSHARECFG_NONE, NAI_DT_CURSHARECFG_SH12_IND34, NAI_DT_CURSHARECFG_SH123_IND4, NAI_DT_CURSHARECFG_SH34_IND12, NAI_DT_CURSHARECFG_SH12_SH34, or NAI_DT_CURSHARECFG_ALL
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter or config parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetBankPullUpDownCfg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankPullUpDownCfg ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_dt_pullconfig_t config )

Sets the Pull-Up/Down Current Configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
config: (Input) Pull-Up/Down Current Cfg: NAI_DT_PULLCONFIG_PULLUP or NAI_DT_PULLCONFIG_PULLDOWN.
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetBankSourceSinkCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankSourceSinkCurrent ( int32_t cardIndex,
int32_t module,
int32_t bank,
float64_t current )

Sets Source/Sink Current configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
current: (Input) Current (0 - 0.005) in Amps
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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_SetBankSourceSinkCurrent_mA()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetBankSourceSinkCurrent_mA ( int32_t cardIndex,
int32_t module,
int32_t bank,
float64_t current_mA )

Sets Source/Sink Current configuration for the specified Discrete channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
current_mA: (Input) Current (0 - 5) 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.