Changes

Template:Networking rutos manual serial utilities (view source)

Revision as of 09:24, 15 April 2024

3,391 bytes added , 15 April

no edit summary

Line 1: Line 1: −

{{Template: ~~Networking_rutos_manual_fw_disclosure~~

+

{{Template: Networking_device_manual_fw_disclosure

−

| fw_version ={{Template: ~~Networking_rutos_manual_latest_fw~~

+

| series = {{{series}}}

+

| name = {{{name}}}

+

| fw_version ={{Template: Networking_device_manual_latest_fw

| series = {{{series}}}

| name = {{{name}}}

}}

+

{{#ifeq: {{{series}}} | RUT9 |Note: [[{{{name}}} RS232/RS485 (legacy WebUI)#RS232|click here]] for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.|}}

==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.

−

+

{{#ifeq: {{#expr: {{{rs232}}} or {{{rs485}}}}}| 1 |==General information==|}}

+

{{#switch:{{{series}}}|TRB2| TRB2M =

+

===RS232/RS485===

+

----

+

====Connector pinout====

+

----

+

For {{{name}}} pinout, please refer to [[{{{name}}} Input/Output#16_pin_Connector_Pinout|Input/Output]] page.| #default =

{{#ifeq: {{{rs232}}} | 1 |

−

~~==General information==~~

===RS232===

----

Line 116: Line 114:

----

−

To connect another DCE device to ~~RUT955~~, a Null-modem (crossed) Male/Male cable should be used:

+

To connect another DCE device to RUT/TRB, a Null-modem (crossed) Male/Male cable should be used:

[[File:Male male rs232 cable.jpg]]

Line 171: Line 169:

<tr>

−

+

<td style="border: 1px solid black;">Power input 9-30 VDC</td>

<td style="border: 1px solid white; border-left: 1px solid black; width: 250px" colspan="1">filler text</td>

Line 202: Line 200:

</tr>

−

</table>}}

+

</table>

====Maximum data rate vs. transmission line length====

----

Line 221: Line 219:

Below is an example of a 4-wire network electrical connection. There are 3 devices shown in the example. One of the devices is the "master" and other two are "slaves". Termination resistors (120 Ω each) are placed at each cable end. Four-wire networks consists of one master with its transmitter connected to each of the slaves' receivers on one twisted pair. The slave transmitters are all connected to the master receiver on a second twisted pair:

−

[[File:Services rs485 ~~4wire~~.PNG]]

+

[[File:Services rs485 4wire_v2.PNG]]

Example 2-wire network electrical connection: to enable a 2-wire RS485 configuration you need to connect D_P to R_P and D_N to R_N on the device’s RS485 socket. Termination resistors are placed at each cable end (120 Ω each):

−

[[File:Services rs485 ~~2wire~~.PNG]]

+

[[File:Services rs485 2wire_v2.PNG]]

|}}

+

}}

−

==Modem Control==

+

{{#ifeq:{{{modem}}}|1|==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]]

+

{{#ifeq:{{{dual_modem}}} | 1 |

+

[[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]]

+

}}

+

Line 242: Line 245:

<tr>

<td>Enable</td>

−

<td>off | on; default: off</td>

+

<td>off {{!}} on; default: off</td>

<td>Turns the instance on or off.</td>

</tr>

Line 262: Line 265:

<tr>

−

<td>7 | 8; default: 8</td>

+

<td>{{#ifeq: {{{rs232}}} | 1 | 5 {{!}} 6 {{!}} 7 {{!}} 8 | 8}}; default: 8</td>

<td>Number of data bits for each character.</td>

</tr>

<tr>

−

<td>1 | 2; default: 1</td>

+

<td>1 {{!}} 2; default: 1</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: None</td>

+

<td>None {{!}} Odd {{!}} Even {{!}} Mark {{!}} Space; default: None</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>

Line 287: Line 290:

<ul>

<li>RTS/CTS - 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>Xon/Xoff - 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>Xon/Xoff - 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: {{{dual_modem}}} | 1 |

+

<tr>

+

<td>Modem</td>

+

<td>Primary modem{{!}} Secondary modem; default: Primary modem</td>

+

<td>Specifies modem, which will be used for modem control.

+

<ul>

+

<li>Primary modem- enables modem control for Primary modem.</li>

+

<li>Secondary modem- enables modem control for Secondary modem.</li>

+

</ul>

+

</td>

+

</tr> |}}

<tr>

Line 296: Line 310:

<td>Specifies modem control mode.

<ul>

−

<li>Partial control- enables modem control with AT commands, mobile connection will be controlled by RUTOS.

+

<li>Partial control- enables modem control with AT commands, mobile connection will be controlled by RUTOS.</li>

−

<li>Full control- enables modem control with AT commands, mobile connection will be controlled by user.

+

<li>Full control- enables modem control with AT commands, mobile connection will be controlled by user. </li>

</ul>

</td>

Line 306: Line 320:

<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>

</tr>|}}

−

</table>

+

<tr>

+

<td>Start up message</td>

+

<td>string; default: none</td>

+

<td>Message to print to serial device when modem control is ready.</td>

+

</tr>

+

</table>|}}

==Console==

Line 322: Line 341:

<tr>

<td>Enable</td>

−

<td>off | on; default: off</td>

+

<td>off {{!}} on; default: off</td>

<td>Turns the instance on or off.</td>

</tr>

Line 342: Line 361:

<tr>

−

<td>7 | 8; default: 8</td>

+

<td>{{#ifeq: {{{rs232}}} | 1 | 5 {{!}} 6 {{!}} 7 {{!}} 8 | 8}}; default: 8</td>

<td>Number of data bits for each character.</td>

</tr>

<tr>

−

<td>1 | 2; default: 1</td>

+

<td>1 {{!}} 2; default: 1</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>

<td>Parity</td>

−

<td>None | Odd | Even | Mark | Space; default: None</td>

+

<td>None {{!}} Odd {{!}} Even {{!}} Mark {{!}} Space; default: None</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>

Line 367: Line 386:

<ul>

<li>RTS/CTS - 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>Xon/Xoff - 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>Xon/Xoff - 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>

Line 386: Line 405:

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]]

+

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

Line 396: Line 415:

<tr>

<td>Enable</td>

−

<td>off | on; default: off</td>

+

<td>off {{!}} on; default: off</td>

<td>Turns the instance on or off.</td>

</tr>

Line 416: Line 435:

<tr>

−

<td>7 | 8; default: 8</td>

+

<td>{{#ifeq: {{{rs232}}} | 1 | 5 {{!}} 6 {{!}} 7 {{!}} 8 | 8}}; default: 8</td>

<td>Number of data bits for each character.</td>

</tr>

<tr>

−

<td>1 | 2; default: 1</td>

+

<td>1 {{!}} 2; default: 1</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: None</td>

+

<td>None {{!}} Odd {{!}} Even {{!}} Mark {{!}} Space; default: None</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>

Line 441: Line 460:

<ul>

<li>RTS/CTS - 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>Xon/Xoff - 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>Xon/Xoff - 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>

Line 449: Line 468:

<td>off {{!}} on; default: off</td>

<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>

+

</tr>|}}{{#ifeq: {{{rs232}}} | 1 |

+

<tr>

+

+

<td>off {{!}} on; default: off</td>

+

<td> Enable serial device echo. This option is available only on the RS232 device.</td>

</tr>|}}

</table>

Line 456: Line 480:

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

−

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

+

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

Line 466: Line 490:

<tr>

−

<td>Server | Client | Bidirect; default: Server</td>

+

<td>Server {{!}} Client {{!}} Client + server {{!}} Bidirect; default: Server</td>

<td>This device's role in the connection:

<ul>

<li>Server - the device waits for incoming connections.</li>

<li>Client - the device initiates the connection.</li>

+

<li>Client + server - launches service in server and client(s) mode simultaneously.</li>

<li>Bidirect - acts as client by default but waits for incoming connections at the same time.</li>

</ul>

Line 477: Line 502:

<tr>

<td>Protocol</td>

−

<td>TCP | UDP; default: TCP</td>

+

<td>TCP {{!}} UDP; default: TCP</td>

<td>Protocol used in the communication process.</td>

</tr>

<tr>

−

+

<td>Client: Destination address</td>

−

<td>~~off~~ {{!}} on; default; default: ~~off~~</td>

+

<td>IP {{!}} Port; default: empty</td>

+

<td>Specify server address and port for client to connect to. E.g first field for address second for port. 16 destination addresses are allowed. </td>

+

</tr>

+

<tr>

+

<td>Server: UDP: Predefined addresses</td>

+

<td>IP {{!}} Port; default: empty</td>

+

<td>Set predefined IP and port for UDP connection. E.g first field for address second for port.</td>

+

</tr>

+

<tr>

+

<td>Listening port</td>

+

<td>[1..65535]; default: empty</td>

<td>When enabled, all data will be transmitted transparently.</td>

+

</tr>

+

</table>

+

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

+

+

<tr>

+

<th style="width: 360px>Field</th>

+

<th>Value</th>

+

<th>Description</th>

</tr>

<tr>

−

<td>~~No leading zeros~~</td>

+

−

<td>off | on; default: off</td>

+

<td>off {{!}} on; default: off</td>

−

<td>~~When checked, indicates that the first hex zeros should be skipped~~.</td>

+

<td>Mark to use TLS/SSL for connection.</td>

</tr>

<tr>

−

<td>~~Server settings: Port~~</td>

+

<td>TLS version</td>

−

<td>~~integer [~~0..~~65535]~~; default: ~~none~~</td>

+

<td>Support all {{!}} tlsv1.0 {{!}} tlsv1.1 {{!}} tlsv1.2 {{!}} tlsv1.3; default: Support all</td>

−

<td>~~Internal port number~~ used ~~to listen for incoming connections~~.</td>

+

<td>Minimum TLS version allowed to be used.</td>

</tr>

<tr>

−

<td><~~span style="color: red;"~~>~~Server settings~~<~~/span~~> | ~~TCP~~~~: Timeout (s)</td>~~

+

−

~~<td>integer [0..32767]~~; default: ~~300~~</td>

+

<td>Certificate based {{!}} Pre-Shared-Key based; default: Certificate based</td>

−

<td>~~Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected~~.</td>

+

<td>Select the type of TLS encryption.</td>

</tr>

<tr>

−

<td>~~Server settings | UDP: Predefined client 1 address~~</td>

+

<td>Require certificate</td>

−

<td>~~ip4~~; default: ~~none~~</td>

+

<td>off {{!}} on; default: on</td>

−

<td>~~Specifies IP address for predefined connection 1~~.</td>

+

<td>Demand certificate and key from peer and verify them against certificate authority.</td>

</tr>

<tr>

−

<td>~~Server settings | UDP: Predefined port 1~~</td>

+

<td>Verify host</td>

−

<td>~~port~~; default: ~~none~~</td>

+

<td>off {{!}} on; default: off</td>

−

<td>~~Specifies port number for predefined connection 1~~.</td>

+

<td>Check if the server certificates Common Name (CN) matches hostname to which client is connecting.</td>

</tr>

<tr>

−

<td>~~Server settings | UDP: Predefined client 2 address~~</td>

+

<td>Certificate files from device</td>

−

<td>~~ip4~~; default: ~~none~~</td>

+

<td>off {{!}} on; default: off</td>

−

<td>~~Specifies IP address for predefined connection 2~~.</td>

+

<td>Choose this option if you want to select certificate files from device. Certificate files can be generated <a class=link href="/system/admin/certificates/generation">here</a>.</td>

</tr>

<tr>

−

<td>~~Server settings | UDP: Predefined port 2~~</td>

+

<td>Certificate file</td>

−

<td>~~port~~; default: none</td>

+

<td>.crt file; default: none</td>

−

<td>~~Specifies port number for predefined connection 2~~.</td>

+

<td>Upload certificate file.</td>

</tr>

<tr>

−

<td>~~Client settings: Server Address~~</td>

+

−

<td>~~ip | host~~; default: none</td>

+

<td>.key file; default: none</td>

−

<td>~~IP address or hostname of the server that this client will connect to~~.</td>

+

<td>Upload key file.</td>

</tr>

<tr>

−

<td>~~Client settings: Port~~</td>

+

−

<td>~~integer [0.~~.~~65535]~~; default: none</td>

+

<td>.ca file; default: none</td>

−

<td>~~Server's listening port number~~.</td>

+

<td>Upload CA file.</td>

</tr>

<tr>

−

<td>~~Client settings~~~~: Reconnect interval (s)~~</td>

+

<td>Pre-Shared-Key</td>

−

<td>~~integer~~; default: none</td>

+

<td>string; default: none</td>

−

<td>~~Time period (in seconds) between reconnection attempts~~ in ~~case a connection fails~~.</td>

+

<td>The pre-shared-key in hex format with no leading “0x”.</td>

</tr>

<tr>

−

<td>Serial ~~device read time~~</td>

+

<td>Identify</td>

+

<td>string; default: none</td>

+

<td>Specify the identity.</td>

+

</tr>

+

</table>

+

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

+

+

<tr>

+

<th style="width: 360px>Field</th>

+

<th>Value</th>

+

<th>Description</th>

+

</tr>

+

<tr>

+

+

<td>off {{!}} on; default: on</td>

+

<td>When enabled, all data will be transmitted transparently.</td>

+

</tr>

+

<tr>

+

<td>Remove all zeros</td>

+

<td>off {{!}} on; default: off</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: 300</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: none</td>

−

<td>Specifies ~~custom read time~~ for ~~the~~ serial ~~device~~.</td>

+

<td>Specifies the maximum milliseconds to wait for serial data.</td>

−

</tr>~~{{#ifeq~~: {{~~{rs485~~}}~~} | 1 |~~

+

</tr>

+

<tr>

+

<td>Max clients</td>

+

<td>integer [1..32]; default: 4</td>

+

<td>Specify how many clients are allowed to connect simultaneously.</td>

+

</tr>

+

<tr>

+

+

<td>on {{!}} off; default: off</td>

+

<td>Enable software TCP echo.</td>

+

</tr>

<tr>

−

<td><~~span style="color~~: ~~purple;"~~>~~RS485:~~</~~span~~> ~~Full Duplex~~</td>

+

<td>Close connections</td>

−

<td>~~off~~ {{!}} on; default: off</td>

+

<td>on {{!}} off; default: off</td>

−

<td>~~Turns Full Duplex mode on or off. This option is available only on the RS485 device~~.</td>

+

<td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>

−

</tr>~~|}}~~

+

</tr>

+

<tr>

+

<td>Keep alive</td>

+

<td>on {{!}} off; default: off</td>

+

<td>Enable keep alive.</td>

+

</tr>

<tr>

−

<td>~~Server settings |~~ ~~TCP~~~~: Max clients~~</td>

+

<td>Keep alive time</td>

−

<td>integer [1..32]; default: 32</td>

+

<td>integer [0..32000]; default: 0</td>

−

<td>~~Specifies how many clients are allowed to connect simultaneously~~.</td>

+

<td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>

</tr>

<tr>

−

+

<td>Keep alive interval</td>

−

<td>~~off | on~~; default: ~~off~~</td>

+

<td>integer [0..32000]; default: 0</td>

−

<td>~~Enables software TCP echo~~.</td>

+

<td>The interval between subsequential keepalive probes.</td>

</tr>

<tr>

−

<td>~~TCP~~~~: Always reconnect~~</td>

+

<td>Keep alive probes</td>

−

<td>~~off | on~~; default: ~~off~~</td>

+

<td>integer [0..32000]; default: 0</td>

−

<td>~~When enabled, a new TCP connection will be made after sending every data package~~.</td>

+

<td>The number of unacknowledged probes.</td>

</tr>

</table>

MartynasL

Administrators

219

edits