Programmatic Interface - I/O Commands

These commands allow control over Input and Output streams over Serial ports, TCP or UDP connections. The NetRS has four serial ports, which are always defined. In addition, you can define TCP protcol or UDP protocol ports that can provide services over the Ethernet or over a PPP connection on a serial port. Port Configuration Parameters are available for adjusting the characteristics of the ports.

For those commands that require the specification of an I/O port, these three parameter formats are allowed:
port=SerialPortX where X is 1, 2, 3 or 4.
port=TcpPortXXXX where XXXX is between 1024 and 65535.
port=UdpPortXXXX where XXXX is between 1024 and 65535.

Each ports can be assigned a Service, such as PPP or RT17 data streaming, The service determines what sort of data stream or protocol will be configured on the port. Each service has a set of Service Configuration Parameters that allow configuration of the specific characteristics of that service.

The following commands are available for controlling I/O Ports:

Port-Type-Specific Configuration Parameters
Service-Specific Configuration Parameters
Other I/O Port Configuration Parameters

List of all commands
Programmatic Overview


Show IOstatus

This command returns a multi-line response describing all active IOports. The list will include:

For each active port, the type of data service is indicated. For TCP and UDP ports, the IP address of the remote system is also shown.

Parameters:

No parameters are available.

Response:

<Show IOstatus>
IOport name=SerialPort2 service=met
IOport name=SerialPort3 service=rt17
IOport name=TcpPort9999 service=rt17 remoteIP=192.168.142.7
<end of Show IOstatus>

Show IOports

This command produces a multi-line response that contains a complete listing of all defined I/O ports and their setup parameters.

Parameters:

No parameters are available.

Response:

<Show IOports>

IOport port=SerialPort1 service=ppp baud=115200 flow=None 
       localIP=1.1.1.1 remoteIP=1.1.1.2 connection=Direct enable=yes

IOport port=SerialPort2 service=Met 
       cmd1=60:0102P9 cmd2=off cmd3=off cmd4=off cmd5=off cmd6=off 
       baud=57600 parity=None flow=None enable=yes 

IOport port=SerialPort3 service=ppp baud=115200 flow=None 
       localIP=192.168.0.1 remoteIP=192.168.0.30 connection=Direct
       enable=yes

IOport port=SerialPort4 service=ppp baud=2400 flow=None 
       localIP=192.168.0.1 remoteIP=192.168.0.40 
       connection=Modem 
       reset=Reset init1=Init1 init2=init2 init3=intit3
       enable=yes

IOport port=TcpPort5020 service=Ephemerides enable=yes clientAuth=no

IOport port=TcpPort5021 service=Almanacs enable=yes clientAuth=no

IOport port=TcpPort5022 service=SvStatus enable=no clientAuth=no

IOport port=TcpPort9999 service=RT17 interval=1 measurements=yes 
       positions=no concise=yes iodeslips=no GPSdata=no rawGPS=no 
       rawWAAS=no smoothCode=no smoothCarrier=no
       enable=yes clientAuth=yes

<end of Show IOports>

Show IOport

This command returns a description of an individual I/O port and its setup parameters. The format is the same as a single IOport line in the Show IOports command.

Parameters:

port=portName The port for which data is requested. The name must be of the form:
port=SerialPortX where X is 1, 2, 3 or 4.
port=TcpPortXXXX where XXXX is between 1024 and 65535.
port=UdpPortXXXX where XXXX is between 1024 and 65535.
port=RepPortXXXX where XXXX is between 1024 and 65535.

Response:

IOport port=TcpPort9999 service=RT17 interval=1 measurements=yes 
       positions=no concise=yes iodeslips=no GPSdata=no rawGPS=no 
       rawWAAS=no smoothCode=no smoothCarrier=no
       enable=yes clientAuth=no

Set IOport

This command is used to create or modify the settings of an I/O port. The port is specified with a 'port=' parameter. Each port is assigned a "service" type, describing what type of data or activity is desired on the port. Depending on the service, numerous other parameters are available to customize the service.

