Template:Networking rutos manual serial utilities: Difference between revisions
Appearance
No edit summary |
No edit summary |
||
| (23 intermediate revisions by 4 users not shown) | |||
| Line 14: | Line 14: | ||
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 | RUT206 = | ||
===RS232/RS485=== | ===RS232/RS485=== | ||
---- | ---- | ||
====Connector pinout==== | ====Connector pinout==== | ||
---- | ---- | ||
For {{{name}}} pinout, please refer to <b>[[{{{name}}} | For {{{name}}} pinout, please refer to <b>[[QSG {{{name}}}#Front_view|QSG]]</b> page.| #default = | ||
{{#ifeq: {{{rs232}}} | 1 | | {{#ifeq: {{{rs232}}} | 1 | | ||
===RS232=== | ===RS232=== | ||
| Line 25: | 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 40: | 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 46: | 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 52: | 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 58: | 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 70: | 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 76: | 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 82: | 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 88: | 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 94: | 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 231: | Line 231: | ||
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. | ||
===Status=== | |||
[[File: | |||
[[File:Networking_rutos_manual_serial_utilities_modem_control_status.png|border|class=tlt-border]] | |||
===General settings=== | |||
[[File:Networking_rutos_manual_serial_utilities_modem_control.png|border|class=tlt-border]] | |||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 257: | Line 259: | ||
<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>{{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>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>{{#ifeq: {{{rs485}}} | 1 | | ||
<tr> | |||
<td>Baud rate (RS485)</td> | |||
<td>integer [300..230400]; default:<b>9600</b></td> | |||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | |||
</tr>|}}{{#ifeq: {{{rs232}}} | 1 | | |||
<tr> | |||
<td>Baud rate (RS232)</td> | |||
<td>integer [300..115200]; default:<b>9600</b></td> | |||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | |||
</tr>|}}{{#ifeq: {{{usb}}} | 1 | | |||
<tr> | <tr> | ||
<td>Baud rate</td> | <td>Baud rate (USB)</td> | ||
<td>integer [300.. | <td>integer [300..4000000]; default:<b>9600</b></td> | ||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | <td>Data rate for serial data transmission (in bits per second (bps)).</td> | ||
</tr> | </tr>|}} | ||
<tr> | <tr> | ||
<td>Data bits</td> | <td>Data bits</td> | ||
| Line 304: | Line 316: | ||
</ul> | </ul> | ||
</td> | </td> | ||
</tr> |}} | </tr>|}} | ||
<tr> | <tr> | ||
<td>Mode</td> | <td>Mode</td> | ||
| Line 314: | Line 326: | ||
</ul> | </ul> | ||
</td> | </td> | ||
</tr>{{#ifeq: {{{rs485}}} | 1 | | </tr>{{#switch: {{{series}}} | RUT206 = | #default = {{#ifeq: {{{rs485}}} | 1 | | ||
<tr> | <tr> | ||
<td><span style="color: purple;">RS485:</span> Full Duplex</td> | <td><span style="color: purple;">RS485:</span> Full Duplex</td> | ||
<td>off {{!}} on; default: <b>off</b></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> | <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td> | ||
</tr>|}} | </tr>|}}}} | ||
</table> | |||
===Advanced settings=== | |||
{{#switch: {{{name}}} | TRB142 | TRB145 = | |||
[[File:Networking_rutos_manual_serial_utilities_modem_control_advanced_settings_trb.png|border|class=tlt-border]] | |||
| #default = [[File:Networking_rutos_manual_serial_utilities_modem_control_advanced_settings.png|border|class=tlt-border]]}} | |||
<table class="nd-mantable"> | |||
<tr> | |||
<th>Field</th> | |||
<th>Value</th> | |||
<th>Description</th> | |||
</tr> | |||
<tr> | <tr> | ||
<td>Start up message</td> | |||
<td>string; default: <b>none</b></td> | <td>string; default: <b>none</b></td> | ||
<td> | <td>Prints message to serial device when modem control is ready.</td> | ||
</tr>{{#switch: {{{name}}} | TRB142 | TRB145 = | |||
<tr> | |||
<td>Data mode</td> | |||
<td>off {{!}} on; default: <b>off</b></td> | |||
<td>Enable this option to allow data mode. Data mode will not operate without it.</td> | |||
</tr>| #default =}} | |||
<tr> | |||
<td>Canonical mode</td> | |||
<td>off {{!}} on; default: <b>off</b></td> | |||
<td>Forwards data to modem only when new line symbol ('\n') is detected.</td> | |||
</tr> | </tr> | ||
</table>|}} | </table>|}} | ||
| Line 331: | Line 366: | ||
<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. | ||
[[File: | ===Status=== | ||
[[File:Networking_rutos_manual_serial_utilities_console_status.png|border|class=tlt-border]] | |||
===General settings=== | |||
[[File:Networking_rutos_manual_serial_utilities_console_general.png|border|class=tlt-border]] | |||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 353: | Line 392: | ||
<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>{{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>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>{{#ifeq: {{{rs485}}} | 1 | | ||
<tr> | |||
<td>Baud rate (RS485)</td> | |||
<td>integer [300..230400]; default:<b>9600</b></td> | |||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | |||
</tr>|}}{{#ifeq: {{{rs232}}} | 1 | | |||
<tr> | |||
<td>Baud rate (RS232)</td> | |||
<td>integer [300..115200]; default:<b>9600</b></td> | |||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | |||
</tr>|}}{{#ifeq: {{{usb}}} | 1 | | |||
<tr> | <tr> | ||
<td>Baud rate</td> | <td>Baud rate (USB)</td> | ||
<td>integer [300.. | <td>integer [300..4000000]; default:<b>9600</b></td> | ||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | <td>Data rate for serial data transmission (in bits per second (bps)).</td> | ||
</tr> | </tr>|}} | ||
<tr> | <tr> | ||
<td>Data bits</td> | <td>Data bits</td> | ||
| Line 389: | Line 438: | ||
</ul>|}} | </ul>|}} | ||
</td> | </td> | ||
</tr>{{#ifeq: {{{rs485}}} | 1 | | </tr>{{#switch: {{{series}}} | RUT206 = | #default = {{#ifeq: {{{rs485}}} | 1 | | ||
<tr> | <tr> | ||
<td><span style="color: purple;">RS485:</span> Full Duplex</td> | <td><span style="color: purple;">RS485:</span> Full Duplex</td> | ||
<td>off {{!}} on; default: <b>off</b></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> | <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td> | ||
</tr>|}} | </tr>|}}}} | ||
</table> }} | </table> }} | ||
| Line 400: | Line 449: | ||
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 427: | Line 481: | ||
<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>{{#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>{{#ifeq: {{{rs485}}} | 1 | | ||
<tr> | |||
<td>Baud rate (RS485)</td> | |||
<td>integer [300..230400]; default:<b>9600</b></td> | |||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | |||
</tr>|}}{{#ifeq: {{{rs232}}} | 1 | | |||
<tr> | |||
<td>Baud rate (RS232)</td> | |||
<td>integer [300..115200]; default:<b>9600</b></td> | |||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | |||
</tr>|}}{{#ifeq: {{{usb}}} | 1 | | |||
<tr> | <tr> | ||
<td>Baud rate</td> | <td>Baud rate (USB)</td> | ||
<td>integer [300.. | <td>integer [300..4000000]; default:<b>9600</b></td> | ||
<td>Data rate for serial data transmission (in bits per second (bps)).</td> | <td>Data rate for serial data transmission (in bits per second (bps)).</td> | ||
</tr> | </tr>|}} | ||
<tr> | <tr> | ||
<td>Data bits</td> | <td>Data bits</td> | ||
| Line 463: | Line 527: | ||
</ul>|}} | </ul>|}} | ||
</td> | </td> | ||
</tr>{{#ifeq: {{{rs485}}} | 1 | | </tr>{{#switch: {{{series}}} | RUT206 = | #default = {{#ifeq: {{{rs485}}} | 1 | | ||
<tr> | <tr> | ||
<td><span style="color: purple;">RS485:</span> Full Duplex</td> | <td><span style="color: purple;">RS485:</span> Full Duplex</td> | ||
<td>off {{!}} on; default: <b>off</b></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> | <td>Turns Full Duplex mode on or off. This option is available only on the RS485 device.</td> | ||
</tr>|}}{{#ifeq: {{{rs232}}} | 1 | | </tr>|}}}}{{#ifeq: {{{rs232}}} | 1 | | ||
<tr> | <tr> | ||
<td><span style="color: green;">RS232:</span> Echo</td> | <td><span style="color: green;">RS232:</span> Echo</td> | ||