Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
        • Diagnostics
        • Information
        • Maintenance
        • Time
        • Upgrade
          • system.upgrade.started (Upgrade started)
          • system.upgrade.succeeded (Upgrade succeeded)
          • system.upgrade.failed (Upgrade failed)
          • system.upgrade.progressReport (Upgrade progress report)
        • Credentials
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
What it does
Reported fields
Example
Minimum permission

system.upgrade.failed (Upgrade failed)

system.upgrade.failed: Upgrade failed

system.upgrade.failed · device scope · message query permission Alarm

What it does

Reported when upgrade fails. After subscribing to capabilityEvent, see Receive device messages and setMessageCallback; Event catalog · Overview and common payload. compose merges multiple idents; outputData may be {} or omit errCode.

Reported fields

Fields inside outputData. Platform fields: Overview and common payload.

NameDescriptionTypeRequiredValues
errCodeError code. 0 upgrade failed, 1 battery too low.enumno0 upgrade failed; 1 battery too low

Example

{
 "msgType": "system.upgrade.failed",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "outputData": {
 "errCode": "0"
 },
 "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.

system.upgrade.succeeded (Upgrade succeeded)
system.upgrade.progressReport (Upgrade progress report)