Template:Networking rutos manual serial utilities: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
Line 12: Line 12:
The <b>Serial Utilities</b> page is used to make serial communication configurations of different types.
The <b>Serial Utilities</b> page is used to make serial communication configurations of different types.


To make a <b>new serial configuration</b> instance select a serial type from the left-hand navigation menu. In the next page enter a custom name for the new config, select a serial device and click the Add button.
{{#ifeq:{{{name}}}|TRB143|==Over IP==
 
The <b>Over IP</b> serial type is used to manage serial connections over a TCP/IP network.
 
===Serial Device Configuration===
----
Configure serial port communication parameters in the <b>Serial Device Configuration</b> section.
 
[[File:Networking_rutos_manual_serial_utilities_over_ip_serial_default_{{{default}}}_v1.png|border|class=tlt-border]]
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enable</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Turns the instance on or off.</td>
    </tr>
    <tr>
      <td>Name</td>
      <td>string; default: <b>none</b></td>
      <td>Instance name, generated by the user when first creating the configuration.</td>
    </tr>
    <tr>
        <td>Device</td>
        <td>{{Template: Networking_rutos_manual_serial_ports | rs232={{{rs232}}} | rs485={{{rs485}}} | usb={{{usb}}} }}; default: <b>{{Template: Networking_rutos_manual_default_serial_port | rs232={{{rs232}}} | rs485={{{rs485}}} | usb={{{usb}}} }}</b></td>
        <td>Specifies which serial port will be used for serial communication.</td>
    </tr>
    <tr>
    <td>Baud rate</td>
        <td>integer [300..3000000]; default: <b>9600</b></td>
        <td>Data rate for serial data transmission (in bits per second (bps)).</td>
    </tr>
    <tr>
    <td>Data bits</td>
        <td>7 {{!}} 8; default: <b>8</b></td>
        <td>Number of data bits for each character.</td>
    </tr>
    <tr>
      <td>Stop bits</td>
      <td>1 {{!}} 2; default: <b>1</b></td>
      <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
    </tr>
    <tr>
    <td>Parity</td>
        <td>None {{!}} Odd {{!}} Even {{!}} Mark {{!}} Space; default: <b>None</b></td>
        <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
            <ul>
              <li><b>None</b> (<b>N</b>) - no parity method is used.</li>
              <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li>
              <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>
            </ul>
        </td>
    </tr>
    <tr>
    <td>Flow control</td>
        <td>None{{#ifeq: {{{rs232}}} | 1 | {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: <b>None</b></td>
        <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.{{#ifeq: {{{rs232}}} | 1 |
            <ul>
                <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
            </ul>|}}
        </td>
    </tr>{{#ifeq: {{{rs485}}} | 1 |
    <tr>
      <td><span style="color: purple;">RS485:</span> Full Duplex</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
    </tr>|}}
</table>
 
===Over IP Configuration Settings===
----
You can configure network related parameters of the serial connection in the <b>Over IP Configuration</b> secion.
 
[[File:Networking_rutos_manual_serial_utilities_over_ip_configuration_v1.png|border|class=tlt-border]]
 
<table class="nd-mantable">
    <tr>
        <th style="width: 360px>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
    <td>Mode</td>
        <td><span style="color: red;">Server</span> {{!}} <span style="color: purple;">Client</span> {{!}} <span style="color: orange;">Bidirect</span>; default: <b>Server</b></td>
        <td>This device's role in the connection:
            <ul>
                <li><b>Server</b> - the device waits for incoming connections.</li>
                <li><b>Client</b> - the device initiates the connection.</li>
                <li><b>Bidirect</b> - acts as client by default but waits for incoming connections at the same time.</li>
            </ul>
        </td>
    </tr>
    <tr>
      <td>Protocol</td>
      <td><span style="color: blue;">TCP</span> {{!}} <span style="color: green;">UDP</span>; default: <b>TCP</b></td>
      <td>Protocol used in the communication process.</td>
    </tr>
    <tr>
      <td>Raw mode</td>
      <td>off {{!}} on; default; default: <b>off</b></td>
      <td>When enabled, all data will be transmitted transparently.</td>
    </tr>
    <tr>
    <td>No leading zeros</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>When checked, indicates that the first hex zeros should be skipped.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Server settings</span>: Port</td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>Internal port number used to listen for incoming connections.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Server settings</span> {{!}} <span style="color: blue;">TCP</span>: Timeout (s)</td>
        <td>integer [0..32767]; default: <b>300</b></td>
        <td>Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined client 1 address</td>
        <td>ip4; default: <b>none</b></td>
        <td>Specifies IP address for predefined connection 1.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined port 1</td>
        <td>port; default: <b>none</b></td>
        <td>Specifies port number for predefined connection 1.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined client 2 address</td>
        <td>ip4; default: <b>none</b></td>
        <td>Specifies IP address for predefined connection 2.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined port 2</td>
        <td>port; default: <b>none</b></td>
        <td>Specifies port number for predefined connection 2.</td>
    </tr>
    <tr>
      <td><span style="color: purple;">Client settings</span>: Server Address</td>
      <td>ip {{!}} host; default: <b>none</b></td>
      <td>IP address or hostname of the server that this client will connect to.</td>
    </tr>
    <tr>
    <td><span style="color: purple;">Client settings</span>: Port</td>
        <td>integer [0..65535]; default: <b>none</b></td>
        <td>Server's listening port number.</td>
    </tr>
    <tr>
    <td><span style="color: purple;">Client settings</span>: Reconnect interval (s)</td>
        <td>integer; default: <b>none</b></td>
        <td>Time period (in seconds) between reconnection attempts in case a connection fails.</td>
    </tr>
    <tr>
    <td>Serial device read time</td>
        <td>integer [0..1000]; default: <b>none</b></td>
        <td>Specifies custom read time for the serial device.</td>
    </tr>{{#ifeq: {{{rs485}}} | 1 |
    <tr>
    <td><span style="color: purple;">RS485:</span> Full Duplex</td>
        <td>off {{!}} on; default: <b>off</b></td>
      <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
    </tr>|}}
    <tr>
    <td><span style="color: red;">Server settings</span> {{!}} <span style="color: blue;">TCP</span>: Max clients</td>
        <td>integer [1..32]; default: <b>32</b></td>
        <td>Specifies how many clients are allowed to connect simultaneously.</td>
    </tr>
    <tr>
    <td><span style="color: blue;">TCP</span>: TCP echo</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Enables software TCP echo.</td>
    </tr>
    <tr>
    <td><span style="color: blue;">TCP</span>: Always reconnect</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>When enabled, a new TCP connection will be made after sending every data package.</td>
    </tr>
</table>|To make a <b>new serial configuration</b> instance select a serial type from the left-hand navigation menu. In the next page enter a custom name for the new config, select a serial device and click the Add button.


Example from the Modem Configuration page:
Example from the Modem Configuration page:
Line 252: Line 434:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>off | on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Turns the instance on or off.</td>
       <td>Turns the instance on or off.</td>
     </tr>
     </tr>
Line 272: Line 454:
     <tr>
     <tr>
     <td>Data bits</td>
     <td>Data bits</td>
         <td>7 | 8; default: <b>8</b></td>
         <td>7 {{!}} 8; default: <b>8</b></td>
         <td>Number of data bits for each character.</td>
         <td>Number of data bits for each character.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Stop bits</td>
       <td>Stop bits</td>
       <td>1 | 2; default: <b>1</b></td>
       <td>1 {{!}} 2; default: <b>1</b></td>
       <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
       <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Parity</td>
     <td>Parity</td>
         <td>None | Odd | Even | Mark | Space; default: <b>None</b></td>
         <td>None {{!}} Odd {{!}} Even {{!}} Mark {{!}} Space; default: <b>None</b></td>
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
             <ul>
             <ul>
Line 297: Line 479:
             <ul>
             <ul>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
             </ul>|}}
             </ul>|}}
         </td>
         </td>
