BKG Ntrip Client (BNC)

The BKG Ntrip Client (BNC) is a program for simultaneously retrieving, decoding and converting real-time GNSS data streams from NTRIP broadcasters like http://www.euref-ip.net/home or http://www.igs-ip.net/home.

BNC has been developed for the Federal Agency for Cartography and Geodesy (BKG) within the framework of the EUREF-IP Pilot Project (EUREF-IP, IP for Internet Protocol) and the Real-Time IGS Working Group (RTIGS WG).

BNC has been written under GNU General Public License (GPL). Binaries for BNC are available for Windows, 32-bit Linux, 64-bit Linux (compiled using option -m32), and Solaris systems. It is likely that BNC can be compiled on other systems where a GNU compiler and Qt Version 4.2.3 are installed.
History
Dec 2006  Version 1.0b  Binaries of first beta version published.
Jan 2007  Version 1.1b  [Add] Observables C2, S1, and S2
[Add] Virtual reference station access
[Bug] RTCM2 decoder time tag fixed
[Mod] Small letters for public RINEX skeleton files
[Add] Online help through Shift+F1
Apr 2007  Version 1.2b  [Bug] Output only through IP port
[Bug] Method 'reconnecting' now thread-save
[Add] ZERO decoder added
[Mod] Download public RINEX skeletons once per day
[Mod] Upgrade to Qt Version 4.2.3
[Mod] Replace 'system' call for RINEX script by 'QProcess'
[Add] HTTP Host directive for skeleton file download
[Add] Percent encoding for user IDs and passwords
[Bug] Exit execution of calling thread for RTCM3 streams
[Bug] Signal-slot mechanism for threads
May 2007  Version 1.3  Source code published.
Jul 2007  Version 1.4  [Bug] Skip messages from proxy server
[Bug] Call RINEX script through 'nohup'

Contents

A - Purpose
B - Options
C - Limitations
D - Authors
E - Links
F - Annex

A - Purpose

The purpose of BNC is to

BNC decodes and converts GNSS data streams carrying code and phase data coming in

Furthermore, BNC allows to by-pass its decoding and conversion algorithms, leave whatever is received untouched and save it in files.

Resources
BNC needs access to the Internet with a minimum of about 2 to 6 kbits/sec per stream depending on the stream format. You need to make sure that you have always the necessary bandwidth available. BNC has the capacity to retrieve hundreds of GNSS data streams simultaneously. Please be aware that it is a powerful tool that may generate a heavy workload on the NTRIP broadcaster side depending on the number of streams it requests. We suggest to limited the number of streams where possible to avoid unnecessary workload.

Note that running BNC requires that the clock of the hosting computer is synchronized.

B - Options

B - 1. File
B - 2. Help
B - 3. Proxy
B - 4. Synchronized Output
      B - 4.1. Wait for Full Epoch
      B - 4.2. ASCII Output File
      B - 4.3. Port for Binary Output
B - 5. RINEX
      B - 5.1. RINEX File Names
      B - 5.2. RINEX Directory
      B - 5.3. RINEX Script
      B - 5.4. RINEX File Interval
      B - 5.5. RINEX Sampling
      B - 5.6. RINEX Skeleton Extension
      B - 5.7. Append Files
B - 6. Mountpoints
      B - 6.1. Add Mountpoints
      B - 6.2. Broadcaster Host and Port
      B - 6.3. Broadcaster User and Password
      B - 6.4. Get Table
      B - 6.5. Delete Mountpoints
      B - 6.6. Edit Mountpoints
B - 7. Log
B - 8. Start
B - 9. Stop
B - 10. No Window

B - 1. File

The 'File' button lets you

B - 2. Help

The 'Help' button provides access to

BNC comes with a help system providing online information about its functionality and usage. Simple descriptions are available for any widget. Focus to the relevant widget and press Shift+F1 to request help information. A help text appears immediately; it goes away as soon as the user does something else. Some dialogs may provide a "?" button that users can click; they then click the relevant widget to pop up the help text.

B - 3. Proxy - mandatory if BNC is operated in a protected LAN

You may like to run BNC in a Local Area Network (LAN). LANs are often protected by a proxy server. Enter your proxy server IP and port number in case one is operated in front of BNC. If you don't know the IP and port of your proxy server, check out the proxy server settings of your Internet browser or ask your network administrator.

