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

Last change on this file since 9776 was 9776, checked in by stuerze, 2 months ago

sme example configs are updated

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. The configuration
80pulls streams from Ntrip Broadcasters using Ntrip Version 2 to generate 15min
811Hz 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.
128
1299. Configuration File 'PPPNet.bnc'
130Purpose: Precise Point Positioning for several rovers or receivers from an
131entire network of reference stations in one BNC job. The possible maximum
132number of PPP solutions per job depends on the processing power of the hosting
133computer. This example configuration reads two RTCM Version 3 observation
134streams, a Broadcast Ephemeris stream and a stream with Broadcast Corrections.
135PPP Results for the two stations are saved in PPP logfiles.
136
13710. Configuration File 'PPPQuickStart.bnc'
138Purpose: Precise Point Positioning in Quick-Start mode from observations of a
139static receiver with precisely known position. The configuration reads RTCM
140Version 3 observations, Broadcast Corrections and a Broadcast Ephemeris stream.
141Positions are saved in NMEA format on disc. They are also output through IP
142port for real-time visualization with tools like RTKPLOT. Positions are saved
143in the logfile.
144
14511. Configuration File 'PPPPostProc.bnc'
146Purpose: Precise Point Positioning in post processing mode. BNC reads RINEX
147Version 3 Observation and 3 Navigation files and a Broadcast Correction file.
148PPP processing options are set to support the Quick-Start mode. The output is
149saved in a specific post processing logfile and contains coordinates derived
150over time following the implemented PPP filter algorithm.
151
15212. Configuration File 'PPPOsm.bnc'
153Purpose: Track BNC's point positioning solutions using
154OpenStreetMap as background. BNC reads a RINEX Observation file and a RINEX
155Navigation file to carry out a 'Standard Point Positioning' solution in post
156processing mode. Although this is not a real-time application it requires the
157BNC host to be connected to the Internet. Specify a computation speed, then hit
158button 'Open Map' to open the track map, then hit 'Start' to visualize receiver
159positions on top of OSM maps.
160
16113. Configuration File 'SPPQuickStartGal.bnc'
162Purpose: Single Point Positioning in Quick-Start mode from observations of a
163static receiver with quite precisely known position. The configuration uses
164GPS, GLONASS and Galileo observations and a Broadcast Ephemeris stream.
165
16614. Configuration File 'SaveSp3.bnc'
167Purpose: Produces SP3 files from a Broadcast Ephemeris stream and a Broadcast
168Correction stream. The Broadcast Correction stream is formally introduced in
169BNC's 'Combine Corrections' table. Note that producing SP3 requires an ANTEX
170file because SP3 file content should be referred to CoM.
171
17215. Configuration File 'Sp3ETRF2000PPP.bnc'
173Purpose: Produce SP3 files from a Broadcast Ephemeris stream and a stream
174carrying ETRF2000 Broadcast Corrections. The Broadcast Correction stream is
175formally introduced in BNC's 'Combine Corrections' table. The configuration
176leads to a SP3 file containing orbits also referred to ETRF2000. Pulling in
177addition observations from a reference station at precisely known ETRF2000
178position allows comparing an 'INTERNAL' PPP solution with a known ETRF2000
179reference coordinate.
180
18116. Configuration File 'Upload.bnc'
182Purpose: Upload orbits and clocks from a real-time GNSS engine to an Ntrip
183Broadcaster. For that the configuration reads precise orbits and clocks in
184RTNET format. It also reads a stream carrying Broadcast Ephemeris. BNC converts
185the orbits and clocks into Broadcast Corrections and encodes them to RTCM
186Version 3 SSR messages to finally upload them to an Ntrip Broadcaster. The
187Broadcast Correction stream is referred to satellite Antenna Phase Center (APC)
188and reference system IGS14. Orbits are saved on disk in SP3 format and clocks
189are saved in Clock RINEX format.
190
19117. Configuration File 'Combi.bnc'
192Purpose: Pull several streams carrying Broadcast Corrections and a Broadcast
193Ephemeris from an Ntrip Broadcaster to produce a combined Broadcast Correction
194stream. BNC encodes the combination product in RTCM Version 3 SSR messages and
195uploads that to an Ntrip Broadcaster. The Broadcast Correction stream is
196referred to satellite Antenna Phase Center (APC) and not to satellite Center of
197Mass (CoM). Its reference system is IGS14. Orbits are saved in SP3 format
198(referred to CoM) and clocks in Clock RINEX format.
199
20018. Configuration File 'CombiPPP.bnc'
201Purpose: This configuration equals the 'Combi.bnc' configuration. However, the
202combined Broadcast Corrections are in addition used for an 'INTERNAL' PPP
203solutions based on observations from a static reference station with known
204precise coordinates. This allows a continuous quality check of the combination
205product through observing coordinate displacements.
206
20719. Configuration File 'UploadEph.bnc'
208Purpose: Pull a number of streams from reference stations to get hold of
209contained Broadcast Ephemeris messages. They are encoded to RTCM Version 3
210format and uploaded for the purpose of providing a Broadcast Ephemeris stream
211with an update rate of 5 seconds.
212
21320. Configuration File 'CompareSp3.bnc'
214Purpose: Compare two SP3 files to calculate RMS values for orbit and clock
215differences. GPS satellite G05 and GLONASS satellite R18 are excluded from this
216comparison. Comparison results are saved in a logfile.
217
21821. Configuration File 'Empty.bnc'
219Purpose: Provide an empty example configuration file for BNC which only
220contains the default settings.
221
222(B) Working with Command Line configuration options
223
224The following configuration examples make use of BNC's 'Command Line Interface'
225(CLI). Configuration options are exclusively specified via command line. No
226configuration file is used. Examples are provided as shell scripts for a Linux
227system. They call BNC in 'no window' batch mode (command line option -nw).
228The scripts expect 'Example_Configs' to be the current working directory.
229
23022. Shell Script 'RinexQC.sh'
231Purpose: Equals configuration file example 'RinexQC.bnc', checks the quality of
232a RINEX Version 3 file by means of a multipath analysis. Virtual X-Server
233'Xvfb' is operated while producing plot files in PNG format. BNC is offline.
234All results are saved on disk.
235
23623. Shell Script 'RinexConcat.sh'
237Purpose: Equals configuration file example 'RinexConcat.bnc', concatenates
238several RINEX Version 3 files to produce one compiled file and edit the marker
239name in the file header. The sampling interval is set to 30 seconds. BNC is
240offline.
241
24224. Shell Script 'RinexEph.sh'
243Purpose: Equals configuration file example 'RinexEph.bnc', converts a RTCM
244stream with navigation messages to RINEX Navigation files. The configuration
245pulls a RTCM Version 3 stream with Broadcast Ephemeris coming from the
246real-time EUREF and IGS networks and saves hourly RINEX Version 3 Navigation
247files. BNC runs online until it's terminated after 10 seconds. See
248http://igs.bkg.bund.de/ntrip/ephemeris for further real-time Broadcast
249Ephemeris resources.
250
25125. Shell Script 'ScanLate.sh'
252Purpose: Scan an observation stream for contained RTCM message types, print
253observation latencies. The output is saved in a logfile. Latencies are
254reported every 10 seconds. BNC runs online until it's terminated after 20
255seconds.
256
25726. Shell Script 'RinexObs.sh'
258Purpose: Equals configuration file example 'RinexObs.bnc', converts RTCM
259streams to RINEX Observation files. The configuration pulls streams from two
260Ntrip Broadcasters using Ntrip Version 1 to generate 15min 1Hz RINEX Version 3
261Observation files. See http://igs.bkg.bund.de/ntrip/observations for
262observation stream resources. BNC runs online until it's terminated after 30
263seconds.
264
265(C) Command Line configuration options overwriting Configuration File options
266
267For specific applications you may like to use your own set of standard
268configuration options from a configuration file and update some of its content
269via command line. When using a configuration file and command line configuration
270options together in one BNC call, the command line configuration options will
271always overrule options contained in the configuration file.
272
27327. Shell Script 'CompareSp3.sh'
274Purpose: Equals configuration file example 'CompareSp3.bnc', compares two SP3
275files to calculate RMS values for orbit and clock differences. However, instead
276of excluding GPS satellite G05 and GLONASS satellite R18 from the comparison as
277specified in 'CompareSp3.bnc', GPS satellite G06 and all GLONASS satellites are
278excluded via command line option. BNC runs offline. Comparison results are saved
279in a logfile.
280
281Andrea Stuerze, BKG
282Frankfurt, June 2022
283igs-ip@bkg.bund.de
284
Note: See TracBrowser for help on using the repository browser.