source: ntrip/trunk/ntripclient/README@ 494

Last change on this file since 494 was 494, checked in by stoecker, 15 years ago

added NTRIP V2 modes

File size: 4.9 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 is a generic, stateless protocol based on the
36Hypertext Transfer Protocol HTTP/1.1. The HTTP objects are enhanced
37to GNSS data streams.
38
39Ntrip is designed for disseminating differential correction data
40(e.g in the RTCM-104 format) or other kinds of GNSS streaming data to
41stationary or mobile users over the Internet, allowing simultaneous PC,
42Laptop, PDA, or receiver connections to a broadcasting host. Ntrip
43supports Wireless Internet access through Mobile IP Networks like GSM,
44GPRS, EDGE, or UMTS.
45
46Ntrip is implemented in three system software components: NtripClients,
47NtripServers and NtripCasters. The NtripCaster is the actual HTTP
48server program whereas NtripClient and NtripServer are acting as HTTP
49clients.
50
51ntripclient
52-----------
53This POSIX Ntrip client program is written under GNU General Public
54License in C programming language. The program reads data from an Ntrip
55Broadcaster and writes on standard output for further redirection
56of data to a file or COM-port. PLEASE NOTE THAT THIS PROGRAM VERSION
57DOES NOT HANDLE POTENTIALLY OCCURRING INTERRUPTIONS OF COMMUNICATION
58OR NETWORK CONGESTION SITUATIONS. Its distribution may stimulate
59those intending to write their own client program.
60
61Call the program with following arguments:
62
63ntripclient -s server -u user ...
64 -d --data the requested data set
65 -s --server the server name or address
66 -p --password the login password
67 -r --port the server port number (default 2101)
68 -u --user the user name
69 -n --nmea NMEA string for sending to server
70 -b --bitrate output bitrate
71 -S --proxyhost proxy name or address
72 -R --proxyport proxy port, optional (default 2101)
73 -M --mode mode for data request
74 Valid modes are:
75 1, h, http NTRIP Version 2.0 Caster in TCP/IP mode
76 2, r, rtsp NTRIP Version 2.0 Caster in RTSP/RTP mode
77 3, n, ntrip1 NTRIP Version 1.0 Caster
78 4, a, auto automatic detection (default)
79
80or using an URL:
81ntripclient ntrip:mountpoint[/username[:password]][@[server][:port][@proxy[:port]]][;nmea]
82
83
84The argument '-h' will cause a HELP on the screen.
85Without any argument ntripclient will provide the a table of
86available resources (source table).
87
88Compilation/Installation
89------------------------
90Please extract the archive and copy its contents into an appropriate
91directory. Compile the source code under POSIX systems by calling 'make'.
92
93Registration
94------------
95Some of the data streams (mountpoints) from an NtripCaster may be
96available for test, demonstration, and evaluation purposes and
97accessible without authentication/authorization. For accessing other
98data streams (mountpoints) the user needs a user-ID and a
99user password. Authorization can be provided for a single stream,
100for a group of streams (network) or for all available streams.
101Currently, registration can be requested via the registration form
102on http://igs.ifag.de/ntrip/ntrip_register.htm.
103
104Ntrip Broadaster Address and Port
105---------------------------------
106The current Internet address of the Ntrip Broadcaster is
107www.euref-ip.net. The port number is 2101.
108
109Disclaimer
110----------
111Note that this ntripclient program is for experimental use
112only. The BKG disclaims any liability nor responsibility to any
113person or entity with respect to any loss or damage caused, or alleged
114to be caused, directly or indirectly by the use and application of the
115Ntrip technology.
116
117Further Information
118-------------------
119http://igs.ifag.de/index_ntrip.htm
120euref-ip@bkg.bund.de
Note: See TracBrowser for help on using the repository browser.