source: ntrip/trunk/BNC/Example_Configs/00_Readme.txt@ 9826

Last change on this file since 9826 was 9826, checked in by stuerze, 3 months ago

Update Example Configs readme

File size: 14.3 KB
Line 
1Configuration Examples
2
3BNC comes with a number of configuration examples which can be used on all
4operating systems. Copy the complete directory 'Example_Configs' which comes
5with the software including sub-directories 'Input' and 'Output' to your disc.
6There are several ways to start BNC using one of the example configurations:
7
8* On graphical systems (except for Mac systems) you may use the computer mouse
9 to 'drag' a configuration file icon and 'drop' it on top of BNC's program icon.
10
11* You could also start BNC using a command line for naming a specific
12 configuration file (suggested e.g. for Mac systems):
13 bnc --conf <configFileName>
14
15* On non-graphical systems or when running BNC in batch mode in the background
16 you may start the program using a command line with a configuration file
17 option in 'no window' mode (example for Windows systems):
18 bnc.exe --conf <configFileName> --nw
19
20Although it's not a must, we suggest that you always create BNC configuration
21files with the filename extension '.bnc'.
22
23We furthermore suggest for convenience reasons that you configure your system
24to automatically start BNC when you double-click a file with the filename
25extension '.bnc'. The following describes what to do on Windows systems to
26associate the BNC program to such configuration files:
27
28
291. Right-click a file that has the extension '.bnc' and then click 'Open'. If
30 the 'Open' command is not available, click 'Open With' or double-click the
31 file.
32
332. Windows displays a dialog box that says that the system cannot open this
34 file. The dialog box offers several options for selecting a program.
35
363. Click 'Select the program from a list', and then click 'OK'.
37
384. The 'Open With' dialog box is displayed. Click 'Browse', locate and then
39 click the BNC program, and then click 'Open'.
40
415. Click to select the 'Always use the selected program to open this kind
42 of file' check box.
43
446. Click 'OK'.
45
46Some of the presented example configuration files contain a user ID 'Example'
47with a password 'Configs' for accessing a few GNSS streams from public Ntrip
48Broadcasters. This generic account is arranged for convenience reasons only.
49Please be so kind as to replace the generic account details as well as the
50place holders 'User' and 'Pass' by the personal user ID and password you
51receive following an online registration through
52http://register.rtcm-ntrip.org.
53
54Note that the account for an Ntrip Broadcaster is usually limited to
55pulling a specified maximum number of streams at the same time. As running
56some of the example configurations requires pulling several streams, it
57is suggested to make sure that you don't exceed your account's limits.
58
59Make also sure that sub-directories 'Input' and 'Output' which are part of
60the example configurations exist on your system or adjust the affected
61example configuration options according to your needs.
62
63Some BNC options require antenna phase center variations as made available
64from IGS through so-called ANTEX files at
65https://files.igs.org/pub/station/general/igs14.atx
66An example ANTEX file 'igs14.atx' is part of the BNC package for convenience.
67
68The example configurations assume that no proxy protects your BNC host.
69Should a proxy be operated in front of BNC then you need to introduce its
70name or IP and port number in the 'Network' panel.
71
72(A) Working with Configuration Files
73
74You should be able to run all configuration file examples without changing
75contained options. However, configurations 'Upload.bnc' and 'UploadEPH.bnc' are
76exceptions because they require an input stream from a connected network engine.
77
781. Configuration File 'RinexObs.bnc'
79Purpose: Convert RTCM streams to RINEX Observation files.
80The configuration pulls RTCM Version 3 streams from Ntrip Broadcasters using
81Ntrip Version 2 to generate 15min 1Hz RINEX Version 4 Observation files. See
82https://igs.bkg.bund.de/ntrip/#rtcm-obs for observation stream resources.
83
842. Configuration File 'RinexEph.bnc'
85Purpose: Convert a RTCM stream with navigation messages to RINEX Navigation
86files. The configuration pulls a RTCM Version 3 stream with Broadcast Ephemeris
87coming from the real-time EUREF and IGS networks and saves hourly RINEX Version
884 Navigation files. See https://igs.bkg.bund.de/ntrip/#rtcm-eph for further
89real-time Broadcast Ephemeris resources.
90
913. Configuration File 'BrdcCorr.bnc'
92Purpose: Save Broadcast Corrections from RTCM SSR messages in hourly plain
93ASCII files. See https://igs.bkg.bund.de/ntrip/#rtcm-corr for various real-time IGS
94or EUREF orbit/clock correction products.
95
964. Configuration File 'RinexConcat.bnc'
97Purpose: Concatenate several RINEX Version 3 files to produce one compiled file
98and edit the marker name in the file header. The sampling interval is set to 30
99seconds. See section 'RINEX Editing & QC' in the documentation for examples on
100how to call BNC from command line in 'no window' mode for RINEX file editing,
101concatenation and quality check.
102
1035. Configuration File 'RinexQC.bnc'
104Purpose: Check the quality of a RINEX Version 4 file by means of a multipath
105analysis. Results are saved on disk in terms of a plot in PNG format. See
106section 'RINEX Editing & QC' in the documentation for examples on how to call
107BNC from command line in 'no window' mode for RINEX file editing, concatenation
108and quality check.
109
1106. Configuration File 'RTK.bnc'
111Purpose: Feed a serial connected receiver with observations from a nearby
112reference station for conventional RTK. The stream is scanned for RTCM
113messages. Message type numbers and latencies of incoming observations are
114reported in BNC's logfile.
115
1167. Configuration File 'FeedEngine.bnc'
117Purpose: Feed a real-time GNSS engine with observations from remote reference
118stations. The configuration pulls a single stream from an Ntrip Broadcaster.
119You could also pull several streams from different casters. Incoming
120observations are decoded, synchronized, output through a local IP port and also
121saved into a file. Failure and recovery thresholds are specified to inform
122about outages.
123
1248. Configuration File 'PPP.bnc'
125Purpose: Precise Point Positioning from observations of a rover receiver. The
126configuration reads RTCM Version 3 observations, a Broadcast Ephemeris stream
127and a stream with Broadcast Corrections. Positions are saved in the logfile.
128More detailed PPP results are saved in the PPP logfile.
129
1309. Configuration File 'PPPNet.bnc'
131Purpose: Precise Point Positioning for several rovers or receivers from an
132entire network of reference stations in one BNC job. The possible maximum
133number of PPP solutions per job depends on the processing power of the hosting
134computer. This example configuration reads two RTCM Version 3 observation
135streams, a Broadcast Ephemeris stream and a stream with Broadcast Corrections.
136Detailed PPP Results for the two stations are saved in PPP logfiles.
137
13810. Configuration File 'PPPQuickStart.bnc'
139Purpose: Precise Point Positioning in Quick-Start mode from observations of a
140static receiver with precisely known position. The configuration reads RTCM
141Version 3 observations, Broadcast Corrections and a Broadcast Ephemeris stream.
142Positions are saved in NMEA format on disc. They are also output through IP
143port for real-time visualization with tools like RTKPLOT. Positions are saved
144in the logfile.
145
14611. Configuration File 'PPPPostProc.bnc'
147Purpose: Precise Point Positioning in post processing mode. BNC reads RINEX
148Version 3 Observation and Navigation files and a Broadcast Correction file.
149PPP processing options are set to support the Quick-Start mode. The output is
150saved in a specific post processing logfile and contains coordinates derived
151over time following the implemented PPP filter algorithm.
152
15312. Configuration File 'PPPOsm.bnc'
154Purpose: Track BNC's point positioning solutions using OpenStreetMap as background.
155BNC reads a RINEX Observation file and a RINEX Navigation file to carry out
156a 'Standard Point Positioning' solution in post processing mode.
157Although this is not a real-time application it requires the BNC host to be
158connected to the Internet. Specify a computation speed, then hit button 'Open Map'
159to open the track map, then hit 'Start' to visualize receiver positions on top
160of OSM maps.
161
16213. Configuration File 'SPPQuickStartGal.bnc'
163Purpose: Single Point Positioning in Quick-Start mode from observations of a
164static receiver with quite precisely known position. The configuration uses
165Galileo observations only and a Broadcast Ephemeris stream.
166
16714. Configuration File 'SaveSp3.bnc'
168Purpose: Produces SP3 files from a Broadcast Ephemeris stream and a Broadcast
169Correction stream. The Broadcast Correction stream is formally introduced in
170BNC's 'Combine Corrections' table. Note that producing SP3 requires an ANTEX
171file because SP3 file content should be referred to CoM.
172
17315. Configuration File 'Sp3ETRF2000PPP.bnc'
174Purpose: Produce SP3 files from a Broadcast Ephemeris stream and a stream
175carrying ETRF2000 Broadcast Corrections. The Broadcast Correction stream is
176formally introduced in BNC's 'Combine Corrections' table. The configuration
177leads to a SP3 file containing orbits also referred to ETRF2000. Pulling in
178addition observations from a reference station at precisely known ETRF2000
179position allows comparing an 'INTERNAL' PPP solution with a known ETRF2000
180reference coordinate.
181
18216. Configuration File 'Upload.bnc'
183Purpose: Upload orbits and clocks from a real-time GNSS engine to an Ntrip
184Broadcaster. For that the configuration reads precise orbits and clocks in
185RTNET format. It also reads a stream carrying Broadcast Ephemeris. BNC converts
186the orbits and clocks into Broadcast Corrections and encodes them to
187IGS-SSR messages to finally upload them to an Ntrip Broadcaster. The
188Broadcast Correction stream is referred to satellite Antenna Phase Center (APC)
189and reference system IGS14. Orbits are saved on disk in SP3 format and clocks
190are saved in Clock RINEX format.
191
19217. Configuration File 'Combi.bnc'
193Purpose: Pull 2 streams carrying Broadcast Corrections, and Satellite Code Biases
194together with Broadcast Ephemeris from an Ntrip Broadcaster
195to produce a combined Broadcast Correction stream.
196BNC encodes the combination product in IGS-SSR messages and uploads them to
197an Ntrip Broadcaster. The Broadcast Correction stream is referred to
198satellite Antenna Phase Center (APC) and not to satellite Center of
199Mass (CoM). Its reference system is IGS14. Orbits are saved in SP3 format
200(referred to CoM) and clocks in Clock RINEX format.
201
20218. Configuration File 'CombiPPP.bnc'
203Purpose: This configuration equals the 'Combi.bnc' configuration. However, the
204combined Broadcast Corrections are in addition used for an 'INTERNAL' PPP
205solutions based on observations from a static reference station with known
206precise coordinates. This allows a continuous quality check of the combination
207product through observing coordinate displacements.
208
20919. Configuration File 'UploadEph.bnc'
210Purpose: Pull a number of streams from reference stations to get the
211contained Broadcast Ephemeris messages. They are encoded to RTCM Version 3
212format and uploaded for the purpose of providing a Broadcast Ephemeris stream
213with an update rate of 5 seconds.
214
21520. Configuration File 'CompareSp3.bnc'
216Purpose: Compare two SP3 files to calculate RMS values for orbit and clock
217differences. GPS satellite G05 and GLONASS satellite R18 are excluded from this
218comparison. Comparison results are saved in a logfile.
219
22021. Configuration File 'Empty.bnc'
221Purpose: Provide an empty example configuration file for BNC which only
222contains the default settings.
223
224(B) Working with Command Line configuration options
225
226The following configuration examples make use of BNC's 'Command Line Interface'
227(CLI). Configuration options are exclusively specified via command line. No
228configuration file is used. Examples are provided as shell scripts for a Linux
229system. They call BNC in 'no window' batch mode (command line option -nw).
230The scripts expect 'Example_Configs' to be the current working directory.
231
23222. Shell Script 'RinexQC.sh'
233Purpose: Equals configuration file example 'RinexQC.bnc', checks the quality of
234a RINEX Version 4 file by means of a multipath analysis. The platform offscreen
235is used while producing plot files in PNG format. BNC is offline.
236All results are saved on disk.
237
23823. Shell Script 'RinexConcat.sh'
239Purpose: Equals configuration file example 'RinexConcat.bnc', concatenates
240several RINEX Version 3 files to produce one compiled file and edit the marker
241name in the file header. The sampling interval is set to 30 seconds. BNC is
242offline.
243
24424. Shell Script 'RinexEph.sh'
245Purpose: Equals configuration file example 'RinexEph.bnc', converts a RTCM
246stream with navigation messages to RINEX Navigation files. The configuration
247pulls a RTCM Version 3 stream with Broadcast Ephemeris coming from the
248real-time EUREF and IGS networks and saves hourly RINEX Version 4 Navigation
249files. BNC runs online until it's terminated after 10 seconds. See
250https://igs.bkg.bund.de/ntrip/#rtcm-eph for further real-time Broadcast
251Ephemeris resources.
252
25325. Shell Script 'ScanLate.sh'
254Purpose: Scan an observation stream for contained RTCM message types, print
255observation latencies. The output is saved in a logfile. Latencies are
256reported every 10 seconds. BNC runs online until it's terminated after 20
257seconds.
258
25926. Shell Script 'RinexObs.sh'
260Purpose: Equals configuration file example 'RinexObs.bnc', converts RTCM
261streams to RINEX Observation files. The configuration pulls streams from two
262Ntrip Broadcasters using Ntrip Version 2 to generate 15min 1Hz RINEX Version 4
263Observation files. See https://igs.bkg.bund.de/ntrip/#rtcm-obs for
264observation stream resources. BNC runs online until it's terminated after 30
265seconds.
266
267(C) Command Line configuration options overwriting Configuration File options
268
269For specific applications you may like to use your own set of standard
270configuration options from a configuration file and update some of its content
271via command line. When using a configuration file and command line configuration
272options together in one BNC call, the command line configuration options will
273always overrule options contained in the configuration file.
274
27527. Shell Script 'CompareSp3.sh'
276Purpose: Equals configuration file example 'CompareSp3.bnc', compares two SP3
277files to calculate RMS values for orbit and clock differences. However, instead
278of excluding GPS satellite G05 and GLONASS satellite R18 from the comparison as
279specified in 'CompareSp3.bnc', GPS satellite G06 and all GLONASS satellites are
280excluded via command line option. BNC runs offline. Comparison results are saved
281in a logfile.
282
283Andrea Stuerze, BKG
284Frankfurt, June 2022
285igs-ip@bkg.bund.de
286
Note: See TracBrowser for help on using the repository browser.