Note that IP streaming may generally be denied in a LAN. In such a case you need to ask your network administrator for an appropriate modification of his security policy or for the installation of a TCP relay to involved NTRIP broadcasters. If that doesn't work out, run BNC outside your LAN on a host that is connected to the Internet through an Internet Service Provider (ISP).

B - 4. Synchronized Output

BNC lets you output synchronized observations from all stations and satellites epoch by epoch. This output is made available in a plain ASCII format and/or a binary format. The output comprises the following observations if available:

StatID, SVPRN, GPSWeek, GPSWeeks, C1, C2, P1, P2, L1, L2, S1, S2, SNR1, SNR2

Note that SNR stands for the signal-to-noise ratio S mapped to integer numbers 1 to 9. Note further that in case an observation is unavailable, its value is set to zero '0.000'.

B - 4.1 Wait for Full Epoch - optional

When feeding a real-time GNSS engine waiting for input epoch by epoch, BNC ignores whatever is received later than 'Wait for full epoch' seconds. A value of 3 to 5 seconds could be an appropriate choice for that, depending on the latency of the incoming streams and the delay you can accept for your real-time GNSS product. Default value for 'Wait for full epoch' is 1 second.

Note that 'Wait for full epoch' does not influence the RINEX file contents. Observations received later than 'Wait for full epoch' seconds will still be included in the RINEX files.

B - 4.2 ASCII Output File - optional

Enter the full path for a file to save synchronized observations in a plain ASCII format. Default value is an empty option field, meaning that no ASCII output file is created.

Note that the size of this file rapidly inreases, mainly depending on the number of incoming streams. Thus, this output option is primarily meant for test and evaluation purposes.

B - 4.3 Port for Binary Output - optional

BNC makes synchronized observations available in a binary format on your local host (IP 127.0.0.1) through an IP port. Enter an IP port number to activate this function. Default is an empty option field, meaning that no binary output is generated.

The binary output is provided as a continuous stream in the order of

begEpoch
begObs
Observation
begObs
Observation
begObs
Observation
...
endEpoch
begEpoch
...

where the corresponding structures are defined as

const char begEpoch = 'A';
const char begObs   = 'B';
const char endEpoch = 'C';
struct Observation {
  int    flags;
  char   StatID[20+1];// Station ID
  char   satSys;      // Satellite System ('G' or 'R')
  int    satNum;      // Satellite Number (PRN for GPS NAVSTAR)
  int    slot;        // Slot Number (for Glonass)
  int    GPSWeek;     // Week of GPS-Time
  double GPSWeeks;    // Second of Week (GPS-Time)
  double C1;          // CA-code pseudorange (meters)
  double C2;          // CA-code pseudorange (meters)
  double P1;          // P1-code pseudorange (meters)
  double P2;          // P2-code pseudorange (meters)
  double L1;          // L1 carrier phase (cycles)
  double L2;          // L2 carrier phase (cycles)
  double S1;          // L1 signal-to noise ratio
  double S2;          // L2 signal-to noise ratio
  int    SNR1;        // L1 signal-to noise ratio (mapped to integer)
  int    SNR2;        // L2 signal-to noise ratio (mapped to integer)
} ;

Note that the source code for BNC comes with an example program named 'test_bnc_qt.cpp' that lets you read BNC's binary output from the IP port.

B - 5. RINEX

Observations will be converted to RINEX Version 2.11 if they come in either RTCM Version 2.x, RTCM Version 3, or RTIGS format. BNC's RINEX observation files generally contain C1, C2, P1, P2, L1, L2, S1, and S2 observations. In case an observation is unavailable, its value is set to zero '0.000'. Note that even if a RINEX file does not contain GLONASS data, the 'RINEX TYPE' field in the RINEX file header may be set to 'M (MIXED)'.

B - 5.1 RINEX File Names

RINEX file names are derived by BNC from the first 4 characters of the corresponding mountpoint (4Char Station ID) while omitting the residual part of the mountpoint string. Thus, retrieving data from mountpoints FRANKFURT and WETTZELL leads to hourly RINEX observation files named

FRAN{ddd}{h}.{yy}O
WETT{ddd}{h}.{yy}O

