Merge pull request #4959 from YevhenBondarenko/feature/ota-tag

[3.3.0] OtaPackage Tag

application/src/main/data/upgrade/3.2.2/schema_update.sql

@@ -67,6 +67,7 @@ CREATE TABLE IF NOT EXISTS ota_package (
     type varchar(32) NOT NULL,
     title varchar(255) NOT NULL,
     version varchar(255) NOT NULL,
+    tag varchar(255),
     url varchar(255),
     file_name varchar(255),
     content_type varchar(255),

application/src/main/java/org/thingsboard/server/controller/OtaPackageController.java

@@ -146,6 +146,7 @@ public class OtaPackageController extends BaseController {
             otaPackage.setType(info.getType());
             otaPackage.setTitle(info.getTitle());
             otaPackage.setVersion(info.getVersion());
+            otaPackage.setTag(info.getTag());
             otaPackage.setAdditionalInfo(info.getAdditionalInfo());
 
             ChecksumAlgorithm checksumAlgorithm = ChecksumAlgorithm.valueOf(checksumAlgorithmStr.toUpperCase());

application/src/main/java/org/thingsboard/server/service/ota/DefaultOtaPackageStateService.java

@@ -64,6 +64,7 @@ import static org.thingsboard.server.common.data.ota.OtaPackageKey.CHECKSUM;
 import static org.thingsboard.server.common.data.ota.OtaPackageKey.CHECKSUM_ALGORITHM;
 import static org.thingsboard.server.common.data.ota.OtaPackageKey.SIZE;
 import static org.thingsboard.server.common.data.ota.OtaPackageKey.STATE;
+import static org.thingsboard.server.common.data.ota.OtaPackageKey.TAG;
 import static org.thingsboard.server.common.data.ota.OtaPackageKey.TITLE;
 import static org.thingsboard.server.common.data.ota.OtaPackageKey.TS;
 import static org.thingsboard.server.common.data.ota.OtaPackageKey.URL;
@@ -246,6 +247,11 @@ public class DefaultOtaPackageStateService implements OtaPackageStateService {
         List<TsKvEntry> telemetry = new ArrayList<>();
         telemetry.add(new BasicTsKvEntry(ts, new StringDataEntry(getTargetTelemetryKey(firmware.getType(), TITLE), firmware.getTitle())));
         telemetry.add(new BasicTsKvEntry(ts, new StringDataEntry(getTargetTelemetryKey(firmware.getType(), VERSION), firmware.getVersion())));
+
+        if (StringUtils.isNotEmpty(firmware.getTag())) {
+            telemetry.add(new BasicTsKvEntry(ts, new StringDataEntry(getTargetTelemetryKey(firmware.getType(), TAG), firmware.getTag())));
+        }
+
         telemetry.add(new BasicTsKvEntry(ts, new LongDataEntry(getTargetTelemetryKey(firmware.getType(), TS), ts)));
         telemetry.add(new BasicTsKvEntry(ts, new StringDataEntry(getTelemetryKey(firmware.getType(), STATE), OtaPackageUpdateStatus.QUEUED.name())));
 
@@ -289,6 +295,9 @@ public class DefaultOtaPackageStateService implements OtaPackageStateService {
         List<AttributeKvEntry> attributes = new ArrayList<>();
         attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(getAttributeKey(otaPackageType, TITLE), otaPackage.getTitle())));
         attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(getAttributeKey(otaPackageType, VERSION), otaPackage.getVersion())));
