Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions docs/Coiote_IoT_DM/Campaigns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: Campaigns
date: 2024-01-23
og_title: AVSystem IoT Developer Zone
---
# Campaigns

Firmware campaigns allows for updating a group of devices simultaneously. This feature enables configuration, activation, and tracking the Fleet FOTA campaign process.

## FOTA campaigns dashboard

![FOTA campaigns dashboard](images/FOTA_Campaigns_Dashboard.png)
The FOTA campaigns dashboard consists of a list of campaigns with the possibility to add or hide columns with:

* **Status**
* **Name**
* **Domain**
* **Target device type**
* **Start time**
* **Finish time**
* **Created**
* **Created by**

The possible statuses for a campaign can be as follows:

* **Active** - The campaign is in progress.
* **Finished** - The campaign ended.
* **Canceled** - The Firmware configuration has been removed, as a result of which all the Firmware updates in this campaign are canceled.
* **Deactivated** - The campaign is no longer active, as it was stopped while being in progress.
* **Scheduled** - The start time for the campaign has been scheduled, but it hasn't started yet.

The **Settings** icon allows for adjusting the table according to your preferences. If you want to search for specific campaigns, you can type the campaign name in the search bar or filter entities per status and domain.

In the dashboard view, by clicking the **Actions** icon > **Go to campaign details**, you can preview details on the chosen campaign.
![FOTA campaign details](images/Firmware_Updates_On_Devices_dashboard.png)
The cards show Firmware update statuses and number of affected devices. The following statuses are possible:

- Finished - completed updates with the **Error** and **Success** status
- Not started - scheduled updates with the **Not started** status
- Ongoing - updates that are in progress
- Successful - successfully completed updates
- Failed - updates with the **Error** status
- Canceled - updates canceled manually or automatically while being in progress

By clicking on a chosen status card, you will be taken to the **Updates started** or **Updates not started** tab, depending whether the update is finished, in progress or not started yet. This view shows a list of devices concerned with assigned statuses, campaign start time, campaign finish time, and the last time when the device was active. The **Updates started** tab allows for filtering Firmware updates by status.

The **Information** tab consists of information on a chosen FOTA campaign and the used FOTA configuration.

The left-side panel summarizes FOTA campaign information and allows for deactivating the campaign with no possibility to reactivate it. If there are any ongoing FOTA Firmware updates, they will be finished normally, but the new updates won't start.

## Manage groups

You can manage groups of devices according to your preferences.
![Manage groups](images/Manage_group_dashboard.png)

1. In the left-side panel, go to **Device inventory**.
2. Select devices that you want to carry out actions on.
3. Click **Actions** and choose the action that you want to execute.
* To add selected devices to a group, click **Add to group** and specify your preferences in the dialog window.
* To remove devices from a group, click **Remove from group** and follow the instruction in the dialog window.
* To change a domain, click **Change domain** and follow the instruction in the dialog window.
* To permanently delete devices, click **Delete**. You won't be able to recover deleted devices.


## Add FOTA campaigns

1. To add FOTA campaign, go to **Firmware Update** > **FOTA campaigns**.
2. In the upper-right corner, click **Add FOTA campaign** > **Basic**.
3. In the **Basic data** view, provide a campaign name, description of the firmware (optionally) and select FOTA configuration.
![Domain selection](images/Domains_selection.png)

!!! info
You can choose between subordinate, superior or your own domain. If you select a configuration from a domain below yours, the devices included in the update will be limited to the devices under that sub-domain.

4. In the preview section, verify the details before moving next.
5. To schedule campaign time, click **Next**.
6. Specify campaign start and finish time by choosing the date and time. The campaign can last for up to 6 months.
7. To proceed, click **Next**.
8. In the **Devices** section, select target device type and device group. The table shows a list of affected devices with a corresponding status, endpoint name and the last time they were active.
9. To go to the **Summary** section, click **Next**.
10. Once you review the details of your campaign, click **Add FOTA campaign**.

If you fill in the details correctly, you will see the confirmation that your campaign has been added successfully.

!!! info
For more information on adding devices to a group, see [Manage groups](#manage-groups).

71 changes: 71 additions & 0 deletions docs/Coiote_IoT_DM/Configurations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Configurations
date: 2024-01-22
og_title: AVSystem IoT Developer Zone
---
# Configurations
FOTA Configuration is an entity that determines the technical settings for Firmware updates. The settings cover:

- image delivery method
- image transport type
- URI format
- timeout

You can create and manage Fleet FOTA configuration for your devices.

## FOTA configurations dashboard

![FOTA configuration dashboard](images/FOTA_Confiuration_Dashboard.png)
The FOTA configuration dashboard contains a list of configurations with the possibility to filter information per:

* **Status** (active or expired)
* **Name**
* **Type** (multi-component or basic)
* **Domain**
* **Expiration date**
* **Created**
* **Created by**
* **Visible in subdomains** (visible or not visible)

The **Settings** icon allows for adjusting the table by adding or hiding columns. If you want to search for specific configurations, you can type the configuration name in the search bar or filter entities per status and domain.

The **More actions** icon lets you execute the following:

- **Show settings** allows for previewing details on the chosen configuration.
- **Copy** takes you to the view of creating a new configuration.
- **Delete** simply deletes the chosen configuration. This action affects firmware updates that use a given configuration, as those updates won't be completed. It also affects the FOTA campaigns that use this configuration underneath. If deleted, the FOTA campaign changes status to **Canceled** and the Firmware updates can't be finished successfully therefore they are canceled as well.

## Add FOTA configurations

1. From the navigation menu, go to **Firmware Update** > **FOTA configurations**.
2. To start creating a new configuration, click **Add FOTA configuration** > **Basic**.
3. In the **Basic data** section, type in the configuration name.
4. Upload a firmware image from the repository or from your computer. For a newly uploaded image, provide a file name and confirm your choice by clicking **Save**.
5. To see the configuration in the domains under yours, enable the **Visible in subdomains** option. This option essentially allows your subcustomers to use the FOTA Firmware update. The underlying files expiration date is set to 6 months by default.
6. Optionally, in the **Description** field, provide information on your firmware.
7. To go to **Settings**, click **Next**.
8. Choose the image delivery method:

![Basic Firmware Update](images/push-pull.png)

* **Pull method** (recommended): The LwM2M Client receives the URI of the file that is to be downloaded and pulls the file from it.
**Pull** supports the following **transport types**:
- `CoAP` or `CoAPs` over `UDP`
- `CoAP` or `CoAPs` over `TCP`
- `HTTP` or `HTTPs`
* **Push method**: The LwM2M Server pushes the firmware file to the device.
**Push** transmits the firmware over the same transport type as is used for device management, which is `CoAPs` over `UDP` by default.

!!! Tip "Which transport protocol to choose?"
Downloads using `CoAP(s)` over `UDP` tend to be slow due to the limitation of the maximum CoAP Block size of 1024 bytes and the required acknowledgements for each Block transfer.
Choosing `CoAP(s)` over `TCP` or `HTTP(s)` usually results in faster download speeds. However, not every device supports these transport protocols.

9. Choose the URI format in which the URL is sent to the firmware package.

!!! Info
You can verify the location of the security token in the **Preview** field.

10. Once you check the details in the **Firmware Update Flow Preview** section, click **Next**.
11. In the **Summary** section, preview the Firmware update information and click **Add FOTA configuration**.

If you fill in the details correctly, you see the confirmation that the FOTA configuration has been added successfully.
Loading