Changeset 7562 in ntrip


Ignore:
Timestamp:
Oct 29, 2015, 7:56:36 PM (9 years ago)
Author:
weber
Message:

Documentation completed

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/BNC/Example_Configs/00_Readme.txt

    r7499 r7562  
    22
    33BNC comes with a number of configuration examples which can be used on all
    4 operating systems. You may use a statically linked BNC executable to run the
    5 configuration examples. Configuration 'PPPGoogleMaps.bnc' is an exception
    6 from this because it requires a shared library BNC build.
    7 
    8 If not already done then copy the complete directory 'Example_Configs' to you
    9 disc. It contains sub-directories 'Input' and 'Output'. There are several ways to
    10 start BNC using one of the example configurations:
    11 
    12 * On graphical systems (except for Mac systems) you may use the computer mouse to
    13   'drag' a configuration file icon and 'drop' it on top of BNC's program icon.
    14 * On non-graphical systems you may start BNC using a command line with the
    15   following option for a configuration file (example for Windows systems):
    16   bnc.exe --conf <configFileName> --nw
    17 
    18 Although it's not a must, we suggest that you always create BNC configuration
    19 files with the file name extension '.bnc'.
    20 
    21 We furthermore suggest for convenience reasons that you configure your system
    22 to automatically start BNC when you double-click a file with the file name
     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
    2325extension '.bnc'. The following describes what to do on Windows systems to
    2426associate the BNC program to such configuration files:
    2527
    26 1. Right-click a file that has the extension '.bnc' and then click 'Open'. If the
    27    'Open' command is not available, click 'Open With' or double-click the file.
    28 2. Windows displays a dialog box that says that the system cannot open this file.
    29    The dialog box offers several options for selecting a program.
    30 3. Click 'Select the program from a list', and then click 'OK'.
    31 4. The 'Open With' dialog box is displayed. Click 'Browse', locate and then click
    32    the BNC program, and then click 'Open'.
    33 5. Click to select the 'Always use the selected program to open this kind of file'
    34    check box.
    35 6. Click 'OK'.
    36 
    37 Some of the presented example configuration files contain a user ID 'Example'
    38 with a password 'Configs' for accessing a few GNSS streams from public Ntrip
     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
    3948Broadcasters. This generic account is arranged for convenience reasons only.
    4049Please be so kind as to replace the generic account details as well as the
    4150place holders 'User' and 'Pass' by the personal user ID and password you
    42 receive following an online registration through 
     51receive following an online registration through
    4352http://register.rtcm-ntrip.org.
    4453
    45 Note that the account for an Ntrip Broadcaster is usually limited to pulling a
    46 specified maximum number of streams at the same time. As running some of the
    47 example configurations requires pulling several streams, it is suggested to
    48 make sure that you don't exceed your account's limits.
    49 
    50 Make also sure that sub-directories 'Input' and 'Output' which are part of the
    51 example configurations exist on your system or adjust the affected example
    52 configuration options according to your needs.
    53 
    54 Some BNC options require antenna phase center variations as made available from
    55 IGS through so-called ANTEX files at ftp://igs.org/pub/station/general. An
    56 example ANTEX file 'igs08.atx' is part of the BNC package for convenience.
    57 
    58 The example configurations assume that no proxy protects your BNC host. Should
    59 a proxy be operated in front of BNC then you need to introduce its IP and port
    60 in the 'Network' tab of the example configurations.
     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 ftp://igs.org/pub/station/general.
     65An example ANTEX file 'igs08.atx' is part of the BNC package for convenience.
     66
     67The example configurations assume that no proxy protects your BNC host.
     68Should a proxy be operated in front of BNC then you need to introduce its
     69name or IP and port number in the 'Network' panel.
    6170
    6271You should be able to run all configuration examples without changing their
    6372options. However, configurations 'Upload.bnc' and 'UploadPPP.bnc' are
    64 exceptions because they require an input stream from a connected GNSS network
    65 engine.
    66 
    67 1. File 'RinexObs.bnc'
     73exceptions because they require an input stream from a connected network engine.
     74
     751.  File 'RinexObs.bnc'
    6876The purpose of this configuration is showing how to convert RTCM streams to
    69 RINEX. The configuration pulls two streams from Ntrip Broadcasters using
    70 Ntrip version 2 to generate 15min 1Hz RINEX Version 3 observation files.
    71 Note that network option 'Ignore SSL authorization errors' is set in order
    72 to allow pulling RINEX skeleton files via HTTPS when necessary. See
    73 http://igs.bkg.bund.de/ntrip/observations for observation stream resources.
    74 
    75 2. File 'RinexEph.bnc'
     77RINEX Observation files. The configuration pulls streams from Ntrip
     78Broadcasters using Ntrip version 1 to generate 15min 1Hz RINEX Version 3
     79Observation files. See http://igs.bkg.bund.de/ntrip/observations for
     80observation stream resources.
     81
     822.  File 'RinexEph.bnc'
    7683The purpose of this configuration is showing how to convert a RTCM stream
    77 carrying navigation messages to RINEX Navigation files. The configuration
    78 pulls a RTCM Version 3 stream with Broadcast Ephemeris coming from the
    79 real-time EUREF, IGS and M-GEX networks. It saves hourly RINEX Version 3
    80 Navigation files. See http://igs.bkg.bund.de/ntrip/ephemeris for further
    81 real-time Broadcast Ephemeris resources.
    82 
    83 3. File 'BrdcCorr.bnc'
    84 The purpose of this configuration is to save Broadcast Corrections from RTCM
    85 SSR messages in a plain ASCII format as hourly files. Depending on the
    86 Broadcast Corrections stream the file may contain orbit and clock
    87 corrections as well as code and phase biases. Information on correction
    88 streams from IGS and EUREF resources is available from
    89 http://igs.bkg.bund.de/ntrip/orbits.
    90 
    91 4. File 'RinexConcat.bnc'
    92 The purpose of this configuration is to concatenate RINEX Version 3 files to
    93 produce a concatenated file and edit the marker name in the file header. The
     84carrying navigation messages to a RINEX Navigation files. The configuration
     85pulls an RTCM Version 3 stream with Broadcast Ephemeris coming from the
     86real-time EUREF and IGS networks. It saves hourly RINEX Version 3 Navigation
     87files. See http://igs.bkg.bund.de/ntrip/ephemeris for further real-time
     88Broadcast Ephemeris resources.
     89
     903.  File 'BrdcCorr.bnc'
     91The purpose of this configuration is to save Broadcast Corrections from
     92RTCM SSR messages in a plain ASCII format as hourly files. See
     93http://igs.bkg.bund.de/ntrip/orbits for further real-time IGS or EUREF
     94orbit/clock products.
     95
     964.  File 'RinexConcat.bnc'
     97The purpose of this configuration is to concatenate RINEX Version 3 files
     98to produce a concatenated file and edit the marker name in the file header. The
    9499sampling interval is set to 30 seconds. See section 'RINEX Editing & QC' in the
    95100documentation for examples on how to call BNC from command line in 'no window'
    96 mode for RINEX file editing, concatenation and quality checks. 
    97 
    98 5. File 'RinexQC.bnc'
    99 The purpose of this configuration is to check the quality of a RINEX Version 3
    100 file through a multipath analysis. The results is saved in disk in terms of a
    101 plot in PNG format. See section 'RINEX Editing & QC' in the documentation for
    102 examples on how to call BNC from command line in 'no window' mode for RINEX
    103 file editing, concatenation and quality checks.
    104 
    105 6. File 'RTK.bnc'
    106 The purpose of this configuration is to feed a serial connected receiver with
    107 observations from a reference station for conventional RTK. The stream is
     101mode for RINEX file editing, concatenation and quality checks.
     102
     1035.  File 'RinexQC.bnc'
     104The purpose of this configuration is to check the quality of a RINEX
     105Version 3 file through a multipath analysis. The results are saved on disk in
     106terms of a plot in PNG format. See section 'RINEX Editing & QC' in the
     107documentation for examples on how to call BNC from command line in 'no window'
     108mode for RINEX file editing, concatenation and quality checks.
     109
     1106.  File 'RTK.bnc'
     111The purpose of this configuration is to feed a serial connected receiver
     112with observations from a reference station for conventional RTK. The stream is
    108113scanned for RTCM messages. Message type numbers and latencies of incoming
    109 observation are reported in BNC's logfile. 
    110 
    111 7. File 'FeedEngine.bnc'
     114observation are reported in BNC's logfile.
     115
     1167.  File 'FeedEngine.bnc'
    112117The purpose of this configuration is to feed a real-time GNSS engine with
    113118observations from a remote reference stations. The configuration pulls a single
    114 stream from an NTRIP Broadcasters. It would of course be possible to pull
     119stream from an Ntrip Broadcasters. It would of course be possible to pull
    115120several streams from different casters. Incoming observations are decoded,
    116121synchronized and output through a local IP port and saved into a file. Failure
    117 and recovery thresholds are specified to inform about outages. 
    118 
    119 8. File 'PPP.bnc'
     122and recovery thresholds are specified to inform about outages.
     123
     1248.  File 'PPP.bnc'
    120125The purpose of this configuration is Precise Point Positioning from
    121126observations of a rover receiver. The configuration reads RTCM Version 3
    122127observations, a Broadcast Ephemeris stream and a stream with Broadcast
    123 Corrections. Positions are saved in the logfile. 
    124 
    125 9. File 'PPPNet.bnc'
    126 The purpose of this configuration is to demonstrate siumultaneous Precise
     128Corrections. Positions are saved in the logfile.
     129
     1309.  File 'PPPNet.bnc'
     131The purpose of this configuration is to demonstrate simultaneous Precise
    127132Point Positioning for several rovers or several receivers from a network of
    128133reference stations in one BNC job. The possible maximum number of PPP solutions
    … …  
    130135configuration reads two RTCM Version 3 observation streams, a Broadcast
    131136Ephemeris stream and a stream with Broadcast Corrections. PPP Results for the
    132 two stations are saved in PPP logfiles. 
     137two stations are saved in PPP logfiles.
    133138
    13413910. File 'PPPQuickStart.bnc'
    135 The purpose of this configuration is Precise Point Positioning in Quick-Start
    136 mode from observations of a static receiver with precisely known position. The
    137 configuration reads RTCM Version 3 observations, Broadcast Corrections and a
    138 Broadcast Ephemeris stream. Positions are saved in NMEA format on disc.
    139 Positions are also output through IP port for real-time visualization with
    140 tools like RTKPLOT. Positions are also saved in the logfile.
     140The purpose of this configuration is Precise Point Positioning in
     141Quick-Start mode from observations of a static receiver with precisely known
     142position. The configuration reads RTCM Version 3 observations, Broadcast
     143Corrections and a Broadcast Ephemeris stream. Positions are saved in NMEA
     144format on disc. Positions are also output through IP port for real-time
     145visualization with tools like RTKPLOT. Positions are also saved in the logfile.
    141146
    14214711. File 'PPPPostProc.bnc'
    … …  
    146151support the Quick-Start mode. The output is saved in a specific Post Processing
    147152logfile and contains the coordinates derived over time following the
    148 implemented PPP filter algorithm. 
     153implemented PPP filter algorithm.
    149154
    15015512. File 'PPPGoogleMaps.bnc'
    151 The purpose of this configuration is to track BNC's point positioning
    152 solution using Google Maps or Open StreetMap as background. BNC reads a
    153 RINEX Observation file and a RINEX Navigation file to carry out a
    154 'Standard Point Positioning' solution in post-processing mode. Although
    155 this is not a real-time application it requires the BNC host to be connected
    156 to the Internet. Specify a computation speed, then hit button 'Open Map'
    157 to open the track map, then hit 'Start' to visualize receiver positions
    158 on top of GM/OSM maps.
     156The purpose of this configuration is to track BNC's point positioning
     157solution using Google Maps or OpenStreetMap as background. BNC reads a RINEX
     158Observation file and a RINEX Navigation file to carry out a 'Standard Point
     159Positioning' solution in post-processing mode. Although this is not a real-time
     160application it requires the BNC host to be connected to the Internet. Specify a
     161computation speed, then hit button 'Open Map' to open the track map, then hit
     162'Start' to visualize receiver positions on top of GM/OSM maps.
    159163
    16016413. File 'SPPQuickStartGal.bnc'
    161 The purpose of this configuration is Single Point Positioning in Quick-Start
    162 mode from observations of a static receiver with precisely known position. The
    163 configuration uses GPS, GLONASS and Galileo observations and a Broadcast
    164 Ephemeris stream.
     165The purpose of this configuration is Single Point Positioning in
     166Quick-Start mode from observations of a static receiver with precisely known
     167position. The configuration uses GPS, GLONASS and Galileo observations and a
     168Broadcast Ephemeris stream.
    165169
    16617014. File 'SaveSp3.bnc'
    … …  
    169173stream is formally introduced in BNC's 'Combine Corrections' table. Note that
    170174producing SP3 requires an ANTEX file because SP3 file contents should be
    171 referred to CoM. 
     175referred to CoM.
    172176
    17317715. File 'Sp3ETRF2000PPP.bnc'
    … …  
    178182to ETRF2000. Pulling in addition observations from a reference station at
    179183precisely known ETRF2000 position allows comparing an 'INTERNAL' PPP solution
    180 with ETRF2000 reference coordinates. 
     184with ETRF2000 reference coordinates.
    181185
    18218616. File 'Upload.bnc'
    183187The purpose of this configuration is to upload orbits and clocks from a
    184 real-time GNSS engine to an NTRIP Broadcaster. For that the configuration reads
     188real-time GNSS engine to an Ntrip Broadcaster. For that the configuration reads
    185189precise orbits and clocks in RTNET format. It also reads a stream carrying
    186190Broadcast Ephemeris. BNC converts the orbits and clocks into Broadcast
    187191Corrections and encodes them in RTCM Version 3 SSR messages to upload them to
    188 an NTRIP Broadcaster. The Broadcast Corrections stream is referred to satellite
     192an Ntrip Broadcaster. The Broadcast Corrections stream is referred to satellite
    189193Antenna Phase Center (APC) and IGS08. Orbits are saved on disk in SP3 format
    190 and clocks in Clock RINEX format. 
     194and clocks in Clock RINEX format.
    191195
    19219617. File 'UploadPPP.bnc'
    … …  
    195199on observations from a static reference station with known precise coordinates.
    196200This allows a continuous quality check of the Broadcast Corrections through
    197 observing coordinate displacements. 
     201observing coordinate displacements.
    198202
    19920318. File 'Combi.bnc'
    200 The purpose of this configuration is to pull several streams carrying Broadcast
    201 Corrections and a Broadcast Ephemeris stream from an NTRIP Broadcaster to
    202 produce a combined Broadcast Corrections stream. BNC encodes the combination
    203 product in RTCM Version 3 SSR messages and uploads that to an Ntrip
     204The purpose of this configuration is to pull several streams carrying
     205Broadcast Corrections and a Broadcast Ephemeris stream from an Ntrip
     206Broadcaster to produce a combined Broadcast Corrections stream. BNC encodes the
     207combination product in RTCM Version 3 SSR messages and uploads that to an Ntrip
    204208Broadcaster. The Broadcast Corrections stream is not referred to satellite
    205209Center of Mass (CoM). It is referred to IGS08. Orbits are saved in SP3 format
    206 and clocks in Clock RINEX format. 
     210and clocks in Clock RINEX format.
    207211
    20821219. File 'CombiPPP.bnc'
    209 This configuration equals the 'Combi.bnc' configuration. However, the combined
    210 Broadcast Corrections are in addition used for an 'INTERNAL' PPP solutions
    211 based on observations from a static reference station with known precise
    212 coordinates. This allows a continuous quality check of the combination product
    213 through observing coordinate displacements.
     213This configuration equals the 'Combi.bnc' configuration. However, the
     214combined Broadcast Corrections are in addition used for an 'INTERNAL' PPP
     215solutions based on observations from a static reference station with known
     216precise coordinates. This allows a continuous quality check of the combination
     217product through observing coordinate displacements.
    214218
    21521920. File 'UploadEph.bnc'
    216 The purpose of this configuration is to pull a number of streams from reference
    217 stations to get hold of contained Broadcast Ephemeris messages. These are
    218 encoded then in a RTCM Version 3 stream which only provides Broadcast Ephemeris
    219 with an update rate of 5 seconds.
     220The purpose of this configuration is to pull a number of streams from
     221reference stations to get hold of contained Broadcast Ephemeris messages. These
     222are encoded then in a RTCM Version 3 stream which only provides Broadcast
     223Ephemeris with an update rate of 5 seconds.
    220224
    22122521. File 'CompareSp3.bnc'
    … …  
    223227RMS values for orbit and clock differences. GPS satellite G05 and GLONASS
    224228satellite R18 are excluded from this comparison. Comparison results are saved
    225 in a logfile. 
     229in a logfile.
    226230
    22723122. File 'Empty.bnc'
    228 The purpose of this example is to provide an empty configuration file for BNC
    229 which only contains the default settings.
     232The purpose of this example is to provide an empty configuration file for
     233BNC which only contains the default settings.
    230234
    231235Georg Weber, BKG
    232236Frankfurt, November 2015
    233237igs-ip@bkg.bund.de
     238
Note: See TracChangeset for help on using the changeset viewer.