Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1e856cb authored by gomo's avatar gomo
Browse files

Make the comments of some of the raw GNSS measurements more clear. 

Test: Existing unit tests still pass.

Change-Id: I8c0a506b2c9f7979f8cdb33c9e65db53ff1c4b2b
parent 127ba323

location/java/android/location/GnssMeasurement.java

+15 −8
Original line number Diff line number Diff line
@@ -660,8 +660,14 @@ public final class GnssMeasurement implements Parcelable { 
    /**

     * Gets the carrier frequency of the tracked signal.

     *

     * <p>For example it can be the GPS L1 = 1.57542e9 Hz, or L2, L5, varying GLO channels, etc. If

     * the field is not set, it is the primary common use frequency, e.g. L1 for GPS.

     * <p>For example it can be the GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz,

     * L5 = 1176.45 MHz, varying GLO channels, etc. If the field is not set, it is the primary

     * common use central frequency, e.g. L1 = 1575.45 MHz for GPS.

     *

     * For an L1, L5 receiver tracking a satellite on L1 and L5 at the same time, two raw

     * measurement objects will be reported for this same satellite, in one of the measurement

     * objects, all the values related to L1 will be filled, and in the other all of the values

     * related to L5 will be filled.

     *

     * <p>The value is only available if {@link #hasCarrierFrequencyHz()} is {@code true}.

     */
@@ -892,11 +898,12 @@ public final class GnssMeasurement implements Parcelable { 
    /**

     * Gets the Automatic Gain Control level in dB.

     *

     * <p> AGC acts as a variable gain amplifier adjusting the power of the incoming signal to

     * minimize the quantization losses. The AGC level may be used to indicate potential

     * interference. When AGC is at a nominal level, this value must be set as 0.  Higher gain

     * (and/or lower input power) shall be output as a positive number. Hence in cases of strong

     * jamming, in the band of this signal, this value will go more negative.

     * <p> AGC acts as a variable gain amplifier adjusting the power of the incoming signal. The AGC

     * level may be used to indicate potential interference. When AGC is at a nominal level, this

     * value must be set as 0. Higher gain (and/or lower input power) shall be output as a positive

     * number. Hence in cases of strong jamming, in the band of this signal, this value will go more

     * negative.

     *

     * <p>Note: Different hardware designs (e.g. antenna, pre-amplification, or other RF HW

     * components) may also affect the typical output of of this value on any given hardware design

     * in an open sky test - the important aspect of this output is that changes in this value are

location/java/android/location/GnssStatus.java

+7 −2
Original line number Diff line number Diff line
@@ -231,8 +231,13 @@ public final class GnssStatus { 
    /**

     * Gets the carrier frequency of the signal tracked.

     *

     * For example it can be the GPS L1 = 1.57542e9 Hz, or L2, L5, varying GLO channels, etc. If

     * the field is not set, it is the primary common use frequency, e.g. L1 for GPS.

     * <p>For example it can be the GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz,

     * L5 = 1176.45 MHz, varying GLO channels, etc. If the field is not set, it is the primary

     * common use central frequency, e.g. L1 = 1575.45 MHz for GPS.

     *

     * For an L1, L5 receiver tracking a satellite on L1 and L5 at the same time, two measurements

     * will be reported for this same satellite, in one all the values related to L1 will be filled,

     * and in the other all of the values related to L5 will be filled.

     *

     * <p>The value is only available if {@link #hasCarrierFrequency(int satIndex)} is {@code true}.

     */