Programmatic Interface - Configuration Commands

These commands implement numerous controls that affect the operation of the GPS receiver.



List of all commands
Programmatic Overview


Reset System

Restarts this NetRS. This causes the system to shut down all active operations. The NetRS then reboots and, after approximately two minutes, resumes normal operations. This is roughly equivalent to pressing the front panel power button, waiting for the system to shut down, and then pressing the button again to turn the system back on.

It should be noted that this can have a serious impact on data logging and I/O streaming. Any active data logging Sessions will be halted during the reboot. Sessions should resume logging, usually to the original files, but there can be several minutes of missing data.

Likewise I/O streams can experience a disruption. There can be missing data, and TCP or UDP connections may not be re-established automatically.

The reponse to the restart command will come back immediately. The actual system shutdown will be delayed for about five seconds.


Parameters:

No parameters are available.


Response:
OK: Restarting this NetRS.

Show ReferenceFrequency

This command shows the state of the Reference Frequency source control, and whether an external Reference Frequency signal is detected.

The Reference Frequency is a 10MHz signal that drives all clocks within the NetRS. The source for this signal can be either an internal crystal oscillator, or a user-supplied external signal. Show ReferenceFrequency shows the currently selected source. The response also shows whether a valid external signal is present at the input to the receiver.


Parameters:

No parameters are available.


Response:
ReferenceFrequency source=internal externalSignalDetected=yes

Set ReferenceFrequency

This command modifies the state of the Reference Frequency source control.

The Reference Frequency is a 10MHz signal that drives all clocks within the NetRS. The source for this signal can be either an internal crystal oscillator, or a user-supplied external signal. Show ReferenceFrequency shows the currently selected source. The response also shows whether a valid external signal is present at the input to the receiver.

Switching between Reference Frequency sources will momentarily disupt signal tracking, resulting in missing logged data records, and interrupted I/O data streams. The signal tracking function must be restarted and all operations dependent on that subsystem will also be restarted.

Switching this control to 'external', when no external siganl is available will result in loss of all GPS measurements until a signal is supplied. The status of the signal is indicated in the response.

For symmetry with the Show ReferenceFrequency command, a parameter "externalSignalDetected" will be accepted but will be ignored.


Parameters:

source=internal Specifies whether the Reference Frequency should use an 'internal' or 'external' source.
externalSignalDetected=yes This parameter is accepted but ignored.


Response:
OK: ReferenceFrequency source=internal externalSignalDetected=yes

Show ElevationMask

This command shows the current setting of the Elevation Mask control. The Elevation Mask defines an elevation limit below which GPS satellites will not be tracked or used.


Parameters:

No parameters are available.


Response:
ElevationMask mask=5

Set ElevationMask

This command modifies the Elevation Mask control. The Elevation Mask defines an elevation limit below which GPS satellites will not be tracked or used.



Parameters:

mask=10 The desired Elevation Mask in degrees. Valid range is -10 to 90.


Response:
OK: ElevationMask mask=10

Show PdopMask

This command shows the current setting of the PDOP Mask control. The PDOP Mask defines a limit for the PDOP of a position fix. Position fixes with a PDOP above the mask will not be presented to the user, logged into data files, etc.


Parameters:

No parameters are available.


Response:
PdopMask mask=7

Set PdopMask

This command modifies the PDOP Mask control. The PDOP Mask defines a limit for the PDOP of a position fix. Position fixes with a PDOP above the mask will not be presented to the user, logged into data files, etc.


Parameters:

mask=10 The desired PDOP Mask.
PDOP is a unitless measurement.
Valid range is 0 to 99.


Response:
OK: PdopMask mask=10

Show ClockSteering

This command shows the current setting of the Clock Steering control. When Clock Steering is enabled, the receiver will adjust its internal measurements to produce a clock offset of zero.


Parameters:

No parameters are available.


Response:
ClockSteering enable=yes

Set ClockSteering

This command Modifies the setting of the Clock Steering control. When Clock Steering is enabled, the receiver will adjust its internal measurements to produce a clock offset of zero.


Parameters:

enable=yes The desired setting of the control, either 'yes' or 'no'.


Response:
OK: ClockSteering enable=yes

Show MultipathReject

This command shows the current setting of the Multipath Reject control. When Multipath Reject is enabled, the receiver will use Everest® Multipath Reduction to reduce the effects of multiple signal paths on GPS measurements.


Parameters:

No parameters are available.


Response:
MultipathReject enable=yes

Set MultipathReject

This command modifies the setting of the Multipath Reject control. When Multipath Reject is enabled, the receiver will use Everest® Multipath Reduction to reduce the effects of multiple signal paths on GPS measurements.


