Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
IRIG Basic Configuration Functions: Protocol
NAI Board Library - Module Functions » IRIG Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetProtocolByValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_protocol_value_t irigProtoValue)
 Set the IRIG Protocol with a value given by the naibrd_irig_protocol_value_t enum type. This enum contains all valid IRIG protocols and the enum value itself reflects the configuration settings of the IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. Specifically, the format of the 16-bit value is shown below:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetProtocolByValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_protocol_value_t *p_outIrigProtoValue)
 Get the IRIG Protocol that the device is currently set to. This function returns a 16-bit value of an enum type that reflects the reference configuration settings of the IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. Specifically, the format of the 16-bit value is shown below:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetProtocol (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_protocol_t irigProtocol)
 Set the IRIG Protocol, which comprises of four reference parameters: IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. Only certain combinations of these four parameters are currently supported and these combinations are shown in the table below. For simplicity, you can use naibrd_IRIG_SetProtocolByValue() instead.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetProtocol (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_protocol_t *p_outIrigProtocol)
 Get the IRIG Protocol that the device is currently set to. The IRIG protocol comprises of four reference parameters: IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_format_t irigFormat)
 Sets the IRIG format only and it doesn't touch IRIG Modulation, Carrier Frequency, or Coded Expression. For simplicity, you can use naibrd_IRIG_SetProtocolByValue() instead.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_format_t *p_outIrigFormat)
 Get the currently set IRIG format.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModulation (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_modulation_t irigModulation)
 Sets the IRIG Modulation only and it doesn't touch IRIG Format, Carrier Frequency, or Coded Expression. For simplicity, you can use naibrd_IRIG_SetProtocolByValue() instead.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModulation (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_modulation_t *p_outIrigModulation)
 Get the currently set IRIG Modulation.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetYear (int32_t cardIndex, int32_t module, int32_t channel, int32_t year)
 Set the two-digit year for IRIG sources/format e.g (B122) that do not provide year information.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetYear (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outYear)
 Get the currently set two-digit year for IRIG sources that do not provide year information which is set by calling naibrd_IRIG_SetYear().
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_GetFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_format_t * p_outIrigFormat )

Get the currently set IRIG format.

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_outIrigFormat: (Output) IRIG format given by one of the following: 
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_A                    IRIG A
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_B                    IRIG B
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_G                    IRIG G
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_GetModulation()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModulation ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_modulation_t * p_outIrigModulation )

Get the currently set IRIG Modulation.

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_outIrigModulation: (Output) IRIG modulation given by one of the following: 
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DCLS             DCLS
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_AM_ASK           AM ASK
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DC_MANCHESTER    DC Manchester
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_GetProtocol()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetProtocol ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_protocol_t * p_outIrigProtocol )

Get the IRIG Protocol that the device is currently set to. The IRIG protocol comprises of four reference parameters: IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression.

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_outIrigProtocol: (Input) Structure containing current settings of IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. The possible configuration settings are given below: 
      IRIG Format:
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_A (1)                    IRIG A
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_B (2)                    IRIG B
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_G (7)                    IRIG G

      IRIG Modulation:
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DCLS (0)             DCLS
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_AM_ASK (1)           AM ASK
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DC_MANCHESTER (2)    DC Manchester

      Carrier Frequency:
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_NONE (0)                no carrier
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_100HZ (1)               100 Hz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_1KHZ (2)                1 kHz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_10KHZ (3)               10 kHz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_100KHZ (4)              100 kHz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_1MHZ (5)                1 MHz

      Coded Expression:
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_CF_SBS (0)           BCDTOY, CF, SBS
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_CF (1)               BCDTOY, CF
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY (2)                  BCDTOY
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_SBS (3)              BCDTOY, SBS
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR_CF_SBS (4)   BCDTOY, BCDYEAR, CF, SBS
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR_CF (5)       BCDTOY, BCDYEAR, CF
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR (6)          BCDTOY, BCDYEAR
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR_SBS (7)      BCDTOY, BCDYEAR, SBS
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_UNKNOWN_VALUE when registers read from module contain invalid values.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetProtocolByValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetProtocolByValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_protocol_value_t * p_outIrigProtoValue )

Get the IRIG Protocol that the device is currently set to. This function returns a 16-bit value of an enum type that reflects the reference configuration settings of the IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. Specifically, the format of the 16-bit value is shown below:

