:OTAアップデート

OTAモジュールのバージョンをIoT Platformに送信する

次のトピックは、デバイスがIoT Platformにデータを送信するときに使用されます。

トピック: /ota/device/inform/${productKey}/${deviceName}

デバイスは、OTAモジュールのバージョンをこのトピックに送信します。

リクエストの例

{
    "id": "123",
    "params": {
        "version": "1.0.1" 、
        "モジュール": "MCU"
    }
}

OTAアップデートパッケージに関する情報をデバイスにプッシュする

次のトピックは、IoT Platformがデバイスにデータを送信するときに使用されます。

トピック: /ota/device/upgrade/${productKey}/${deviceName}

IoT Platformは、OTA更新パッケージに関する情報を上記のトピックに送信します。 デバイスは、情報を取得するためにトピックをサブスクライブすることができる。

• 単一のファイルを含むOTAアップデートパッケージに関するサンプル情報:
  • HTTPS経由でOTAアップデートパッケージをダウンロードします:

    {
        "code": "1000",
        "data": {
            "size": 432945,
            "version": "2.0.0",
            "isDiff": 1、
            "url": "https:// ***/nop *** .tar.gz?Expires=1502955804&OSSAccessKeyId=***&Signature=XfgJu7P6DW *** qAKU % 3D&security-token=*** Tz2IHtIf3 ***" 、
            "md5": "93230c3bde425a9d ***" 、
            "digestsign":"A4WOP *** SYHJ6DDDJD9 ***" 、
            "sign": "93230c3bde425a9d ***" 、
            "signMethod": "MD5" 、
            "モジュール": "MCU" 、
            "extData":{
                "key1":"value1" 、
                "key2":"value2" 、
                "_package_udi":"{\" ota_notice\":\" カメラドライバーを更新して、ビデオがぼやけないようにします。 \"}"
            }
        },
        "id": 1626969597470、
        "メッセージ": "成功"
    } 

  • MQTT経由でOTAアップデートパッケージをダウンロードします:

    {
        "code":"1000" 、
        "data":{
            "サイズ":432945、
            "version":"2.0.0" 、
            "isDiff":1、
            "signMethod":"MD5" 、
            "dProtocol":"mqtt" 、
            "streamId":1397345、
            "streamFileId":1、
            "md5":"93230c3bde425 ***" 、
            "digestsign":"A4WOP *** SYHJ6DDDJD9 ***" 、
            "sign":"93230c3bde425 ***" 、
            "モジュール":"MCU" 、
            "extData":{
                "key1":"value1" 、
                "key2":"value2"
            }
        },
        "id":1507707025、
        "メッセージ":"成功"
    } 

• 複数のファイルを含むOTA更新パッケージは、HTTP経由でのみダウンロードできます。 サンプル情報:

  {
      "code": "1000",
      "data": {
          "version": "2.0.0",
          "isDiff": 1、
          "signMethod": "MD5" 、
          "files":[
              {
                  "fileSize":432944、
                  "fileName":"file1-name" 、
                  "fileUrl":"https:// ***/nop *** .tar.gz?Expires=1502955804&OSSAccessKeyId=***&Signature=*** XJEH0qAKU % 3D&security-token=CAISuQJ ***" 、
                  "fileMd5":"93230c3bde425a9d ***" 、
                  "fileSign":"93230c3bde425a9d ****"
              },
              {
                  "fileSize":432945、
                  "fileName":"file2-name" 、
                  "fileUrl":"https:// ***/no *** .tar.gz?Expires=1502955804&OSSAccessKeyId=***&Signature=*** qAKU % 3D&security-token=*** q6Ft5B2y ***" 、
                  "fileMd5":"93230c3bde425a92 ***" 、
                  "fileSign":"93230c3bde425a92 ****"
              }
          ],
          "モジュール": "MCU" 、
          "extData":{
              "key1":"value1" 、
              "key2":"value2" 、
              "_package_udi":"{\" ota_notice\":\" カメラドライバーを更新して、ビデオがぼやけないようにします。 \"}"
          }
      },
      "id": 1626969597470、
      "メッセージ": "成功"
  } 

