Programmatic Interface - Satellite Commands

These commands are associated with GPS or WAAS/EGNOS satellites. They allow you to determine information about the current satellite constellation including what is being tracked, satellite health, almanac and Ephemeris data, etc. Override controls are available to disable or force the usage of individual satellites.



List of all commands
Programmatic Overview


Show TrackingStatus

Returns a multi-line response showing which satellites are currently being tracked and several parametersa bout those satellites.


Parameters:

No parameters are available.


Response:
<ShowTrackingStatus>
Chan=0  PRN=2   Elv=28   Azm=47  L1snr=40 L2snr=31 IODE=0   URA=2.0
Chan=1  PRN=16  Elv=4    Azm=41  L1snr=32 L2snr=0  IODE=54  URA=2.0
Chan=3  PRN=10  Elv=12   Azm=321 L1snr=32 L2snr=16 IODE=185 URA=2.0
Chan=4  PRN=3   Elv=25   Azm=77  L1snr=39 L2snr=30 IODE=137 URA=2.8
Chan=5  PRN=134 Elv=15   Azm=250 L1snr=35
Chan=6  PRN=20  Elv=1    Azm=170 L1snr=0  L2snr=0  IODE=219 URA=2.0
Chan=7  PRN=1   Elv=46   Azm=119 L1snr=44 L2snr=40 IODE=120 URA=2.8
Chan=10 PRN=13  Elv=77   Azm=92  L1snr=47 L2snr=46 IODE=115 URA=2.8
Chan=11 PRN=28  Elv=12   Azm=214 L1snr=37 L2snr=20 IODE=34  URA=2.8
<end of ShowTrackingStatus>

Show GpsHealth

Returns a complete listing of the health state of all 32 GPS satellites. For unhealthy satellites, the health code is shown. Unknown satellites are those that are unknown (have no data) in the almanacs.


Parameters:

No parameters are available.


Response:
GpsHealth healthy=1-4,6-11,13-18,20,21,23-31 unhealthy=5:63 unknown=12,19,22,32

Show GpsSatControls

Shows the Enable/Disable/Ignorehealth control state for each GPS satellite.


Parameters:

No parameters are available.


Response:
GpsSatControls enable=all disable=5,6 ignoreHealth=7

Set GpsSatControls

Sets the Enable/Disable/Ignorehealth control state for one or more GPS satellites.

This command can be used to control all satellite controls at once, or to change the state of a limited subset. If the 'all' keyword is used in a list, then the setting for every satellite is set. Otherwise, only those satellites explicitly mentioned are affected. The response string always shows the complete settings list, as would bs seen under Show GpsSatControls.


Parameters:

enable=list List of satelites to be set 'Enabled'.
disable=list List of satelites to be set 'Disabled'.
ignoreHealth=list List of satelites to be set to 'IgnoreHealth'.
  • One or more of the possible parameters must be specified.
  • list can be a comma separated list of satellite numbers from 1..32.
  • list can be blank or 'none'.
  • One of the lists can be 'all' to indicate a 'default unless otherwise specified'.
  • This enables all satellites:
    Set GpsSatControls enable=all
  • This disables a single satellite, leaving the other controls as they were.
    Set GpsSatControls disable=7

Response:
OK: GpsSatControls enable=all disable=5,6 ignoreHealth=7
  • See the Response section of Show GpsSatControls for details of the response.
  • All satellites settings will be shown in the response, regardless of which settings are actually specified in the command.

Show GpsEphemeris

Returns a multi-line response showing the most recently received Ephemeris data for a specified GPS satellite.


Parameters:

prn=PrnNumber The PRN number (1 to 32) of the satelite.


Response:
<Show GpsEphemeris prn=1>
ID:                         01
IODC:                       0120
Eccentricity:               5.246064276E-03
Time of Applicability(s):   4.176000000E+05
Orbital Inclination(rad):   9.766570346E-01
Rate of Right Ascen(r/s):  -7.853898865E-09
SQRT(A) (m^1/2):            5.153642370E+03
Right Ascen at TOA(rad):    3.656759551E-01
Argument of Perigee(rad):  -1.727029984E+00
Mean Anom(rad):            -9.249746419E-01
mean motion diff(r/s):      4.054454550E-09
Rate of inclin (r/s):       5.428797412E-10
lat cosine ampl (r):        1.898035407E-06
Lat sine ampl   (r):        9.672716260E-06
radius cos ampl (m):        2.019375000E+02
radius sin ampl (m):        3.484375000E+01
inclin cos ampl(r):        -5.774199963E-08
inclin sin ampl(r):         6.519258022E-08
week:                       1243
t_gd:                      -3.259629011E-09
t_oc:                       4.176000000E+05
Af0(s):                     3.139334731E-04
Af1(s/s):                   2.046363079E-12
Af2(s/s/s):                 0.000000000E+00
<end of Show GpsEphemeris prn=1>

Show GpsAlmanac

Returns a multi-line response showing the most recently received Ephemeris data for a specified GPS satellite.


Parameters:

