source: ntrip/trunk/ntripserver/README@ 548

Last change on this file since 548 was 548, checked in by stuerze, 16 years ago

Ntrip Version 2.0 hints added

File size: 8.5 KB
Line 
1----------------------------------------------------------------------
2 ntripserver
3----------------------------------------------------------------------
4
5(c) German Federal Agency for Cartography and Geodesy (BKG), 2002-2007
6
7
8Files in ntripserver.tgz
9------------------------
10- ntripserver.tar: ntripserver program tar archive
11- makefile: preconfigured makefile for convenient installation
12- ntripserver.c: c source file
13- README: Readme file for the ntripserver program
14- startntripserver.sh: shell script to start the ntripserver program
15
16
17NTRIP
18-----
19The ntripserver is a HTTP client based on "Networked Transport of
20RTCM via Internet Protocol" (NTRIP). This is an application-level
21protocol streaming Global Navigation Satellite System (GNSS) data
22over the Internet.
23NTRIP Version 1.0 is a generic, stateless protocol based on the
24Hypertext Transfer Protocol HTTP/1.1. The HTTP objects are
25enhanced to GNSS data streams.
26
27The primary motivation for NTRIP Version 2.0 is to develop a fully
28HTTP-compatible Internet protocol standard that would work with proxy
29servers and to add an optional data transport via UDP. Hence, one
30NTRIP Version 2.0 transport approach is still based on HTTP1.1 on top
31of TCP. The second NTRIP Version 2.0 transport approach is based on
32both, the Internet Standard Protocol RTSP (Real Time Streaming Protocol)
33for stream control on top of TCP and the Internet Standard Protocol RTP
34(Real Time Transport Protocol) for data transport on top of
35connectionless UDP.
36
37NTRIP is designed for disseminating differential correction data
38(e.g in the RTCM-104 format) or other kinds of GNSS streaming data to
39stationary or mobile users over the Internet, allowing simultaneous
40PC, Laptop, PDA, or receiver connections to a broadcasting host. NTRIP
41supports wireless Internet access through Mobile IP Networks like GSM,
42GPRS, EDGE, or UMTS.
43
44NTRIP is implemented in three system software components:
45NTRIP clients, NTRIP servers and NTRIP casters. The NTRIP caster is the
46actual HTTP server program whereas NTRIP client and NTRIP server are
47acting as HTTP clients.
48
49
50ntripserver
51-----------
52The program ntripserver is designed to provide real-time data
53from a single NTRIP source running under a POSIX operating system.
54
55Basically the ntripserver grabs a GNSS byte stream (Input, Source)
56from either
57
581. a Serial port, or
592. an IP server, or
603. a File, or
614. a SISNeT Data Server, or
625. a UDP server, or
636. an NTRIP Version 1.0 Caster
64
65and forwards that incoming stream to either
66
671. an NTRIP Version 2.0 Caster via TCP/IP (Output, Destination), or
682. an NTRIP Version 2.0 Caster via RTSP/RTP (Output, Destination), or
693. an NTRIP Version 1.0 Caster.
70
71Please note, the options to support NTRIP Version 2.0 are currently still
72under development and should be used with care. Keep in mind that details
73of the NTRIP Version 2.0 transport protocol are still under discussion
74and may be changed.
75
76
77Installation
78------------
79To install the program run
80
81- gunzip ntripserver.tgz
82- tar -xf ntripserver.tar
83- make, or
84- make debug (for debugging purposes).
85
86The exacutable will show up as ntripserver.
87
88
89Usage
90-----
91The user may call the program with the following options:
92
93-h|? print this help screen
94
95-E <ProxyHost> Proxy server host name or address, required i.e. when
96 running the program in a proxy server protected LAN,
97 optional
98-F <ProxyPort> Proxy server IP port, required i.e. when running
99 the program in a proxy server protected LAN, optional
100-R <maxDelay> Reconnect mechanism with maximum delay between reconnect
101 attemts in seconds, default: no reconnect activated,
102 optional
103
104-M <InputMode> Sets the input mode (1 = Serial Port, 2 = IP server,
105 3 = File, 4 = SISNeT Data Server, 5 = UDP server, 6 = NTRIP Caster),
106 mandatory
107
108 <InputMode> = 1 (Serial Port):
109 -i <Device> Serial input device, default: /dev/gps, mandatory if
110 <InputMode>=1
111 -b <BaudRate> Serial input baud rate, default: 19200 bps, mandatory
112 if <InputMode>=1
113
114 <InputMode> = 2|5 (IP port | UDP port):
115 -H <ServerHost> Input host name or address, default: 127.0.0.1,
116 mandatory if <InputMode> = 2|5
117 -P <ServerPort> Input port, default: 1025, mandatory if <InputMode>= 2|5
118 -f <ServerFile> Name of initialization file to be send to server,
119 optional
120 -x <ServerUser> User ID to access incoming stream, optional
121 -y <ServerPass> Password, to access incoming stream, optional
122 -B Bind to incoming UDP stream, optional for <InputMode> = 5
123
124 <InputMode> = 3 (File):
125 -s <File> File name to simulate stream by reading data from (log)
126 file, default is /dev/stdin, mandatory for <InputMode> = 3
127
128 <InputMode> = 4 (SISNeT Data Server):
129 -H <SisnetHost> SISNeT Data Server name or address,
130 default: 131.176.49.142, mandatory if <InputMode> = 4
131 -P <SisnetPort> SISNeT Data Server port, default: 7777, mandatory if
132 <InputMode> = 4
133 -u <SisnetUser> SISNeT Data Server user ID, mandatory if <InputMode> = 4
134 -l <SisnetPass> SISNeT Data Server password, mandatory if <InputMode> = 4
135 -V <SisnetVers> SISNeT Data Server Version number, options are 2.1, 3.0
136 or 3.1, default: 3.1, mandatory if <InputMode> = 4
137
138 <InputMode> = 6 (NTRIP Version 1.0 Caster):
139 -H <SourceHost> Source caster name or address, default: 127.0.0.1,
140 mandatory if <InputMode> = 6
141 -P <SourcePort> Source caster port, default: 2101, mandatory if
142 <InputMode> = 6
143 -D <SourceMount> Source caster mountpoint for stream input, mandatory if
144 <InputMode> = 6
145 -U <SourceUser> Source caster user Id for input stream access, mandatory
146 for protected streams if <InputMode> = 6
147 -W <SourcePass> Source caster password for input stream access, mandatory
148 for protected streams if <InputMode> = 6
149
150-O <OutputMode> Sets output mode for communatation with destination caster, optional
151 1 = http: NTRIP Version 2.0 Caster in TCP/IP mode
152 2 = rtsp: NTRIP Version 2.0 Caster in RTSP/RTP mode
153 3 = ntrip1: NTRIP Version 1.0 Caster
154
155 Defaults to NTRIP Version 1.0, but will change to 2.0 in future versions
156 Note that the program automatically falls back from mode rtsp to mode http and
157 further to mode ntrip1 if necessary.
158
159 -a <DestHost> Destination caster name or address, default: 127.0.0.1,
160 mandatory
161 -p <DestPort> Destination caster port, default: 2101, mandatory
162 -m <DestMount> Destination caster mountpoint for stream upload,
163 mandatory
164 -n <DestUser> Destination caster user ID for stream upload to
165 mountpoint, only for NTRIP Version 2.0 destination
166 casters, mandatory
167 -c <DestPass> Destination caster password for stream upload to
168 mountpoint, mandatory
169 -N <STR-record> Sourcetable STR-record
170 optional for NTRIP Version 2.0 in RTSP/RTP and TCP/IP mode
171
172
173Example1: Reading from serial port and forward to NTRIP Version 1.0 Caster:
174
175./ntripserver -M 1 -i /dev/ttys0 -b 9600 -O 2 -a www.euref-ip.net -p 2101 -m Mount2
176 -n serverID -c serverPass
177
178Example2: Reading from NTRIP Version 1.0 Caster and forward to NTRIP Version 2.0
179
180./ntripserver -M 6 -H www.euref-ip.net -P 2101 -D Mount1 -U clientID -W clientPass
181 -O 1 -a www.goenet-ip.fi -p 2101 -m Mount2 -n serverID -c serverPass
182
183
184NTRIP Caster password and mountpoint
185------------------------------------
186Feeding data streams into the NTRIP system using the ntripserver
187program needs a password (and a user ID for NTRIP Version 2.0)
188and one mountpoint per stream.
189For the NTRIP Broadcasters EUREF-IP or IGS-IP this is currently
190available from http://igs.bkg.bund.de/index_ntrip_prov.htm
191
192
193Disclaimer
194----------
195Note that this example server implementation is currently an
196experimental software. The BKG disclaims any liability nor
197responsibility to any person or entity with respect to any loss or
198damage caused, or alleged to be caused, directly or indirectly by the
199use and application of the NTRIP technology.
200
201
202Further information
203-------------------
204URL: http://igs.bkg.bund.de/index_ntrip.htm
205E-mail: euref-ip@bkg.bund.de
Note: See TracBrowser for help on using the repository browser.