更新の進行状況をIoT Platformに送信する

次のトピックは、デバイスがIoT Platformにデータを送信するときに使用されます。

トピック: /ota/device/progress/${productKey}/${deviceName}

OTA更新中に、デバイスは前のトピックに対するパーセンテージとして更新の進行状況を送信します。

リクエストの例

{
    "id": "123",
    "params": {
        "step": "-1",
        "desc": "アップデートパッケージ情報が見つからないため、OTAアップデートに失敗しました。"
        "モジュール": "MCU"
    }
}

OTA更新パッケージに関する情報を要求する

次のトピックは、デバイスがIoT Platformにデータを送信するときに使用されます。

リクエストトピック: /sys/${productKey}/${deviceName}/thing/ota/firmware/get

レスポンストピック: /sys/${productKey}/${deviceName}/thing/ota/firmware/get_reply

リクエストの例

{
    "id": "123",
    "version"： "1.0"、
    "params": {
        "モジュール": "MCU"
    },
    "method": "thing.ota.firmware.get"
} 

IoT Platformがデバイスからリクエストを受信すると、IoT Platformはレスポンスを送信します。

• IoT Platformは、最新の更新パッケージに関する情報をデバイスに送信します。 レスポンス例：
  • 単一のファイルを含むOTAアップデートパッケージに関するサンプル情報:
    • HTTPS経由でOTAアップデートパッケージをダウンロードします:

      {
          "id": "123",
          "code": 200,
          "data": {
              "サイズ": 93796291、
              "sign": "f8d85b250d4d787a9f483d89a974 ***" 、
              "version": "10.0.1.9.20171112.1432" 、
              "isDiff": 1、
              "url": "https:// the_firmware_url" 、
              "signMethod": "MD5" 、
              "md5": "f8d85b250d4d787a9f48 ***" 、
              "モジュール": "MCU" 、
              "extData":{
                  "key1":"value1" 、
                  "key2":"value2" 、
                  "_package_udi":"{\" ota_notice\":\" カメラドライバーを更新して、ビデオがぼやけないようにします。 \"}"
              }
          }
      }

    • MQTT経由でOTAアップデートパッケージをダウンロードします:

      {
          "id": "123",
          "code": 200,
          "data":{
              "サイズ":432945、
              "digestsign":"A4WOP *** SYHJ6DDDJD9 ***" 、
              "version":"2.0.0" 、
              "isDiff":1、
              "signMethod":"MD5" 、
              "dProtocol":"mqtt" 、
              "streamId":1397345、
              "streamFileId":1、
              "md5":"93230c3bde ***" 、
              "sign":"93230c3bde42 ***" 、
              "モジュール":"MCU" 、
              "extData":{
                  "key1":"value1" 、
                  "key2":"value2"
              }
          }
      }

  • 複数のファイルを含むOTA更新パッケージは、HTTP経由でのみダウンロードできます。 サンプル情報:

    {
        "id": "123",
        "code": 200,
        "data": {
            "version": "2.0.0",
            "isDiff": 1、
            "signMethod": "MD5" 、
            "files":[
                {
                    "fileSize":432944、
                    "fileName":"file1-name" 、
                    "fileUrl":"https:// iotx *** .aliyuncs.com/nop***.tar.gz?Expires=1502955804&OSSAccessKeyId=***&Signature=XfgJu7***U%3D&security-token=CAISu***" 、
                    "fileMd5":"93230c3bde425a9d7984a594ac55ea1e" 、
                    "fileSign":"93230c3bde425a9d7984a594ac55 ****"
                },
                {
                    "fileSize":432945、
                    "fileName":"file2-name" 、
                    "fileUrl":"https:// iotx-*** .aliyuncs.com/no***.tar.gz?Expires=1502955804&OSSAccessKeyId=***&Signature=XfgJu7P***KU%3D&security-token=CAISuQJ***" 、
                    "fileMd5":"93230c3bde425a9d7984a594ac56ea1f" 、
                    "fileSign":"93230c3bde425a9d7984a594ac56 ****"
               }
            ],
            "モジュール": "MCU" 、
            "extData":{
                "key1":"value1" 、
                "key2":"value2" 、
                "_package_udi":"{\" ota_notice\":\" カメラドライバーを更新して、ビデオがぼやけないようにします。 \"}"
            }
        }
    }

  表5. パラメーター

  パラメーター	データ型	説明
  id	String	メッセージの ID 。 有効な値: 0 ~ 4294967295 各メッセージIDは、デバイスに対して一意である必要があります。 応答のメッセージIDは、要求のメッセージIDと同じです。 /sys/${productKey}/${deviceName}/thing/ota/firmware/getトピックに送信されたデータでidパラメーターを表示できます。
  コード	Integer	ステータスコード。 値が200の場合、リクエストが成功したことを示します。
  データ	オブジェクト	OTA更新パッケージに関する情報。 詳細については、「OTAアップデートパッケージに関する情報をデバイスにプッシュする」をご参照ください。

