Difference between revisions of "Template:Networking rutos manual serial utilities"
(18 intermediate revisions by 3 users not shown) | |||
Line 7: | Line 7: | ||
}} | }} | ||
}} | }} | ||
− | + | ||
− | + | {{#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==|}} | ||
− | {{# | + | {{#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=== | ||
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. | ||
Line 278: | Line 265: | ||
<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 338: | Line 325: | ||
<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. | ||
Line 374: | Line 361: | ||
<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 408: | Line 395: | ||
<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 430: | ||
<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> | ||
Line 448: | Line 440: | ||
<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 535: | Line 527: | ||
</table> | </table> | ||
− | [[File:Networking rutos manual serial utilities over ip mbus configuration | + | [[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 546: | Line 538: | ||
<td>Use TLS/SSL</td> | <td>Use TLS/SSL</td> | ||
<td>off {{!}} on; default: <b>off</b></td> | <td>off {{!}} on; default: <b>off</b></td> | ||
− | <td></td> | + | <td>Mark to use TLS/SSL for connection.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>TLS version</td> | <td>TLS version</td> | ||
<td>Support all {{!}} tlsv1.0 {{!}} tlsv1.1 {{!}} tlsv1.2 {{!}} tlsv1.3; default: <b>Support all</b></td> | <td>Support all {{!}} tlsv1.0 {{!}} tlsv1.1 {{!}} tlsv1.2 {{!}} tlsv1.3; default: <b>Support all</b></td> | ||
− | <td></td> | + | <td>Minimum TLS version allowed to be used.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>TLS type</td> | <td>TLS type</td> | ||
<td>Certificate based {{!}} <span style="color: blue;">Pre-Shared-Key based</span>; default: <b>Certificate based</b></td> | <td>Certificate based {{!}} <span style="color: blue;">Pre-Shared-Key based</span>; default: <b>Certificate based</b></td> | ||
− | <td></td> | + | <td>Select the type of TLS encryption.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Require certificate</td> | <td>Require certificate</td> | ||
<td>off {{!}} on; default: <b>on</b></td> | <td>off {{!}} on; default: <b>on</b></td> | ||
− | <td></td> | + | <td>Demand certificate and key from peer and verify them against certificate authority.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>Verify host</td> |
− | <td>off {{!}} on; default: <b> | + | <td>off {{!}} on; default: <b>off</b></td> |
− | <td></td> | + | <td>Check if the server certificates Common Name (CN) matches hostname to which client is connecting.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Certificate files from device</td> | <td>Certificate files from device</td> | ||
<td>off {{!}} on; default: <b>off</b></td> | <td>off {{!}} on; default: <b>off</b></td> | ||
− | <td> | + | <td>Choose this option if you want to select certificate files from device.<br> Certificate files can be generated <a class=link href="/system/admin/certificates/generation">here</a>.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Certificate file</td> | <td>Certificate file</td> | ||
<td>.crt file; default: <b>none</b></td> | <td>.crt file; default: <b>none</b></td> | ||
− | <td> | + | <td>Upload certificate file.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Key file</td> | <td>Key file</td> | ||
<td>.key file; default: <b>none</b></td> | <td>.key file; default: <b>none</b></td> | ||
− | <td> | + | <td>Upload key file.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>CA file</td> | <td>CA file</td> | ||
<td>.ca file; default: <b>none</b></td> | <td>.ca file; default: <b>none</b></td> | ||
− | <td> | + | <td>Upload CA file.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: blue;">Pre-Shared-Key</span></td> | <td><span style="color: blue;">Pre-Shared-Key</span></td> | ||
<td>string; default: <b>none</b></td> | <td>string; default: <b>none</b></td> | ||
− | <td></td> | + | <td>The pre-shared-key in hex format with no leading “0x”.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span style="color: blue;">Identify</span></td> | <td><span style="color: blue;">Identify</span></td> | ||
<td>string; default: <b>none</b></td> | <td>string; default: <b>none</b></td> | ||
− | <td></td> | + | <td>Specify the identity.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
− | [[File:Networking rutos manual serial utilities over ip mbus configuration | + | [[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 634: | ||
<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> |
Revision as of 10:45, 13 May 2024
The information in this page is updated in accordance with firmware version .
Summary
The Serial Utilities 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.
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 | 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.
Instance Example
Here's an example demonstrating Over IP in action, running in Client + Server Mode.
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 | 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 | Set predefined IP and port for UDP connection. E.g first field for address second for port. |
Listening port | [1..65535]; default: empty | When enabled, all data will be transmitted transparently. |
Field | Value | Description |
---|---|---|
Use TLS/SSL | off | on; default: off | Mark to use TLS/SSL for connection. |
TLS version | Support all | tlsv1.0 | tlsv1.1 | tlsv1.2 | tlsv1.3; default: Support all | Minimum TLS version allowed to be used. |
TLS type | Certificate based | Pre-Shared-Key based; default: Certificate based | Select the type of TLS encryption. |
Require certificate | off | on; default: on | Demand certificate and key from peer and verify them against certificate authority. |
Verify host | off | on; default: off | Check if the server certificates Common Name (CN) matches hostname to which client is connecting. |
Certificate files from device | off | on; default: off | 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>. |
Certificate file | .crt file; default: none | Upload certificate file. |
Key file | .key file; default: none | Upload key file. |
CA file | .ca file; default: none | Upload CA file. |
Pre-Shared-Key | string; default: none | The pre-shared-key in hex format with no leading “0x”. |
Identify | string; default: none | Specify the identity. |
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 | on | off; default: off | Enable keep alive. |
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]]