Template:Networking rutos manual usb tools: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
 
(35 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Template:Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.06
| series = {{{series}}}
| series     = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
}}
__TOC__
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} USB Tools (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
 
==Summary==
==Summary==


Line 31: 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.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 40: Line 43:
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Filesystem</td>
       <td>Device</td>
       <td>filepath; default: <b>/dev/sd*</b></td>
       <td>filepath; default: <b>/dev/sd*</b></td>
       <td>The filesystem of the attached USB MSD.</td>
       <td>The filesystem of the attached USB MSD.</td>
Line 66: Line 69:
</table>
</table>


The '<b>Unmount</b>' button next to each entry in the list is used to unmount an attached USB device. Please make sure to unmount a USB device before physically detaching it from the {{{name}}}.
The <b>Format</b> button can be used to format the attached device, and the <b>Unmount</b> button next to each entry in the list is used to unmount an attached USB device. Please make sure to unmount a USB device before physically detaching it from the {{{name}}}.


The '<b>Refresh</b>' is used to refresh the information in the Mounted File Systems list. If you attach a new USB device and cannot see it in the list, try clicking the 'Refresh' button.
The <b>Refresh</b> is used to refresh the information in the Mounted File Systems list. If you attach a new USB device and cannot see it in the list, try clicking the 'Refresh' button.


'''Note:''' Usb with NTFS partition is supported in read-only mode.
{{#ifeq:{{{printer}}}|0||
==Printer Server==
==Printer Server==


Line 86: Line 92:
     <tr>
     <tr>
       <td>Enable</td>
       <td>Enable</td>
       <td>off | on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Turns USB printer support on or off.</td>
       <td>Turns USB printer support on or off.</td>
     </tr>
     </tr>
Line 101: Line 107:
     <tr>
     <tr>
     <td>Bidirectional mode</td>
     <td>Bidirectional mode</td>
         <td>off | on; default: <b>on</b></td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>Turns bidirectional mode on or off.</td>
         <td>Turns bidirectional mode on or off.</td>
     </tr>
     </tr>
</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>|}}
}}


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:{{{shares}}}|0||
 
==USB to Serial==
 
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.
            </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>
 
==Storage Memory Expansion==
 
The <b>Storage Memory Expansion</b> function provides the possibility to expand the device's flash memory with a USB Mass Storage Device (MSD) and use the extra memory to install additional software packages. This section provides instruction on how to do just that. However, there are a few prerequisites and warnings to take note of before using memory expansion.
 
To be eligible for memory expansion, the USB MSD must meet the following restrictions.
 
<ul>
    <li>The MSD must be the last one (chronologically) inserted.</li>
    <li>If you are using a USB hub, the target MSD must be the last one attached to the hub.</li>
    <li><b>No important data on the MSD as it will be wiped during expansion setup!</b></li>
</ul>
 
When expansion is enabled, <b>do not detach the USB device as this will delete the data stored on it</b>. Changes made to the device configuration while expansion was enabled will disappear after it is disabled.
 
===Enabling memory expansion===
----
To successfully expand the flash memory of your device follow the steps described below.
 
<ol>
    <li>Attach a USB Mass Storage Device (MSD) to the USB connector on the device and go to the Services → Storage Memory Expansion page.</li>
    <li>Set the 'Enable storage expansion' slider to 'on' and click 'Save & Apply'.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_1.png|border|class=tlt-border]]</li>
    <li>You will see a pop-up asking for confirmation. Take note that <u>if you continue from this point on:</u>
        <ul>
            <li>your <b>USB device's memory will be wiped</b> and formatted to ext2 format;</li>
            <li>your device's <b>current configuration will be backed up</b> and restored to this point if the USB drive is removed or memory expansion is disabled;</li>
            <li>the entire procedure <b>may take a very long time</b> and includes a reboot at the end; exact time will vary depending on the size of the MSD (larger size will take longer; for example, using a 128 GB drive will take about 2 hours to fully set up, while a 16 GB will only take about 5 minutes).</li>
        </ul>Click 'Continue' to proceed.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_2.png|border|class=tlt-border]]
    </li>
    <li>If all is in order you should see a 'Formatting MSD...' message on the screen. This indicates that the MSD is being formatted and integrated with the system. This procedure can take a long time and ends with a reboot of the device.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_3.png]]</li>
    <li>Your device's flash memory will be expanded once the reboot has finished. In order to check, log in to the WebUI and look to the 'System' widget in the 'Overview' page. Hover your mouse cursor over the 'FLASH' memory indicator; you should see an increase to the device's flash memory.<br>[[File:Networking_rutos_manual_storage_memory_expansion_enable_4.png|border|class=tlt-border]]</li>
