Get Firmware File¶

Get the file of the specified firmware.

Operation Permissions¶

Required Authorization	Required Operation Permission
Device Management	Read

Request Format¶

GET https://{apigw-address}/connect-service/v2.1/ota-firmwares?action=get

Request Parameters (URI)¶

Name	Location（Path/Query）	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get orgId>>
firmwareId	Query	Mandatory	String	The firmware ID.

Response Parameters¶

Name	Data Type	Description
data	FirmwareInfo Struct	The returned results of the firmware information. For details, see FirmwareInfo Struct>>

FirmwareInfo Struct ¶

Name	Data Type	Description
orgId	String	The organization ID.
firmwareId	String	The firmware ID.
productKey	String	The product key.
name	StringI18n	The firmware name.
version	String	The firmware version.
desc	String	The firmware description.
signMethod	String	The signature algorithm for the firmware file.
sign	String	The fimware file signature.
fileUrl	String	The firmware file identifier.
fileSize	String	The size of the firmware file.
enableVerification	Boolean	`true`: Needs to be verified. `false`: Does not need to be verified.
isVerified	Boolean	`true`: The firmware is verified. `false`: The firmware is not verified.
createTime	Long	The time when the firmware is created.

Error Codes¶

Code	Message	Description
24404	Firmware not found	The firmware cannot be found.

Samples¶

Request Sample¶

url: https://{apigw-address}/connect-service/v2.1/ota-firmwares?action=get&orgId=yourOrgId&firmwareId=yourFirmwareId
method: GET

Return Sample¶

{
    "code":0,
    "msg":"OK",
    "requestId":"28da9093-400f-4eb1-8cdc-83e4ec77070d",
    "data":{
        "orgId":"yourOrgId",
        "firmwareId":"yourFirmwareId",
        "productKey":"BXwU4kMk",
        "name":{
            "defaultValue":"HC_TEST",
            "i18nValue":{

            }
        },
        "version":"2.0",
        "desc":null,
        "signMethod":"md5",
        "sign":"12c696fa5c075e8687458fd6ce164b57",
        "fileUrl":"enos-connect://2325a9b338800000.zip",
        "fileSize":1767,
        "isVerified":false,
        "enableVerification":false,
        "createTime":1590746442378
    }
}

Java SDK Sample¶

package com.envisioniot.enos.connect_service.ota.firmware;


import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;
import com.envisioniot.enos.connect_service.v2_1.ota.firmware.GetFirmwareFileRequest;
import com.envisioniot.enos.connect_service.v2_1.ota.firmware.GetFirmwareFileResponse;

public class GetFirmware {
    public static void main(String[] args) {
        final String appKey = "yourAppKey";
        final String appSecret = "yourAppSecret";
        String serverUrl = "yourServerUrl";

        String orgId = "yourOrgId";
        String firmwareId = "yourFirmwareId";

        GetFirmwareFileRequest request = new GetFirmwareFileRequest();
        request.setOrgId(orgId);
        request.setFirmwareId(firmwareId);

        GetFirmwareFileResponse response = Poseidon
                .config(PConfig.init().appKey(appKey).appSecret(appSecret).debug())
                .url(serverUrl)
                .getResponse(request, GetFirmwareFileResponse.class);
    }
}