prn=PrnNumber The PRN number (1 to 32) of the satelite.


Response:
<Show GpsAlmanac prn=1>
ID:                         1
Health:                     000
Eccentricity:               5.251884460E-03
Time of Applicability(s):   5.898240000E+05
Orbital Inclination(rad):   9.767347574E-01
Rate of Right Ascen(r/s):  -7.486026021E-09
SQRT(A) (m^1/2):            5.153600586E+03
Right Ascen at TOA(rad):    3.643556535E-01
Argument of Perigee(rad):  -1.727030873E+00
Mean Anom(rad):            -9.370592833E-01
Af0(s):                     3.147125244E-04
Af1(s/s):                   3.637978807E-12
week:                       1243
<end of Show GpsAlmanac prn=1>

Show GpsUtcData

Returns a multi-line response, showing the most recently decoded UTC parameters. These describe the current relationship between the UTC and GPS time systems.


Parameters:

No parameters are available.


Response:
<Show GpsUtcData>
A_0 (s):         -8.381903172E-09
A_1 (s/s):       -2.131628207E-14
DELTA_T_LS (s):         13
T_OT (s):         5.898240000E+05
WN_T (wk):            1243
WN_LSF (wk):          1246
DN (days):               5
DELTA_T_LF (s):         13
<end of Show GpsUtcData>

Show GpsIonoData

Returns a multi-line response, showing the most recently decoded GPS Ionospheric Model parameters.


Parameters:

No parameters are available.


Response:
<Show GpsIonoData>
ALPHA_0 (sec):                 3.073364496E-08
ALPHA_1 (sec/semicircle):      0.000000000E+00
ALPHA_2 (sec/semicircle^2):   -1.192092896E-07
ALPHA_3 (sec/semicircle^3):    1.788139343E-07
BETA_0  (sec):                 1.413120000E+05
BETA_1  (sec/semicircle):     -9.830400000E+04
BETA_2  (sec/semicircle^2):    6.553600000E+04
BETA_3  (sec/semicircle^3):   -3.932160000E+05
<end of Show GpsIonoData>

Reset GpsData

Erases all decoded GPS Almanac, Ephemeris, UTC and Iono data. This requires a restart of the GPS tracking subsystem, and WILL result in a short period of lost measurements and communications.


Parameters:

No parameters are available.


Response:
OK: Clearing GpsData and restarting satellite tracking operations.
  • The response is returned a few seconds before the actual erasure process begins.

Show WaasTracking

Shows the current state of the control that enables tracking and usage of WAAS/EGNOS satellites.


Parameters:

No parameters are available.


Response:
WaasTracking enable=yes
  • Enable will be either 'yes' or 'no'.

Set WaasTracking

Sets the control that enables tracking and usage of WAAS/EGNOS satellites.


Parameters:

enable=state The new control state.
Can be either 'yes' or 'no'.


Response:
OK: WaasTracking enable=yes

Show WaasSatControls

Shows the Enable/Disable/Ignorehealth control state for each WAAS/EGNOS satellite.


Parameters:

No parameters are available.


Response:
WaasSatControls disable=all enable=122,134 ignoreHealth=none
  • WAAS/EGNOS Satellites use PRN values in the range from 120 to 138.
  • "Enable" is a comma separated list of satellites whose control setting is "Track only if healthy".
  • "Disable" is a comma separated list of satellites whose control setting is "Don't use this satellite".
  • "IgnoreHealth" is a comma separated list of satellites whose control setting is "Use if available, regardless of health." These satellites will be tracked and their differential corrections used, even if they are known to be unhealthy.
  • One parameter may be specified as "all', which is the default for all satellites that aren't explicitly mentioned in other sections. For example, in the above sample, satellites 122 and 134 are disabled, no satellites are set to ignore health, and all others satellites are disabled.
  • If a list is empty, then it will indicate "none".
  • Lists for this Response do not use the '120-127' syntax that is used for 'Show GpsSatControls'.

Set WaasSatControls

Sets the Enable/Disable/Ignorehealth control state for one or more WAAS/EGNOS satellites.

This command can be used to control all satellite controls at once, or to change the state of a limited subset. If the 'all' keyword is used in a list, then the control for every satellite is set. Otherwise, only those satellites explicitly mentioned are affected. The response string always shows the complete settings list, as would bs seen under Show WaasSatControls.


Parameters:

enable=list List of satelites to be set 'Enabled'.
disable=list List of satelites to be set 'Disabled'.
ignoreHealth=list List of satelites to be set to 'IgnoreHealth'.
  • One or more of the possible parameters must be specified.
  • list can be a comma separated list of satellite numbers from 120..138.
  • list can be blank or 'none'.
  • One of the lists can be 'all' to indicate a 'default unless otherwise specified'.
  • This disables all satellites except one:
    Set WaasSatControls disable=all enable=134
  • This enables a single satellite, leaving the other controls as they were.
    Set GpsSatControls enable=122

Response:
OK: WaasSatControls disable=all enable=134 ignoreHealth=none
  • See Show WaasSatControls for details on the Response.