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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_ioformat_t format)
 Sets the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_ioformat_t *outformat)
 Retrieves the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetOpMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_enhanced_mode_t mode)
 Sets the Operation mode for the specified TTL channel. Default power on configuration for the channels is Input. Selection of one of the basic modes will switch to transceiver (basic) mode operation with no signal processing.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetEnhanceTriggerEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_enable_t enable)
 Sets operation to disabled or enabled for specified TTL channel.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetEnhanceTriggerEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_enable_t *outenable)
 Retrieves the present enhance operation enable state for the specified Discrete channel. Power on default configuration for the channels is Enhanced Input.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetOpMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ttl_enhanced_mode_t *outmode)
 Retrieves the Operation mode for the specified TTL channel. Retrieves either Basic/Transceiver modes or other modes, depending whether the Transceiver mode is enabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetBankVCCSource (int32_t cardIndex, int32_t module, int32_t bank, nai_ttl_vcc_t source)
 Sets the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCSource (int32_t cardIndex, int32_t module, int32_t bank, nai_ttl_vcc_t *outsource)
 Retrieves the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCReading (int32_t cardIndex, int32_t module, int32_t bank, float64_t *outvoltage)
 Retrieves the Vcc voltage reading for the specified TTL bank, reading is returned in volts. This feature is only supported on X2 TTL modules and up.
 

Detailed Description


Function Documentation

◆ naibrd_TTL_GetBankVCCReading()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCReading ( int32_t cardIndex,
int32_t module,
int32_t bank,
float64_t * outvoltage )

Retrieves the Vcc voltage reading for the specified TTL bank, reading is returned in volts. This feature is only supported on X2 TTL modules and up.

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) Number of the bank set(1 - [max banks for module]).
outvoltage: (Output) Available operation modes: NAI_TTL_VCC_EXTERNAL NAI_TTL_VCC_INTERNAL
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetBankVCCSource()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetBankVCCSource ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_ttl_vcc_t * outsource )

Retrieves the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.

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) Number of the bank set(1 - [max banks for module]).
outsource: (Output) Available operation modes: NAI_TTL_VCC_EXTERNAL NAI_TTL_VCC_INTERNAL
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetEnhanceTriggerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetEnhanceTriggerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_enable_t * outenable )

Retrieves the present enhance operation enable state for the specified Discrete channel. Power on default configuration for the channels is Enhanced Input.

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]).
outenable: (Output) Refer to nai_ttl_enable_t definitions.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetIOFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetIOFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_ioformat_t * outformat )

Retrieves the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.

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]).
outformat: (Output) NAI_TTL_IOFORMAT_INPUT, NAI_TTL_GEN5_IOFORMAT_OUTPUT or NAI_TTL_GEN3_IOFORMAT_OUTPUT.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetOpMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetOpMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_enhanced_mode_t * outmode )

Retrieves the Operation mode for the specified TTL channel. Retrieves either Basic/Transceiver modes or other modes, depending whether the Transceiver mode is enabled.

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]).
outmode: (Input) Available operation modes: Refer to nai_ttl_mode_t mode selections.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetBankVCCSource()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetBankVCCSource ( int32_t cardIndex,
int32_t module,
int32_t bank,
nai_ttl_vcc_t source )

Sets the Vcc source to internal or external for the specified TTL bank. Power on default is internal Vcc.

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) Number of the bank set(1 - [max banks for module]).
source: (Input) Available operation modes: NAI_TTL_VCC_EXTERNAL NAI_TTL_VCC_INTERNAL
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetEnhanceTriggerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetEnhanceTriggerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_enable_t enable )

Sets operation to disabled or enabled for specified TTL channel.

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) Refer to nai_ttl_enable_t definitions.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetIOFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetIOFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_ioformat_t format )

Sets the Input/Output configuration for the specified TTL channel. Default configuration for the channels is input.

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]).
format: (Input) NAI_TTL_IOFORMAT_INPUT, NAI_TTL_GEN5_IOFORMAT_OUTPUT or NAI_TTL_GEN3_IOFORMAT_OUTPUT.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetOpMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetOpMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ttl_enhanced_mode_t mode )

Sets the Operation mode for the specified TTL channel. Default power on configuration for the channels is Input. Selection of one of the basic modes will switch to transceiver (basic) mode operation with no signal processing.

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]).
mode: (Input) Available operation modes: Refer to nai_ttl_mode_t mode selections.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.