Changeset 4206 in ntrip for trunk/BNC/bnchelp.html

Timestamp:

May 22, 2012, 1:28:01 PM (13 years ago)

Author:

weber

Message:

Documentation completed

File:

• trunk/BNC/bnchelp.html (modified) (13 diffs)

trunk/BNC/bnchelp.html

@@ -4 +4 @@
 <p>
 The BKG Ntrip Client (BNC) is a program for simultaneously retrieving, decoding, converting and processing real-time GNSS data streams. It has been developed within the framework of the IAG subcommission for Europe (EUREF) and the International GNSS Service (IGS). Although meant as a real-time tool, it comes with some Post Processing functionality. You may like to use it for data coming from NTRIP Broadcasters like
-</p>
-<p>
-<u>http://www.euref-ip.net/home</u>,<br>
-<u>http://www.igs-ip.net/home</u>,<br>
-<u>http://products.igs-ip.net/home</u>, or<br>
+<u>http://www.euref-ip.net/home</u>,
+<u>http://www.igs-ip.net/home</u>,
+<u>http://products.igs-ip.net/home</u>, or
 <u>http://mgex.igs-ip.net/home</u>. 
 </p>
@@ -294 +292 @@
 &nbsp; &nbsp; &nbsp; 3.16.1 <a href=#streamedit>Edit Streams</a><br>
 &nbsp; &nbsp; &nbsp; 3.16.2 <a href=#streamdelete>Delete Stream</a><br>
-&nbsp; &nbsp; &nbsp; 3.16.3 <a href=#streamconf>Reconfigure Streams On-the-fly</a><br><br>
+&nbsp; &nbsp; &nbsp; 3.16.3 <a href=#streamconf>Reconfigure Stream Selection On-the-fly</a><br><br>
 <b>Logging Canvas</b><br>
 3.17. <a href=#logs>Logging</a><br>
@@ -2080 +2078 @@
 <p><a name="streams"><h4>3.16. Streams</h4></p>
 <p>
-Each stream on an NTRIP Broadcaster (and consequently on BNC) 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 streams and their 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.
-</p>
-
-<p>
-Streams selected for retrieval are listed under the 'Streams' canvas section on BNC's main window. The list provides the following information either extracted from source-table(s) produced by the NTRIP Broadcasters or introduced by BNC's user:
+Each stream on an NTRIP Broadcaster (and consequently on BNC) is defined using a unique source ID called mountpoint. An NTRIP Client like BNC access the desired stream by referring to its mountpoint. Information about streams and their 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.
+</p>
+
+<p>
+Streams selected for retrieval are listed under the 'Streams' canvas on BNC's main window. The list provides the following information either extracted from source-table(s) produced by the NTRIP Broadcasters or introduced by BNC's user:
 </p>
 <p>
@@ -2118 +2116 @@
 To remove a stream from the 'Streams' canvas in the main window, highlight it by clicking on it and hit the 'Delete Stream' button. You can also remove multiple streams simultaneously by highlighting them using +Shift and +Ctrl.</p>
 
-<p><a name="streamconf"><h4>3.16.3 Reconfigure Streams On-the-fly</h4></p>
+<p><a name="streamconf"><h4>3.16.3 Reconfigure Stream Selection On-the-fly</h4></p>
 <p>
 The streams selection can be changed on-the-fly without interrupting uninvolved threads in the running BNC process.
@@ -2139 +2137 @@
 <p><a name="throughput"><h4>3.17.2 Throughput</h4></p>
 <p>
-The bandwidth consumption per stream is shown in the 'Throughput' tab in bits per second (bps) or kilo bits per second (kbps). The following figure shows the bandwidth comsumption of incoming streams.
+The bandwidth consumption per stream is shown in the 'Throughput' tab in bits per second (bps) or kilo bits per second (kbps). The following figure shows an example for the bandwidth comsumption of incoming streams.
 </p>
 
@@ -2147 +2145 @@
 <p><a name="latency"><h4>3.17.3 Latency</h4></p>
 <p>
-The latency of observations in each incoming stream is shown in the 'Latency' tab in milliseconds or seconds. Streams not carrying observations (i.e. those providing only Broadcast Ephemeris messages) or having an outage are not considered here and shown in red color. Note that the calculation of correct latencies requires the clock of the host computer to be properly synchronized. The next figure shows the latency of incoming streams.
+The latency of observations in each incoming stream is shown in the 'Latency' tab in milliseconds or seconds. Streams not carrying observations (i.e. those providing only Broadcast Ephemeris messages) or having an outage are not considered here and shown in red color. Note that the calculation of correct latencies requires the clock of the host computer to be properly synchronized. The next figure shows an example for the latency of incoming streams.
 </p>
 
@@ -2177 +2175 @@
 <p><a name="streamhost"><h4>3.18.1.1 Caster Host and Port - mandatory</h4></p>
 <p>
-Enter the NTRIP Broadcaster host IP and port number. Note that EUREF and IGS operate NTRIP Broadcasters at <u>http://www.euref-ip.net/home</u> and <u>http://www.igs-ip.net/home</u> and <u>http://www.products.igs-ip.net/home</u>.
+Enter the NTRIP Broadcaster host IP and port number. Note that EUREF and IGS operate NTRIP Broadcasters at <u>http://www.euref-ip.net/home</u>, <u>http://www.igs-ip.net/home</u>, <u>http://www.products.igs-ip.net/home</u> and <u>http://mgex.igs-ip.net/home</u>.
 </p> 
 