Bits 15 to 12 Bits 11 to 8 Bits 7 to 4 Bits 3 to 0
IRIG Format IRIG Modulation Carrier Frequency Coded Expression

where the possible values of each field are:

      IRIG Format:
      1                    IRIG A
      2                    IRIG B
      7                    IRIG G

      IRIG Modulation:
      0                    DCLS
      1                    AM ASK
      2                    DC Manchester

      Carrier Frequency:
      0                    no carrier
      1                    100 Hz
      2                    1 kHz
      3                    10 kHz
      4                    100 kHz
      5                    1 MHz

      Coded Expression:
      0                    BCDTOY, CF, SBS
      1                    BCDTOY, CF
      2                    BCDTOY
      3                    BCDTOY, SBS
      4                    BCDTOY, BCDYEAR, CF, SBS
      5                    BCDTOY, BCDYEAR, CF
      6                    BCDTOY, BCDYEAR
      7                    BCDTOY, BCDYEAR, SBS

For example, NAIBRD_IRIG_PROTOCOL_VALUE_7145 sets the IRIG protocol for IRIG Format G, AM ASK, 100 kHz and BCDTOY,BCDYEAR,CF.

Please refer to the definition of naibrd_irig_protocol_value_t for all valid protocol values.

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_outIrigProtoValue: (Output) Returned naibrd_irig_protocol_value_t enum value.
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_UNKNOWN_VALUE when registers read from module contain invalid values.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetYear()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetYear ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outYear )

Get the currently set two-digit year for IRIG sources that do not provide year information which is set by calling naibrd_IRIG_SetYear().

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_outYear: (Output) Two-digit year YY.
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 if the read year value is not valid.

◆ naibrd_IRIG_SetFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_format_t irigFormat )

Sets the IRIG format only and it doesn't touch IRIG Modulation, Carrier Frequency, or Coded Expression. For simplicity, you can use naibrd_IRIG_SetProtocolByValue() instead.

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]).
irigFormat: (Input) Select IRIG format from one of the following: 
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_A                    IRIG A
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_B                    IRIG B
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_G                    IRIG G
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 irigFormat value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetModulation()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModulation ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_modulation_t irigModulation )

Sets the IRIG Modulation only and it doesn't touch IRIG Format, Carrier Frequency, or Coded Expression. For simplicity, you can use naibrd_IRIG_SetProtocolByValue() instead.

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]).
irigModulation: (Input) Select IRIG modulation from one of the following: 
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DCLS             DCLS
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_AM_ASK           AM ASK
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DC_MANCHESTER    DC Manchester
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 irigModulation value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetProtocol()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetProtocol ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_protocol_t irigProtocol )

Set the IRIG Protocol, which comprises of four reference parameters: IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. Only certain combinations of these four parameters are currently supported and these combinations are shown in the table below. For simplicity, you can use naibrd_IRIG_SetProtocolByValue() instead.

