Changeset 10753 in ntrip for trunk/BNC/src/bnchelp.html
- Timestamp:
- Sep 2, 2025, 1:03:59 PM (6 weeks ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/BNC/src/bnchelp.html
r10694 r10753 247 247 2.16.3 <a href=#brdcsys>Satellite System </a><br> 248 248 2.16.4 <a href=#brdcsmpl>Sampling</a><br> 249 2.17 <a href=#streams><b>Streams Canvas</b></a><br> 250 2.17.1 <a href=#streamedit>Edit Streams</a><br> 251 2.17.2 <a href=#streamdelete>Delete Stream</a><br> 252 2.17.3 <a href=#streamconf>Reconfigure Stream Selection On-the-fly</a><br> 253 2.18 <a href=#logs><b>Logging Canvas</b></a><br> 254 2.18.1 <a href=#logfile>Log</a><br> 255 2.18.2 <a href=#throughput>Throughput</a><br> 256 2.18.3 <a href=#latency>Latency</a><br> 257 2.18.4 <a href=#ppptab>PPP Plot</a><br> 258 2.19 <a href=#bottom><b>Bottom Menu Bar</b></a><br> 259 2.19.1 <a href=#streamadd>Add Stream</a><br> 260 2.19.1.1 <a href=#streamcaster>Add Stream - Coming from Caster</a><br> 261 2.19.1.1.1 <a href=#streamhost>Caster Host and Port</a><br> 262 2.19.1.1.2 <a href=#streamtable>Casters Table</a><br> 263 2.19.1.1.3 <a href=#streamuser>User and Password</a><br> 264 2.19.1.1.4 <a href=#gettable>Get Table</a><br> 265 2.19.1.1.5 <a href=#ntripv>Ntrip Version</a><br> 266 2.19.1.1.6 <a href=#castermap>Map</a><br> 267 2.19.1.2 <a href=#streamip>Add Stream - Coming from TCP/IP Port</a><br> 268 2.19.1.3 <a href=#streamudp>Add Stream - Coming from UDP Port</a><br> 269 2.19.1.4 <a href=#streamser>Add Stream - Coming from Serial Port</a><br> 270 2.19.2 <a href=#streamsdelete>Delete Stream</a><br> 271 2.19.3 <a href=#streamsmap>Map</a><br> 272 2.19.4 <a href=#start>Start</a><br> 273 2.19.5 <a href=#stop>Stop</a><br> 274 2.19.6 <a href=#contexthelp>Help? = Shift+F1</a><br> 275 2.20 <a href=#cmd><b>Command Line Options</b></a><br> 276 2.20.1 <a href=#cmdVersion>Version</a><br> 277 2.20.2 <a href=#cmdDisplay>Display</a><br> 278 2.20.3 <a href=#nw>No Window Mode</a><br> 279 2.20.4 <a href=#post>File Mode</a><br> 280 2.20.5 <a href=#conffile>Configuration File</a><br> 281 2.20.6 <a href=#confopt>Configuration Options</a><br><br> 249 2.17 <a href=#upraw><b>Upload Raw Data - NtripServer Functionality</b></a><br> 250 2.17.1 <a href=#rawsourcemount>Source Mountpoint</a><br> 251 2.17.2 <a href=#rawserver>Host & Port</a><br> 252 2.17.3 <a href=#rawmount>Upload Mountpoint, Ntrip Version, User, Password</a><br> 253 2.18 <a href=#streams><b>Streams Canvas</b></a><br> 254 2.18.1 <a href=#streamedit>Edit Streams</a><br> 255 2.18.2 <a href=#streamdelete>Delete Stream</a><br> 256 2.18.3 <a href=#streamconf>Reconfigure Stream Selection On-the-fly</a><br> 257 2.19 <a href=#logs><b>Logging Canvas</b></a><br> 258 2.19.1 <a href=#logfile>Log</a><br> 259 2.19.2 <a href=#throughput>Throughput</a><br> 260 2.19.3 <a href=#latency>Latency</a><br> 261 2.19.4 <a href=#ppptab>PPP Plot</a><br> 262 2.20 <a href=#bottom><b>Bottom Menu Bar</b></a><br> 263 2.20.1 <a href=#streamadd>Add Stream</a><br> 264 2.20.1.1 <a href=#streamcaster>Add Stream - Coming from Caster</a><br> 265 2.20.1.1.1 <a href=#streamhost>Caster Host and Port</a><br> 266 2.20.1.1.2 <a href=#streamtable>Casters Table</a><br> 267 2.20.1.1.3 <a href=#streamuser>User and Password</a><br> 268 2.20.1.1.4 <a href=#gettable>Get Table</a><br> 269 2.20.1.1.5 <a href=#ntripv>Ntrip Version</a><br> 270 2.20.1.1.6 <a href=#castermap>Map</a><br> 271 2.20.1.2 <a href=#streamip>Add Stream - Coming from TCP/IP Port</a><br> 272 2.20.1.3 <a href=#streamudp>Add Stream - Coming from UDP Port</a><br> 273 2.20.1.4 <a href=#streamser>Add Stream - Coming from Serial Port</a><br> 274 2.20.2 <a href=#streamsdelete>Delete Stream</a><br> 275 2.20.3 <a href=#streamsmap>Map</a><br> 276 2.20.4 <a href=#start>Start</a><br> 277 2.20.5 <a href=#stop>Stop</a><br> 278 2.20.6 <a href=#contexthelp>Help? = Shift+F1</a><br> 279 2.21 <a href=#cmd><b>Command Line Options</b></a><br> 280 2.21.1 <a href=#cmdVersion>Version</a><br> 281 2.21.2 <a href=#cmdDisplay>Display</a><br> 282 2.21.3 <a href=#nw>No Window Mode</a><br> 283 2.21.4 <a href=#post>File Mode</a><br> 284 2.21.5 <a href=#conffile>Configuration File</a><br> 285 2.21.6 <a href=#confopt>Configuration Options</a><br><br> 282 286 <b>3.</b> <a href=#annex><b>Annex</b></a><br><br> 283 287 3.1 <a href=#rtcm>RTCM Standards</a><br> … … 1089 1093 </li> 1090 1094 1095 <li>Configuration File 'UploadRaw.bnc'<br> 1096 Purpose: Forward the stream contents of the incoming stream BCEP00BKG0 1097 from products.igs-ip.net to another caster. 1098 </li> 1099 1091 1100 <li>Configuration File 'CompareSp3.bnc'<br> 1092 1101 Purpose: Compare two SP3 files to calculate RMS values for orbit and clock … … 1107 1116 'Example_Configs' to be the current working directory. 1108 1117 1109 <ol start="2 2">1118 <ol start="23"> 1110 1119 <li>Shell Script 'RinexQC.sh'<br> 1111 1120 Purpose: Equals configuration file example 'RinexQC.bnc', checks the quality of … … 1153 1162 For specific applications you may like to use your own set of standard configuration options from a configuration file and update some of its content via command line. When using a configuration file together with command line configuration options in one BNC call, the command line configuration options will always overrule options contained in the configuration file. 1154 1163 1155 <ol start="2 7">1164 <ol start="28"> 1156 1165 <li>Shell Script 'CompareSp3.sh'<br> 1157 1166 Purpose: Equals configuration file example 'CompareSp3.bnc', compares two SP3 … … 5563 5572 <p>Figure 32: BNC producing Broadcast Ephemeris streams from globally distributed RTCM streams; upload in RTCM format to an Ntrip Broadcaster</p> 5564 5573 5565 <p><h4 id="streams">2.17 Streams Canvas</h4></p> 5574 <p><h4 id="upraw">2.17 Upload Raw Data - NtripServer Functionality</h4></p> 5575 <p> 5576 BNC can upload Raw Data streams in any format like a NtripServer. To fill the 'Upload Raw Data' table, hit the 'Add Row' button. 5577 </p> 5578 <p><h4 id="rawsourcemount">2.17.1 Source Mountpoint</h4></p> 5579 <p> 5580 Within the 'Source Mountpoint' field please specify the Source of data from the 'Streams' section below, which shall be forwarded without decoding. 5581 If the decoder string is not an accepted one ('RTCM_2.x', 'RTCM_3.x' and 'RTNET'), please change the decoder string to 5582 <ul> 5583 <li> 'ZERO' (forward the raw data) or </li> 5584 <li> 'ZERO2FILE' (forward and store the raw data)</li> 5585 </ul> in addition. 5586 </p> 5587 <p><h4 id="rawserver">2.17.2 Host & Port - optional</h4></p> 5588 <p> 5589 Specify the 'Host' IP number or URL of an Ntrip Broadcaster to upload the stream. An empty option field means that you 5590 do not want to upload Broadcast Ephemeris. 5591 </p> 5592 <p> 5593 Enter the Ntrip Broadcaster's IP 'Port' number for stream upload. Note that Ntrip Broadcasters are often configured to provide 5594 access through more than one port, usually ports 80 and 2101. If you experience communication problems on port 80, you should 5595 try to use the alternative port(s). 5596 </p> 5597 5598 <p><h4 id="rawmount">2.17.3 Mountpoint, Ntrip Version, User, Password - mandatory if 'Host' is set</h4></p> 5599 <p> 5600 BNC uploads a stream to the Ntrip Broadcaster by referring it to a dedicated mountpoint that has been set by its operator. 5601 Specify the mountpoint based on the details you received for your stream from the operator. It is often a 9-character ID (capital letters) 5602 plus an integer number. 5603 </p> 5604 <p> 5605 For stream upload the Ntrip Version can be chosen. An Ntrip version 1 upload is protected through an upload 'Password' only. 5606 For an Ntrip Version 2 upload an upload 'User' is required in addition. Enter the user name and the password you received 5607 from the Ntrip Broadcaster operator along with the mountpoint. 5608 </p> 5609 5610 <p><h4 id="streams">2.18 Streams Canvas</h4></p> 5566 5611 <p> 5567 5612 Each stream on an Ntrip Broadcaster (and consequently on BNC) is defined using a unique source ID called mountpoint. An Ntrip Client like BNC … … 5587 5632 </table> 5588 5633 </p> 5589 <p><h4 id="streamedit">2.1 7.1 Edit Streams</h4></p>5634 <p><h4 id="streamedit">2.18.1 Edit Streams</h4></p> 5590 5635 <ul> 5591 5636 <li>BNC automatically allocates one of its internal decoders to a stream based on the stream's 'format' and 'format-details' as given in the source-table. … … 5614 5659 </ul> 5615 5660 5616 <p><h4 id="streamdelete">2.1 7.2 Delete Stream</h4></p>5661 <p><h4 id="streamdelete">2.18.2 Delete Stream</h4></p> 5617 5662 <p> 5618 5663 To remove a stream from the 'Streams' canvas in the main window, highlight it by clicking on it and hit the 'Delete Stream' button. … … 5620 5665 </p> 5621 5666 5622 <p><h4 id="streamconf">2.1 7.3 Reconfigure Stream Selection On-the-fly</h4></p>5667 <p><h4 id="streamconf">2.18.3 Reconfigure Stream Selection On-the-fly</h4></p> 5623 5668 <p> 5624 5669 The streams selection can be changed on-the-fly without interrupting uninvolved threads in the running BNC process. … … 5636 5681 </p> 5637 5682 5638 <p><h4 id="logs">2.1 8Logging Canvas</h4></p>5683 <p><h4 id="logs">2.19 Logging Canvas</h4></p> 5639 5684 <p> 5640 5685 The 'Logging Canvas' above the bottom menu bar on the main window labeled 'Log', 'Throughput', 'Latency', and 'PPP Plot' … … 5643 5688 </p> 5644 5689 5645 <p><h4 id="logfile">2.1 8.1 Log</h4></p>5690 <p><h4 id="logfile">2.19.1 Log</h4></p> 5646 5691 <p> 5647 5692 Records of BNC's activities are shown in the 'Log' tab. They can be saved into a file when a valid path is specified in the 'Logfile (full path)' field. 5648 5693 </p> 5649 5694 5650 <p><h4 id="throughput">2.1 8.2 Throughput</h4></p>5695 <p><h4 id="throughput">2.19.2 Throughput</h4></p> 5651 5696 <p> 5652 5697 The bandwidth consumption per stream is shown in the 'Throughput' tab in bits per second (bps) or kilobits per second (kbps). … … 5655 5700 <p><img src="IMG/Figure33.png"width=1000/></p> 5656 5701 <p>Figure 33: Bandwidth consumption of RTCM streams received by BNC</p> 5657 <p><h4 id="latency">2.1 8.3 Latency</h4></p>5702 <p><h4 id="latency">2.19.3 Latency</h4></p> 5658 5703 <p> 5659 5704 The latency of observations in each incoming stream is shown in the 'Latency' tab in milliseconds or seconds. … … 5666 5711 <p>Figure 34: Latency of RTCM streams received by BNC</p> 5667 5712 5668 <p><h4 id="ppptab">2.1 8.4 PPP Plot</h4></p>5713 <p><h4 id="ppptab">2.19.4 PPP Plot</h4></p> 5669 5714 <p> 5670 5715 Precise Point Positioning time series of North (red), East (green) and Up (blue) coordinate components are shown in the 'PPP Plot' tab when … … 5677 5722 <p>Figure 35: Example for time series plot of displacements produced by BNC</p> 5678 5723 5679 <p><h4 id="bottom">2. 19Bottom Menu Bar</h4></p>5724 <p><h4 id="bottom">2.20 Bottom Menu Bar</h4></p> 5680 5725 <p> 5681 5726 The bottom menu bar allows to add or delete streams to or from BNC's configuration and to start or stop it. … … 5686 5731 <p>Figure 36: Steam input communication links accepted by BNC</p> 5687 5732 5688 <p><h4 id="streamadd">2. 19.1 Add Stream</h4></p>5733 <p><h4 id="streamadd">2.20.1 Add Stream</h4></p> 5689 5734 <p> 5690 5735 Button 'Add Stream' allows you to pull streams either from an Ntrip Broadcaster or from a TCP/IP port, UPD port, or serial port. 5691 5736 </p> 5692 5737 5693 <p><h4 id="streamcaster">2. 19.1.1 Add Stream - Coming from Caster</h4></p>5738 <p><h4 id="streamcaster">2.20.1.1 Add Stream - Coming from Caster</h4></p> 5694 5739 <p> 5695 5740 Button 'Add Stream' > 'Coming from Caster' opens a window that allows users to select data streams from an Ntrip Broadcaster according … … 5697 5742 </p> 5698 5743 5699 <p><h4 id="streamhost">2. 19.1.1.1 Caster Host and Port - mandatory</h4></p>5744 <p><h4 id="streamhost">2.20.1.1.1 Caster Host and Port - mandatory</h4></p> 5700 5745 <p> 5701 5746 Enter the Ntrip Broadcaster host IP and port number. Note that EUREF and IGS operate Ntrip Broadcasters … … 5705 5750 </p> 5706 5751 5707 <p><h4 id="streamtable">2. 19.1.1.2 Casters Table - optional</h4></p>5752 <p><h4 id="streamtable">2.20.1.1.2 Casters Table - optional</h4></p> 5708 5753 <p> 5709 5754 It may be that you are not sure about your Ntrip Broadcaster's host and port number or you are interested in other … … 5715 5760 <p>Figure 37: BNC's 'Select Broadcaster' table</p> 5716 5761 5717 <p><h4 id="streamuser">2. 19.1.1.3 User and Password - mandatory for protected streams</h4></p>5762 <p><h4 id="streamuser">2.20.1.1.3 User and Password - mandatory for protected streams</h4></p> 5718 5763 <p> 5719 5764 Streams on Ntrip Broadcasters may be protected. Enter a valid 'User' ID and 'Password' for access to protected streams. … … 5723 5768 </p> 5724 5769 5725 <p><h4 id="gettable">2. 19.1.1.4 Get Table</h4></p>5770 <p><h4 id="gettable">2.20.1.1.4 Get Table</h4></p> 5726 5771 <p> 5727 5772 Use the 'Get Table' button to download the source-table from the Ntrip Broadcaster. Pay attention to data fields 'format' and 'format-details'. … … 5761 5806 <p>Figure 38: Broadcaster source-table shown by BNC</p> 5762 5807 5763 <p><h4 id="ntripv">2. 19.1.1.5 Ntrip Version - mandatory</h4></p>5808 <p><h4 id="ntripv">2.20.1.1.5 Ntrip Version - mandatory</h4></p> 5764 5809 <p> 5765 5810 Some limitations and deficiencies of the Ntrip Version 1 stream transport protocol are solved in Ntrip Version 2. … … 5790 5835 a mobile Internet Service Provider may not support it. 5791 5836 </p> 5792 <p><h4 id="castermap">2. 19.1.1.6 Map - optional</h4></p>5837 <p><h4 id="castermap">2.20.1.1.6 Map - optional</h4></p> 5793 5838 <p> 5794 5839 Button 'Map' opens a window to show a distribution map of the caster's streams. You may like to zoom in or out using the mouse. … … 5798 5843 <p>Figure 39: Stream distribution map shown by BNC as derived from Ntrip Broadcaster source-table</p> 5799 5844 5800 <p><h4 id="streamip">2. 19.1.2 Add Stream - Coming from TCP/IP Port</h4></p>5845 <p><h4 id="streamip">2.20.1.2 Add Stream - Coming from TCP/IP Port</h4></p> 5801 5846 <p> 5802 5847 Button 'Add Stream' > 'Coming from TCP/IP Port' allows to retrieve streams via TCP directly from an IP address … … 5818 5863 Note that this option works only if no proxy server is involved in the communication link. 5819 5864 </p> 5820 <p><h4 id="streamudp">2. 19.1.3 Add Stream - Coming from UDP Port</h4></p>5865 <p><h4 id="streamudp">2.20.1.3 Add Stream - Coming from UDP Port</h4></p> 5821 5866 <p> 5822 5867 Button 'Add Stream' > 'Coming from UDP Port' allows to pick up streams arriving directly at one of the local host's UDP ports without using the Ntrip transport protocol. For that you: … … 5833 5878 <p> 5834 5879 5835 <p><h4 id="streamser">2. 19.1.4 Add Stream - Coming from Serial Port</h4></p>5880 <p><h4 id="streamser">2.20.1.4 Add Stream - Coming from Serial Port</h4></p> 5836 5881 <p> 5837 5882 Button 'Add Stream' > 'Coming from Serial Port' allows to retrieve streams from a GNSS receiver via serial port without using the Ntrip transport protocol. For that you: … … 5872 5917 <p>Figure 40: BNC configuration for pulling a stream via serial port</p> 5873 5918 5874 <p><h4 id="streamsdelete">2. 19.2 Delete Stream</h4></p>5919 <p><h4 id="streamsdelete">2.20.2 Delete Stream</h4></p> 5875 5920 <p> 5876 5921 Button 'Delete Stream' allows you to delete streams previously selected for retrieval as listed under the 'Streams' canvas on BNC's main window. 5877 5922 </p> 5878 5923 5879 <p><h4 id="streamsmap">2. 19.3 Map</h4></p>5924 <p><h4 id="streamsmap">2.20.3 Map</h4></p> 5880 5925 <p> 5881 5926 Button 'Map' opens a window to show a distribution map of the streams selected for retrieval as listed under the 'Streams' canvas. … … 5883 5928 </p> 5884 5929 5885 <p><h4 id="start">2. 19.4 Start</h4></p>5930 <p><h4 id="start">2.20.4 Start</h4></p> 5886 5931 <p> 5887 5932 Hit 'Start' to start retrieving, decoding or converting GNSS data streams in real-time. … … 5890 5935 </p> 5891 5936 5892 <p><h4 id="stop">2. 19.5 Stop</h4></p>5937 <p><h4 id="stop">2.20.5 Stop</h4></p> 5893 5938 <p> 5894 5939 Hit the 'Stop' button in order to stop BNC. 5895 5940 </p> 5896 5941 5897 <p><h4 id="contexthelp">2. 19.6 Help? = Shift+F1</h4></p>5942 <p><h4 id="contexthelp">2.20.6 Help? = Shift+F1</h4></p> 5898 5943 <p> 5899 5944 BNC comes with a <i>What's This</i> help system providing information about its functionality and usage. … … 5902 5947 The dialogs on some operating systems may provide a '?' button that users can click; click the relevant widget to pop up the help text. 5903 5948 </p> 5904 <p><h4 id="cmd">2.2 0Command Line Options</h4></p>5949 <p><h4 id="cmd">2.21 Command Line Options</h4></p> 5905 5950 <p> 5906 5951 Command line options are available to run BNC in 'no window' mode or let it read previously recorded input offline from one or … … 5919 5964 provides a list of all available command line options. 5920 5965 </p> 5921 <p><h4 id="cmdVersion">2.2 0.1 Version - optional</h4></p>5966 <p><h4 id="cmdVersion">2.21.1 Version - optional</h4></p> 5922 5967 <p> 5923 5968 Command line option '--version' lets BNC print its version number. … … 5927 5972 bnc --version (MS Windows: bnc.exe --version | more) 5928 5973 </p> 5929 <p><h4 id="cmdDisplay">2.2 0.2 Display - optional</h4></p>5974 <p><h4 id="cmdDisplay">2.21.2 Display - optional</h4></p> 5930 5975 <p> 5931 5976 On systems which support graphics, command line option '--display' forces BNC to present the BNC window on the specified display. … … 5935 5980 bnc.exe --display localhost:10.0 5936 5981 </p> 5937 <p><h4 id="nw">2.2 0.3 No Window Mode - optional</h4></p>5982 <p><h4 id="nw">2.21.3 No Window Mode - optional</h4></p> 5938 5983 <p> 5939 5984 Apart from its regular windows mode, BNC can be started on all systems as a batch job with command line option '-nw'. … … 5970 6015 </p></pre> 5971 6016 5972 <p><h4 id="post">2.2 0.4 File Mode - optional</h4></p>6017 <p><h4 id="post">2.21.4 File Mode - optional</h4></p> 5973 6018 <p> 5974 6019 Although BNC is primarily a real-time online tool, for debugging purposes it can be run offline to read data from a file … … 5986 6031 <p>Note further that option '--file' forces BNC to apply the '-nw' option for running in 'no window' mode. 5987 6032 </p> 5988 <p><h4 id="conffile">2.2 0.5 Configuration File - optional</h4></p>6033 <p><h4 id="conffile">2.21.5 Configuration File - optional</h4></p> 5989 6034 The default configuration filename is 'BNC.bnc'. You may change this name at startup time using command line option '--conf <<u>confFileName</u>>'. This allows running several BNC jobs in parallel on the same host using different sets of configuration options. <u>confFileName</u> stands either for the full path to a configuration file or just for a filename. If you introduce only a filename, the corresponding file will be saved in the current working directory from where BNC is started. 5990 6035 </p> … … 5996 6041 This leads to a BNC job using configuration file 'MyConfig.bnc'. The configuration file will be saved in the current working directory. 5997 6042 </p> 5998 <p><h4 id="confopt">2.2 0.6 Configuration Options - optional</h4></p>6043 <p><h4 id="confopt">2.21.6 Configuration Options - optional</h4></p> 5999 6044 <p> 6000 6045 BNC applies options from the configuration file but allows updating every one of them on the command line while the content of the configuration file remains unchanged. Note the following syntax for Command Line Interface (CLI) options: … … 6496 6541 6497 6542 Upload Ephemeris Panel keys: 6498 uploadEphMountpointsOut {Upload corrections table [character string, semicolon separated list, each element in quotation marks, example:6543 uploadEphMountpointsOut {Upload ephemeris table [character string, semicolon separated list, each element in quotation marks, example: 6499 6544 "products.igs-ip.net,443,BCEP00BKG0,2s,usr,pass,ALL;products.igs-ip.net,443,BCEP01BKG0,2s,usr,pass,G"]} 6500 6545 uploadSamplRtcmEph {Stream upload sampling rate [integer number of seconds: 0|5|10|15|20|25|30|35|40|45|50|55|60]} 6546 6547 Upload Raw Data Panel keys: 6548 uploadRawMountpointsOut {Upload raw data table [character string, semicolon separated list, each element in quotation marks, example: 6549 "TCP00DEU0,products.igs-ip.net,443,SSRA00BKG0,2s,usr,pass;TCP01DEU0,products.igs-ip.net,443,SSRA01BKG0,2s,usr,pass"]} 6501 6550 6502 6551 Add Stream keys:
Note:
See TracChangeset
for help on using the changeset viewer.