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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, bool_t enable)
 Sets the bit corresponding to the specified SG Channel in the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Interrupt Enable register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, bool_t *outenable)
 Retrieves the bit corresponding to the specified SG Channel in the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Interrupt Enable register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptVector (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t vector)
 This function will set the vector for the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptVector (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t *outvector)
 This function will read the vector for the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, nai_sg_edgelevel_t edgelevel)
 Sets the bit corresponding to the specified SG channel in the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 edge/level interrupt register. This function only applies to modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, nai_sg_edgelevel_t *outedgelevel)
 Retrieves the bit corresponding to the specified SG channel in the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 edge/level interrupt register. This function only applies to modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, naibrd_int_steering_t steering)
 This function will set the interrupt steering, which indicates the interrupt direction, for the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt. This function only applies to modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, naibrd_int_steering_t *outsteering)
 This function retrieves the interrupt steering, which indicates the interrupt direction, for the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt. This function only applies to modules that are Generation 5 or later.
 

Detailed Description


Function Documentation

◆ naibrd_SG_GetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_status_type_t type,
nai_sg_edgelevel_t * outedgelevel )

Retrieves the bit corresponding to the specified SG channel in the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 edge/level interrupt register. This function only applies to modules that are Generation 5 or later.

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_sg_status_type_t definition.
outedgelevel: (Output) 0 for edge interrupt, 1 for level interrupt.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_status_type_t type,
bool_t * outenable )

Retrieves the bit corresponding to the specified SG Channel in the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Interrupt Enable 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.
type: (Input) Status Type: refer to nai_sg_status_type_t definition.
outenable: (Output) 1 for enable, 0 for disable.
0 if BIT Status Interrupts are Disabled for specified channel
1 if BIT Status Interrupts are Enabled for specified channel
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
naibrd_int_steering_t * outsteering )

This function retrieves the interrupt steering, which indicates the interrupt direction, for the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt. This function only applies to modules that are Generation 5 or later.

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]).
type: (Input) Status Type: refer to nai_sg_status_type_t definition.
outsteering: (Output) Interrupt steering type: 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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
uint32_t * outvector )

This function will read the vector for the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt.

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]).
type: (Input) Status Type: refer to nai_sg_status_type_t definition.
outvector: interrupt vector for the status type
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 type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetInterruptEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_status_type_t type,
nai_sg_edgelevel_t edgelevel )

Sets the bit corresponding to the specified SG channel in the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 edge/level interrupt register. This function only applies to modules that are Generation 5 or later.

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_sg_status_type_t definition.
edgelevel: (Input) 0 for edge interrupt, 1 for level interrupt.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_status_type_t type,
bool_t enable )

Sets the bit corresponding to the specified SG Channel in the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Interrupt Enable 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]).
type: (Input) Status Type: refer to nai_sg_status_type_t definition.
enable: (Input) 1 for enable, 0 for disable.
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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptSteering ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
naibrd_int_steering_t steering )

This function will set the interrupt steering, which indicates the interrupt direction, for the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt. This function only applies to modules that are Generation 5 or later.

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]).
type: (Input) Status Type: refer to nai_sg_status_type_t definition.
steering: (Input) Interrupt steering type: 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 module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter or invalid steering parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptVector ( int32_t cardIndex,
int32_t module,
nai_sg_status_type_t type,
uint32_t vector )

This function will set the vector for the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt.

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]).
type: (Input) Status Type: refer to nai_sg_status_type_t definition.
vector: (Input) vector for status type interrupt
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 type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.