Parameters:

port=portName The port for which data is requested. The name must be of the form:
port=SerialPortX where X is 1, 2, 3 or 4.
port=TcpPortXXXX where XXXX is between 1024 and 65535.
port=UdpPortXXXX where XXXX is between 1024 and 65535.
port=RepPortXXXX where XXXX is between 1024 and 65535.
If the port is a SerialPort or a UdpPort, then other Port-Type Specific Configuration Parameters must be supplied.
Most ports also can be supplied "Enable" or "ClientAuth" parameters. See Other I/O Port Configuration Parameters for details.
service=ServiceName Defines the type of activity desired on this port.
  • PPP - Point to Point Protocol.
    Implements a TCP/IP protocol over a serial port.
  • RT17 - Streams RT17 format data.
  • Binex - Streams Binex format data.
  • RTCM - Provides GPS differential correcitons.
  • CMR - Provides raw GPS measurements for RTK systems.
  • Met - Interfaces to external environmental sensors.
  • Ephemerides Dumps complete set of GPS ephemeris data.
  • Almanacs Dumps complete set of GPS almanac data.
  • SvStatus Dumps information about GPS satellite tracking status.
  • Trimcom Implements an subset of Trimcom I/O protocol.
The remaining parameters are dependent on the type of service selected. Click on the service links above to see which parameters are appropriate for the desired service.

Response:

OK: IOport port=TcpPort9999 service=RT17 interval=1 measurements=yes 
           positions=no concise=yes iodeslips=no GPSdata=no rawGPS=no 
           rawWAAS=no smoothCode=no smoothCarrier=no
           enable=yes clientAuth=no

Delete IOport

This command deactivates a specified port and removes its definition from the NetRS.

Only TCP and UDP ports can be deleted. To deactivate a Serial port stream, use 'Set IOport' to set its service type to PPP.

Parameters:

port=portName The port to be deleted. The name must be of the form:
port=TcpPortXXXX where XXXX is between 1024 and 65535.
port=UdpPortXXXX where XXXX is between 1024 and 65535.
all=yes Deletes ALL TCP and UDP ports.

Responses:

OK: IOport portName is deleted.

OK: All TCP and UDP IOports have been deleted.

Show RefStation

This command returns the current parameters defining the Reference Station setup. These values are used by CMR or RTCM output streams.

Note that two forms of response are possible, selected by the optional style parameter. If Style is llh then Latitude, Longitude and Height will be sent for the reference station position. If Style is xyz then the position will be sent using ECEF coordinates X, Y and Z.

Parameters:

style=llh Style is either llh (Lat/Lon/Height), or xyz. Controls the format in which the reference station position is returned. If not specified, the default is llh.

Response:

RefStation lat=37.388923181 lon=-122.036700958 height=1.234500 
           RtcmId=20 BinexId=Bnx3 CmrId=21 CmrStationName='cmr7' 
           Description='A Descriptive Phrase'

RefStation x=-2691513.5954 y=-4301188.9436 z=3851777.1431 
           RtcmId=20 BinexId=Bnx3 CmrId=21 CmrStationName='cmr7' 
           Description='A Descriptive Phrase'

Set RefStation

This command modifies the settings for the Reference Station. These values are used by CMR, RTCM and Binex output streams. One or more parameters can be specified with the command. Only those settings which are specifically included will be modified. Thus, you can change a single RefStation control without affecting any of the other settings. The only exception to this is that the position must be specified by a complete X/Y/Z or Lat/Lon/Height triplet of values.

Parameters:

