Template:Networking rutos manual firmware: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
 
(42 intermediate revisions by 5 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.1
| 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
{{#ifeq:{{{series}}}|TAP100||{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series = {{{series}}}
| series = {{{series}}}
}}
| name = {{{name}}}
}}}}


=={{{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 49: Line 51:
</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 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 =
{{#ifeq: {{{series}}} | TRB1 | [[File:Networking_rutos_manual_firmware_modem_{{{mobile}}}_v4.png|border|class=tlt-border]] | [[File:Networking_rutos_manual_firmware_modem_{{{mobile}}}_v2.png|border|class=tlt-border]]}}
      {{#switch:{{{name}}}
 
        | RUTX12 = [[File:Networking_rutx12_manual_firmware_v1.png]]
        | RUTX10 = [[File:Networking_rutx08_10_manual_firmware_v1.png]]
        | RUTX08 = [[File:Networking_rutx08_10_manual_firmware_v1.png]]
        | [[File:Networking_rutx_manual_firmware_v3.png|border|class=tlt-border]]
      }}
|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>Upgrade from</td>
         <td>yes | no; default: <b>yes</b></td>
         <td>File | 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>{{#ifeq: {{{series}}} | TRB1 |
     <tr>
     <tr>
    <td>Upgrade from</td>
        <td>File | Server; Default: <b>File</b></td>
        <td>Source of the firmware image. Can be either downloaded from FOTA (Server) or uploaded from a computer (File)</td>
    </tr>
  <tr>
     <td>Firmware type</td>
     <td>Firmware type</td>
         <td>Device firmware{{#ifeq: {{{series}}} |TRB2XX| |{{#ifeq:{{{mobile}}}| 1| <nowiki>|</nowiki> Modem firmware | }} }}; Default: <b>Device Firmware</b></td>
         <td>Device firmware <nowiki>|</nowiki> Modem firmware; default: <b>Device Firmware</b></td>
         <td>{{#ifeq: {{{series}}}|TRB2XX| Firmware type used for upgrade. | Select which type of firmware is going to be uploaded.}}</td>
         <td>Firmware type used for upgrade.</td>
    </tr>|}}
    <tr>
    <td>Keep settings</td>
        <td>off | on; default: <b>on</b></td>
        <td>Ensures that all of the current device settings will be kept after the firmware upgrade.</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>Image</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>
    <td> Flash selected image (Upgrade)</td>
        <td>- (interactive button)</td>
        <td>Uploads the firmware image to the router and attempts to verify its validity</td>
     </tr>
     </tr>
</table>
</table>
Line 116: Line 91:
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 126: Line 101:
[[File:Trb14x_webui_system_flash_firmware_verification_failed_v2.png| ]]
[[File:Trb14x_webui_system_flash_firmware_verification_failed_v2.png| ]]


===FOTA Settings===
===FOTA Configuration===
----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.png|border|class=tlt-border]]
|[[File:Networking_rutos_manual_firmware_fota_configuration_v1.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>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==

Latest revision as of 12:05, 19 April 2024

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


Summary

The Firmware page 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 Firmware page for {{{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.

{{{name}}} Firmware

New firmwares are periodically uploaded to this Wiki. To download firmware images for {{{name}}} devices, click [[{{{name}}}_Firmware_Downloads|here]].

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

<SERIES>_<TYPE>_<VERSION>_WEBUI.bin
example: {{{SERIES}}}_R_00.00.00.bin

Where:

  • <SERIES> - the series of the device. For {{{name}}} devices, the SERIES string should always be {{{SERIES}}}
  • <TYPE> - indicates the type of the firmware image. Possible values are:
    • R - 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 [[{{{name}}}_Firmware_Downloads|downloads page]]
    • T_R - test release. A test firmware is usually compiled for internal testing purposes
    • T_DEV - test development.
    • T_F - test feature. A test feature firmware usually contains some new feature that is not present in the release version. However, unlike the release version, the feature version will not include other fixes, has not been thoroughly tested and approved for release
    • T_H - test hotfix. Hotfixes are firmwares that contain a fix (usually one) for some issue present in the release version. They are compiled when a quick fix is required and usually nothing else in the release is changed
  • <VERSION> - firmware version. The version part consists of 3 or 4 segments:
    • first segment indicates whether the firmware is standard or modified in some special way. If the first segment is 00, it means the file is a standard Teltonika firmware image. If the first segment is anything else (e.g., 01), it means this is a special version of the firmware, usually customized for specific customer
    • other segments indicate the firmware version number

Update Firmware

The Update Firmware 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 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:

[[File:Networking_rutos_manual_firmware_modem_{{{mobile}}}_v2.png|border|class=tlt-border]]

Field Value Description
Upgrade from File | Server; default: Server Source of the firmware image. Can be either downloaded from FOTA (Server) or uploaded from a computer (File).
Keep settings off | on; default: on Ensures that all of the current device settings will be kept after the firmware upgrade.
Image - (interactive button) Click to browse your computer for a firmware image file.

Firmware verification

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:

This means that the uploaded firmware image is compatible with your device. The indication also displays the file's Checksum. A checksum 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 Cancel 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:

FOTA Configuration

FOTA stands for firmware over the air. Here you can enable or disable this feature.

Field Value Description
Enable off | on; default: on Turns the FOTA service on or off.
Device firmware update notifications off | on; default: on Enables notifications across WebUI when new device firmware version is available on the server.

See also

Teltonika provides a software development kit (SDK) for their Networking products' firmwares under the General Public Licence (GPL). This enables the user to modify the firmware in any way according to their liking. Downloads and other related information can be found here.

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

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