View source for FOTA WEB Devices

__TOC__

There are the following columns in the general Device area. 

[[Image:FOTADevice.png|1100px|center]]
{| style="width: 100%;"
! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''FIELD NAME'''
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''VALUE'''
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''DESCRIPTION'''
|-
| rowspan="2" style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''DESCRIPTION'''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Device description |default: -</nowiki>
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Will display device description added by the user.<br />
|-
|+
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''MODEL'''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device model<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Displays device’s model, e.g. FMB001, FMC130 etc. This field cannot be changed.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''FIRMWARE'''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Device firmware version |default: -</nowiki>
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Once device is seen – field shall display current firmware version. This field is changed only when firmware has been updated and FM device reconnected to FOTA WEB with the new firmware.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''CONFIGURATION''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Current configuration name | default: - </nowiki><br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Field displays configuration file name that has been uploaded via FOTA WEB from '''FILES''' tab. If FM configuration was changed via other means than FOTA WEB – this field shall not be updated.<br />
'''Note:''' if a configuration was downloaded from the device – it’s name shall be displayed.

'''Note:''' From 2022-02-01, if the device was sent from manufacturing with custom client configuration, the name of the configuration will have the following structure '''''GCFXXX_YYYYMMDDHHMM''''' where:

* '''''XXX'''''  - shows the internal manufacturing identification number
* '''''YYYYMMDDHHMM'''''  - date and time configuration file was uploaded to manufacturing.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''IMEI''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s IMEI<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Field displays device’s IMEI. <br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''SERIAL NO.''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s S/N<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Field displays device’s Serial number.<br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''GSM NUMBER'''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |GSM number (MSISDN) of the SIM card installed in the device
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Note:''' The GSM number is shown in FOTA WEB for all devices that had the SIM card is installed during the device manufacturing process (eSIM or regular SIM) after May 3rd, 2022. 
Previously manufactured devices might not have the GSM number available in FOTA WEB.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''ICCID'''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |ICCID of the SIM card that is installed in the device
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Note:''' The SIM card IMSI is shown in FOTA WEB for all devices that had the SIM card is installed during the device manufacturing process (eSIM or regular SIM) after May 3rd, 2022. 
Previously manufactured devices might not have the ICCID number available in FOTA WEB.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''IMSI'''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |IMSI number of the SIM card that is installed in the device
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Note:''' The SIM card IMSI is shown in FOTA WEB for all devices that had the SIM card is installed during the device manufacturing process (eSIM or regular SIM) after May 3rd, 2022. 
Previously manufactured devices might not have the IMSI number available in FOTA WEB.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''PRODUCT CODE'''
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Manufacturing code of the device
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Internal manufacturing code, that shows the device hardware/firmware configuration.

'''Note:''' All devices manufactured '''after''' 2022, May 3rd will have the product code displayed in FOTA WEB - devices manufactured before this date, might not have the product code in FOTA WEB.
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''COMPANY''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s Company <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shall always show which company device belongs to directly. Higher level companies shall not be displayed in this field. <br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''GROUP'''<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Device’s Group<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |If device is assigned to a group, this field displays group name device is assigned to.<br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''STATUS NAME'''<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Devices Status<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shall indicate status of device. Possible statuses:

'''Inactive''' - Device has not connected to system in the last 30 days

'''Idle''' - Device has no pending tasks

'''Pending''' - Device has queued tasks that have to be executed

'''Working''' - Device currently is connected to server and executing task
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''UPDATED AT'''<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |String; default: N/A <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shows the last time device information has changed.<br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''SEEN AT'''<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |String; default: N/A <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shows the last time device connected to FOTA WEB web.<br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''CREATED AT'''<br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |String; default: N/A <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This field shows the time device was added to the FOTA WEB web system.
|}
=='''Create Task'''==