where 'ddd' is the day of year, 'h' is a letter which corresponds to an hour long UTC time block and 'yy' is the year.

For those streams that show mountpoints with an identical 4Char Station ID (same first 4 characters), the mountpoint strings are split into two sub-strings and both become part of the RINEX file name. Example: When simultaneously retrieving data from mountpoints FRANKFURT and FRANCE, their hourly RINEX observation file names are defined as

FRAN{ddd}{h}_KFURT.{yy}O
FRAN{ddd}{h}_CE.{yy}O.

If several streams show exactly the same mountpoint (example: BRUS0 from www.euref-ip.net and BRUS0 from www.igs-ip.net), BNC adds an integer number to the file name leading i.e. to hourly RINEX observation files like

BRUS{ddd}{h}_0.{yy}O
BRUS{ddd}{h}_1.{yy}O.

Note that RINEX file names for all intervals less than 1 hour follow the file name convention for 15 minutes RINEX observation files i.e.

FRAN{ddd}{h}{mm}.{yy}O

where 'mm' is the starting minute within the hour.

B - 5.2 RINEX Directory - optional

Enter a path for saving the RINEX files in a directory. If this directory does not exist, BNC will not create RINEX files. Default value for 'RINEX directory' is an empty option field, meaning that streams are not converted to RINEX.

B - 5.3 RINEX Script - optional

Whenever a RINEX file is saved, you may like to compress, copy or upload it immediately via FTP. For that you enter the full path of a script or batch file which is then called to carry out these operations. The RINEX file path will be passed to the script as a command line parameter (%1 on Windows systems, $1 on Unix/Linux systems).

The triggering event for calling the script or batch file is the end of a RINEX file interval. If that is superposed by a stream outage, the triggering event is the stream reconnect.

B - 5.4 RINEX File Interval - mandatory if 'RINEX directory' set

Select the interval for the RINEX file generation. Default for 'RINEX file interval' is 15 minutes.

B - 5.5 RINEX Sampling - mandatory if 'RINEX directory' set

Select the RINEX sample interval in seconds. Zero '0' stands for converting all incoming epochs to RINEX. Default for RINEX 'Sampling' is '0'.

B - 5.6 RINEX Skeleton Extension - optional

Whenever BNC starts generating RINEX files (and then once every day at midnight), it first tries to retrieve information needed for RINEX headers from so-called public RINEX header skeleton files which are derived from sitelogs. An HTTP link to a directory containing these skeleton files may be available through data field number 7 of the affected NET record in the source-table. See http://www.epncb.oma.be:80/stations/log/skl/brus.skl for an example for a public RINEX header skeleton file concerning the EPN station Brussels.

However, it may happen that public RINEX header skeleton files are not available, its contents is not up to date, or you need to have additional/optional records in the RINEX header. For that BNC allows to introduce personal skeleton files that contain the header records you would like to see. You may derive a personal RINEX header skeleton file from the information given in an up to date sitelog. A file in the 'RINEX directory' with the extension 'RINEX skeleton extension' is interpreted by BNC as a personal RINEX header skeleton file for the affected stream.

Examples for file name convention: RINEX files for mountpoints WETTZELL, FRANKFURT and FRANCE (same 4Char Station ID), BRUS0 from www.euref-ip.net and BRUS0 from www.igs-ip.net (same 4Char Station ID, identical mountpoint stings) would accept personal skeleton files named

WETT.skl
FRAN_KFURT.skl
FRAN_CE.skl
BRUS_0.skl
BRUS_1.skl

if 'RINEX skeleton extension' is set to 'skl'.

Note the following regulations regarding personal RINEX header skeleton files:

If neither a public nor a personal RINEX header skeleton file is available for BNC, a default header is generated for the affected RINEX file.

B - 5.7 Append Files

When starting BNC, new RINEX files are created by default. Probably existing files will be overwritten. However, it may be desirable to append observations to already existing RINEX files following a restart of BNC after an intentional 'Stop', a system crash or a crash of BNC. Hit 'Append files' to continue with already existing files and thus save what has been recorded so far. Note that option 'Append files' also concerns the 'ASCII output file' and the 'Log' file.

B - 6. Mountpoints

