Help Center > > API Reference> Northbound Python SDK API Reference> Service API List> Message Push> Pushing Device Information Change Notifications

Pushing Device Information Change Notifications

Updated at: Aug 28, 2019 GMT+08:00

Typical Scenario

After an NA subscribes to device information change notifications (the notification type is deviceInfoChanged) on the IoT platform, the IoT platform sends a notification message to the NA when the device configuration or status (such as manufacturer, location, version and online status) changes.

API Function

This API is used by the IoT platform to push notification messages to an NA that has subscribed to device information change notifications.

Note

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

API Description

Callback URL

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

Callback API

def handleDeviceInfoChanged(self)

Class

PushMessageReceiver

Parameter Description

The input parameter is request.json.

Parameter

Mandatory or Optional

Type

Location

Description

ndicDTO

Mandatory

NotifyDeviceInfoChangedDTO

body

For details, see NotifyDeviceInfoChangedDTO structure.

NotifyDeviceInfoChangedDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

notifyType

Mandatory

String

body

Indicates the notification type. The value is deviceInfoChanged.

deviceId

Mandatory

String

body

Uniquely identifies a device.

gatewayId

Mandatory

String

body

Uniquely identifies a gateway.

deviceInfo

Mandatory

DeviceInfo

body

Indicates information about the device. For details, see DeviceInfo structure.

DeviceInfo structure

Parameter

Mandatory or Optional

Type

Location

Description

nodeId

Mandatory

String(256)

body

Uniquely identifies the device. Generally, the MAC address, serial number, or IMEI is used as the node ID.

NOTE:

When the IMEI is used as the node ID, the node ID varies depending on the chip provided by the manufacturer.

  • The unique identifier of a Qualcomm chip is urn:imei:xxxx, where xxxx is the IMEI.
  • The unique identifier of a HiSilicon chip is the IMEI.
  • For details on the unique identifiers of chipsets provided by other manufacturers, contact the module manufacturers.

name

Optional

String(256)

body

Indicates the device name.

description

Optional

String(2048)

body

Indicates the device description.

manufacturerId

Optional

String(256)

body

Uniquely identifies a manufacturer.

manufacturerName

Optional

String(256)

body

Indicates the manufacturer name.

mac

Optional

String(256)

body

Indicates the MAC address of the device.

location

Optional

String(2048)

body

Indicates the device location.

deviceType

Optional

String(256)

body

Indicates the device type. The upper camel case is used, for example, MultiSensor, ContactSensor, and CameraGateway.

model

Optional

String(256)

body

Indicates the device model.

swVersion

Optional

String(256)

body

Indicates the software version of the device.

In Z-Wave, the format is major version.minor version, for example, 1.1.

fwVersion

Optional

String(256)

body

Indicates the firmware version of the device.

hwVersion

Optional

String(256)

body

Indicates the hardware version of the device.

protocolType

Optional

String(256)

body

Indicates the protocol type used by the device. The value options are CoAP, huaweiM2M, Z-Wave, ONVIF, WPS, Hue, WiFi, J808, Gateway, ZigBee, and LWM2M.

bridgeId

Optional

String(256)

body

Identifies the bridge through which the device accesses the IoT platform.

status

Optional

String

body

Indicates whether the device is online. The value options are ONLINE, OFFLINE, INBOX, and ABNORMAL.

statusDetail

Optional

String(256)

body

Indicates status details of the device. The value of this parameter varies with the value of status. For details, see status and statusDetail.

mute

Optional

String

body

Indicates whether the device is in the frozen state. Based on the value of this parameter, the IoT platform determines whether to manage and store data reported by the device.

  • TRUE: The device is in the frozen state.
  • FALSE: The device is not in the frozen state.

supportedSecurity

Optional

String

body

Indicates whether the security mode is supported.

  • TRUE: The security mode is supported.
  • FALSE: The security mode is not supported.

isSecurity

Optional

String

body

Indicates whether the security mode is enabled.

  • TRUE: The security mode is enabled.
  • FALSE: The security mode is disabled.

signalStrength

Optional

String(256)

body

Indicates the signal strength of the device.

sigVersion

Optional

String(256)

body

Indicates the SIG version of the device.

serialNumber

Optional

String(256)

body

Indicates the serial number of the device.

batteryLevel

Optional

String(256)

body

Indicates the battery level of the device.

status and statusDetail

status

statusDetail

OFFLINE

NONE CONFIGURATION_PENDING

ONLINE

NONE COMMUNICATION_ERROR CONFIGURATION_ERROR BRIDGE_OFFLINE FIRMWARE_UPDATING DUTY_CYCLE NOT_ACTIVE

NOTE:

When the device status information is reported to the IoT platform, status and statusDetail must be included. It is recommended that statusDetail be used only for display but not for logical judgment.

Response Parameters

Status Code: 200 OK

Request Example

Method: POST
request: {callbackUrl}
Header:
Content-Type:application/json
Body:
{
    "notifyType ":"deviceInfoChanged",
    "deviceId":"********************************",
    "gatewayId":"*************",
    "deviceInfo":{
        "name":"Sensor_12",
        "manufacturer":"wulian",
        "type":90,
        "model":"90",
        "mac":"****************",
        "swVersion": "...",
        "fwVersion": "...",
        "hwVersion": "...",
        "protocolType":"zigbee",
        "description":"smock detector"
    }
}

Response Example

response:
Status Code: 200 OK

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel