system.upgrade.progressReport (Upgrade progress report)
system.upgrade.progressReport: Upgrade progress report
system.upgrade.progressReport · device scope · message query permission Alarm
What it does
Reported when upgrade progress changes. msgType is system.upgrade.progressReport (until the event catalog entry is finalized, this page is authoritative). After subscribing to capabilityEvent, real-time push and pull deliver this report. See Receive device messages and setMessageCallback · Event catalog · Overview and common payload. Alongside Upgrade succeeded and Upgrade failed.
Reported fields
Fields inside outputData. Platform fields: Overview and common payload.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
upgrade_result | Upgrade result | enum | no | "0" failed; "1" succeeded; "2" upgrading |
Example
{
"msgType": "system.upgrade.progressReport",
"deviceId": "TESTIPC000012345",
"productId": "56WGTET2",
"outputData": { "upgrade_result": "2" },
"time": 1673406989,
"localTime": "20230111T111629",
"alarmId": "116257862023505xxxx"
}
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the alarm message permission. A bound sub-user does not. When a sub-account queries messages for this event, each message is checked against the capability row share/sub codes (system.upgrade is usually Config). list / search filters out events without permission. Upgrade.