Changeset 199 in ntrip for trunk/BNC/bnchelp.html
- Timestamp:
- Oct 5, 2006, 5:32:52 PM (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/BNC/bnchelp.html
r198 r199 1 2 <p><h3>BKG Ntrip Client (BNC)</h3></p> 1 <h3>BKG Ntrip Client (BNC)</h3> 3 2 4 3 <p> … … 8 7 BNC has been developed for the Federal Agency for Cartography and Geodesy (BKG) within the framework of the EUREF-IP Pilot Project (EUREF-IP) and the Real-Time IGS Working Group (RTIGS). 9 8 </p> 10 11 <p> 9 <p> 10 BNC is written under GNU General Public License (GPL). Binaries for BNC are available for Windows, Linux, and Solaris systems. It is likely that BNC can be compiled on other systems where a GNU compiler and Qt Version 4 are available. 11 </p> 12 12 <h3>Contents</h3> 13 <p> 13 14 <h4> 14 15 <a href=#purpose>A - Purpose</a><br> … … 29 30 <ul> 30 31 <li>Retrieve real-time GNSS data streams available through NTRIP transport protocol,</li> 31 <li>Generate high-rate RINEX files to feednear real-time GNSS post-processing applications, and/or</li>32 <li>Output synchronize observations through an IP port to feedreal-time GNSS engines.</li>32 <li>Generate high-rate RINEX files to support near real-time GNSS post-processing applications, and/or</li> 33 <li>Output synchronize observations through an IP port to support real-time GNSS engines.</li> 33 34 </ul> 34 35 <p> … … 41 42 </ul> 42 43 </p> 43 44 <p>45 BNC has been developed under GNU General Public License (GPL). Binaries for BNC are available for Windows, Linux, and Solaris systems. It is likely that BNC can be compiled on other systems where a GNU compiler and Qt Version 4 are available.46 </p>47 48 <br>49 44 <a name="options"> 50 45 <p><h3>B - Options</h3></p> … … 69 64 B - 6.4. <a href=#GetTable>Get Table</a><br> 70 65 B - 6.5. <a href=#delete>Delete Mountpoints</a><br> 66 B - 6.6. <a href=#edit>Edit Mountpoints</a><br> 71 67 B - 7. <a href=#log>Log File</a><br> 72 68 B - 8. <a href=#start>Start</a><br> … … 83 79 <li> 84 80 Select an appropriate font.<br> 85 Use a small font size i n case the BNCwindow exceeds the size of your screen.81 Use a small font size if the BNC main window exceeds the size of your screen. 86 82 </li> 87 83 <li> Save selected options.<br> … … 115 111 116 112 <p> 117 You may like to run BNC in a Local Area Network (LAN) environment. LAN's 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 Windows browser or ask your network administrator.</p>113 You may like to run BNC in a Local Area Network (LAN). LAN's 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 Windows browser or ask your network administrator.</p> 118 114 <p> 119 115 Note that IP streaming may be generally denied in a LAN. In such a case you need to request an appropriate modification of the security policy from your network administrator or ask for the installation of a TCP relay to involved NTRIP broadcasters. If that doesn't work out, run BNC on a host that is connected to the Internet through an Internet Service Provider (ISP). … … 122 118 <a name="output"> <p><h4>B - 4. Synchronized Output</h4></p> 123 119 <p> 124 BNC lets you output synchronized observations epoch by epoch. This output is made available in ASCII format and in binary format. The output comprises the following observations if available:</p>120 BNC lets you output synchronized observations epoch by epoch. This output is made available in ASCII format and in a binary format. The output comprises the following observations if available:</p> 125 121 StatID, SVPRN, GPSWeek, GPSWeeks, sec, C1, P2, L1, L2, SNR1, SNR2, pCodeIndicator, cumuLossOfCont. 126 122 </p> … … 129 125 <p><h4>B - 4.1 Wait for Full Epoch - optional</h4></p> 130 126 <p> 131 When feeding a real-time GNSS engine waiting for input from BNC epoch by 132 epoch, BNC ignores whatever is received later then 'Wait for full epoch' 133 seconds. A value of 2 to 5 seconds may be an appropriate choice for that, 134 depending on the delay you can accept for your real-time product. Default 135 value for 'Wait for full ecpch' is 1 second. 127 When feeding a real-time GNSS engine waiting for input epoch by epoch, BNC ignores whatever is received later then 'Wait for full epoch' seconds. A value of 2 to 5 seconds may be an appropriate choice for that, depending on the delay you can accept for your real-time GNSS product. Default value for 'Wait for full ecpch' is 1 second. 136 128 </p> 137 129 <p> … … 142 134 <p><h4>B - 4.2 ASCII Output File - optional</h4></p> 143 135 <p> 144 Enter the full path for a file to save synchronized observations in plain ASCII format. Default value is an empty option field, meaning that no ASCII output file is generated.136 Enter the full path for a file to save synchronized observations in plain ASCII format. Default value is an empty option field, meaning that no ASCII output file is created. 145 137 </p> 146 138 … … 148 140 <p><h4>B - 4.3 Port for Binary Output - optional</h4></p> 149 141 <p> 150 BNC makes synchronized observations available in a binary format through an IP 151 port. Enter the port number to activate this function. Default is an empty 152 option field, meaning that no binary output is generated. 153 </p> 154 <p>The Binary output is provided as a continuous stream 142 BNC makes synchronized observations available in a binary format through an IP port on your local host IP 127.0.0.1. Enter the port number to activate this function. Default is an empty option field, meaning that no binary output is generated.</p> 143 <p>The binary output is provided as a continuous stream in the order</p> 155 144 <pre> 156 145 begEpoch … … 166 155 ... 167 156 </pre> 168 where the corresponding structures are defined as 157 <p>where the corresponding structures are defined as</p> 169 158 <pre> 170 159 const char begEpoch = 'A'; … … 187 176 } ; 188 177 </pre> 189 </p>190 178 191 179 <a name="rinex"> … … 194 182 Observations are converted to RINEX Version 2.1. RINEX file names are derived by BNC from the first 4 characters of the corresponding mountpoint (4Char Station ID) while truncating the residual part of the mountpoint string. Thus, retrieving data from mountpoints FRANKFURT and WETTZELL leads to RINEX files named FRAN*.* and WETT*.*.</p> 195 183 <p> 196 In case you retrieve streams that show mountpoints with an identical 4Char Station ID (same first 4 characters), the mountpoint string is split in two sub-strings and both become part of the RINEX file name. Example: When simultaneously retrieving data from mountpoints FRANKFURT and FRANCE, there RINEX file names are defined as FRAN*_KFURT.* and FRAN*_CE.*. 184 If you retrieve streams that show mountpoints with an identical 4Char Station ID (same first 4 characters), the mountpoint string is split in two sub-strings and both become part of the RINEX file name. Example: When simultaneously retrieving data from mountpoints FRANKFURT and FRANCE, there RINEX file names are defined as FRAN*_KFURT.* and FRAN*_CE.*. 185 </p> 186 <p> 187 Note that RINEX file names for file intervals less than 1 hour are created following the file name convention for 15 minute RINEX files. 197 188 </p> 198 189 … … 200 191 <p><h4>B - 5.1 RINEX Directory Path - optional</h4></p> 201 192 <p> 202 Enter a path for saving the RINEX files in a directory. If this directory does not exist, BNC will not generate RINEX files. Default value for 'RINEX directory path' is an empty option field, meaning that streams are not converted to RINEX.193 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 path' is an empty option field, meaning that streams are not converted to RINEX. 203 194 </p> 204 195 205 196 <a name="rnxscript"> 206 <p><h4>B - 5.2 RINEX Script </h4></p>207 <p> 208 Whenever a RINEX file is generated, you may like to compress, copy, or upload it immediately. For that you enter the full path of a script or batch file carrying out these operations. The RINEX file name will be passed to the script as a command line parameter.197 <p><h4>B - 5.2 RINEX Script - optional</h4></p> 198 <p> 199 Whenever a RINEX file is generated, you may like to compress, copy, or upload it immediately. For that you enter the full path of a script or batch file carrying out these operations. The RINEX file path and name will be passed to the script as a command line parameter (%1 on Windows systems, $1 on UNIX/Linux systems). 209 200 </p> 210 201 … … 224 215 <p><h4>B - 5.5 RINEX Skeleton Extension - optional</h4></p> 225 216 <p> 226 BNC lets you introduce RINEX skeleton files that contain the header records you would like to see instead of a default header. You may like to derive RINEX skeleton files from the information given in sitelogs. A file in the 'RINEX directory path' with the 'RINEX skeleton extension' is understood by BNC as a RINEX skeleton file for the affected stream. 227 </p> 228 <p> 229 Example: Mountpoint FRAN0 leads to the generation of RINEX files FRAN*.*. The header part of this files would be overwritten by the content of an existing skeleton file FRAN.skl in case 'RINEX skeleton extension' is set to 'skl' . 230 </p> 217 BNC lets you introduce RINEX header skeleton files that contain the header records you would like to see instead of a default header. You may like to derive RINEX skeleton files from the information given in sitelogs. A file in the 'RINEX directory path' with the 'RINEX skeleton extension' is understood by BNC as a RINEX header skeleton file for the affected stream. 218 </p> 219 <p> 220 Example: Mountpoint FRAN0 leads to the generation of RINEX files FRAN*.*. The header part of this files would be overwritten by the content of an existing skeleton file named FRAN.skl if 'RINEX skeleton extension' is set to 'skl' . 221 </p> 222 <p> 223 Note the following conditions regarding RINEX header skeleton files. 224 <ul> 225 <li>They should contain empty header records of type:</li> 226 <br> PGM / RUN BY / DATE 227 <br> # / TYPES OF OBSERVATIONS 228 <br> TIME OF FIRST OBS 229 <br>The existence of these empty records will force BNC to include such lines in the final RINEX file header together with an additional COMMENT line mentioning the source of the stream. 230 <li>They must contain an empty header record of type:</li> 231 <br> END OF HEADER 232 <li>They may contain any other complete header record as defined in the RINEX Version 2.1 documentation. Its contents may be derived from sitelog files.</li> 233 </ul> 234 <p> 231 235 232 236 <a name="mountpoints"> … … 239 243 <p><h4>B - 6.1 Add Mountpoints</h4></p> 240 244 <p> 241 Button 'Add Mountpoints' opens a window that lets you select data streams by their mountpoints.245 Button 'Add Mountpoints' opens a window that lets you select data streams from an NTRIP broadcaster by their mountpoints. 242 246 </p> 243 247 … … 257 261 <p><h4>B - 6.4 Get Table</h4></p> 258 262 <p> 259 Hit button 'Get Table' to download a sourcetable from the NTRIP broadcaster. Pay attention to data fields 'format' and 'format-details'. Rememberthat 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 message types 1001 or 1003, better 1003 or 1004, 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. Hit 'OK' to return to the main window.263 Hit button 'Get Table' to download the sourcetable from the NTRIP broadcaster. Pay attention to data fields 'format' and 'format-details'. Have 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 message types 1001 or 1003, better 1003 or 1004, 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. Hit 'OK' to return to the main window. 260 264 </p> 261 265 … … 263 267 <p><h4>B - 6.5 Delete Mountpoints</h4></p> 264 268 <p> 265 To delete a stream shown under 'Mountpoints' in the main window select it by mouse click and then hit 'Delete Mountpoints'. For simultaneous deletion of several streams single them out through using +Shift and +Ctrl.</p> 269 To delete a stream shown under 'Mountpoints' in the main window select it by mouse click and hit 'Delete Mountpoints'. For simultaneous deletion of several streams single them out through using +Shift and +Ctrl.</p> 270 271 <a name="edit"> 272 <p><h4>B - 6.6 Edit Mountpoints</h4></p> 266 273 <p> 267 274 BNC automatically selects one out of several internal decoders for a stream based on its 'format' and 'format-details' as given in the sourcetable. It may happen that you need to overrule the automated decoder selection because of sourcetable setup deficiencies. Therefore BNC allows to edit the decoder part for each stream shown under 'Mountpoints'. Accepted decoder strings allowed to be introduced are 'RTCM_2.x', 'RTCM_3', and 'RTIGS'. … … 271 278 <p><h4>B - 7. Log File - optional</h4></p> 272 279 <p> 273 BNC's comments its activities in the 'Log file' section on the main windows. Comments can be saved and concatenated in a file when entering a full path for 'Log file'. Information is given about the communication between BNC and the NTRIP broadcaster as well as about problems that occur concerning communication link, stream availability, stream delay, stream conversion etc. Default value for 'Log file' is an empty option field, meaning that BNC's comments are not saved in a file. 274 </p> 275 <p> 276 Note that a connection to the NTRIP broadcaster may break or a stream requested may be temporarily unavailable. When this happens, a reconnect is tried with decreasing frequency. BNC first tries to reconnect with 1 second delay, if unsuccessful, tries again in 2 seconds from the last attempt, if still unsuccessful tries with 4 seconds from the last attempt etc. Each attempt doubles the delay from the previous attempt. The maximum delay between attempts is limited to 60 seconds. The reconnection process is documented in 'Log file'. 277 </p> 280 BNC comments its activities in the 'Log file' section on the main windows. Comments can be saved and concatenated in a file when entering a full path for 'Log file'. Information is given about the communication between BNC and the NTRIP broadcaster as well as about problems that occur concerning communication link, stream availability, stream delay, stream conversion etc. Default value for 'Log file' is an empty option field, meaning that BNC comments are not saved in a file. 281 </p> 278 282 279 283 <a name="start"> … … 292 296 <p><h4>B - 10. No Window - optional</h4></p> 293 297 <p> 294 On all systems you may like to use BNC in batch mode with the command line 295 option -nw. BNC then runs in 'no window' mode, reading options from the 296 configuration file ${HOME}/.config/BKG/BNC_NTRIP_Client (Unix/Linux) or from 297 the registers (Windows). 298 </p> 299 <p> 300 Note that the self-explaining contents of the configuration file can easily be edited and option -nw is not available under Windows. 298 You can use BNC 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 (Unix/Linux) or from the registers (Windows). 299 </p> 300 <p> 301 Note that the self-explaining contents of the configuration file or the Windows registers can easily be edited. 301 302 </p> 302 303 <br> … … 305 306 <ul> 306 307 <li> 308 A connection to the NTRIP broadcaster may break or a stream requested may be temporarily unavailable. Furthermore, a connection is interpreted by BNC to be broken if no data is coming in for a period of 20 seconds. When this happens, a reconnect is tried with decreasing frequency. BNC first tries to reconnect with ~1 second delay, if unsuccessful, tries again in ~2 seconds from the last attempt, if still unsuccessful tries with ~4 seconds from the last attempt etc. Each attempt doubles the delay from the previous attempt. The maximum delay between attempts is limited to ~128 seconds. The reconnection process is documented in 'Log file'. 309 </li> 310 <li> 307 311 So far BNC only handles GPS data while ignoring GLONASS and Galileo observations. Furthermore, its function is limited today to processing L1, L2, P1, and P2 observations only. 308 312 </li> … … 325 329 </li> 326 330 <li> 327 BNC's 'Get Table' function only informs about the STR records of a sourcetable. Note that you can use an Internet browser to download the full sourcetable contents of any NTRIP broadcaster by simply entering its URL : http://host:port/dummy. Data field number 8 of the NET recordsmay provide information about where to register for an NTRIP broadcaster account.328 </li> 329 <li> 330 EUREF as well as IGS follow an open data policy. Streams are made available through NTRIP broadcasters at <u>www.euref-ip.net</u> and <u>www.igs-ip.net</u> free of charge to anybody for any purpose. It is not clear today how many users will have to be supported simultaneously. The situation may develop in a way that it becomes difficult to serve all registered users at any time. In case limited dissemination resources on the NTRIP broadcaster side (software restrictions, bandwidth limitation etc.) make it necessary, first priority in stream provision will be given to stream providers, re al-time analysis centres, and re-broadcasting activities while access for others may be temporarily denied.331 </li> 332 < /ul>333 < br>331 BNC's 'Get Table' function only informs about the STR records of a sourcetable. Note that you can use an Internet browser to download the full sourcetable contents of any NTRIP broadcaster by simply entering its URL plus a dummy string in the form http://host:port/dummy. Data field number 8 of the NET records that may show up may provide information about where to register for an NTRIP broadcaster account. 332 </li> 333 <li> 334 EUREF as well as IGS follow an open data policy. Streams are made available through NTRIP broadcasters at <u>www.euref-ip.net</u> and <u>www.igs-ip.net</u> free of charge to anybody for any purpose. It is not clear today how many users will have to be supported simultaneously. The situation may develop in a way that it becomes difficult to serve all registered users at any time. In case limited dissemination resources on the NTRIP broadcaster side (software restrictions, bandwidth limitation etc.) make it necessary, first priority in stream provision will be given to stream providers, re-broadcasting activities, and real-time analysis centres while access for others may be temporarily denied. 335 </li> 336 <br> 337 </ul> 334 338 <a name="authors"> 335 339 <p><h3>D - Authors</h3></p> 336 340 <p> 337 Basically BNC is an NTRIP Qt Graphic User Interface (GUI) developed for the Federal Agency for Cartography and Geodesy (BKG) by Leos Mervart (Czech Technical University Prague, Department of Advanced Geodesy). BNC integrates the following already existing GNU GPL software components:338 <ul> 339 <li> RTCM 2.x decoder, written by John Sager with contributions from Carsten Becker (German Aerospace Center, DLR, Neustrelitz)</li>340 <li> RTCM 3 decoder, written for BKG by Dirk Stoecker (Euronik GmbH, Schoenefeld)</li>341 <li> RTIGS decoder, written by Ken MacLeod (Natural Resources Canada, NRCan)</li>341 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 Advanced Geodesy. BNC integrates the following GNU GPL software components: 342 <ul> 343 <li> RTCM 2.x decoder, written by John Sager with contributions from Carsten Becker, German Aerospace Center, DLR, Neustrelitz</li> 344 <li> RTCM 3 decoder, written for BKG by Dirk Stoecker, Euronik GmbH, Schoenefeld</li> 345 <li> RTIGS decoder, written by Ken MacLeod, Natural Resources Canada, NRCan</li> 342 346 </ul> 343 347 </p> … … 356 360 <p><h3>E - Links</h3></p> 357 361 <table> 362 <tr></tr> 358 363 <tr><td>NTRIP </td><td><u>http://igs.bkg.bund.de/index_ntrip.htm</u></td></tr> 359 364 <tr><td>EUREF-IP NTRIP broadcaster </td><td><u>http://www.euref-ip.net/home</u></td></tr> … … 363 368 <tr><td>Real-Time IGS Working Group </td><td><u>http://igscb.jpl.nasa.gov/projects/rtwg/index.html</u> 364 369 </table> 365 <br> <br>370 <br> 366 371 367 372 <a name="annex"> … … 402 407 <li>Enables streaming over mobile IP networks because of using TCP/IP.</li> 403 408 </ul> 404 </p> <br>409 </p> 405 410 406 411 <a name="source"> … … 417 422 Sourcetable records of type NET contain the following data fields: 'identifiey', 'operator', 'authentication', 'fee', 'web-net', 'web-str', 'web-reg', 'misc'. 418 423 </p> 424 <p> 425 Sourcetable records of type CAS contain the following data fields: 'host', 'port', 'identifier', 'operator', 'nmea', 'country', 'latitude', 'longitude', 'misc'. 426 </p> 419 427 420 428 <a name="rtcm"> … … 431 439 <p><h4>F - 2.1 RTCM Version 2.x</h4></p> 432 440 <p> 433 Transmitting GNSS carrier phase data can be done through RTCM Version 2.x messages. Message that may be of interest here are types 1, 2, 3, 6, 9, 16,18/19, 20/21, and 22.441 Transmitting GNSS carrier phase data can be done through RTCM Version 2.x messages. Messages that may be of interest here are types 1, 2, 3, 6, 9, 16,18/19, 20/21, and 22. 434 442 </p> 435 443 … … 467 475 </p> 468 476 <p> 469 RTCM Version 3 defines a number of message types. Among them are the following:477 RTCM Version 3 defines a number of message types. Messages that may be of interest here are: 470 478 </p> 471 479 <ul> … … 504 512 </p> 505 513 506 507 508
Note:
See TracChangeset
for help on using the changeset viewer.