RTes Documentation

RTes command line usage: rtes -I input.xml

Please refer to the RTes input file tab on how to set the input XML file for RTes.

rtes_batch_v4 command line usage: rtes_batch_v4 -H 127.0.0.1 -p 6001 -I input.xml

-H sets the TCP host of the computer that RTes is running on. -p is the command port used by RTes.

Please refer to the other tabs for information on how to set the input file for each command supported by rtes_batch_v4.

All time interval parameters support the following units: s/sec/second, m/min/minute, h/hr/hour, d/day, w/week. If no unit is given, the default unit is seconds.

All data size parameters support the following units: b/byte/bytes, kb/kilobyte/kilobytes, mb/megabyte/megabytes, gb/gigabyte/gigabytes.

All boolean values may be set as: t/y/on/true/yes or f/n/off/false/no.

Case does not matter for any of the units.

Multiple commands can be included in a single rtes_batch_v4 input file (such as when starting several stations).

For paths with the ‘Selection, Range’ field set to ‘dynamic’, the following variables may be set in its path:

ParameterDescription
[STATION]station name
[AGENCY]agency that runs the station
[OBSERVER]station's observer
[YY]last 2 digits of the year
[YYYY]4-digit year
[MO]2-digit month number (01-12)
[MON]3-digit month abbreviation
[MONTH]full month name
[DAY]2-digit day of month (01-31)
[WK], [WEEK]GPS week number
[DOY]3-digit day of the year (0001-365)
[HH]2-digit hour (24-hour clock)
[SH]2-digit hour (12-hour clock)
[AM], [PM]AM/PM (if using 12-hour clock)
[MM]2-digit minute
[SS]2-digit second

Parameters within the RTes XML input file (needed to start RTes)

Document root element must be <rtes_v4 version="4.0" real_time="yes">

Example input file

(* marks required options, ! marks options that should be set but are not required, ? marks options that should only be set when troubleshooting, never in production)