Line 306: Line 488:
       <td>Specifies modem control mode.
       <td>Specifies modem control mode.
           <ul>
           <ul>
             <li><b>Partial control</b>- enables modem control with AT commands,  mobile connection will be controlled by RUTOS.
             <li><b>Partial control</b>- enables modem control with AT commands,  mobile connection will be controlled by RUTOS.</li>
             <li><b>Full control</b>- enables modem control with AT commands,  mobile connection will be controlled by user.  
             <li><b>Full control</b>- enables modem control with AT commands,  mobile connection will be controlled by user. </li>
             </ul>
             </ul>
         </td>
         </td>
Line 332: Line 514:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>off | on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Turns the instance on or off.</td>
       <td>Turns the instance on or off.</td>
     </tr>
     </tr>
Line 352: Line 534:
     <tr>
     <tr>
     <td>Data bits</td>
     <td>Data bits</td>
         <td>7 | 8; default: <b>8</b></td>
         <td>7 {{!}} 8; default: <b>8</b></td>
         <td>Number of data bits for each character.</td>
         <td>Number of data bits for each character.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Stop bits</td>
       <td>Stop bits</td>
       <td>1 | 2; default: <b>1</b></td>
       <td>1 {{!}} 2; default: <b>1</b></td>
       <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronize with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
       <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronize with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Parity</td>
     <td>Parity</td>
         <td>None | Odd | Even | Mark | Space; default: <b>None</b></td>
         <td>None {{!}} Odd {{!}} Even {{!}} Mark {{!}} Space; default: <b>None</b></td>
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
             <ul>
             <ul>
