Jump to content

Template:Networking rutos manual usb tools: Difference between revisions

 
(2 intermediate revisions by the same user not shown)
Line 34: Line 34:
The <b>Mounted File Systems</b> list displays USB mass storage devices (MSD) currently attached to this device.
The <b>Mounted File Systems</b> list displays USB mass storage devices (MSD) currently attached to this device.


[[File:Networking_rutos_manual_usb_tools_general_mounted_file_systems_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_general_mounted_file_systems_v3.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 74: Line 74:


'''Note:''' Usb with NTFS partition is supported in read-only mode.
'''Note:''' Usb with NTFS partition is supported in read-only mode.
[[File:Networking_rutos_manual_usb_tools_general_ntfs.png|border|class=tlt-border]]


{{#ifeq:{{{printer}}}|0||
{{#ifeq:{{{printer}}}|0||
Line 114: Line 112:
</table>
</table>
{{#ifeq:{{{series}}}|RUTM||For step-by-step instructions on how to use a printer with {{{name}}}, <b>[[How to set up a USB printer (Windows, {{{name}}})|click here]].</b>|}}
{{#ifeq:{{{series}}}|RUTM||For step-by-step instructions on how to use a printer with {{{name}}}, <b>[[How to set up a USB printer (Windows, {{{name}}})|click here]].</b>|}}
}}
{{#ifeq:{{{serial}}}|0||
==USB to Serial==
<b>Note:</b> From FW version R_00.07.03 this section was removed.
The device's USB connector can also be used as a <b>serial port</b>.
[[File:Networking_rutos_manual_usb_tools_printer_server_usb_to_serial.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Enabled</td>
      <td>off {{!}} on; default: <b>off</b></td>
      <td>Turns the USB to Serial service on or off.</td>
    </tr>
    <tr>
    <td>Baud rate</td>
        <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200; default: <b>115200</b></td>
        <td>Data rate for serial data transmission (in bits per second).</td>
    </tr>
    <tr>
    <td>Data bits</td>
        <td>5 {{!}} 6 {{!}} 7 {{!}} 8; default: <b>8</b></td>
        <td>Number of data bits for each character</td>
    </tr>
    <tr>
    <td>Parity</td>
        <td>None {{!}} Odd {{!}} Even; 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>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>Flow control</td>
        <td>None {{!}} 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.
            <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.</li>
            </ul>
        </td>
    </tr>
    <tr>
    <td>Serial type</td>
        <td>[[#Console|Console]] {{!}} [[#Over IP|Over IP]] {{!}} [[#Modbus gateway|Modbus gateway]] {{!}} [[#NTRIP client|NTRIP client]]; default: <b>Console</b></td>
        <td>Specifies the serial connection type.<br><b>Look to the sections below for information on different USB to Serial type options.</b></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_usb_tools_printer_server_usb_to_serial_console.png|border|class=tlt-border]]
===Over IP===
----
The <b>Over IP</b> serial type is used to manage serial connections over a TCP/IP network.
[[File:Networking_rutos_manual_usb_tools_printer_server_usb_to_serial_over_ip.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Protocol</td>
      <td>TCP {{!}} UDP; default: <b>TCP</b></td>
      <td>Protocol used in the communication process.</td>
    </tr>
    <tr>
    <td>Mode</td>
        <td><span style="color: purple;">Server</span> {{!}} <span style="color: red;">Client</span> {{!}} <span style="color: blue;">Bidirect</span>; default: <b>Server</b></td>
        <td>The role of this device in the serial connection:
            <ul>
                <li><b><span style="color: purple;">Server</span></b> - the device waits for incoming connections</li>
                <li><b><span style="color: red;">Client</span></b> - the device initiates the connection.</li>
                <li><b><span style="color: blue;">Bidirect</span></b> - acts as client by default but waits for incoming connections at the same time.</li>
            </ul>
        </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>: Timeout (s)</td>
        <td>integer; default: <b>none</b></td>
        <td>Specifies an inactivity time limit (in second) after which an inactive clients is disconnected.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Server settings</span>: Open port automatically</td>
        <td>off {{!}} on; default: <b>on</b></td>
        <td>Automatically adds a traffic rule in the firewall configuration to open the required port for NTRIP communication.</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: red;">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: red;">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>Echo</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Turn USB to serial echo on or off.</td>
    </tr>
</table>
===Modbus gateway===
----
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_printer_server_usb_to_serial_modbus_gateway.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Listening IP</td>
      <td>ip; default: <b>0.0.0.0</b></td>
      <td>IP address to listen for incoming connections. The default value (<i>0.0.0.0</i>) means that this device will listen for incoming connections on any interface or IP address.</td>
    </tr>
    <tr>
      <td>Port</td>
      <td>integer [0..65535]; default: <b>502</b></td>
      <td>Port number to listen for incoming connections.</td>
    </tr>
    <tr>
    <td>Slave ID configuration type</td>
        <td><span style="color: red;">User defined</span> {{!}} <span style="color: purple;">Obtained from TCP</span>;<br>default: <b><span style="color: red;">User defined</span></b></td>
        <td>Specifies whether slave IDs are user defined or automatically obtained from TCP.</td>
    </tr>
    <tr>
    <td><span style="color: red;">Slave ID</span> {{!}} <span style="color: purple;">Permitted slave IDs</span></td>
        <td><span style="color: red;">integer </span> {{!}} <span style="color: purple;">range of integers</span>;<br>default: <b><span style="color: red;">1</span> or <span style="color: purple;">1-247</span></b></td>
        <td>Specifies the slave ID of range of permitted slave IDs. The way this field is named and its function depends on the value of the ''Slave ID configuration'' field. <br> A range of IDs can be specified by placing a hyphen (<i>-</i>) between two integer numbers. For example, if you permit slave IDs in the range of 10 to 20, you would specify it as: <i>10-20</i><br>You can also specify multiple values that are not connected in a range using commas (<i>,</i>). For example, to specify 6, 50 and 100 as permitted slave IDs, you would have to use: <i>6,50,100</i></td>
    </tr>
    <tr>
    <td>Open port automatically</td>
        <td>off {{!}} on; default: <b>on</b></td>
        <td>Automatically adds a traffic rule in the firewall configuration to open the required port for serial communication.<br><b><u>Caution:</u></b> use with care if listening IP is left as the default value (<i>0.0.0.0</i>). Leaving it as such will leave the device open for remote connections on the specified port.</td>
    </tr>
    <tr>
    <td>Echo</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Turn USB to serial echo on or off.</td>
    </tr>
</table>
===NTRIP client===
----
<b>Networked Transport of RTCM via Internet Protocol (NTRIP)</b> is a protocol for streaming differential GPS (DGPS) data over the Internet in accordance with specification published by RTCM.
[[File:Networking_rutos_manual_usb_tools_printer_server_usb_to_serial_ntrip_client.png|border|class=tlt-border]]
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>IP address</td>
      <td>ip; default: <b>0.0.0.0</b></td>
      <td>IP address of an NTRIP server.</td>
    </tr>
    <tr>
      <td>Port</td>
      <td>integer [0..65535]; default: <b>none</b></td>
      <td>TCP/UDP port used for NTRIP communication.</td>
    </tr>
    <tr>
    <td>Mount point</td>
        <td>filepath {{!}} string; default: <b>none</b></td>
        <td>NTRIP mount point.</td>
    </tr>
    <tr>
    <td>Data format</td>
        <td>NTRIP V2.0 TCP/IP {{!}} NTRIP V2.0 RSTP/RTP {{!}} NTRIP V1.0 {{!}} Automatic detection {{!}} NTRIP V2.0 UDP; default: <b>NTRIP V1.0</b></td>
        <td>Version of NTRIP protocol.</td>
    </tr>
    <tr>
      <td>Username</td>
      <td>string; default: <b>none</b></td>
      <td>Username for authentication to an NTRIP server.</td>
    </tr>
    <tr>
      <td>Password</td>
      <td>string; default: <b>none</b></td>
      <td>Password for authentication to an NTRIP server.</td>
    </tr>
    <tr>
    <td>Default NMEA string</td>
        <td>string; default: <b>none</b></td>
        <td>Optional NMEA string that will be used as the default value when initiating the connection to the NTRIP server (this value is only sent to the server if there is no NMEA from router's GPS device).</td>
    </tr>
    <tr>
    <td>Use device GPS</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Allows to obtain default NMEA string from the router's GPS device. Only works if GPS service is enabled and location fix is obtained at the time of NTRIP service start.</td>
    </tr>
    <tr>
    <td>Open port automatically</td>
        <td>off {{!}} on; default: <b>on</b></td>
        <td>Automatically adds a traffic rule in the firewall configuration to open the required port for serial communication.</td>
    </tr>
    <tr>
    <td>Echo</td>
        <td>off {{!}} on; default: <b>off</b></td>
        <td>Turn USB to serial echo on or off.</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]]


{{#ifeq:{{{shares}}}|0||
{{#ifeq:{{{shares}}}|0||
Line 444: Line 184:
The <b>Shared Directories</b> section is used to configure access to the device's files and directories, including USB storage drives. The list of Shared Directories is empty by default; click the 'Add' button in order to create a new configuration:
The <b>Shared Directories</b> section is used to configure access to the device's files and directories, including USB storage drives. The list of Shared Directories is empty by default; click the 'Add' button in order to create a new configuration:


[[File:Networking_rutos_manual_usb_tools_network_shares_general_shared_directories_add_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_network_shares_general_shared_directories_add_button_v2.png|border|class=tlt-border]]


The newly added Shared Directory configuration should look similar to this:
The newly added Shared Directory configuration should look similar to this:


[[File:Networking_rutos_manual_usb_tools_network_shares_general_shared_directories.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_network_shares_general_shared_directories_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 463: Line 203:
     <tr>
     <tr>
         <td>Path</td>
         <td>Path</td>
         <td>filepath; default: <b>/mnt/</b></td>
         <td>filepath; default: <b>No mount point</b></td>
         <td>Path to a shared directory. To share an entire drive, choose an automatically generated path from this drop-down box (for example, /mnt/sda1). To share a specific directory on the drive, specify the full path to that directory (for example, /mnt/sda1/shared/video).</td>
         <td>Path to a shared directory. To share an entire drive, choose an automatically generated path from this drop-down box (for example, /mnt/sda1). To share a specific directory on the drive, specify the full path to that directory (for example, /mnt/sda1/shared/video).</td>
     </tr>
     </tr>
Line 487: Line 227:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Delete</td>
         <td>Actions</td>
         <td>-(interactive button)</td>
         <td>Delete; default: <b>Delete</b></td>
         <td>Deletes a Shared Directory configuration.</td>
         <td>Deletes a Shared Directory configuration.</td>
     </tr>
     </tr>
Line 508: Line 248:
The <b>Users</b> section is used to create Samba users that can be granted access to Shared Directories. To add a new user, enter a custom username, password and click the 'Add' button.
The <b>Users</b> section is used to create Samba users that can be granted access to Shared Directories. To add a new user, enter a custom username, password and click the 'Add' button.


[[File:Networking_rutos_manual_usb_tools_network_shares_users_add_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_network_shares_users_add_button_v2.png|border|class=tlt-border]]


The newly added User should appear in the Users list. To change the password of a Samba User, click the 'Edit' button located next to it:
The newly added User should appear in the Users list. To change the password of a Samba User, click the 'Edit' button located next to it:


[[File:Networking_rutos_manual_usb_tools_network_shares_users_edit_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_network_shares_users_edit_button_v2.png|border|class=tlt-border]]


This will redirect you to the Settings page for that User which should look similar to this:
This will redirect you to the Settings page for that User which should look similar to this:


[[File:Networking_rutos_manual_usb_tools_network_shares_users_user_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_network_shares_users_user_settings_v2.png|border|class=tlt-border]]
}}
}}


Line 538: Line 278:
===General Settings===
===General Settings===
----
----
[[File:Networking_rutos_manual_dlna_general_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_dlna_general_settings_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 592: Line 332:
===Advanced Settings===
===Advanced Settings===
----
----
[[File:Networking_rutos_manual_dlna_advanced_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_dlna_advanced_settings_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 606: Line 346:
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Database directory</td>
       <td>Enable notify</td>
      <td>filepath; default: <b>/var/run/minidlna</b></td>
      <td>The directory where DLNA will store its database and album art cache.</td>
    </tr><!--
    <tr>
      <td>Log directory</td>
      <td>filepath; default: <b>/var/log</b></td>
      <td>The directory where DLNA will store its log file.</td>
    </tr>
--> <tr>
       <td>Enable inotify</td>
       <td>off | on; default: <b>on</b></td>
       <td>off | on; default: <b>on</b></td>
       <td>Turns inotify on or off. Inotify is a Linux kernel subsystem that notices changes to the filesystem and reports on these changes to applications, in this case, the DLNA service.</td>
       <td>Turns inotify on or off. Inotify is a Linux kernel subsystem that notices changes to the filesystem and reports on these changes to applications, in this case, the DLNA service.</td>