Jump to content
  • EN

Template:Networking rutos manual serial utilities: Difference between revisions

← Older editNewer edit →
VisualWikitext
No edit summary
No edit summary
(35 intermediate revisions by 5 users not shown)
Line 7: Line 7:
  }}
  }}
}}
}}
<br><i><b>Note</b>: {{#ifeq:{{{rs232}}}|1|
 
<b>[[{{{name}}} RS232|RS232]]</b>|}}{{#ifeq:{{{rs232}}}|1|{{#ifeq:{{{rs485}}}|1|&#32;and&#32;|}}|}}{{#ifeq:{{{rs485}}}|1|<b>[[{{{name}}} RS485|RS485]]</b>|}} services were merged and moved to <b>Serial Utilities</b> page from FW version {{{series}}}_R_00.07.03</i>.
{{#ifeq: {{{series}}}| RUT9 |<i><b>Note</b>: <b>[[{{{name}}} RS232/RS485 (legacy WebUI)#RS232|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT9 |<i><b>Note</b>: <b>[[{{{name}}} RS232/RS485 (legacy WebUI)#RS232|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==


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.
{{#ifeq:{{{name}}}|TRB143||
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:
[[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.
This manual page provides an overview of the Serial Utilities page in {{{name}}} devices.
{{#ifeq: {{#expr: {{{rs232}}} or {{{rs485}}}}}| 1 |==General information==|}}
{{#ifeq: {{#expr: {{{rs232}}} or {{{rs485}}}}}| 1 |==General information==|}}
{{#ifeq:{{{series}}}|TRB2|
{{#switch:{{{series}}}|TRB2| TRB2M | RUT206 =
===RS232/RS485===
===RS232/RS485===
----
----
====Connector pinout====
====Connector pinout====
----
----
For {{{name}}} pinout, please refer to <b>[[{{{name}}} Input/Output#16_pin_Connector_Pinout|Input/Output]]</b> page.|
For {{{name}}} pinout, please refer to <b>[[QSG {{{name}}}#Front_view|QSG]]</b> page.| #default =
{{#ifeq: {{{rs232}}} | 1 |
{{#ifeq: {{{rs232}}} | 1 |
===RS232===
===RS232===
Line 38: Line 25:
====Connector pinout====
====Connector pinout====
----
----
The RS232 connector type on this device is a '''DCE female'''. DCE stands for Data Communication Equipment.  
The following table lists commonly used RS-232 signals ('''DTE male''' to '''DCE female'''). The RS232 connector type on device is a DCE female.


[[File:Services_rs232_connector.PNG|400px]]
[[File:Services_rs232_connector_v1.png|400px]]


<table class="nd-othertables">
<table class="nd-othertables">
Line 53: Line 40:
       <td>DCD</td>
       <td>DCD</td>
       <td>Data Carrier Detect</td>
       <td>Data Carrier Detect</td>
       <td>Output</td>
       <td>Input</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 59: Line 46:
       <td>RXD</td>
       <td>RXD</td>
       <td>Receive Data</td>
       <td>Receive Data</td>
       <td>Output</td>
       <td>Input</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 65: Line 52:
         <td>TXD</td>
         <td>TXD</td>
         <td>Transmit Data</td>
         <td>Transmit Data</td>
       <td>Input</td>
       <td>Output</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 71: Line 58:
         <td>DTR</td>
         <td>DTR</td>
         <td>Data Terminal Ready</td>
         <td>Data Terminal Ready</td>
       <td>Input</td>
       <td>Output</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 83: Line 70:
       <td>DSR</td>
       <td>DSR</td>
       <td>Data Set Ready</td>
       <td>Data Set Ready</td>
       <td>Output</td>
       <td>Input</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 89: Line 76:
         <td>RTS</td>
         <td>RTS</td>
         <td>Ready To Send</td>
         <td>Ready To Send</td>
       <td>Input</td>
       <td>Output</td>
     </tr>
     </tr>
     <tr>
     <tr>
Line 95: Line 82:
         <td>CTS</td>
         <td>CTS</td>
         <td>Clear To Send</td>
         <td>Clear To Send</td>
       <td>Output</td>
       <td>Input</td>
     </tr>{{#ifeq:{{{series}}}|TRB1|
     </tr>{{#ifeq:{{{series}}}|TRB1|
     <tr>
     <tr>
Line 101: Line 88:
         <td>RI</td>
         <td>RI</td>
         <td>Ring Indicator</td>
         <td>Ring Indicator</td>
       <td>Output (connected to +3.8V permanently via a 4.7k resistor) </td>
       <td>Input (connected to +3.8V permanently via a 4.7k resistor) </td>
     </tr>|
     </tr>|
     <tr>
     <tr>
Line 107: Line 94:
         <td>RI</td>
         <td>RI</td>
         <td>Ring Indicator</td>
         <td>Ring Indicator</td>
       <td>Output (connected to +5V permanently via a 4.7k resistor) </td>
       <td>Input (connected to +5V permanently via a 4.7k resistor) </td>
     </tr>}}
     </tr>}}
</table>
</table>
Line 240: Line 227:
}}
}}


==Modem Control==  
{{#ifeq:{{{modem}}}|1|==Modem Control==  


The <b>Modem</b> 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.
The <b>Modem</b> 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.


{{#ifeq:{{{dual_modem}}} | 1 |
===Status===
[[File:Networking_rutos_manual_serial_utilities_modem_control_default_{{{default}}}_dual_modem_v1.png|border|class=tlt-border]]|
 
[[File:Networking_rutos_manual_serial_utilities_modem_control_default_{{{default}}}_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_serial_utilities_modem_control_status.png|border|class=tlt-border]]
}}
 
===General settings===


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


<table class="nd-mantable">
<table class="nd-mantable">
Line 270: Line 259:
         <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>{{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>
         <td>Specifies which serial port will be used for serial communication.</td>
     </tr>
     </tr>{{#ifeq: {{{rs485}}} | 1 |
    <tr>
    <td>Baud rate (RS485)</td>
        <td>integer [300..230400]; default:<b>9600</b></td>
        <td>Data rate for serial data transmission (in bits per second (bps)).</td>
    </tr>|}}{{#ifeq: {{{rs232}}} | 1 |
    <tr>
    <td>Baud rate (RS232)</td>
        <td>integer [300..115200]; default:<b>9600</b></td>
        <td>Data rate for serial data transmission (in bits per second (bps)).</td>
    </tr>|}}{{#ifeq: {{{usb}}} | 1 |
     <tr>
     <tr>
     <td>Baud rate</td>
     <td>Baud rate (USB)</td>
         <td>integer [300..3000000]; default: <b>9600</b></td>
         <td>integer [300..4000000]; default:<b>9600</b></td>
         <td>Data rate for serial data transmission (in bits per second (bps)).</td>
         <td>Data rate for serial data transmission (in bits per second (bps)).</td>
     </tr>
     </tr>|}}
     <tr>
     <tr>
     <td>Data bits</td>
     <td>Data bits</td>
         <td>7 {{!}} 8; default: <b>8</b></td>
         <td>{{#ifeq: {{{rs232}}} | 1 | 5 {{!}} 6 {{!}} 7 {{!}} 8 | 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>
Line 317: Line 316:
             </ul>
             </ul>
         </td>
         </td>
     </tr> |}}
     </tr>|}}
     <tr>
     <tr>
         <td>Mode</td>
         <td>Mode</td>
Line 327: Line 326:
             </ul>
             </ul>
         </td>
         </td>
     </tr>{{#ifeq: {{{rs485}}} | 1 |
     </tr>{{#switch: {{{series}}} | RUT206 = | #default = {{#ifeq: {{{rs485}}} | 1 |
     <tr>
     <tr>
       <td><span style="color: purple;">RS485:</span> Full Duplex</td>
       <td><span style="color: purple;">RS485:</span> Full Duplex</td>
       <td>off {{!}} on; default: <b>off</b></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>
       <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
     </tr>|}}
     </tr>|}}}}
</table>
 
===Advanced settings===
{{#switch: {{{name}}} | TRB142 | TRB145 =
[[File:Networking_rutos_manual_serial_utilities_modem_control_advanced_settings_trb.png|border|class=tlt-border]]
| #default = [[File:Networking_rutos_manual_serial_utilities_modem_control_advanced_settings.png|border|class=tlt-border]]}}
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
     <tr>
     <tr>
        <td>Start up message</td>
      <td>Start up message</td>
       <td>string; default: <b>none</b></td>
       <td>string; default: <b>none</b></td>
       <td>Message to print to serial device when modem control is ready.</td>
       <td>Prints message to serial device when modem control is ready.</td>
    </tr>{{#switch: {{{name}}} | TRB142 | TRB145 =
    <tr>
      <td>Data mode</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Enable this option to allow data mode. Data mode will not operate without it.</td>
    </tr>| #default =}}
    <tr>
      <td>Canonical mode</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Forwards data to modem only when new line symbol ('\n') is detected.</td>
     </tr>
     </tr>
</table>
</table>|}}


==Console==
{{#switch: {{{name}}} | TRB143 = | #default = ==Console==  


<b>Console</b> 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.
<b>Console</b> 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]]
===Status===
[[File:Networking_rutos_manual_serial_utilities_console_status.png|border|class=tlt-border]]
 
===General settings===
[[File:Networking_rutos_manual_serial_utilities_console_general.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 366: Line 392:
         <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>{{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>
         <td>Specifies which serial port will be used for serial communication.</td>
     </tr>
     </tr>{{#ifeq: {{{rs485}}} | 1 |
    <tr>
    <td>Baud rate (RS485)</td>
        <td>integer [300..230400]; default:<b>9600</b></td>
        <td>Data rate for serial data transmission (in bits per second (bps)).</td>
    </tr>|}}{{#ifeq: {{{rs232}}} | 1 |
    <tr>
    <td>Baud rate (RS232)</td>
        <td>integer [300..115200]; default:<b>9600</b></td>
        <td>Data rate for serial data transmission (in bits per second (bps)).</td>
    </tr>|}}{{#ifeq: {{{usb}}} | 1 |
     <tr>
     <tr>
     <td>Baud rate</td>
     <td>Baud rate (USB)</td>
         <td>integer [300..3000000]; default: <b>9600</b></td>
         <td>integer [300..4000000]; default:<b>9600</b></td>
         <td>Data rate for serial data transmission (in bits per second (bps)).</td>
         <td>Data rate for serial data transmission (in bits per second (bps)).</td>
     </tr>
     </tr>|}}
     <tr>
     <tr>
     <td>Data bits</td>
     <td>Data bits</td>
         <td>7 {{!}} 8; default: <b>8</b></td>
         <td>{{#ifeq: {{{rs232}}} | 1 | 5 {{!}} 6 {{!}} 7 {{!}} 8 | 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>
Line 402: Line 438:
             </ul>|}}
             </ul>|}}
         </td>
         </td>
     </tr>{{#ifeq: {{{rs485}}} | 1 |
     </tr>{{#switch: {{{series}}} | RUT206 = | #default = {{#ifeq: {{{rs485}}} | 1 |
     <tr>
     <tr>
       <td><span style="color: purple;">RS485:</span> Full Duplex</td>
       <td><span style="color: purple;">RS485:</span> Full Duplex</td>
       <td>off {{!}} on; default: <b>off</b></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>
       <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
     </tr>|}}
     </tr>|}}}}
</table>
</table> }}
}}
 
==Over IP==
==Over IP==


The <b>Over IP</b> serial type is used to manage serial connections over a TCP/IP network.
The <b>Over IP</b> serial type is used to manage serial connections over a TCP/IP network.
===Instance Example===
----
Here's an example demonstrating Over IP in action, running in Client + Server Mode.
[[File:Networking_rutos_manual_serial_utilities_over_ip_configuration_example_v1.png|border|class=tlt-border]]


===Serial Device Configuration===
===Serial Device Configuration===
Line 438: Line 479:
     <tr>
     <tr>
         <td>Device</td>
         <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>{{#ifeq:{{{default}}}|mbus|MBUS| {{Template: Networking_rutos_manual_serial_ports | rs232={{{rs232}}} | rs485={{{rs485}}} | usb={{{usb}}} }}}}; default: <b>{{#ifeq:{{{default}}}|mbus|MBUS| {{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>
         <td>Specifies which serial port will be used for serial communication.</td>
     </tr>
     </tr>{{#ifeq: {{{rs485}}} | 1 |
    <tr>
    <td>Baud rate (RS485)</td>
        <td>integer [300..230400]; default:<b>9600</b></td>
        <td>Data rate for serial data transmission (in bits per second (bps)).</td>
    </tr>|}}{{#ifeq: {{{rs232}}} | 1 |
    <tr>
    <td>Baud rate (RS232)</td>
        <td>integer [300..115200]; default:<b>9600</b></td>
        <td>Data rate for serial data transmission (in bits per second (bps)).</td>
    </tr>|}}{{#ifeq: {{{usb}}} | 1 |
     <tr>
     <tr>
     <td>Baud rate</td>
     <td>Baud rate (USB)</td>
         <td>integer [300..3000000]; default: <b>9600</b></td>
         <td>integer [300..4000000]; default:<b>9600</b></td>
         <td>Data rate for serial data transmission (in bits per second (bps)).</td>
         <td>Data rate for serial data transmission (in bits per second (bps)).</td>
     </tr>
     </tr>|}}
     <tr>
     <tr>
     <td>Data bits</td>
     <td>Data bits</td>
         <td>5 {{!}} 6 {{!}} 7 {{!}} 8; default: <b>8</b></td>
         <td>{{#ifeq: {{{rs232}}} | 1 | 5 {{!}} 6 {{!}} 7 {{!}} 8 | 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>{{#switch: {{{name}}} | TRB143 = 1; default: <b>1</b>  | #default = 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>{{#switch: {{{name}}} | TRB143 = Even {{!}} default: Even | #default = 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 476: Line 527:
             </ul>|}}
             </ul>|}}
         </td>
         </td>
     </tr>{{#ifeq: {{{rs485}}} | 1 |
     </tr>{{#switch: {{{series}}} | RUT206 = | #default = {{#ifeq: {{{rs485}}} | 1 |
     <tr>
     <tr>
       <td><span style="color: purple;">RS485:</span> Full Duplex</td>
       <td><span style="color: purple;">RS485:</span> Full Duplex</td>
       <td>off {{!}} on; default: <b>off</b></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>
       <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
     </tr>|}}{{#ifeq: {{{rs232}}} | 1 |
     </tr>|}}}}{{#ifeq: {{{rs232}}} | 1 |
     <tr>
     <tr>
       <td><span style="color: green;">RS232:</span> Echo</td>
       <td><span style="color: green;">RS232:</span> Echo</td>
Line 535: Line 586:
     </table>
     </table>


[[File:Networking rutos manual serial utilities over ip mbus configuration security_v1.png|border|class=tlt-border]]
[[File:Networking rutos manual serial utilities over ip mbus configuration security_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 600: Line 651:
</table>
</table>


[[File:Networking rutos manual serial utilities over ip mbus configuration advanced_v2.png|border|class=tlt-border]]
[[File:Networking rutos manual serial utilities over ip mbus configuration advanced_v3.png|border|class=tlt-border]]
      
      
     <table class="nd-mantable">
     <table class="nd-mantable">
Line 642: Line 693:
         <td>on {{!}} off; default: <b>off</b></td>
         <td>on {{!}} off; default: <b>off</b></td>
         <td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>
         <td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>
    </tr>
        <tr>
    <td>Keep alive</td>
        <td><span style="color: blue;">on</span> {{!}} off; default: <b>off</b></td>
        <td>Enable keep alive.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Keep alive time</td>
     <td><span style="color: blue;">Keep alive time</span></td>
         <td>integer [0..32000]; default: <b>0</b></td>
         <td>integer [0..32000]; default: <b>0</b></td>
         <td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>
         <td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Keep alive interval</td>
     <td><span style="color: blue;">Keep alive interval</span></td>
         <td>integer [0..32000]; default: <b>0</b></td>
         <td>integer [0..32000]; default: <b>0</b></td>
         <td>The interval between subsequential keepalive probes.</td>
         <td>The interval between subsequential keepalive probes.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Keep alive probes</td>
     <td><span style="color: blue;">Keep alive probes</span></td>
         <td>integer [0..32000]; default: <b>0</b></td>
         <td>integer [0..32000]; default: <b>0</b></td>
         <td>The number of unacknowledged probes.</td>
         <td>The number of unacknowledged probes.</td>
Retrieved from "https://wiki.teltonika-networks.com/view/Template:Networking_rutos_manual_serial_utilities"