Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Interrupt Functions
Relay Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, bool_t enable)
 Sets the Interrupt Enable for the specified RLY channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, bool_t *outenable)
 Retrieves the Interrupt Enable setting for the specified RLY channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, nai_rly_interrupt_t interruptType)
 Sets the Interrupt Edge/Level property for the specified RLY channel and interrupt status type. Determines whether an interrupt condition can retrigger on the same occurrence without clearing first.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetEdgeLevelInterrupt (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, nai_rly_interrupt_t *outinterruptType)
 Retrieves the Interrupt Edge/Level property for the specified RLY channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, uint32_t vector)
 Sets the Interrupt Vector for the specified RLY channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetGroupInterruptVector (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, uint32_t *outvector)
 Retrieves the Interrupt Vector for the specified RLY channel and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, naibrd_int_steering_t steering)
 Sets the Interrupt Steering which indicates the interrupt direction for the specified RLY group and interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetGroupInterruptSteering (int32_t cardIndex, int32_t module, int32_t group, nai_rly_status_type_t type, naibrd_int_steering_t *outsteering)
 Retrieves the Interrupt Steering which indicates the interrupt direction for the specified RLY group and interrupt status type.
 

Detailed Description


Function Documentation

◆ naibrd_RLY_GetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rly_status_type_t type,
nai_rly_interrupt_t * outinterruptType )

Retrieves the Interrupt Edge/Level property for the specified RLY channel and interrupt status type.

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]).
type: (Input) Status Type: Refer to nai_rly_status_type_t definitions.
outinterruptType: (Output) Interrupt trigger mode: Refer to nai_rly_interrupt_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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_GetGroupInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetGroupInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_rly_status_type_t type,
naibrd_int_steering_t * outsteering )

Retrieves the Interrupt Steering which indicates the interrupt direction for the specified RLY group and interrupt status type.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_rly_status_type_t definition.
outsteering: (Output) Interrupt Steering: refer to naibrd_int_steering_t definition.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_GetGroupInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetGroupInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_rly_status_type_t type,
uint32_t * outvector )

Retrieves the Interrupt Vector for the specified RLY channel and interrupt status type.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_rly_status_type_t definitions (Latched types only).
outvector: (Output) Interrupt Vector.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rly_status_type_t type,
bool_t * outenable )

Retrieves the Interrupt Enable setting for the specified RLY channel and interrupt status type.

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]).
type: (Input) Status Type: refer to nai_rly_status_type_t definitions (Latched types only).
outenable: (Output) 0: disabled, 1: enabled.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_SetEdgeLevelInterrupt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetEdgeLevelInterrupt ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rly_status_type_t type,
nai_rly_interrupt_t interruptType )

Sets the Interrupt Edge/Level property for the specified RLY channel and interrupt status type. Determines whether an interrupt condition can retrigger on the same occurrence without clearing first.

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]).
type: (Input) Status Type: Refer to nai_rly_status_type_t definition.
interruptType: (Input) Interrupt Type: Refer to nai_rly_interrupt_t definition.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_SetGroupInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetGroupInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_rly_status_type_t type,
naibrd_int_steering_t steering )

Sets the Interrupt Steering which indicates the interrupt direction for the specified RLY group and interrupt status type.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_rly_status_type_t definition.
steering: (Input) Interrupt Steering: refer to naibrd_int_steering_t definition.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_SetGroupInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetGroupInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_rly_status_type_t type,
uint32_t vector )

Sets the Interrupt Vector for the specified RLY channel and interrupt status type.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Status Type: refer to nai_rly_status_type_t definitions (Latched types only).
vector: (Input) Interrupt Vector.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rly_status_type_t type,
bool_t enable )

Sets the Interrupt Enable for the specified RLY channel and interrupt status type.

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]).
type: (Input) Status Type: refer to nai_rly_status_type_t definitions (Latched types only).
enable: (Input) 0 to disable, 1 to enable interrupt.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.