Lat=37.388923181 Reference station Latitude in decimal degrees.
Lon=-122.036700958 Reference station Longitude in decimal degrees.
Height=234.567 Reference station Height above sea level in meters.
X=-2691513.5954 Reference station ECEF X coordinate in meters.
Y=-4301188.9436 Reference station ECEF Y coordinate in meters.
Z=3851777.1431 Reference station ECEF Z coordinate in meters.
The position parameter triplets Lat/Lon/Height and X/Y/Z are mutually exclusive. Only one of the two position formats can be used in a single command. A complete triplet must be specified in order to change the reference position.
RtcmId=20 RTCM numeric identifier. Maximum value is 1023.
BinexId=Bnx7 Four character Binex station identifier.
CmrId=21 CMR numeric identifier. Maximum value is 31.
CmrStationName=CMR2 Eight character CMR/RTCM station name. Use single-quotes around the name if it contains spaces. This parameter was formerly named "Name". For backward compatibility, that name will still be accepted. The response to this command will always show the value as "CmrStationName=".
Description='A verbose string' Fifty character RTCM station description. Use single-quotes ('  ') around the string if it contains spaces.

Response:

OK: RefStation lat=37.388923181 lon=-122.036700958 height=1.234500 
               RtcmId=20 CmrId=21 CmrStationName='Rtcm2' 
               Description='A verbose string'

OK: RefStation x=-2691513.5954 y=-4301188.9436 z=3851777.1431 
               RtcmId=20 CmrId=21 CmrStationName='Rtcm2' 
               Description='A verbose string'

Show ClientAuthKey

This command returns the current value of the Client Authentication Key, used by those I/O streams that have the Client Authentication feature enabled. That system involves the use of a secret key which is known to the NetRS and to the clients who wish to access those output streams.

The value returned by this command is an encrypted version of the actual 7-character key. This command cannot be used to obtain the original clear-text key. However, the encrypted value can be used (with Set ClientAuthKey) to re-install the same key or to transfer the key to another NetRS, without risk of showing the actual key.

Parameters:

No parameters are available.

Response:

ClientAuthKey key=9345ef5e63d56135

Set ClientAuthKey

This command modifies the Client Authentication Key which is used by I/O streams that have the Client Authentication feature enabled. That system involves the use of a secret key which is known to the NetRS and to the clients who wish to access those output streams.

The key can be specified in one of two ways:

The first form should be used with care, since an observer of the transmitted packets could see the raw key. This should only be done on a secure link, for example, using the https protocol.

Transmitting the encrypted key is much safer, but requires that a NetRS be used to encrypt the key. The algorithm used to encrypt the key is not publicly available. The concept here is that a shared key would be installed carefully, using cleartext in a secured environment. After that, the encrypted key can be used to archive and restore control settings or to share the key between several NetRS units.

Parameters:

key=9345ef5e63d56135 An encrypted key, as would be obtained with Show ClientAuthKey.
clearkey=theKey! A cleartext version of the 7-character key.

Response:

OK: ClientAuthKey key=9345ef5e63d56135

Show PortAdvertising

This command returns the current control settings of the Port Advertising system. Port Advertising is a method of informing selected remote computers of the presence and I/O capabilities of this NetRS. The response to Show PortAdvertising shows the current enabled state, the advertising interval in seconds, and a list of the currently specified targets.

When the function is enabled (enable=yes) then UDP packets will be sent periodically to a set of targets, specified by IP addresses and UDP port numbers. When IP Filtering is disabled (enable=no) then Port Advertisements wlll not be sent.

The interval parameter indicates how often (in seconds) Port Advertisements will be sent.

Targets are specified with an IP address and a port Number, as with 192.168.142.7:8001. Multiple targets can be defined at the same time, and advertisements will be sent to each of them.


Parameters:

No parameters are available.


Response:
PortAdvertising enable=yes 
                interval=300
                target0=192.168.142.7:8000
                target1=155.63.21.27:9123
                ...

Set PortAdvertising

Modifies the controls for the Port Advertising system. See the description under Show PortAdvertising for details.

The response to a successful invocation of this command will be "OK:" followed by the response generated by the Show PortAdvertising command. This always shows the updated state of the controls.