+        if (StringUtils.isNotEmpty(otaPackage.getTag())) {
+            attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(getAttributeKey(otaPackageType, TAG), otaPackage.getTag())));
+        }
         if (otaPackage.hasUrl()) {
             attributes.add(new BaseAttributeKvEntry(ts, new StringDataEntry(getAttributeKey(otaPackageType, URL), otaPackage.getUrl())));
             List<String> attrToRemove = new ArrayList<>();

common/data/src/main/java/org/thingsboard/server/common/data/OtaPackageInfo.java

@@ -37,6 +37,7 @@ public class OtaPackageInfo extends SearchTextBasedWithAdditionalInfo<OtaPackage
     private OtaPackageType type;
     private String title;
     private String version;
+    private String tag;
     private String url;
     private boolean hasData;
     private String fileName;
@@ -61,6 +62,7 @@ public class OtaPackageInfo extends SearchTextBasedWithAdditionalInfo<OtaPackage
         this.type = otaPackageInfo.getType();
         this.title = otaPackageInfo.getTitle();
         this.version = otaPackageInfo.getVersion();
+        this.tag = otaPackageInfo.getTag();
         this.url = otaPackageInfo.getUrl();
         this.hasData = otaPackageInfo.isHasData();
         this.fileName = otaPackageInfo.getFileName();

common/data/src/main/java/org/thingsboard/server/common/data/ota/OtaPackageKey.java

@@ -19,7 +19,7 @@ import lombok.Getter;
 
 public enum OtaPackageKey {
 
-    TITLE("title"), VERSION("version"), TS("ts"), STATE("state"), SIZE("size"), CHECKSUM("checksum"), CHECKSUM_ALGORITHM("checksum_algorithm"), URL("url");
+    TITLE("title"), VERSION("version"), TS("ts"), STATE("state"), SIZE("size"), CHECKSUM("checksum"), CHECKSUM_ALGORITHM("checksum_algorithm"), URL("url"), TAG("tag");
 
     @Getter
     private final String value;

common/transport/lwm2m/src/main/java/org/thingsboard/server/transport/lwm2m/server/attributes/DefaultLwM2MAttributesService.java

@@ -120,9 +120,11 @@ public class DefaultLwM2MAttributesService implements LwM2MAttributesService {
         if (msg.getSharedUpdatedCount() > 0 && lwM2MClient != null) {
             String newFirmwareTitle = null;
             String newFirmwareVersion = null;
+            String newFirmwareTag = null;
             String newFirmwareUrl = null;
             String newSoftwareTitle = null;
             String newSoftwareVersion = null;
+            String newSoftwareTag = null;
             String newSoftwareUrl = null;
             List<TransportProtos.TsKvProto> otherAttributes = new ArrayList<>();
             for (TransportProtos.TsKvProto tsKvProto : msg.getSharedUpdatedList()) {
@@ -131,12 +133,16 @@ public class DefaultLwM2MAttributesService implements LwM2MAttributesService {
                     newFirmwareTitle = getStrValue(tsKvProto);
                 } else if (DefaultLwM2MOtaUpdateService.FIRMWARE_VERSION.equals(attrName)) {
                     newFirmwareVersion = getStrValue(tsKvProto);
+                } else if (DefaultLwM2MOtaUpdateService.FIRMWARE_TAG.equals(attrName)) {
+                    newFirmwareTag = getStrValue(tsKvProto);
                 } else if (DefaultLwM2MOtaUpdateService.FIRMWARE_URL.equals(attrName)) {
                     newFirmwareUrl = getStrValue(tsKvProto);
                 } else if (DefaultLwM2MOtaUpdateService.SOFTWARE_TITLE.equals(attrName)) {
                     newSoftwareTitle = getStrValue(tsKvProto);
                 } else if (DefaultLwM2MOtaUpdateService.SOFTWARE_VERSION.equals(attrName)) {
                     newSoftwareVersion = getStrValue(tsKvProto);
+                } else if (DefaultLwM2MOtaUpdateService.SOFTWARE_TAG.equals(attrName)) {
+                    newSoftwareTag = getStrValue(tsKvProto);
                 } else if (DefaultLwM2MOtaUpdateService.SOFTWARE_URL.equals(attrName)) {
                     newSoftwareUrl = getStrValue(tsKvProto);
                 }else {
@@ -144,10 +150,10 @@ public class DefaultLwM2MAttributesService implements LwM2MAttributesService {
                 }
             }
             if (newFirmwareTitle != null || newFirmwareVersion != null) {
-                otaUpdateService.onTargetFirmwareUpdate(lwM2MClient, newFirmwareTitle, newFirmwareVersion, Optional.ofNullable(newFirmwareUrl));
+                otaUpdateService.onTargetFirmwareUpdate(lwM2MClient, newFirmwareTitle, newFirmwareVersion, Optional.ofNullable(newFirmwareUrl), Optional.ofNullable(newFirmwareTag));
             }
             if (newSoftwareTitle != null || newSoftwareVersion != null) {
-                otaUpdateService.onTargetSoftwareUpdate(lwM2MClient, newSoftwareTitle, newSoftwareVersion, Optional.ofNullable(newSoftwareUrl));
+                otaUpdateService.onTargetSoftwareUpdate(lwM2MClient, newSoftwareTitle, newSoftwareVersion, Optional.ofNullable(newSoftwareUrl), Optional.ofNullable(newSoftwareTag));
             }
             if (!otherAttributes.isEmpty()) {
                 onAttributesUpdate(lwM2MClient, otherAttributes);

common/transport/lwm2m/src/main/java/org/thingsboard/server/transport/lwm2m/server/ota/DefaultLwM2MOtaUpdateService.java

@@ -85,9 +85,11 @@ public class DefaultLwM2MOtaUpdateService extends LwM2MExecutorAwareService impl
 
     public static final String FIRMWARE_VERSION = getAttributeKey(OtaPackageType.FIRMWARE, OtaPackageKey.VERSION);
     public static final String FIRMWARE_TITLE = getAttributeKey(OtaPackageType.FIRMWARE, OtaPackageKey.TITLE);
+    public static final String FIRMWARE_TAG = getAttributeKey(OtaPackageType.FIRMWARE, OtaPackageKey.TAG);
     public static final String FIRMWARE_URL = getAttributeKey(OtaPackageType.FIRMWARE, OtaPackageKey.URL);
     public static final String SOFTWARE_VERSION = getAttributeKey(OtaPackageType.SOFTWARE, OtaPackageKey.VERSION);
     public static final String SOFTWARE_TITLE = getAttributeKey(OtaPackageType.SOFTWARE, OtaPackageKey.TITLE);
+    public static final String SOFTWARE_TAG = getAttributeKey(OtaPackageType.SOFTWARE, OtaPackageKey.TAG);
     public static final String SOFTWARE_URL = getAttributeKey(OtaPackageType.SOFTWARE, OtaPackageKey.URL);
 
     public static final String FIRMWARE_UPDATE_COAP_RESOURCE = "tbfw";
@@ -165,6 +167,7 @@ public class DefaultLwM2MOtaUpdateService extends LwM2MExecutorAwareService impl
         if (fwInfo.isSupported()) {
             attributesToFetch.add(FIRMWARE_TITLE);
             attributesToFetch.add(FIRMWARE_VERSION);
+            attributesToFetch.add(FIRMWARE_TAG);
             attributesToFetch.add(FIRMWARE_URL);
         }
 
@@ -172,6 +175,7 @@ public class DefaultLwM2MOtaUpdateService extends LwM2MExecutorAwareService impl
         if (swInfo.isSupported()) {
             attributesToFetch.add(SOFTWARE_TITLE);
             attributesToFetch.add(SOFTWARE_VERSION);
+            attributesToFetch.add(SOFTWARE_TAG);
             attributesToFetch.add(SOFTWARE_URL);
         }
         
@@ -186,17 +190,19 @@ public class DefaultLwM2MOtaUpdateService extends LwM2MExecutorAwareService impl
                 if (fwInfo.isSupported()) {
                     Optional<String> newFwTitle = getAttributeValue(attrs, FIRMWARE_TITLE);
                     Optional<String> newFwVersion = getAttributeValue(attrs, FIRMWARE_VERSION);
+                    Optional<String> newFwTag = getAttributeValue(attrs, FIRMWARE_TAG);
                     Optional<String> newFwUrl = getAttributeValue(attrs, FIRMWARE_URL);
                     if (newFwTitle.isPresent() && newFwVersion.isPresent()) {
-                        onTargetFirmwareUpdate(client, newFwTitle.get(), newFwVersion.get(), newFwUrl);
+                        onTargetFirmwareUpdate(client, newFwTitle.get(), newFwVersion.get(), newFwUrl, newFwTag);
                     }
                 }
                 if (swInfo.isSupported()) {
                     Optional<String> newSwTitle = getAttributeValue(attrs, SOFTWARE_TITLE);
                     Optional<String> newSwVersion = getAttributeValue(attrs, SOFTWARE_VERSION);
+                    Optional<String> newSwTag = getAttributeValue(attrs, SOFTWARE_TAG);
                     Optional<String> newSwUrl = getAttributeValue(attrs, SOFTWARE_URL);
                     if (newSwTitle.isPresent() && newSwVersion.isPresent()) {
-                        onTargetSoftwareUpdate(client, newSwTitle.get(), newSwVersion.get(), newSwUrl);
+                        onTargetSoftwareUpdate(client, newSwTitle.get(), newSwVersion.get(), newSwUrl, newSwTag);
                     }
                 }
             }, throwable -> {
@@ -216,9 +222,9 @@ public class DefaultLwM2MOtaUpdateService extends LwM2MExecutorAwareService impl
     }
 
     @Override
-    public void onTargetFirmwareUpdate(LwM2mClient client, String newFirmwareTitle, String newFirmwareVersion, Optional<String> newFirmwareUrl) {
+    public void onTargetFirmwareUpdate(LwM2mClient client, String newFirmwareTitle, String newFirmwareVersion, Optional<String> newFirmwareUrl, Optional<String> newFirmwareTag) {
         LwM2MClientFwOtaInfo fwInfo = getOrInitFwInfo(client);
-        fwInfo.updateTarget(newFirmwareTitle, newFirmwareVersion, newFirmwareUrl);
+        fwInfo.updateTarget(newFirmwareTitle, newFirmwareVersion, newFirmwareUrl, newFirmwareTag);
         update(fwInfo);
         startFirmwareUpdateIfNeeded(client, fwInfo);
     }
@@ -354,9 +360,9 @@ public class DefaultLwM2MOtaUpdateService extends LwM2MExecutorAwareService impl
     }
 
     @Override
-    public void onTargetSoftwareUpdate(LwM2mClient client, String newSoftwareTitle, String newSoftwareVersion, Optional<String> newFirmwareUrl) {
+    public void onTargetSoftwareUpdate(LwM2mClient client, String newSoftwareTitle, String newSoftwareVersion, Optional<String> newSoftwareUrl, Optional<String> newSoftwareTag) {
         LwM2MClientSwOtaInfo fwInfo = getOrInitSwInfo(client);
-        fwInfo.updateTarget(newSoftwareTitle, newSoftwareVersion, newFirmwareUrl);
+        fwInfo.updateTarget(newSoftwareTitle, newSoftwareVersion, newSoftwareUrl, newSoftwareTag);
         update(fwInfo);
         startSoftwareUpdateIfNeeded(client, fwInfo);
     }
@@ -368,7 +374,7 @@ public class DefaultLwM2MOtaUpdateService extends LwM2MExecutorAwareService impl
                 sendStateUpdateToTelemetry(client, fwInfo, OtaPackageUpdateStatus.FAILED, "Client does not support firmware update or profile misconfiguration!");
             } else if (fwInfo.isUpdateRequired()) {
                 if (StringUtils.isNotEmpty(fwInfo.getTargetUrl())) {
-                    log.debug("[{}] Starting update to [{}{}] using URL: {}", client.getEndpoint(), fwInfo.getTargetName(), fwInfo.getTargetVersion(), fwInfo.getTargetUrl());
+                    log.debug("[{}] Starting update to [{}{}][] using URL: {}", client.getEndpoint(), fwInfo.getTargetName(), fwInfo.getTargetVersion(), fwInfo.getTargetUrl());
                     startUpdateUsingUrl(client, FW_URL_ID, fwInfo.getTargetUrl());
                 } else {
                     log.debug("[{}] Starting update to [{}{}] using binary", client.getEndpoint(), fwInfo.getTargetName(), fwInfo.getTargetVersion());

common/transport/lwm2m/src/main/java/org/thingsboard/server/transport/lwm2m/server/ota/LwM2MClientOtaInfo.java

@@ -32,6 +32,7 @@ public abstract class LwM2MClientOtaInfo<Strategy, State, Result> {
 
     protected String targetName;
     protected String targetVersion;
+    protected String targetTag;
     protected String targetUrl;
 
     //TODO: use value from device if applicable;
@@ -52,10 +53,11 @@ public abstract class LwM2MClientOtaInfo<Strategy, State, Result> {
         this.strategy = strategy;
     }
 
-    public void updateTarget(String targetName, String targetVersion, Optional<String> newTargetUrl) {
+    public void updateTarget(String targetName, String targetVersion, Optional<String> newTargetUrl, Optional<String> newTargetTag) {
         this.targetName = targetName;
         this.targetVersion = targetVersion;
         this.targetUrl = newTargetUrl.orElse(null);
+        this.targetTag = newTargetTag.orElse(null);
     }
 
     @JsonIgnore
@@ -64,13 +66,18 @@ public abstract class LwM2MClientOtaInfo<Strategy, State, Result> {
             return false;
         } else {
             String targetPackageId = getPackageId(targetName, targetVersion);
-            String currentPackageIdUsingObject5 = getPackageId(currentName, currentVersion);
+            String currentPackageId = getPackageId(currentName, currentVersion);
             if (StringUtils.isNotEmpty(failedPackageId) && failedPackageId.equals(targetPackageId)) {
                 return false;
             } else {
-                if (targetPackageId.equals(currentPackageIdUsingObject5)) {
+                if (targetPackageId.equals(currentPackageId)) {
+                    return false;
+                } else if (StringUtils.isNotEmpty(targetTag) && targetTag.equals(currentPackageId)) {
                     return false;
                 } else if (StringUtils.isNotEmpty(currentVersion3)) {
+                    if (StringUtils.isNotEmpty(targetTag) && currentVersion3.contains(targetTag)) {
+                        return false;
+                    }
                     return !currentVersion3.contains(targetPackageId);
                 } else {
                     return true;

common/transport/lwm2m/src/main/java/org/thingsboard/server/transport/lwm2m/server/ota/LwM2MOtaUpdateService.java

@@ -26,9 +26,9 @@ public interface LwM2MOtaUpdateService {
 
     void forceFirmwareUpdate(LwM2mClient client);
 
-    void onTargetFirmwareUpdate(LwM2mClient client, String newFwTitle, String newFwVersion, Optional<String> newFwUrl);
+    void onTargetFirmwareUpdate(LwM2mClient client, String newFwTitle, String newFwVersion, Optional<String> newFwUrl, Optional<String> newFwTag);
 
-    void onTargetSoftwareUpdate(LwM2mClient client, String newSwTitle, String newSwVersion, Optional<String> newSwUrl);
+    void onTargetSoftwareUpdate(LwM2mClient client, String newSwTitle, String newSwVersion, Optional<String> newSwUrl, Optional<String> newSwTag);
 
     void onCurrentFirmwareNameUpdate(LwM2mClient client, String name);
 

dao/src/main/java/org/thingsboard/server/dao/model/ModelConstants.java

@@ -499,6 +499,7 @@ public class ModelConstants {
     public static final String OTA_PACKAGE_TYPE_COLUMN = "type";
     public static final String OTA_PACKAGE_TILE_COLUMN = TITLE_PROPERTY;
     public static final String OTA_PACKAGE_VERSION_COLUMN = "version";
+    public static final String OTA_PACKAGE_TAG_COLUMN = "tag";
     public static final String OTA_PACKAGE_URL_COLUMN = "url";
     public static final String OTA_PACKAGE_FILE_NAME_COLUMN = "file_name";
     public static final String OTA_PACKAGE_CONTENT_TYPE_COLUMN = "content_type";

dao/src/main/java/org/thingsboard/server/dao/model/sql/OtaPackageEntity.java

@@ -48,6 +48,7 @@ import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_DATA_S
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_DEVICE_PROFILE_ID_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_FILE_NAME_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TABLE_NAME;
+import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TAG_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TENANT_ID_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TILE_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TYPE_COLUMN;
@@ -78,6 +79,9 @@ public class OtaPackageEntity extends BaseSqlEntity<OtaPackage> implements Searc
     @Column(name = OTA_PACKAGE_VERSION_COLUMN)
     private String version;
 
+    @Column(name = OTA_PACKAGE_TAG_COLUMN)
+    private String tag;
+
     @Column(name = OTA_PACKAGE_URL_COLUMN)
     private String url;
 
@@ -112,24 +116,25 @@ public class OtaPackageEntity extends BaseSqlEntity<OtaPackage> implements Searc
         super();
     }
 
-    public OtaPackageEntity(OtaPackage firmware) {
-        this.createdTime = firmware.getCreatedTime();
-        this.setUuid(firmware.getUuidId());
-        this.tenantId = firmware.getTenantId().getId();
-        if (firmware.getDeviceProfileId() != null) {
-            this.deviceProfileId = firmware.getDeviceProfileId().getId();
+    public OtaPackageEntity(OtaPackage otaPackage) {
+        this.createdTime = otaPackage.getCreatedTime();
+        this.setUuid(otaPackage.getUuidId());
+        this.tenantId = otaPackage.getTenantId().getId();
+        if (otaPackage.getDeviceProfileId() != null) {
+            this.deviceProfileId = otaPackage.getDeviceProfileId().getId();
         }
-        this.type = firmware.getType();
-        this.title = firmware.getTitle();
-        this.version = firmware.getVersion();
-        this.url = firmware.getUrl();
-        this.fileName = firmware.getFileName();
-        this.contentType = firmware.getContentType();
-        this.checksumAlgorithm = firmware.getChecksumAlgorithm();
-        this.checksum = firmware.getChecksum();
-        this.data = firmware.getData().array();
-        this.dataSize = firmware.getDataSize();
-        this.additionalInfo = firmware.getAdditionalInfo();
+        this.type = otaPackage.getType();
+        this.title = otaPackage.getTitle();
+        this.version = otaPackage.getVersion();
+        this.tag = otaPackage.getTag();
+        this.url = otaPackage.getUrl();
+        this.fileName = otaPackage.getFileName();
+        this.contentType = otaPackage.getContentType();
+        this.checksumAlgorithm = otaPackage.getChecksumAlgorithm();
+        this.checksum = otaPackage.getChecksum();
+        this.data = otaPackage.getData().array();
+        this.dataSize = otaPackage.getDataSize();
+        this.additionalInfo = otaPackage.getAdditionalInfo();
     }
 
     @Override
@@ -144,26 +149,27 @@ public class OtaPackageEntity extends BaseSqlEntity<OtaPackage> implements Searc
 
     @Override
     public OtaPackage toData() {
-        OtaPackage firmware = new OtaPackage(new OtaPackageId(id));
-        firmware.setCreatedTime(createdTime);
-        firmware.setTenantId(new TenantId(tenantId));
+        OtaPackage otaPackage = new OtaPackage(new OtaPackageId(id));
+        otaPackage.setCreatedTime(createdTime);
+        otaPackage.setTenantId(new TenantId(tenantId));
         if (deviceProfileId != null) {
-            firmware.setDeviceProfileId(new DeviceProfileId(deviceProfileId));
+            otaPackage.setDeviceProfileId(new DeviceProfileId(deviceProfileId));
         }
-        firmware.setType(type);
-        firmware.setTitle(title);
-        firmware.setVersion(version);
-        firmware.setUrl(url);
-        firmware.setFileName(fileName);
-        firmware.setContentType(contentType);
-        firmware.setChecksumAlgorithm(checksumAlgorithm);
-        firmware.setChecksum(checksum);
-        firmware.setDataSize(dataSize);
+        otaPackage.setType(type);
+        otaPackage.setTitle(title);
+        otaPackage.setVersion(version);
+        otaPackage.setTag(tag);
+        otaPackage.setUrl(url);
+        otaPackage.setFileName(fileName);
+        otaPackage.setContentType(contentType);
+        otaPackage.setChecksumAlgorithm(checksumAlgorithm);
+        otaPackage.setChecksum(checksum);
+        otaPackage.setDataSize(dataSize);
         if (data != null) {
-            firmware.setData(ByteBuffer.wrap(data));
-            firmware.setHasData(true);
+            otaPackage.setData(ByteBuffer.wrap(data));
+            otaPackage.setHasData(true);
         }
-        firmware.setAdditionalInfo(additionalInfo);
-        return firmware;
+        otaPackage.setAdditionalInfo(additionalInfo);
+        return otaPackage;
     }
 }

dao/src/main/java/org/thingsboard/server/dao/model/sql/OtaPackageInfoEntity.java

@@ -48,6 +48,7 @@ import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_DATA_S
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_DEVICE_PROFILE_ID_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_FILE_NAME_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TABLE_NAME;
+import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TAG_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TENANT_ID_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TILE_COLUMN;
 import static org.thingsboard.server.dao.model.ModelConstants.OTA_PACKAGE_TYPE_COLUMN;
@@ -78,6 +79,9 @@ public class OtaPackageInfoEntity extends BaseSqlEntity<OtaPackageInfo> implemen
     @Column(name = OTA_PACKAGE_VERSION_COLUMN)
     private String version;
 
+    @Column(name = OTA_PACKAGE_TAG_COLUMN)
+    private String tag;
+
     @Column(name = OTA_PACKAGE_URL_COLUMN)
     private String url;
 
@@ -111,26 +115,27 @@ public class OtaPackageInfoEntity extends BaseSqlEntity<OtaPackageInfo> implemen
         super();
     }
 
-    public OtaPackageInfoEntity(OtaPackageInfo firmware) {
-        this.createdTime = firmware.getCreatedTime();
-        this.setUuid(firmware.getUuidId());
-        this.tenantId = firmware.getTenantId().getId();
-        this.type = firmware.getType();
-        if (firmware.getDeviceProfileId() != null) {
-            this.deviceProfileId = firmware.getDeviceProfileId().getId();
+    public OtaPackageInfoEntity(OtaPackageInfo otaPackageInfo) {
+        this.createdTime = otaPackageInfo.getCreatedTime();
+        this.setUuid(otaPackageInfo.getUuidId());
+        this.tenantId = otaPackageInfo.getTenantId().getId();
+        this.type = otaPackageInfo.getType();
+        if (otaPackageInfo.getDeviceProfileId() != null) {
+            this.deviceProfileId = otaPackageInfo.getDeviceProfileId().getId();
         }
-        this.title = firmware.getTitle();
-        this.version = firmware.getVersion();
-        this.url = firmware.getUrl();
-        this.fileName = firmware.getFileName();
-        this.contentType = firmware.getContentType();
-        this.checksumAlgorithm = firmware.getChecksumAlgorithm();
-        this.checksum = firmware.getChecksum();
-        this.dataSize = firmware.getDataSize();
-        this.additionalInfo = firmware.getAdditionalInfo();
+        this.title = otaPackageInfo.getTitle();
+        this.version = otaPackageInfo.getVersion();
+        this.tag = otaPackageInfo.getTag();
+        this.url = otaPackageInfo.getUrl();
+        this.fileName = otaPackageInfo.getFileName();
+        this.contentType = otaPackageInfo.getContentType();
+        this.checksumAlgorithm = otaPackageInfo.getChecksumAlgorithm();
+        this.checksum = otaPackageInfo.getChecksum();
+        this.dataSize = otaPackageInfo.getDataSize();
+        this.additionalInfo = otaPackageInfo.getAdditionalInfo();
     }
 
-    public OtaPackageInfoEntity(UUID id, long createdTime, UUID tenantId, UUID deviceProfileId, OtaPackageType type, String title, String version,
+    public OtaPackageInfoEntity(UUID id, long createdTime, UUID tenantId, UUID deviceProfileId, OtaPackageType type, String title, String version, String tag,
                                 String url, String fileName, String contentType, ChecksumAlgorithm checksumAlgorithm, String checksum, Long dataSize,
                                 Object additionalInfo, boolean hasData) {
         this.id = id;
@@ -140,6 +145,7 @@ public class OtaPackageInfoEntity extends BaseSqlEntity<OtaPackageInfo> implemen
         this.type = type;
         this.title = title;
         this.version = version;
+        this.tag = tag;
         this.url = url;
         this.fileName = fileName;
         this.contentType = contentType;
@@ -162,23 +168,24 @@ public class OtaPackageInfoEntity extends BaseSqlEntity<OtaPackageInfo> implemen
 
     @Override
     public OtaPackageInfo toData() {
-        OtaPackageInfo firmware = new OtaPackageInfo(new OtaPackageId(id));
-        firmware.setCreatedTime(createdTime);
-        firmware.setTenantId(new TenantId(tenantId));
+        OtaPackageInfo otaPackageInfo = new OtaPackageInfo(new OtaPackageId(id));
+        otaPackageInfo.setCreatedTime(createdTime);
+        otaPackageInfo.setTenantId(new TenantId(tenantId));
         if (deviceProfileId != null) {
-            firmware.setDeviceProfileId(new DeviceProfileId(deviceProfileId));
+            otaPackageInfo.setDeviceProfileId(new DeviceProfileId(deviceProfileId));
         }
-        firmware.setType(type);
-        firmware.setTitle(title);
-        firmware.setVersion(version);
-        firmware.setUrl(url);
-        firmware.setFileName(fileName);
-        firmware.setContentType(contentType);
-        firmware.setChecksumAlgorithm(checksumAlgorithm);
-        firmware.setChecksum(checksum);
-        firmware.setDataSize(dataSize);
-        firmware.setAdditionalInfo(additionalInfo);
-        firmware.setHasData(hasData);
-        return firmware;
+        otaPackageInfo.setType(type);
+        otaPackageInfo.setTitle(title);
+        otaPackageInfo.setVersion(version);
+        otaPackageInfo.setTag(tag);
+        otaPackageInfo.setUrl(url);
+        otaPackageInfo.setFileName(fileName);
+        otaPackageInfo.setContentType(contentType);
+        otaPackageInfo.setChecksumAlgorithm(checksumAlgorithm);
+        otaPackageInfo.setChecksum(checksum);
+        otaPackageInfo.setDataSize(dataSize);
+        otaPackageInfo.setAdditionalInfo(additionalInfo);
+        otaPackageInfo.setHasData(hasData);
+        return otaPackageInfo;
     }
 }

dao/src/main/java/org/thingsboard/server/dao/ota/BaseOtaPackageService.java

@@ -51,6 +51,7 @@ import org.thingsboard.server.dao.tenant.TenantDao;
 import java.nio.ByteBuffer;
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 
 import static org.thingsboard.server.common.data.CacheConstants.OTA_PACKAGE_CACHE;
@@ -318,6 +319,10 @@ public class BaseOtaPackageService implements OtaPackageService {
             throw new DataValidationException("Updating otaPackage version is prohibited!");
         }
 
+        if (!Objects.equals(otaPackage.getTag(), otaPackageOld.getTag())) {
+            throw new DataValidationException("Updating otaPackage tag is prohibited!");
+        }
+
         if (!otaPackageOld.getDeviceProfileId().equals(otaPackage.getDeviceProfileId())) {
             throw new DataValidationException("Updating otaPackage deviceProfile is prohibited!");
         }

dao/src/main/java/org/thingsboard/server/dao/sql/ota/OtaPackageInfoRepository.java

@@ -26,14 +26,14 @@ import org.thingsboard.server.dao.model.sql.OtaPackageInfoEntity;
 import java.util.UUID;
 
 public interface OtaPackageInfoRepository extends CrudRepository<OtaPackageInfoEntity, UUID> {
-    @Query("SELECT new OtaPackageInfoEntity(f.id, f.createdTime, f.tenantId, f.deviceProfileId, f.type, f.title, f.version, f.url, f.fileName, f.contentType, f.checksumAlgorithm, f.checksum, f.dataSize, f.additionalInfo, CASE WHEN (f.data IS NOT NULL OR f.url IS NOT NULL)  THEN true ELSE false END) FROM OtaPackageEntity f WHERE " +
+    @Query("SELECT new OtaPackageInfoEntity(f.id, f.createdTime, f.tenantId, f.deviceProfileId, f.type, f.title, f.version, f.tag, f.url, f.fileName, f.contentType, f.checksumAlgorithm, f.checksum, f.dataSize, f.additionalInfo, CASE WHEN (f.data IS NOT NULL OR f.url IS NOT NULL)  THEN true ELSE false END) FROM OtaPackageEntity f WHERE " +
             "f.tenantId = :tenantId " +
             "AND LOWER(f.searchText) LIKE LOWER(CONCAT(:searchText, '%'))")
     Page<OtaPackageInfoEntity> findAllByTenantId(@Param("tenantId") UUID tenantId,
                                                  @Param("searchText") String searchText,
                                                  Pageable pageable);
 
-    @Query("SELECT new OtaPackageInfoEntity(f.id, f.createdTime, f.tenantId, f.deviceProfileId, f.type, f.title, f.version, f.url, f.fileName, f.contentType, f.checksumAlgorithm, f.checksum, f.dataSize, f.additionalInfo, true) FROM OtaPackageEntity f WHERE " +
+    @Query("SELECT new OtaPackageInfoEntity(f.id, f.createdTime, f.tenantId, f.deviceProfileId, f.type, f.title, f.version, f.tag, f.url, f.fileName, f.contentType, f.checksumAlgorithm, f.checksum, f.dataSize, f.additionalInfo, true) FROM OtaPackageEntity f WHERE " +
             "f.tenantId = :tenantId " +
             "AND f.deviceProfileId = :deviceProfileId " +
             "AND f.type = :type " +
@@ -45,7 +45,7 @@ public interface OtaPackageInfoRepository extends CrudRepository<OtaPackageInfoE
                                                                                     @Param("searchText") String searchText,
                                                                                     Pageable pageable);
 
-    @Query("SELECT new OtaPackageInfoEntity(f.id, f.createdTime, f.tenantId, f.deviceProfileId, f.type, f.title, f.version, f.url, f.fileName, f.contentType, f.checksumAlgorithm, f.checksum, f.dataSize, f.additionalInfo, CASE WHEN (f.data IS NOT NULL OR f.url IS NOT NULL)  THEN true ELSE false END) FROM OtaPackageEntity f WHERE f.id = :id")
+    @Query("SELECT new OtaPackageInfoEntity(f.id, f.createdTime, f.tenantId, f.deviceProfileId, f.type, f.title, f.version, f.tag, f.url, f.fileName, f.contentType, f.checksumAlgorithm, f.checksum, f.dataSize, f.additionalInfo, CASE WHEN (f.data IS NOT NULL OR f.url IS NOT NULL)  THEN true ELSE false END) FROM OtaPackageEntity f WHERE f.id = :id")
     OtaPackageInfoEntity findOtaPackageInfoById(@Param("id") UUID id);
 
     @Query(value = "SELECT exists(SELECT * " +

dao/src/main/resources/sql/schema-entities-hsql.sql

@@ -173,6 +173,7 @@ CREATE TABLE IF NOT EXISTS ota_package (
     type varchar(32) NOT NULL,
     title varchar(255) NOT NULL,
     version varchar(255) NOT NULL,
+    tag varchar(255),
     url varchar(255),
     file_name varchar(255),
     content_type varchar(255),

dao/src/main/resources/sql/schema-entities.sql

@@ -188,6 +188,7 @@ CREATE TABLE IF NOT EXISTS ota_package (
     type varchar(32) NOT NULL,
     title varchar(255) NOT NULL,
     version varchar(255) NOT NULL,
+    tag varchar(255),
     url varchar(255),
     file_name varchar(255),
     content_type varchar(255),

ui-ngx/src/app/modules/home/pages/ota-update/ota-update-table-config.resolve.ts

@@ -59,9 +59,10 @@ export class OtaUpdateTableConfigResolve implements Resolve<EntityTableConfig<Ot
 
     this.config.columns.push(
       new DateEntityTableColumn<OtaPackageInfo>('createdTime', 'common.created-time', this.datePipe, '150px'),
-      new EntityTableColumn<OtaPackageInfo>('title', 'ota-update.title', '20%'),
-      new EntityTableColumn<OtaPackageInfo>('version', 'ota-update.version', '20%'),
-      new EntityTableColumn<OtaPackageInfo>('type', 'ota-update.package-type', '20%', entity => {
+      new EntityTableColumn<OtaPackageInfo>('title', 'ota-update.title', '15%'),
+      new EntityTableColumn<OtaPackageInfo>('version', 'ota-update.version', '15%'),
+      new EntityTableColumn<OtaPackageInfo>('tag', 'ota-update.version-tag', '15%'),
+      new EntityTableColumn<OtaPackageInfo>('type', 'ota-update.package-type', '15%', entity => {
         return this.translate.instant(OtaUpdateTypeTranslationMap.get(entity.type));
       }),
       new EntityTableColumn<OtaPackageInfo>('url', 'ota-update.direct-url', '20%', entity => {

ui-ngx/src/app/modules/home/pages/ota-update/ota-update.component.html

@@ -74,6 +74,11 @@
           </mat-error>
         </mat-form-field>
       </div>
+      <mat-form-field class="mat-block" fxFlex style="margin-bottom: 8px">
+        <mat-label translate>ota-update.version-tag</mat-label>
+        <input matInput formControlName="tag" type="text" [readonly]="!isAdd">
+        <mat-hint *ngIf="isAdd" translate>ota-update.version-tag-hint</mat-hint>
+      </mat-form-field>
       <tb-device-profile-autocomplete
         formControlName="deviceProfileId"
         required
@@ -94,8 +99,8 @@
       <section *ngIf="isAdd">
         <div class="mat-caption" style="margin: -8px 0 8px;" translate>ota-update.warning-after-save-no-edit</div>
         <mat-radio-group formControlName="isURL" fxLayoutGap="16px">
-          <mat-radio-button [value]="false">Upload binary file</mat-radio-button>
-          <mat-radio-button [value]="true">Use external URL</mat-radio-button>
+          <mat-radio-button [value]="false">{{ "ota-update.upload-binary-file" | translate }}</mat-radio-button>
+          <mat-radio-button [value]="true">{{ "ota-update.use-external-url" | translate }}</mat-radio-button>
         </mat-radio-group>
       </section>
       <section *ngIf="!entityForm.get('isURL').value">

ui-ngx/src/app/modules/home/pages/ota-update/ota-update.component.ts

@@ -15,7 +15,7 @@
 ///
 
 import { Component, Inject, OnDestroy, OnInit } from '@angular/core';
-import { Subject } from 'rxjs';
+import { combineLatest, Subject } from 'rxjs';
 import { Store } from '@ngrx/store';
 import { AppState } from '@core/core.state';
 import { TranslateService } from '@ngx-translate/core';
@@ -30,7 +30,7 @@ import {
   OtaUpdateTypeTranslationMap
 } from '@shared/models/ota-package.models';
 import { ActionNotificationShow } from '@core/notification/notification.actions';
-import { filter, takeUntil } from 'rxjs/operators';
+import { filter, startWith, takeUntil } from 'rxjs/operators';
 import { isNotEmptyStr } from '@core/utils';
 
 @Component({
@@ -56,22 +56,33 @@ export class OtaUpdateComponent extends EntityComponent<OtaPackage> implements O
 
   ngOnInit() {
     super.ngOnInit();
-    this.entityForm.get('isURL').valueChanges.pipe(
-      filter(() => this.isAdd),
-      takeUntil(this.destroy$)
-    ).subscribe((isURL) => {
-      if (isURL === false) {
-        this.entityForm.get('url').clearValidators();
-        this.entityForm.get('file').setValidators(Validators.required);
-        this.entityForm.get('url').updateValueAndValidity({emitEvent: false});
-        this.entityForm.get('file').updateValueAndValidity({emitEvent: false});
-      } else {
-        this.entityForm.get('file').clearValidators();
-        this.entityForm.get('url').setValidators([Validators.required, Validators.pattern('(.|\\s)*\\S(.|\\s)*')]);
-        this.entityForm.get('file').updateValueAndValidity({emitEvent: false});
-        this.entityForm.get('url').updateValueAndValidity({emitEvent: false});
-      }
-    });
+    if (this.isAdd) {
+      this.entityForm.get('isURL').valueChanges.pipe(
+        takeUntil(this.destroy$)
+      ).subscribe((isURL) => {
+        if (isURL === false) {
+          this.entityForm.get('url').clearValidators();
+          this.entityForm.get('file').setValidators(Validators.required);
+          this.entityForm.get('url').updateValueAndValidity({emitEvent: false});
+          this.entityForm.get('file').updateValueAndValidity({emitEvent: false});
+        } else {
+          this.entityForm.get('file').clearValidators();
+          this.entityForm.get('url').setValidators([Validators.required, Validators.pattern('(.|\\s)*\\S(.|\\s)*')]);
+          this.entityForm.get('file').updateValueAndValidity({emitEvent: false});
+          this.entityForm.get('url').updateValueAndValidity({emitEvent: false});
+        }
+      });
+      combineLatest([
+        this.entityForm.get('title').valueChanges.pipe(startWith('')),
+        this.entityForm.get('version').valueChanges.pipe(startWith(''))
+      ]).pipe(
+        filter(() => this.entityForm.get('tag').pristine),
+        takeUntil(this.destroy$)
+      ).subscribe(([title, version]) => {
+        const tag = (`${title} ${version}`).trim();
+        this.entityForm.get('tag').patchValue(tag);
+      });
+    }
   }
 
   ngOnDestroy() {
@@ -92,6 +103,7 @@ export class OtaUpdateComponent extends EntityComponent<OtaPackage> implements O
     const form = this.fb.group({
       title: [entity ? entity.title : '', [Validators.required, Validators.maxLength(255)]],
       version: [entity ? entity.version : '', [Validators.required, Validators.maxLength(255)]],
+      tag: [entity ? entity.tag : '', [Validators.maxLength(255)]],
       type: [entity?.type ? entity.type : OtaUpdateType.FIRMWARE, Validators.required],
       deviceProfileId: [entity ? entity.deviceProfileId : null, Validators.required],
       checksumAlgorithm: [entity && entity.checksumAlgorithm ? entity.checksumAlgorithm : ChecksumAlgorithm.SHA256],
@@ -119,6 +131,7 @@ export class OtaUpdateComponent extends EntityComponent<OtaPackage> implements O
     this.entityForm.patchValue({
       title: entity.title,
       version: entity.version,
+      tag: entity.tag,
       type: entity.type,
       deviceProfileId: entity.deviceProfileId,
       checksumAlgorithm: entity.checksumAlgorithm,

ui-ngx/src/app/shared/models/ota-package.models.ts

@@ -91,6 +91,7 @@ export interface OtaPackageInfo extends BaseData<OtaPackageId> {
   deviceProfileId?: DeviceProfileId;
   title?: string;
   version?: string;
+  tag?: string;
   hasData?: boolean;
   url?: string;
   fileName: string;

ui-ngx/src/assets/locale/locale.constant-en_US.json

@@ -2341,8 +2341,12 @@
         "firmware": "Firmware",
         "software": "Software"
       },
+      "upload-binary-file": "Upload binary file",
+      "use-external-url": "Use external URL",
       "version": "Version",
       "version-required": "Version is required.",
+      "version-tag": "Version Tag",
+      "version-tag-hint": "Custom tag should match the package version reported by your device.",
       "warning-after-save-no-edit": "Once the package is uploaded, you will not be able to modify title, version, device profile and package type."
     },
     "position": {