source: ntrip/trunk/rtcm3torinex/rtcm3torinex.txt@ 5035

Last change on this file since 5035 was 510, checked in by stuerze, 15 years ago

minor changes

File size: 5.6 KB
Line 
1Manual for rtcm3torinex
2
3The program rtcm3torinex is an real-time converter from NTRIP streamed RTCM3
4data into the RINEX format.
5
6RTCM3 defines a number of message types. Among them are the following:
7
8Message
9Type Contains information about
10--------------------------------------------------------------------------
111001 GPS L1 code and phase
121002 GPS L1 code and phase and ambiguities and carrier to noise ratio
131003 GPS L1 and L1 code and phase
141004 GPS L1 and L2 code and phase and ambiguities and carrier to noise ratio
151005 Station coordinates XZY for antenna reference point
161006 Station coordinates XYZ for antenna reference point and antenna height
171007 Antenna descriptor and ID
181008 Antenna serial number
191009 GLONASS L1 code and phase
201010 GLONASS L1 code and phase and ambiguities and carrier to noise ratio
211011 GLONASS L1 and L1 code and phase
221012 GLONASS L1 and L2 code and phase and ambiguities and carrier to noise ratio
231013 Modified julian date, leep second, configured message types and intervall
241014-1017 Network RTK (MAK) messages
251019 GPS Ephemeris
261020 GLONASS Ephemeris
274088-4095 Proprietary messages (under development)
28
29Note that this version of rtcm3torinex only handles RTCM3 message types 1001,
301002, 1003, 1004, 1009, 1010, 1011, 1012, 1019 and 1020.
31
32The generated RINEX is somewhat limited due to the streaming character of the
33conversion:
34
35 - Header records can only represent data, which is known after receiving the
36 very first epoch. Data rate, position, number of observations and any such
37 additional fields cannot be provided.
38 - The number of observables cannot change during the program runtime. Only
39 the observables, which exist in the first epoch are output. If there
40 are new observables later on, these are ignored.
41 - Only known message types are interpreted. Send me new RTCM3 data files and
42 data support can be improved. See contact address at the end of this document.
43 - If the ambiguity field in the RTCM3 data is not set, the output will be no
44 valid RINEX. All values will be stored modulo 299792.458. A COMMENT line
45 will tell you, when this happens. It would be necessary to approximately
46 calculate the range to fix the ambiguity (needing ephemeris/alamanac and
47 easy positioning algorithm).
48
49Usage: ./rtcm3torinex -s server -u user ...
50 -d --data the requested data set
51 -f --headerfile file for RINEX header information
52 -s --server the server name or address
53 -p --password the login password
54 -r --port the server port number (default 2101)
55 -t --timeout timeout in seconds (default 60)
56 -u --user the user name
57 -E --gpsephemeris output file for GPS ephemeris data
58 -G --glonassephemeris output file for GLONASS ephemeris data
59 -3 --rinex3 output RINEX type 3 data
60 -S --proxyhost proxy name or address
61 -R --proxyport proxy port, optional (default 2101)
62 -n --nmea NMEA string for sending to server
63 -M --mode mode for data request
64 Valid modes are:
65 1, h, http NTRIP Version 2.0 Caster in TCP/IP mode
66 2, r, rtsp NTRIP Version 2.0 Caster in RTSP/RTP mode
67 3, n, ntrip1 NTRIP Version 1.0 Caster
68 4, a, auto automatic detection (default)
69
70The fields --user and --password are used to specify the access data for the
71NTRIP server. The arguments --server and --port are used to specify the NTRIP
72server itself (defaults to "www.euref-ip.net" port 2101). The Argument --data
73must be used to specify the RTCM3 input data stream. If it is not given, you
74will be shown the source table of the selected NTRIP caster.
75
76Alternatively a single text of the form
77"ntrip:data[/user[:password]][@[server][:port][@proxyhost[:proxyport]]][;nmea]"
78can be used. Everything in brackets is optional.
79
80Additionally the argument --headerfile can be used to provide additional header
81information. The file must contain normal RINEX observation file header lines.
82The given lines overwrite the automatical generated lines. Overwriting the
83lines "# / TYPES OF OBSERV" and "TIME OF FIRST OBS" usually is a bad idea and
84you will get warned if you do so. The line "END OF HEADER" is ignored.
85Unknown lines or COMMENT lines will be appended before the "END OF HEADER".
86
87NOTE: The tool does not check the input lines for validity. So be sure to
88use correct RINEX specifiers as well as correct alignment.
89
90To stop RINEX output send the program a killing signal. Following signal
91sources are supported:
92
93signal number usual source of the signal
94---------------------------------------------------------------------------
95SIGINT 2 pressing CTRL+C in the shell running the tool
96SIGQUIT 3 pressing CTRL-\ or sending QUIT signal
97SIGTERM 15 called kill <num> with the process number of rtcm3torinex
98SIGPIPE 13 the output or input of rtcm3torinex has been closed
99
100The programm will be terminated after the current epoch has been finished.
101You will not get corrupted RINEX files.
102
103When compiling the program with older gcc versions running the `make'
104command, you may receive an informative error message saying
105
106rtcm3torinex.c: In function `signalhandler_alarm':
107rtcm3torinex.c:1240: warning: `noreturn' function does return
108
109This is most likely a compiler problem which only concerns the optimization
110and is thus not critical. New compilers will not show this problem.
111
112Program written by
113
114Dirk Stoecker
115Alberding GmbH
116http://www.alberding.eu/
117
118for
119
120Federal Agency for Cartography and Geodesy (BKG)
121Richard-Strauss-Allee 11
122D-60598 Frankfurt
123http://igs.bkg.bund.de/index_ntrip.htm
124
125Contact Dirk Stoecker [stoecker@alberding.eu] or [euref-ip@bkg.bund.de]
126with your comments, suggestions, improvements, patches, ...
Note: See TracBrowser for help on using the repository browser.