Changes

no edit summary
Line 1: Line 1: −
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.04.1
+
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series     = {{{series}}}
+
| series = {{{series}}}
 +
}}
 
}}
 
}}
 +
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} RS232/RS485 (legacy WebUI)#RS232|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
 +
 
__TOC__
 
__TOC__
   Line 10: Line 13:     
This manual page provides an overview of the RS232 page in {{{name}}} devices.
 
This manual page provides an overview of the RS232 page in {{{name}}} devices.
 +
{{#switch: {{{series}}}
 +
| TRB1|RUT9|RUT9M=
 +
==General information==
 +
 +
==RS232 connector pinout==
 +
 +
The RS232 connector type on this device is a '''DCE female'''. DCE stands for Data Communication Equipment.
 +
 +
[[File:Services_rs232_connector.PNG|400px]]
 +
 +
<table class="nd-othertables">
 +
    <tr>
 +
        <th style="width: 30px">PIN</th>
 +
      <th style="width: 60px">NAME*</th>
 +
      <th style="width: 170px">DESCRIPTION*</th>
 +
        <th style="width: 400px">DIRECTION ON THIS DEVICE</th>
 +
    </tr>
 +
    <tr>
 +
      <td>1</td>
 +
      <td>DCD</td>
 +
      <td>Data Carrier Detect</td>
 +
      <td>Output</td>
 +
    </tr>
 +
    <tr>
 +
      <td>2</td>
 +
      <td>RXD</td>
 +
      <td>Receive Data</td>
 +
      <td>Output</td>
 +
    </tr>
 +
    <tr>
 +
    <td>3</td>
 +
        <td>TXD</td>
 +
        <td>Transmit Data</td>
 +
      <td>Input</td>
 +
    </tr>
 +
    <tr>
 +
    <td>4</td>
 +
        <td>DTR</td>
 +
        <td>Data Terminal Ready</td>
 +
      <td>Input</td>
 +
    </tr>
 +
    <tr>
 +
      <td>5</td>
 +
      <td>GND</td>
 +
      <td>Signal Ground</td>
 +
      <td>-</td>
 +
    </tr>
 +
    <tr>
 +
      <td>6</td>
 +
      <td>DSR</td>
 +
      <td>Data Set Ready</td>
 +
      <td>Output</td>
 +
    </tr>
 +
    <tr>
 +
    <td>7</td>
 +
        <td>RTS</td>
 +
        <td>Ready To Send</td>
 +
      <td>Input</td>
 +
    </tr>
 +
    <tr>
 +
    <td>8</td>
 +
        <td>CTS</td>
 +
        <td>Clear To Send</td>
 +
      <td>Output</td>
 +
    </tr>{{#ifeq:{{{series}}}|TRB1|
 +
    <tr>
 +
    <td>9</td>
 +
        <td>RI</td>
 +
        <td>Ring Indicator</td>
 +
      <td>Output (connected to +3.8V permanently via a 4.7k resistor) </td>
 +
    </tr>|
 +
    <tr>
 +
    <td>9</td>
 +
        <td>RI</td>
 +
        <td>Ring Indicator</td>
 +
      <td>Output (connected to +5V permanently via a 4.7k resistor) </td>
 +
    </tr>}}
 +
</table>
 +
 +
==Cables==
 +
 +
There are two types of RS232 serial devices: '''DTE''' and '''DCE'''. DTE typically refers to the serial port on a PC or terminal, while DCE refers to communication devices. Connectors mounted on DTE are likely to be male, and those mounted on DCE are likely to be female.
 +
 +
This device is DCE and has a female connector.
 +
----
 +
To connect a standard DTE device, use a straight-through Female/Male RS232 cable:
 +
 +
[[File:Services rs232 connector female male.PNG]]
 +
 +
See straight cable pinout below:
 +
 +
[[File:Straight cable pinout v2.png|400px]]
 +
 +
----
 +
 +
To connect another DCE device to RUT955, a Null-modem (crossed) Male/Male cable should be used:
 +
 +
[[File:Male male rs232 cable.jpg]]
 +
 +
See straight crossed cable pinout below:
 +
 +
[[File:Straight crossed rs232 cable pinout v2.png|400px]]
 +
 +
----
 +
 +
Maximum cable length is 15 meters or the cable length equal to a capacitance of 2500 pF (for a 19200 baud rate). Using lower capacitance cables can increase the distance. Reducing communication speed can also increase maximum cable length.|}}
    
==RS232 Configuration==
 
