-BNS is released under the GNU General Public License (GPL). Binaries for BNS are available for Windows, 32-bit and 64-bit Linux (compiled under -m32 32-bit compatibility mode), Solaris, and Mac OS X systems. The MinGW compiler (Version 5.3.1) is used to produce the Windows binary. It is likely that BNS can be compiled on other systems where a GNU compiler and Qt Version 4.3.2 are available. +BNS is released under the GNU General Public License (GPL). Binaries for BNS are available for Windows, 32-bit and 64-bit Linux (compiled under -m32 32-bit compatibility mode), Solaris, and Mac OS X systems. The MinGW compiler (Version 5.3.1) is used to produce the Windows binary. It is likely that BNS can be compiled on other systems where a GNU compiler and Qt Version 4.4.3 are available.
@@ -22,5 +22,5 @@ 1. Purpose-The current size of the real-time stream produced by BNS is in the order of 5 kbits/sec depending on the number of visible satellites. When uploading the stream to an NTRIP Broadcaster, user needs to ensure that the connection used can sustain the required bandwidth. -
--Running BNS requires the clock of the host computer to be properly synchronized. +
++Apart from its regular window mode, BNS can be run as a background job in a 'no window' mode using processing options from previously saved configuration. +
++BNS requires access to the Internet with a minimum of about 1 kbits/sec per stream depending on the stream format and the number of visible satellites. You need to make sure that the connection can sustain the required bandwidth. +
++It requires the clock of the host computer to be properly synchronized.
@@ -90,37 +93,60 @@-All options for running BNS on Unix/Linux/Mac systems are saved in file ${HOME}/.config/BKG/BKG_NTRIP_Server.conf, see annexed 'Configuration File' example. On Windows systems options are saved in register BKG_NTRIP_Server. The self-explaining contents of the configuration file or the Windows register can easily be edited. -
- -
-4.1. File
-4.2. Help
-4.3. Proxy
-4.4. General
- 4.4.1. Logfile
- 4.4.2. Append Files
-4.5. RINEX Ephemeris
- 4.5.1. Host & Port
- 4.5.2. Save
-4.6. Clocks & Orbits
- 4.6.1. Listening Port
- 4.6.2. Save
-4.7. Ephemeris Corrections
- 4.7.1. Host & Port
- 4.7.2. Mountpoint & Password
- 4.7.3. System
- 4.7.4. Save
-4.8. RINEX Clocks
- 4.8.1. Directory
- 4.8.2. Interval & Sampling
-4.9. SP3 Orbits
- 4.9.1. Directory
- 4.9.2. Interval & Sampling
-4.10. Start
-4.11. Stop
-4.12. No Window
-
+The usual handling of BNS is that you first select severs for 'RINEX Ephemeris' and 'Clocks & Orbits'. You then select an NTRIP broadcaster for stream upload ('Broadcast Corrections') before you start the program ('Start'). Records of BNS's activities are shown in the'Logs' canvas in the middle of the main window. +
+ ++As a default, configuration files for running BNS on Unix/Linux/Mac systems are saved in directory '${HOME}/.config/BKG'. On Windows systems, they are typically saved in directory 'C:/Documents and Settings/Username/.config/BKG'. The default configuration file name is 'BNS.ini'. +
+ ++The default file name 'BNS.ini' can be changed and the file contents can easily be edited. On graphical user interfaces it is possible to Drag & Drop a configuration file icon to start BNS. See annexed 'Configuration Example' for a complete set of configuration options. +
+ +
+4.1. Top Menu Bar
+4.1.1 File
+4.1.2 Help
+4.2. Proxy
+4.3. General
+ 4.3.1. Logfile
+ 4.3.2. Append Files
+ 4.3.3. Auto Start
+4.4. RINEX Ephemeris
+ 4.4.1. Host & Port
+ 4.4.2. Save
+4.5. Clocks & Orbits
+ 4.5.1. Listening Port
+ 4.5.2. Save
+4.6. Broadcast Corrections
+ 4.6.1. Host & Port
+ 4.6.2. Mountpoint & Password
+ 4.6.3. System
+ 4.6.4. Save
+4.7. RINEX Clocks
+ 4.7.1. Directory
+ 4.7.2. Interval & Sampling
+4.8. SP3 Orbits
+ 4.8.1. Directory
+ 4.8.2. Interval & Sampling
+4.9. Bottom Menu Bar
+4.9.1 Start
+4.9.2 Stop
+4.10. Command Line Options
+4.10.1 No Window
+4.10.2 Configuration File
+
+The top menu bar allows to select a font for the BNS windows, save configured options or quit + the program execution. It also provides access to a program documentation. +
+ +@@ -131,6 +157,5 @@ Use smaller font size if the BNS main window extends beyond the size of your screen. -
@@ -162,25 +187,33 @@
-4.3. Proxy - for usage in a protected LAN
-If you are running BNS within a protected Local Area Network (LAN), you might need to use a proxy server to access the Internet. Enter your proxy server IP and port number in case one is operated in front of BNC. If you don't know the address and port of your proxy server, check the proxy server settings in your Internet browser or ask your network administrator. +
4.2. Proxy - for usage in a protected LAN
+If you are running BNS within a protected Local Area Network (LAN), you might need to use a proxy server to access the Internet. Enter your proxy server IP and port number in case one is operated in front of BNS. If you don't know the address and port of your proxy server, check the proxy server settings in your Internet browser or ask your network administrator.
Note 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 Casters. If these are not possible, you might need to run BNS outside your LAN on a host that has unobstructed connection to the Internet.
- - - --Records 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. All times are given in UTC. The default value for 'Log (full path)' is an empty option field, meaning that BNC logs will not saved into a file. -
- - + ++The following describes general settings for BNC's logfile, file handling and auto-start. +
+ + ++Records of BNS'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 BNS and the NTRIP broadcaster as well as problems that may occur in the communication link, stream availability, stream delay, stream conversion etc. All times are given in UTC. The default value for 'Log (full path)' is an empty option field, meaning that BNS logs will not saved into a file. +
+ +When BNS 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 BNS, a system crash or when BNS had 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 BNS.
- + ++You may like to auto-start BNS at startup time in window mode with preassigned configuration options. This may be required i.e. immediately after booting your system. Tick 'Autostart' to supersede the usage of the 'Start' button. Make sure that you maintain a link to BNS for that in your Autostart directory (Windows systems) or call BNS in a script below directory /etc/init.d (Unix/Linux/Mac systems). +
+ +BNS requires GNSS Broadcast Ephemeris in RINEX Version 3 Navigation file format from an IP address and port. This information can be provided in real-time by the 'BKG Ntrip Client' (BNC) program. Note that whenever a new set of Broadcast Ephemeris becomes available, BNS needs it immediately. @@ -208,15 +241,15 @@
- +Enter the IP address and port number of a Broadcast Ephemeris server like BNC to establish a persistent socket connection, see section 'Flow Chart' under 'Help' for socket communication details. If BNS runs on the same host as BNC, 127.0.0.1 should be used as the server's IP address. Make sure that this server is up and running before you start BNS.
- + Specify the full path to a file where received Broadcast Ephemeris will be logged. Beware that the size of this file can rapidly increase. Default is an empty option field meaning that logging is disabled. - +BNS requires GNSS clocks and orbits in the IGS Earth-Centered-Earth-Fixed (ECEF) reference system in SP3 format. They can be provided by a real-time GNSS engine such as RTNet. The sampling rate should not be much greater than 10 sec. Note that otherwise in IP streaming involved tools on the NTRIP Broadcaster or client side may respond with a timeout. @@ -263,20 +296,20 @@
-4.6.1 Listening Port - mandatory
4.5.1 Listening Port - mandatory
BNS is listening at an IP port for incoming GNSS clocks and orbits in SP3 format. Enter the respective IP port number to setup a server socket for incoming data, see section 'Flow Chart' under 'Help' for socket communication details. Make sure that the software providing clocks and orbits is up and running before you start BNS.
- +Specify the full path to a file where received clocks and orbits from a real-time engine will be logged. Beware that the size of this file can rapidly increase. Default is an empty option field meaning that logging is disabled.
- +BNS can upload the resulting stream(s) of clock and orbit corrections to Broadcast Ephemeris to an NTRIP Broadcaster. Both EUREF and IGS operate an NTRIP broadcaster at http://www.euref-ip.net/home and http://www.igs-ip.net/home which can be used for stream upload. The stream's format is RTCM Version 3.x. Note that it only carries the premature message Types 4063 and 4069 for combined orbit and clock corrections to GPS and GLONASS Broadcast Ephemeris.
-BNS allows to configure two Ephemeris Corrections streams refering do different reference systems for upload to different NTRIP broadcasters. You may use this functionality for parallel support of a backup NTRIP broadcaster or for simultaneous support of two reference systems. +BNS allows to configure two Broadcast Corrections streams refering do different reference systems for upload to different NTRIP broadcasters. You may use this functionality for parallel support of a backup NTRIP broadcaster or for simultaneous support of two reference systems.
@@ -285,5 +318,5 @@ - +Enter the NTRIP Caster's 'Host' IP name or number for stream upload. @@ -293,5 +326,5 @@
-4.7.2 Mountpoint & Password - mandatory if 'Host' is set
4.6.2 Mountpoint & Password - mandatory if 'Host' is set
Each stream on an NTRIP Caster is defined using a unique source ID called mountpoint. An NTRIP Server like BNS upload a stream to the Caster by referring to a dedicated mountpoint that has been set by the Caster operator. Specify here the mountpoint based on the detail you received from the operator for your stream. It is often a four character ID (capital letters) plus an integer number. @@ -301,5 +334,5 @@
-4.7.3 System - mandatory if 'Host' is set
4.6.3 System - mandatory if 'Host' is set
BNS refers its clock and orbit corrections to a specific reference system. Available options are @@ -341,5 +374,5 @@ -
+The clock and orbit corrections streamed by BNS to the NTRIP Caster can be logged locally. Specify a full 'Save stream' path here to save this information to a local file. Default value for 'Save stream' is an empty option field, meaning that logging is disabled. @@ -378,15 +411,19 @@
- +The clock corrections generated by BNS can be logged separately in Clock RINEX format. The file naming follows the RINEX convention. -
- - ++ +
+Note that clocks in the Clock RINEX files are not corrected for the 2nd-order relativistic effect. + + +Here you can specify the path to where the Clock RINEX files will be stored. If the specified directory does not exist, BNS will not create Clock RINEX files. Default value for 'Directory' is an empty option field, meaning that logging of Clock RINEX files is disabled.
-4.8.2 Interval & Sampling - mandatory if 'Directory' is set
4.7.2 Interval & Sampling - mandatory if 'Directory' is set
Select the length of the Clock RINEX file generated. The default value is 1 day. @@ -397,15 +434,18 @@
- +The orbit corrections generated by BNS can be logged separately in SP3 Orbit files. The file naming follows the IGS convention.
- - + +Note that clocks in the SP3 Orbit files are not corrected for the 2nd-order relativistic effect. + + +Here you can specify the path to where the SP3 Orbit files will be stored. If the specified directory does not exist, BNS will not create SP3 Orbit files. Default value for 'Directory' is an empty option field, meaning that logging of SP3 Orbit files is disabled.
-4.9.2 Interval & Sampling - mandatory if 'Directory' is set
4.8.2 Interval & Sampling - mandatory if 'Directory' is set
Select the length of the SP3 Orbit file generated. The default value is 1 day. @@ -415,20 +455,45 @@
- + ++The bottom menu bar allows to start or stop the execution of BNS and provides access the BNC's online help funtion. +
+ +Hit 'Start' to start receiving IGS orbits and clocks and convert them into corrections to Broadcast Ephemeris. Note that when started BNS by default will begin with new files which might overwrite existing files when necessary unless the option 'Append files' is ticked.
- +Hit the 'Stop' button in order to stop BNS.
- --On all systems BNS can be started in batch mode with the command line option '-nw'. BNS will then run in 'no window' mode, using options from the configuration file ${HOME}/.config/BKG/BNC_NTRIP_Server.conf (Unix/Linux/Mac, see 'Configuration File' example in the Annex) or from the register BKG_NTRIP_Server (Windows). -
--The self-explanatory contents of the configuration file or the Windows registry can easily be edited. Before editing, terminate BNS first using Windows Task Manager when running it in 'no window' mode on Windows systems. +
++Command line options are available to run BNS in 'no window' mode or let it read a specific configuration file. Note that the self-explaining contents of the configuration file can easily be edited. It is possible to introduce a specific configuration file name instead of using the default name 'BNS.ini'. +
+ + ++Apart from its regular windows mode, BNS can be started on all systems as a background/batch job with command line option '-nw'. BNS will then run in 'no window' mode, using processing options from its configuration file on disk. Terminate BNS using Windows Task Manager when running it in 'no window' mode on Windows systems. +
+
+Example:
+bns.exe -nw
+
4.10.2 Configuration File - optional
+Example:
+./bns --conf MyConfig.ini
+
+This leads to a BNS job using configuration file 'MyConfig.ini'. The configuration file will be saved in the current working directory. +
+ + @@ -465,5 +530,5 @@ 7.2.1 RTCM NTRIP| Dec 2008 | Version 1.0 | [Add] Source code and binaries published. |
| Mar 2009 | Version 1.1 | [Add] New messages for URA and high-rate clocks. |
| Dec 2008 | Version 1.0 | +[Add] Source code and binaries published. | +
| Mar 2009 | Version 1.1 | +[Add] New messages for URA and high-rate clocks. [Add] Upgrade to Qt Version 4.4.3 [Add] Enable/disable tab widgets [Add] User defined configuration file name [mod] Switch to configuration files in ini-Format [Add] Auto start [Add] Drag and drop ini files |
+
-The following is an example of the contents of a Unix/Linux/Mac configuration file ${HOME}/.config/BKG/BKG_NTRIP_Server.conf. It enables the upload of streams CLCK1 and CLCK2 to www.igs-ip.net. Clock RINEX files and SP3 Orbit files are saved to a directory /home/weber/rinex : -
--
-[General] -clkPort=7000 -ephEcho=/home/weber/rinex/eph.rnx -ephHost=clock-ip.bkg.bund.de -ephPort=6000 -fileAppend=0 -font="Helvetica [Adobe],8,-1,5,75,0,0,0,0,0" -inpEcho=/home/weber/rinex/ClocksOrbits.dat -logFile=/home/weber/rinex/bns.log -mountpoint_1=CLCK1 -mountpoint_2=CLCK2 -outFile_1=/home/weber/rinex/CLCK1 -outFile_2=/home/weber/rinex/CLCK2 -beClocks1= -beClocks2= -outHost=www.igs-ip.net -outPort=2101 -password=serverPass -proxyHost= -proxyPort= -refSys_1=IGS05 -refSys_2=ETRS89 -rnxIntr=1 day -rnxPath=/home/weber/rinex -rnxSampl=30 -sp3Intr=1 day -sp3Path=/home/weber/rinex -sp3Sampl=300 + ++The following table's left column is an example for the contents of a configuration file 'BNS.ini'. It enables the upload of streams CLCK1 and CLCK2 to www.igs-ip.net. Clock RINEX files and SP3 Orbit files are saved to a directory /home/weber/rinex : +
+
| Option | Affiliation |
| [General] | Settings: Group |
| proxyHost= | Proxy: Host |
| proxyPort= | Proxy: Port |
| logFile=/home/weber/rinex/bns.log | General: Logfile (full path) |
| fileAppend=0 | General: Append files |
| font="Helvetica [Adobe],8,-1,5,75,0,0,0,0,0" | Internal memory: Used font |
| refSys_1=IGS05 | Broadcast Corrections I: System |
| refSys_2=ETRF2000 | Broadcast Corrections II: System |
| inpEcho=/home/weber/rinex/ClocksOrbits.dat | Clocks & Orbits: Save (full path) |
| ephHost=clock-ip.bkg.bund.de | RINEX Ephemeris: Host |
| ephPort=6000 | RINEX Ephemeris: Port |
| ephEcho=/home/weber/rinex/eph.rnx | RINEX Ephemeris: Save (full path) |
| clkPort=7000 | Clocks & Orbits: Listening port |
| outHost1=www.igs-ip.net | Broadcast Corrections I: Host |
| outPort1=2101 | Broadcast Corrections I: Port |
| outHost2=www.euref-ip.net | Broadcast Corrections II: Host |
| outPort2=2101 | Broadcast Corrections II: Port |
| mountpoint_1=CLCK1 | Broadcast Corrections I: Mountpoint |
| mountpoint_2=CLCK2 | Broadcast Corrections II: Mountpoint |
| outFile_1=/home/weber/rinex/CLCK1 | Broadcast Corrections I: Save (full path) |
| outFile_2=/home/weber/rinex/CLCK2 | Broadcast Corrections II: Save (full path) |
| password1=pw1 | Broadcast Corrections I: Password |
| password2=pw2 | Broadcast Corrections I: Password |
| rnxPath=/home/weber/rinex | RINEX Clocks: Directory |
| rnxIntr=1 day | RINEX Clocks: Interval |
| rnxSampl=30 | RINEX Clocks: Sampling |
| sp3Path=/home/weber/rinex | SP3 Orbits: Directory |
| sp3Intr=1 day | SP3 Orbits: Interval |
| sp3Sampl=300 | SP3 Orbits: Sampling |
| startTab=0 | Internal memory: Top tab |
| autoStart=0 | General: Auto start |
| beClocks1=0 | Broadcast Corrections I: Broadcast clocks |
| beClocks2=0 | Broadcast Corrections I: Broadcast clocks |