Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Bit/Open and Cal Interval Functions
Strain Gauge Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t bitopeninterval)
 This function will set the BIT/OPEN Interval time word for all the SG Channels in the specified module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t *outbitopeninterval)
 This function will read the BIT/OPEN Interval time word for all the SG Channels in the specified module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalInterval (int32_t cardIndex, int32_t module, uint32_t calinterval)
 This function will set the background calibration interval time word for all the SG Channels in the specified module. This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetCalInterval (int32_t cardIndex, int32_t module, uint32_t *outcalinterval)
 This function will read the background calibration interval time word for all the SG Channels in the specified module. This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalType (int32_t cardIndex, int32_t module, nai_sg_cal_type_t caltype)
 This function will set the cal type selection for the specified module. Set per module (Applies to all channels in module). This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetCalType (int32_t cardIndex, int32_t module, nai_sg_cal_type_t *outcaltype)
 This function will read the cal type selection for the specified module. This function is only supported by Generation 3 SG modules.
 

Detailed Description


Function Documentation

◆ naibrd_SG_GetBitOpenInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBitOpenInterval ( int32_t cardIndex,
int32_t module,
uint32_t * outbitopeninterval )

This function will read the BIT/OPEN Interval time word for all the SG Channels in the specified module. 

0 = Disable BIT/Open detection
20-65535 where LSB = 60ms. Minimum of 1.2s is required (20 LSB)

This function is only supported by Generation 3 SG modules.

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]).
outbitopeninterval: (Output) A pointer to where the BIT/OPEN Interval value is returned.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetCalInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetCalInterval ( int32_t cardIndex,
int32_t module,
uint32_t * outcalinterval )

This function will read the background calibration interval time word for all the SG Channels in the specified module. This function is only supported by Generation 3 SG modules.

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]).
outcalinterval: (Output) A pointer to where the CalInterval value is returned. 
                                     D15-D0  = Time between succesive background calibrations.
                                               LSB = 60ms. Minimum of 1.2s is required (20 LSB).
                                               Writing "FFFF" to this register forces an imediate
                                               background calibration. When the background calibration
                                               is finished, this register will return to "0000".
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetCalType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetCalType ( int32_t cardIndex,
int32_t module,
nai_sg_cal_type_t * outcaltype )

This function will read the cal type selection for the specified module. This function is only supported by Generation 3 SG modules.

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]).
outcaltype: (Output) A pointer to where the CalType value is returned. 
Cal Types-
          CAL_OFF                 0x00
          CAL_INT_ZERO_INT_FULL   0x03
          CAL_SYS_ZERO_SCALE      0x07
          CAL_SYS_FULL_SCALE      0x0B
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetBitOpenInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBitOpenInterval ( int32_t cardIndex,
int32_t module,
uint32_t bitopeninterval )

This function will set the BIT/OPEN Interval time word for all the SG Channels in the specified module. 

0 = Disable BIT/Open detection
20-65535 where LSB = 60ms. Minimum of 1.2s is required (20 LSB)

This function is only supported by Generation 3 SG modules.

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]).
bitopeninterval: (Input) D15-D0 = Time between succesive BIT/OPEN detection tests.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetCalInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalInterval ( int32_t cardIndex,
int32_t module,
uint32_t calinterval )

This function will set the background calibration interval time word for all the SG Channels in the specified module. This function is only supported by Generation 3 SG modules.

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]).
calinterval: (Input) 
                                     D15-D0  = Time between succesive background calibrations.
                                               The interval represented by the LSB is 256 times the data rate interval.
                                               e.g. a setting of 1 with a data rate of 100Hz will set the periodic cal interval for
                                               1/100 seconds x 256 = 2.56 seconds
                                               Writing "FFFF" to this register forces an imediate
                                               background calibration. When the background calibration
                                               is finished, this register will return to "0000".
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetCalType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalType ( int32_t cardIndex,
int32_t module,
nai_sg_cal_type_t caltype )

This function will set the cal type selection for the specified module. Set per module (Applies to all channels in module). This function is only supported by Generation 3 SG modules.

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]).
caltype: (Input) refer to nai_sg_cal_type_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_NOT_SUPPORTED when function is not supported.