• 更新パッケージ情報が存在しない場合、IoT Platformは応答を送信します。 サンプル応答:

  {
      "id": "123",
      "code": 200,
      "data": {
      }
  }

パッケージセグメントのダウンロード要求の開始

OTAアップデートパッケージのダウンロードプロトコルがMQTTである場合、デバイスは、OTAアップデートパッケージをセグメントごとにダウンロードすることができる。 次のトピックが使用されます。

• リクエストトピック: /sys/${productKey}/${deviceName}/thing/file/download
• レスポンストピック: /sys/${productKey}/${deviceName}/thing/file/download_reply

リクエストの例

{
    "id": "123456" 、
    "version"： "1.0"、
    "params": {
        "fileToken":"1bb8 ***" 、
        "fileInfo":{
            "streamId":1234565、
            "fileId":1
        },
        "fileBlock":{
            "サイズ":256、
            "オフセット":2
        }
    }
}

レスポンス例：

• レスポンスのデータ構造を次の図に示します。

  フィールド	説明
  JSONバイト長	レスポンスのJSON文字列から変換されるバイト配列の長さを指定します。 バイト配列の長さは2バイトである必要があります。 第1のバイトは上位バイトであり、第2のバイトは下位バイトである。 たとえば、レスポンスのUTF-8-encoded JSON文字列はバイト配列に変換されます。 バイト配列の長さは10進数字87であり、これは16進数字57に対応する。 上位バイトは0x00であり、下位バイトは0x57である。
  JSON文字列バイト	レスポンス内のJSON文字列から変換されるバイト配列を指定します。 エンコード形式はUTF-8です。 詳細については、このトピックの「JSONレスポンスのサンプル」を参照してください。
  ファイルブロックバイト	セグメントのバイト配列を指定します。 バイトは、各バイトとパッケージヘッダとの間のオフセットに基づいて昇順にソートされる。
  CRC16/IBM	セグメントのチェック値を指定します。 チェック値の長さは2バイトである必要があります。 CRC-16-IBMのみサポートされています。 第1のバイトは上位バイトであり、第2のバイトは下位バイトである。 たとえば、セグメントのチェック値が0x0809の場合、上位バイトは0x08、下位バイトは0x09です。

• JSONレスポンスのサンプル:

  {
      "id": "123456" 、
      "code":200,
      "msg":"ファイルサイズが制限を超えました16 MB" 、
      "data": {
          "fileToken":"1bb8 ***" 、
          "fileLength":1238848、
          "bSize":1491、
          "bOffset":2
      }
  }

参考資料

エラーコードとトラブルシューティング方法の詳細については、「デバイスのエラーコード」をご参照ください。