@@ -2191 +2189 @@
 <p><a name="streamuser"><h4>3.18.1.3 User and Password - mandatory for protected streams</h4></p>
 <p>
-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 <u>http://igs.bkg.bund.de/ntrip/registeruser</u> for access to protected streams on <u>www.euref-ip.net</u> or <u>www.igs-ip.net</u> or <u>products.igs-ip.net</u>.
+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 <u>http://igs.bkg.bund.de/ntrip/registeruser</u> for access to protected streams from EUREF and IGS.
 </p> 
 
 <p><a name="gettable"><h4>3.18.1.4 Get Table</h4></p>
 <p>
-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, RTCM Version 3, or RTNET format. For access to observations, ephemeris or ephemeris corrections, an RTCM Version 2 streams must contain message types 18 and 19 or 20 and 21 while an RTCM Version 3 streams must contain
-<ul>
-<li>GPS or SBAS message types 1002 or 1004, or</li>
-<li>GLONASS message types 1010 or 1012, or</li>
-<li>proposed State Space Representation messages for GPS and GLONASS, types 1057-1068, or</li>
-<li>proposed 'Multiple Signal Messages' (MSM) for GPS, GLONASS, or Galileo, types 1071-1077, 1081-1087, or 1091-1097.</li>
-</ul>
-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 streams containing message types 1019 (GPS) and 1020 (GLONASS) and 1045 (Galileo) are required. Select your streams line by line, use +Shift and +Ctrl when necessary. The figure below provides an example source-table.
+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, RTCM Version 3, or RTNET format. For access to observations, Broadcast Ephemeris and Broadcast Corrections in RTCM format streams must contain a selection of appropriate message types as listed in the Annex, cf. 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 streams containing message types 1019 (GPS) and 1020 (GLONASS) and 1045 (Galileo) are required. Select your streams line by line, use +Shift and +Ctrl when necessary. The figure below provides an example source-table.
 </p> 
 <p>
@@ -2240 +2231 @@
 <p><a name="map"><h4>3.18.1.6 Map - optional</h4></p>
 <p>
-Button 'Map' opens a window to show a distribution map of the casters' streams. You may like to zoom in or out using option 'Zoom +' or 'Zoom -'. You may also like to 'Clean' or 'Reset' a map or let it 'Fit' exactly to the current size of the window. Option 'Close' shuts the window.
+Button 'Map' opens a window to show a distribution map of the caster's streams. You may like to zoom in or out using option 'Zoom +' or 'Zoom -'. You may also like to 'Clean' or 'Reset' a map or let it 'Fit' exactly to the current size of the window. Option 'Close' shuts the window.
 </p>
 <p><img src="IMG/screenshot24.png"/></p>
@@ -2258 +2249 @@
 </p>
 <p>
-Streams directly received from a TCP/IP port show up with an 'N' for 'No NTRIP' in the 'Streams' canvas section on BNC's main window. Latitude and longitude are to be entered just for informal reasons.
+Streams directly received from a TCP/IP port show up with an 'N' for 'No NTRIP' in the 'Streams' canvas on BNC's main window. Latitude and longitude are to be entered just for informal reasons.
 <p>
 </p>
@@ -2321 +2312 @@
 <p><a name="start"><h4>3.18.5 Start</h4></p>
 <p>
-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.
+Hit 'Start' to start retrieving, decoding or 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.
 </p> 
 
@@ -2331 +2322 @@
 <p><a name="cmd"><h4>3.19. Command Line Options</h4></p>
 <p> 
-Command line options are available to run BNC in 'no window' mode or let it read data offline from one file or several files for debugging or Post Processing purposes. BNC will then use processing options from the configuration file. Note that the self-explaining contents of the configuration file can easily be edited. It is possible to introduce a specific configuration file name instead of using the default name 'BNC.bnc'.
+Command line options are available to run BNC in 'no window' mode or let it read data offline from one or several files for debugging or Post Processing purposes. BNC will then use processing options from the involved configuration file. Note that the self-explaining contents of the configuration file can easily be edited. It is possible to introduce a specific configuration file name instead of using the default name 'BNC.bnc'.
 </p> 
 
 <p><a name="nw"><h4>3.19.1 No Window Mode - optional</h4></p>
 <p>
-Apart from its regular windows mode, BNC can be started on all systems as a background/batch job with command line option '-nw'. BNC will then run in 'no window' mode, using processing options from its configuration file on disk. Terminate BNC using Windows Task Manager when running it in 'no window' mode on Windows systems.
+Apart from its regular windows mode, BNC can be started on all systems as a batch job with command line option '-nw'. BNC will then run in 'no window' mode, using processing options from its configuration file on disk. Terminate BNC using Windows Task Manager when running it in 'no window' mode on Windows systems.
 </p> 
 <p> 
@@ -2404 +2395 @@
 </li>
 
-<li>BNC has some limits with regards to handling data from new GNSS like COMPAS and QZSS.
-Which observables become available on a particular stream also depends on the setup of source receiver and the data format used.
-</li>
+<li>Observations from COMPASS and QZSS are so far not supported.</li>
 <li>
 Using RTCM Version 3 to produce RINEX files, BNC will properly handle most message types. However, when handling message types 1001, 1003, 1009 and 1011 where the ambiguity field is not set, the output will be no valid RINEX. All values will be stored modulo 299792.458 (speed of light).