</ol>
 
===Disabling memory expansion===
----
To successfully disable memory expansion follow the steps described below.
 
<ol>
    <li>Go to the Services → Storage Memory Expansion page.</li>
    <li>Set the 'Enable storage expansion' slider to 'off' and click 'Save & Apply'.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_1.png|border|class=tlt-border]]</li>
    <li>You will see a pop-up asking for confirmation. Take note that <u>if you continue from this point on:</u>
        <ul>
            <li>your <b>USB device's memory will be wiped</b> and formatted to NTFS format;</li>
            <li>your <b>device's configuration will be restored</b> to the point it was before memory expansion;</li>
            <li>the entire procedure <b>will take up to 2 minutes</b> including a reboot.</li>
        </ul>Click 'Continue' to proceed.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_2.png|border|class=tlt-border]]
    </li>
    <li>If all is in order you should see a 'Formatting MSD...' message on the screen. This indicates that the MSD is being formatted and detached from the system. This procedure can take up to a couple of minutes and ends with a reboot of the device.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_3.png]]</li>
    <li>Your device's flash memory will be restored to normal once the reboot has finished. In order to check, log in to the WebUI and look to the 'System' widget in the 'Overview' page. Hover your mouse cursor over the 'FLASH' memory indicator; you should see your device's flash memory return to its regular size.<br>[[File:Networking_rutos_manual_storage_memory_expansion_disable_4.png|border|class=tlt-border]]</li>
</ol>
 
==Network Shares==
==Network Shares==


Line 409: Line 122:
     <li>FAT</li>
     <li>FAT</li>
     <li>FAT32</li>
     <li>FAT32</li>
    <li>exFAT</li>
     <li>NTFS</li>
     <li>NTFS</li>
    <li>ext2</li>
    <li>ext3</li>
    <li>ext4</li>
</ul>
</ul>
 
{{#switch:{{{series}}}
|#default=|RUTX|RUTM|RUTC=
<u><b>Note:</b> Network Shares is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>}}
===General Settings===
===General Settings===
----
----
The <b>General</b> section is used to set up <b>Samba</b> - a software solution for using the Server Message Block (SMB) networking protocol, which provides shared file access between nodes on a computer network. Refer to the figures and table below for more information about Samba configuration.  
The <b>General</b> section is used to set up <b>Samba</b> - a software solution for using the Server Message Block (SMB) networking protocol, which provides shared file access between nodes on a computer network. Refer to the figures and table below for more information about Samba configuration.  