Multiple target parameters can be supplied with this command. The parameter names for these can be either target= or targetN=, where N is any positive integer. The numeric suffixes are essentially arbitrary, as is the order in which they are placed in the command. Thus, you could specify three separate targets and they all could all use "target=" with no suffixes. Or you could specify target1=, target5=, and target2=. The OK: response to this command will always specify the targets as target1, target2, target3, etc.

This command can only be used to specify the COMPLETE state of the Port Advertising controls. It is not possible to add or delete individual address targets from the current settings, nor to change the Enable or Interval controls, without completely re-specifying the entire set of controls.


Parameters:

enable=yes Controls whether IP Filtering will occur.
Yes: IP connections will be restricted to clients located in the address ranges listed in the range parameters.
No: IP Filtering will NOT be done. Connections can be made from clients at any IP address.
interval=600 Controls the time interval in seconds between Port Advertisements.
target=192.168.142.1:8000
target0=192.168.142.7:9123
target1=155.63.21.25:1077
Defines target systems to which Port advertisements will be sent.
Values must be of the form IP : port


Response:
OK: PortAdvertising enable=yes 
                    interval=600
                    target1=192.168.142.1:8000
                    target2=192.168.142.7:9123
                    target3=155.63.21.25:1077
                    ...

Show PppDialout

This command returns the current control settings of the PPP Dialout function. PPP Dialout lets the NetRS use a modem, a phone line, and an ISP to establish a connection to the Internet. See the help page on PPP Dialout for a detailed description. There are four basic elements that can be configured: the PAP Password, the CHAP Password, the list of PPPD Options, and the Chatscript. Show PppDialout returns a string documenting the current state of these controls.

For security reasons, the two passwords are shown in an encrypted form. The original cleartext values cannot be obtained using this command. However, the encrypted forms are accepted as input parameters by the Set PppDialout command, so the encrypted values can be used to save and restore the current state. The encrypted passwords always contain one or more blocks of 16 hexadecimal characters. The number of blocks is dependent on the length of the original cleartext password.

The PPPD Options information can contain multiple lines of text. Each line will be shown as a separate parameter with a parameter id of the form optN, where N is a positive integer. For example, a three line options file would be shown with parameters opt1, opt2, and opt3. Since PPPD Option lines can contain arbitrary text, including spaces, the values will always be surrounded by single-quotes, as in opt1='user CharlieT'. Any single quote characters that are part of line will be backslash-escaped, as in  'don\'t' .

The ChatScript information can also contain multiple lines of arbitrary text. This information will be shown in a manner identical to the PPPD Options, except that the parameters will be named chat1, chat2, etc. Each line's contents will be shown inside single-quotes with single-quote characters backslash-escaped.


Parameters:

No parameters are available.


Response:
PppDialout papPassword=c279e38ed19bb874 
           chapPassword=c279e38ed19bb874
           opt1='debug' 
           opt2='crtscts' 
           opt3='defaultroute' 
           chat1='\'\' ATZ' 
           chat2='OK ATDT916505551212' 
           chat3='CONNECT \d\c'

Set PppDialout

Modifies the controls for the PPP Dialout system. See the description under Show PPP Dialout for a summary of this system and the help page on PPP Dialout for a detailed description.

The response to a successful invocation of this command will be "OK:" followed by the response generated by the Show PppDialout command. This always shows the updated state of the controls.

There are four basic elements that can be configured: the PAP Password, the CHAP Password, the list of PPPD Options, and the Chatscript. This command can be used to update one or more of the four elements. Only those portions of the controls that are specified will be updated. The remainder will be left at their original settings. Regardless of which portions are set, the response to this command will always show the complete state of the controls.

PAP Password and CHAP Password can be specified either as cleartext or encrypted values. The cleartext values can be initially entered using either clearPapPassword= or clearChapPassword=. For security reasons, these values cannot be recovered in their original form using the Show PppDialout function. That command can only be used to obtain the encrypted values. If Set PppDialout is being used to restore settings that were previously obtained using Show PppDialout then the parameters papPassword= and chapPassword= must be used. Previously stored passwords can be erased by setting the cleartext password to an empty string, as with clearPapPassword=''.

