Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
General Temperature Functions
Core Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleTempEx (int32_t cardIndex, int32_t module, nai_module_temp_type_t moduleTempType, float64_t *moduleTemp)
 Retrieves a module's extended precision temperature if available, otherwise returns integer temperature reading. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMotherboardTempEx (int32_t cardIndex, nai_motherboard_temp_type_t mbTempType, float64_t *mbTemp)
 Retrieves a motherboard's extended precision temperature, if available. Otherwise returns integer temperature reading. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleTemp (int32_t cardIndex, int32_t module, nai_module_temp_type_t moduleTempType, nai_module_temp_t *moduleTemp)
 Retrieves a module's temperature. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMotherboardTemp (int32_t cardIndex, nai_motherboard_temp_type_t mbTempType, nai_motherboard_temp_t *mbTemp)
 Retrieves the motherboard's temperature. This feature is only available on the Xilinx Generation 5 platforms.
 

Detailed Description


Function Documentation

◆ naibrd_GetModuleTemp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleTemp ( int32_t cardIndex,
int32_t module,
nai_module_temp_type_t moduleTempType,
nai_module_temp_t * moduleTemp )

Retrieves a module's temperature. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleTempType: (Input) The type of module temperature to read.
moduleTemp: (Output) The module temperature.
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.

◆ naibrd_GetModuleTempEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleTempEx ( int32_t cardIndex,
int32_t module,
nai_module_temp_type_t moduleTempType,
float64_t * moduleTemp )

Retrieves a module's extended precision temperature if available, otherwise returns integer temperature reading. This feature is only available on the Xilinx Generation 5 platforms.

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]).
moduleTempType: (Input) The type of module temperature to read.
moduleTemp: (Output) The module temperature.
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.

◆ naibrd_GetMotherboardTemp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMotherboardTemp ( int32_t cardIndex,
nai_motherboard_temp_type_t mbTempType,
nai_motherboard_temp_t * mbTemp )

Retrieves the motherboard's temperature. This feature is only available on the Xilinx Generation 5 platforms.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
mbTempType: (Input) The type of module temperature to read.
mbTemp: (Output) The module temperature.
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.

◆ naibrd_GetMotherboardTempEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMotherboardTempEx ( int32_t cardIndex,
nai_motherboard_temp_type_t mbTempType,
float64_t * mbTemp )

Retrieves a motherboard's extended precision temperature, if available. Otherwise returns integer temperature reading. This feature is only available on the Xilinx Generation 5 platforms.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
mbTempType: (Input) The type of motherboard temperature to read.
mbTemp: (Output) The motherboard temperature.
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.