[[File:Networking_rutos_manual_usb_tools_network_shares_general_samba_general_settings.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_usb_tools_network_shares_general_samba_general_settings_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 426: Line 145:
     <tr>
     <tr>
         <td>Enable</td>
         <td>Enable</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns Samba on or off.</td>
         <td>Turns Samba on or off.</td>
     </tr>
     </tr>
Line 446: Line 165:
     <tr>
     <tr>
         <td>Share home-directories</td>
         <td>Share home-directories</td>
         <td>off | on; default: <b>on</b></td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>Allows system users to reach their home directories via network shares.</td>
         <td>Allows system users to reach their home directories via network shares.</td>
    </tr>
    <tr>
        <td>Interfaces</td>
        <td>lan; default: <b>none</b></td>
        <td>Bind samba server to specified interfaces </td>
    </tr>
    <tr>
        <td>Insert custom configuration to config</td>
        <td>string; default: <b>none</b></td>
        <td>Insert custom line to configuration file.</td>
     </tr>
     </tr>
</table>
</table>
===Edit Template===
----
The <b>Edit Template</b> section is used to make modifications to the template that is used for generating the Samba configuration. This is the content of the <i>/etc/samba/smb.conf.template</i> file from which your Samba configuration will be generated. Values enclosed by pipe symbols ('|') should not be changed. They get their values from the 'General Settings' tab.
[[File:Networking_rutos_manual_usb_tools_network_shares_general_samba_edit_template.png|border|class=tlt-border]]
===Format USB===
----
The <b>Format USB</b> section contains only one button that is used for formatting an attached USB drive.
[[File:Networking_rutos_manual_usb_tools_network_shares_general_samba_format_usb.png|border|class=tlt-border]]


===Shared Directories===
===Shared Directories===
Line 467: 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 486: 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 496: Line 213:
     <tr>
     <tr>
         <td>Read-only</td>
         <td>Read-only</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Makes a Shared Directory read-only, which means the directory can only be accessed to view and read files (not write).</td>
         <td>Makes a Shared Directory read-only, which means the directory can only be accessed to view and read files (not write).</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Browseable</td>
         <td>Browseable</td>
         <td>off | on; default: <b>on</b></td>
         <td>off {{!}} on; default: <b>on</b></td>
         <td>Makes a Shared Directory browsable; i.e., visible in shared directory network discovery.</td>
         <td>Makes a Shared Directory browsable; i.e., visible in shared directory network discovery.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Allow guests</td>
         <td>Allow guests</td>
         <td>off | on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns guest access on or off. Guest access allows anonymous connections to a Shared Directory.</td>
         <td>Turns guest access on or off. Guest access allows anonymous connections to a Shared Directory.</td>
     </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 531: 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]]
}}
 
==DLNA==
 
The <b>Digital Living Network Alliance (DLNA)</b> standard provides the possibility to stream media files from local storage to DLNA-capable devices such as computers, Smart TVs, tablets, etc.
 
This page is used to configure the DLNA service on the device. When the DLNA service is enabled, the device listens for incoming connections on the specified network interface and port number. Clients connecting to that port number on that interface will be granted access to the media files residing in the specified directories.
 
DLNA devices use Universal Plug and Play (UPnP) to discover and communicate with each other on a network. To access the DLNA server hosted on this device you will need a DLNA-capable application. If you're using your phone or other mobile device, simply search for DLNA in the device's application store. On Linux and Windows computers you can use applications capable of playing network media streams (such as VLC). Smart TVs and similar devices may have DLNA support built-in by default.
 
File format types supported by the DLNA service on this device:
 
<ul>
    <li>Audio - WMA, WAV, MP3, FLAC</li>
    <li>Image - JPEG</li>
    <li>Video - WMV, MTS, MP4, MKV, MOV</li>
</ul>
<u><b>Note:</b> DLNA is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
 