Line 377: Line 559:
             <ul>
             <ul>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
             </ul>|}}
             </ul>|}}
         </td>
         </td>
Line 406: Line 588:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>off | on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Turns the instance on or off.</td>
       <td>Turns the instance on or off.</td>
     </tr>
     </tr>
Line 426: Line 608:
     <tr>
     <tr>
     <td>Data bits</td>
     <td>Data bits</td>
         <td>7 | 8; default: <b>8</b></td>
         <td>7 {{!}} 8; default: <b>8</b></td>
         <td>Number of data bits for each character.</td>
         <td>Number of data bits for each character.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Stop bits</td>
       <td>Stop bits</td>
       <td>1 | 2; default: <b>1</b></td>
       <td>1 {{!}} 2; default: <b>1</b></td>
       <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
       <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Parity</td>
     <td>Parity</td>
         <td>None | Odd | Even | Mark | Space; default: <b>None</b></td>
         <td>None {{!}} Odd {{!}} Even {{!}} Mark {{!}} Space; default: <b>None</b></td>
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
         <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
             <ul>
             <ul>
Line 451: Line 633:
             <ul>
             <ul>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li>
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.
                 <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li>
             </ul>|}}
             </ul>|}}
         </td>
         </td>
Line 476: Line 658:
     <tr>
     <tr>
     <td>Mode</td>
     <td>Mode</td>
         <td><span style="color: red;">Server</span> | <span style="color: purple;">Client</span> | <span style="color: orange;">Bidirect</span>; default: <b>Server</b></td>
         <td><span style="color: red;">Server</span> {{!}} <span style="color: purple;">Client</span> {{!}} <span style="color: orange;">Bidirect</span>; default: <b>Server</b></td>
         <td>This device's role in the connection:
         <td>This device's role in the connection:
             <ul>
             <ul>
Line 487: Line 669:
     <tr>
     <tr>
       <td>Protocol</td>
       <td>Protocol</td>
       <td><span style="color: blue;">TCP</span> | <span style="color: green;">UDP</span>; default: <b>TCP</b></td>
       <td><span style="color: blue;">TCP</span> {{!}} <span style="color: green;">UDP</span>; default: <b>TCP</b></td>
       <td>Protocol used in the communication process.</td>
       <td>Protocol used in the communication process.</td>
     </tr>
     </tr>
Line 497: Line 679:
     <tr>
     <tr>
     <td>No leading zeros</td>
     <td>No leading zeros</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>When checked, indicates that the first hex zeros should be skipped.</td>
         <td>When checked, indicates that the first hex zeros should be skipped.</td>
     </tr>
     </tr>