The '''Create Task''' pop up menu button is the main tool for all possible actions (tasks) with devices. Successful action results in a [[FOTA WEB Devices#View Tasks|'''queued job''']].

[[Image:Task.png|1100px|center]]

This chapter provides an explanation of what each dropdown menu item does and how to use it. There is 4 possible filtering from the beginning to assign your tasks.<br />
1. For the manually '''selected devices'''.<br />
2. For the '''filtered devices'''.<br />
3. For the devices '''from .csv file'''.<br />
4. For '''all devices'''.<br />

[[Image:TaskCreation.png|300px|alt=|left]]

{| class="sortable" style="width: 100%;"
! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''FIELD NAME'''
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''ACTION'''
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''DESCRIPTION'''
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Update firmware''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Update selected firmware version | Select File | Create </nowiki><br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |You can Upload the required firmware version over the '''Files menu''' or over the same pop up windown while selecting the task, if you have the firmware uploaded already, task can be assigned by selecting required firmware version.<br />
If there is no available firmware versions for the update, please press on '''Upload new file''' button to add the file on the same pop up window.<br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Update configuration''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Update selected configuration | Select File | Create </nowiki><br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |You can Upload the required configuration over the '''Files menu''' or over the same pop up windown while selecting the task, if you have the firmware uploaded already, task can be created by selecting required configuration file.<br />
If there is no available configuration versions for the update, please press on '''Upload new file''' button to add the file on the same pop up window.<br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Receive configuration''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Receive configuration | Create </nowiki><br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This function assigns a Download configuration job to device. Next time it connects to FOTA WEB – selected files shall be downloaded.<br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Receive internal log''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Receive internal log | Create </nowiki><br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |This function assigns a Download logs job to device. Next time it connects to FOTA WEB – selected files shall be downloaded.<br />
'''NOTE:''' Continuous log lets you select number of files to be downloaded. Newest log files, that are stored in device’s memory, are taken first. <br />
|-
|'''Send TLS file'''
|<nowiki>Transfer user TLS certificate | Select File | Create </nowiki>
|You can Upload the required TLS certificate over the '''Files menu''' or over the same pop up window while selecting the task, if you have the TLS certificate uploaded already, task can be created by selecting required TLS certificate.<br />If there is no available TLS certificates, please press on '''Upload new file''' button to add the certificate on the same pop up window.
|}

=== Scheduled tasks ===
The "Schedule time" feature allows users to select the time, when the created task can be executed.

[[File:Scheduling_task.png|alt=|frameless|400x400px]]

Time range can be selected in 30 minute periods, but it cannot be less than 2 hours - for example, user can select a task time from 8:30 to 15:00. 

With the time range set for the task, the device will only execute the task, if it connects to FOTA WEB during set hours.

'''NOTE:''' The time is selected in the user's time zone.

'''NOTE:''' The scheduling feature does '''not''' adjust the time of the device connection to FOTA WEB - the user has to ensure, that the device has the correct connection frequency configured, so the device would connect to FOTA WEB during the set time range. Otherwise, the device will not execute the task. 

FOTA WEB connection frequency configuration is described here: [[FMB920 GPRS settings#FOTA%20WEB%20Settings|FOTA WEB Settings]]
=='''Add scenario'''==

The feature allows enabling scenarios on devices as easy as possible. Scenarios e.g.:

*Overspeeding
*Crash Detection
*Towing detection

[[File:2021-12-15 11 26 22-Window2.png|frameless]]

After sending the partial configuration, it will not be portrayed as the current configuration.

Setting scenario doesn't overwrite other parameters apart from scenario parameters.

Each scenario has recommended settings.

Scenarios have info link to scenario Wiki page: [[FMB130 Features settings#Over Speeding|Overspeeding]] | [[FMB130 Accelerometer Features settings#Crash Detection|Crash Detection]] | [[FMB130 Accelerometer Features settings#Towing Detection|Towing Detection]]
[[File:2021-12-15_10_19_03-Window1.png|alt=|center|frameless|1109x1109px]]

=='''Move'''==

This function assigns devices from the Device list.

There are 4 possible filtering options for this function..<br />1. For the manually '''selected devices'''.<br />2. For the '''filtered devices'''.<br />3. For the devices '''from .csv file''' (IMEI or Serial No. can be used as identifier).<br />4. For '''all devices'''.<br />

Select '''Company''' or '''Group''' name that these devices should be assigned to.<br />
'''NOTE:''' a '''Group''' must be created first in '''Groups''' menu.<br />

[[Image:MoveFOTA.png|1100px|center]]

=='''Export'''==

This function is used to '''Export''' devices to the required '''.csv''' or '''.xlsx''' files. 
There are 4 possible filtering options for this function.<br />
1. For the manually '''selected devices'''.<br />
2. For the '''filtered devices'''.<br />
3. For the devices '''from .csv file''' (IMEI or Serial No. can be used as identifier).<br />
4. For '''all devices'''.<br />

=='''Device transfer'''==

This function is used to '''transfer devices''' from one company to another.

[[Image:Device_transfer.png|1100px|center|alt=The photo of "Device transfer" button.|Device transfer window.]]

"Device transfer" function working principle: <br />
1. Company A (Device receiving company) generates a transfer token by selecting the company and clicking on the "Create button". The generated token will be visible in the following window. 
 
<div style="width: 1000px; height: 300px;">
{{{insert1|[[Image:Create_token.png|550x270px|left|]]}}}{{{insert2|[[Image:FOTA_WEB_transfer_token.png|550x270px|right|]]}}}
</div>

<br />

'''NOTE:''' The token is single-use and expires in 21 days. Send this token to the person responsible for transferring devices from their company to yours.

2. Company A provides token to Company B (Device sending company) <br />
3. Company B opens the Device transfer window, Transfer devices tab, and selects the preferred device source (Selected, Filtered or From file). <br />
4. Company B enters the transfer token and clicks on the "Transfer" button to transfer selected devices to the "Receiving company"<br />

[[Image:FOTA_WEB_transfer_devices.png|500px|center]]

If all steps were correctly done, device/devices will be transferred to the receiving company.

=='''View Tasks'''==

This menu provides an opportunity to observe the status of a TASK. <br />

Tasks are successfully '''queued job''', meaning that there was no error parsing user’s request to make an [[FOTA WEB Devices#Create task|'''Create Task''']]. <br />

If there are multiple jobs assigned for a single device – FOTA WEB shall execute them one by one. Each time a job is completed FM shall reconnect to FOTA WEB immediately and if another job is awaiting – attempt to complete it.<br />

The order of job execution is as follows:<br />

1. Upload FW to the device <br />
2. Upload CFG to the device <br />
3. Download LOGS from the device <br />
4. Download CFG from the device <br />

Meaning, that if you set all 4 jobs – the device will first upload firmware file, then configuration file and only on 3rd reconnect to FOTA WEB the logs shall be taken.<br />

Relevant possible error’s that you may encounter after creating a task<br />

{| class="wikitable" style="width: 100%;"
|+
! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''TASK'''
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''ERROR'''
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''DESCRIPTION'''
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Config assignment''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Configuration file mismatch device's platform. <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Configuration file is not applicable to this type of device model. Select config file that works on this particular device, e.g. FMB64 config for FMB64 device model. <br />
|-
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |'''Firmware''' <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Firmware file does not exist or information about firmware is missing. Please re-upload firmware file. <br />
| style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |Re-upload the firmware and try again. Should error remain – contact us (your Sales representative) for assistance. <br />
|}

In an unlikely event, any other type of error would appear – it should be reported back to us.<br />

=='''Filter'''==

Filter is designed to both: (1) filter out a list of devices based on combinations of parameters, (2) and to make bulk ACTIONS.<br />

You can select/filter devices by:<br />

*Company<br />
*Group<br />
*Device Model<br />
*Firmware version<br />
*Configuration version<br />
*Job status<br />

Under '''Active Filters''' section you shall see current filters that have been selected.<br />
Each of the '''Active Filters''' can be removed individually by clicking on a particular filter, or they all can be removed together by clicking '''Reset all'''.<br />
'''Active Filters''' shall maintain current configuration until manually Reset, meaning that navigating through various FOTA WEB menu’s '''Active Filters''' shall remain as last configured.<br />

==='''Bulk assignment'''===

Once '''Active Filters''' section has any number of parameters, the '''ACTIONS''' dropdown button automatically displays how many devices have been filtered. It allows to assign jobs to all selected devices.<br />

Example for the device filtering window is showed below, where FMB120 model selected.
[[Image:FOTAFilters.png|1100px|center]]<br />

Clicking on '''Create task''' and then selecting a task from filtering, say Firmware upgrade, would assign a Firmware upgrade job to selected devices.<br />

Next chapter [[FOTA WEB Users|'''Users''']]

[[Category:FOTA WEB]]