Help Center> IoT Device Access> SDK Reference> Old SDKs> Application Python SDK API Reference> Message Push> Pushing a Firmware Upgrade Status Change Notification
View PDF

Pushing a Firmware Upgrade Status Change Notification

Typical Scenario

After an application subscribes to firmware upgrade status change notifications (the notification type is fwUpgradeStateChangeNotify) on the platform, the platform sends a notification to the application when the firmware upgrade status changes.

API Function

This API is used by the platform to push notifications to an application that has subscribed to firmware upgrade status change notifications.

Note

  1. When Subscribing to Device Management Data, an application must subscribe to the specified callback URL in the API description. The server and port in the callback URL are the public IP address and specified port of the application server.
  2. An application receives the content of a push message by inheriting the PushMessageReceiver class and overriding the callback API.
  3. If the callback URL is not the address of the application server, the application must implement the original callback API. For details on the API content, see Message Push in the Northbound API Reference.

API Description

Callback URL

https://server:port/v1.0.0/messageReceiver

Callback API

def handleFwUpgradeStateChanged(self)

Class

PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter

Mandatory or Optional

Type

Location

Description

nfuscDTO

Mandatory

NotifyFwUpgradeStateChangedDTO

body

For details, see NotifyFwUpgradeStateChangedDTO structure.

NotifyFwUpgradeStateChangedDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is fwUpgradeStateChangeNotify.

deviceId

Mandatory

String

body

Uniquely identifies a device.

appId

Mandatory

String

body

Identifies the application to which the device belongs.

operationId

Mandatory

String

body

Identifies a firmware upgrade task.

subOperationId

Mandatory

String

body

Identifies a firmware upgrade sub-task.

step

Mandatory

String

body

Indicates the firmware upgrade status. The value options are 0, 1, 2, and 3.

stepDesc

Mandatory

String

body

Indicates the upgrade status description.

  • downloading: The device is downloading the software package.
  • downloaded: The device has finished downloading the software package.
  • updating: The device is being upgraded.
  • idle: The device is in the idle state.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType":"fwUpgradeStateChangeNotify",
    "deviceId":"******",
    "appId":"***********",
    "operationId":"**************",
    "subOperationId":"***********",
    "step":"1",
    "stepDesc":"downloading"
}

Normal Response Example

response:
Status Code: 200 OK
Parent topic: Message Push