Each stream on an NTRIP broadcaster is defined through a unique source ID called mountpoint. An NTRIP client like BNC can access the data of a desired stream by its mountpoint. Information about mountpoints is available through the source-table maintained by the NTRIP broadcaster. Note that mountpoints could show up in BNC more than once when retrieving streams from several NTRIP broadcasters.

Streams selected for retrieval are listed in the 'Mountpoints' section on BNC's main window. The list provides the following information extracted from NTRIP broadcaster source-tables:
'mountpoint'  NTRIP broadcaster URL, port, and mountpoint.
'decoder'  Internal decoder used to handle the incoming stream content according to its format; editable.
'lat'  Latitude of reference station, degrees, north; editable if 'nmea' = 'yes'.
'long'  Longitude of reference station, degrees, east; editable if 'nmea' = 'yes'.
'nmea'  Shows whether or not stream retrieval needs to be initiated by BNC through sending NMEA-GGA message carrying position coordinates 'lat' and 'long'.
'bytes'  Number of bytes retrieved.

B - 6.1 Add Mountpoints

Button 'Add Mountpoints' opens a window that allows you to select data streams from an NTRIP broadcaster by their mountpoints.

B - 6.2 Broadcaster Host and Port - mandatory

Enter the NTRIP broadcaster host IP and port number. http://www.rtcm-ntrip.org/home provides information about known NTRIP broadcaster installations. Note that EUREF and IGS operate NTRIP broadcasters at http://www.euref-ip.net/home and http://www.igs-ip.net/home.

B - 6.3 Broadcaster User and Password - mandatory for protected streams

Streams on NTRIP broadcasters may be protected by password. Enter a valid 'User' ID and 'Password' for access to protected NTRIP broadcaster streams. Accounts are usually provided per NTRIP broadcaster through a registration procedure. Register through http://igs.bkg.bund.de/index_ntrip_reg.htm for access to protected streams on www.euref-ip.net and www.igs-ip.net.

B - 6.4 Get Table

Hit button 'Get Table' to download the source-table from the NTRIP broadcaster. Pay attention to data fields 'format' and 'format-details'. Keep in mind that BNC can only decode and convert streams that come in RTCM 2.x, RTCM 3, or RTIGS format. RTCM 2.x streams must contain message types 18 and 19 while RTCM 3 streams must contain GPS message types 1002 or 1004 and may contain GLONASS message types 1010 or 1012, see data field 'format-details' for available message types and their repetition rates in brackets. Select your streams line by line, use +Shift and +Ctrl when necessary.

The contents of data field 'nmea' tells you whether a stream retrieval needs to be initiated by BNC through sending an NMEA-GGA message carrying position coordinates (virtual reference station).

Hit 'OK' to return to the main window. You may like to 'Add Mountpoints' from another NTRIP broadcaster when necessary.

B - 6.5 Delete Mountpoints

To delete a stream shown under 'Mountpoints' in the main window, select it by mouse click and hit 'Delete Mountpoints'. For a simultaneous deletion of several streams highlight them using +Shift and +Ctrl.

B - 6.6 Edit Mountpoints

B - 7. Log - optional

BNC comments its activities in the 'Log' section on the main windows. Comments can be saved in a file when entering a full path for a 'Log' file. Information is given on the communication between BNC and the NTRIP broadcaster as well as on problems that may occur concerning communication link, stream availability, stream delay, stream conversion etc. Default value for 'Log' is an empty option field, meaning that BNC comments are not saved in a file.

B - 8. Start

Hit 'Start' to start retrieving, decoding, and converting GNSS data streams in real-time. Note that 'Start' generally forces BNC to begin with fresh RINEX files and thus overwrite probably existing files when necessary unless option 'Append files' is set.

B - 9. Stop

Hit the 'Stop' button in order to stop BNC.

B - 10. No Window - optional

You can use BNC on all systems in batch mode with the command line option '-nw'. BNC then runs in 'no window' mode, reading options from the configuration file ${HOME}/.config/BKG/BNC_NTRIP_Client.conf (Unix/Linux) or from the register BNC_NTRIP_Client (Windows).

Note that the self-explaining contents of the configuration file or the Windows register can easily be edited. Terminate BNC using the Windows Task Manager when running it in 'no window' mode on Windows systems.

C - Limitations

D - Authors

