package com.android.internal.location.gnssmetrics;
import android.os.SystemClock;
import android.os.connectivity.GpsBatteryStats;
import android.os.SystemProperties;
import android.text.format.DateUtils;
import android.util.Base64;
import android.util.Log;
import android.util.TimeUtils;
import java.util.Arrays;
import com.android.internal.app.IBatteryStats;
import com.android.internal.location.nano.GnssLogsProto.GnssLog;
import com.android.internal.location.nano.GnssLogsProto.PowerMetrics;
public class GnssMetrics {
private static final String TAG = GnssMetrics.class.getSimpleName();
public static final int GPS_SIGNAL_QUALITY_POOR = 0;
public static final int GPS_SIGNAL_QUALITY_GOOD = 1;
public static final int NUM_GPS_SIGNAL_QUALITY_LEVELS = GPS_SIGNAL_QUALITY_GOOD + 1;
private static final int DEFAULT_TIME_BETWEEN_FIXES_MILLISECS = 1000;
private String logStartInElapsedRealTime;
private GnssPowerMetrics mGnssPowerMetrics;
public GnssMetrics(IBatteryStats stats) {
mGnssPowerMetrics = new GnssPowerMetrics(stats);
locationFailureStatistics = new Statistics();
timeToFirstFixSecStatistics = new Statistics();
positionAccuracyMeterStatistics = new Statistics();
topFourAverageCn0Statistics = new Statistics();
reset();
}
public void logReceivedLocationStatus(boolean isSuccessful) {
if (!isSuccessful) {
locationFailureStatistics.addItem(1.0);
return;
}
locationFailureStatistics.addItem(0.0);
return;
}
public void logMissedReports(int desiredTimeBetweenFixesMilliSeconds,
int actualTimeBetweenFixesMilliSeconds) {
int numReportMissed = (actualTimeBetweenFixesMilliSeconds /
Math.max(DEFAULT_TIME_BETWEEN_FIXES_MILLISECS, desiredTimeBetweenFixesMilliSeconds)) - 1;
if (numReportMissed > 0) {
for (int i = 0; i < numReportMissed; i++) {
locationFailureStatistics.addItem(1.0);
}
}
return;
}
public void logTimeToFirstFixMilliSecs(int timeToFirstFixMilliSeconds) {
timeToFirstFixSecStatistics.addItem((double) (timeToFirstFixMilliSeconds/1000));
return;
}
public void logPositionAccuracyMeters(float positionAccuracyMeters) {
positionAccuracyMeterStatistics.addItem((double) positionAccuracyMeters);
return;
}
public void logCn0(float[] cn0s, int numSv) {
if (numSv == 0 || cn0s == null || cn0s.length == 0 || cn0s.length < numSv) {
if (numSv == 0) {
mGnssPowerMetrics.reportSignalQuality(null, 0);
}
return;
}
float[] cn0Array = Arrays.copyOf(cn0s, numSv);
Arrays.sort(cn0Array);
mGnssPowerMetrics.reportSignalQuality(cn0Array, numSv);
if (numSv < 4) {
return;
}
if (cn0Array[numSv - 4] > 0.0) {
double top4AvgCn0 = 0.0;
for (int i = numSv - 4; i < numSv; i++) {
top4AvgCn0 += (double) cn0Array[i];
}
top4AvgCn0 /= 4;
topFourAverageCn0Statistics.addItem(top4AvgCn0);
}
return;
}
public String dumpGnssMetricsAsProtoString() {
GnssLog msg = new GnssLog();
if (locationFailureStatistics.getCount() > 0) {
msg.numLocationReportProcessed = locationFailureStatistics.getCount();
msg.percentageLocationFailure = (int) (100.0 * locationFailureStatistics.getMean());
}
if (timeToFirstFixSecStatistics.getCount() > 0) {
msg.numTimeToFirstFixProcessed = timeToFirstFixSecStatistics.getCount();
msg.meanTimeToFirstFixSecs = (int) timeToFirstFixSecStatistics.getMean();
msg.standardDeviationTimeToFirstFixSecs
= (int) timeToFirstFixSecStatistics.getStandardDeviation();
}
if (positionAccuracyMeterStatistics.getCount() > 0) {
msg.numPositionAccuracyProcessed = positionAccuracyMeterStatistics.getCount();
msg.meanPositionAccuracyMeters = (int) positionAccuracyMeterStatistics.getMean();
msg.standardDeviationPositionAccuracyMeters
= (int) positionAccuracyMeterStatistics.getStandardDeviation();
}
if (topFourAverageCn0Statistics.getCount() > 0) {
msg.numTopFourAverageCn0Processed = topFourAverageCn0Statistics.getCount();
msg.meanTopFourAverageCn0DbHz = topFourAverageCn0Statistics.getMean();
msg.standardDeviationTopFourAverageCn0DbHz
= topFourAverageCn0Statistics.getStandardDeviation();
}
msg.powerMetrics = mGnssPowerMetrics.buildProto();
msg.hardwareRevision = SystemProperties.get("ro.boot.revision", "");
String s = Base64.encodeToString(GnssLog.toByteArray(msg), Base64.DEFAULT);
reset();
return s;
}
public String dumpGnssMetricsAsText() {
StringBuilder s = new StringBuilder();
s.append("GNSS_KPI_START").append('\n');
s.append(" KPI logging start time: ").append(logStartInElapsedRealTime).append("\n");
s.append(" KPI logging end time: ");
TimeUtils.formatDuration(SystemClock.elapsedRealtimeNanos() / 1000000L, s);
s.append("\n");
s.append(" Number of location reports: ").append(
locationFailureStatistics.getCount()).append("\n");
if (locationFailureStatistics.getCount() > 0) {
s.append(" Percentage location failure: ").append(
100.0 * locationFailureStatistics.getMean()).append("\n");
}
s.append(" Number of TTFF reports: ").append(
timeToFirstFixSecStatistics.getCount()).append("\n");
if (timeToFirstFixSecStatistics.getCount() > 0) {
s.append(" TTFF mean (sec): ").append(timeToFirstFixSecStatistics.getMean()).append("\n");
s.append(" TTFF standard deviation (sec): ").append(
timeToFirstFixSecStatistics.getStandardDeviation()).append("\n");
}
s.append(" Number of position accuracy reports: ").append(
positionAccuracyMeterStatistics.getCount()).append("\n");
if (positionAccuracyMeterStatistics.getCount() > 0) {
s.append(" Position accuracy mean (m): ").append(
positionAccuracyMeterStatistics.getMean()).append("\n");
s.append(" Position accuracy standard deviation (m): ").append(
positionAccuracyMeterStatistics.getStandardDeviation()).append("\n");
}
s.append(" Number of CN0 reports: ").append(
topFourAverageCn0Statistics.getCount()).append("\n");
if (topFourAverageCn0Statistics.getCount() > 0) {
s.append(" Top 4 Avg CN0 mean (dB-Hz): ").append(
topFourAverageCn0Statistics.getMean()).append("\n");
s.append(" Top 4 Avg CN0 standard deviation (dB-Hz): ").append(
topFourAverageCn0Statistics.getStandardDeviation()).append("\n");
}
s.append("GNSS_KPI_END").append("\n");
GpsBatteryStats stats = mGnssPowerMetrics.getGpsBatteryStats();
if (stats != null) {
s.append("Power Metrics").append("\n");
s.append(" Time on battery (min): "
+ stats.getLoggingDurationMs() / ((double) DateUtils.MINUTE_IN_MILLIS)).append("\n");
long[] t = stats.getTimeInGpsSignalQualityLevel();
if (t != null && t.length == NUM_GPS_SIGNAL_QUALITY_LEVELS) {
s.append(" Amount of time (while on battery) Top 4 Avg CN0 > " +
Double.toString(GnssPowerMetrics.POOR_TOP_FOUR_AVG_CN0_THRESHOLD_DB_HZ) +
" dB-Hz (min): ").append(t[1] / ((double) DateUtils.MINUTE_IN_MILLIS)).append("\n");
s.append(" Amount of time (while on battery) Top 4 Avg CN0 <= " +
Double.toString(GnssPowerMetrics.POOR_TOP_FOUR_AVG_CN0_THRESHOLD_DB_HZ) +
" dB-Hz (min): ").append(t[0] / ((double) DateUtils.MINUTE_IN_MILLIS)).append("\n");
}
s.append(" Energy consumed while on battery (mAh): ").append(
stats.getEnergyConsumedMaMs() / ((double) DateUtils.HOUR_IN_MILLIS)).append("\n");
}
s.append("Hardware Version: " + SystemProperties.get("ro.boot.revision", "")).append("\n");
return s.toString();
}
private class Statistics {
public void reset() {
count = 0;
sum = 0.0;
sumSquare = 0.0;
}
public void addItem(double item) {
count++;
sum += item;
sumSquare += item * item;
}
public int getCount() {
return count;
}
public double getMean() {
return sum/count;
}
public double getStandardDeviation() {
double m = sum/count;
m = m * m;
double v = sumSquare/count;
if (v > m) {
return Math.sqrt(v - m);
}
return 0;
}
private int count;
private double sum;
private double sumSquare;
}
private Statistics locationFailureStatistics;
private Statistics timeToFirstFixSecStatistics;
private Statistics positionAccuracyMeterStatistics;
private Statistics topFourAverageCn0Statistics;
private void reset() {
StringBuilder s = new StringBuilder();
TimeUtils.formatDuration(SystemClock.elapsedRealtimeNanos() / 1000000L, s);
logStartInElapsedRealTime = s.toString();
locationFailureStatistics.reset();
timeToFirstFixSecStatistics.reset();
positionAccuracyMeterStatistics.reset();
topFourAverageCn0Statistics.reset();
return;
}
private class GnssPowerMetrics {
public static final double POOR_TOP_FOUR_AVG_CN0_THRESHOLD_DB_HZ = 20.0;
private static final double REPORTING_THRESHOLD_DB_HZ = 1.0;
private final IBatteryStats mBatteryStats;
private double mLastAverageCn0;
public GnssPowerMetrics(IBatteryStats stats) {
mBatteryStats = stats;
mLastAverageCn0 = -100.0;
}
public PowerMetrics buildProto() {
PowerMetrics p = new PowerMetrics();
GpsBatteryStats stats = mGnssPowerMetrics.getGpsBatteryStats();
if (stats != null) {
p.loggingDurationMs = stats.getLoggingDurationMs();
p.energyConsumedMah = stats.getEnergyConsumedMaMs() / ((double) DateUtils.HOUR_IN_MILLIS);
long[] t = stats.getTimeInGpsSignalQualityLevel();
p.timeInSignalQualityLevelMs = new long[t.length];
for (int i = 0; i < t.length; i++) {
p.timeInSignalQualityLevelMs[i] = t[i];
}
}
return p;
}
public GpsBatteryStats getGpsBatteryStats() {
try {
return mBatteryStats.getGpsBatteryStats();
} catch (Exception e) {
Log.w(TAG, "Exception", e);
return null;
}
}
public void reportSignalQuality(float[] ascendingCN0Array, int numSv) {
double avgCn0 = 0.0;
if (numSv > 0) {
for (int i = Math.max(0, numSv - 4); i < numSv; i++) {
avgCn0 += (double) ascendingCN0Array[i];
}
avgCn0 /= Math.min(numSv, 4);
}
if (Math.abs(avgCn0 - mLastAverageCn0) < REPORTING_THRESHOLD_DB_HZ) {
return;
}
try {
mBatteryStats.noteGpsSignalQuality(getSignalLevel(avgCn0));
mLastAverageCn0 = avgCn0;
} catch (Exception e) {
Log.w(TAG, "Exception", e);
}
return;
}
private int getSignalLevel(double cn0) {
if (cn0 > POOR_TOP_FOUR_AVG_CN0_THRESHOLD_DB_HZ) {
return GnssMetrics.GPS_SIGNAL_QUALITY_GOOD;
}
return GnssMetrics.GPS_SIGNAL_QUALITY_POOR;
}
}
}