Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Board Temperature Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMotherboardTemperature (int32_t cardIndex, naibrd_motherboard_temp_type_t mbTempType, float64_t *p_outmbTemp)
 Retrieves a motherboard's temperature in degrees Celsius. This feature is only available on the Xilinx Generation 5 platforms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleTemperature (int32_t cardIndex, int32_t module, naibrd_module_temp_type_t moduleTempType, float64_t *p_outmoduleTemp)
 Retrieves a module's temperature in degrees Celsius. This feature is only available on the Xilinx Generation 5 platforms.
 

Detailed Description

Function Documentation

◆ naibrd_GetModuleTemperature()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetModuleTemperature ( int32_t cardIndex,
int32_t module,
naibrd_module_temp_type_t moduleTempType,
float64_t * p_outmoduleTemp )

Retrieves a module's temperature in degrees Celsius. 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) Type of module temperature to read. Refer to naibrd_module_temp_type_t for types of module temperature readings.
p_outmoduleTemp: (Output) Module temperature in degrees Celsius.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_GetMotherboardTemperature()

NAIBRDFUNC nai_status_t NAIAPI naibrd_GetMotherboardTemperature ( int32_t cardIndex,
naibrd_motherboard_temp_type_t mbTempType,
float64_t * p_outmbTemp )

Retrieves a motherboard's temperature in degrees Celsius. 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) Type of motherboard temperature to read. Refer to naibrd_motherboard_temp_type_t for types of motherboard temperature readings.
p_outmbTemp: (Output) Motherboard temperature in degrees Celsius.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.