==RS232 Configuration==
Line 15: Line 124:  
The <b>RS232 Configuration</b> section is used to set up the main operating parameters and the serial type of the RS232 connector.
 
The <b>RS232 Configuration</b> section is used to set up the main operating parameters and the serial type of the RS232 connector.
   −
[[File:Networking_rutos_manual_rs232_rs232_configuration.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_rs232_rs232_configuration_data_bits_{{{data_bit}}}.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 30: Line 139:  
     <tr>
 
     <tr>
 
     <td>Baud rate</td>
 
     <td>Baud rate</td>
         <td>300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 | 230400 | 460800 | 921600 | 1000000 | 3000000 ; default: <b>300</b></td>
+
         <td>{{{baud_rates}}}; default: <b>{{{baud_rate}}}</b></td>
         <td>Data rate for serial data transmission (in bits per second).</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>
         <td>5 | 6 | 7 | 8; default: <b>7</b></td>
+
         <td>{{{data_bits}}}; default: <b>{{{data_bit}}}</b></td>
 
         <td>Number of data bits for each character.</td>
 
         <td>Number of data bits for each character.</td>
 
     </tr>
 
     </tr>
Line 66: Line 175:  
     <tr>
 
     <tr>
 
     <td>Serial type</td>
 
     <td>Serial type</td>
         <td>[[#Console|Console]] | [[#Over IP|Over IP]] | [[#Modbus gateway|Modbus gateway]]; default: <b>Console</b></td>
+
         <td>[[#Console|Console]] | [[#Over IP|Over IP]] | [[#Modem|Modem]] | [[#Modbus gateway|Modbus gateway]]; default: <b>Console</b></td>
 
         <td>Specifies the serial connection type.<br><b>Look to the sections below for information on different RS232 serial type options.</b></td>
 
         <td>Specifies the serial connection type.<br><b>Look to the sections below for information on different RS232 serial type options.</b></td>
 
     </tr>
 
     </tr>
Line 75: Line 184:  
<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:Networking_rutos_manual_usb_tools_usb_to_serial_console_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_usb_tools_printer_server_usb_to_serial_console.png|border|class=tlt-border]]
    
===Over IP===
 
===Over IP===
Line 81: Line 190:  
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.  
   −
[[File:Networking_rutos_manual_usb_tools_usb_to_serial_over_ip_v1.png|border|class=tlt-border]]
+
<!--[[File:Networking_rutos_manual_usb_tools_printer_server_usb_to_serial_over_ip_{{{series}}}_v1.png|border|class=tlt-border]]-->
 +
[[File:Networking_rutos_manual_usb_tools_printer_server_usb_to_serial_over_ip.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <th>Field</th>
+
         <th style="width: 360px>Field</th>
 
       <th>Value</th>
 
       <th>Value</th>
 
       <th>Description</th>
 
       <th>Description</th>
Line 91: Line 201:  
     <tr>
 
     <tr>
 
       <td>Protocol</td>
 
       <td>Protocol</td>
       <td>TCP | UDP; default: <b>TCP</b></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>
 
       <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>
 
     <tr>
 
     <tr>
 
     <td>Mode</td>
 
     <td>Mode</td>
         <td><span style="color: red;">Server</span> | <span style="color: purple;">Client</span> | Bidirect; default: <b>Server</b></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:
 
         <td>This device's role in the connection:
 
             <ul>
 
             <ul>
Line 116: Line 231:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
     <td><span style="color: red;">Server settings</span>: Timeout (s)</td>
+
     <td><span style="color: red;">Server settings</span> | <span style="color: blue;">TCP</span>: Timeout (s)</td>
         <td>integer; default: <b>none</b></td>
+
         <td>integer [0..32767]; default: <b>300</b></td>
         <td>Specifies an inactivity time limit (in second) after which an inactive clients is disconnected.</td>
+
         <td>Specifies an inactivity time limit (in seconds) after which an inactive clients is disconnected.</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color: orange;">Bidirect</span>: Output</td>{{#switch:{{{series}}}
 +
| TRB2=<td>Configurable Input/Output (2) {{!}} Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (2)</b></td>
 +
| TRB1=<td>Configurable Input/Output (3) {{!}} Configurable Input/Output (4); default: <b>Configurable Input/Output (3)</b></td>
 +
| RUT9=<td>Output (4) {{!}} Isolated Output (3,4,8) {{!}} Relay (5,10); default: <b>Output (4)</b></td>}}
 +
        <td>Specifies which output to manage.</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color: orange;">Bidirect</span>: Output state</td>
 +
        <td>0 {{!}} 1; default: <b>0</b></td>
 +
        <td>Default output state value, when the application is started.</td>
 +
    </tr><!--
 +
    <tr>
 +
    <td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Number of clients</td>
 +
        <td>1-10; default: <b>1</b></td>
 +
        <td>Specifies how many UDP clients will be supported simultaneously (predefined clients does not count towards this limit).</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>
 
     <tr>
 
     <tr>
     <td><span style="color: red;">Server settings</span>: Open port automatically</td>
+
     <td><span style="color: red;">Server settings</span> | <span style="color: green;">UDP</span>: Predefined client 2 address</td>
         <td>off | on; default: <b>on</b></td>
+
         <td>ip4; default: <b>none</b></td>
         <td>Automatically adds a traffic rule in the firewall configuration to open the required port for NTRIP communication.</td>
+
         <td>Specifies IP address for predefined connection 2.</td>
 
     </tr>
 
     </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>
 
     <tr>
 
       <td><span style="color: purple;">Client settings</span>: Server Address</td>
 
       <td><span style="color: purple;">Client settings</span>: Server Address</td>
Line 131: Line 278:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
     <td><span style="color: red;">Client settings</span>: Port</td>
+
     <td><span style="color: purple;">Client settings</span>: Port</td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>integer [0..65535]; default: <b>none</b></td>
 
         <td>Server's listening port number.</td>
 
         <td>Server's listening port number.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
     <td><span style="color: red;">Client settings</span>: Reconnect interval (s)</td>
+
     <td><span style="color: purple;">Client settings</span>: Reconnect interval (s)</td>
 
         <td>integer; default: <b>none</b></td>
 
         <td>integer; default: <b>none</b></td>
 
         <td>Time period (in seconds) between reconnection attempts in case a connection fails.</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>
 
     </tr>
 
     <tr>
 
     <tr>
 
     <td>Echo</td>
 
     <td>Echo</td>
 
         <td>off | on; default: <b>off</b></td>
 
         <td>off | on; default: <b>off</b></td>
         <td>Turn RS232 echo on or off.</td>
+
         <td>Turns RS232 echo on or off. RS232 echo is a loopback test usually used to check whether the RS232 cable is working properly.</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>{{#ifeq:{{{name}}}|TRB142|
 +
    <tr>
 +
    <td><span style="color: blue;">TCP</span>: CD pin indication</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Enable to use CD pin for TCP connection state indication.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
    <td><span style="color: blue;">TCP</span>: CD pin invert</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Change default status to active (Active when no connection).</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color: blue;">TCP</span>: DSR pin indication</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Enable to use DSR pin for TCP connection state indication.</td>
 +
    </tr>
 +
    <tr>
 +
    <td><span style="color: blue;">TCP</span>: DSR pin invert</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Change default status to active (Active when no connection).</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>
 
</table>
    +
{{#ifeq: {{{modem}}} | 1 |
 +
===Modem===
 +
----
 +
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 such applications  with 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_usb_tools_printer_server_usb_to_serial_modem.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
      <tr>
 +
        <td>Mode</td>
 +
      <td>Partial control {{!}} Full control; default: <b>Partial control</b></td>
 +
      <td>Specifies modem control mode.  <ul>
 +
          <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>
 +
</table>
 +
 +
|}}
    
===Modbus gateway===
 
===Modbus gateway===
Line 152: Line 360:  
The <b>Modbus gateway</b> serial type allows redirecting TCP data coming to a specified port to an RTU specified by the Slave ID. The Slave ID can be specified by the user or be obtained directly from the Modbus header.
 
The <b>Modbus gateway</b> serial type allows redirecting TCP data coming to a specified port to an RTU specified by the Slave ID. The Slave ID can be specified by the user or be obtained directly from the Modbus header.
   −
[[File:Networking_rutos_manual_usb_tools_usb_to_serial_modbus_gateway_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_usb_tools_printer_server_usb_to_serial_modbus_gateway.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 188: Line 396:  
     <td>Echo</td>
 
     <td>Echo</td>
 
         <td>off | on; default: <b>off</b></td>
 
         <td>off | on; default: <b>off</b></td>
         <td>Turn RS232 echo on or off.</td>
+
         <td>Turns RS232 echo on or off. RS232 echo is a loopback test usually used to check whether the RS232 cable is working properly.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</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]]
 
[[Category:{{{name}}} Services section]]

Navigation menu