The BKG Ntrip Client (BNC) Qt Graphic User Interface (GUI) has been developed for the Federal Agency for Cartography and Geodesy (BKG) by Leos Mervart, Czech Technical University Prague, Department of Geodesy. BNC integrates the following GNU GPL software components:

Please make sure you installed the latest version of BNC available from http://igs.bkg.bund.de/index_ntrip_down.htm. We are still working on the program and would appreciate if you sent your comments, suggestions, or bug reports to:

Georg Weber
Federal Agency for Cartography and Geodesy (BKG)
Frankfurt, Germany
euref-ip@bkg.bund.de

E - Links

NTRIP  http://igs.bkg.bund.de/index_ntrip.htm
EUREF-IP NTRIP broadcaster  http://www.euref-ip.net/home
IGS-IP NTRIP broadcaster  http://www.igs-ip.net/home
NTRIP broadcaster overview  http://www.rtcm-ntrip.org/home
EUREF-IP Pilot Project  http://www.epncb.oma.be/euref_IP
Radio Technical Commission
for Maritime Services  
http://www.rtcm.org

F - Annex

F - 1. NTRIP
      E - 1.1 Source-table
F - 2. RTCM
      F - 2.1 RTCM Version 2.x
      F - 2.2 RTCM Version 3
F - 3. RTIGS
      F - 3.1 SOC
F - 4. Config File

F - 1. NTRIP

'Networked Transport of RTCM via Internet Protocol' Version 1.0 (NTRIP) stands for an application-level protocol streaming Global Navigation Satellite System (GNSS) data over the Internet. NTRIP is a generic, stateless protocol based on the Hypertext Transfer Protocol HTTP/1.1. The HTTP objects are enhanced to GNSS data streams.

NTRIP Version 1.0 is an RTCM standard designed for disseminating differential correction data (e.g. in the RTCM-104 format) or other kinds of GNSS streaming data to stationary or mobile users over the Internet, allowing simultaneous PC, Laptop, PDA, or receiver connections to a broadcasting host. NTRIP supports wireless Internet access through Mobile IP Networks like GSM, GPRS, EDGE, or UMTS.

NTRIP is implemented in three system software components: NTRIP clients, NTRIP servers and NTRIP broadcasters. The NTRIP broadcaster is the actual HTTP server program whereas NTRIP client and NTRIP server are acting as HTTP clients.

NTRIP is an open none-proprietary protocol. Major characteristics of NTRIP's dissemination technique are:

F - 1.1 Source-table

The NTRIP broadcaster maintains a source-table containing information on available NTRIP streams, networks of NTRIP streams and NTRIP broadcasters. The source-table is sent to an NTRIP client on request. Source-table records are dedicated to one of the following: Data Streams (record type STR), Casters (record type CAS), or Networks of streams (record type NET).

Source-table records of type STR contain the following data fields: 'mountpoint', 'identifier', 'format', 'format-details', 'carrier', 'nav-system', 'network', 'country', 'latitude', 'longitude', 'nmea', 'solution', 'generator', 'compr-encryp', 'authentication', 'fee', 'bitrate', 'misc'.

Source-table records of type NET contain the following data fields: 'identifiey', 'operator', 'authentication', 'fee', 'web-net', 'web-str', 'web-reg', 'misc'.

Source-table records of type CAS contain the following data fields: 'host', 'port', 'identifier', 'operator', 'nmea', 'country', 'latitude', 'longitude', 'misc'.

F - 2. RTCM

The Radio Technical Commission for Maritime Services (RTCM) is an international non-profit scientific, professional and educational organization. Special Committees provide a forum in which governmental and non-governmental members work together to develop technical standards and consensus recommendations in regard to issues of particular concern. RTCM is engaged in the development of international standards for maritime radionavigation and radiocommunication systems. The output documents and reports prepared by RTCM Committees are published as RTCM Recommended Standards. Topics concerning Differential Global Navigation Satellite Systems (DGNSS) are handled by the Special Committee SC 104.

Personal copies of RTCM Recommended Standards can be ordered through http://www.rtcm.org/orderinfo.php.

F - 2.1 RTCM Version 2.x

Transmitting GNSS carrier phase data can be done through RTCM Version 2.x messages. Please note that only RTCM Version 2.2 and 2.3 streams may include GLONASS data. Messages that may be of some interest here are:

