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

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

update to RINEX3 and epohemeris support

File size: 5.7 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. This means only GPS data at the
42 moment. Send me new RTCM3 data files and data support can be improved.
43 See contact address at the end of this document.
44 - If the ambiguity field in the RTCM3 data is not set, the output will be no
45 valid RINEX. All values will be stored modulo 299792.458. A COMMENT line
46 will tell you, when this happens. It would be necessary to approximately
47 calculate the range to fix the ambiguity (needing ephemeris/alamanac and
48 easy positioning algorithm).
49
50Usage: ./rtcm3torinex -s server -u user ...
51 -d --data the requested data set
52 -f --headerfile file for RINEX header information
53 -s --server the server name or address
54 -p --password the login password
55 -r --port the server port number (default 2101)
56 -t --timeout timeout in seconds (default 60)
57 -u --user the user name
58 -E --gpsephemeris output file for GPS ephemeris data
59 -G --glonassephemeris output file for GLONASS ephemeris data
60 -3 --rinex3 output RINEX type 3 data
61 -S --proxyhost proxy name or address
62 -R --proxyport proxy port, optional (default 2101)
63 -n --nmea NMEA string for sending to server
64 -M --mode mode for data request
65 Valid modes are:
66 1, h, http NTRIP Version 2.0 Caster in TCP/IP mode
67 2, r, rtsp NTRIP Version 2.0 Caster in RTSP/RTP mode
68 3, n, ntrip1 NTRIP Version 1.0 Caster
69 4, a, auto automatic detection (default)
70
71The fields --user and --password are used to specify the access data for the
72NTRIP server. The arguments --server and --port are used to specify the NTRIP
73server itself (defaults to "www.euref-ip.net" port 2101). The Argument --data
74must be used to specify the RTCM3 input data stream. If it is not given, you
75will be shown the source table of the selected NTRIP caster.
76
77Alternatively a single text of the form
78"ntrip:data[/user[:password]][@[server][:port][@proxyhost[:proxyport]]][;nmea]"
79can be used. Everything in brackets is optional.
80
81Additionally the argument --headerfile can be used to provide additional header
82information. The file must contain normal RINEX observation file header lines.
83The given lines overwrite the automatical generated lines. Overwriting the
84lines "# / TYPES OF OBSERV" and "TIME OF FIRST OBS" usually is a bad idea and
85you will get warned if you do so. The line "END OF HEADER" is ignored.
86Unknown lines or COMMENT lines will be appended before the "END OF HEADER".
87
88NOTE: The tool does not check the input lines for validity. So be sure to
89use correct RINEX specifiers as well as correct alignment.
90
91To stop RINEX output send the program a killing signal. Following signal
92sources are supported:
93
94signal number usual source of the signal
95---------------------------------------------------------------------------
96SIGINT 2 pressing CTRL+C in the shell running the tool
97SIGQUIT 3 pressing CTRL-\ or sending QUIT signal
98SIGTERM 15 called kill <num> with the process number of rtcm3torinex
99SIGPIPE 13 the output or input of rtcm3torinex has been closed
100
101The programm will be terminated after the current epoch has been finished.
102You will not get corrupted RINEX files.
103
104When compiling the program with older gcc versions running the `make'
105command, you may receive an informative error message saying
106
107rtcm3torinex.c: In function `signalhandler_alarm':
108rtcm3torinex.c:1240: warning: `noreturn' function does return
109
110This is most likely a compiler problem which only concerns the optimization
111and is thus not critical. New compilers will not show this problem.
112
113Program written by
114
115Dirk Stoecker
116Alberding GmbH
117http://www.alberding.eu/
118
119for
120
121Federal Agency for Cartography and Geodesy (BKG)
122Richard-Strauss-Allee 11
123D-60598 Frankfurt
124http://igs.bkg.bund.de/index_ntrip.htm
125
126Contact Dirk Stoecker [stoecker@alberding.eu] or [euref-ip@bkg.bund.de]
127with your comments, suggestions, improvements, patches, ...
Note: See TracBrowser for help on using the repository browser.