Jump to content

Template:Networking rutos manual firmware: Difference between revisions

No edit summary
No edit summary
 
(61 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.03
| series = {{{series}}}
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} Firmware (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>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} Firmware (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==


The <b>Firmware page</b> can be used to check the current firmware version of the device and to upgrade the device's firmware - either from a local file or from server.
The <b>Firmware page</b> can be used to check the current firmware version of the device and to upgrade the device's firmware - either from a local file or from server.


This chapter is an overview of the  <b>Firmware</b>}} page for {{{name}}} devices.
This chapter is an overview of the  <b>Firmware</b> page for {{{name}}} devices.
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer}}
 
=={{{name}}} Firmware==
=={{{name}}} Firmware==


New firmwares are periodically uploaded to this Wiki. To download firmware images for {{{name}}} devices, click <b>[[{{#ifeq:{{{series}}} | TRB14x | {{{name}}} Firmware (EU)| {{{name}}}_Firmware_Downloads}}|here]]</b>.
New firmwares are periodically uploaded to this Wiki. To download firmware images for {{{name}}} devices, click <b>[[{{{name}}}_Firmware_Downloads|here]]</b>.


The name of the image file can provide some basic information about the firmware. Names for {{{name}}} firmware image files are structured as so:
The name of the image file can provide some basic information about the firmware. Names for {{{name}}} firmware image files are structured as so:


  <{{#ifeq:{{{name}}} | RUT850 | NAME | {{#ifeq:{{{series}}} | TRB14x | NAME_REGION | SERIES}}}}>_<TYPE>_<VERSION>{{#ifeq:{{{series}}} | TRB14x | | _WEBUI}}.bin
  <{{#ifeq:{{{name}}} | RUT850 | NAME | SERIES}}>_<TYPE>_<VERSION>_WEBUI.bin
  <b>example</b>: {{#ifeq:{{{name}}} | RUT850 | {{{name}}}_R_00.00.00.bin | {{#ifeq:{{{series}}} | TRB14x | {{uc:{{{name}}}}}0_R_00.00.00.bin | {{uc:{{{series}}}}}_R_00.00.00.bin}}}}
  <b>example</b>: {{#ifeq:{{{name}}} | RUT850 | {{{name}}}_R_00.00.00.bin | {{uc:{{{series}}}}}_R_00.00.00.bin}}


Where:
Where:
<ul>
<ul>
     <li><b><{{#ifeq:{{{name}}} | RUT850 | NAME | {{#ifeq:{{{series}}} | TRB14x | NAME_REGION | SERIES}}}}></b> - the {{#ifeq:{{{name}}} | RUT850 | name | {{#ifeq:{{{series}}} | TRB14x | name and intended region of use | series of the device}}}}. For {{{name}}} devices, the {{#ifeq:{{{name}}} | RUT850 | NAME | {{#ifeq:{{{series}}} | TRB14x | NAME | SERIES}}}} string should always be <b>{{#ifeq:{{{name}}} | RUT850 | {{{name}}} | {{#ifeq:{{{series}}} | TRB14x | {{{name}}} | {{uc:{{{series}}}}}}}}}</b>{{#ifeq:{{{series}}} | TRB14x | .<br> The REGION symbol indicates the intended region of use. Possible values are:
     <li><b><{{#ifeq:{{{name}}} | RUT850 | NAME | SERIES}}></b> - the {{#ifeq:{{{name}}} | RUT850 | name | series of the device}}. For {{{name}}} devices, the {{#ifeq:{{{name}}} | RUT850 | NAME | SERIES}} string should always be <b>{{#ifeq:{{{name}}} | RUT850 | {{{name}}} | {{uc:{{{series}}}}}}}</b>
        <ul>
            <li><b>0</b> - Europe, the Middle East, Africa, Korea, Thailand, India</li>
            <li><b>1</b> - South America, Australia, New Zealand, Taiwan</li>
        </ul>|}}
     </li>
     </li>
     <li><b><TYPE></b> - indicates the type of the firmware image. Possible values are:
     <li><b><TYPE></b> - indicates the type of the firmware image. Possible values are:
         <ul>
         <ul>
             <li><b>R</b> - release. These versions usually undergo extensive testing and are fitted for mass distribution. This is also the only type of firmware that gets uploaded to the <b>{{#ifeq:{{{series}}} | TRB14x | [[{{{name}}} Firmware (EU)|downloads page]] | [[{{{name}}}_Firmware_Downloads|downloads page]]}}</b></li>
             <li><b>R</b> - release. These versions usually undergo extensive testing and are fitted for mass distribution. This is also the only type of firmware that gets uploaded to the <b>[[{{{name}}}_Firmware_Downloads|downloads page]]</b></li>
             <li><b>T_R</b> - test release. A test firmware is usually compiled for internal testing purposes</li>
             <li><b>T_R</b> - test release. A test firmware is usually compiled for internal testing purposes</li>
             <li><b>T_DEV</b> - test development. </li>
             <li><b>T_DEV</b> - test development. </li>
Line 44: Line 46:
</ul>
</ul>


==Firmware Upgrade Settings==
==Update Firmware==


The <b>Firmware Upgrade Settings</b> section is used to upgrade the device's firmware. Firmware can be upgraded either from server or from an image uploaded from your computer.
The <b>Update Firmware</b> section is used to upgrade the device's/modem firmware. Firmware can be upgraded either from server or from an image uploaded from your computer.


The figure below is an example of the Flash New Firmware Image section and the table below provides information on the fields contained in that section:
The figure below is an example of the Flash New Firmware Image section and the table below provides information on the fields contained in that section:
{{#switch:{{{series}}}:
 
|RUTX =
[[File:Networking_rutos_manual_firmware_update_v1.png|thumb|1050px|center|The photo is common to all products. Some devices do not have the internal modem.]]
      {{#ifeq:{{{name}}}
 
        | RUTX12|[[File:Networking_rutx12_manual_firmware_v1.png]]
        |[[File:Networking_rutx_manual_firmware_v2.png]]
      }}
|TRB14X =
[[File:Networking_trb1_manual_firmware_v2.png]]
|TRB2XX =
        {{#ifeq:{{{name}}}
        | TRB255 |[[File:Networking_trb255_manual_firmware_v2.png]]
        |[[File:Networking_trb245_manual_firmware_v2.png]]
        }}
}}
<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>field name</th>
         <th>Field</th>
       <th>value</th>
       <th>Value</th>
       <th>description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Keep settings</td>
     <td>Update from</td>
         <td>yes | no; default: <b>yes</b></td>
         <td><span style="color:blue">File</span> | Server; default: <b>Server</b></td>
         <td>Ensures that all of the current device settings will be kept after the firmware upgrade</td>
         <td>Source of the firmware image. Can be either downloaded from FOTA (Server) or uploaded from a computer (File).</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Upgrade from</td>
     <td>Firmware type</td>
         <td>File | Server; Default: <b>File</b></td>
         <td>Device firmware <nowiki>|</nowiki> Modem firmware; default: <b>Device Firmware</b></td>
         <td>Source of the firmware image. Can be either downloaded from FOTA (Server) or uploaded from a computer (File)</td>
         <td>Firmware type used for upgrade.</td>
     </tr>
     </tr>
 
    <tr>
  <tr>
     <td>Keep settings</td>
     <td>Firmware type</td>
         <td>off | on; default: <b>on</b></td>
         <td>Device firmware{{#ifeq: {{{series}}} |TRB2XX| |{{#ifeq:{{{mobile}}}| 1| <nowiki>|</nowiki> Modem firmware | }} }}; Default: <b>Device Firmware</b></td>
         <td>Ensures that all of the current device settings will be kept after the firmware upgrade.</td>
         <td>{{#ifeq: {{{series}}}|TRB2XX| Firmware type used for upgrade. | Select which type of firmware is going to be uploaded.}}</td>
     </tr>
     </tr>
{{#ifeq:{{{name}}}| RUTX12 |
        <tr>
      <td>Modem</td>
      <td>Modem (primary) <nowiki>|</nowiki> Modem (secondary); Default: <b>Modem (primary)</b></td>
      <td>Select which modem will be updated</td>
        </tr>
|
}}
     <tr>
     <tr>
       <td>Image (Browse)</td>
       <td><span style="color:blue">Image</span></td>
       <td>- (interactive button)</td>
       <td>- (interactive button)</td>
       <td>Click to browse your computer for a firmware image file</td>
       <td>Click to browse your computer for a firmware image file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
    <td> Flash selected image (Upgrade)</td>
      <td>Flash image</td>
        <td>- (interactive button)</td>
      <td>- (interactive button)</td>
        <td>Uploads the firmware image to the router and attempts to verify its validity</td>
      <td>Initiates firmware flash. <b>Note:</b> by default, stable firmware is flashed. To change default firmware settings go to:
[[{{{device}}}__Firmware#FOTA_Settings|FOTA settings]]</td>
     </tr>
     </tr>
</table>
</table>
Line 110: Line 92:
When you upload a firmware image, the device will have to verify the validity of that image. If the verification was successful, you will be redirected to window with a message such as this:
When you upload a firmware image, the device will have to verify the validity of that image. If the verification was successful, you will be redirected to window with a message such as this:


[[File:Networking rutx manual firmware verification v2.png]]
[[File:Networking rutx manual firmware verification v2.png|border|class=tlt-border]]


This means that the uploaded firmware image is compatible with your device. The indication also displays the file's Checksum. A <b>checksum</b> is a sequence of hexadecimal symbols generated after running an algorithm called a cryptographic hash function on a file. Calculating a checksum and comparing it with the one provided by the file source can be used as a file authenticity check method. A list of {{#ifeq:{{{name}}} | RUT850 | {{{name}}} | {{{series}}}}} firmware checksums can be found <b>[[{{#ifeq:{{{series}}} | RUTxx | {{{name}}} Firmware checksum list | RUTX Firmware checksum list}}|here]]</b>.
This means that the uploaded firmware image is compatible with your device. The indication also displays the file's Checksum. A <b>checksum</b> is a sequence of hexadecimal symbols generated after running an algorithm called a cryptographic hash function on a file. Calculating a checksum and comparing it with the one provided by the file source can be used as a file authenticity check method.


If everything is in order, you can click the '''Proceed''' button to begin the update or click <b>Cancel</b> to abort.
If everything is in order, you can click the <b>Proceed</b> button to begin the update or click <b>Cancel</b> to abort.


On the other hand, if the uploaded a firmware file that is incompatible with your device, you will see an indication such as this:
On the other hand, if the uploaded a firmware file that is incompatible with your device, you will see an indication such as this:
Line 121: Line 103:


===FOTA Settings===
===FOTA Settings===
----FOTA stands for "firmware over the air". Here you can enable or disable this feature.
----
[[File:Networking rutx manual firmware fota v1.png]]
FOTA stands for <b>firmware over the air</b>. Here you can enable or disable this feature.
 
{{#ifeq: {{{mobile}}} | 1 |[[File:Networking_rutos_manual_firmware_fota_configuration_modem_v1.png|border|class=tlt-border]]
|[[File:Networking_rutos_manual_firmware_fota_configuration_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>on</b></td>
        <td>Turns the FOTA service on or off.</td>
    </tr>
    <tr>
    <td>Default device firmware</td>
        <td>Stable firmware {{!}} Latest firmware; default: <b>on</b></td>
        <td>Select firmware type to update.</td>
    </tr>
    <tr>
    <td>Device firmware update notifications</td>
        <td>off {{!}} on; default: <b>on</b></td>
        <td>Enables notifications across WebUI when new device firmware version is available on the server.</td>
    </tr>
    <tr>{{#ifeq: {{{mobile}}} | 1 |
    <td>Modem firmware update notifications</td>
        <td>off {{!}} on; default: <b>on</b></td>
        <td>Enables notifications across WebUI when new modem firmware version is available on the server.</td>
    </tr>|}}
</table>


==See also==
==See also==