Profishark API 2.6.1.0
Loading...
Searching...
No Matches
Power over Ethernet

Power over Ethernet functions. More...

Data Structures

struct  ProfisharkApiPoePairValues
 Power over Ethernet pair measures. More...
 
struct  ProfisharkApiPoeValues
 Power over Ethernet values and calibration parameters. More...
 
struct  ProfisharkApiPoeChannelCalibrationData
 Power over Ethernet calibration parameters. More...
 
struct  ProfisharkApiPoeCalibrationData
 Power over Ethernet calibration parameters. More...
 

Typedefs

typedef struct ProfisharkApiPoePairValues ProfisharkApiPoePairValues
 Power over Ethernet pair measures.
 
typedef struct ProfisharkApiPoeValues ProfisharkApiPoeValues
 Power over Ethernet values and calibration parameters.
 
typedef struct ProfisharkApiPoeChannelCalibrationData ProfisharkApiPoeChannelCalibrationData
 Power over Ethernet calibration parameters.
 
typedef struct ProfisharkApiPoeCalibrationData ProfisharkApiPoeCalibrationData
 Power over Ethernet calibration parameters.
 

Functions

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeGetMeasures (ProfisharkApiDeviceHandle handle, ProfisharkApiPoeValues *result)
 Read Power over Ethernet values and calibration data.
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeGetRawMeasures (ProfisharkApiDeviceHandle handle, ProfisharkApiPoeValues *result)
 Read Power over Ethernet uncalibrated values.
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeGetCalibrationData (ProfisharkApiDeviceHandle handle, ProfisharkApiPoeCalibrationData *result)
 Read Power over Ethernet calibration data.
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeSetCalibrationData (ProfisharkApiDeviceHandle handle, ProfisharkApiPoeCalibrationData *result)
 Write Power over Ethernet calibration data.
 
PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeResetCalibrationData (ProfisharkApiDeviceHandle handle)
 Reset Power over Ethernet calibration data.
 

Detailed Description

Power over Ethernet functions.

Function Documentation

◆ ProfisharkAPIPoeGetCalibrationData()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeGetCalibrationData ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiPoeCalibrationData result 
)

Read Power over Ethernet calibration data.

Parameters
handlea handle to the device
resulta ProfisharkApiPoeCalibrationData that will be filled with the PoE calibration data
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
ProfisharkAPIRet_Unsupportedif the device does not support this operation

◆ ProfisharkAPIPoeGetMeasures()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeGetMeasures ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiPoeValues result 
)

Read Power over Ethernet values and calibration data.

Read Power over Ethernet calibrated values.

Parameters
handlea handle to the device
resulta ProfisharkApiPoeValues that will be filled with the PoE values
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
ProfisharkAPIRet_Unsupportedif the device does not support this operation

◆ ProfisharkAPIPoeGetRawMeasures()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeGetRawMeasures ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiPoeValues result 
)

Read Power over Ethernet uncalibrated values.

Parameters
handlea handle to the device
resulta ProfisharkApiPoeValues that will be filled with the PoE values
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
ProfisharkAPIRet_Unsupportedif the device does not support this operation

◆ ProfisharkAPIPoeResetCalibrationData()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeResetCalibrationData ( ProfisharkApiDeviceHandle  handle)

Reset Power over Ethernet calibration data.

Parameters
handlea handle to the device
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
ProfisharkAPIRet_Unsupportedif the device does not support this operation

◆ ProfisharkAPIPoeSetCalibrationData()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIPoeSetCalibrationData ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiPoeCalibrationData result 
)

Write Power over Ethernet calibration data.

Parameters
handlea handle to the device
resulta ProfisharkApiPoeCalibrationData containing the calibration data to write
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist
ProfisharkAPIRet_Unsupportedif the device does not support this operation