F - 2.2 RTCM Version 3

RTCM Version 3 has been developed as a more efficient alternative to RTCM 2.x. Service providers and vendors have asked for a standard that would be more efficient, easy to use, and more easily adaptable to new situations. The main complaint was that the Version 2 parity scheme was wasteful of bandwidth. Another complaint was that the parity is not independent from word to word. Still another was that even with so many bits devoted to parity, the actual integrity of the message was not as high as it should be. Plus, 30-bit words are awkward to handle. The Version 3 standard is intended to correct these weaknesses.

RTCM Version 3 defines a number of message types. Messages that may be of interest here are:

F - 3. RTIGS

RTIGS stands for a data format and transport protocol for GPS observations. It was defined by the Real-Time IGS Working Group (RTIGS WG). Its definition is based on the SOC format. Every RTIGS record has one of the following numbers:

Station record number 100
Observation record (O_T) number 200
Ephemeris record (E_T) number 300
Meteorological record (M_T) number 400

Every station has one of the following unique numbers:

1-99 reserved for JPL
100-199 reserved for NRCan
200-299 reserved for NGS
300-399 reserved for ESOC
400-499 reserved for GFZ
500-599 reserved for BKG
600-699 reserved for GEOSCIENCE AUS
700-799 others
etc

The number of bytes in each real time message includes the header as well as the data content, but NOT the pointer.

For example:

All records are related to a station configuration indicated by the Issue of Data Station (IODS). The IODS will enable the user to identify the equipment and software that was used to derive the observation data.

Each record header contains the GPS Time in seconds which flows continuously from 6 Jan-1980 onwards.

The data payload of each record consists of observations. The structures indicate a pointer to data but in fact the broadcast messages do not contain the pointer, only the data. Users will have to manage the data and the pointer is shown in order to illustrate where the data is located in the message and one possible data management option.

All record data are in network byte order (Big Endian), i.e. IA32 users have to swap bytes.

Visit http://igscb.jpl.nasa.gov/mail/igs-rtwg/2004/msg00001.html for further details.

F - 3.1 SOC

The SOC format has been designed in July 1999 by the Jet Propulsion Laboratory (JPL) and the California Institute of Technology (CalTech) to transport 1Hz GPS data with minimal bandwidth over the open Internet. SOC follows the 'little-endian' byte order meaning that the low-order byte of a number is stored in memory at the lowest address, and the high-order byte at the highest address. Because the transport layer is UDP, the format does not include sync bits, a checksum, or cyclic redundancy checksum (CRC). SOC allows to transport the GPS observable CA, P1, P2, L1, and L2, efficiently compressed down to 14 bytes with 1 mm range resolution and 0.02 mm phase resolution. SOC contains epochs for cycle slips, a stand-alone time-tag per epoch, a minimum representation of the receiver's clock solution, 3 SNR numbers, a unique site id, a modulo 12 hour sequence number and flags for receiver type and GPS health. SOC's simple structure comprises an 8 byte header, a 9 byte overhead for timetag, number of gps, etc., plus 21 data bytes per gps.

Visit http://gipsy.jpl.nasa.gov/igdg/papers/SOC_FORMAT.ppt for further details.

F - 4. Config File

The following is an example for the contents of a Unix/Linux configuration file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf. It enables the retrieval of stream HOE20 form www.euref-ip.net and GOPE0 from www.igs-ip.net for the generation of 15 min RINEX files. RINEX files are uploaded to an archive using script 'up2archive' :

[General]
casterHost=
casterPassword=
casterPort=
casterUser=
font="Sans Serif,8,-1,5,50,0,0,0,0,0"
logFile=${HOME}/bnc.log
mountPoints=//user:password@www.euref-ip.net:80/HOE20 RTCM_3.0 54.76 8.29 no, //user:password@www.igs-ip.net:80/GOPE0 RTCM_2.2 49.91 14.79 no
outFile=
outPort=
proxyHost=proxy.bkg.de
proxyPort=8000
rnxAppend=2
rnxIntr=15 min
rnxPath=${HOME}/rinex
rnxSampl=0
rnxScript=${HOME}/up2archive
rnxSkel=SKL
waitTime=5