The PPPD Options information can contain multiple lines of text. Each line must be specified as a separate parameter with a parameter id of the form opt or optN, where N is a positive integer. It doesn't matter which of these forms you use. The numeric extensions are ignored. All of the opt parameters are concatenated together, in the order given, to make the complete PPPD Option list. Since PPPD Option lines can contain arbitrary text, including spaces, the values should always be surrounded by single-quotes, as in opt1='user CharlieT'. Any single quote characters that are part of line must be backslash-escaped, as in  'don\'t' .

Likewise, the Chatscript information can contain multiple lines of text. This is handled in the same fashion as the PPPD options, using parameters of the form chat or chat1, chat2,.... Again, the numeric extensions are arbitary. All of the chat parameters are concatenated together, in the order given, to make the complete Chatscript. The values should always be enclosed in single quotes. Any single quote characters that are part of line must be backslash-escaped, as in  '\'\' ATZ' .


Parameters:

clearPapPassword=LoginPw Sets the PAP Password to use when logging into the ISP. LoginPw is the actual password in cleartext. Specify clearPapPassword='' to erase an existing password.
papPassword=0123456789abcdef Sets the PAP Password to use when logging into the ISP. The parameter value is the password encrypted into a hexadecimal string with a multiple of 16 characters.
clearChapPassword=LoginPw Sets the CHAP Password to use when logging into the ISP. LoginPw is the actual password in cleartext. Specify clearChapPassword='' to erase an existing password.
chapPassword=0123456789abcdef Sets the CHAP Password to use when logging into the ISP. The parameter value is the password encrypted into a hexadecimal string with a multiple of 16 characters.
opt='Option Line'
optN='Option Line'
Specifies a line to add to the list of PPPD options. Multiple parameters of this form can be specified.
chat='chatscript Line'
chatN='chatscript Line'
Specifies a line to add to the chatscript. Multiple parameters of this form can be specified.


Response:
OK: PppDialout papPassword=c279e38ed19bb874 
               chapPassword=c279e38ed19bb874
               opt1='debug' 
               opt2='crtscts' 
               opt3='defaultroute' 
               chat1='\'\' ATZ' 
               chat2='OK ATDT916505551212' 
               chat3='CONNECT \d\c'

Port-Type Specific Configuration Parameters

The three types of Input/Output Ports each have their own unique characteristics. These characteristics must be specified when creating or modifying a port, using parameters to the Set Port command.

Some parameters (enable and clientAuth) don't fit well into the port versus service scheme. These are documented in the Other I/O Port Configuration Parameters section.


Serial Ports

Serial ports have controls over the rate at which bits are transmitted, the parity used on transmitted bytes, and the handshaking form that is used to control the flow of data.

Parameters:

port=SerialPortX   The Serial Port.
baud=38400 The bit transmission rate. Acceptable values are:
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
This is a required parameter when creating or modifying a SerialPort.
parity=none Parity can be one of:
  • none
  • even
  • odd
Parity control is not available if the port's service type is PPP. Otherwise, Parity is a required parameter when creating or modifying a SerialPort.
flow=none Flow control can be one of.
  • none
  • hardware
  • xonxoff
Flow control is not available on SerialPort1. If flow is specified on that port, it must be none.
Flow control is a required parameter on all Serial Ports except SerialPort1.
XonXoff flow control is not supported on SerialPorts running the PPP service.


TCP Ports

Ports that use the TCP protocol have no port-type specific parameters.

Parameters:

port=TcpPortXXXX   The TCP Port .


UDP Ports

Ports that use the UDP protocol have a single port-type specific parameter, UdpTimeout. UDP output ports have no way of directly determining whether the client on the other end of a connection is still listening. So all UDP streams require the client to periodically send a KeepAlive packet in order to keep the stream active. UdpTimeout specifies the number of seconds that a stream will be kept active without receiving a KeepAlive request.

Parameters:

