Line 7: |
Line 7: |
| }} | | }} |
| }} | | }} |
− | <br><i><b>Note</b>: {{#ifeq:{{{rs232}}}|1|
| + | |
− | <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>|}} |
− | {{#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. |
− |
| |
− | 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 = |
| ===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== |
Line 438: |
Line 425: |
| <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 435: |
| <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 522: |
| </table> | | </table> |
| | | |
− | [[File:Networking rutos manual serial utilities over ip mbus configuration security.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 546: |
Line 533: |
| <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><span style="color: brown;">Require certificate</span></td> | + | <td>Verify host</td> |
− | <td>off {{!}} on; default: <b>on</b></td> | + | <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>Turn on this option if you want to select generated certificate files from device.</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>TLS certificate file.</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>TLS key file.</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>A certificate authority file.</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 advanced_v1.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 629: |
| <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> |