Template:Networking rut manual firmware: Difference between revisions

Latest revision as of 11:09, 24 October 2023

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 of the user manual provides an overview of the Firmware page for {{{name}}} devices.

{{{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

Firmware Upgrade Settings

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:Networking_{{{series}}}_manual_firmware.png|border|class=tlt-border]]

field name	value	description
Keep all 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)
Firmware image file (Browse)	- (interactive button)	Click to browse your computer for a firmware image file
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 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 MD5 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. A list of {{{series}}} firmware checksums can be found [[{{{name}}}_Firmware_Downloads|here]].

If everything is in order, you can click the Upgrade 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:

@@ 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==
-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.
+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.
-This chapter is an overview of the Flash Firmware page for {{{name}}} devices.
+This chapter of the user manual provides an overview of the Firmware page for {{{name}}} devices.
-==Flash New Firmware Image==
+=={{{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>.
+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
+ <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:
+<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:
+        <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:
+        <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>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_F</b> - 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</li>
+            <li><b>T_H</b> - 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</li>
+        </ul>
+    </li>
+    <li><b><VERSION></b> - firmware version. The version part consists of 3 or 4 segments:
+        <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><b>other segments</b> indicate the firmware version number</li>
+        </ul>
+    </li>
+</ul>
+=={{#ifeq:{{{series}}} | TRB14x | Flash New Firmware Image | Firmware Upgrade Settings}}==
 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 11: / Line 54: @@
 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}}}]]
+[[File:Networking_{{lc:{{{series}}}}}_manual_firmware.png|border|class=tlt-border]]
 <table class="nd-mantable">
@@ Line 20: / Line 63: @@
      </tr>
      <tr>
-     	<td>Keep settings</td>
+     	<td>{{#ifeq:{{{series}}} | TRB14x | Keep settings | Keep all settings}}</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>
      </tr>
      <tr>
-     	<td>Upgrade from</td>
+     	<td>{{#ifeq:{{{series}}} | TRB14x | Upgrade from | Upgrade from...}}</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>
      </tr>
      <tr>
-       	<td>Image (Browse)</td>
+       	<td>{{#ifeq:{{{series}}} | TRB14x | Image (Browse) | Firmware image file (Browse)}}</td>
         	<td>- (interactive button)</td>
         	<td>Click to browse your computer for a firmware image file</td>
      </tr>
      <tr>
-     	<td>Flash selected image (Upgrade)</td>
+     	<td>{{#ifeq:{{{series}}} | TRB14x | Flash selected image (Upgrade) | Upgrade}}</td>
          <td>- (interactive button)</td>
          <td>Uploads the firmware image to the router and attempts to verify its validity</td>
@@ Line 43: / Line 86: @@
 ===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:
+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:
-[[File:{{{file_verification_succeeded}}}]]
+[[File:Networking_rut_manual_firmware_verification_succeeded.png|border|class=tlt-border]]
-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}}} | TRB142 | {{{series}}} | {{{name}}}}} firmware checksums can be seen <b>[[{{#ifeq:{{{name}}} | TRB142 | {{{series}}} | {{{name}}}}} Firmware checksum list|here]]</b>.
+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>.
-If everything is in order, you can click the <b>Proceed</b> button to initiate the upgrade or click <b>Cancel</b> to abort.
+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.
 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}}}]]
+[[File:Networking_rut_manual_firmware_verification_failed.png|border|class=tlt-border]]
+==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)]]