source: ntrip/trunk/ntripserver/NTRIP2.txt@ 483

****************************
* Ntrip 2.0 Server Version *
****************************

INTRODUCTION

    This program is made available with the intention to support the development
    of NTRIP Version 2.0. Please keep in mind that - as of March 2007 - details
    of the NTRIP Version 2.0 transport protocol are still under discussion.


PURPOSE

    The purpose of this program is to pick up a GNSS data stream (Input, Source)
    from either
 
      1. a Serial port, or
      2. an IP server, or
      3. a File, or
      4. a SISNeT Data Server, or
      5. a UDP server, or
      6. an NTRIP Version 1.0 Caster
 
    and forward that incoming stream to either
 
      - an NTRIP Version 1.0 Caster, or
      - an NTRIP Version 2.0 Caster via TCP/IP or RTSP/RTP (Output, Destination).


LIMITATIONS

    The draft for NTRIP Version 2.0 includes a function for source-table
    filterning. This is so far not implemented.


INSTALLATION

    - gzip -d Ntrip2LinuxServer-0.3b.tar.gz
    - tar -xf Ntrip2LinuxServer-0.3b.tar
    - cd Ntrip2LinuxServer-0.3b
    - ./configure
    - make


OPTIONS

    -h|? print this help screen
 
    -E <ProxyHost>       Proxy server host name or address, required i.e. when
                         running the program in a proxy server protected LAN,
                         optional
    -F <ProxyPort>       Proxy server IP port, required i.e. when running
                         the program in a proxy server protected LAN, optional
 
    -I <InputMode> Sets the input mode (1 = Serial Port, 2 = IP server,
       3 = File, 4 = Sisnet Data Server, 5 = UDP server, 6 = NTRIP Caster),
       mandatory
 
       <InputMode> = 1 (Serial Port):
       -i <Device>       Serial input device, default: /dev/gps, mandatory if
                         <InputMode>=1
       -b <BaudRate>     Serial input baud rate, default: 19200 bps, mandatory
                         if <InputMode>=1
 
       <InputMode> = 2|5 (IP port | UDP port):
       -H <ServerHost>   Input host name or address, default: 127.0.0.1,
                         mandatory if <InputMode> = 2|5
       -P <ServerPort>   Input port, default: 1025, mandatory if <InputMode> = 2|5
       -f <ServerFile>   Name of initialization file to be send to server,
                         optional
       -x <ServerUser>   User ID to access incoming stream, optional
       -y <ServerPass>   Password, to access incoming stream, optional
       -B Bind to incoming UDP stream, optional for <InputMode> = 5
 
       <InputMode> = 3 (File):
       -s <File>         File name to simulate stream by reading data from (log)
                         file, default is /dev/stdin, mandatory for <InputMode> = 3
 
       <InputMode> = 4 (Sisnet Data Server):
       -H <SisnetHost>   Sisnet Data Server name or address,
                         default: 131.176.49.142, mandatory if <InputMode> = 4
       -P <SisnetPort>   Sisnet Data Server port, default: 7777, mandatory if
                         <InputMode> = 4
       -u <SisnetUser>   Sisnet Data Server user ID, mandatory if <InputMode> = 4
       -l <SisnetPass>   Sisnet Data Server password, mandatory if <InputMode> = 4
       -V <SisnetVers>   Sisnet Data Server Version number, options are 2.1, 3.0
                         or 3.1, default: 3.1, mandatory if <InputMode> = 4
 
       <InputMode> = 6 (NTRIP Version 1.0 Caster):
       -H <SourceHost>   Source caster name or address, default: 127.0.0.1,
                         mandatory if <InputMode> = 6
       -P <SourcePort>   Source caster port, default: 2101, mandatory if
                         <InputMode> = 6
       -D <SourceMount>  Source caster mountpoint for stream input, mandatory if
                         <InputMode> = 6
       -U <SourceUser>   Source caster user Id for input stream access, mandatory
                         for protected streams if <InputMode> = 6
       -W <SourcePass>   Source caster password for input stream access, mandatory
                         for protected streams if <InputMode> = 6
 
    -O <OutputMode> Sets the output mode for communatation with the destination
       caster (r = NTRIP Version 2.0 Caster in RTSP/RTP mode, t = Ntrip Version 2.0
       Caster in TCP/IP mode, f = NTRIP Version 1.0 Caster), mandatory
 
       Note that the program automatically falls back from mode r to mode t and
       further to mode f if necessary.
 
       -a <DestHost>     Destination caster name or address, default: 127.0.0.1,
                         mandatory
       -p <DestPort>     Destination caster port, default: 2101, mandatory
       -m <DestMount>    Destination caster mountpoint for stream upload,
                         mandatory
       -n <DestUser>     Destination caster user ID for stream upload to
                         mountpoint, only for NTRIP Version 2.0 destination
                         casters, mandatory
       -c <DestPass>     Destination caster password for stream upload to
                         mountpoint, mandatory
       -N <STR-record>   Sourcetable STR-record, optional for <OutputMode> = t|r

USAGE, EXAMPLES

 ./Ntrip2LinuxServer -I 1 -i /dev/ttys0 -b 9600
       -O r -a www.euref-ip.net -p 2101 -m Mount2 -n serverID -c serverPass
 ./Ntrip2LinuxServer -I 6 -H www.euref-ip.net -P 2101 -D Mount1 -U clientID -W clientPass
       -O t -a www.igs-ip.net -p 2101 -m Mount2 -n serverID -c serverPass
   
  
CONTACT

    Andrea Stuerze, BKG, Frankfurt
    URL:    http://igs.bkg.bund.de/index_ntrip.htm
    E-mail: euref-ip@bkg.bund.de