===General Settings===
----
[[File:Networking_rutos_manual_dlna_general_settings_v2.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 DLNA service on or off.</td>
    </tr>
    <tr>
      <td>Port</td>
      <td>integer [0..65535]; default: <b>8200</b></td>
      <td>DLNA service listening port.</td>
    </tr>
    <tr>
      <td>Friendly name</td>
      <td>string; default: <b>Teltonika DLNA Server</b></td>
      <td>The name of this server as it will be displayed to clients.</td>
    </tr>
    <tr>
      <td>Root container</td>
      <td>Standard container | Browse directory | Music | Video | Pictures; default: <b>Standard container</b></td>
      <td>Specifies which type of files will be made available in DLNA file sharing.
            <ul>
                <li><b>Standard container</b> - allows browsing the shared media directory but also organizes files by type (music, video, pictures).</li>
                <li><b>Browse directory</b> - allows browsing the shared media directory .</li>
                <li><b>Music, Video, Pictures</b> - only shares the files of the specified type.</li>
            </ul>
        </td>
    </tr>
    <tr>
      <td>Media directories</td>
      <td>filepath(s); default: <b>/mnt</b></td>
      <td>A list of directories that will be scanned by the DLNA service and made available to clients. You can also specify what types of files should be displayed from the directy. Use 'A' for audio, 'V' for video, 'P' for images followed by a comma and the path to the directory. For example:
            <ul>
                <li><i>A,/mnt</i> - share only audio files from the <i>/mnt/sda1</i> directory.</li>
                <li><i>V,/mnt</i> - share only video files from the <i>/mnt/sda1</i> directory.</li>
                <li><i>P,/mnt</i> - share only image files from the <i>/mnt/sda1</i> directory.</li>
            </ul>Click the plus symbol to add more directories.
        </td>
    </tr>
    <tr>
      <td>Album art names</td>
      <td>filename(s); default: <b>Album.jpg</b></td>
      <td>Name of the file(s) to check when searching for album art images. Click the plus symbol to specify more file names.</td>
    </tr>
</table>
 
===Advanced Settings===
----
[[File:Networking_rutos_manual_dlna_advanced_settings_v2.png|border|class=tlt-border]]
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>Interfaces</td>
      <td>network interface; default: <b>br-lan</b></td>
      <td>Network interface(s) on which this DLNA server will be hosted.</td>
    </tr>
    <tr>
      <td>Enable notify</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>
    </tr>
    <tr>
      <td>Enable TIVO</td>
      <td>off | on; default: <b>off</b></td>
      <td>Turn support for streaming .jpg and .mp3 files to a TiVo supporting HMO on or off.</td>
    </tr>
    <tr>
      <td>Strict to DLNA standard</td>
      <td>off | on; default: <b>off</b></td>
      <td>Set this to strictly adhere to DLNA standards. Turning this on will allow server-side downscaling of very large JPEG images, which may hurt JPEG serving performance on (at least) Sony DLNA products.</td>
    </tr>
    <tr>
      <td>Notify interval</td>
      <td>integer; default: <b>900</b></td>
      <td>Notify interval in seconds.</td>
    </tr>
</table>


[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]

Latest revision as of 09:40, 4 October 2024

The information in this page is updated in accordance with firmware version .

Summary

The USB Tools page is used to manage services related to the device's USB connector.

This chapter of the user manual provides an overview of the USB Tools page in {{{name}}} devices.

If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Advanced" button, located at the top of the WebUI.

General

The General section is used to manage global USB settings. It consists of two subsections:

USB Mount Settings

The USB Mount Settings section is used to set the transfer type (synchronous or asynchronous) for the USB device.

Synchronous ensures that all changes to the according filesystem are immediately flushed to disk. Enabling this will drastically lower the life expectancy of your USB device.

Mounted File Systems

The Mounted File Systems list displays USB mass storage devices (MSD) currently attached to this device.

Field Value Description
Device filepath; default: /dev/sd* The filesystem of the attached USB MSD.
Mount Point filepath; default: /mnt/sd* The root directory of the mounted filesystem.
Available string; default: none Displays available storage information for a mounted USB MSD.
Used string; default: none Displays used storage information for a mounted USB MSD.
In Use string; default: none Indicates whether a USB MSD is currently in use by some device service or not.

The Format button can be used to format the attached device, and the Unmount button next to each entry in the list is used to unmount an attached USB device. Please make sure to unmount a USB device before physically detaching it from the {{{name}}}.

The Refresh is used to refresh the information in the Mounted File Systems list. If you attach a new USB device and cannot see it in the list, try clicking the 'Refresh' button.

Note: Usb with NTFS partition is supported in read-only mode.

Printer Server

The Printer Server feature provides the possibility to configure access to a printer that is connected to the USB port of the device. After the printer is connected to the device's USB port and configured, it can be utilized by users in the local network (LAN, WiFi) or remotely.

The 'Add' button lets you add and manage additional printers. To configure a printer instance, click the Edit button located next to it:

Field Value Description
Enable off | on; default: off Turns USB printer support on or off.
Device filepath; default: /dev/usb/lp0 Printer's device file.
Port integer [9100..9109]; default: 9100 Printer's TCP port.
Bidirectional mode off | on; default: on Turns bidirectional mode on or off.

For step-by-step instructions on how to use a printer with {{{name}}}, [[How to set up a USB printer (Windows, {{{name}}})|click here]].

Network Shares

The Network Shares section is used to manage Network-attached storage (NAS) such as USB drives and hard drives. The {{{name}}} device supports the following file system architectures:

  • FAT
  • FAT32
  • exFAT
  • NTFS
  • ext2
  • ext3
  • ext4

General Settings

The General section is used to set up Samba - a software solution for using the Server Message Block (SMB) networking protocol, which provides shared file access between nodes on a computer network. Refer to the figures and table below for more information about Samba configuration.

Field Value Description
Enable off | on; default: off Turns Samba on or off.
Hostname string; default: Router_share Name of the Samba server.
Description string; default: Router share Short description about the Same server.
Workgroup string; default: WORKGROUP Name of the server's workgroup.
Share home-directories off | on; default: on Allows system users to reach their home directories via network shares.
Interfaces lan; default: none Bind samba server to specified interfaces
Insert custom configuration to config string; default: none Insert custom line to configuration file.

Shared Directories

The Shared Directories 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 newly added Shared Directory configuration should look similar to this:

Field Value Description
Name string; default: none Name of a shared directory.
Path filepath; default: No mount point 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).
Allowed users samba user(s); default: none Samba user(s) that are permitted to access a Shared Directory. Users can be created from the Users menu tab.
Read-only off | on; default: off Makes a Shared Directory read-only, which means the directory can only be accessed to view and read files (not write).
Browseable off | on; default: on Makes a Shared Directory browsable; i.e., visible in shared directory network discovery.
Allow guests off | on; default: off Turns guest access on or off. Guest access allows anonymous connections to a Shared Directory.
Actions Delete; default: Delete Deletes a Shared Directory configuration.

To connect to the router's SAMBA server from Windows, specify the address in this format: 

\\smb_server_address\share_name

Replace smb_server_address with the IP address of this device or SAMBA share hostname; replace share_name with the name of the "share" (as specified in the 'Name' field). For example: 

\\192.168.1.1\my_share
\\Router_share\johns_files

Users

The Users 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 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:

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

DLNA

The Digital Living Network Alliance (DLNA) standard provides the possibility to stream media files from local storage to DLNA-capable devices such as computers, Smart TVs, tablets, etc.

This page is used to configure the DLNA service on the device. When the DLNA service is enabled, the device listens for incoming connections on the specified network interface and port number. Clients connecting to that port number on that interface will be granted access to the media files residing in the specified directories.

DLNA devices use Universal Plug and Play (UPnP) to discover and communicate with each other on a network. To access the DLNA server hosted on this device you will need a DLNA-capable application. If you're using your phone or other mobile device, simply search for DLNA in the device's application store. On Linux and Windows computers you can use applications capable of playing network media streams (such as VLC). Smart TVs and similar devices may have DLNA support built-in by default.

File format types supported by the DLNA service on this device:

  • Audio - WMA, WAV, MP3, FLAC
  • Image - JPEG
  • Video - WMV, MTS, MP4, MKV, MOV

Note: DLNA is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

General Settings

Field Value Description
Enable off | on; default: off Turns the DLNA service on or off.
Port integer [0..65535]; default: 8200 DLNA service listening port.
Friendly name string; default: Teltonika DLNA Server The name of this server as it will be displayed to clients.
Root container Standard container | Browse directory | Music | Video | Pictures; default: Standard container Specifies which type of files will be made available in DLNA file sharing.
  • Standard container - allows browsing the shared media directory but also organizes files by type (music, video, pictures).
  • Browse directory - allows browsing the shared media directory .
  • Music, Video, Pictures - only shares the files of the specified type.
Media directories filepath(s); default: /mnt A list of directories that will be scanned by the DLNA service and made available to clients. You can also specify what types of files should be displayed from the directy. Use 'A' for audio, 'V' for video, 'P' for images followed by a comma and the path to the directory. For example:
  • A,/mnt - share only audio files from the /mnt/sda1 directory.
  • V,/mnt - share only video files from the /mnt/sda1 directory.
  • P,/mnt - share only image files from the /mnt/sda1 directory.
Click the plus symbol to add more directories.
Album art names filename(s); default: Album.jpg Name of the file(s) to check when searching for album art images. Click the plus symbol to specify more file names.

Advanced Settings

Field Value Description
Interfaces network interface; default: br-lan Network interface(s) on which this DLNA server will be hosted.
Enable notify off | on; default: on 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.
Enable TIVO off | on; default: off Turn support for streaming .jpg and .mp3 files to a TiVo supporting HMO on or off.
Strict to DLNA standard off | on; default: off Set this to strictly adhere to DLNA standards. Turning this on will allow server-side downscaling of very large JPEG images, which may hurt JPEG serving performance on (at least) Sony DLNA products.
Notify interval integer; default: 900 Notify interval in seconds.

[[Category:{{{name}}} Services section]]

Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_usb_tools&oldid=133641"