IRIG Format IRIG Modulation Carrier Frequency Coded Expression
A DCLS None BCDTOY, CF, SBS
A DCLS None BCDTOY, CF
A DCLS None BCDTOY
A DCLS None BCDTOY, SBS
A DCLS None BCDTOY, BCDYEAR, CF, SBS
A DCLS None BCDTOY, BCDYEAR, CF
A DCLS None BCDTOY, BCDYEAR
A DCLS None BCDTOY, BCDYEAR, SBS
A AM ASK 10 kHz BCDTOY, CF, SBS
A AM ASK 10 kHz BCDTOY, CF
A AM ASK 10 kHz BCDTOY
A AM ASK 10 kHz BCDTOY, SBS
A AM ASK 10 kHz BCDTOY, BCDYEAR, CF, SBS
A AM ASK 10 kHz BCDTOY, BCDYEAR, CF
A AM ASK 10 kHz BCDTOY, BCDYEAR
A AM ASK 10 kHz BCDTOY, BCDYEAR, SBS
B DCLS None BCDTOY, CF, SBS
B DCLS None BCDTOY, CF
B DCLS None BCDTOY
B DCLS None BCDTOY, SBS
B DCLS None BCDTOY, BCDYEAR, CF, SBS
B DCLS None BCDTOY, BCDYEAR, CF
B DCLS None BCDTOY, BCDYEAR
B DCLS None BCDTOY, BCDYEAR, SBS
B AM ASK 1 kHz BCDTOY, CF, SBS
B AM ASK 1 kHz BCDTOY, CF
B AM ASK 1 kHz BCDTOY
B AM ASK 1 kHz BCDTOY, SBS
B AM ASK 1 kHz BCDTOY, BCDYEAR, CF, SBS
B AM ASK 1 kHz BCDTOY, BCDYEAR, CF
B AM ASK 1 kHz BCDTOY, BCDYEAR
B AM ASK 1 kHz BCDTOY, BCDYEAR, SBS
G DCLS None BCDTOY, CF
G DCLS None BCDTOY
G DCLS None BCDTOY, BCDYEAR, CF
G DCLS None BCDTOY, BCDYEAR
G AM ASK 100 kHz BCDTOY, CF
G AM ASK 100 kHz BCDTOY
G AM ASK 100 kHz BCDTOY, BCDYEAR, CF
G AM ASK 100 kHz BCDTOY, BCDYEAR
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]).
irigProtocol: (Input) Structure containing user selections for IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. Select from the Following: 
      IRIG Format:
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_A (1)                    IRIG A
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_B (2)                    IRIG B
      NAIBRD_IRIG_CTRL_MODE_IRIG_FORMAT_G (7)                    IRIG G

      IRIG Modulation:
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DCLS (0)             DCLS
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_AM_ASK (1)           AM ASK
      NAIBRD_IRIG_CTRL_MODE_IRIG_MODULATION_DC_MANCHESTER (2)    DC Manchester

      Carrier Frequency:
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_NONE (0)                no carrier
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_100HZ (1)               100 Hz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_1KHZ (2)                1 kHz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_10KHZ (3)               10 kHz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_100KHZ (4)              100 kHz
      NAIBRD_IRIG_MODE_CARRIER_FREQUENCY_1MHZ (5)                1 MHz

      Coded Expression:
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_CF_SBS (0)           BCDTOY, CF, SBS
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_CF (1)               BCDTOY, CF
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY (2)                  BCDTOY
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_SBS (3)              BCDTOY, SBS
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR_CF_SBS (4)   BCDTOY, BCDYEAR, CF, SBS
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR_CF (5)       BCDTOY, BCDYEAR, CF
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR (6)          BCDTOY, BCDYEAR
      NAIBRD_IRIG_CTRL_MODE_CODE_EXP_BCDTOY_BCDYEAR_SBS (7)      BCDTOY, BCDYEAR, SBS
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 irigProtocol is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetProtocolByValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetProtocolByValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_protocol_value_t irigProtoValue )

Set the IRIG Protocol with a value given by the naibrd_irig_protocol_value_t enum type. This enum contains all valid IRIG protocols and the enum value itself reflects the configuration settings of the IRIG Format, IRIG Modulation, Carrier Frequency and Coded Expression. Specifically, the format of the 16-bit value is shown below:

Bits 15 to 12 Bits 11 to 8 Bits 7 to 4 Bits 3 to 0
IRIG Format IRIG Modulation Carrier Frequency Coded Expression

where the possible values of each field are:

      IRIG Format:
      1                    IRIG A
      2                    IRIG B
      7                    IRIG G

      IRIG Modulation:
      0                    DCLS
      1                    AM ASK
      2                    DC Manchester

      Carrier Frequency:
      0                    no carrier
      1                    100 Hz
      2                    1 kHz
      3                    10 kHz
      4                    100 kHz
      5                    1 MHz

      Coded Expression:
      0                    BCDTOY, CF, SBS
      1                    BCDTOY, CF
      2                    BCDTOY
      3                    BCDTOY, SBS
      4                    BCDTOY, BCDYEAR, CF, SBS
      5                    BCDTOY, BCDYEAR, CF
      6                    BCDTOY, BCDYEAR
      7                    BCDTOY, BCDYEAR, SBS

For example, NAIBRD_IRIG_PROTOCOL_VALUE_7145 sets the IRIG protocol for IRIG Format G, AM ASK, 100 kHz and BCDTOY,BCDYEAR,CF.

Please refer to the definition of naibrd_irig_protocol_value_t for all valid protocol values.

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]).
irigProtoValue: (Input) naibrd_irig_protocol_value_t enum value.
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 irigProtoValue is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetYear()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetYear ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t year )

Set the two-digit year for IRIG sources/format e.g (B122) that do not provide year information.

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]).
year: (Input) Two-digit year YY.
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 the value of year is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.