Line 506: Line 688:
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Server settings</span> | <span style="color: blue;">TCP</span>: Timeout (s)</td>
     <td><span style="color: red;">Server settings</span> {{!}} <span style="color: blue;">TCP</span>: Timeout (s)</td>
         <td>integer [0..32767]; default: <b>300</b></td>
         <td>integer [0..32767]; default: <b>300</b></td>
         <td>Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected.</td>
         <td>Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined client 1 address</td>
     <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined client 1 address</td>
         <td>ip4; default: <b>none</b></td>
         <td>ip4; default: <b>none</b></td>
         <td>Specifies IP address for predefined connection 1.</td>
         <td>Specifies IP address for predefined connection 1.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined port 1</td>
     <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined port 1</td>
         <td>port; default: <b>none</b></td>
         <td>port; default: <b>none</b></td>
         <td>Specifies port number for predefined connection 1.</td>
         <td>Specifies port number for predefined connection 1.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined client 2 address</td>
     <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined client 2 address</td>
         <td>ip4; default: <b>none</b></td>
         <td>ip4; default: <b>none</b></td>
         <td>Specifies IP address for predefined connection 2.</td>
         <td>Specifies IP address for predefined connection 2.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined port 2</td>
     <td><span style="color: red;">Server settings</span> {{!}} <span style="color: green;">UDP</span>: Predefined port 2</td>
         <td>port; default: <b>none</b></td>
         <td>port; default: <b>none</b></td>
         <td>Specifies port number for predefined connection 2.</td>
         <td>Specifies port number for predefined connection 2.</td>
Line 532: Line 714:
     <tr>
     <tr>
       <td><span style="color: purple;">Client settings</span>: Server Address</td>
       <td><span style="color: purple;">Client settings</span>: Server Address</td>
       <td>ip | host; default: <b>none</b></td>
       <td>ip {{!}} host; default: <b>none</b></td>
       <td>IP address or hostname of the server that this client will connect to.</td>
       <td>IP address or hostname of the server that this client will connect to.</td>
     </tr>
     </tr>
Line 556: Line 738:
     </tr>|}}
     </tr>|}}
     <tr>
     <tr>
     <td><span style="color: red;">Server settings</span> | <span style="color: blue;">TCP</span>: Max clients</td>
     <td><span style="color: red;">Server settings</span> {{!}} <span style="color: blue;">TCP</span>: Max clients</td>
         <td>integer [1..32]; default: <b>32</b></td>
         <td>integer [1..32]; default: <b>32</b></td>
         <td>Specifies how many clients are allowed to connect simultaneously.</td>
         <td>Specifies how many clients are allowed to connect simultaneously.</td>
Line 562: Line 744:
     <tr>
     <tr>
     <td><span style="color: blue;">TCP</span>: TCP echo</td>
     <td><span style="color: blue;">TCP</span>: TCP echo</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Enables software TCP echo.</td>
         <td>Enables software TCP echo.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td><span style="color: blue;">TCP</span>: Always reconnect</td>
     <td><span style="color: blue;">TCP</span>: Always reconnect</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>When enabled, a new TCP connection will be made after sending every data package.</td>
         <td>When enabled, a new TCP connection will be made after sending every data package.</td>
     </tr>
     </tr>
Line 580: Line 762:
Then enter the IP address and save.
Then enter the IP address and save.


[[File:Networking_rutos_manual_console_ip_filter_instance.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_console_ip_filter_instance.png|border|class=tlt-border]]}}


[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]

Revision as of 12:49, 12 September 2023

Template:Networking rutos manual fw disclosure
Note: services were merged and moved to Serial Utilities page from FW version {{{series}}}_R_00.07.03.

Summary

The Serial Utilities page is used to make serial communication configurations of different types.

To make a new serial configuration instance select a serial type from the left-hand navigation menu. In the next page enter a custom name for the new config, select a serial device and click the Add button.

Example from the Modem Configuration page:

[[File:Networking_rutos_manual_serial_utilities_add_new_instance_default_{{{default}}}_v1.png|border|class=tlt-border]]

Then, click the Edit button next to the instance:

[[File:Networking_rutos_manual_serial_utilities_edit_config_default_{{{default}}}_v1.png|border|class=tlt-border]]

This manual page provides an overview of the Serial Utilities page in {{{name}}} devices.



Modem Control

The Modem serial type is used to manage modem functionality which could be accessed using shell interface. For this purpose you may want use CR/LF (Carriage Return, Line Feed) capable applications like PuTTY on Windows and microcom, minicom, cutecom or similar applications on Linux.

[[File:Networking_rutos_manual_serial_utilities_modem_control_default_{{{default}}}_v1.png|border|class=tlt-border]]

Field Value Description
Enable off | on; default: off Turns the instance on or off.
Name string; default: none Instance name, generated by the user when first creating the configuration.
Device ; default: Specifies which serial port will be used for serial communication.
Baud rate integer [300..3000000]; default: 9600 Data rate for serial data transmission (in bits per second (bps)).
Data bits 7 | 8; default: 8 Number of data bits for each character.
Stop bits 1 | 2; default: 1 Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.
Parity None | Odd | Even | Mark | Space; default: None In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
  • None (N) - no parity method is used.
  • Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.
  • Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.
