Kontron KEAPI - Manual (Page 19)

Software specification for Kontron EAPI
19
2.9 Voltage sensors
2.9.1 KEApiGetVoltageSensorCount
KEAPI_CALLTYPE KEAPI_UINT32 KEApiGetVoltageSensorCount (
KEAPI_UINT32 boardHandle,
KEAPI_PINT32 pVoltageSensorCount
);
Description:
Provides number of voltage sensors.
Parameters:
in/out Parameter name Description
in boardHandle Handle of the selected board
out pVoltageSensorCount Pointer to the voltage sensors count
2.9.2 KEApiGetVoltageSensorList
KEAPI_CALLTYPE KEAPI_UINT32 KEApiGetVoltageSensorList (
KEAPI_UINT32 boardHandle,
PVOLTAGE_SENSOR pVoltageSensors,
KEAPI_INT32 voltageSensorCount
);
Description:
Provides information about voltage sensors in the structure VOLTAGE_SENSOR .
Parameters:
in/out Parameter name Description
in boardHandle Handle of the selected board
in voltageSensorCount Number of sensors, obtained from the function
KEApiGetVoltageSensorCount
out pVoltageSensors Pointer to the voltage sensors structure
VOLTAGE_SENSOR
Structure used:
typedef struct Voltage_Sensor
{
KEAPI_CHAR name[MAX_STR]; // Sensor’s name
KEAPI_INT32 value; // Value obtained from the sensor in millivolts
} VOLTAGE_SENSOR , * PVOLTAGE_SENSOR ;
2.9.3 KEApiGetVoltageSensorValue
KEAPI_CALLTYPE KEAPI_UINT32 KEApiGetVoltageSensorValue (
KEAPI_UINT32 boardHandle,
KEAPI_INT32 voltageSensorNr,
KEAPI_PINT32 pVoltageSensorValue
);
Description:
Provides current voltage value of a selected voltage sensor.