45
edits
Changes
Template:Networking rutos manual serial utilities (view source)
Revision as of 10:45, 13 May 2024
, 13 Mayno edit summary
}}
}}
{{#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.
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 =
===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>[[{{{name}}} Input/Output#16_pin_Connector_Pinout|Input/Output]]</b> page.| #default =
{{#ifeq: {{{rs232}}} | 1 |
{{#ifeq: {{{rs232}}} | 1 |
===RS232===
===RS232===
}}
}}
==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.
<td>Message to print to serial device when modem control is ready.</td>
<td>Message to print to serial device when modem control is ready.</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.
<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===
<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>
<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>
</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">
</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">
<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>
