Difference between revisions of "FOTA WEB Devices"
m (Kriauciunas.to moved page FOTA Devices to FOTA WEB Devices) |
|||
(58 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
− | |||
− | |||
− | |||
There are the following columns in the general Device area. | There are the following columns in the general Device area. | ||
− | [[Image: | + | [[Image:FOTADevice.png|1100px|center]] |
− | {| style="width: 100%;" | + | {| class="wikitable" 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: 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;" | '''VALUE''' | ||
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''DESCRIPTION''' | ! 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''' | + | | rowspan="2" style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" | '''DESCRIPTION'''<br /> |
− | | 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;" | <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;" | 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;" | '''MODEL''' <br /> |
− | | 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;" | 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;" | 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;" | '''FIRMWARE''' <br /> |
− | | 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;" | <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 | + | | 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 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;" | '''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;" |<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 | + | | 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 from '''FILES''' tab. If FM configuration was changed via other means than FOTA – this field shall not be updated.<br /> |
− | '''Note:''' if | + | '''Note:''' if configuration was downloaded from device – it’s name shall be displayed. |
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | 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;" | '''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;" | 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;" | Field displays device’s IMEI. <br /> |
|- | |- | ||
− | | style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |''' | + | | 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;" | | + | | 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;" | | + | | 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;" |''' | + | | 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;" | | + | | 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;" | | + | | 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;" |''' | + | | 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 | + | | 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;" | | + | | 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;" |''' | + | | 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;" | | + | | 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;" | | + | | 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 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;" |'''UPDATED AT'''<br /> | ||
Line 86: | Line 63: | ||
| 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;" |'''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;" |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 | + | | 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.<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;" |'''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;" |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 | + | | 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 system. |
|} | |} | ||
+ | <br /> | ||
− | === | + | =='''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 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 /> | 1. For the manually '''selected devices'''.<br /> | ||
2. For the '''filtered devices'''.<br /> | 2. For the '''filtered devices'''.<br /> | ||
Line 124: | Line 83: | ||
4. For '''all devices'''.<br /> | 4. For '''all devices'''.<br /> | ||
− | [[Image: | + | [[Image:TaskCreation.png|300px|center]] |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | {| class="wikitable" style="width: 100%;" | |
− | + | |+ | |
− | + | ! style="width: 20%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" | '''FIELD NAME''' | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | {| class=" | ||
− | ! 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;" |'''ACTION''' | ||
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''DESCRIPTION''' | ! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''DESCRIPTION''' | ||
Line 179: | Line 97: | ||
|- | |- | ||
| 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;" |'''Update configuration''' <br /> | ||
− | | style="border: 1px solid white; border-bottom: 2px solid #E8E8E8; text-align: left; vertical-align: center; background: white;" |<nowiki>Update selected | + | | 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 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 /> | | 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 /> | 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;" |'''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;" | <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 | + | | 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 – 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;" |'''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;" |<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 | + | | 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 – 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 /> | '''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 /> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
=='''Move'''== | =='''Move'''== | ||
− | This function assigns devices from | + | This function assigns devices from Device list. |
− | + | There is 4 possible filtering options for this function..<br /> | |
− | There | + | 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 /> | ||
Select '''Company''' or '''Group''' name that these devices should be assigned to.<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 /> | '''NOTE:''' a '''Group''' must be created first in '''Groups''' menu.<br /> | ||
− | [[Image: | + | [[Image:MoveFOTA.png|1100px|center]] |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
=='''Export'''== | =='''Export'''== | ||
This function is used to '''Export''' devices to the required '''.csv''' or '''.xlsx''' files. | This function is used to '''Export''' devices to the required '''.csv''' or '''.xlsx''' files. | ||
− | There | + | There is 4 possible filtering options for this function.<br /> |
1. For the manually '''selected devices'''.<br /> | 1. For the manually '''selected devices'''.<br /> | ||
2. For the '''filtered devices'''.<br /> | 2. For the '''filtered devices'''.<br /> | ||
− | 3. For the devices '''from .csv file''' | + | 3. For the devices '''from .csv file'''.<br /> |
4. For '''all devices'''.<br /> | 4. For '''all devices'''.<br /> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | [[Image:ExportFOTA.png|1100px|center]] | |
=='''View Tasks'''== | =='''View Tasks'''== | ||
Line 350: | Line 140: | ||
This menu provides an opportunity to observe the status of a TASK. <br /> | 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 | + | Tasks are successfully '''queued job''', meaning that there was no error parsing user’s request to make an [[FOTA Devices#Create task|'''Create Task''']]. <br /> |
− | If there are multiple jobs assigned for a single device – FOTA | + | If there are multiple jobs assigned for a single device – FOTA shall execute them one by one. Each time a job is completed FM shall reconnect to FOTA immediately and if another job is awaiting – attempt to complete it.<br /> |
The order of job execution is as follows:<br /> | The order of job execution is as follows:<br /> | ||
Line 361: | Line 151: | ||
4. Download CFG 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 | + | 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 the logs shall be taken.<br /> |
Relevant possible error’s that you may encounter after creating a task<br /> | Relevant possible error’s that you may encounter after creating a task<br /> | ||
Line 371: | Line 161: | ||
! style="width: 40%; border: 1px solid white; border-bottom: 2px solid #0054A6; background: white; color: #0054A6; text-align: left;" |'''DESCRIPTION''' | ! 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;" | '''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 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;" |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 /> | ||
Line 382: | Line 172: | ||
In an unlikely event, any other type of error would appear – it should be reported back to us.<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 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 Users|'''Users''']] | ||
[[Category:FOTA WEB]] | [[Category:FOTA WEB]] |
Revision as of 20:22, 28 April 2021
Main Page > Software & Applications > FOTA WEB > FOTA WEB DevicesThere are the following columns in the general Device area.
FIELD NAME | VALUE | DESCRIPTION |
---|---|---|
DESCRIPTION |
Device description |default: - | Will display device description added by the user. |
MODEL |
Device model |
Displays device’s model, e.g. FMB001, FMC130 etc. This field cannot be changed. |
FIRMWARE |
Device firmware version |default: - | 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 with the new firmware. |
CONFIGURATION |
Current configuration name | default: - |
Field displays configuration file name that has been uploaded via FOTA from FILES tab. If FM configuration was changed via other means than FOTA – this field shall not be updated. Note: if configuration was downloaded from device – it’s name shall be displayed. |
IMEI |
Device’s IMEI |
Field displays device’s IMEI. |
SERIAL NO. |
Device’s S/N |
Field displays device’s Serial number. |
COMPANY |
Device’s Company |
This field shall always show which company device belongs to directly. Higher level companies shall not be displayed in this field. |
GROUP |
Device’s Group |
If device is assigned to a group, this field displays group name device is assigned to. |
STATUS NAME |
Devices Status |
This field shall indicate status of device. Possible statuses:
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 |
UPDATED AT |
String; default: N/A |
This field shows the last time device information has changed. |
SEEN AT |
String; default: N/A |
This field shows the last time device connected to FOTA web. |
CREATED AT |
String; default: N/A |
This field shows the time device was added to the FOTA 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 queued job.
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.
1. For the manually selected devices.
2. For the filtered devices.
3. For the devices from .csv file.
4. For all devices.
FIELD NAME | ACTION | DESCRIPTION |
---|---|---|
Update firmware |
Update selected firmware version | Select File | Create |
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. 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. |
Update configuration |
Update selected firmware version | Select File | Create |
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. 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. |
Receive configuration |
Receive configuration | Create |
This function assigns a Download configuration job to device. Next time it connects to FOTA – selected files shall be downloaded. |
Receive internal log |
Receive internal log | Create |
This function assigns a Download logs job to device. Next time it connects to FOTA – selected files shall be downloaded. 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. |
Move
This function assigns devices from Device list.
There is 4 possible filtering options for this function..
1. For the manually selected devices.
2. For the filtered devices.
3. For the devices from .csv file.
4. For all devices.
Select Company or Group name that these devices should be assigned to.
NOTE: a Group must be created first in Groups menu.
Export
This function is used to Export devices to the required .csv or .xlsx files.
There is 4 possible filtering options for this function.
1. For the manually selected devices.
2. For the filtered devices.
3. For the devices from .csv file.
4. For all devices.
View Tasks
This menu provides an opportunity to observe the status of a TASK.
Tasks are successfully queued job, meaning that there was no error parsing user’s request to make an Create Task.
If there are multiple jobs assigned for a single device – FOTA shall execute them one by one. Each time a job is completed FM shall reconnect to FOTA immediately and if another job is awaiting – attempt to complete it.
The order of job execution is as follows:
1. Upload FW to the device
2. Upload CFG to the device
3. Download LOGS from the device
4. Download CFG from the device
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 the logs shall be taken.
Relevant possible error’s that you may encounter after creating a task
TASK | ERROR | DESCRIPTION |
---|---|---|
Config assignment |
Configuration file mismatch device's platform. |
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. |
Firmware |
Firmware file does not exist or information about firmware is missing. Please re-upload firmware file. |
Re-upload the firmware and try again. Should error remain – contact us (your Sales representative) for assistance. |
In an unlikely event, any other type of error would appear – it should be reported back to us.
Filter
Filter is designed to both: (1) filter out a list of devices based on combinations of parameters, (2) and to make bulk ACTIONS.
You can select/filter devices by:
- Company
- Group
- Device Model
- Firmware version
- Configuration version
- Job status
Under Active Filters section you shall see current filters that have been selected.
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.
Active Filters shall maintain current configuration until manually Reset, meaning that navigating through various FOTA menu’s Active Filters shall remain as last configured.
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.
Example for the device filtering window is showed below, where FMB120 model selected.
Clicking on Create task and then selecting a task from filtering, say Firmware upgrade, would assign a Firmware upgrade job to selected devices.
Next chapter Users