Green Mode Power Savings Estimates API [OPENAPI_GREEN_PWR_ESTIMATES]

Functions
open_error_t	openapiGreenEthrIntfStatisticsClear (openapiClientHandle_t *client_handle, uint32_t intIfNum)
	Clear green mode statistics for the given interface. More...
open_error_t	openapiGreenEthrPwrEstGlobalPwrSavingGet (openapiClientHandle_t *client_handle, uint32_t *pwrSaving)
	Get green mode power saving. More...
open_error_t	openapiGreenPwrEstGlobalCumSavingGet (openapiClientHandle_t *client_handle, uint32_t *pwrSaving)
	Get green mode current power saving. More...
open_error_t	openapiGreenPwrEstGlobalCurPwrGet (openapiClientHandle_t *client_handle, uint32_t *pwrConsumption)
	Get green mode current power consumption. More...
open_error_t	openapiGreenPwrEstIntfCumSavingGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pwrSaving)
	Get green mode cumulative power saving on given interface. More...
open_error_t	openapiGreenPwrEstIntfCurPwrGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pwrConsumption)
	Get green mode current power consumption on given interface. More...

Detailed Description

Function Documentation

open_error_t openapiGreenEthrIntfStatisticsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum
	)

Clear green mode statistics for the given interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.26

Examples:

green_pwr_estimates_example.c.

open_error_t openapiGreenEthrPwrEstGlobalPwrSavingGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pwrSaving
	)

Get green mode power saving.

Parameters

[in]	client_handle	client handle from registration API
[out]	pwrSaving	cumulative power saving

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.26

Examples:

green_pwr_estimates_example.c.

open_error_t openapiGreenPwrEstGlobalCumSavingGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pwrSaving
	)

Get green mode current power saving.

Parameters

[in]	client_handle	client handle from registration API
[out]	pwrSaving	cumulative power saving

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.26

Examples:

green_pwr_estimates_example.c.

open_error_t openapiGreenPwrEstGlobalCurPwrGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	pwrConsumption
	)

Get green mode current power consumption.

Parameters

[in]	client_handle	client handle from registration API
[out]	pwrConsumption	current power consumption

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.26

Examples:

green_pwr_estimates_example.c.

open_error_t openapiGreenPwrEstIntfCumSavingGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	pwrSaving
	)

Get green mode cumulative power saving on given interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	pwrSaving	cumulative power saving

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.26

Examples:

green_pwr_estimates_example.c.

open_error_t openapiGreenPwrEstIntfCurPwrGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t *	pwrConsumption
	)

Get green mode current power consumption on given interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intIfNum	internal interface number
[out]	pwrConsumption	current power consumption

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_INTERNAL	Internal error.

OpEN API Version: 1.26

Examples:

green_pwr_estimates_example.c.