KeywordSelection/RangeDescription
agencyName of agency running RTes. This name is printed in RINEX navigation files generated by RTes.
run_byName of person who is managing RTes. This name is printed in RINEX observation files generated by RTes.
command_hostTCP host of network interface used by RTes to listen for commands (from RTnet or from rtes_batch_v4).
*command_port1-65535TCP port that RTes will listen for commands (from RTnet or from rtes_batch_v4).
command_max_connectionsMaximum number of clients allowed to use RTes simultaneously.
caster_hostTCP host of network interface used by RTes to listen for NTRIP client connections.
caster_port1-65535TCP port that RTes will listen for NTRIP client connections.
caster_max_connectionsMaximum number of NTRIP clients allowed to use RTes simultaneously.
log_dirdynamicPath used to log diagnostic information by RTes (must be a path to a directory).
log_leveldebug, info, warning, errorA log level that is allowed to be log. For example, if you want to only log warnings and errors, set:
<log_level>warning</log_level>
<log_level>error</log_level>
log_maxsize50mbLog file will be rolled when this size limit is reached.
log_roll_interval1hra new log file will be created at this interval
log_tersebooleanConsider turning on if there are many active stations. This significantly reduces the amount of information logged by RTes.
?log_raw_observationsbooleanLog all information decoded by RTes for each station. Only enable when there are few stations active on RTes (when troubleshooting problems with a station). Debug level logging must be turned on to see this information.
err_plainbooleanIf set, only print plain ASCII to terminal. Otherwise, print formatting characters that change color and font weight.
err_leveldebug, info, warning, errorLog levels to print to stderr. Usage is the same as log_level.
*epochs_per_station300Maximum number of epochs to buffer for each station. This number must be large enough to store enough epochs that RTnet will wait for using the MAXTWAIT setting. For example, if MAXTWAIT is 30 and the fastest sampling rate of the stations is 1 Hz, then epochs_per_station must be set to at least 30 (although 40 or larger would be better to be safe).
*max_staMaximum number of stations server can manage simultaneously. valid range: 1-65535 (although it must be less than the maximum number of file handles allowed for a single process--use ulimit -n to show this number).
*max_sample_rate0.25Maximum rate data can come for a single station (seconds).
max_nav_per_sv5Maximum number of navigation records to store per satellite. valid range: 1-1024 (max IODC is 1024).
*gps_utc_fileFile that specifies when leap seconds occur in order to keep track of the GPS-UTC offset (tai-utc.dat, available from ftp://maia.usno.navy.mil/ser7/tai-utc.dat).
station_complete_buffer length="1hr"Length of time used to calculate the percentage of epochs received in the station statistics file.
disable_station_statisticsbooleanDisable station statistic file generation.
mp_rms_window decimation="5s"Time window for calculating mean RMS of MP values. Decimation is interval of mp values used in RMS calculation
save_mp_statisticsbooleanWill print satellite-specific MP (multipath) values to the station statistics log file. Has no effect if disable_station_statistics is true.
check_mp_jump mp1_gps="150" mp2_gps="195" mp1_glonass="500" mp2_glonass="400"booleanCheck for jumps in multipath values?
Optional: Set limits for MP1 and MP2 in cm:
Default MP1 GPS jump limit is 150 cm.
Default MP2 GPS jump limit is 195 cm.
Default MP1 GLONASS jump limit is 500 cm.
Default MP2 GLONASS jump limit is 650 cm.
check_iono_jump iono_gps="400" iono_glonass="400"Check for ionosphere jumps? (cm / minute)
rinex2 version="2.12"By default, output the latest version of RINEX 2.x (currently 2.12). Use 2.11 if generated RINEX will be processed by teqc because teqc does not support RINEX 2.12.
log_gps_navdynamicPath to directory where GPS RINEX ephemeris will be stored.
log_glonass_navdynamicPath to directory where GLONASS RINEX ephemeris will be stored.
log_qzss_navdynamicPath to directory where QZSS RINEX ephemeris will be stored.
check_nav enabled="yes" buffer_size="3" gps_tol="200" glo_tol="1000"<nav_path>path to directory</nav_path>This is used to verify broadcast ephemeris sent by stations on RTes. To use this option, there needs to be a global stream of broadcast ephemeris (using either a number of stations or using an ephemeris stream from RTIGS). The buffer size is the number of ephemeris to store for each satellite. All ephemeris must be consistent with each other. gps_tol is the number of meters for differences for GPS satellite positions between ephemeris. glo_tol is the tolerance for GLONASS satellites. The <nav_path> paths point to directories storing broadcast ephemeris used to initialize RTes with good ephemeris. If no paths are given, RTes must receive at least buffer_size ephemeris for a satellite before any will be marked valid (which can take up to 6 hours for GPS satellites).
dead_socket_time try_immediate_reconnect="true"12sThe amount of time to wait for data on a socket before closing the connection and starting to reconnect. If try_immediate_reconnect is enabled, as soon as the socket is considered dead a reconnect attempt will be made (rather than scheduling a reconnect attempt a minute in the future).
rtcm_2 enable_msg_count="false" single_frequency="false" has_glonass="false"RTCM 2.x decoding options. If enable_msg_count is enabled, RTes will determine that an epoch is complete based on the number of epochs decoded for each epoch based on the other rtcm_2 flags. Otherwise, it will use the multiple message indicator. Some receivers do not set the multiple message indicator correctly, which is the only time enable_msg_count would be set to "true". If single_frequency is set, RTes will expect observations only for L1. If has_glonass is set to true, RTes will expect GPS+GLONASS observations, otherwise only GPS observations.
disable_stream_obs<obs>L2C</obs>
use_sbas enabled="no"Determines whether RTes process SBAS observations. If not enabled, SBAS observations will not be written to RINEX or sent to RTnet.
use_qzss enabled="yes"Determines whether RTes process QZSS observations. If not enabled, QZSS observations will not be written to RINEX or sent to RTnet.
use_galileo enabled="yes"Determines whether RTes process Galileo observations. If not enabled, Galileo observations will not be written to RINEX or sent to RTnet.
?force_pcode_l2 enabled="no"This forces all L2 observations to be reported as P-code observations to RTnet. This option is only needed for very old versions of RTnet.

Parameters within the rtes_batch_v4 XML input file for the command to add a station to RTes.

Document root element must be <rtes_batch version="4.0">

Command element is <start_station>. The following options are placed within the <start_station> element.

Example input file

(* marks required options, ! marks options that should be set but are not required, ? marks options that should only be set when troubleshooting, never in production)

KeywordSelection/RangeDescription
*station_nameUnique station name. The name may contain the following characters: a-z, A-Z, 0-9, _. This name must match the name used in the STALIST name in the RTnet input file and the coordinate file used by RTnet. The name must be unique on RTes (there cannot be two stations with the same name). It is recommended that the station name be 4 or more characters.
station_data_update_timeYYYY/MM/DDThe date that the station information was last updated.
station_typeStation movement type written in RINEX header file. Must be one of unknown, base, kinematic, reference, virtualreference, geodetic, nongeodetic, spaceborne, airborne, watercraft, groundcraft, FixedBuoy, FloatingBuoy, FloatingIce, Glacier, Ballistic, Animal, Human, String.
marker_pos_typeStation's coordinate type. Must be one of precise, approximate, or unknown.
network_id0-255Corresponds to Network ID in message 1014 in RTCM 3.0.
subnetwork_id0-15Corresponds to Subetwork ID in message 1014 in RTCM 3.0.
monument_id0-4095Used as reference station ID when sent in RTCM format.
agencyAgency that owns the receiver.
observerPerson who is responsible for maintaining the receiver.
adjust_phaseShould phase values be adjusted for quarter-cycle offsets? Must be one of yes, no, or automatic.
receiver->serial_numberStation serial number as set by the manufacturer.
receiver->typeManufacturer/receiver model
receiver->firmware_versionFirmware version installed on the receiver.
antenna->serial_numberAntenna serial number as set by the manufacturer.
antenna->setup_id0-255Antenna setup ID, see RTCM 3.0 format for details.
antenna->typeTRM29659.00Corresponds to RTCM 'Antenna Descriptor'. This must be set if RTnet does not use a station coordinate file.
arp_xCorresponds to Antenna Reference Point (ARP) ECEF-X (meters). This must be set if RTnet does not use a station coordinate file.
arp_yCorresponds to Antenna Reference Point (ARP) ECEF-Y (meters). This must be set if RTnet does not use a station coordinate file.
arp_zCorresponds to Antenna Reference Point (ARP) ECEF-Z (meters). This must be set if RTnet does not use a station coordinate file.
antenna->height0-6.5535mHeight offset in meters from ARP coordinate.
*antenna->sample_rate20-60000msSample rate for observations for this antenna in milliseconds.
*socket_connection->hostTCP host of receiver or NTRIP caster.
*socket_connection->port1-65535TCP port of receiver or NTRIP caster.
*socket_connection->connection_typeMust be either TCP or NTRIP. If NTRIP, the mountpoint and other parameters may need to be set.
*socket_connection->data_typeFormat used by the receiver to broadcst observations on this connection. Must be one of NMEA, RT17, BINEX, RTCM2, RTCM3, TOPCON, RTNET, SBF, NOVATEL.
socket_connection->mount_pointMount point for this station on the NTRIP caster. Only needs to be set if the connection_type is NTRIP.
socket_connection->ntrip_usernameUser name used to connect to NTRIP caster. Only needs to be set if connection_type is NTRIP and the NTRIP caster uses basic authentication.
socket_connection->ntrip_passwordPassword used to connect to NTRIP caster. Only needs to be set if connection_type is NTRIP and the NTRIP caster uses basic authentication.
socket_connection->init_stringString that is sent to receiver when connection is established.
socket_connection->hangup_stringString that is sent to receiver just before connection is closed.
socket_connection->netrs_keyPublic key sent to NetRS receiver if NetRS authentication is enabled on the receiver.
save_raw enabled="true"Should observation data for this receiver be saved to files in RINEX or raw format?
save_raw->output_pathdynamicDirectory that will contain observation files. For example: /data/rinex_data/[STATION]
save_raw->output_namedynamicFile name pattern of observation files. For example: [STATION]-[YYYY]-[DOY]-[HH]-[MM].[YY]O.gz
save_raw->formatData format used to save observations. Must be either rinex or raw. If raw, will save data in the same format that it is broadcasted in.
save_raw->rinex_options<obs type="L1"/>List of observations to store in RINEX files. All RINEX 2.12 observation codes are supported. This list must be set for rinex format (otherwise no observations will be stored), but has no effect if the format is raw.
save_raw->compressbooleanShould the file be compressed using zlib? If enabled, please ensure that the output_name ends with the .gz file extension.
ignore_nav_recordsShould broadcast ephemeris for this station be ignored? Only turn this on if there are problems with the receiver's firmware that causes it to send bad ephemeris data.
req_nav_recordsCan broadcast ephemeris be requested from the receiver by RTes?

Parameters within the rtes_batch_v4 XML input file for the command to stop a station on RTes.

Document root element must be <rtes_batch version="4.0">

Command element is <stop_station>. The following options are placed within the <stop_station> element.

Example input file

(* marks required options, ! marks options that should be set but are not required, ? marks options that should only be set when troubleshooting, never in production)

KeywordSelection/RangeDescription
*station_idThe name of the station to stop.

Parameters within the rtes_batch_v4 XML input file for the command to request the server status.

Document root element must be <rtes_batch version="4.0">

Command element is <request_server_status/>. This command takes no additional parameters.

Example input file

Parameters within the rtes_batch_v4 XML input file for the command to requestion information of a station on RTes.

Document root element must be <rtes_batch version="4.0">

Command element is <request_station_info_by_name>. The following options are placed within the <request_station_info_by_name> element.

Example input file

(* marks required options, ! marks options that should be set but are not required, ? marks options that should only be set when troubleshooting, never in production)

KeywordSelection/RangeDescription
*station_idWill request information for this station.

Parameters within the rtes_batch_v4 XML input file for the command to add a user who can access the RTes NTRIP caster.

Document root element must be <rtes_batch version="4.0">

Command element is <add_ntrip_user>. The following options are placed within the <add_ntrip_user> element.

Example input file

(* marks required options, ! marks options that should be set but are not required, ? marks options that should only be set when troubleshooting, never in production)

KeywordSelection/RangeDescription
*user_nameName of the user (used to access mountpoint on RTes caster using basic authentication).
*user_passwordPassword of the user.
*mount_list__ALL__List of mount points user may access. This is in addition to any mount points the user may already access on RTes. Set this to __ALL__ if the user may access all mount points on RTes.

Parameters within the rtes_batch_v4 XML input file for the command to remove a user who has access to the RTes NTRIP caster.

Document root element must be <rtes_batch version="4.0">

Command element is <del_ntrip_user>. The following options are placed within the <del_ntrip_user> element.

Example input file

(* marks required options, ! marks options that should be set but are not required, ? marks options that should only be set when troubleshooting, never in production)

KeywordSelection/RangeDescription
*user_nameThe name of the user to delete.

Parameters within the rtes_batch_v4 XML input file for the command to start streaming data for a station on the RTes caster, including all of the information needed for the source table.

Document root element must be <rtes_batch version="4.0">

Command element is <start_ntrip_stream>. The following options are placed within the <start_ntrip_stream> element.

Example input file

(* marks required options, ! marks options that should be set but are not required, ? marks options that should only be set when troubleshooting, never in production)

KeywordSelection/RangeDescription
*station_nameThe name of the station. This station must have already been started on RTes using the start_station command.
*mount_pointThe mount point name for this station. This is the name NTRIP clients will use to access this station using the RTes caster.
identifierSource identifier, e.g. name of city next to source location.
formatFormat of data to stream for this mount point. One of raw (pass through of raw data stream), RTCM3.
format-descDetails of format, like which RTCM records are sent and at what interval.
carrierDoes this stream send carrier phase data? 0=no, 1=Yes,L1, 2=Yes,L1&L2
nav-systemGPS, GPS+GLONASS, GPS+EGNOS
networkName of network this receiver is in (or blank if it's not part of a network).
countryCountry receiver is located within.
latitudeApproximate latitude of receiver.
longitudeApproximate longitude of receiver.
nmea0==client must not send NMEA record to caster, 1==client must send NMEA GGA record to caster with client's approximate position (so that caster will generate virtual reference station data).
solution1==network used to generate stream, 0==single reference station generated stream
generatorHardware or software generated data.
compr-encryptType of compression/encryption applied to data stream.
authenticationN, B or DN=no authentication, B=basic, D=digest
feeY or NIs there a fee required to access this stream?
bit_rateBit rate of this stream.
miscMiscellaneous notes on this stream.