Index: trunk/ntripserver/README =================================================================== --- trunk/ntripserver/README (revision 9404) +++ trunk/ntripserver/README (revision 9448) @@ -3,5 +3,5 @@ ---------------------------------------------------------------------- -(c) German Federal Agency for Cartography and Geodesy (BKG), 2002-2019 +(c) German Federal Agency for Cartography and Geodesy (BKG), 2002-2021 @@ -51,26 +51,22 @@ from a single NTRIP source running under a POSIX operating system. -Basically the ntripserver grabs a GNSS byte stream (Input, Source) +The purpose of this program is to pick up a GNSS data stream (Input, Source) from either -1. a Serial port, or -2. an IP server, or -3. a File, or -4. a SISNeT Data Server, or -5. a UDP server, or -6. an NTRIP Version 1.0 Caster - -and forwards that incoming stream to either - -1. an NTRIP Version 2.0 Caster via TCP/IP (Output, Destination), or -2. an NTRIP Version 2.0 Caster via RTSP/RTP (Output, Destination), or -3. an NTRIP Version 2.0 Caster via plain UDP (Output, Destination), or -4. an NTRIP Version 1.0 Caster. - -Please note, the options to support NTRIP Version 2.0 are currently still -under development and should be used with care. Keep in mind that details -of the NTRIP Version 2.0 transport protocol are still under discussion -and may be changed. - + 1. a Serial port, or + 2. an IP server, or + 3. a File, or + 4. a SISNeT Data Server, or + 5. a UDP server, or + 6. an NTRIP Version 1.0 Caster + 7. an NTRIP Version 2.0 Caster in HTTP mode + +and forward that incoming stream (Output, Destination) to either + + 1. an NTRIP Version 2.0 Caster via TCP/IP (Output, Destination), or + 2. an NTRIP Version 2.0 Caster via RTSP/RTP (Output, Destination), or + 3. an NTRIP Version 2.0 Caster via plain UDP (Output, Destination), or + 4. an NTRIP Version 1.0 Caster, or + 5. an IP server via TCP/IP Installation @@ -98,86 +94,80 @@ The user may call the program with the following options: --h|? print this help screen - --E Proxy server host name or address, required i.e. when - running the program in a proxy server protected LAN, - optional --F Proxy server IP port, required i.e. when running - the program in a proxy server protected LAN, optional --R Reconnect mechanism with maximum delay between reconnect - attemts in seconds, default: no reconnect activated, - optional - --M Sets the input mode (1 = Serial Port, 2 = IP server, - 3 = File, 4 = SISNeT Data Server, 5 = UDP server, 6 = NTRIP Caster), - mandatory - - = 1 (Serial Port): (using 8-N-1 = data bits-parity-stop bits) - -i Serial input device, default: /dev/gps, mandatory if - =1 - -b Serial input baud rate, default: 19200 bps, mandatory - if =1 - -f Name of initialization file to be send to input device, - optional - - = 2|5 (IP port | UDP port): - -H Input host name or address, default: 127.0.0.1, - mandatory if = 2|5 - -P Input port, default: 1025, mandatory if = 2|5 - -f Name of initialization file to be send to server, - optional - -x User ID to access incoming stream, optional - -y Password, to access incoming stream, optional - -B Bind to incoming UDP stream, optional for = 5 - - = 3 (File): - -s File name to simulate stream by reading data from (log) - file, default is /dev/stdin, mandatory for = 3 - - = 4 (SISNeT Data Server): - -H SISNeT Data Server name or address, - default: 131.176.49.142, mandatory if = 4 - -P SISNeT Data Server port, default: 7777, mandatory if - = 4 - -u SISNeT Data Server user ID, mandatory if = 4 - -l SISNeT Data Server password, mandatory if = 4 - -V SISNeT Data Server Version number, options are 2.1, 3.0 - or 3.1, default: 3.1, mandatory if = 4 - - = 6 (NTRIP Version 1.0 Caster): - -H Source caster name or address, default: 127.0.0.1, - mandatory if = 6 - -P Source caster port, default: 2101, mandatory if - = 6 - -D Source caster mountpoint for stream input, mandatory if - = 6 - -U Source caster user Id for input stream access, mandatory - for protected streams if = 6 - -W Source caster password for input stream access, mandatory - for protected streams if = 6 - --O Sets output mode for communatation with destination caster - 1 = http: NTRIP Version 2.0 Caster in TCP/IP mode - 2 = rtsp: NTRIP Version 2.0 Caster in RTSP/RTP mode - 3 = ntrip1: NTRIP Version 1.0 Caster - 4 = udp: NTRIP Version 2.0 Caster in Plain UDP mode - optional - - Defaults to NTRIP1.0, but will change to 2.0 in future versions - Note that the program automatically falls back from mode rtsp to mode http and - further to mode ntrip1 if necessary. - - -a Destination caster name or address, default: 127.0.0.1, - mandatory - -p Destination caster port, default: 2101, mandatory - -m Destination caster mountpoint for stream upload, - mandatory - -n Destination caster user ID for stream upload to - mountpoint, only for NTRIP Version 2.0 destination - casters, mandatory - -c Destination caster password for stream upload to - mountpoint, mandatory - -N Sourcetable STR-record - optional for NTRIP Version 2.0 in RTSP/RTP and TCP/IP mode +./ntripserver [OPTIONS] + + -h|? print this help screen + + -E Proxy server host name or address, required i.e. when + running the program in a proxy server protected LAN, + optional + -F Proxy server IP port, required i.e. when running + the program in a proxy server protected LAN, optional + -R Reconnect mechanism with maximum delay between reconnect + attemts in seconds, default: no reconnect activated, + optional + -M Sets the input mode (1 = Serial Port, 2 = IP server, + 3 = File, 4 = SISNeT Data Server, 5 = UDP server, 6 = NTRIP1 Caster, + 7 = NTRIP2 Caster in HTTP mode), + mandatory + = 1 (Serial Port): + -i Serial input device, default: /dev/gps, mandatory if + =1 + -b Serial input baud rate, default: 19200 bps, mandatory + if =1 + -f Name of initialization file to be send to input device, + optional + = 2|5 (IP port | UDP port): + -H Input host name or address, default: 127.0.0.1, + mandatory if = 2|5 + -P Input port, default: 1025, mandatory if = 2|5 + -f Name of initialization file to be send to server, + optional + -x User ID to access incoming stream, optional + -y Password, to access incoming stream, optional + -B Bind to incoming UDP stream, optional for = 5 + = 3 (File): + -s File name to simulate stream by reading data from (log) + file, default is /dev/stdin, mandatory for = 3 + = 4 (SISNeT Data Server): + -H SISNeT Data Server name or address, + default: 131.176.49.142, mandatory if = 4 + -P SISNeT Data Server port, default: 7777, mandatory if + = 4 + -u SISNeT Data Server user ID, mandatory if = 4 + -l SISNeT Data Server password, mandatory if = 4 + -V SISNeT Data Server Version number, options are 2.1, 3.0 + or 3.1, default: 3.1, mandatory if = 4 + = 6|7 (NTRIP Version 1.0|2.0 Caster): + -H Source caster name or address, default: 127.0.0.1, + mandatory if = 6|7 + -P Source caster port, default: 2101, mandatory if + = 6|7 + -D Source caster mountpoint for stream input, mandatory if + = 6|7 + -U Source caster user Id for input stream access, mandatory + for protected streams if = 6|7 + -W Source caster password for input stream access, mandatory + for protected streams if = 6|7 + -O Sets output mode for communication with destination caster / server + 1 = http : NTRIP Version 2.0 Caster in TCP/IP mode + 2 = rtsp : NTRIP Version 2.0 Caster in RTSP/RTP mode + 3 = ntrip1: NTRIP Version 1.0 Caster + 4 = udp : NTRIP Version 2.0 Caster in Plain UDP mode + 5 = tcpip : IP server in TCP/IP mode + Defaults to NTRIP1.0, but will change to 2.0 in future versions + Note that the program automatically falls back from mode rtsp to mode http and + further to mode ntrip1 if necessary. + -a Destination caster/server name or address, default: 127.0.0.1, + mandatory + -p Destination caster/server port, default: 2101, + mandatory + -m Destination caster mountpoint for stream upload, + only for NTRIP destination casters, mandatory + -n Destination caster user ID for stream upload to mountpoint, + only for NTRIP Version 2.0 destination casters, mandatory + -c Destination caster password for stream upload to mountpoint, + only for NTRIP destination casters, mandatory + -N Sourcetable STR-record + optional for NTRIP Version 2.0 in RTSP/RTP and TCP/IP mode @@ -198,7 +188,6 @@ program needs a password (and a user ID for NTRIP Version 2.0) and one mountpoint per stream. -For the NTRIP Broadcasters EUREF-IP or IGS-IP this is currently -available from https://igs.bkg.bund.de/ntrip/registerprovider - +For the NTRIP Broadcasters EUREF-IP or IGS-IP please contact +euref-ip@bkg.bund.de or igs-ip@bkg.bund.de Disclaimer