Template:Networking rutos manual serial utilities rut2 rut9: Difference between revisions
Created page with "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{se..." |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 12: | Line 12: | ||
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 = | {{#switch:{{{series}}}|TRB2| TRB2M = | ||
| Line 37: | Line 25: | ||
====Connector pinout==== | ====Connector pinout==== | ||
---- | ---- | ||
The | The following table lists commonly used RS-232 signals ('''DTE male''' to '''DCE female'''). The RS232 connector type on device is a DCE female. | ||
[[File: | [[File:Services_rs232_connector_v1.png|400px]] | ||
<table class="nd-othertables"> | <table class="nd-othertables"> | ||
| Line 52: | Line 40: | ||
<td>DCD</td> | <td>DCD</td> | ||
<td>Data Carrier Detect</td> | <td>Data Carrier Detect</td> | ||
<td> | <td>Input</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 58: | Line 46: | ||
<td>RXD</td> | <td>RXD</td> | ||
<td>Receive Data</td> | <td>Receive Data</td> | ||
<td> | <td>Input</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 64: | Line 52: | ||
<td>TXD</td> | <td>TXD</td> | ||
<td>Transmit Data</td> | <td>Transmit Data</td> | ||
<td> | <td>Output</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 70: | Line 58: | ||
<td>DTR</td> | <td>DTR</td> | ||
<td>Data Terminal Ready</td> | <td>Data Terminal Ready</td> | ||
<td> | <td>Output</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 82: | Line 70: | ||
<td>DSR</td> | <td>DSR</td> | ||
<td>Data Set Ready</td> | <td>Data Set Ready</td> | ||
<td> | <td>Input</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 88: | Line 76: | ||
<td>RTS</td> | <td>RTS</td> | ||
<td>Ready To Send</td> | <td>Ready To Send</td> | ||
<td> | <td>Output</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 94: | Line 82: | ||
<td>CTS</td> | <td>CTS</td> | ||
<td>Clear To Send</td> | <td>Clear To Send</td> | ||
<td> | <td>Input</td> | ||
</tr>{{#ifeq:{{{series}}}|TRB1| | </tr>{{#ifeq:{{{series}}}|TRB1| | ||
<tr> | <tr> | ||
| Line 100: | Line 88: | ||
<td>RI</td> | <td>RI</td> | ||
<td>Ring Indicator</td> | <td>Ring Indicator</td> | ||
<td> | <td>Input (connected to +3.8V permanently via a 4.7k resistor) </td> | ||
</tr>| | </tr>| | ||
<tr> | <tr> | ||
| Line 106: | Line 94: | ||
<td>RI</td> | <td>RI</td> | ||
<td>Ring Indicator</td> | <td>Ring Indicator</td> | ||
<td> | <td>Input (connected to +5V permanently via a 4.7k resistor) </td> | ||
</tr>}} | </tr>}} | ||
</table> | </table> | ||
| Line 267: | Line 255: | ||
<tr> | <tr> | ||
<td>Device</td> | <td>Device</td> | ||
<td>{{Template: | <td>{{Template: Networking_rutos_manual_serial_ports_rut2_rut9 | rs232={{{rs232}}} | rs485={{{rs485}}} | usb={{{usb}}} }}; default: <b>{{Template: Networking_rutos_manual_default_serial_port_rut2_rut9 | 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 363: | Line 351: | ||
<tr> | <tr> | ||
<td>Device</td> | <td>Device</td> | ||
<td>{{Template: | <td>{{Template: Networking_rutos_manual_serial_ports_rut2_rut9 | rs232={{{rs232}}} | rs485={{{rs485}}} | usb={{{usb}}} }}; default: <b>{{Template: Networking_rutos_manual_default_serial_port_rut2_rut9 | 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 437: | Line 425: | ||
<tr> | <tr> | ||
<td>Device</td> | <td>Device</td> | ||
<td>{{Template: | <td>{{Template: Networking_rutos_manual_serial_ports_rut2_rut9 | rs232={{{rs232}}} | rs485={{{rs485}}} | usb={{{usb}}} }}; default: <b>{{Template: Networking_rutos_manual_default_serial_port_rut2_rut9 | 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> | ||
Latest revision as of 08:21, 22 July 2025
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.
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 | 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 | 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 | 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 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]]