port=UdpPortXXXX   The UDP Port.
udpTimeout=60 The maximum time that is allowed between received KeepAlive packets before a UDP connection is cancelled.
If this parameter is not specified in a Set Port command, the udpTimeout defaults to 10 seconds.


REP Ports

Ports that use the REP protocol have no port-type specific parameters. However, the only service type supported on REP ports is Binex.

Only a single REP port can be defined at any time. If a new REP port is created with the Set IOport command, any previously defined REP port will be silently deleted.

Parameters:

port=RepPortXXXX   The REP Port.
service=Binex   REP ports only support the Binex stream service. This must be specified and any other service type will be rejected.

Service-Specific Configuration Parameters

Every defined Serial, TCP or UDP port is associated with a service, which defines how the port will behave, what data it will stream, etc. Some services are only supported on specific port types. May optional parameters are only appropriate for specific services. The table below summarizes each service type and provides a link to a section that gives a complete description of the parameters associated with that service.
PPP Point to Point Protocol.
Implements a TCP/IP protocol over a serial port.
Only available on Serial Ports.
RT17 A Streaming protocol containing raw GPS measurements and other data.
Available on Serial ports, TCP ports, and UDP ports.
Binex A Streaming protocol containing raw GPS measurements and other data.
Available on all port types.
RTCM A Streaming protocol containing GPS differential corrections.
Available on Serial ports, TCP ports, and UDP ports.
CMR A Streaming protocol containing GPS carrier phase measurements for use in RTK systems.
Available on Serial ports, TCP ports and UDP ports.
Met A protocol for interacting with external environmental sensors.
Only available on serial ports.
Ephemerides A query service that responds with a complete binary dump of the GPS ephemeris data.
Only available on TCP ports.
Almanacs A query service that responds with a complete binary dump of the GPS almanac data.
Only available on TCP ports.
SvStatus A query service that responds with a binary dump of Satellite status information.
Only available on TCP ports.
Trimcom An interactive command protocol for use in remote control systems.
Only available on TCP ports.
This protocol is deprecated and should not be used for new designs.

PPP Parameters

This service implements a TCP/IP interface over a serial port. It is only available on Serial Ports. The parameters available for this port allow configuration of the serial port characteristics, modem interface commands, and the parameters needed for PPP itself.

Note that the Serial Port control parameters for PPP ports are a limited subset of the normal values available on serial ports.

Parameters:

port=SerialPortName The serial port to use
service=PPP The service assigned to this port.
baud=38400 The bit transmission rate. Acceptable values are:
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
This is a required parameter when creating or modifying a SerialPort.
flow=none Flow control can be one of.
  • none
  • hardware
Flow control is not available on SerialPort1. If flow is specified on that port, it must be none.
FlowControl is a required parameter on all Serial Ports except SerialPort1.
XonXoff flow control is not supported on SerialPorts running the PPP service.
localIP=192.168.0.1 The IP address used on the NetRS end of the PPP link.
remoteIP=192.168.0.20 The IP address used on the remote end of the PPP link.
connection=modem The type of connection protocol used by the PPP system.
direct Used if the serial port is directly connected to the Computer on the other end of the PPP link.
modem Used if the connection is going through a modem to reach the remote computer. For modem connections, the init1, init2, init3, and reset parameters can be specified to allow the PPP system to properly control the modem connection.
init1=InitString
init2=InitString
init3=InitString
reset=ResetString
These parameters define initialization and reset strings used by the PPP system when interacting with a Modem, that is, when the Connection parameter is modem. They are not allowed when Connection is direct. The strings cannot have embedded spaces.

RT17 Stream Parameters

RT17 is a Streaming protocol containing raw GPS measurements and other data. This service is available on Serial ports, TCP ports and UDP ports.

Parameters:

port=PortName The IOport to use. RT17 streaming is is supported on all port types.
service=RT17 The service assigned to this port.
interval=10 This is the interval (in seconds) between measurement and/or position records in the stream. Valid values are:
  0.1 1 10 60
  0.2 2 15 300
  0.5 5 30 600
