-BNC decodes and converts GNSS data streams carrying code and phase data coming in -
--
+BNC supports the following GNSS data formats: +
++
-BNC needs access to the Internet with a minimum of about 2 to 6 kbits/sec per stream depending on the stream format and the number of visible satellites. Make sure that you always have the necessary bandwidth available. -
--Note that running BNC requires that the clock of the hosting computer is synchronized. -
--BNC has the capacity to retrieve hundreds of GNSS data streams simultaneously. 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. +BNC requires access to the Internet with a minimum of about 2 to 6 kbits/sec per stream depending on the stream format and the number of visible satellites. You need to make sure that the connection can sustain the required bandwidth. +
++Note that running BNC requires the clock of the host computer to be properly synchronized. +
++BNC has the capacity to retrieve hundreds of GNSS data streams simultaneously. Please be aware that such usage may incur a heavy load on the NTRIP broadcaster side depending on the number of streams requested. We recommend limiting the number of streams where possible to avoid unnecessary workload.
@@ -99,5 +98,5 @@-BNC comes with a help system providing online information about its functionality and usage. Short 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. The dialogs on some operating systems may provide a "?" button that users can click; they then click the relevant widget to pop up the help text. -
- -3.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. +BNC comes with a help system providing online information about its functionality and usage. Short 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 disappears as soon as the user does something else. The dialogs on some operating systems may provide a "?" button that users can click; they then click the relevant widget to pop up the help text. +
+ +3.3. Proxy - for usage in a protected LAN
+If you are running BNC within a protected Local Area Network (LAN), you might need to use a proxy server to access the Internet. 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 the proxy server settings in your Internet browser or ask your network administrator.
++Note that IP streaming is often not allowed in a LAN. In this case you need to ask your network administrator for an appropriate modification of the local security policy or for the installation of a TCP relay to the NTRIP broadcasters. If these are not possible, you might need to run BNC outside your LAN on a host that has unobstructed connection to the Internet.
-BNC lets you output synchronized observations (no ephemeris) 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:
+BNC can generate synchronized epoch by epoch observations from all stations and satellites. The output can be in either a plain ASCII format and/or a binary format. It comprises the following observations where 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'. +Note that SNR stands for the signal-to-noise ratio 'S' mapped to integer numbers 1 to 9. In case an observation is not available, its value is set to zero '0.000'.
3.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 5 seconds. -
--Note that 'Wait for full epoch' does not influence the RINEX Observation file contents. Observations received later than 'Wait for full epoch' seconds will still be included in the RINEX Observation files. +When feeding a real-time GNSS engine waiting for input epoch by epoch, BNC drops 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 acceptable for your real-time GNSS product. Default value for 'Wait for full epoch' is 5 seconds. +
++Note that 'Wait for full epoch' does not effect the RINEX Observation file content. Observations received later than 'Wait for full epoch' seconds will still be included in the RINEX Observation files.
3.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. +Specifies the full path to a file where synchronized observations are saved in plain ASCII format. The default value is an empty option field, meaning that no ASCII output file is created. +
++Beware that the size of this file can rapidly inrease depending on the number of incoming streams. This option is primarily meant for testing and evaluation.
3.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
+BNC can produce synchronized observations in binary format on your local host (IP 127.0.0.1) through an IP port. Specify an IP port number here to activate this function. The default is an empty option field, meaning that no binary output is generated. +The binary output is a continuous stream in the following order:
begEpoch @@ -179,5 +178,5 @@ ...-
where the corresponding structures are defined as
+with the corresponding structures defined as follow:
const char begEpoch = 'A'; @@ -204,13 +203,13 @@ } ;-
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.
+The source code for BNC comes with an example program called 'test_bnc_qt.cpp' that allows you to read BNC's binary output from the IP port.
-Observations will be converted to RINEX if they come in either RTCM Version 2.x, RTCM Version 3.x, 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 Observation file does not contain GLONASS or SBAS data, the 'RINEX TYPE' field in the RINEX Observation file header may be set to 'M (MIXED)'. +Observations will be converted to RINEX if they come in either RTCM Version 2.x, RTCM Version 3.x, 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 the 'RINEX TYPE' field in the RINEX Observation file header is always set to 'M(MIXED)' even if the file does not contain any GLONASS or SABAS data.
-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
+RINEX file names are derived by BNC from the first 4 characters of the corresponding mountpoint (4Char Station ID). For example, data from mountpoints FRANKFURT and WETTZELL will have hourly RINEX Observation files named
FRAN{ddd}{h}.{yy}O
@@ -221,5 +220,5 @@
-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
+If there are more than one stream with identical 4Char Station ID (same first 4 characters for their mountpoints), the mountpoint strings are split into two sub-strings and both become part of the RINEX file name. For example, when simultaneously retrieving data from mountpoints FRANKFURT and FRANCE, their hourly RINEX Observation files are named as
FRAN{ddd}{h}_KFURT.{yy}O
@@ -227,5 +226,5 @@
-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
+If several streams show exactly the same mountpoint name (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
@@ -243,39 +242,39 @@
3.5.2 RINEX Directory - optional
-Enter a path for saving the RINEX Observation files in a directory. If this directory does not exist, BNC will not create RINEX Observation files. Default value for 'RINEX directory' is an empty option field, meaning that streams are not converted to RINEX. +Here you can specify the path to where the RINEX Observation files will be stored. If the specified directory does not exist, BNC will not create RINEX Observation files. Default value for 'RINEX directory' is an empty option field, meaning that no RINEX Observation files will be written.
3.5.3 RINEX Version - optional
-Default format for RINEX Observation files is RINEX Version 2.11. Select 'RINEX v3' if you want to save observations in RINEX Version 3 format. +The default format for RINEX Observation files is RINEX Version 2.11. Select 'RINEX v3' if you would like to save observations in RINEX Version 3 format.
-Whenever a RINEX Observation 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 Observation file path will be passed to the script as a command line parameter (%1 on Windows systems, $1 on Unix/Linux systems). +Whenever a RINEX Observation file is saved, you might want to compress, copy or upload it immediately via FTP. BNC allows you to execute a script/batch file to carry out these operations. To do that specify the full path of the script/batch file here. BNC will pass the RINEX Observation file path 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 Observation 'File interval'. If that is superposed by a stream outage, the triggering event is the stream reconnect. +The triggering event for calling the script or batch file is the end of a RINEX Observation 'File interval'. If that is overridden by a stream outage, the triggering event is the stream reconnection.
-As an alternative to initiating file uploads through BNC, you may like to call an upload script or bach file through your crontable (independant from BNC) once every 2 or 3 minutes after the end of each RINEX 'File interval'. -
- -3.5.5 RINEX File Interval - mandatory if 'RINEX directory' set
-Select the interval for the RINEX Observation file generation. Default for RINEX 'File interval' is 15 minutes. -
- -3.5.6 RINEX Sampling - mandatory if 'RINEX directory' set
-Select the RINEX Observation sample interval in seconds. Zero '0' stands for converting all incoming epochs to RINEX. Default for RINEX 'Sampling' is '0'. +As an alternative to initiating file uploads through BNC, you may like to call an upload script or batch file through your crontable or Task Scheduler (independent from BNC) once every 2 or 3 minutes after the end of each RINEX 'File interval'. +
+ +3.5.5 RINEX File Interval - mandatory if 'RINEX directory' is set
+Select the length of the RINEX Observation file generated. The default value is 15 minutes. +
+ +3.5.6 RINEX Sampling - mandatory if 'RINEX directory' is set
+Select the RINEX Observation sampling interval in seconds. A value of zero '0' tells BNC to store all received epochs into RINEX. This is the default value.
3.5.7 RINEX Skeleton Extension - optional
-Whenever BNC starts generating RINEX Observation 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. +Whenever BNC starts generating RINEX Observation 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. A 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 of a public RINEX header skeleton file for the Brussels EPN station. +
++However, sometimes public RINEX header skeleton files are not available, its contents is not up to date, or you need to put additional/optional records in the RINEX header. For that BNC allows using personal skeleton files that contain the header records you would like to include. You can 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 corresponding stream.
@@ -293,10 +292,10 @@ 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 Observation file. +If neither a public nor a personal RINEX header skeleton file is available for BNC, a default header will be used.
@@ -325,9 +324,9 @@-When starting BNC, new RINEX Observation files are created by default. Probably existing files will be overwritten. However, it may be desirable to append observations to already existing RINEX Observation 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 RINEX Navigation files, the 'ASCII output file' and the 'Log' file. +When BNC is started, new RINEX Observation files are created by default and any existing files with the same name will be overwritten. However, users might want to append observations and ephemeris to existing RINEX files following a restart of BNC, a system crash or when BNC crashed. Tick 'Append files' to continue with existing files and keep what has been recorded so far. Note that option 'Append files' also affects RINEX Navigation files, the 'ASCII output file' and the 'Log' file.
-Broadcast Ephemeris can be saved in RINEX Navigation files if received in RTCM Version 3.x as message types 1019 (GPS) and 1020 (GLONASS). The file name convention follows the details given in section 'RINEX File Names' except that the first four characters are 'BNC_' and the last character is +Broadcast Ephemeris can be saved as RINEX Navigation files when received via RTCM Version 3.x as message types 1019 (GPS) and 1020 (GLONASS). The file name convention follows the details given in section 'RINEX File Names' except that the first four characters are 'BNC_' and the last character is
3.6.1 Ephemeris Directory - optional
-Enter a path for saving Broadcast Ephemeris data as RINEX Navigation files in a directory. If this directory does not exist, BNC will not create RINEX Navigation files. Default value for 'Ephemeris directory' is an empty option field, meaning that no RINEX Navigation files are created. +Specify the path for saving Broadcast Ephemeris data as RINEX Navigation files. If the specified directory does not exist, BNC will not create RINEX Navigation files. Default value for 'Ephemeris directory' is an empty option field, meaning that no RINEX Navigation files will be created.
@@ -346,23 +345,23 @@ -3.6.3 Ephemeris Interval - mandatory if 'Ephemeris directory' set
-Select the interval for the RINEX Navigation file generation. Default for Ephemeris 'File interval' is 1 day. +
3.6.3 Ephemeris Interval - mandatory if 'Ephemeris directory' is set
+Select the length of the RINEX Navigation file generated. The default value is 1 day.
-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: +Each stream on an NTRIP broadcaster is defined using a unique source ID called mountpoint. An NTRIP client like BNC access the desired data stream by referring to 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 under the 'Mountpoints' section on BNC's main window. The list provides the following information extracted from source-table(s) produced by the NTRIP broadcasters:| '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'. |
| 'decoder' | Type of decoder used to handle the incoming stream content according to its format; editable. |
| 'lat' | Approximate latitude of reference station, in degrees, north; editable if 'nmea' = 'yes'. |
| 'long' | Approximate longitude of reference station, in degrees, east; editable if 'nmea' = 'yes'. |
| 'nmea' | Indicates whether or not streaming needs to be initiated by BNC through sending NMEA-GGA message carrying position coordinates in 'lat' and 'long'. |
| 'bytes' | Number of bytes retrieved. |
-Button 'Add Mountpoints' opens a window that allows you to select data streams from an NTRIP broadcaster by their mountpoints. -
- -3.7.2 Broadcaster Host and Port - mandatory
3.7.2 Broadcaster Host and Port - required
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.
-3.7.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. +
3.7.3 Broadcaster User and Password - required for protected streams
+Some streams on NTRIP broadcasters may be restricted. Enter a valid 'User' ID and 'Password' for access to protected 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.
-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 Version 2.x, RTCM Version 3.x, or RTIGS format. RTCM Version 2.x streams must contain message types 18 and 19 while RTCM Version 3.x streams must contain GPS or SBAS 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. Note that RINEX Navigation files containing Broadcast Ephemeris need RTCM Version 3.x streams containing message types 1019 (GPS) and 1020 (GLONASS). Select your streams line by line, use +Shift and +Ctrl when necessary. +Use the 'Get Table' button 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 Version 2.x, RTCM Version 3.x, or RTIGS format. RTCM Version 2.x streams must contain message types 18 and 19 while RTCM Version 3.x streams must contain GPS or SBAS 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. Note that in order to produce RINEX Navigation files RTCM Version 3.x streams containing message types 1019 (GPS) and 1020 (GLONASS) are required. Select your streams line by line, use +Shift and +Ctrl when necessary.
@@ -391,22 +390,22 @@
-Hit 'OK' to return to the main window. You may like to 'Add Mountpoints' from another NTRIP broadcaster when necessary. +Hit 'OK' to return to the main window. If you wish you can click on 'Add Mountpoints' and repeat the process again to retrieve mountpoints from different casters.
-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.
+To remove a stream from the 'Mountpoints' list in the main window, highlight it by clicking on it and hit the 'Delete Mountpoints' button. You can also remove multiple mountpoints simultaneously by highlighting them using +Shift and +Ctrl.-BNC comments its activities in the 'Log' section of 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. +Records of BNC's activities are shown in the 'Log' section of the main windows. These logs can be saved into a file when a valid path is specified in the 'Log (full path)' field. The message log covers the communication status between BNC and the NTRIP broadcaster as well as problems that may occur in the communication link, stream availability, stream delay, stream conversion etc. The default value for 'Log (full path)' is an empty option field, meaning that BNC logs will not saved into a file.
-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. +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 which might overwrite existing files when necessary unless the option 'Append files' is ticked.
@@ -430,22 +429,22 @@-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, see Config File example in the Annex) or from the register BKG_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. +On all systems BNC can be started in batch mode with the command line option '-nw'. BNC will then run in 'no window' mode, using options from the configuration file ${HOME}/.config/BKG/BNC_NTRIP_Client.conf (Unix/Linux, see Config File example in the Annex) or from the register BKG_NTRIP_Client (Windows). +
++Note that the self-explaining contents of the configuration file or the Windows register can easily be edited. Terminate BNC using Windows Task Manager when running it in 'no window' mode on Windows systems.
-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: +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 includes 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: +Please ensure that you have installed the latest version of BNC available from http://igs.bkg.bund.de/index_ntrip_down.htm. We are continuously working on the program and would appreciate if you could send any comments, suggestions, or bug reports to:
@@ -483,4 +482,9 @@
Frankfurt, Germany
euref-ip@bkg.bund.de or igs-ip@bkg.bund.de
+
+Acknowledgements
+BNC's Help Contents has been proofread by Thomas Yan, University of New South Wales, Australia.
+Scott Glazier, OmniSTAR Australia, has been helpful in finding BNC's bugs.