Changeset 9448 in ntrip for trunk/ntripserver/README


Ignore:
Timestamp:
May 28, 2021, 12:23:36 PM (4 years ago)
Author:
stuerze
Message:

data upload to localhost added

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/ntripserver/README

    r9404 r9448  
    33----------------------------------------------------------------------
    44
    5 (c) German Federal Agency for Cartography and Geodesy (BKG), 2002-2019
     5(c) German Federal Agency for Cartography and Geodesy (BKG), 2002-2021
    66
    77
    … …  
    5151from a single NTRIP source running under a POSIX operating system.
    5252
    53 Basically the ntripserver grabs a GNSS byte stream (Input, Source)
     53The purpose of this program is to pick up a GNSS data stream (Input, Source)
    5454from either
    5555
    56 1. a Serial port, or
    57 2. an IP server, or
    58 3. a File, or
    59 4. a SISNeT Data Server, or
    60 5. a UDP server, or
    61 6. an NTRIP Version 1.0 Caster
    62 
    63 and forwards that incoming stream to either
    64 
    65 1. an NTRIP Version 2.0 Caster via TCP/IP (Output, Destination), or
    66 2. an NTRIP Version 2.0 Caster via RTSP/RTP (Output, Destination), or
    67 3. an NTRIP Version 2.0 Caster via plain UDP (Output, Destination), or
    68 4. an NTRIP Version 1.0 Caster.
    69 
    70 Please note, the options to support NTRIP Version 2.0 are currently still
    71 under development and should be used with care. Keep in mind that details
    72 of the NTRIP Version 2.0 transport protocol are still under discussion
    73 and may be changed.
    74 
     56  1. a Serial port, or
     57  2. an IP server, or
     58  3. a File, or
     59  4. a SISNeT Data Server, or
     60  5. a UDP server, or
     61  6. an NTRIP Version 1.0 Caster
     62  7. an NTRIP Version 2.0 Caster in HTTP mode
     63
     64and forward that incoming stream (Output, Destination) to either
     65
     66  1. an NTRIP Version 2.0 Caster via TCP/IP (Output, Destination), or
     67  2. an NTRIP Version 2.0 Caster via RTSP/RTP (Output, Destination), or
     68  3. an NTRIP Version 2.0 Caster via plain UDP (Output, Destination), or
     69  4. an NTRIP Version 1.0 Caster, or
     70  5. an IP server via TCP/IP
    7571
    7672Installation
    … …  
    9894The user may call the program with the following options:
    9995
    100 -h|? print this help screen
    101 
    102 -E <ProxyHost>       Proxy server host name or address, required i.e. when
    103                      running the program in a proxy server protected LAN,
    104                      optional
    105 -F <ProxyPort>       Proxy server IP port, required i.e. when running
    106                      the program in a proxy server protected LAN, optional
    107 -R <maxDelay>        Reconnect mechanism with maximum delay between reconnect
    108                      attemts in seconds, default: no reconnect activated,
    109                      optional
    110 
    111 -M <InputMode> Sets the input mode (1 = Serial Port, 2 = IP server,
    112    3 = File, 4 = SISNeT Data Server, 5 = UDP server, 6 = NTRIP Caster),
    113    mandatory
    114 
    115    <InputMode> = 1 (Serial Port): (using 8-N-1 = data bits-parity-stop bits)
    116    -i <Device>       Serial input device, default: /dev/gps, mandatory if
    117                      <InputMode>=1
    118    -b <BaudRate>     Serial input baud rate, default: 19200 bps, mandatory
    119                      if <InputMode>=1
    120    -f <InitFile>     Name of initialization file to be send to input device,
    121                      optional
    122 
    123    <InputMode> = 2|5 (IP port | UDP port):
    124    -H <ServerHost>   Input host name or address, default: 127.0.0.1,
    125                      mandatory if <InputMode> = 2|5
    126    -P <ServerPort>   Input port, default: 1025, mandatory if <InputMode>= 2|5
    127    -f <ServerFile>   Name of initialization file to be send to server,
    128                      optional
    129    -x <ServerUser>   User ID to access incoming stream, optional
    130    -y <ServerPass>   Password, to access incoming stream, optional
    131    -B Bind to incoming UDP stream, optional for <InputMode> = 5
    132 
    133    <InputMode> = 3 (File):
    134    -s <File>         File name to simulate stream by reading data from (log)
    135                      file, default is /dev/stdin, mandatory for <InputMode> = 3
    136 
    137    <InputMode> = 4 (SISNeT Data Server):
    138    -H <SisnetHost>   SISNeT Data Server name or address,
    139                      default: 131.176.49.142, mandatory if <InputMode> = 4
    140    -P <SisnetPort>   SISNeT Data Server port, default: 7777, mandatory if
    141                      <InputMode> = 4
    142    -u <SisnetUser>   SISNeT Data Server user ID, mandatory if <InputMode> = 4
    143    -l <SisnetPass>   SISNeT Data Server password, mandatory if <InputMode> = 4
    144    -V <SisnetVers>   SISNeT Data Server Version number, options are 2.1, 3.0
    145                      or 3.1, default: 3.1, mandatory if <InputMode> = 4
    146 
    147    <InputMode> = 6 (NTRIP Version 1.0 Caster):
    148    -H <SourceHost>   Source caster name or address, default: 127.0.0.1,
    149                      mandatory if <InputMode> = 6
    150    -P <SourcePort>   Source caster port, default: 2101, mandatory if
    151                      <InputMode> = 6
    152    -D <SourceMount>  Source caster mountpoint for stream input, mandatory if
    153                      <InputMode> = 6
    154    -U <SourceUser>   Source caster user Id for input stream access, mandatory
    155                      for protected streams if <InputMode> = 6
    156    -W <SourcePass>   Source caster password for input stream access, mandatory
    157                      for protected streams if <InputMode> = 6
    158 
    159 -O <OutputMode> Sets output mode for communatation with destination caster
    160    1 = http: NTRIP Version 2.0 Caster in TCP/IP mode
    161    2 = rtsp: NTRIP Version 2.0 Caster in RTSP/RTP mode
    162    3 = ntrip1: NTRIP Version 1.0 Caster
    163    4 = udp: NTRIP Version 2.0 Caster in Plain UDP mode
    164    optional
    165 
    166    Defaults to NTRIP1.0, but will change to 2.0 in future versions
    167    Note that the program automatically falls back from mode rtsp to mode http and
    168    further to mode ntrip1 if necessary.
    169 
    170    -a <DestHost>     Destination caster name or address, default: 127.0.0.1,
    171                      mandatory
    172    -p <DestPort>     Destination caster port, default: 2101, mandatory
    173    -m <DestMount>    Destination caster mountpoint for stream upload,
    174                      mandatory
    175    -n <DestUser>     Destination caster user ID for stream upload to
    176                      mountpoint, only for NTRIP Version 2.0 destination
    177                      casters, mandatory
    178    -c <DestPass>     Destination caster password for stream upload to
    179                      mountpoint, mandatory
    180    -N <STR-record>   Sourcetable STR-record
    181                      optional for NTRIP Version 2.0 in RTSP/RTP and TCP/IP mode
     96./ntripserver [OPTIONS]
     97
     98 -h|? print this help screen
     99
     100   -E <ProxyHost>       Proxy server host name or address, required i.e. when
     101                        running the program in a proxy server protected LAN,
     102                        optional
     103   -F <ProxyPort>       Proxy server IP port, required i.e. when running
     104                        the program in a proxy server protected LAN, optional
     105   -R <maxDelay>        Reconnect mechanism with maximum delay between reconnect
     106                        attemts in seconds, default: no reconnect activated,
     107                        optional
     108   -M <InputMode> Sets the input mode (1 = Serial Port, 2 = IP server,
     109      3 = File, 4 = SISNeT Data Server, 5 = UDP server, 6 = NTRIP1 Caster,
     110      7 = NTRIP2 Caster in HTTP mode),
     111      mandatory
     112      <InputMode> = 1 (Serial Port):
     113      -i <Device>       Serial input device, default: /dev/gps, mandatory if
     114                        <InputMode>=1
     115      -b <BaudRate>     Serial input baud rate, default: 19200 bps, mandatory
     116                        if <InputMode>=1
     117      -f <InitFile>     Name of initialization file to be send to input device,
     118                        optional
     119      <InputMode> = 2|5 (IP port | UDP port):
     120      -H <ServerHost>   Input host name or address, default: 127.0.0.1,
     121                        mandatory if <InputMode> = 2|5
     122      -P <ServerPort>   Input port, default: 1025, mandatory if <InputMode>= 2|5
     123      -f <ServerFile>   Name of initialization file to be send to server,
     124                        optional
     125      -x <ServerUser>   User ID to access incoming stream, optional
     126      -y <ServerPass>   Password, to access incoming stream, optional
     127      -B                Bind to incoming UDP stream, optional for <InputMode> = 5
     128      <InputMode> = 3 (File):
     129      -s <File>         File name to simulate stream by reading data from (log)
     130                        file, default is /dev/stdin, mandatory for <InputMode> = 3
     131      <InputMode> = 4 (SISNeT Data Server):
     132      -H <SisnetHost>   SISNeT Data Server name or address,
     133                        default: 131.176.49.142, mandatory if <InputMode> = 4
     134      -P <SisnetPort>   SISNeT Data Server port, default: 7777, mandatory if
     135                        <InputMode> = 4
     136      -u <SisnetUser>   SISNeT Data Server user ID, mandatory if <InputMode> = 4
     137      -l <SisnetPass>   SISNeT Data Server password, mandatory if <InputMode> = 4
     138      -V <SisnetVers>   SISNeT Data Server Version number, options are 2.1, 3.0
     139                        or 3.1, default: 3.1, mandatory if <InputMode> = 4
     140      <InputMode> = 6|7 (NTRIP Version 1.0|2.0 Caster):
     141      -H <SourceHost>   Source caster name or address, default: 127.0.0.1,
     142                        mandatory if <InputMode> = 6|7
     143      -P <SourcePort>   Source caster port, default: 2101, mandatory if
     144                        <InputMode> = 6|7
     145      -D <SourceMount>  Source caster mountpoint for stream input, mandatory if
     146                        <InputMode> = 6|7
     147      -U <SourceUser>   Source caster user Id for input stream access, mandatory
     148                        for protected streams if <InputMode> = 6|7
     149      -W <SourcePass>   Source caster password for input stream access, mandatory
     150                        for protected streams if <InputMode> = 6|7
     151   -O <OutputMode> Sets output mode for communication with destination caster / server
     152      1 = http  : NTRIP Version 2.0 Caster in TCP/IP mode
     153      2 = rtsp  : NTRIP Version 2.0 Caster in RTSP/RTP mode
     154      3 = ntrip1: NTRIP Version 1.0 Caster
     155      4 = udp   : NTRIP Version 2.0 Caster in Plain UDP mode
     156      5 = tcpip : IP server in TCP/IP mode
     157      Defaults to NTRIP1.0, but will change to 2.0 in future versions
     158      Note that the program automatically falls back from mode rtsp to mode http and
     159      further to mode ntrip1 if necessary.
     160      -a <DestHost>     Destination caster/server name or address, default: 127.0.0.1,
     161                        mandatory
     162      -p <DestPort>     Destination caster/server port, default: 2101,
     163                        mandatory
     164      -m <DestMount>    Destination caster mountpoint for stream upload,
     165                        only for NTRIP destination casters, mandatory
     166      -n <DestUser>     Destination caster user ID for stream upload to mountpoint,
     167                        only for NTRIP Version 2.0 destination casters, mandatory
     168      -c <DestPass>     Destination caster password for stream upload to mountpoint,
     169                        only for NTRIP destination casters, mandatory
     170      -N <STR-record>   Sourcetable STR-record
     171                        optional for NTRIP Version 2.0 in RTSP/RTP and TCP/IP mode
    182172
    183173
    … …  
    198188program needs a password (and a user ID for NTRIP Version 2.0)
    199189and one mountpoint per stream.
    200 For the NTRIP Broadcasters EUREF-IP or IGS-IP this is currently
    201 available from https://igs.bkg.bund.de/ntrip/registerprovider
    202 
     190For the NTRIP Broadcasters EUREF-IP or IGS-IP please contact
     191euref-ip@bkg.bund.de or igs-ip@bkg.bund.de
    203192
    204193Disclaimer
Note: See TracChangeset for help on using the changeset viewer.