From 18641ed7c2c070d4140ffdd4045f8e7c9e11b5b4 Mon Sep 17 00:00:00 2001 From: Daria Chen Date: Thu, 14 Dec 2017 11:01:38 +0800 Subject: [PATCH] modify the firmware api related documents. (#101) --- content/en/SUMMARY.md | 2 +- .../api_references/report_device_firmware.md | 10 +- .../retrieve_device_available_firmware.md | 21 ++++- .../retrieve_device_firmware_by_version.md | 16 +++- .../api_references/retrieve_firmware_url.md | 10 +- content/en/tutorial.html | 2 +- content/en/tutorial/managing_firmware.md | 91 ++++++++++--------- .../api_references/report_device_firmware.md | 10 +- .../retrieve_device_available_firmware.md | 17 +++- .../retrieve_device_firmware_by_version.md | 16 +++- .../api_references/retrieve_firmware_url.md | 11 +-- content/zh-CN/tutorial/managing_firmware.md | 79 ++++++++-------- .../api_references/report_device_firmware.md | 14 +-- .../retrieve_device_available_firmware.md | 18 +++- .../retrieve_device_firmware_by_version.md | 15 ++- .../api_references/retrieve_firmware_url.md | 10 +- content/zh-TW/tutorial/managing_firmware.md | 78 ++++++++-------- 17 files changed, 234 insertions(+), 186 deletions(-) diff --git a/content/en/SUMMARY.md b/content/en/SUMMARY.md index 1f4f706..ccb73a5 100755 --- a/content/en/SUMMARY.md +++ b/content/en/SUMMARY.md @@ -36,9 +36,9 @@ * [Report Device Firmware](api_references/report_device_firmware.md) * [Retrieve Device Available Firmware](api_references/retrieve_device_available_firmware.md) * [Retrieve Device Firmware by version](api_references/retrieve_device_firmware_by_version.md) + * [Retrieve Firmware URL](api_references/retrieve_firmware_url.md) * [Device activation](api_references/device_activation.md) * [MQTT communication format](api_references/mqtt_communication_format.md) -* [Retrieve Firmware URL](api_references/retrieve_firmware_url.md) * [Mobile application](mobile_application/README.md) * [Mobile application--cn](mobile_application--cn/README.md) * [7681 Firmware Update](7681_firmware_update/README.md) diff --git a/content/en/api_references/report_device_firmware.md b/content/en/api_references/report_device_firmware.md index 30757e5..ceffa99 100644 --- a/content/en/api_references/report_device_firmware.md +++ b/content/en/api_references/report_device_firmware.md @@ -1,8 +1,8 @@ -# Report Device Firmware +# Report Device Firmware Version ## Description -Use **HTTPs PUT** to report the firmware of the device to MCS. +Use **HTTPs PUT** to report the current firmware version of the device to MCS. ## Request URL @@ -11,7 +11,9 @@ Use **HTTPs PUT** to report the firmware of the device to MCS. https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares ``` -To report the current firmware the device is using to the MCS. Please note that for MCS to get the firmware, you have to implement this API in your device to report the device firmware. +The device is able to report its current firmware version to MCS platform by using this API. Please note: The reported version must be one of the uploaded firmwares on MCS platform. + +This API could be used by device to report its initial firmware version when it boots up for the first time and then keep this firmware information updated when the firmware upgrade is done. This could be a useful information for device management. ## Action HTTPs PUT @@ -57,7 +59,7 @@ The response body will construct in JSON format with the following fields: | Field Name | Type | Description| | --- | --- | --- | --- | -| fwId | string | the firmware ID the device reported using | +| fwId | string | the firmware ID of this reported version | |code| string|http status code| |message|string|system log message| diff --git a/content/en/api_references/retrieve_device_available_firmware.md b/content/en/api_references/retrieve_device_available_firmware.md index d2caf24..7f11ead 100644 --- a/content/en/api_references/retrieve_device_available_firmware.md +++ b/content/en/api_references/retrieve_device_available_firmware.md @@ -3,7 +3,7 @@ ## Description -Use **HTTPs GET** to retrieve the available firmware for the device from MCS. +Use **HTTPs GET** to retrieve the available firmwares for this device from MCS. ## Request URL @@ -12,7 +12,19 @@ Use **HTTPs GET** to retrieve the available firmware for the device from MCS. https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/available ``` -To retrieve the available firmware for this device. +To retrieve the available firmwares for this device. + +If this device has reported its firmware version to MCS platform, this API provides a list of firmwares which are compatible with the current version. If the device hasn't reported any firmware yet, then, only the firmwares without any compatibility limitation are listed. + +### Query string + +Following fields could be constructed and appended to the end of the URL: + +| Field Name | Type | Required |Description| +| --- | --- | --- | --- | +| url | string | boolean | An optional parameter. Append **url=true** to get the download URL in the response.| + + ## Action HTTPs GET @@ -21,14 +33,13 @@ HTTPs GET ## Parameters ### Header - deviceKey: `device_key_here` Content-Type:`application/json` ### Return format -The return format is in json format +The return format is in JSON format ## Response @@ -49,7 +60,7 @@ The response body will construct in JSON format with the following fields: | Field Name | Type | Description| | --- | --- | --- | --- | -| results | array | the available firmware list for the device | +| results | array | the available firmware list for the device, and it includes
1. fwid: The firmware ID
2. name
3. description
4. version
5. URL: The firmware download URL (If there is a query string, **url=true**, in the request) | |code| string|http status code| |message|string|system log message| diff --git a/content/en/api_references/retrieve_device_firmware_by_version.md b/content/en/api_references/retrieve_device_firmware_by_version.md index 800e927..c57e139 100644 --- a/content/en/api_references/retrieve_device_firmware_by_version.md +++ b/content/en/api_references/retrieve_device_firmware_by_version.md @@ -1,8 +1,8 @@ -# Retrieve Device Firmware by version +# Retrieve Compatible Firmware by Version ## Description -Use **HTTPs GET** to retrieve the compatible firmware for specific firmware for the device from MCS. +Use **HTTPs GET** to retrieve the compatible firmwares for a specified firmware version. ## Request URL @@ -11,7 +11,15 @@ Use **HTTPs GET** to retrieve the compatible firmware for specific firmware for https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/available/:versionId ``` -To retrieve the compatible firmwares for specific firmware for this device. +This API provides a flexibility to query the compatible firmwares for a specified firmware version. + +### Query string + +Following fields could be constructed and appended to the end of the URL: + +| Field Name | Type | Required |Description| +| --- | --- | --- | --- | +| url | string | boolean | append **url=true** to get the download URL in the response.| ## Action HTTPs GET @@ -48,7 +56,7 @@ The response body will construct in JSON format with the following fields: | Field Name | Type | Description| | --- | --- | --- | --- | -| results | array | the compatible firmwares for specific firmware for this device | +| results | array | the compatible firmwares list for the specified firmware version, please refer to **/firmware/available** API | |code| string|http status code| |message|string|system log message| diff --git a/content/en/api_references/retrieve_firmware_url.md b/content/en/api_references/retrieve_firmware_url.md index 4adfbad..bf298de 100644 --- a/content/en/api_references/retrieve_firmware_url.md +++ b/content/en/api_references/retrieve_firmware_url.md @@ -2,8 +2,7 @@ ## Description -Use **HTTPs GET** to retrieve the firmware download url that the device want to download. - +Use **HTTPs GET** to retrieve the download URL of specified firmware. ## Request URL @@ -11,7 +10,8 @@ Use **HTTPs GET** to retrieve the firmware download url that the device want to https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/:fwId/url ``` -To retrieve the firmware url this device wants to download. +To retrieve the download URL of specified firmware. +You can use **/firmwares/available** API to get a list of compatible firmwares for your device and then specify the firmware ID in this API to get the download URL. ## Action HTTPs GET @@ -48,7 +48,7 @@ The response body will construct in JSON format with the following fields: | Field Name | Type | Description| | --- | --- | --- | --- | -| url | array | the firmware download url | +| url | array | the firmware download URL | |code| string|http status code| |message|string|system log message| @@ -57,7 +57,7 @@ The response body will construct in JSON format with the following fields: Request URL ``` -https://api.mediatek.com//mcs/v2/devices/DAWfOAsi/firmwares/FAdJBknrDsOm/url +https://api.mediatek.com/mcs/v2/devices/DAWfOAsi/firmwares/FAdJBknrDsOm/url ``` Please be noted, you can get the **firmware id** by calling the **retrieve device available firmware** API. diff --git a/content/en/tutorial.html b/content/en/tutorial.html index 15a9e18..ac8da5a 100755 --- a/content/en/tutorial.html +++ b/content/en/tutorial.html @@ -118,7 +118,7 @@
  • - Managing firmware + Firmware management
  • diff --git a/content/en/tutorial/managing_firmware.md b/content/en/tutorial/managing_firmware.md index da5bcb0..cc86e28 100755 --- a/content/en/tutorial/managing_firmware.md +++ b/content/en/tutorial/managing_firmware.md @@ -1,42 +1,40 @@ -# Managing Firmware +# Firmware Management -MediaTek Clous Sandbox(MCS) enables you to manage the device firmware and supports Firmware Over-The-Air (FOTA) for upgrade. +MediaTek Cloud Sandbox(MCS) enables you to manage the device firmware and supports Firmware Over-The-Air (FOTA) for upgrade. -MCS provides firmware repository services for prototypes and their test devices. The services provide basic firmware upload and download with version control, a web management console for firmware management as well as APIs that enable test devices to retrieve compatible firmware from MCS. +MCS provides firmware repository services for the prototypes and test devices. This service provides basic firmware upload and download with version control, a web console for firmware management as well as APIs that enable test devices to retrieve compatible firmware from MCS. -MCS does not handle the device firmware upgrade operation, you need to code the device or call the firmware APIs available from your development board's SDK. +MCS won't handle the complete device firmware upgrade process on your device, the developers have to implement this and leverage the firmware related library in your development board's SDK. -## Uploading Firmware to the Prototype +## Upload a Firmware to MCS +You can manage the firmwares for your prototype on **Prototype Details -> Firmware** page. -To use the Firmware service, go to the **Firmware** tab in the **Prototype detail** page. - -Click **Add firmware** to upload a new firmware, +To upload your first firmware, you just need to click **Add firmware** link, fill up the name and version of this firmware, select the firmware file and click **Upload**. ![](../images/Firmware/img_firmware_01.png) -Enter the Firmware name and version, select a firmware file and click **Upload**. - -Next, select a firmware that's compatible with the firmware you've just uploaded. -![](../images/Firmware/img_firmware_02.png) +In the next step, you could configure the compatibility of this firmware. **All firmware** is selected by default, or you could also select **Limited firmware** and opt in the individual firmwares which are compatible with this version. -Choose the prerequisite firmware that's compatible with the firmware you've uploaded. +Only the devices which are using the compatible firmwares are allowed to fetch this firmware information and be upgraded to this version. -The default option is **All firmware** or you can specify your own selection by clicking on the limited firmware. Only the firmware listed in the prerequisite can be upgraded using the firmware you've uploaded. +Now, you can either click **Done** to finish the firmware upload process or click **Next** to push the firmware to selected devices. +![](../images/Firmware/img_firmware_02.png) -If you don't want to proceed to push the firmware to the test device, you can stop by clicking **Done**. Otherwise, click **Next** to push the firmware to the device. +After selecting the devices you'd like to upgrade, click **Push**. ![](../images/Firmware/img_firmware_03.png) -After selecting the devices you'd like to upgrade, click **Push**. You can also do this by clicking on the first icon next to the firmware. - +You can also trigger this by clicking on the push icon in the firmware list. ![](../images/Firmware/img_firmware_04.png) -## Upgrading Firmware for Devices +## Upgrade a Firmware to Device -You can also upgrade the firmware from the **Device detail** page. In the Device detail page, click on the **firmware** tab, and you will see the current firmware used and the available firmware that the device can use for upgrade. +After the firmware is uploaded to MCS platform, you could **push** it to the connected devices on MCS web console or use **MCS APIs** to fetch the information of compatible firmwares. -Please note that the **Push** button will only be available when the device is connected. You can see the connection status of the device from the light signal in front of the device name. If the light is green, the device is connected; and if the light is grey, the device is offline. +The **push firmware** function is available on both **Prototype -> Firmware** or **Device details -> Firmware** page. + +Please note that the **Push** button is only available when the device is connected to MCS platform. The icon in front of the device name indicates the device connection status. The green light means the device is connected; and it turns to grey color if the device is offline. ![](../images/Firmware/img_firmware_05.png) @@ -44,43 +42,46 @@ Click **Push** button next to the firmware you want to use for device upgrade. A ![](../images/Firmware/img_firmware_06.png) -Please note, in the MCS platform, firmware upgrade information is sent to a device, however the firmware upgrade process is not handled. Please create code for your device in order to receive the information and perform firmware download and upgrade. - -The MCS command server will pass the code information to the device in the following format after clicking **Push**: -**deviceId,deviceKey,timestamp,FOTA,version,MD5,URL** +Please note: MCS could only **push** the firmware information down to the selected device, but it will not handle the complete firmware upgrade process on the device side. You have to implement your own program to download the firmware binary and upgrade the firmware accordingly. -* deviceId: the deviceId of the device -* deviceKey: the deviceKey of the device -* timestamp: the timestamp when the firmware is pushed -* FOTA: a string -* version: the version of the firmware being passed -* MD5: the MD5 of the firmware being passed -* URL: the download URL of the firmware being passed +After you click **push** button, MCS will send out the firmware information selected devices. Here are the supported protocol and format. -Or if you are using the MQTT to connect the device, the MCS MQTT Broker will pass the code information to the device in the following format after clicking **Push**: +1. TCP connection: **deviceId,deviceKey,timestamp,FOTA,version,MD5,URL**, for example -**timestamp,FOTA,version,MD5,URL** + ``` + Dbxxxx9k,TPJVxxxxxxxxBxBv,1513132150790,FOTA,2.0,null,https://cdn.mediatek.com/firmwares/P9MxxxxxxbTK/6a94dxxxxxxxxxxxxxxxxxxxx61f5df/a.bin + ``` + + * deviceId: the device ID of the device + * deviceKey: the device key of the device + * timestamp: the timestamp when this firmware is pushed + * FOTA: a fixed string which stands for "Firmware Over-The-Air" + * version: the version of this firmware + * MD5: the MD5 hash of this firmware + * URL: the download URL of this firmware -* timestamp: the timestamp when the firmware is pushed -* FOTA: a string -* version: the version of the firmware being passed -* MD5: the MD5 of the firmware being passed -* URL: the download URL of the firmware being passed +2. MQTT connection: **timestamp,FOTA,version,MD5,URL**, for example -Also, for devices based on LinkIt Connect 7681, the firmware upgrade process is handled by MCS, and you do not need to do any additional coding. However, you need to set a unique firmware version due to device limitation related to LinkIt Connect 7681, which is that it can only upgrade to a firmware with higher version. + ``` + 1513133357160,FOTA,2.0,null,https://cdn.mediatek.com/firmwares/P9MxxxxxxbTK/6a94dxxxxxxxxxxxxxxxxxxxx61f5df/a.bin + ``` -## Calling APIs to Report and Download Firmware from MCS + * timestamp: the timestamp when this firmware + * FOTA: a fixed string which stands for "Firmware Over-The-Air" + * version: the version of this firmware + * MD5: the MD5 hash of this firmware + * URL: the download URL of this firmware -MCS provides various firmware APIs to report current firmware version of the device, to retrieve all available firmware for device, as well as to get the firmware information you would like to use for upgrade. However, to use the APIs, you need to code them into your device. - -For a device to report its firmware version to the MCS platform, please use the **Report device firmware** API [here](https://mcs.mediatek.com/resources/latest/api_references/) and code it into the device. Once the device reports its firmware version to MCS, the information will be shown in the device firmware tab. +Also, for devices based on LinkIt Connect 7681, the firmware upgrade process is handled by MCS, and you do not need to do any additional coding. However, you need to set a unique firmware version due to device limitation related to LinkIt Connect 7681, which is that it can only upgrade to a firmware with higher version. -If you don't want to do the firmware upgrade through the MCS platform, you can use the **Retrieve device available firmware** API [here](https://mcs.mediatek.com/resources/latest/api_references/) to get all the available firmware for the device. +## MCS APIs -After you've retrieved the available firmware list and you've decided on the firmware version for upgrade, use the **Retrieve firmware URL** API [here](https://mcs.mediatek.com/resources/latest/api_references/) to get the download location of the firmware. +MCS provides the following APIs for firmware management and development. +1. [Report firmware version of a device](http://mcs.mediatek.com/resources/latest/api_references/#report-device-firmware): This API allows device to report its current firmware version back to MCS platform. Only the version number which has been uploaded onto MCS platform can be reported. +2. [Retrieve the compatible firmwares](http://mcs.mediatek.com/resources/latest/api_references/#report-device-firmware): After the device has reported its firmware version to MCS platform, this API provides a list of firmwares which are compatible with the current version. If the device hasn't reported its firmware yet, then, only the firmwares without any compatibility limitation are listed. diff --git a/content/zh-CN/api_references/report_device_firmware.md b/content/zh-CN/api_references/report_device_firmware.md index 23795f0..9d485db 100644 --- a/content/zh-CN/api_references/report_device_firmware.md +++ b/content/zh-CN/api_references/report_device_firmware.md @@ -1,8 +1,8 @@ -# 回报装置固件 +# 回报装置固件版本 ##描述 -使用 **HTTPs PUT** 来向 MCS 平台回报装置使用之固件。 +使用 **HTTPs PUT** 来向 MCS 平台回报装置的固件版本。 ## 请求 URL @@ -11,7 +11,9 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares ``` -向 MCS 平台回報裝置正在使用的固件。請注意，您必須將此功能自行編碼於您的裝置中，方可使用。 +装置可使用此 API 向 MCS 平台回报当前正在使用的固件版本。请注意，回报的版本号码，必须是先前已经上传至 MCS 平台的固件之一。 + +首次启用装置时，可透过呼叫此 API 来回报装置固件资讯，以方便后续装置版本的管理。此外，当装置完成固件更新时，亦可用来更新 MCS 平台上此装置的固件资讯，同时代表更新成功。 ## 动作 @@ -56,7 +58,7 @@ JSON 格式的回覆内容会包含以下几个栏位： |栏位名称|格式|描述| | --- | --- | --- | --- | -| fwId | string | 装置所回报的固件 ID| +| fwId | string | 装置回报的固件版本所对应到的固件 ID| |code| string|http 状态代码| |message|string|系统讯息| diff --git a/content/zh-CN/api_references/retrieve_device_available_firmware.md b/content/zh-CN/api_references/retrieve_device_available_firmware.md index 29eb78f..1446de6 100644 --- a/content/zh-CN/api_references/retrieve_device_available_firmware.md +++ b/content/zh-CN/api_references/retrieve_device_available_firmware.md @@ -1,9 +1,9 @@ -# 取得装置所有韧体资讯 +# 取得与此装置相容的固件列表 ## 描述 -使用 **HTTPs GET** 来从MCS平台取得该装置所有固件资讯清单。 +使用 **HTTPs GET** 從 MCS 平台取得该装置可使用的所有固件列表。 ## 请求 URL @@ -12,7 +12,16 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/available ``` -取得装置所有固件资讯清单。 +取得装置所有可使用的固件列表。 + +若您已将装置的固件版本回报至 MCS 平台，您可以使用此 API 获取相容的固件资讯，包含固件的下载网址。若您未曾回报装置的固件版本，其回传的固件资讯为无版本相容性限制的所有固件资讯。 + +### 查詢參數 +可將下列參數帶入請求 URL + +| Field Name | Type | Required |Description| +| --- | --- | --- | --- | +| url | 字串 | 布林值 | 为非必要的参数。加上 **url=true** 後，伺服器將會回傳各固件的下載網址| ## 动作 HTTPs GET @@ -49,7 +58,7 @@ JSON 格式的回覆内容会包含以下几个栏位： |栏位名称|格式|描述| | --- | --- | --- | --- | -| results | array | 所有该装置的固件清单资讯 | +| results | array | 该装置所有可使用的固件列表，其中包含以下资讯
    1. fwid: 固件 ID
    2. name
    3. description
    4. version
    5. URL: 固件的下载网址 (需在请求中加入 **url=true** 的查询参数) | |code| string|http 状态代码| |message|string|系统讯息| diff --git a/content/zh-CN/api_references/retrieve_device_firmware_by_version.md b/content/zh-CN/api_references/retrieve_device_firmware_by_version.md index f32121b..13330b7 100644 --- a/content/zh-CN/api_references/retrieve_device_firmware_by_version.md +++ b/content/zh-CN/api_references/retrieve_device_firmware_by_version.md @@ -1,8 +1,8 @@ -# 取得装置可相容之固件资讯 +# 取得与特定版本相容的固件列表 ## 描述 -使用 **HTTPs GET** 来从 MCS 取得装置特定固件可相容之韧体资讯。 +使用 **HTTPs GET** 来从 MCS 取得与特定版本相容的固件列表。 ## 请求 URL @@ -11,7 +11,15 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/available/:versionId ``` -取得装置特定固件可相容之韧体资讯。 +此 API 在版本相容性的查询上提供了更弹性的作法，可直接查询与指定版本相容的固件列表。 + + +### 查詢參數 +可將下列參數帶入請求 URL + +| Field Name | Type | Required |Description| +| --- | --- | --- | --- | +| url | 字串 | 布林值 | 非必要的参数。加上 **url=true** 后，伺服器将会回传各固件的下载网址| ## 动作 HTTPs GET @@ -48,7 +56,7 @@ JSON 格式的回覆内容会包含以下几个栏位： |栏位名称|格式|描述| | --- | --- | --- | --- | -| results | array | 所有该装置可相容的固件清单资讯 | +| results | array | 所有与特定版本相容的固件列表，可参考 **/firmware/available** API | |code| string|http 状态代码| |message|string|系统讯息| diff --git a/content/zh-CN/api_references/retrieve_firmware_url.md b/content/zh-CN/api_references/retrieve_firmware_url.md index 63813d1..372dfec 100644 --- a/content/zh-CN/api_references/retrieve_firmware_url.md +++ b/content/zh-CN/api_references/retrieve_firmware_url.md @@ -1,8 +1,8 @@ -# 取得固件 URL +# 取得固件下载网址 ## 描述 -使用 **HTTPs GET** 来取得您的装置欲更新之特定固件下载 url。 +使用 **HTTPs GET** 来取得指定固件的下载网址。 ## 请求 URL @@ -11,7 +11,8 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/:fwId/url ``` -来取得您的装置欲更新之特定固件下载 url。 +透过指定固件 ID 来取得此固件的下载网址。您可先呼叫 **/firmwares/available** API 获取与此装置相容的所有固件，再使用此 API 来取得单一固件的下载点。 + ## 动作 HTTPs GET @@ -48,7 +49,7 @@ JSON 格式的回覆内容会包含以下几个栏位： |栏位名称|格式|描述| | --- | --- | --- | --- | -| url | array | 固件下载 url | +| url | array | 固件下载网址 | |code| string|http 状态代码| |message|string|系统讯息| @@ -60,8 +61,6 @@ JSON 格式的回覆内容会包含以下几个栏位： https://api.mediatek.com//mcs/v2/devices/DAWfOAsi/firmwares/FAdJBknrDsOm/url ``` -请注意，您可以呼叫**取得装置所有固件资讯** API 以取得 **firmware id**。 - 请求 Header deviceKey: `g06jBWOtB0kqHk2B` diff --git a/content/zh-CN/tutorial/managing_firmware.md b/content/zh-CN/tutorial/managing_firmware.md index 6be1a7f..f705bbd 100755 --- a/content/zh-CN/tutorial/managing_firmware.md +++ b/content/zh-CN/tutorial/managing_firmware.md @@ -7,81 +7,74 @@ MCS 提供产品原型及其测试装置的固件库存服务。 MCS 提供基 MCS 将不会处理装置端的固件更新，使用者需自行开发您的开发板来呼叫固件相关APIs 来下载和更新固件。 -##上传固件至产品原型 +##上传固件 -您可以在产品原型页面中的**固件分页**来使用我们的固件服务。 +您可以在**产品原型**页面中的**固件**分页来使用我们的固件服务。点击**新增固件**来上传一个新的固件吧。 -点击**新增固件**来上传一个新的固件吧。 + +请输入固件名称，版本，并且选择您要上传的固件档案，然后点击上传按钮。 ![](../images/Firmware/img_firmware_01.png) -请输入固件名称，版本，并且选择您要上传的固件档案，然后点击上传按钮。 +之后，选择能相容此固件的前版固件。系统的预设值是所有固件，您可以透过选择**特定的固件**并勾选能与此上传版本相容的固件修改其相容设定。只有正使用您所勾选的前版固件的装置，才能够透过 MCS 网页或 API 获取此次上传的固件资讯，进行升级。 -之后，选择能相容此固件更新的前置韧体。 +如果您不想立即将此新版固件直接推送至连线中的装置触发更新，您可以点击完成按钮退出，或是您可以点击下一步按钮来选择您要推送更新的装置。 ![](../images/Firmware/img_firmware_02.png) -当您在选择能和此固件更新相容的前置固件时，您会发现，系统的预设值是所有的固件都会被选取。您可以更改此设定，只要勾选您想要能相容的固件即可。只有您在此勾选的前置固件，能够和您所上传的新固件相容。 - -如果您暂时不想将您所上传的固件更新直接更新置装置，您可以点击完成按钮退出，或是您可以点击下一步按钮来选择您要更新此固件的装置。 +当您选取好欲推送固件的装置后，点击推拨按钮。 ![](../images/Firmware/img_firmware_03.png) -当您选取好要更新此固件的装置后，点击推拨按钮。您亦可以在固件分页中，点击某一固件的清单中右边第一个图标来做固件推播。 +您亦可以在固件分页中，点击某一固件的清单中右边第一个图标开启固件推送页面。 ![](../images/Firmware/img_firmware_04.png) -## 替您的装置更新固件 +## 更新固件 + +将固件上传至 MCS 主控台后，您可以透过 MCS 主控台页面**推送**固件资讯至连线中的装置，或是透过 **MCS APIs** 取得与此装置相容的固件资讯。 -您亦可以于装置详情页面中来做固件更新服务。您只需要在装置详情页面中，点击固件分页，您将会看到此装置当时所使用的固件，和您和此装置目前固件相容的其他固件更新。 +若要在 MCS 主控台使用**固件推送**功能，您可以在**产品原型 -> 固件**分页下点击推送图示并选取您所要推送至的装置，或于单一装置的**装置详情 -> 固件**分页下，选取欲推送的固件并点击推送按钮。 +请注意，**推送**按钮只有在此装置有与 MCS 平台保持连线时才可以被点击。您可以透过装置名称前方的灯号来判断此装置是否在线。当灯号为绿色时，表示装置在线；当灯号为灰色时，表示装置离线。 -请注意，**推播**按钮只有在此装置有与 MCS 平台保持连线时才可以被点击。您可以使用装置名称前方的灯号来判断此装置是否在线。当灯号为绿色时，表示装置在线;当灯号为灰色时，表示装置离线。 ![](../images/Firmware/img_firmware_05.png) -点击您欲更新的固件后方的**推播**按钮来更新。之后，您将会看到固件推送成功讯息。 +推送完成后,您将会看到固件推送成功讯息。 ![](../images/Firmware/img_firmware_06.png) -请注意，MCS 平台只会将固件更新资讯传递到装置端，我们将不会处理装置端的固件更新程序。您必须自行开发您的装置，以下载和更新固件。 - -当您按下推播按钮后，MCS command server 会将资讯以以下格式传递给装置： - - -**deviceId,deviceKey,timestamp,FOTA,version,MD5,URL** - -* deviceId：装置的 deviceId -* deviceKey：装置的 deviceKey -* timestamp：按下推播按钮的时间点 -* FOTA：字串 -* version：被传递的固件版本 -* MD5：被传递的固件 MD5 -* URL：被传递的固件的下载网址 - -若您的装置是透过 MQTT 和 MCS 做相连，当您按下推播按钮后，MCS MQTT Broker 会将资讯以以下格式传递给装置： - -**timestamp,FOTA,version,MD5,URL** - -* timestamp: 按下推播按钮的时间点 -* FOTA: 字串 -* version: 被传递的韧体版本 -* MD5: 被传递的韧体 MD5 -* URL: 被传递的韧体的下载网址 +请注意, MCS 平台只负责将固件更新资讯传递到装置端，并不会处理装置端的固件更新程序。您必须自行开发您的装置，完成后续固件的下载与更新。 -此外，若您是使用 7681 开发板，您将不必额外对开发板进行开发，我们已经内建固件新功能。您唯一需要注意的是确认固件版本号有被正确设置，版本号需要为独特不能重复的。此外，7681 裝置由於硬體限制，只能接受版本号高于现有版本的固件更新。 +当您按下推送按钮后，MCS 平台会将固件资讯透过装置与 MCS 平台连线的协定回传给装置，其格式如下： +1. TCP 连线：**deviceId,deviceKey,timestamp,FOTA,version,MD5,URL**，例如 + + ``` + Dbxxxx9k,TPJVxxxxxxxxBxBv,1513132150790,FOTA,2.0,null,https://cdn.mediatek.com/firmwares/P9MxxxxxxbTK/6a94dxxxxxxxxxxxxxxxxxxxx61f5df/a.bin + ``` +2. MQTT 连线：**timestamp,FOTA,version,MD5,URL**，例如 -##使用 MCS 的 API 来回报和更新固件至 MCS 平台 + ``` + 1513133357160,FOTA,2.0,null,https://cdn.mediatek.com/firmwares/P9MxxxxxxbTK/6a94dxxxxxxxxxxxxxxxxxxxx61f5df/a.bin ``` -MCS 提供多种固件相关的的 API 来让您回报装置目前使用之固件，取得装置所有可使用固件，和取得欲更新知固件下载网址等等。唯一需要注意的是，您必须自行在您的装置上开发以呼叫使用这些 API。 +* deviceId: 装置的 deviceId（由于 MQTT 连线时，必须先指定 device ID，因此回传內文不包含此资讯） +* deviceKey: 装置的 deviceKey（由于 MQTT 连线时，必须先指定 device key，因此回传內文不包含此资讯） +* timestamp: 按下推送按钮的时间 +* FOTA: 固定字串，表示固件更新 +* version: 固件版本 +* MD5: 固件 MD5 杂凑，可用于检查下载后的档案是否完整。 +* URL: 固件的下载网址 +若您是使用 LinkIt Connect 7681 开发板，您将不必额外对开发板进行开发，我们已经内建固件更新功能。您唯一需要注意的是确认固件版本号有被正确设置，版本号需要为独特不能重复的。此外，7681 装置由于硬体限制，只能接受版本号高于现有版本的固件更新。 -您可以使用**回报装置固件** [API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/) 来和MCS平台回报您目前使用的固件版本。当装置回报固件版本后，您将可以在MCS平台中的固件分页中查看到此资讯。 -若您不想透过 MCS 平台来查看或是更新固件，您可以使用**取得装置所有固件资讯** [API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/) 以取得所有装置可使用的固件清单。 +##使用 MCS APIs -当您取得所有装置可使用的固件清单，并决定您要将装置更新至特定固件后，您可以使用**取得固件网址** [API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/) 来取得您欲更新的固件位置资讯。 +MCS 提供有以下几个与固件相关的 APIs ，方便您开发和管理装置与固件。 +1. [回报装置固件 API](https://mcs.mediatek.com/resources/zh-CN/latest/api_references/#回报装置固件)：将装置目前使用之固件版本回报至 MCS 平台。请注意，您回报的固件版本必须是已上传至 MCS 平台的固件版本。 +2. [取得可用固件 API](https://mcs.mediatek.com/resources/zh-CN/latest/api_references/#取得装置所有韧体资讯)：若您已将装置的固件版本回报至 MCS 平台，您可以使用此 API 获取相容的固件资讯，包含固件的下载网址。若您未曾回报装置的固件版本，其回传的固件资讯为无版本相容性限制的所有固件资讯。 diff --git a/content/zh-TW/api_references/report_device_firmware.md b/content/zh-TW/api_references/report_device_firmware.md index 7f0ce38..5ffaef8 100644 --- a/content/zh-TW/api_references/report_device_firmware.md +++ b/content/zh-TW/api_references/report_device_firmware.md @@ -1,8 +1,8 @@ -# 回報裝置韌體 +# 回報裝置韌體版本 ## 描述 -使用 **HTTPs PUT** 來向 MCS 平台回報裝置使用之韌體。 +使用 **HTTPs PUT** 來向 MCS 平台回報裝置的韌體版本。 ## 請求 URL @@ -11,7 +11,9 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares ``` -向 MCS 平台回報裝置正在使用的韌體。請注意，您必須將此功能自行編碼於您的裝置中，方可使用。 +裝置可使用此 API 向 MCS 平台回報當前正在使用的韌體版本。請注意，回報的版本號碼，必須是先前已經上傳至 MCS 平台的韌體之一。 + +首次啟用裝置時，可透過呼叫此 API 來回報裝置韌體資訊，以方便後續裝置版本的管理。此外，當裝置完成韌體更新時，亦可用來更新 MCS 平台上此裝置的韌體資訊，同時代表更新成功。 ## 動作 @@ -56,9 +58,9 @@ JSON 格式的回覆內容會包含以下幾個欄位： | 欄位名稱 | 格式 |描述| | --- | --- | --- | --- | -| fwId | string | 裝置所回報的韌體 ID| -|code| string|http 狀態代碼| -|message|string|系統訊息| +| fwId | string | 裝置回報的韌體版本所對應到的韌體 ID| +| code | string |http 狀態代碼| +| message |string |系統訊息| **範例：** diff --git a/content/zh-TW/api_references/retrieve_device_available_firmware.md b/content/zh-TW/api_references/retrieve_device_available_firmware.md index b4a87e9..98cfcd4 100644 --- a/content/zh-TW/api_references/retrieve_device_available_firmware.md +++ b/content/zh-TW/api_references/retrieve_device_available_firmware.md @@ -1,9 +1,9 @@ -# 取得裝置所有韌體資訊 +# 取得與此裝置相容的韌體列表 ## 描述 -使用 **HTTPs GET** 來從 MCS 平台取得該裝置所有韌體資訊清單。 +使用 **HTTPs GET** 從 MCS 平台取得該裝置可使用的所有韌體列表。 ## 請求 URL @@ -12,7 +12,17 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/available ``` -取得裝置所有韌體資訊清單。 +取得裝置所有可使用的韌體列表。 + +若您已將裝置的韌體版本回報至 MCS 平台，您可以使用此 API 獲取相容的韌體資訊，包含韌體的下載網址。若您未曾回報裝置的韌體版本，其回傳的韌體資訊為無版本相容性限制的所有韌體資訊。 + + +### 查詢參數 +可將下列參數帶入請求 URL + +| Field Name | Type | Required |Description| +| --- | --- | --- | --- | +| url | 字串 | 布林值 | 非必要的参数。加上 **url=true** 後，伺服器將會回傳各韌體的下載網址| ## 動作 HTTPs GET @@ -49,7 +59,7 @@ JSON 格式的回覆內容會包含以下幾個欄位： | 欄位名稱 | 格式 |描述| | --- | --- | --- | --- | -| results | array | 所有該裝置的韌體清單資訊 | +| results | array | 該裝置所有可使用的韌體列表，其中包含以下資訊
    1. fwid: 韌體 ID
    2. name
    3. description
    4. version
    5. URL: 韌體的下載網址 (需在請求中加入 **url=true** 的查詢參數) | |code| string|http 狀態代碼| |message|string|系統訊息| diff --git a/content/zh-TW/api_references/retrieve_device_firmware_by_version.md b/content/zh-TW/api_references/retrieve_device_firmware_by_version.md index 93417c2..319d003 100644 --- a/content/zh-TW/api_references/retrieve_device_firmware_by_version.md +++ b/content/zh-TW/api_references/retrieve_device_firmware_by_version.md @@ -1,8 +1,8 @@ -# 取得裝置可相容之韌體資訊 +# 取得與特定版本相容的韌體列表 ## 描述 -使用 **HTTPs GET** 來從 MCS 取得裝置特定韌體可相容之韌體資訊。 +使用 **HTTPs GET** 來從 MCS 取得與特定版本相容的韌體列表。 ## 請求 URL @@ -11,7 +11,14 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/available/:versionId ``` -取得裝置特定韌體可相容之韌體資訊。 +此 API 在版本相容性的查詢上提供了更彈性的作法，可直接查詢與指定版本相容的韌體列表。 + +### 查詢參數 +可將下列參數帶入請求 URL + +| Field Name | Type | Required |Description| +| --- | --- | --- | --- | +| url | 字串 | 布林值 | 非必要的参数。加上 **url=true** 後，伺服器將會回傳各韌體的下載網址| ## 動作 HTTPs GET @@ -48,7 +55,7 @@ JSON 格式的回覆內容會包含以下幾個欄位： | 欄位名稱 | 格式 |描述| | --- | --- | --- | --- | -| results | array | 所有該裝置可相容的韌體清單資訊 | +| results | array | 所有與特定版本相容的韌體列表，可參考 **/firmware/available** API | |code| string|http 狀態代碼| |message|string|系統訊息| diff --git a/content/zh-TW/api_references/retrieve_firmware_url.md b/content/zh-TW/api_references/retrieve_firmware_url.md index c44ee6e..b658c2d 100644 --- a/content/zh-TW/api_references/retrieve_firmware_url.md +++ b/content/zh-TW/api_references/retrieve_firmware_url.md @@ -1,8 +1,8 @@ -# 取得韌體 URL +# 取得韌體下載網址 ## Description -使用 **HTTPs GET** 來取得您的裝置欲更新之特定韌體下載 url。 +使用 **HTTPs GET** 來取得指定韌體的下載網址。 ## 請求 URL @@ -11,7 +11,7 @@ https://api.mediatek.com/mcs/v2/devices/:deviceId/firmwares/:fwId/url ``` -來取得您的裝置欲更新之特定韌體下載 url。 +透過指定韌體 ID 來取得此韌體的下載網址。您可先呼叫 **/firmwares/available** API 獲取與此裝置相容的所有韌體，再使用此 API 來取得單一韌體的下載點。 ## 動作 HTTPs GET @@ -48,7 +48,7 @@ JSON 格式的回覆內容會包含以下幾個欄位： | 欄位名稱 | 格式 |描述| | --- | --- | --- | --- | -| url | array | 韌體下載 url | +| url | array | 韌體下載網址 | |code| string|http 狀態代碼| |message|string|系統訊息| @@ -60,8 +60,6 @@ JSON 格式的回覆內容會包含以下幾個欄位： https://api.mediatek.com//mcs/v2/devices/DAWfOAsi/firmwares/FAdJBknrDsOm/url ``` -請注意, 您可以呼叫**取得裝置所有韌體資訊** API 以取得 **firmware id**。 - 請求 Header deviceKey: `g06jBWOtB0kqHk2B` diff --git a/content/zh-TW/tutorial/managing_firmware.md b/content/zh-TW/tutorial/managing_firmware.md index 96d79db..4dc5788 100755 --- a/content/zh-TW/tutorial/managing_firmware.md +++ b/content/zh-TW/tutorial/managing_firmware.md @@ -2,83 +2,81 @@ 您可以使用 MediaTek Clous Sandbox (MCS) 來管理您的韌體，並且透過空中更新將韌體更新至您的裝置。 -MCS 提供產品原型及其測試裝置的韌體庫存服務。MCS 提供基本的韌體版本控制和上傳和下載服務。使用者可以選擇在網頁上直接推播韌體資訊至裝置或是使用 MCS APIs 來讓裝置主動取得韌體資訊。 +MCS 提供產品原型及其測試裝置的韌體上傳下載、版本與相容性管理服務。使用者可以選擇在網頁上直接推送韌體資訊至連線的裝置或是使用 MCS APIs 來讓裝置主動取得韌體資訊。 MCS 將不會處理裝置端的韌體更新，使用者需自行開發您的開發板來呼叫韌體相關 APIs 來下載和更新韌體。 -## 上傳韌體至產品原型 +## 上傳韌體 -您可以在產品原型頁面中的**韌體分頁**來使用我們的韌體服務。點擊**新增韌體**來上傳一個新的韌體吧。 +您可以在**產品原型**頁面中的**韌體**分頁來使用我們的韌體服務。點擊**新增韌體**來上傳一個新的韌體吧。 -![](../images/Firmware/img_firmware_01.png) 請輸入韌體名稱，版本，並且選擇您要上傳的韌體檔案，然後點擊上傳按鈕。 -之後，選擇能相容此韌體更新的前置韌體。 +![](../images/Firmware/img_firmware_01.png) -![](../images/Firmware/img_firmware_02.png) +之後，選擇能相容此韌體的前版韌體。系統的預設值是所有韌體，您可以透過選擇**特定的韌體**並勾選能與此上傳版本相容的韌體修改其相容設定。只有正使用您所勾選的前版韌體的裝置，才能夠透過 MCS 網頁或 API 獲取此次上傳的韌體資訊，進行升級。 -當您在選擇能和此韌體更新相容的前置韌體時，您會發現，系統的預設值是所有的韌體都會被選取。您可以更改此設定，只要勾選您想要能相容的韌體即可。只有您在此勾選的前置韌體，能夠和您所上傳的新韌體相容。 +如果您不想立即將此新版韌體直接推送至連線中的裝置觸發更新，您可以點擊完成按鈕退出，或是您可以點擊下一步按鈕來選擇您要推送更新的裝置。 + +![](../images/Firmware/img_firmware_02.png) -如果您暫時不想將您所上傳的韌體更新直接更新置裝置，您可以點擊完成按鈕退出，或是您可以點擊下一步按鈕來選擇您要更新此韌體的裝置。 +當您選取好欲推送韌體的裝置後，點擊推撥按鈕。 ![](../images/Firmware/img_firmware_03.png) -當您選取好要更新此韌體的裝置後，點擊推撥按鈕。您亦可以在韌體分頁中，點擊某一韌體的清單中右邊第一個圖標來做韌體推播。 +您亦可以在韌體分頁中，點擊某一韌體的清單中右邊第一個圖標開啟韌體推送頁面。 ![](../images/Firmware/img_firmware_04.png) -## 替您的裝置更新韌體 +## 更新韌體 -您亦可以於裝置詳情頁面中來做韌體更新服務。您只需要在裝置詳情頁面中，點擊韌體分頁，您將會看到此裝置當時所使用的韌體，和您和此裝置目前韌體相容的其他韌體更新。 +將韌體上傳至 MCS 主控台後，您可以透過 MCS 主控台頁面**推送**韌體資訊至連線中的裝置，或是透過 **MCS APIs** 取得與此裝置相容的韌體資訊。 +若要在 MCS 主控台使用**韌體推送**功能，您可以在**產品原型 -> 韌體**分頁下點擊推送圖示並選取您所要推送至的裝置，或於單一裝置的**裝置詳情 -> 韌體**分頁下，選取欲推送的韌體並點擊推送按鈕。 -請注意，**推播**按鈕只有在此裝置有與 MCS 平台保持連線時才可以被點擊。您可以使用裝置名稱前方的燈號來判斷此裝置是否在線。當燈號為綠色時，表示裝置在線；當燈號為灰色時，表示裝置離線。 +請注意，**推送**按鈕只有在此裝置有與 MCS 平台保持連線時才可以被點擊。您可以透過裝置名稱前方的燈號來判斷此裝置是否在線。當燈號為綠色時，表示裝置在線；當燈號為灰色時，表示裝置離線。 ![](../images/Firmware/img_firmware_05.png) -點擊您欲更新的韌體後方的**推播** 按鈕來更新。之後,您將會看到韌體推送成功訊息。 +推送完成後,您將會看到韌體推送成功訊息。 ![](../images/Firmware/img_firmware_06.png) -請注意, MCS 平台只會將韌體更新資訊傳遞到裝置端，我們將不會處理裝置端的韌體更新程序。您必須自行開發您的裝置，以下載和更新韌體。 - -當您按下推播按鈕後，MCS command server 會將資訊以以下格式傳遞給裝置： - -**deviceId,deviceKey,timestamp,FOTA,version,MD5,URL** - -* deviceId: 裝置的 deviceId -* deviceKey: 裝置的 deviceKey -* timestamp: 按下推播按鈕的時間點 -* FOTA: 字串 -* version: 被傳遞的韌體版本 -* MD5: 被傳遞的韌體 MD5 -* URL: 被傳遞的韌體的下載網址 - -若您的裝置是透過 MQTT 和 MCS 做相連，當您按下推播按鈕後，MCS MQTT Broker 會將資訊以以下格式傳替給裝置： +請注意, MCS 平台只負責將韌體更新資訊傳遞到裝置端，並不會處理裝置端的韌體更新程序。您必須自行開發您的裝置，完成後續韌體的下載與更新。 -**timestamp,FOTA,version,MD5,URL** +當您按下推送按鈕後，MCS 平台會將韌體資訊透過裝置與 MCS 平台連線的協定回傳給裝置，其格式如下： -* timestamp: 按下推播按鈕的時間點 -* FOTA: 字串 -* version: 被傳遞的韌體版本 -* MD5: 被傳遞的韌體 MD5 -* URL: 被傳遞的韌體的下載網址 +1. TCP 連線：**deviceId,deviceKey,timestamp,FOTA,version,MD5,URL**，例如 + + ``` + Dbxxxx9k,TPJVxxxxxxxxBxBv,1513132150790,FOTA,2.0,null,https://cdn.mediatek.com/firmwares/P9MxxxxxxbTK/6a94dxxxxxxxxxxxxxxxxxxxx61f5df/a.bin + ``` +2. MQTT 連線：**timestamp,FOTA,version,MD5,URL**，例如 + ``` + 1513133357160,FOTA,2.0,null,https://cdn.mediatek.com/firmwares/P9MxxxxxxbTK/6a94dxxxxxxxxxxxxxxxxxxxx61f5df/a.bin + ``` -此外，若您是使用 7681 開發板，您將不必額外對開發板進行開發，我們已經內建韌體更新功能。您唯一需要注意的是確認韌體版本號有被正確設置，版本號需要為獨特不能重複的。此外，7681 裝置由於硬體限制，只能接受版本號高於現有版本的韌體更新。 +* deviceId: 裝置的 deviceId（由於 MQTT 連線時，必須先指定 device ID，因此回傳訊息不包含此資訊） +* deviceKey: 裝置的 deviceKey（由於 MQTT 連線時，必須先指定 device key，因此回傳訊息不包含此資訊） +* timestamp: 按下推送按鈕的時間 +* FOTA: 固定字串，表示韌體更新 +* version: 韌體版本 +* MD5: 韌體 MD5 雜湊，可用於檢查下載後的檔案是否完整。 +* URL: 韌體的下載網址 +若您是使用 LinkIt Connect 7681 開發板，您將不必額外對開發板進行開發，我們已經內建韌體更新功能。您唯一需要注意的是確認韌體版本號有被正確設置，版本號需要為獨特不能重複的。此外，7681 裝置由於硬體限制，只能接受版本號高於現有版本的韌體更新。 -## 使用 MCS APIs 來回報和更新韌體至 MCS 平台 -MCS 提供多種韌體相關的 APIs 來讓您回報裝置目前使用之韌體，取得裝置所有可使用之韌體，和取得欲更新知韌體下載網址等等。唯一需要注意的是，您必須自行在您的裝置上開發以呼叫使用這些 API。 +## 使用 MCS APIs -您可以使用**回報裝置韌體** [API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/) 來和 MCS 平台回報您目前使用的韌體版本。當裝置回報韌體版本後，您將可以在 MCS 平台中的韌體分頁中查看到此資訊。 +MCS 提供有以下幾個與韌體相關的 APIs ，方便您開發和管理裝置與韌體。 -若您不想透過 MCS 平台來查看或是更新韌體，您可以使用**取得裝置所有韌體資訊** [API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/) 以取得所有裝置可使用的韌體清單。 +1. [回報裝置韌體 API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/#回報裝置韌體)：將裝置目前使用之韌體版本回報至 MCS 平台。請注意，您回報的韌體版本必須是已上傳至 MCS 平台的韌體版本。 +2. [取得可用韌體 API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/#取得裝置所有韌體資訊)：若您已將裝置的韌體版本回報至 MCS 平台，您可以使用此 API 獲取相容的韌體資訊，包含韌體的下載網址。若您未曾回報裝置的韌體版本，其回傳的韌體資訊為無版本相容性限制的所有韌體資訊。 -當您取得所有裝置可使用的韌體清單，並決定您要將裝置更新至特定韌體後，您可以使用**取得韌體 URL** [API](https://mcs.mediatek.com/resources/zh-TW/latest/api_references/) 來取得您欲更新的韌體位置資訊。