doc/manual/cl-serial.html
changeset 0 2b3e5ec03512
equal deleted inserted replaced
-1:000000000000 0:2b3e5ec03512
       
     1 <html>
       
     2 <head>
       
     3 <title> DTN2 Manual: Serial Convergence Layer </title>
       
     4 <link rel="stylesheet" type="text/css" href="manual.css" />
       
     5 </head>
       
     6 <body>
       
     7 <h1>Serial Convergence Layer
       
     8 </h1>
       
     9 
       
    10 <p>
       
    11 When using the Serial convergence layer a connection is either a receiver or a sender. First it parses and attempts to resolve the next hop address and if able to do so opens a tty. To add a serial interface in your config file, use:
       
    12 
       
    13 <p>Syntax: <tt>interface add <i>name</i> <i>CL</i> [<i>arg=val arg=val2 argN=valN...</i>]</tt>
       
    14 <p>Example: <tt>interface add serial0 serial </tt>
       
    15 <p>Valid arguments for <tt><i>arg</i></tt> are:
       
    16 
       
    17 <p>
       
    18 <table>
       
    19 <tr>
       
    20 <th>arg
       
    21 <th>Possible settings
       
    22 <th>Default
       
    23 <th>Comments
       
    24 
       
    25 <tr>
       
    26 <td><tt>hexdump</tt>
       
    27 <td>true or false
       
    28 <td>false
       
    29 <td>Whether to log a hexdump of all traffic
       
    30 
       
    31 <tr>
       
    32 <td><tt>initstr</tt>
       
    33 <td>string
       
    34 <td>""
       
    35 <td>String to initialize the tty
       
    36 
       
    37 <tr>
       
    38 <td><tt>ispeed</tt>
       
    39 <td>number
       
    40 <td>19200
       
    41 <td>Input speed on the tty
       
    42 
       
    43 <tr>
       
    44 <td><tt>ospeed</tt>
       
    45 <td>number 
       
    46 <td>19200
       
    47 <td>Output speed on the tty
       
    48 
       
    49 <tr>
       
    50 <td><tt>sync_interval</tt>
       
    51 <td>number
       
    52 <td>1000
       
    53 <td>Interval to send initial sync bits
       
    54 
       
    55 
       
    56 
       
    57 </table>
       
    58 <p> <b>Note</b>
       
    59 <p>
       
    60 The side which initiates the active connect is not necessarily the sender.
       
    61 <p>
       
    62 The serial CL first attempt to parse the next hop address and if unable to do so, the link can't be opened. If it can it opens the tty and set the tty parameters and initializes the timer. If there's a dialing string, it will attempt to send it, reserve space in the buffer and send a sync byte to kick things off. 
       
    63 <p>
       
    64 During the session it will check that it hasn't been too long since it got some data from the other side and if it has it will time out the connection.
       
    65 <p> 
       
    66 Once data is received on the channel, it means the other side is up and trying to sync, so it will send the contact header
       
    67 
       
    68 </body>
       
    69 </html>
       
    70