Software Library API naibrd 1.62
See all documentation at naii.docs.com
On-board reference Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetOnBoardOSC (int32_t cardIndex, uint32_t module, nai_dl_onBoardOsc_type_t opMode, float64_t opValue)
 Sets either the on board voltage or on board Frequency to the dlv module. Use nai_dl_onBoardOsc_type_t to select the specified configuration type to be written to the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetOnBoardOSC (int32_t cardIndex, uint32_t module, nai_dl_onBoardOsc_type_t opMode, float64_t *opValue)
 Gets either the on board voltage or on board Frequency from the dlv module. Use nai_dl_onBoardOsc_type_t to select the specified configuration type to be read from the DLV module.
 

Detailed Description


Function Documentation

◆ naibrd_DL_GetOnBoardOSC()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetOnBoardOSC ( int32_t cardIndex,
uint32_t module,
nai_dl_onBoardOsc_type_t opMode,
float64_t * opValue )

Gets either the on board voltage or on board Frequency from the dlv module. Use nai_dl_onBoardOsc_type_t to select the specified configuration type to be read from the DLV module.

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]).
opMode: (Input) Configuration type: refer to nai_dl_onBoardOsc_type_t definitions.
opValue: (Output) float64_t: Value received from the module.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetOnBoardOSC()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetOnBoardOSC ( int32_t cardIndex,
uint32_t module,
nai_dl_onBoardOsc_type_t opMode,
float64_t opValue )

Sets either the on board voltage or on board Frequency to the dlv module. Use nai_dl_onBoardOsc_type_t to select the specified configuration type to be written to the DLV module.

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]).
opMode: (Input) Configuration type: refer to nai_dl_onBoardOsc_type_t definitions.
opValue: (Input) float64_t: Value received from the module.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.