Flow control None; default: None In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
Mode Partial control | Full control; default: Partial control Specifies modem control mode.
  • Partial control- enables modem control with AT commands, mobile connection will be controlled by RUTOS.
  • Full control- enables modem control with AT commands, mobile connection will be controlled by user.

Console

Console mode requires no further configuration than the settings above and is used as a direct-access method to the device's shell interface. For this purpose you may want use such applications as PuTTY on Windows and microcom, minicom, picocom or similar applications on Linux.

[[File:Networking_rutos_manual_serial_utilities_console_default_{{{default}}}_v1.png|border|class=tlt-border]]

Field Value Description
Enable off | on; default: off Turns the instance on or off.
Name string; default: none Instance name, generated by the user when first creating the configuration.
Device ; default: Specifies which serial port will be used for serial communication.
Baud rate integer [300..3000000]; default: 9600 Data rate for serial data transmission (in bits per second (bps)).
Data bits 7 | 8; default: 8 Number of data bits for each character.
Stop bits 1 | 2; default: 1 Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronize with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.
Parity None | Odd | Even | Mark | Space; default: None In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
  • None (N) - no parity method is used.
  • Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.
  • Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.
Flow control None; default: None In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.

Over IP

The Over IP serial type is used to manage serial connections over a TCP/IP network.

Serial Device Configuration

Configure serial port communication parameters in the Serial Device Configuration section.

[[File:Networking_rutos_manual_serial_utilities_over_ip_serial_default_{{{default}}}_v1.png|border|class=tlt-border]]

Field Value Description
Enable off | on; default: off Turns the instance on or off.
Name string; default: none Instance name, generated by the user when first creating the configuration.
Device ; default: Specifies which serial port will be used for serial communication.
Baud rate integer [300..3000000]; default: 9600 Data rate for serial data transmission (in bits per second (bps)).
Data bits 7 | 8; default: 8 Number of data bits for each character.
Stop bits 1 | 2; default: 1 Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.
Parity None | Odd | Even | Mark | Space; default: None In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
  • None (N) - no parity method is used.
  • Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.
  • Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.
Flow control None; default: None In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.

Over IP Configuration Settings

You can configure network related parameters of the serial connection in the Over IP Configuration secion.

Field Value Description
Mode Server | Client | Bidirect; default: Server This device's role in the connection:
  • Server - the device waits for incoming connections.
  • Client - the device initiates the connection.
  • Bidirect - acts as client by default but waits for incoming connections at the same time.
Protocol TCP | UDP; default: TCP Protocol used in the communication process.
Raw mode off | on; default; default: off When enabled, all data will be transmitted transparently.
No leading zeros off | on; default: off When checked, indicates that the first hex zeros should be skipped.
Server settings: Port integer [0..65535]; default: none Internal port number used to listen for incoming connections.
Server settings | TCP: Timeout (s) integer [0..32767]; default: 300 Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected.
Server settings | UDP: Predefined client 1 address ip4; default: none Specifies IP address for predefined connection 1.
Server settings | UDP: Predefined port 1 port; default: none Specifies port number for predefined connection 1.
Server settings | UDP: Predefined client 2 address ip4; default: none Specifies IP address for predefined connection 2.
Server settings | UDP: Predefined port 2 port; default: none Specifies port number for predefined connection 2.
Client settings: Server Address ip | host; default: none IP address or hostname of the server that this client will connect to.
Client settings: Port integer [0..65535]; default: none Server's listening port number.
Client settings: Reconnect interval (s) integer; default: none Time period (in seconds) between reconnection attempts in case a connection fails.
Serial device read time integer [0..1000]; default: none Specifies custom read time for the serial device.
Server settings | TCP: Max clients integer [1..32]; default: 32 Specifies how many clients are allowed to connect simultaneously.
TCP: TCP echo off | on; default: off Enables software TCP echo.
TCP: Always reconnect off | on; default: off When enabled, a new TCP connection will be made after sending every data package.

IP Filter

The IP Filter section is used for configuring which network is allowed to communicate with the device. You may add a new instance by selecting the Interface and pressing Add.

Then enter the IP address and save.

[[Category:{{{name}}} Services section]]

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_serial_utilities&oldid=111393"