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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetAMOutputGain (int32_t cardIndex, int32_t module, int32_t channel, uint8_t level)
 Set the IRIG AM output gain level (0 to 255).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetAMOutputGain (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *p_outlevel)
 Get the currently set IRIG AM output gain level (0 to 255).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDriftThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t driftThreshold)
 Set the IRIG drift threshold, which is the number of seconds before ‘excessive drift’ interrupt (16 bits) by comparing the master time with the actual IRIG source. The count down starts when master time is not locked on to a reference. When the count reaches to zero and the master time remain not locked on to a reference, the actual Reference source register (0x10E4) will be set to 7(coasting for too long) and the status Change in refernce source(b15) in General Status will be set.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDriftThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outDriftThreshold)
 Get the IRIG drift threshold, which is the number of seconds before ‘excessive drift’ interrupt (16 bits)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetCtrlBitsToSend (int32_t cardIndex, int32_t module, int32_t channel, uint32_t ctrlbits)
 Set the IRIG user bits(CF) to send, which are loaded at the beginning of an IRIG Tx frame. This applies to both analog and digital IRIG. Not all IRIG protocol supports user bits(CF) field.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCtrlBitsToSend (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outctrlbits)
 Get the IRIG user bits to send, which are loaded at the beginning of an IRIG Tx frame.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCtrlBitsReceived (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outctrlbits)
 Get the IRIG user bits received, which are loaded when received. This applies to both analog and digital IRIG. Not all IRIG protocol supports user bits(CF) field.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_Set1PPSPulseWidth (int32_t cardIndex, int32_t module, int32_t channel, uint32_t pulseWidthUSec)
 Sets the 1PPS Pulse Width for the specified IRIG channel in units of microseconds. The 1PPS pulse is generated by the master timer. Output only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_Get1PPSPulseWidth (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outpulseWidthUSec)
 Retrieves the 1PPS Pulse Width for the specified IRIG channel in units of microseconds.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetPeriodicInterruptPeriod (int32_t cardIndex, int32_t module, int32_t channel, uint32_t periodUSec)
 Sets the Periodic Interrupt Period in units of microseconds. The 1PPS pulse is generated by the master timer. Output only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetPeriodicInterruptPeriod (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outperiodUSec)
 Retrieves the Periodic Interrupt Period for the specified IRIG channel in units of microseconds.
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_Get1PPSPulseWidth()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_Get1PPSPulseWidth ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outpulseWidthUSec )

Retrieves the 1PPS Pulse Width for the specified IRIG channel in units of microseconds.

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]).
p_outpulseWidthUSec: (Output) 1PPS Pulse Width in microseconds.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetAMOutputGain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetAMOutputGain ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t * p_outlevel )

Get the currently set IRIG AM output gain level (0 to 255).

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]).
p_outlevel: (Output) Output gain.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetCtrlBitsReceived()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCtrlBitsReceived ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outctrlbits )

Get the IRIG user bits received, which are loaded when received. This applies to both analog and digital IRIG. Not all IRIG protocol supports user bits(CF) field.

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]).
p_outctrlbits: (Output) User control bits received.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetCtrlBitsToSend()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCtrlBitsToSend ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outctrlbits )

Get the IRIG user bits to send, which are loaded at the beginning of an IRIG Tx frame.

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]).
p_outctrlbits: (Output) User control bits.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetDriftThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDriftThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outDriftThreshold )

Get the IRIG drift threshold, which is the number of seconds before ‘excessive drift’ interrupt (16 bits)

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]).
p_outDriftThreshold: (Output) Drift threshold (16 bits)
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetPeriodicInterruptPeriod()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetPeriodicInterruptPeriod ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outperiodUSec )

Retrieves the Periodic Interrupt Period for the specified IRIG channel in units of microseconds.

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]).
p_outperiodUSec: (Output) Periodic Interrupt Period in microseconds.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_Set1PPSPulseWidth()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_Set1PPSPulseWidth ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t pulseWidthUSec )

Sets the 1PPS Pulse Width for the specified IRIG channel in units of microseconds. The 1PPS pulse is generated by the master timer. Output only.

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]).
pulseWidthUSec: (Input) 1PPS Pulse Width in microseconds.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetAMOutputGain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetAMOutputGain ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t level )

Set the IRIG AM output gain level (0 to 255).

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]).
level: (Input) Output gain (0 to 255).
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_NOT_SUPPORTED when function is not supported.
  • NAI_ERROR_INVALID_VALUE when invalid level is supplied.

◆ naibrd_IRIG_SetCtrlBitsToSend()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetCtrlBitsToSend ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t ctrlbits )

Set the IRIG user bits(CF) to send, which are loaded at the beginning of an IRIG Tx frame. This applies to both analog and digital IRIG. Not all IRIG protocol supports user bits(CF) field.

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]).
ctrlbits: (Input) User control bits (bits 0 to 26 are valid).
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetDriftThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDriftThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t driftThreshold )

Set the IRIG drift threshold, which is the number of seconds before ‘excessive drift’ interrupt (16 bits) by comparing the master time with the actual IRIG source. The count down starts when master time is not locked on to a reference. When the count reaches to zero and the master time remain not locked on to a reference, the actual Reference source register (0x10E4) will be set to 7(coasting for too long) and the status Change in refernce source(b15) in General Status will be set.

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]).
driftThreshold: (Input) Drift threshold (16 bits)
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetPeriodicInterruptPeriod()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetPeriodicInterruptPeriod ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t periodUSec )

Sets the Periodic Interrupt Period in units of microseconds. The 1PPS pulse is generated by the master timer. Output only.

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]).
periodUSec: (Input) Periodic Interrupt Period in microseconds.
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_NOT_SUPPORTED when function is not supported.