31,703
edits
Changes
Template:Networking rutos manual serial utilities (view source)
Revision as of 11:24, 23 November 2022
, 11:24, 23 November 2022Created page with "{{Template: Networking_rutos_manual_fw_disclosure | fw_version ={{Template: Networking_rutos_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }} ==Summary=..."
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
==Summary==
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.
==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.
[[File:Networking_rutos_manual_serial_utilities_modem_control_default_rs485_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>{{#ifeq: {{{rs232}}} | 1 | rs232 |}} {{#ifeq: {{{rs485}}} | 1 | rs485 |}}; default: <b>{{{default}}}</b></td>
<td>Serial device.</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{{#ifeq: {{{rs232}}} | 1 | {{!}} RTS/CTS {{!}} Xon/Xoff|}}; 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.
</ul>|}}
</td>
</tr>
<tr>
<td>Mode</td>
<td>Partial control {{!}} Full control; default: <b>Partial control</b></td>
<td>Specifies modem control mode.
<ul>
<li><b>Partial control</b>- enables modem control with AT commands, mobile connection will be controlled by RUTOS.
<li><b>Full control</b>- enables modem control with AT commands, mobile connection will be controlled by user.
</ul>
</td>
</tr>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off | on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
</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.
[[File:Networking_rutos_manual_serial_utilities_console_default_{{{default}}}_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>{{#ifeq: {{{rs232}}} | 1 | rs232 |}} {{#ifeq: {{{rs485}}} | 1 | rs485 |}}; default: <b>{{{default}}}</b></td>
<td>Serial device.</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{{#ifeq: {{{rs232}}} | 1 | {{!}} RTS/CTS {{!}} Xon/Xoff|}}; 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.
</ul>|}}
</td>
</tr>>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off | on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
</table>
==Over IP==
The <b>Over IP</b> serial type is used to manage serial connections over a TCP/IP network.
===Serial Device Configuration===
----
[[File:Networking_rutos_manual_serial_utilities_console_default_{{{default}}}_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>{{#ifeq: {{{rs232}}} | 1 | rs232 |}} {{#ifeq: {{{rs485}}} | 1 | rs485 |}}; default: <b>{{{default}}}</b></td>
<td>Serial device.</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{{#ifeq: {{{rs232}}} | 1 | {{!}} RTS/CTS {{!}} Xon/Xoff|}}; 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.
</ul>|}}
</td>
</tr>>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off | on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
</table>
===Over IP Configuration Settings===
----
<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>Raw mode</td>
<td>off {{!}} on; default; default: <b>off</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><span style="color: red;">Server settings</span>: Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Internal port number used to listen for incoming connections.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: blue;">TCP</span>: Timeout (s)</td>
<td>integer [0..32767]; default: <b>300</b></td>
<td>Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined client 1 address</td>
<td>ip4; default: <b>none</b></td>
<td>Specifies IP address for predefined connection 1.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined port 1</td>
<td>port; default: <b>none</b></td>
<td>Specifies port number for predefined connection 1.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined client 2 address</td>
<td>ip4; default: <b>none</b></td>
<td>Specifies IP address for predefined connection 2.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined port 2</td>
<td>port; default: <b>none</b></td>
<td>Specifies port number for predefined connection 2.</td>
</tr>
<tr>
<td><span style="color: purple;">Client settings</span>: Server Address</td>
<td>ip | host; default: <b>none</b></td>
<td>IP address or hostname of the server that this client will connect to.</td>
</tr>
<tr>
<td><span style="color: purple;">Client settings</span>: Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Server's listening port number.</td>
</tr>
<tr>
<td><span style="color: purple;">Client settings</span>: Reconnect interval (s)</td>
<td>integer; default: <b>none</b></td>
<td>Time period (in seconds) between reconnection attempts in case a connection fails.</td>
</tr>
<tr>
<td>Serial device read time</td>
<td>integer [0..1000]; default: <b>none</b></td>
<td>Specifies custom read time for the serial device.</td>
</tr>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: blue;">TCP</span>: Max clients</td>
<td>integer [1..32]; default: <b>32</b></td>
<td>Specifies how many clients are allowed to connect simultaneously.</td>
</tr>
<tr>
<td><span style="color: blue;">TCP</span>: TCP echo</td>
<td>off | on; default: <b>off</b></td>
<td>Enables software TCP echo.</td>
</tr>
<tr>
<td><span style="color: blue;">TCP</span>: Always reconnect</td>
<td>off | on; default: <b>off</b></td>
<td>When enabled, a new TCP connection will be made after sending every data package.</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]]
[[Category:{{{name}}} Services section]]
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
==Summary==
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.
==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.
[[File:Networking_rutos_manual_serial_utilities_modem_control_default_rs485_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>{{#ifeq: {{{rs232}}} | 1 | rs232 |}} {{#ifeq: {{{rs485}}} | 1 | rs485 |}}; default: <b>{{{default}}}</b></td>
<td>Serial device.</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{{#ifeq: {{{rs232}}} | 1 | {{!}} RTS/CTS {{!}} Xon/Xoff|}}; 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.
</ul>|}}
</td>
</tr>
<tr>
<td>Mode</td>
<td>Partial control {{!}} Full control; default: <b>Partial control</b></td>
<td>Specifies modem control mode.
<ul>
<li><b>Partial control</b>- enables modem control with AT commands, mobile connection will be controlled by RUTOS.
<li><b>Full control</b>- enables modem control with AT commands, mobile connection will be controlled by user.
</ul>
</td>
</tr>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off | on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
</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.
[[File:Networking_rutos_manual_serial_utilities_console_default_{{{default}}}_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>{{#ifeq: {{{rs232}}} | 1 | rs232 |}} {{#ifeq: {{{rs485}}} | 1 | rs485 |}}; default: <b>{{{default}}}</b></td>
<td>Serial device.</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{{#ifeq: {{{rs232}}} | 1 | {{!}} RTS/CTS {{!}} Xon/Xoff|}}; 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.
</ul>|}}
</td>
</tr>>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off | on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
</table>
==Over IP==
The <b>Over IP</b> serial type is used to manage serial connections over a TCP/IP network.
===Serial Device Configuration===
----
[[File:Networking_rutos_manual_serial_utilities_console_default_{{{default}}}_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>{{#ifeq: {{{rs232}}} | 1 | rs232 |}} {{#ifeq: {{{rs485}}} | 1 | rs485 |}}; default: <b>{{{default}}}</b></td>
<td>Serial device.</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{{#ifeq: {{{rs232}}} | 1 | {{!}} RTS/CTS {{!}} Xon/Xoff|}}; 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.
</ul>|}}
</td>
</tr>>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off | on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
</table>
===Over IP Configuration Settings===
----
<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>Raw mode</td>
<td>off {{!}} on; default; default: <b>off</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><span style="color: red;">Server settings</span>: Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Internal port number used to listen for incoming connections.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: blue;">TCP</span>: Timeout (s)</td>
<td>integer [0..32767]; default: <b>300</b></td>
<td>Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined client 1 address</td>
<td>ip4; default: <b>none</b></td>
<td>Specifies IP address for predefined connection 1.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined port 1</td>
<td>port; default: <b>none</b></td>
<td>Specifies port number for predefined connection 1.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined client 2 address</td>
<td>ip4; default: <b>none</b></td>
<td>Specifies IP address for predefined connection 2.</td>
</tr>
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined port 2</td>
<td>port; default: <b>none</b></td>
<td>Specifies port number for predefined connection 2.</td>
</tr>
<tr>
<td><span style="color: purple;">Client settings</span>: Server Address</td>
<td>ip | host; default: <b>none</b></td>
<td>IP address or hostname of the server that this client will connect to.</td>
</tr>
<tr>
<td><span style="color: purple;">Client settings</span>: Port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>Server's listening port number.</td>
</tr>
<tr>
<td><span style="color: purple;">Client settings</span>: Reconnect interval (s)</td>
<td>integer; default: <b>none</b></td>
<td>Time period (in seconds) between reconnection attempts in case a connection fails.</td>
</tr>
<tr>
<td>Serial device read time</td>
<td>integer [0..1000]; default: <b>none</b></td>
<td>Specifies custom read time for the serial device.</td>
</tr>{{#ifeq: {{{rs485}}} | 1 |
<tr>
<td>Full Duplex</td>
<td>off {{!}} on; default: <b>off</b></td>
<td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td>
</tr>|}}
<tr>
<td><span style="color: red;">Server settings</span> | <span style="color: blue;">TCP</span>: Max clients</td>
<td>integer [1..32]; default: <b>32</b></td>
<td>Specifies how many clients are allowed to connect simultaneously.</td>
</tr>
<tr>
<td><span style="color: blue;">TCP</span>: TCP echo</td>
<td>off | on; default: <b>off</b></td>
<td>Enables software TCP echo.</td>
</tr>
<tr>
<td><span style="color: blue;">TCP</span>: Always reconnect</td>
<td>off | on; default: <b>off</b></td>
<td>When enabled, a new TCP connection will be made after sending every data package.</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]]
[[Category:{{{name}}} Services section]]