measurements=yes Yes or no to indicate whether GPS measurement records should be included in the stream. This defaults to Yes if not specified.
positions=no Yes or no to indicate whether GPS position records should be included in the stream. This defaults to no if not specified.
concise=yes Yes or no to indicate whether the concise (compressed) format should be used. This defaults to yes if not specified.
iodeslips=yes Yes or no to indicate whether records should be included containing satellite IODE values and cycle slip counts. This defaults to yes if not specified.
gpsdata=yes Yes or no to indicate whether records should be included containing decoded GPS satellite data. This defaults to yes if not specified.
rawgps=no Yes or no to indicate whether records should be included containing raw GPS satellite data. This defaults to no if not specified.
rawwaas=no Yes or no to indicate whether records should be included containing raw GPS satellite data. This defaults to no if not specified.
smoothcarrier=no Yes or no to indicate whether GPS carrier phase measurements should be smoothed. This defaults to no if not specified. Carrier Smoothing is not allowed if the interval parameter is less than 1 second.
smoothcode=no Yes or no to indicate whether GPS code phase measurements should be smoothed. This defaults to no if not specified.

Binex Stream Parameters

Binex is a streaming protocol containing raw GPS measurements and other data. This service is available on all port types.

Parameters:

port=PortName The IOport to use. Binex streaming is is supported on all port types.
service=Binex The service to assign to this port.
measInterval=10 This is the interval (in seconds) between measurement records, either binex type 0x7f-02 or 0x7f-03. Valid values are:
  0.1 1 10 60
  0.2 2 15 300
  0.5 5 30 600
This is a required parameter. There is no default value.
smoothCarrier=no Yes or no to indicate whether carrier phase measurements should be smoothed in measurement records. Defaults to no. Carrier Smoothing is not allowed if measInterval is 0.1, 0.2 or 0.5 seconds.
7f02=no Yes or no to indicate whether measurements should be sent encoded as Binex record types 0x7f-02. Defaults to no.
7f03=no Yes or no to indicate whether measurements should be sent encoded as Binex record types 0x7f-03. Defaults to no.
7f03Dopplers=no Yes or no to indicate whether L1 Doppler information should be included in 0x7f-03 records. Defaults to no.
7f03Slips=no Yes or no to indicate whether Cycle Slip Count information should be included in 0x7f-03 records. Defaults to no.
7f03ClockOffsets=never Indicates when reciever clock offset information should be included in 0x7f-03 records.
  • never : Don't ever include clock offset information. This is the default value.
  • always : Include clock offsets in every 0x7f-03 record.
  • onRollover : Include clock offset information only when an internal clock rollover has occurred.
metaInterval=60 This is the interval (in seconds) between BINEX meta records. Valid values are: off, 0 (same as off), 60, 300, 900, 1800 and 3600. The default value is off.
metaSiteDesc=no Yes or no to indicate whether the Site Description string should be included in the meta records. Defaults to no.
metaStnID=no Yes or no to indicate whether the Binex Station ID should be included in the meta records. Defaults to no.
metaRcvrType=no Yes or no to indicate whether the Receiver Type should be included in the meta records. Defaults to no.
metaRinexRcvr=no Yes or no to indicate whether the Rinex Receiver Number should be included in the meta records. Defaults to no.
metaFirmware=no Yes or no to indicate whether the NetRS Firmware version should be included in the meta records. Defaults to no.
metaAntXYZ=no Yes or no to indicate whether the position of the antenna, as determined from a GPS position fix, should be included in the meta records, in ECEF-XYZ coordinates. Defaults to no.
metaAntOffset=no Yes or no to indicate whether the Antenna Offset should be included in the meta records. Defaults to no.
metaRinexAnt=no Yes or no to indicate whether the Rinex Antenna Number should be included in the meta records. Defaults to no.
sysStatusInterval=60 This is the interval (in seconds) between BINEX System Status records. Valid values are: off, 0 (same as off), 60, 300, 900, 1800, and 3600. The default value is off.

