Template:Networking rut manual firmware: Difference between revisions

From Teltonika Networks Wiki
m (Text replacement - "\{\{Template: Networking_rutos_manual_fw_disclosure (.*) (.*) (.*) (.*) \}\}" to "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }}")
No edit summary
(66 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Template: Networking_device_manual_fw_disclosure
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
}}
}}
==Summary==
==Summary==


The <b>Firmware</b> 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.
The <b>Flash Firmware</b> 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 of the user manual provides an overview of the Firmware page for {{{name}}} devices.
This chapter is an overview of the Flash Firmware page for {{{name}}} devices.


=={{{name}}} Firmware==
==Where can I get a firmware image for my device?==


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>[[{{#ifeq:{{{name}}} | RUT850 | {{{name}}} | {{{series}}}}} Firmware|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>
<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}}}}


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></li>
        <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><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 are usually undergo extensive testing and are fitted more mass usage. This is also the only type of firmware that gets uploaded the <b>[[{{#ifeq:{{{name}}} | RUT850 | {{{name}}} | {{{series}}}}} Firmware|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 39: Line 25:
         </ul>
         </ul>
     </li>
     </li>
     <li><b><VERSION></b> - firmware version. The version part consists of 3 or 4 segments:
     <li><b><VERSION></b> - firmware version. The version part is made up of 3 or 4 segments. The first segment indicates whether the firmware is standard or modified in some special way. If the first segment is <b>00</b>, it means the file is a standard Teltonika firmware image. If the first segment is anything else (e.g., <b>00</b>), it means
         <ul>
         <ul>
             <li><b>first segment</b> indicates whether the firmware is standard or modified in some special way. If the first segment is <b>00</b>, it means the file is a standard Teltonika firmware image. If the first segment is anything else (e.g., <b>01</b>), it means this is a special version of the firmware, usually customized for specific customer
             <li></li>
            </li>
             <li></li>
             <li><b>other segments</b> indicate the firmware version number</li>
         </ul>
         </ul>
     </li>
     </li>
</ul>
</ul>


=={{#ifeq:{{{series}}} | TRB14x | Flash New Firmware Image | Firmware Upgrade Settings}}==
==Flash New Firmware Image==


The <b>Flash New Firmware Image</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>Flash New Firmware Image</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.
Line 54: Line 39:
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:


[[File:Networking_{{lc:{{{series}}}}}_manual_firmware.png|border|class=tlt-border]]
[[File:{{{file_flash_firmware}}}]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 63: Line 48:
     </tr>
     </tr>
     <tr>
     <tr>
     <td>{{#ifeq:{{{series}}} | TRB14x | Keep settings | Keep all settings}}</td>
     <td>Keep settings</td>
         <td>yes | no; default: <b>yes</b></td>
         <td>yes | no; default: <b>yes</b></td>
         <td>Ensures that all of the current device settings will be kept after the firmware upgrade</td>
         <td>Ensures that all of the current device settings will be kept after the firmware upgrade</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>{{#ifeq:{{{series}}} | TRB14x | Upgrade from | Upgrade from...}}</td>
     <td>Upgrade from</td>
         <td>File | Server; Default: <b>Server</b></td>
         <td>File | Server; Default: <b>Server</b></td>
         <td>Source of the firmware image. Can be either downloaded from Fota Free (Server) or uploaded from a computer (File)</td>
         <td>Source of the firmware image. Can be either downloaded from Fota Free (Server) or uploaded from a computer (File)</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>{{#ifeq:{{{series}}} | TRB14x | Image (Browse) | Firmware image file (Browse)}}</td>
       <td>Image (Browse)</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>{{#ifeq:{{{series}}} | TRB14x | Flash selected image (Upgrade) | Upgrade}}</td>
     <td>Flash selected image (Upgrade)</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>Uploads the firmware image to the router and attempts to verify its validity</td>
Line 86: Line 71:
===Firmware verification===
===Firmware verification===
----
----
When you upload a firmware image, the device will have to verify the validity of that image. If the verification was a success, 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 a success, you will redirected to window with a message such as this:


[[File:Networking_rut_manual_firmware_verification_succeeded.png|border|class=tlt-border]]
[[File:{{{file_verification_succeeded}}}]]


This means that the uploaded firmware image is compatible with your device. The indication also displays the file's {{#ifeq:{{{series}}} | TRB14x | MD5 and SHA256 checksums | MD5 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}}} | TRB14x | {{{name}}} Firmware checksum list | {{{name}}}_Firmware_Downloads}}|here]]</b>.
This means that the uploaded firmware image is compatible with your device. The indication also displays the file's MD5 and SHA256 checksums. 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:{{{name}}} | RUT850 | {{{name}}} | {{{series}}}}} Firmware checksum list|here]]</b>.


If everything is in order, you can click the {{#ifeq:{{{series}}} | TRB14x | <b>Proceed</b> | <b>Upgrade</b>}} 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 initiate the upgrade 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:


[[File:Networking_rut_manual_firmware_verification_failed.png|border|class=tlt-border]]
[[File:{{{file_verification_failed}}}]]
 
==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 <b>[[GPL|here]]</b>.
 
[[Category:{{{name}}} System section (legacy)]]

Revision as of 12:47, 11 January 2019

Summary

The Flash 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 Flash Firmware page for {{{name}}} devices.

Where can I get a firmware image for my device?

New firmwares are periodically uploaded to this Wiki. To download firmware images for {{{name}}} devices, click [[{{{series}}} Firmware|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>

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 are usually undergo extensive testing and are fitted more mass usage. This is also the only type of firmware that gets uploaded the [[{{{series}}} Firmware|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 is made up of 3 or 4 segments. The 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., 00), it means

Flash New Firmware Image

The Flash New Firmware Image 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:{{{file_flash_firmware}}}]]

field name value description
Keep settings yes | no; default: yes Ensures that all of the current device settings will be kept after the firmware upgrade
Upgrade from File | Server; Default: Server Source of the firmware image. Can be either downloaded from Fota Free (Server) or uploaded from a computer (File)
Image (Browse) - (interactive button) Click to browse your computer for a firmware image file
Flash selected image (Upgrade) - (interactive button) Uploads the firmware image to the router and attempts to verify its validity

Firmware verification


When you upload a firmware image, the device will have to verify the validity of that image. If the verification was a success, you will redirected to window with a message such as this:

[[File:{{{file_verification_succeeded}}}]]

This means that the uploaded firmware image is compatible with your device. The indication also displays the file's MD5 and SHA256 checksums. 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. A list of {{{series}}} firmware checksums can be found [[{{{series}}} Firmware checksum list|here]].

If everything is in order, you can click the Proceed button to initiate the upgrade 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:

[[File:{{{file_verification_failed}}}]]