source: ntrip/trunk/ntripserver/README@ 1747

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

minor update - plain udp option

File size: 8.9 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 2.0 Caster via plain UDP (Output, Destination), or
704. an NTRIP Version 1.0 Caster.
71
72Please note, the options to support NTRIP Version 2.0 are currently still
73under development and should be used with care. Keep in mind that details
74of the NTRIP Version 2.0 transport protocol are still under discussion
75and may be changed.
76
77
78Installation
79------------
80To install the program run
81
82- gunzip ntripserver.tgz
83- tar -xf ntripserver.tar
84- make, or
85- make debug (for debugging purposes).
86
87To compile the source code on a Windows system where a mingw gcc
88compiler is available, you may like to run the following command:
89
90- gcc -Wall -W -O3 -DWINDOWSVERSION ntripserver.c -DNDEBUG
91 -o ntripserver -lwsock32, or
92- mingw32-make, or
93- mingw32-make debug
94
95The exacutable will show up as ntripserver on Linux
96or ntripserver.exe on a Windows system.
97
98Usage
99-----
100The user may call the program with the following options:
101
102-h|? print this help screen
103
104-E <ProxyHost> Proxy server host name or address, required i.e. when
105 running the program in a proxy server protected LAN,
106 optional
107-F <ProxyPort> Proxy server IP port, required i.e. when running
108 the program in a proxy server protected LAN, optional
109-R <maxDelay> Reconnect mechanism with maximum delay between reconnect
110 attemts in seconds, default: no reconnect activated,
111 optional
112
113-M <InputMode> Sets the input mode (1 = Serial Port, 2 = IP server,
114 3 = File, 4 = SISNeT Data Server, 5 = UDP server, 6 = NTRIP Caster),
115 mandatory
116
117 <InputMode> = 1 (Serial Port):
118 -i <Device> Serial input device, default: /dev/gps, mandatory if
119 <InputMode>=1
120 -b <BaudRate> Serial input baud rate, default: 19200 bps, mandatory
121 if <InputMode>=1
122 -f <InitFile> Name of initialization file to be send to input device,
123 optional
124
125 <InputMode> = 2|5 (IP port | UDP port):
126 -H <ServerHost> Input host name or address, default: 127.0.0.1,
127 mandatory if <InputMode> = 2|5
128 -P <ServerPort> Input port, default: 1025, mandatory if <InputMode>= 2|5
129 -f <ServerFile> Name of initialization file to be send to server,
130 optional
131 -x <ServerUser> User ID to access incoming stream, optional
132 -y <ServerPass> Password, to access incoming stream, optional
133 -B Bind to incoming UDP stream, optional for <InputMode> = 5
134
135 <InputMode> = 3 (File):
136 -s <File> File name to simulate stream by reading data from (log)
137 file, default is /dev/stdin, mandatory for <InputMode> = 3
138
139 <InputMode> = 4 (SISNeT Data Server):
140 -H <SisnetHost> SISNeT Data Server name or address,
141 default: 131.176.49.142, mandatory if <InputMode> = 4
142 -P <SisnetPort> SISNeT Data Server port, default: 7777, mandatory if
143 <InputMode> = 4
144 -u <SisnetUser> SISNeT Data Server user ID, mandatory if <InputMode> = 4
145 -l <SisnetPass> SISNeT Data Server password, mandatory if <InputMode> = 4
146 -V <SisnetVers> SISNeT Data Server Version number, options are 2.1, 3.0
147 or 3.1, default: 3.1, mandatory if <InputMode> = 4
148
149 <InputMode> = 6 (NTRIP Version 1.0 Caster):
150 -H <SourceHost> Source caster name or address, default: 127.0.0.1,
151 mandatory if <InputMode> = 6
152 -P <SourcePort> Source caster port, default: 2101, mandatory if
153 <InputMode> = 6
154 -D <SourceMount> Source caster mountpoint for stream input, mandatory if
155 <InputMode> = 6
156 -U <SourceUser> Source caster user Id for input stream access, mandatory
157 for protected streams if <InputMode> = 6
158 -W <SourcePass> Source caster password for input stream access, mandatory
159 for protected streams if <InputMode> = 6
160
161-O <OutputMode> Sets output mode for communatation with destination caster
162 1 = http: NTRIP Version 2.0 Caster in TCP/IP mode
163 2 = rtsp: NTRIP Version 2.0 Caster in RTSP/RTP mode
164 3 = ntrip1: NTRIP Version 1.0 Caster
165 4 = udp: NTRIP Version 2.0 Caster in Plain UDP mode
166 optional
167
168 Defaults to NTRIP1.0, but will change to 2.0 in future versions
169 Note that the program automatically falls back from mode rtsp to mode http and
170 further to mode ntrip1 if necessary.
171
172 -a <DestHost> Destination caster name or address, default: 127.0.0.1,
173 mandatory
174 -p <DestPort> Destination caster port, default: 2101, mandatory
175 -m <DestMount> Destination caster mountpoint for stream upload,
176 mandatory
177 -n <DestUser> Destination caster user ID for stream upload to
178 mountpoint, only for NTRIP Version 2.0 destination
179 casters, mandatory
180 -c <DestPass> Destination caster password for stream upload to
181 mountpoint, mandatory
182 -N <STR-record> Sourcetable STR-record
183 optional for NTRIP Version 2.0 in RTSP/RTP and TCP/IP mode
184
185
186Example1: Reading from serial port and forward to NTRIP Version 1.0 Caster:
187
188./ntripserver -M 1 -i /dev/ttys0 -b 9600 -O 2 -a www.euref-ip.net -p 2101 -m Mount2
189 -n serverID -c serverPass
190
191Example2: Reading from NTRIP Version 1.0 Caster and forward to NTRIP Version 2.0
192
193./ntripserver -M 6 -H www.euref-ip.net -P 2101 -D Mount1 -U clientID -W clientPass
194 -O 1 -a www.goenet-ip.fi -p 2101 -m Mount2 -n serverID -c serverPass
195
196
197NTRIP Caster password and mountpoint
198------------------------------------
199Feeding data streams into the NTRIP system using the ntripserver
200program needs a password (and a user ID for NTRIP Version 2.0)
201and one mountpoint per stream.
202For the NTRIP Broadcasters EUREF-IP or IGS-IP this is currently
203available from http://igs.bkg.bund.de/index_ntrip_prov.htm
204
205
206Disclaimer
207----------
208Note that this example server implementation is currently an
209experimental software. The BKG disclaims any liability nor
210responsibility to any person or entity with respect to any loss or
211damage caused, or alleged to be caused, directly or indirectly by the
212use and application of the NTRIP technology.
213
214
215Further information
216-------------------
217URL: http://igs.bkg.bund.de/index_ntrip.htm
218E-mail: euref-ip@bkg.bund.de
Note: See TracBrowser for help on using the repository browser.