source: ntrip/trunk/ntripserver/README@ 1161

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

init file option extended for serial ports

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