Parameters:

enable=no The desired setting of the control, either 'yes' or 'no'.


Response:
OK: MultipathReject enable=no

Show PPS

This command returns the current control settings of the Pulse-Per-Second (PPS) function. The PPS function can generate electrical signals that are precisely aligned to UTC. The PPS function can be enabled or not, and the timing edge of the pulse can be selected as positive-going or negative-going.


Parameters:

No parameters are available.


Response:
PPS enable=yes slope=positive

Set PPS

This command modifies the control settings of the Pulse-Per-Second (PPS) function. The PPS function can generate electrical signals that are precisely aligned to UTC. The PPS function can be enabled or not, and the timing edge of the pulse can be selected as positive-going or negative-going.


Parameters:

enable=yes Either 'yes' or 'no' to enable or disable generation of PPS pulses.
slope=negative Either 'positive' or 'negative'. Sets the precisely timed edge to the selected slope.


Response:
OK: PPS enable=yes slope=negative

Show L2C

This command shows the current setting of the L2C control. When L2C is enabled, the receiver will attempt to track L2C signals on the L2 channels.


Parameters:

No parameters are available.


Response:
L2C enable=no

Set L2C

This command modifies the current setting of the L2C control. When L2C is enabled, the receiver will attempt to track L2C signals on the L2 channels.


Parameters:

enable=yes The desired setting of the control, either 'yes' or 'no'.


Response:
OK: L2C enable=yes

Show AntennaTypes

This command returns a multi-line response, showing which antenna types are supported in the NetRS antenna database. This is primarily of use in determining how to specify an antenna with the Set Antenna command. Antennas can be selected by specifying one of

The list of possible values for each antenna are listed by Show AntennaTypes. Each line of the response shows a single antenna type, which can be specified by any one of the four different identifiers.

Note that the sample Response below is not complete and should not be used as a reference.


Parameters:

No parameters are available.


Response:
<Show AntennaTypes>
type=0   code=E  NgsIgs=             name=Unknown_External
type=20  code=P0 NgsIgs=TRM23903.00  name=Permanent_L1/L2
type=23  code=DT NgsIgs=AOAD/M_T     name=Dorne_Margolin_Model_T
type=27  code=G2 NgsIgs=TRM29659.00  name=Choke_Ring
<end of Show AntennaTypes>

Show Antenna

Using the command Set Antenna, the user can select an antenna type, and can enter several other values describing the current antenna installation. This command returns a single-line response showing the characteristics of the previously specified antenna setup. These values are inserted in appropriate places in logged data files, streamed output formats, etc.


Parameters:

No parameters are available.


Response:
Antenna serialNumber=12345 type=27 refPoint=APC 
        height=1.234 name=Choke_Ring 
        code=G2 NgsIgs=TRM29659.00

Set Antenna

This command can be used to specify the characteristics of the antenna attached to this NetRS. The basic antenna type can be specified using one of several methods . A serial number, height measurement, and height reference point method can also be specified. These values are inserted in appropriate places in logged data files, streamed output formats, etc.

The basic type of the antenna can be specified using four equivalent parameters, Type, Name, Code or NgsIgs. Only one of them needs to be supplied to set the antenna type. Overspecifying is acceptable.

The existing antenna setup parameters are used as the defaults for all unspecified parameters. Thus, for example, it is possible to specify only a new Height measurement, while leaving all other parameters alone. The response to this command will always show all of the antenna setup parameters, regardless of how many parameters are actually specified in the command.


Parameters:

serialNumber=12345 The serial number of the antenna.
type=27 A Trimble-specific numeric identifier for the antenna.
refPoint=APC RefPoint is one of several methods used to specify the reference point for the antenna height measurement. Possible values are:
  • 'APC' [Antenna Phase Center]
  • 'Bottom_of_Antenna_Mount'
  • 'Bottom_edge_of_choke_ring'
  • 'Bottom_of_notch'
  • 'Bottom_of_notch_on_ground_plane'
  • 'Bottom_edge_of_ground_plane'
Spaces within the string should be replaced with underscores, or they can be left out altogether.
height=1.234 The Antenna Height in meters.
name=Choke_Ring The descriptive name of the antenna type.
Spaces within the string should be replaced with underscores, or they can be left out altogether.
code=G2 The one- or two-character code for the antenna type.
NgsIgs=TRM29659.00 The NGS- or IGS-defined string describing this antenna.
Spaces within the string should be replaced with underscores, or they can be left out altogether.


Response:
OK: Antenna serialNumber=12345 type=27 refPoint=APC 
            height=1.234 name=Choke_Ring 
            code=G2 NgsIgs=TRM29659.00