RTCM Stream Parameters

A Streaming protocol containing GPS differential corrections. Available on Serial ports, TCP ports and UDP ports.

Parameters:

port=PortName The IOport to use. RTCM streaming is is supported on all port types.
service=RTCM The service to assign to this port.
version=2.3 Indictes which version of the RTCM standard should be use for this stream. Possible values are:
  • 2.1
  • 2.2
  • 2.3
style=dgps Describes an application, which implies the types of records to be transmitted. Possible values are:
DGPS Includes record types 1, 3, 22, and 59.
If version is 2.3, also includes type 24.
RTK Includes record types 3, 18, and 19.
If version is 2.1 or 2.2, also includes types 22 and 59.
If version is 2.3, also includes types 23 and 24.
DGPS_RTK Includes record types 1, 3, 18, 19, 22, and 59.
If version is 2.3, also includes types 23 and 24.
Custom:1,22,23+24,59.3   This style allows a choice of individual record types, although some come as pairs. The choice is made by using a comma-separated list of record types. Valid values are:
  • '1'
  • '2'
  • '3'
  • '18+19'
  • '22'
  • '23+24' (only available with version 2.3).
  • '59.3'
  • '59.13'

CMR Stream Parameters

A Streaming protocol containing GPS carrier phase measurements for use in RTK systems.
Available on Serial ports, TCP ports and UDP ports.

Parameters:

port=PortName The IOport to use. RTCM streaming is is supported on all port types.
service=CMR The service to assign to this port.
style=standard Selects from two styles of CMR format. Value is either standard or CmrPlus.

Met Stream Parameters

A protocol for interacting with external environmental sensors.
Only available on serial ports.

Parameters:

port=SerialPortName The serial port to use.
service=met The service to assign to this port.
cmd1=once:0102P0
cmd2=60:0102P9
cmd3=off
..
cmd6=off
Cmd1 through Cmd6 are the encoded commands to be sent to the external sensors over the serial port. Each command is formatted as
    time:string
and consists of a timing specification and a command string, separated by a colon, ' : '.

The timing specification indicates the time interval (in minutes) between sendings of the command string. The time can be 0 or once to indicate that the command should be activated once-only whenever a new data logging session is started.

Inactive commands are set to "off" instead of a 'time:string'.

Ephemerides Service Parameters

A query service that responds with a complete binary dump of the GPS ephemeris data. This service is only available on TCP ports.

Parameters:

port=TcpPortXXXX The TCP port to use for this service.
service=ephemerides The service to assign to this port.
There are no other configuration parameters for this service.

Almanac Service Parameters

A query service that responds with a complete binary dump of the GPS almanac data. This service is only available on TCP ports.

Parameters:

port=SerialPortName The serial port to use
service=almanacs The service to assign to this port.
There are no other configuration parameters for this service.

SvStatus Service Parameters

A query service that responds with a binary dump of satellite status information. This service is only available on TCP ports.

Parameters:

port=SerialPortName The serial port to use
service=svstatus The service to assign to this port.
There are no other configuration parameters for this service.

Trimcom Service Parameters

An interactive command protocol for use in remote control systems. This service is only available on TCP ports.

This protocol is deprecated and should not be used for new designs.

Parameters:

port=SerialPortName The serial port to use
service=trimcom The service to assign to this port.
There are no other configuration parameters for this service.

Other I/O Port Configuration Parameters

Some Input/Output Port configuration parameters don't fit nicely into the Port-Type or Service categories. These parameters are listed here. When appropriate, these values will be listed in Show Port responses. The parameters can be optionally specified when creating a new Port setup with Set Port. If these parameters are not specified, they will default as shown.

Parameters:

enable=yes Enable or disable this port definition. Can be Yes or no.
This parameter is optional and defaults to Yes if not specified.
clientAuth=no Controls the Client Authentication setting on this port.
This parameter is optional and defaults to no if not specified.