Changeset 1192 in ntrip


Ignore:
Timestamp:
Nov 13, 2008, 3:57:52 PM (15 years ago)
Author:
weber
Message:

* empty log message *

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/BNC/bnchelp.html

    r1191 r1192  
    2121<h4>
    2222<a href=#purpose>1. Purpose</a><br>
    23 <a href=#resources>2. Resources</a><br>
     23<a href=#resources>2. Modes & Resources</a><br>
    2424<a href=#options>3. Options</a><br>
    2525<a href=#limits>4. Limitations</a><br>
     
    3838<li>generate ephemeris and synchronized observations epoch by epoch through an IP port to support real-time GNSS engines, and/or</li>
    3939<li>generate clock and orbit corrections to broadcast ephemeris through an IP port to support real-time Precise Point Positioning on GNSS rovers, and/or</li>
    40 <li>generate synchronized clock and orbit corrections to broadcast ephemeris epoch by epoch through an IP port to support the combination of such streams coming from various providers, and/or</li>
     40<li>generate synchronized clock and orbit corrections to broadcast ephemeris epoch by epoch through an IP port to support the combination of such streams as coming from various correction providers, and/or</li>
    4141<li>monitor the performance of a network of real-time GNSS reference stations to generate advisory notes, and/or</li>
    4242<li>check RTCM streams for incoming message types and their repetition rates.</li>
     
    5454BNC allows to by-pass its decoding and conversion algorithms, leave whatever is received untouched and save it in files.
    5555</p>
    56 <p><a name="resources"><h3>2. Modes and Resources</h3></p>
    57 <p>
    58 Although BNC is a real-time tool to be operated in online mode, it can be run offline for post processing of data made availabe from a file. Furthermore, besides its regular window mode, BNC can be started as a batch/background job in a 'no window' mode using processing options from previously saved configuration parameters.
     56<p><a name="resources"><h3>2. Modes & Resources</h3></p>
     57<p>
     58Although BNC is a real-time tool to be operated in online mode, it can be run offline for post processing of data made availabe from a file. Furthermore, apart from its regular window mode, BNC can be run as a batch/background job in a 'no window' mode using processing options from previously saved configuration.
    5959</p>
    6060<p>
     
    6969
    7070<p><a name="options"><h3>3. Options</h3></p>
     71<p>
     72All options for running BNC on Unix/Linux/Mac systems are saved in file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf, see annexed 'Configuration File' example. On Windows systems options are saved in register BKG_NTRIP_Client. The self-explaining contents of the configuration file or the Windows register can easily be edited.
     73</p>
    7174<p>
    72753.1. <a href=#file>File</a><br>
     
    1181213.12. <a href=#start>Start</a><br>
    1191223.13. <a href=#stop>Stop</a><br>
    120 3.14. <a href=#cmd>Command Line</a><br>
    121 &nbsp; &nbsp; &nbsp; 3.14.1. <a href=#nw>No Window</a><br>
    122 &nbsp; &nbsp; &nbsp; 3.14.2. <a href=#post>Offline</a><br>
     1233.14. <a href=#cmd>Command Line Options</a><br>
     124&nbsp; &nbsp; &nbsp; 3.14.1. <a href=#nw>No Window Mode</a><br>
     125&nbsp; &nbsp; &nbsp; 3.14.2. <a href=#post>Offline Mode</a><br>
    123126</p>
    124127
     
    132135Use smaller font size if the BNC main window exceeds the size of your screen.
    133136</li>
    134 <li> save selected options.<br>
    135 Note that on Windows systems options are saved in register BKG_NTRIP_Client. On Unix/Linux systems options are saved in file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf.
     137<li> save selected options in configuration file resp. Windows register.<br>
    136138</li>
    137139<li>
     
    185187</p>
    186188
    187 <p><a name="reconf"><h4>3.4.3 Reread Configuration - mandatory</h4></p>
    188 <p>
    189 When operating BNC in online mode, some configuration parameters can be changed on-the-fly without interrupting the running process. For that BNC rereads parts of its configuration (see section 'Config File') in pre-defined intervals. Configuration parameters that can be changed on-the-fly are
     189<p><a name="reconf"><h4>3.4.3 Reread Configuration - optional</h4></p>
     190<p>
     191When operating BNC online in window or 'no window' mode, some configuration options can be changed on-the-fly without interrupting the running process. Configuration options that can be changed on-the-fly are
    190192</p>
    191193<p>
    192194<ul>
    193195<li>'mountPoints' to change the selection of streams to be processed, see section 'Mountpoints',</li>
    194 <li>'waitTime' to change the 'Wait for full epoch' parameter, see section 'Synchronized Observations', and</li>
    195 <li>'binSample' to change the 'Sampling' parameter, see section 'Synchronized Observations'.</li>
     196<li>'waitTime' to change the 'Wait for full epoch' option, see section 'Synchronized Observations', and</li>
     197<li>'binSample' to change the 'Sampling' option, see section 'Synchronized Observations'.</li>
    196198</ul>
    197199</p>
    198200<p>
    199 Select '1 min', '1 hour', or '1 day' to let BNC reread the above mentioned configuration parameters every full minute, hour, or day and thus avoid usage of 'Start', 'Stop', or 'Quit' buttons.
     201<u>Window mode:</u> For changes while running BNC in window mode you interactively modify one of the above mentioned options and then hit 'Save Options'. Changes will immediately become effective without interrupting uninvolved threads.
     202</p>
     203<p>
     204<u>'No window' mode:</u> For changes while running BNC in 'no window' mode you force the program to rereads parts of its configuration in pre-defined intervals. Select '1 min', '1 hour', or '1 day' to let BNC reread the above mentioned configuration options every full minute, hour, or day. This avoids interrupting BNC through usage of 'Start', 'Stop', or 'Quit' buttons and lets probably edited configuration options become effective on-the-fly without interrupting uninvolved threads. See annexed section 'Configuration File' for a Unix/Linux/Mac configuration file example.
    200205</p>
    201206
     
    302307<p><a name="rnxscript"><h4>3.5.6 Script - optional</h4></p>
    303308<p>
    304 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).
     309Whenever 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/Mac systems).
    305310</p>
    306311<p>
     
    550555<p><a name="advscript"><h4>3.9.5 Advisory Script - optional </h4></p>
    551556<p>
    552 As mentioned previously, BNC can trigger a shell script or a batch file to be executed when one of the events described are reported. This script can be used to email an advisory note to network operator or stream providers. To enable this feature, specify the full path to the script or batch file in the 'Script' field. The affected mountpoint and type of event reported ('Begin_Outage', 'End_Outage', 'Begin_Corrupted' or 'End_Corrupted') will then be passed on to the script as command line parameters (%1 and %2 on Windows systems or $1 and $2 on Unix/Linux systems) together with date and time information.
     557As mentioned previously, BNC can trigger a shell script or a batch file to be executed when one of the events described are reported. This script can be used to email an advisory note to network operator or stream providers. To enable this feature, specify the full path to the script or batch file in the 'Script' field. The affected mountpoint and type of event reported ('Begin_Outage', 'End_Outage', 'Begin_Corrupted' or 'End_Corrupted') will then be passed on to the script as command line parameters (%1 and %2 on Windows systems or $1 and $2 on Unix/Linux/Mac systems) together with date and time information.
    553558</p>
    554559<p>
     
    561566FFMJ0 End_Outage 08-02-21 11:36:02 Begin was 08-02-21 09:25:59
    562567</pre>
    563 Sample script for Unix/Linux systems:
     568Sample script for Unix/Linux/Mac systems:
    564569<pre>
    565570#!/bin/bash
     
    696701</p>
    697702
    698 <p><a name="cmd"><h4>3.14. Command Line</h4></p>
     703<p><a name="cmd"><h4>3.14. Command Line Options</h4></p>
    699704<p>
    700 Command line options are available to run BNC in 'no window' mode or let it read data from a file in 'offline' mode.
    701 BNC will then use processing 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.
    702 </p>
    703 
    704 <p><a name="nw"><h4>3.14.1 No Window - optional</h4></p>
    705 <p>
    706 On all systems BNC can be started as a batch job with the command line option '-nw'. BNC will then run in 'no window' mode, using processing options from its configuration file. Terminate BNC using Windows Task Manager when running it in 'no window' mode on Windows systems.
     705Command line options are available to run BNC in 'no window' mode or let it read data from a file in offline mode. BNC will then use processing options from the configuration file (Unix/Linux/Mac) 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.
     706</p>
     707
     708<p><a name="nw"><h4>3.14.1 No Window Mode - optional</h4></p>
     709<p>
     710Apart 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. Terminate BNC using Windows Task Manager when running it in 'no window' mode on Windows systems.
    707711</p>
    708712<p>
     
    711715</p>
    712716
    713 <p><a name="post"><h4>3.14.2 Offline - optional</h4></p>
    714 <p>
    715 Although BNC is a real-time tool, it can be run in 'offline' mode to read data from a file for post processing purposes. Enter the following four command line options for that:
     717<p><a name="post"><h4>3.14.2 Offline Mode - optional</h4></p>
     718<p>
     719Although BNC is primarily a real-time online tool, it can be run in offline mode to read data from a file for post processing purposes. Enter the following four command line options for that:
    716720</p>
    717721<p>
     
    727731</p>
    728732<p>
    729 Note that it is necessary to define a date and time for the first epoch because RTCM streams do not contain complete time stamps as needed for RINEX. Note further that when running BNC in 'offline' mode, it will use options for file saving, interval, sampling etc. from its configuration file.
     733Note that it is necessary to define a date and time for the first epoch because RTCM streams do not contain complete time stamps as needed for RINEX. Note further that when running BNC in offline mode, it will use options for file saving, interval, sampling etc. from its configuration file.
    730734</p>
    731735
     
    764768</li>
    765769<li>
    766 Once BNC has been started, its configuration can not be changed as long as it is stopped. A reconfiguration on-the-fly is not implemented.
     770Once BNC has been started, many of its configuration options can not be changed as long as it is stopped. See chapter 'Reread Configuration' for on-the-fly configuration exceptions.
    767771</li>
    768772<br>
     
    8018058.3. <a href=#rtigs>RTIGS</a><br>
    802806&nbsp; &nbsp; &nbsp; 8.3.1 <a href=#soc>SOC</a><br>
    803 8.4. <a href=#config>Config File</a><br>
     8078.4. <a href=#config>Configuration File</a><br>
    8048088.5. <a href=#links>Links</a><br>
    805809</p>
     
    994998<p>
    995999</p>
    996 <p><a name="config"><h4>8.4. Config File</h4></p>
    997 <p>
    998 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 ACOR0 form www.euref-ip.net and FFMJ3 from www.igs-ip.net for the generation of 15 min RINEX files. RINEX files are uploaded to an archive using script 'up2archive' :
     1000<p><a name="config"><h4>8.4. Configuration File</h4></p>
     1001<p>
     1002The following is an example for the contents of a Unix/Linux/Mac configuration file ${HOME}/.config/BKG/BKG_NTRIP_Client.conf. It enables the retrieval of stream ACOR0 form www.euref-ip.net and FFMJ3 from www.igs-ip.net for the generation of 15 min RINEX files. RINEX files are uploaded to an archive using script 'up2archive' :
    9991003<pre>
    10001004[General]
     
    10361040</p>
    10371041<p>
    1038 Note that on Windows systems configuration parameters are saved in register BKG_NTRIP_Client.
     1042Note that on Windows systems configuration options are saved in register BKG_NTRIP_Client.
    10391043<p>
    10401044
Note: See TracChangeset for help on using the changeset viewer.