batConsumptionAvg (function)

This function will return the average battery current consumption in mA measured since the last call to batConsumptionClear.

The average battery current consumption is only measured when the current consumption measurement circuit is enabled by using the batConsumptionEnable function.

The current consumption average is persistent even through system restarts and may be reset by calling batConsumptionClear,

Input:

None.

Returns: DINT

The average current that is being consumed from the battery in mA.

Declaration:

FUNCTION batConsumptionAvg : DINT;

Example:

INCLUDE rtcu.inc
 
PROGRAM example;
VAR
  val : DINT;
END_VAR;
 
  // Start the current consumption measurement
  batConsumptionEnable(enable := ON);
 
BEGIN
  ...
  // Get the current consumption
  val := batConsumptionAvg();
  ...
END;
END_PROGRAM;