Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
IRIG RTC (Realtime Clock) Functions
NAI Board Library - Module Functions » IRIG Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_rtc_time_t rtcTimeStruct)
 Sets the RTC (Real Time Clock) Time for the specified IRIG channel based on the values in the structure passed in. Once the RTC is set, use the function naibrd_IRIG_SetRTC to load the content to the master time.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_rtc_time_t *p_outrtcTimeStruct)
 Retrieves the RTC (Real Time Clock) Time for the specified IRIG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCDate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_rtc_date_t rtcDateStruct)
 Sets the RTC (Real Time Clock) Date for the specified IRIG channel based on the values in the structure passed in. Once the RTC is set, use the function naibrd_IRIG_SetRTC to load the content to the master time.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCDate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_rtc_date_t *p_outrtcDateStruct)
 Retrieves the RTC (Real Time Clock) Date for the specified IRIG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTC (int32_t cardIndex, int32_t module, int32_t channel)
 Sets the RTC (Real Time Clock) for the specified IRIG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t propOffset)
 Sets the Number of ticks to be added to or subtracted from the master timer when the reference source is RTC The range: +/-10.0 seconds (-1199999999 to 1199999999) wc todo, need to verify the range.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outpropOffset)
 Gets the Number of ticks to be added to or subtracted from the master timer when the reference source is RTC The range: +/-10.0 seconds (-1199999999 to 1199999999) wc todo, need to verify the range.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCTimeZoneOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t timeZoneOffset)
 Sets the Number of minutes to be added to or subtracted from the master timer when the reference source is RTC. Range : +/-1439.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCTimeZoneOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outtimeZoneOffset)
 Gets the Number of minutes to be added to or subtracted from the master timer when the reference source is RTC. Range : +/-1439.
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_GetRTCDate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCDate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_rtc_date_t * p_outrtcDateStruct )

Retrieves the RTC (Real Time Clock) Date for the specified IRIG channel.

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_outrtcDateStruct: (Output) Structure of RTC Year, Month, and Day.
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_GetRTCPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outpropOffset )

Gets the Number of ticks to be added to or subtracted from the master timer when the reference source is RTC The range: +/-10.0 seconds (-1199999999 to 1199999999) wc todo, need to verify the range.

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_outpropOffset: (Output) Propagation Offset (valid range: -1199999999 to 1199999999).
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_GetRTCTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_rtc_time_t * p_outrtcTimeStruct )

Retrieves the RTC (Real Time Clock) Time for the specified IRIG channel.

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_outrtcTimeStruct: (Output) Structure of RTC Hour, Minute, and Second.
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_GetRTCTimeZoneOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetRTCTimeZoneOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outtimeZoneOffset )

Gets the Number of minutes to be added to or subtracted from the master timer when the reference source is RTC. Range : +/-1439.

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_outtimeZoneOffset: (Output) Time Zone Offset (valid range: -1439 to 1439).
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_SetRTC()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTC ( int32_t cardIndex,
int32_t module,
int32_t channel )

Sets the RTC (Real Time Clock) for the specified IRIG channel.

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]).
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_TIMEOUT when RTC Control register is not ready to be set within 2 seconds.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetRTCDate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCDate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_rtc_date_t rtcDateStruct )

Sets the RTC (Real Time Clock) Date for the specified IRIG channel based on the values in the structure passed in. Once the RTC is set, use the function naibrd_IRIG_SetRTC to load the content to the master time.

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]).
rtcDateStruct: (Input) Structure of RTC Year, Month, and Day to set.
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_SetRTCPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t propOffset )

Sets the Number of ticks to be added to or subtracted from the master timer when the reference source is RTC The range: +/-10.0 seconds (-1199999999 to 1199999999) wc todo, need to verify the range.

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]).
propOffset: (Input) Propagation Offset (valid range: -1199999999 to 1199999999).
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 propOffset value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetRTCTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_rtc_time_t rtcTimeStruct )

Sets the RTC (Real Time Clock) Time for the specified IRIG channel based on the values in the structure passed in. Once the RTC is set, use the function naibrd_IRIG_SetRTC to load the content to the master time.

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]).
rtcTimeStruct: (Input) Structure of RTC Hour, Minute, and Second to set.
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_SetRTCTimeZoneOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetRTCTimeZoneOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t timeZoneOffset )

Sets the Number of minutes to be added to or subtracted from the master timer when the reference source is RTC. Range : +/-1439.

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]).
timeZoneOffset: (Input) Time Zone Offset (valid range: -1439 to 1439).
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 timeZoneOffset value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.