Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Interval Functions
RTD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t bitopeninterval)
 Sets the time interval between successive BIT/open detection tests. Writing '0' disables BIT/open detection. The time interval LSB is 60 msec for G4, 1.024 msec for RT1. The minimum G4 BIT/open time interval is 1.2 sec (20 LSBs). Power on default interval is 20 sec. For Gen 5 modules, this function applies to X1 modules only and is not supported for Gen 5 X2 modules. For Gen 5 X2 modules, the BIT/Open interval is fixed at 30 seconds, or optionally suspended.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t *outbitopeninterval)
 Retrieves the time interval between successive BIT/open detection tests. Writing '0' disables BIT/open detection. The time interval LSB is 60 msec. The minimum BIT/open time interval is 1.2 sec (20 LSBs). Default time interval is 20 sec. For Gen 5 modules, this function applies to X1 modules only and is not supported for Gen 5 X2 modules. For Gen 5 X2 modules, the BIT/Open interval is fixed at 30 seconds.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetCalInterval (int32_t cardIndex, int32_t module, uint32_t calinterval)
 NOTE: This API only applies to the G4 module. Sets the time interval between successive background calibrations. Writing '0' disables background calibration. Writing 'FFFF' forces an immediate background calibration, with the register automatically being set back to '0' upon completion of background calibration. The time interval LSB is 60 msec. The minimum background calibration time interval is 1.2 sec (20 LSBs). Default time interval is 10 min.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetCalInterval (int32_t cardIndex, int32_t module, uint32_t *outcalinterval)
 NOTE: This API only applies to the G4 module. Retrieves the time interval between successive background calibrations. Writing '0' disables background calibration. Writing 'FFFF' forces an immediate background calibration, with the register automatically being set back to '0' upon completion of background calibration. The time interval LSB is 60 msec. The minimum background calibration time interval is 1.2 sec (20 LSBs). Default time interval is 10 min.
 

Detailed Description


Function Documentation

◆ naibrd_RTD_GetBitOpenInterval()

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

Retrieves the time interval between successive BIT/open detection tests. Writing '0' disables BIT/open detection. The time interval LSB is 60 msec. The minimum BIT/open time interval is 1.2 sec (20 LSBs). Default time interval is 20 sec. For Gen 5 modules, this function applies to X1 modules only and is not supported for Gen 5 X2 modules. For Gen 5 X2 modules, the BIT/Open interval is fixed at 30 seconds.

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) BIT/open detection time interval. 0 to disable BIT/open detection. 20 - 65535 where time interval LSB = 60 ms (minimum 1.2s (i.e. 20 LSBs)).
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_SUPPORTED when function is not supported.

◆ naibrd_RTD_GetCalInterval()

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

NOTE: This API only applies to the G4 module. Retrieves the time interval between successive background calibrations. Writing '0' disables background calibration. Writing 'FFFF' forces an immediate background calibration, with the register automatically being set back to '0' upon completion of background calibration. The time interval LSB is 60 msec. The minimum background calibration time interval is 1.2 sec (20 LSBs). Default time interval is 10 min.

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) Background calibration time interval. 0 to disable background calibration. 65535 to force immediate background calibration. 20 - 65534 where time interval LSB = 60 ms (minimum 1.2s (i.e. 20 LSBs)).
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_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetBitOpenInterval()

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

Sets the time interval between successive BIT/open detection tests. Writing '0' disables BIT/open detection. The time interval LSB is 60 msec for G4, 1.024 msec for RT1. The minimum G4 BIT/open time interval is 1.2 sec (20 LSBs). Power on default interval is 20 sec. For Gen 5 modules, this function applies to X1 modules only and is not supported for Gen 5 X2 modules. For Gen 5 X2 modules, the BIT/Open interval is fixed at 30 seconds, or optionally suspended.

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) BIT/open detection time interval word. 0 to disable BIT/open detection. For G4: 20 to 65535 with LSB = 60 ms (minimum 1.2s (i.e. 20 LSBs)). For RT1: LSB = 1.024 ms (0x7271 = 30 seconds) Writing 0 will disable BIT/Open status detection.
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_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetCalInterval()

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

NOTE: This API only applies to the G4 module. Sets the time interval between successive background calibrations. Writing '0' disables background calibration. Writing 'FFFF' forces an immediate background calibration, with the register automatically being set back to '0' upon completion of background calibration. The time interval LSB is 60 msec. The minimum background calibration time interval is 1.2 sec (20 LSBs). Default time interval is 10 min.

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) Background calibration time interval. 0 to disable background calibration. 65535 to force immediate background calibration. 20 - 65534 where time interval LSB = 60 ms (minimum 1.2s (i.e. 20 LSBs)).
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_SUPPORTED when function is not supported.