Changeset 680 in ntrip


Ignore:
Timestamp:
Feb 13, 2008, 11:25:56 AM (16 years ago)
Author:
weber
Message:

* empty log message *

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/BNC/bnchelp.html

    r678 r680  
    59593.2. <a href=#help>Help</a><br>
    60603.3. <a href=#proxy>Proxy</a><br>
    61 3.4. <a href=#output>Synchronized Output</a><br>
    62 &nbsp; &nbsp; &nbsp; 3.4.1. <a href=#wait>Wait for Full Epoch</a><br>
    63 &nbsp; &nbsp; &nbsp; 3.4.2. <a href=#ascii>ASCII Output File</a><br>
    64 &nbsp; &nbsp; &nbsp; 3.4.3. <a href=#obsbin>Port for Binary Observation Output</a><br>
    65 &nbsp; &nbsp; &nbsp; 3.4.4. <a href=#ephascii>Port for ASCII Ephemeris Output</a><br>
    66 3.5. <a href=#rinex>RINEX</a><br>
    67 &nbsp; &nbsp; &nbsp; 3.5.1. <a href=#rnxname>RINEX File Names</a><br>
    68 &nbsp; &nbsp; &nbsp; 3.5.2. <a href=#rnxpath>RINEX Directory</a><br>
    69 &nbsp; &nbsp; &nbsp; 3.5.3. <a href=#rnxversion>RINEX Version</a><br>
    70 &nbsp; &nbsp; &nbsp; 3.5.4. <a href=#rnxscript>RINEX Script</a><br>
    71 &nbsp; &nbsp; &nbsp; 3.5.5. <a href=#rnxinterval>RINEX File Interval</a><br>
    72 &nbsp; &nbsp; &nbsp; 3.5.6. <a href=#rnxsample>RINEX Sampling</a><br>
    73 &nbsp; &nbsp; &nbsp; 3.5.7. <a href=#rnxskeleton>RINEX Skeleton Extension</a><br>
    74 &nbsp; &nbsp; &nbsp; 3.5.8. <a href=#rnxappend>Append Files</a><br>
    75 3.6. <a href=#mountpoints>Ephemeris</a><br>
    76 &nbsp; &nbsp; &nbsp; 3.6.1. <a href=#ephpath>Ephemeris Directory</a><br>
    77 &nbsp; &nbsp; &nbsp; 3.6.2. <a href=#ephvers>RINEX Version</a><br>
    78 &nbsp; &nbsp; &nbsp; 3.6.3. <a href=#ephinterval>Ephemeris File Interval</a><br>
    79 3.7. <a href=#thresholds>Advisory Note</a><br>
    80 &nbsp; &nbsp; &nbsp; 3.7.1. <a href=#inspectSegm>Inspect Segment</a><br>
    81 &nbsp; &nbsp; &nbsp; 3.7.2. <a href=#threshFail>Failure Threshold</a><br>
    82 &nbsp; &nbsp; &nbsp; 3.7.3. <a href=#threshReco>Recovery Threshold</a><br>
    83 &nbsp; &nbsp; &nbsp; 3.7.4. <a href=#noteScript>Advisory Script</a><br>
    84 3.8. <a href=#mountpoints>Mountpoints</a><br>
    85 &nbsp; &nbsp; &nbsp; 3.8.1. <a href=#AddMounts>Add Mountpoints</a><br>
    86 &nbsp; &nbsp; &nbsp; 3.8.2. <a href=#HostPort>Broadcaster Host and Port</a><br>
    87 &nbsp; &nbsp; &nbsp; 3.8.3. <a href=#account>Broadcaster User and Password</a><br>
    88 &nbsp; &nbsp; &nbsp; 3.8.4. <a href=#GetTable>Get Table</a><br>
    89 &nbsp; &nbsp; &nbsp; 3.8.5. <a href=#delete>Delete Mountpoints</a><br>
    90 &nbsp; &nbsp; &nbsp; 3.8.6. <a href=#edit>Edit Mountpoints</a><br>
    91 3.9. <a href=#log>Log</a><br>
     613.4. <a href=#general>General</a><br>
     62&nbsp; &nbsp; &nbsp; 3.4.1. <a href=#genlog>Logfile</a><br>
     63&nbsp; &nbsp; &nbsp; 3.4.2. <a href=#genapp>Append Files</a><br>
     643.5. <a href=#rinex>RINEX - Observations</a><br>
     65&nbsp; &nbsp; &nbsp; 3.5.1. <a href=#rnxname>File Names</a><br>
     66&nbsp; &nbsp; &nbsp; 3.5.2. <a href=#rnxdir>Directory</a><br>
     67&nbsp; &nbsp; &nbsp; 3.5.3. <a href=#rnxinterval>File Interval</a><br>
     68&nbsp; &nbsp; &nbsp; 3.5.4. <a href=#rnxsample>Sampling</a><br>
     69&nbsp; &nbsp; &nbsp; 3.5.5. <a href=#rnxskl>Skeleton Extension</a><br>
     70&nbsp; &nbsp; &nbsp; 3.5.6. <a href=#rnxscript>Script</a><br>
     71&nbsp; &nbsp; &nbsp; 3.5.7. <a href=#rnxvers>Version</a><br>
     723.6. <a href=#ephemeris>RINEX - Ephemeris</a><br>
     73&nbsp; &nbsp; &nbsp; 3.6.3. <a href=#ephdir>Directory</a><br>
     74&nbsp; &nbsp; &nbsp; 3.6.1. <a href=#ephint>File Interval</a><br>
     75&nbsp; &nbsp; &nbsp; 3.6.2. <a href=#ephport>Output Port</a><br>
     76&nbsp; &nbsp; &nbsp; 3.6.4. <a href=#ephvers>Version</a><br>
     773.7. <a href=#syncout>Synchronized Observations</a><br>
     78&nbsp; &nbsp; &nbsp; 3.7.1. <a href=#syncport>Output Port</a><br>
     79&nbsp; &nbsp; &nbsp; 3.7.2. <a href=#syncwait>Wait for Full Epoch</a><br>
     80&nbsp; &nbsp; &nbsp; 3.7.3. <a href=#syncfile>Output File</a><br>
     813.8. <a href=#advnote>Advisory Notice</a><br>
     82&nbsp; &nbsp; &nbsp; 3.8.1. <a href=#advsegm>Inspect Segment</a><br>
     83&nbsp; &nbsp; &nbsp; 3.8.2. <a href=#advfail>Failure Threshold</a><br>
     84&nbsp; &nbsp; &nbsp; 3.8.3. <a href=#advreco>Recovery Threshold</a><br>
     85&nbsp; &nbsp; &nbsp; 3.8.4. <a href=#advscript>Advisory Script</a><br>
     863.9. <a href=#mountpoints>Mountpoints</a><br>
     87&nbsp; &nbsp; &nbsp; 3.9.1. <a href=#mountadd>Add Mountpoints</a><br>
     88&nbsp; &nbsp; &nbsp; 3.9.2. <a href=#mounthost>Broadcaster Host and Port</a><br>
     89&nbsp; &nbsp; &nbsp; 3.9.3. <a href=#mountuser>Broadcaster User and Password</a><br>
     90&nbsp; &nbsp; &nbsp; 3.9.4. <a href=#mounttable>Get Table</a><br>
     91&nbsp; &nbsp; &nbsp; 3.9.5. <a href=#mountdelete>Delete Mountpoints</a><br>
     92&nbsp; &nbsp; &nbsp; 3.9.6. <a href=#mountedit>Edit Mountpoints</a><br>
    92933.10. <a href=#start>Start</a><br>
    93943.11. <a href=#stop>Stop</a><br>
    … …  
    139140Note 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.
    140141</p>
    141 
    142 <p><a name="output"><h4>3.4. Synchronized Output</h4></p>
     142<p><a name="general"><h4>3.4. General</h4></p>
     143
     144<p><a name="genlog"><h4>3.4.1 Logfile - optional</h4></p>
     145<p>
     146Records of BNC's activities are shown in the Log section on the bottom of the main window. 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.
     147</p>
     148
     149<p><a name="genapp"><h4>3.4.2 Append Files</h4></p>
     150<p>
     151When BNC is started, new files are created by default and any existing files with the same name will be overwritten. However, users might want to append existing 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' affects all types of files created by BNC.
     152</p>
     153
     154<p><a name="rinex"><h4>3.5. RINEX - Observations</h4></p>
     155<p>
     156Observations 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.
     157</p>
     158
     159<p><a name="rnxname"><h4>3.5.1 RINEX File Names</h4></p>
     160<p>
     161RINEX 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</p>
     162<p>
     163FRAN{ddd}{h}.{yy}O<br>
     164WETT{ddd}{h}.{yy}O
     165</p>
     166<p>
     167where 'ddd' is the day of year, 'h' is a letter which corresponds to an hour long UTC time block and 'yy' is the year.
     168</p>
     169<p>
     170If 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</p>
     171<p>
     172FRAN{ddd}{h}_KFURT.{yy}O<br>
     173FRAN{ddd}{h}_CE.{yy}O.
     174</p>
     175<p>
     176If several streams show exactly the same mountpoint name (example: BRUS0 from <u>www.euref-ip.net</u> and BRUS0 from <u>www.igs-ip.net</u>), BNC adds an integer number to the file name leading i.e. to hourly RINEX Observation files like</p>
     177<p>
     178BRUS{ddd}{h}_0.{yy}O<br>
     179BRUS{ddd}{h}_1.{yy}O.
     180</p>
     181<p>
     182Note that RINEX file names for all intervals less than 1 hour follow the file name convention for 15 minutes RINEX Observation files i.e.</p>
     183<p>
     184FRAN{ddd}{h}{mm}.{yy}O
     185</p>
     186<p>
     187where 'mm' is the starting minute within the hour.
     188</p>
     189
     190<p><a name="rnxdir"><h4>3.5.2 Directory - optional</h4></p>
     191<p>
     192Here 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 'Directory' is an empty option field, meaning that no RINEX Observation files will be written.
     193</p>
     194
     195<p><a name="rnxinterval"><h4>3.5.3 File Interval - mandatory if 'Directory' is set</h4></p>
     196<p>
     197Select the length of the RINEX Observation file generated. The default value is 15 minutes.
     198</p>
     199
     200<p><a name="rnxsample"><h4>3.5.4 Sampling - mandatory if 'Directory' is set </h4></p>
     201<p>
     202Select 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.
     203</p>
     204
     205<p><a name="rnxskl"><h4>3.5.5 Skeleton Extension - optional</h4></p>
     206<p>
     207Whenever 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 <u>http://www.epncb.oma.be:80/stations/log/skl/brus.skl</u> for an example of a public RINEX header skeleton file for the Brussels EPN station.
     208</p>
     209<p>
     210However, 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 'Skeleton' is interpreted by BNC as a personal RINEX header skeleton file for the corresponding stream.
     211</p>
     212<p>
     213Examples for personal skeleton file name convention: RINEX Observation files for mountpoints WETTZELL, FRANKFURT and FRANCE (same 4Char Station ID), BRUS0 from <u>www.euref-ip.net</u> and BRUS0 from <u>www.igs-ip.net</u> (same 4Char Station ID, identical mountpoint stings) would accept personal skeleton files named</p>
     214<p>
     215WETT.skl<br>
     216FRAN_KFURT.skl<br>
     217FRAN_CE.skl<br>
     218BRUS_0.skl<br>
     219BRUS_1.skl</p>
     220<p>
     221if RINEX 'Skeleton' extension is set to 'skl'.
     222</p>
     223<p>
     224Note the following regulations regarding personal RINEX header skeleton files:
     225<ul>
     226<li>If such a file exists in the 'RINEX directory', the corresponding public RINEX header skeleton file is ignored. The RINEX header is generated solely from the contents of the personal skeleton.</li>
     227<li>Personal skeletons should contain a complete first header record of type</li>
     228<br>- &nbsp; RINEX VERSION / TYPE
     229<li>They should then contain an empty header record of type</li>
     230<br>- &nbsp; PGM / RUN BY / DATE
     231<br>BNC will complete this line and include it in the actual RINEX file header.
     232<li>They should further contain complete header records of type</li>
     233<br>- &nbsp; MARKER NAME
     234<br>- &nbsp; OBSERVER / AGENCY
     235<br>- &nbsp; REC # / TYPE / VERS
     236<br>- &nbsp; ANT # / TYPE
     237<br>- &nbsp; APPROX POSITION XYZ
     238<br>- &nbsp; ANTENNA: DELTA H/E/N
     239<br>- &nbsp; WAVELENGTH FACT L1/2
     240<li>They may contain any other optional complete header record as defined in the RINEX documentation.</li>
     241<li>They should then contain empty header records of type</li>
     242<br>- &nbsp; # / TYPES OF OBSERV
     243<br>- &nbsp; TIME OF FIRST OBS
     244<br>BNC will include these lines in the final RINEX file header together with an additional
     245<br>- &nbsp; COMMENT
     246<br>line describing the source of the stream.
     247<li>They should finally contain an empty header record of type</li>
     248<br>- &nbsp; END OF HEADER (last record)
     249</ul>
     250<p>
     251If neither a public nor a personal RINEX header skeleton file is available for BNC, a default header will be used.
     252</p>
     253
     254<p><a name="rnxscript"><h4>3.5.6 Script - optional</h4></p>
     255<p>
     256Whenever 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).
     257</p>
     258<p>
     259The 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.
     260</p>
     261<p>
     262As 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'.
     263</p>
     264
     265<p><a name="rnxvers"><h4>3.5.7 Version - optional</h4></p>
     266<p>
     267The default format for RINEX Observation files is RINEX Version 2.11. Select 'Version 3' if you would like to save observations in RINEX Version 3 format.
     268</p>
     269
     270<p><a name="ephemeris"><h4>3.6. Ephemeris</h4></p>
     271<p>
     272Broadcast ephemeris can be saved as RINEX Navigation files when received via RTCM Version 3.x as message types 1019 (GPS) and 1020 (GLONASS) or via RTIGS records type 300. The file name convention follows the details given in section 'RINEX File Names' except that the first four characters are 'BRDC' and the last character is
     273</p>
     274<ul>
     275<li>'N' or 'G' for GPS or GLONASS ephemeris in two separate RINEX Version 2.11 Navigation files, or</li>
     276<li>'P' for GPS plus GLONASS ephemeris saved together in one RINEX Version 3 Navigation file.
     277</ul>
     278
     279<p><a name="ephdir"><h4>3.6.1 Directory - optional</h4></p>
     280<p>
     281Specify 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.
     282</p>
     283
     284<p><a name="ephint"><h4>3.6.2 Interval - mandatory if Ephemeris 'Directory' is set</h4></p>
     285<p>
     286Select the length of the RINEX Navigation file generated. The default value is 1 day.
     287</p>
     288
     289<p><a name="ephport"><h4>3.6.3 Output Port - optional</h4></p>
     290<p>
     291BNC can output broadcast ephemeris in RINEX ASCII format on your local host (IP 127.0.0.1) through an IP port. Specify an IP port number to activate this function. The default is an empty option field, meaning that no ASCII ephemeris output via IP port is generated.
     292</p>
     293<p>
     294The source code for BNC comes with an example perl script called 'test_bnc_eph.pl' that allows you to read BNC's ASCII ephemeris output from the IP port.
     295</p>
     296
     297<p><a name="ephvers"><h4>3.6.4 Version - optional</h4></p>
     298<p>
     299Default format for RINEX Navigation files containing broadcast ephemeris is RINEX Version 2.11. Select 'Version 3' if you want to save the ephemeris in RINEX Version 3 format.
     300</p>
     301
     302<p><a name="syncout"><h4>3.7. Synchronized Observations</h4></p>
    143303<p>
    144304BNC 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:</p>
    … …  
    149309Note 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'.
    150310</p>
    151 <p><a name="wait"><h4>3.4.1 Wait for Full Epoch - optional</h4></p>
    152 <p>
    153 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.
    154 </p>
    155 <p>
    156 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.
    157 </p>
    158 
    159 <p><a name="ascii"><h4>3.4.2 ASCII Output File - optional</h4></p>
    160 <p>
    161 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.
    162 </p>
    163 <p>
    164 Beware that the size of this file can rapidly increase depending on the number of incoming streams. This option is primarily meant for testing and evaluation.
    165 </p>
    166 
    167 <p><a name="obsbin"><h4>3.4.3 Port for Binary Observation Output - optional</h4></p>
     311
     312<p><a name="syncport"><h4>3.7.1 Output Port - optional</h4></p>
    168313<p>
    169314BNC 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.</p>
    … …  
    207352} ;
    208353</pre>
    209 <p>The source code for BNC comes with an example program called 'test_bnc_qt.cpp' that allows you to read BNC's binary observation output from the IP port.</p>
    210 
    211 <p><a name="ephascii"><h4>3.4.4 Port for ASCII Ephemeris Output - optional</h4></p>
    212 <p>
    213 BNC can output broadcast ephemeris in binary format on your local host (IP 127.0.0.1) through an IP port. Specify an IP port number to activate this function. The default is an empty option field, meaning that no ASCII ephemeris output via IP port is generated.
    214 </p>
    215 <p>The source code for BNC comes with an example perl script called 'test_bnc_eph.pl' that allows you to read BNC's ASCII ephemeris output from the IP port.</p>
    216 <p><a name="rinex"><h4>3.5. RINEX</h4></p>
    217 <p>
    218 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.
    219 </p>
    220 <p><a name="rnxname"><h4>3.5.1 RINEX File Names</h4></p>
    221 <p>
    222 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</p>
    223 <p>
    224 FRAN{ddd}{h}.{yy}O<br>
    225 WETT{ddd}{h}.{yy}O
    226 </p>
    227 <p>
    228 where 'ddd' is the day of year, 'h' is a letter which corresponds to an hour long UTC time block and 'yy' is the year.
    229 </p>
    230 <p>
    231 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</p>
    232 <p>
    233 FRAN{ddd}{h}_KFURT.{yy}O<br>
    234 FRAN{ddd}{h}_CE.{yy}O.
    235 </p>
    236 <p>
    237 If several streams show exactly the same mountpoint name (example: BRUS0 from <u>www.euref-ip.net</u> and BRUS0 from <u>www.igs-ip.net</u>), BNC adds an integer number to the file name leading i.e. to hourly RINEX Observation files like</p>
    238 <p>
    239 BRUS{ddd}{h}_0.{yy}O<br>
    240 BRUS{ddd}{h}_1.{yy}O.
    241 </p>
    242 <p>
    243 Note that RINEX file names for all intervals less than 1 hour follow the file name convention for 15 minutes RINEX Observation files i.e.</p>
    244 <p>
    245 FRAN{ddd}{h}{mm}.{yy}O
    246 </p>
    247 <p>
    248 where 'mm' is the starting minute within the hour.
    249 </p>
    250 
    251 <p><a name="rnxpath"><h4>3.5.2 RINEX Directory - optional</h4></p>
    252 <p>
    253 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.
    254 </p>
    255 
    256 <p><a name="rnxversion"><h4>3.5.3 RINEX Version - optional</h4></p>
    257 <p>
    258 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.
    259 </p>
    260 
    261 <p><a name="rnxscript"><h4>3.5.4 RINEX Script - optional</h4></p>
    262 <p>
    263 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).
    264 </p>
    265 <p>
    266 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.
    267 </p>
    268 <p>
    269 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'.
    270 </p>
    271 
    272 <p><a name="rnxinterval"><h4>3.5.5 RINEX File Interval - mandatory if 'RINEX directory' is set</h4></p>
    273 <p>
    274 Select the length of the RINEX Observation file generated. The default value is 15 minutes.
    275 </p>
    276 
    277 <p><a name="rnxsample"><h4>3.5.6 RINEX Sampling - mandatory if 'RINEX directory' is set </h4></p>
    278 <p>
    279 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.
    280 </p>
    281 
    282 <p><a name="rnxskeleton"><h4>3.5.7 RINEX Skeleton Extension - optional</h4></p>
    283 <p>
    284 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 <u>http://www.epncb.oma.be:80/stations/log/skl/brus.skl</u> for an example of a public RINEX header skeleton file for the Brussels EPN station.
    285 </p>
    286 <p>
    287 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.
    288 </p>
    289 <p>
    290 Examples for personal skeleton file name convention: RINEX Observation files for mountpoints WETTZELL, FRANKFURT and FRANCE (same 4Char Station ID), BRUS0 from <u>www.euref-ip.net</u> and BRUS0 from <u>www.igs-ip.net</u> (same 4Char Station ID, identical mountpoint stings) would accept personal skeleton files named</p>
    291 <p>
    292 WETT.skl<br>
    293 FRAN_KFURT.skl<br>
    294 FRAN_CE.skl<br>
    295 BRUS_0.skl<br>
    296 BRUS_1.skl</p>
    297 <p>
    298 if 'RINEX skeleton extension' is set to 'skl'.
    299 </p>
    300 <p>
    301 Note the following regulations regarding personal RINEX header skeleton files:
    302 <ul>
    303 <li>If such a file exists in the 'RINEX directory', the corresponding public RINEX header skeleton file is ignored. The RINEX header is generated solely from the contents of the personal skeleton.</li>
    304 <li>Personal skeletons should contain a complete first header record of type</li>
    305 <br>- &nbsp; RINEX VERSION / TYPE
    306 <li>They should then contain an empty header record of type</li>
    307 <br>- &nbsp; PGM / RUN BY / DATE
    308 <br>BNC will complete this line and include it in the actual RINEX file header.
    309 <li>They should further contain complete header records of type</li>
    310 <br>- &nbsp; MARKER NAME
    311 <br>- &nbsp; OBSERVER / AGENCY
    312 <br>- &nbsp; REC # / TYPE / VERS
    313 <br>- &nbsp; ANT # / TYPE
    314 <br>- &nbsp; APPROX POSITION XYZ
    315 <br>- &nbsp; ANTENNA: DELTA H/E/N
    316 <br>- &nbsp; WAVELENGTH FACT L1/2
    317 <li>They may contain any other optional complete header record as defined in the RINEX documentation.</li>
    318 <li>They should then contain empty header records of type</li>
    319 <br>- &nbsp; # / TYPES OF OBSERV
    320 <br>- &nbsp; TIME OF FIRST OBS
    321 <br>BNC will include these lines in the final RINEX file header together with an additional
    322 <br>- &nbsp; COMMENT
    323 <br>line describing the source of the stream.
    324 <li>They should finally contain an empty header record of type</li>
    325 <br>- &nbsp; END OF HEADER (last record)
    326 </ul>
    327 <p>
    328 If neither a public nor a personal RINEX header skeleton file is available for BNC, a default header will be used.
    329 </p>
    330 
    331 <p>
    332 
    333 <p><a name="rnxappend"><h4>3.5.8 Append Files</h4></p>
    334 <p>
    335 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.
    336 </p>
    337 <p><a name="mountpoints"><h4>3.6. Ephemeris</h4></p>
    338 <p>
    339 Broadcast ephemeris can be saved as RINEX Navigation files when received via RTCM Version 3.x as message types 1019 (GPS) and 1020 (GLONASS) or via RTIGS records type 300. 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
    340 </p>
    341 <ul>
    342 <li>'N' or 'G' for GPS or GLONASS ephemeris in two separate RINEX Version 2.11 Navigation files, or</li>
    343 <li>'P' for GPS plus GLONASS ephemeris saved together in one RINEX Version 3 Navigation file.
    344 </ul>
    345 
    346 <p><a name="ephpath"><h4>3.6.1 Ephemeris Directory - optional</h4></p>
    347 <p>
    348 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.
    349 </p>
    350 
    351 <p><a name="ephvers"><h4>3.6.2 RINEX Version - optional</h4></p>
    352 <p>
    353 Default format for RINEX Navigation files containing broadcast ephemeris is RINEX Version 2.11. Select 'RINEX v3' if you want to save the ephemeris in RINEX Version 3 format.
    354 </p>
    355 
    356 <p><a name="ephinterval"><h4>3.6.3 Ephemeris Interval - mandatory if 'Ephemeris directory' is set</h4></p>
    357 <p>
    358 Select the length of the RINEX Navigation file generated. The default value is 1 day.
    359 </p>
    360 
    361 <p><a name="thresholds"><h4>3.7. Advisory Note</h4></p>
    362 
    363 <p>
    364 At various times, the incoming stream might become unavailable or corrupted. In such cases, it is important that the BNCoperator and/or the stream providers become aware of the situation so that necessary measures can be taken to restore the stream. Furthermore, continuous attempts to decode corrupted stream(s) can generate unnecessary workload for BNC.
    365 </p>
    366 <p>
    367 <u>Stream outages:</u> BNC considers a connection to be broken when there are no incoming data detected for more than 20 seconds. When this occurs, BNC will attempt to reconnect at a decreasing rate. It will first try to reconnect with 1 second delay, and again in2 seconds if the previous attempt failed. If the attempt is still unsuccessful, it will try to reconnect within 4 seconds after the previous attempt and so on. The wait time doubles each time with a maximum wait time of 256 seconds.
    368 </p>
    369 <p>
    370 <u>Stream corruption:</u> Not all bits chunk transfers to BNC's internal decoders return valid observations. Sometimes several chunks might be needed before the next observation can be properly decoded. BNC buffers all the outputs (both valid and invalid) from the decoder for a short 'Inspect Segment' time span and then determines whether the content of that segment is valid or corrupted. If it is corrupted, the decoding process is paused and decodings are then attempted again at decreasing rate. BNC will first attempt to decode again after a 30 second lag and if unsuccessful, make another attempt within 60 seconds after the previous attempt. If it is still unsuccessful, it will make another attempt to decode within 120 seconds after the previous attempt and so on. Each decoding attempt doubles the wait time since the previous attempt. The maximum wait time between attempts is limited to 960 seconds.
    371 </p>
    372 
    373 <p><a name="inspectSegm"><h4>3.7.1 Inspect Segment - mandatory for 'Failure' and 'Recovery' thresholds</h4></p>
    374 <p>
    375 BNC buffers all the results (both valid and invalid) returned by the decoder within a short 'Inspect Segment' time and then determines whether the stream is corrupted or not. If all the results observed within the 'Inspect Segment' time span are invalid this segment is then reported as bad segment. The default value of 15 seconds for 'Inspect Segment' is recommended when handling 1Hz data. If the specified value is too small and temporary communication bottlenecks occur, this may lead to an additional data loss of some data of the affected stream.
    376 </p>
    377 <p>
    378 Specifying a value of zero '0' will bypass BNC's data corruption check. Beware that this may result in unnecessary additional workload in case of prolonged stream corruption. Also note that 'Inspect Segment' must be set to greater than zero '0' in order to trigger event report on corrupted streams.
    379 </p>
    380 
    381 <p><a name="threshFail"><h4>3.7.2 Failure Threshold - optional</h4></p>
     354<p>
     355The source code for BNC comes with an example program called 'test_bnc_qt.cpp' that allows you to read BNC's binary observation output from the IP port.
     356</p>
     357
     358<p><a name="syncwait"><h4>3.7.2 Wait for Full Epoch - optional</h4></p>
     359<p>
     360When 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.
     361</p>
     362<p>
     363Note 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.
     364</p>
     365
     366<p><a name="syncfile"><h4>3.7.3 Output File - optional</h4></p>
     367<p>
     368Specifies 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.
     369</p>
     370<p>
     371Beware that the size of this file can rapidly increase depending on the number of incoming streams. This option is primarily meant for testing and evaluation.
     372</p>
     373
     374<p><a name="advnote"><h4>3.8. Advisory Notice</h4></p>
     375
     376<p>
     377At various times, the incoming stream might become unavailable or corrupted. In such cases, it is important that the BNC operator and/or the stream providers become aware of the situation so that necessary measures can be taken to restore the stream. Furthermore, continuous attempts to decode corrupted stream(s) can generate unnecessary workload for BNC.
     378</p>
     379<p>
     380<u>Stream outages:</u> BNC considers a connection to be broken when there are no incoming data detected for more than 20 seconds. When this occurs, BNC will attempt to reconnect at a decreasing rate. It will first try to reconnect with 1 second delay, and again in 2 seconds if the previous attempt failed. If the attempt is still unsuccessful, it will try to reconnect within 4 seconds after the previous attempt and so on. The wait time doubles each time with a maximum wait time of 256 seconds.
     381</p>
     382<p>
     383<u>Stream corruption:</u> Not all bits chunk transfers to BNC's internal decoders return valid observations. Sometimes several chunks might be needed before the next observation can be properly decoded. BNC buffers all the outputs (both valid and invalid) from the decoder for a short 'Inspect segment' time span and then determines whether the content of that segment is valid or corrupted. If several consecutive segments are corrupted, the decoding process is paused and decodings are then attempted again at decreasing rate. BNC will first attempt to decode again after a 30 second lag and if unsuccessful, make another attempt within 60 seconds after the previous attempt. If it is still unsuccessful, it will make another attempt to decode within 120 seconds after the previous attempt and so on. Each decoding attempt doubles the wait time since the previous attempt. The maximum wait time between attempts is limited to 960 seconds.
     384</p>
     385
     386<p><a name="advsegm"><h4>3.8.1 Inspect Segment - mandatory for 'Failure' and 'Recovery' thresholds</h4></p>
     387<p>
     388BNC buffers all the results (both valid and invalid) returned by the decoder within a short 'Inspect segment' time and then determines whether the stream is corrupted or not. If all the results observed within the 'Inspect segment' time span are invalid this segment is then reported as bad segment. The default value of 15 seconds for 'Inspect segment' is recommended when handling 1Hz data. If the specified value is too small and temporary communication bottlenecks occur, this may lead to an additional loss of some data of the affected stream.
     389</p>
     390<p>
     391Specifying a value of zero '0' will bypass BNC's data corruption check. Beware that this may result in unnecessary additional workload in case of prolonged stream corruption. Also note that 'Inspect segment' must be set to greater than zero '0' in order to trigger event report on corrupted streams.
     392</p>
     393
     394<p><a name="advfail"><h4>3.8.2 Failure Threshold - optional</h4></p>
    382395<p>
    383396
    … …  
    385398</p>
    386399
    387 <p><a name="threshReco"><h4>3.7.3 Recovery Threshold - optional</h4></p>
    388 <p>
    389 Once a 'Begin_Failure' or 'Begin_Corrupted' event has been reported, BNC will check for when the stream again becomes available or uncorrupted. Event 'End_Failure' or 'End_Corrupted' will be reported as soon as a valid observation is again received at least once within the 'Recovery' threshold time span. The default value is set to 5 minutes and is recommended so not to innundate users with too many event reports. 
     400<p><a name="advreco"><h4>3.8.3 Recovery Threshold - optional</h4></p>
     401<p>
     402Once a 'Begin_Failure' or 'Begin_Corrupted' event has been reported, BNC will check for when the stream again becomes available or uncorrupted. Event 'End_Failure' or 'End_Corrupted' will be reported as soon as valid segments are again detected continuously throughout the 'Recovery' threshold time span. The default value is set to 5 minutes and is recommended so not to innundate users with too many event reports. 
    390403</p>
    391404<p>
    … …  
    393406</p>
    394407<p>
    395 Also note that using this function for corrupted streams requires the 'Inspect Segment' value to be set to greater than zero '0'.
    396 </p>
    397 <p>
    398 All the events are reported in the 'Log' file/section as a 'Begin_Outage', End_Outage', 'Begin_Corrupted' or 'End_Corrupted' message. They can also be passed on as parameters to a shell script or batch file to generate an advisory notice to BNC operator or affected stream providers. This functionality lets users utilise BNC as a real-time performance monitor and alarm system for a network of GNSS reference stations.
    399 </p>
    400 
    401 <p><a name="noteScript"><h4>3.7.4 Advisory Script - optional </h4></p>
    402 <p>
    403 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 notice to network operator or stream providers. To enable this feature, specify the full path to the script or batch file in the 'Notice 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/Linuxsystems).
     408Also note that using this function for corrupted streams requires the 'Inspect segment' value to be set to greater than zero '0'.
     409</p>
     410<p>
     411All the events are reported in the Log file/section. They can also be passed on as parameters to a shell script or batch file to generate an advisory notice to BNC operator or affected stream providers. This functionality lets users utilise BNC as a real-time performance monitor and alarm system for a network of GNSS reference stations.
     412</p>
     413
     414<p><a name="advscript"><h4>3.8.4 Advisory Script - optional </h4></p>
     415<p>
     416As 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 notice 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/Linuxsystems).
    404417</p>
    405418<p>
    … …  
    413426sleep $((60*RANDOM/32767))
    414427cat | mail -s "BNC: $2 Stream $1" email@address &lt;&lt;!
    415 Advisory Note to BNC User,
     428Advisory Notice to BNC User,
    416429Please note a $2 advisory from BNC for stream $1 dated `date`.
    417430Regards, BNC
    … …  
    422435</p>
    423436
    424 <p><a name="mountpoints"><h4>3.8. Mountpoints</h4></p>
     437<p><a name="mountpoints"><h4>3.9. Mountpoints</h4></p>
    425438<p>
    426439Each 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.
    … …  
    439452</table>
    440453
    441 <p><a name="AddMounts"><h4>3.8.1 Add Mountpoints</h4></p>
     454<p><a name="mountadd"><h4>3.9.1 Add Mountpoints</h4></p>
    442455<p>
    443456Button 'Add Mountpoints' opens a window that allows user to select data streams from an NTRIP broadcaster according to their mountpoints.
    444457</p>
    445458
    446 <p><a name="HostPort"><h4>3.8.2 Broadcaster Host and Port - required</h4></p>
     459<p><a name="mounthost"><h4>3.9.2 Broadcaster Host and Port - required</h4></p>
    447460<p>
    448461Enter the NTRIP broadcaster host IP and port number. <u>http://www.rtcm-ntrip.org/home</u> provides information about known NTRIP broadcaster installations. 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>.
    449462</p>
    450463
    451 <p><a name="account"><h4>3.8.3 Broadcaster User and Password - required for protected streams</h4></p>
     464<p><a name="mountuser"><h4>3.9.3 Broadcaster User and Password - required for protected streams</h4></p>
    452465<p>
    453466Some 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/index_ntrip_reg.htm</u> for access to protected streams on <u>www.euref-ip.net</u> and <u>www.igs-ip.net</u>.
    454467</p>
    455468
    456 <p><a name="GetTable"><h4>3.8.4 Get Table</h4></p>
     469<p><a name="mounttable"><h4>3.9.4 Get Table</h4></p>
    457470<p>
    458471Use 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.
    … …  
    465478</p>
    466479
    467 <p><a name="delete"><h4>3.8.5 Delete Mountpoints</h4></p>
     480<p><a name="mountdelete"><h4>3.9.5 Delete Mountpoints</h4></p>
    468481<p>
    469482To 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.</p>
    470483
    471 <p><a name="edit"><h4>3.8.6 Edit Mountpoints</h4></p>
     484<p><a name="mountedit"><h4>3.9.6 Edit Mountpoints</h4></p>
    472485<ul>
    473486<li>
    … …  
    484497</ul>
    485498
    486 <p><a name="log"><h4>3.9. Log - optional</h4></p>
    487 <p>
    488 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.
    489 </p>
    490 
    491499<p><a name="start"><h4>3.10. Start</h4></p>
    492500<p>
    … …  
    508516<p><a name="limits"><h3>4. Limitations</h3></p>
    509517<ul>
     518<li>
     519On Qt-based desktop environments (like KDE) it may happen that you experience a crash of BNC at startup even when running the program in the background using the '-nw' option. This is a known bug most likely resulting from an incompatibility of Qt libraries in the environment and in BNC. Entering the command 'unset SESSION_MANAGER' before running BNC may help as a work-around.
     520</li>
    510521<li>
    511522Currently BNC only handles GPS, SBAS and GLONASS data. Galileo is not yet supported.
    … …  
    580591<tr><td>May 2007 &nbsp;</td><td>Version 1.3 &nbsp;</td><td>[Add] Source code published.
    581592<tr><td>Jul 2007 &nbsp;</td><td>Version 1.4 &nbsp;</td><td>[Bug] Skip messages from proxy server<br> [Bug] Call RINEX script through 'nohup'</td></tr>
    582 <tr><td>Feb 2008 &nbsp;</td><td>Version 1.5 &nbsp;</td><td>[Add] Handle ephemeris from RTCM Version 3.x streams<br> [Add] Upgrade to Qt Version 4.3.2<br> [Add] Optional RINEX v3 output<br> [Add] SBAS support<br> [Bug] RINEX skeleton download following stream outage<br> [Add] Handle ephemeris from RTIGS streams<br> [Add] Advisory notes following stream failure/recovery</td></tr>
     593<tr><td>Feb 2008 &nbsp;</td><td>Version 1.5 &nbsp;</td><td>[Add] Handle ephemeris from RTCM Version 3.x streams<br> [Add] Upgrade to Qt Version 4.3.2<br> [Add] Optional RINEX v3 output<br> [Add] SBAS support<br> [Bug] RINEX skeleton download following stream outage<br> [Add] Handle ephemeris from RTIGS streams<br> [Add] Advisory notes following stream failure/recovery<br> [Mod] Main window layout<br> [Bug] Freezing of About window on Mac systems</td></tr>
    583594</table>
    584595</p>
Note: See TracChangeset for help on using the changeset viewer.