source: ntrip/trunk/ntripclient/README @ 580

Last change on this file since 580 was 580, checked in by stuerze, 13 years ago

added Windows compilation hint

File size: 7.7 KB
Line 
1----------------------------------------------------------------------
2                NTRIP Client for POSIX systems
3----------------------------------------------------------------------
4
5Easy example NTRIP client for POSIX systems.
6Copyright (C) 2003-2007 by Dirk Stoecker <soft@dstoecker.de>
7   
8This program is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation; either version 2 of the License, or
11(at your option) any later version.
12
13This program is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with this program; if not, write to the Free Software
20Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21or read http://www.gnu.org/licenses/gpl.txt
22
23Files in ntripclient.tgz
24-----------------------------
25ntripclient.c:    Ntrip POSIX client source code
26README:           Dokumentation
27startntripclient: Shell script to start client
28makefile:         Easy makefile to build source
29
30Ntrip
31-----
32The ntripclient is an HTTP client based on 'Networked Transport
33of RTCM via Internet Protocol' (Ntrip). This is an application-level
34protocol streaming Global Navigation Satellite System (GNSS) data over
35the Internet. Ntrip Version 1.0 is a generic, stateless protocol based
36on the Hypertext Transfer Protocol HTTP/1.1. The HTTP objects are
37enhanced to GNSS data streams.
38
39The primary motivation for Ntrip Version 2.0 is to develop a fully
40HTTP-compatible Internet protocol standard that would work with proxy
41servers and to add an optional data transport via UDP. Hence, one
42Ntrip Version 2.0 transport approach is still based on HTTP1.1 on top
43of TCP. The second Ntrip Version 2.0 transport approach is based on
44both, the Internet Standard Protocol RTSP (Real Time Streaming Protocol)
45for stream control on top of TCP and the Internet Standard Protocol RTP
46(Real Time Transport Protocol) for data transport on top of
47connectionless UDP.
48
49Ntrip is designed for disseminating differential correction data
50(e.g in the RTCM-104 format) or other kinds of GNSS streaming data to
51stationary or mobile users over the Internet, allowing simultaneous PC,
52Laptop, PDA, or receiver connections to a broadcasting host. Ntrip
53supports Wireless Internet access through Mobile IP Networks like GSM,
54GPRS, EDGE, or UMTS.
55
56Ntrip is implemented in three system software components: NtripClients,
57NtripServers and NtripCasters. The NtripCaster is the actual HTTP
58server program whereas NtripClient and NtripServer are acting as HTTP
59clients.
60
61ntripclient
62-----------
63This POSIX Ntrip client program is written under GNU General Public
64License in C programming language. The program reads data from an Ntrip
65Broadcaster and writes on standard output for further redirection
66of data to a file or COM-port. PLEASE NOTE THAT THIS PROGRAM VERSION
67DOES NOT HANDLE POTENTIALLY OCCURRING INTERRUPTIONS OF COMMUNICATION
68OR NETWORK CONGESTION SITUATIONS. Its distribution may stimulate
69those intending to write their own client program.
70
71Call the program with following arguments:
72
73ntripclient -s server -u user ...
74 -m --mountpoint the requested data set or criteria for sourcetable filtering
75 -s --server     the server name or address
76 -p --password   the login password
77 -r --port       the server port number (default 2101)
78 -u --user       the user name
79 -n --nmea       NMEA string for sending to server
80 -b --bitrate    output bitrate
81 -S --proxyhost  proxy name or address
82 -R --proxyport  proxy port, optional (default 2101)
83 -M --mode       mode for data request
84     Valid modes are:
85     1, h, http     NTRIP Version 2.0 Caster in TCP/IP mode
86     2, r, rtsp     NTRIP Version 2.0 Caster in RTSP/RTP mode
87     3, n, ntrip1   NTRIP Version 1.0 Caster
88     4, a, auto     automatic detection (default)
89
90or using an URL:
91ntripclient ntrip:mountpoint[/user[:password]][@[server][:port][@proxyhost[:proxyport]]][;nmea]
92
93The argument '-h' will cause a HELP on the screen.
94Without any argument ntripclient will provide the a table of
95available resources (sourcetable).
96
97Sourcetable filtering
98----------------------
99A missing argument '-m' leads to the output of the complete broadcaster
100sourcetable. This may comprise hundreds of lines in case of large
101networks. To limit the output, the sourcetable contents can be filtered
102through entering the argument '-m' followed by a sequence of query strings,
103one for each sourcetable data field. Only those sourcetable lines are
104returned from the broadcaster whoes data fields match the corresponding
105query strings. A sequence of query strings has to be initiated by a '?'
106and a semicolon is acting as query string delimiter in analogy to the
107sourcetable data field delimiter.
108
109Note that for fully understanding the sourcetable filtering option
110you have to make yourself familiar with the details of the sourcetable
111contents. In general, search criterias can be applied on each sourcetable
112data field.
113
114The following query string operators are available for integer and
115floating-point numbers in the sourcetable lines:
116
117- Equation operators: <, >, >=, <=, =, != (not equal)
118- Approximation operator: ~n (find value with minimal distance to n)
119
120The following query string operators are available for alphanumeric
121strings in the sourcetable lines:
122
123- Wildcard operator: '*' means any number of characters
124- Alternation operator: expression|expression
125- Grouping operator: (expression)
126- Any character matching for strings (case insensitivity)
127
128The following operators are available for both text as well as integer
129and floating-point numbers in the sourcetable lines:
130
131- Logical operators: ! (NOT), & (AND), | (OR)
132- Grouping operator: [!] (Expression)
133
134Examples:
135
136- Searching in a sourcetable for streams in Germany would require
137  entering the '-m' argument followed by
138  the query string:
139  ?STR;;;;;;DEU
140
141- Searching in a sourcetable for free streams fom the EUREF network and
142  coming from the Frankfurt area would require entering the '-m' argument
143  followed by the query string:
144  ?STR;;;;;;;EUREF;;=>50&<=51;=>8.1&<8.6;;;;;N
145
146Compilation/Installation
147------------------------
148Please extract the archive and copy its contents into an appropriate
149directory. Compile the source code under POSIX systems by calling 'make'.
150
151To compile the source code on a Windows system where a mingw gcc
152compiler is available, you may like to run the following command:
153
154gcc -DWINDOWSVERSION -o ntripclient.exe ntripclient.c -lwsock32
155
156Registration
157------------
158Some of the data streams (mountpoints) from an NtripCaster may be
159available for test, demonstration, and evaluation purposes and
160accessible without authentication/authorization. For accessing other
161data streams (mountpoints) the user needs a user-ID and a
162user password. Authorization can be provided for a single stream,
163for a group of streams (network) or for all available streams.
164Currently, registration can be requested via the registration form
165on http://igs.bkg.bund.de/index_ntrip_reg.htm
166
167Ntrip Broadaster Address and Port
168---------------------------------
169The current Internet address of the Ntrip Broadcaster is
170www.euref-ip.net. The port number is 2101.
171
172Disclaimer
173----------
174Note that this ntripclient program is for experimental use
175only. The BKG disclaims any liability nor responsibility to any
176person or entity with respect to any loss or damage caused, or alleged
177to be caused, directly or indirectly by the use and application of the
178Ntrip technology.
179
180Further Information
181-------------------
182http://igs.bkg.bund.de/index_ntrip.htm
183euref-ip@bkg.bund.de
Note: See TracBrowser for help on using the repository browser.