Difference between revisions of "Template:Networking rutos manual serial utilities"
(25 intermediate revisions by 4 users not shown) | |||
Line 7: | Line 7: | ||
}} | }} | ||
}} | }} | ||
− | + | <br><i><b>Note</b>: {{#ifeq:{{{rs232}}}|1| | |
− | {{#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>|}} | + | <b>[[{{{name}}} RS232|RS232]]</b>|}}{{#ifeq:{{{rs232}}}|1|{{#ifeq:{{{rs485}}}|1| and |}}|}}{{#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>|}} | ||
==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|==Over IP== <!-----------------TRB143 has Only 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_mbus_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>mbus; default: <b>mbus</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; 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> | ||
+ | </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 mbus configuration general.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>Listening port</td> | ||
+ | <td>[1..65535]; default: <b>empty</b></td> | ||
+ | <td>When enabled, all data will be transmitted transparently.</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | |||
+ | [[File:Networking rutos manual serial utilities over ip mbus configuration advanced.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>Raw mode</td> | ||
+ | <td>off {{!}} on; default: <b>on</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>Inactivity timeout</td> | ||
+ | <td>integer [0..36000]; default: <b>300</b></td> | ||
+ | <td>Specifies period of time in seconds, where server connection must be inactive, to disconnect client. To disable timeout input 0.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Serial timeout</td> | ||
+ | <td>integer [0..1000]; default: <b>none</b></td> | ||
+ | <td>Specifies the maximum milliseconds to wait for serial data.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Max clients</td> | ||
+ | <td>integer [1..32]; default: <b>4</b></td> | ||
+ | <td>Specify how many clients are allowed to connect simultaneously.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>TCP echo</td> | ||
+ | <td>on {{!}} off; default: <b>off</b></td> | ||
+ | <td>Enable software TCP echo.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Close connections</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> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Kepp alive time</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> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Kepp alive interval</td> | ||
+ | <td>integer [0..32000]; default: <b>0</b></td> | ||
+ | <td>The interval between subsequential keepalive probes.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Kepp alive probes</td> | ||
+ | <td>integer [0..32000]; default: <b>0</b></td> | ||
+ | <td>The number of unacknowledged probes.</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | |||
+ | ===IP Filter=== | ||
+ | ---- | ||
+ | The <b>IP Filter</b> 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. | ||
+ | |||
+ | [[File:Networking_rutos_manual_console_ip_filter.png|border|class=tlt-border]] | ||
+ | |||
+ | Then enter the IP address and save. | ||
+ | |||
+ | [[File:Networking_rutos_manual_console_ip_filter_instance.png|border|class=tlt-border]] | ||
+ | |||
+ | |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| |
===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.| |
{{#ifeq: {{{rs232}}} | 1 | | {{#ifeq: {{{rs232}}} | 1 | | ||
===RS232=== | ===RS232=== | ||
Line 227: | Line 414: | ||
}} | }} | ||
− | + | ==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. | ||
Line 257: | Line 444: | ||
<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> |
<tr> | <tr> | ||
− | <td>Baud rate | + | <td>Baud rate</td> |
− | <td>integer [300.. | + | <td>integer [300..3000000]; 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> | + | <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> | ||
Line 335: | Line 512: | ||
<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== | |
<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. | ||
Line 363: | Line 540: | ||
<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> |
<tr> | <tr> | ||
− | <td>Baud rate | + | <td>Baud rate</td> |
− | <td>integer [300.. | + | <td>integer [300..3000000]; 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> | + | <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> | ||
Line 415: | Line 582: | ||
<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. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
===Serial Device Configuration=== | ===Serial Device Configuration=== | ||
Line 450: | Line 612: | ||
<tr> | <tr> | ||
<td>Device</td> | <td>Device</td> | ||
− | <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> |
<tr> | <tr> | ||
− | <td>Baud rate | + | <td>Baud rate</td> |
− | <td>integer [300.. | + | <td>integer [300..3000000]; 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> | + | <td>5 {{!}} 6 {{!}} 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> | + | <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> | + | <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 548: | Line 700: | ||
<td><span style="color: red;">Server: </span><span style="color: brown;">UDP: </span> Predefined addresses</td> | <td><span style="color: red;">Server: </span><span style="color: brown;">UDP: </span> Predefined addresses</td> | ||
<td>IP {{!}} Port; default: <b>empty</b></td> | <td>IP {{!}} Port; default: <b>empty</b></td> | ||
− | <td> | + | <td></td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 556: | Line 708: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | + | ||
− | + | [[File:Networking rutos manual serial utilities over ip mbus configuration advanced_v1.png|border|class=tlt-border]] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | [[File:Networking rutos manual serial utilities over ip mbus configuration | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 664: | Line 751: | ||
<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> | ||
<tr> | <tr> | ||
− | <td | + | <td>Keep alive time</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 | + | <td>Keep alive interval</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 | + | <td>Keep alive probes</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> | ||
Line 695: | Line 777: | ||
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 17:05, 19 December 2023
The information in this page is updated in accordance with firmware version .
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}}}_v2.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.
|
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.
|
Start up message | string; default: none | Message to print to serial device when modem control is ready. |
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.
|
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}}}_v2.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 | 5 | 6 | 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.
|
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 | Client + server | Bidirect; default: Server | This device's role in the connection:
|
Protocol | TCP | UDP; default: TCP | Protocol used in the communication process. |
Client: Destination address | IP | Port; default: empty | Specify server address and port for client to connect to. E.g first field for address second for port. 16 destination addresses are allowed. |
Server: UDP: Predefined addresses | IP | Port; default: empty | |
Listening port | [1..65535]; default: empty | When enabled, all data will be transmitted transparently. |
File:Networking rutos manual serial utilities over ip mbus configuration advanced v1.png
Field | Value | Description |
---|---|---|
Raw mode | off | on; default: on | When enabled, all data will be transmitted transparently. |
Remove all zeros | off | on; default: off | When checked, indicates that the first hex zeros should be skipped. |
Inactivity timeout | integer [0..36000]; default: 300 | Specifies period of time in seconds, where server connection must be inactive, to disconnect client. To disable timeout input 0. |
Serial timeout | integer [0..1000]; default: none | Specifies the maximum milliseconds to wait for serial data. |
Max clients | integer [1..32]; default: 4 | Specify how many clients are allowed to connect simultaneously. |
TCP echo | on | off; default: off | Enable software TCP echo. |
Close connections | on | off; default: off | Close TCP connections everytime data is sent or received (might result in serial data loss). |
Keep alive time | integer [0..32000]; default: 0 | Close TCP connections everytime data is sent or received (might result in serial data loss). |
Keep alive interval | integer [0..32000]; default: 0 | The interval between subsequential keepalive probes. |
Keep alive probes | integer [0..32000]; default: 0 | The number of unacknowledged probes. |
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]]