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
      • Algorithm
        • Algorithm package
          • algorithm.package.loaded (Read loaded algorithm info property)
          • algorithm.package.region (Read algorithm package region property)
          • algorithm.package.region (Set algorithm package region property)
          • algorithm.package.upgrade (Upgrade algorithm package)
          • algorithm.package.check (Validate algorithm)
          • algorithm.package.delete (Delete algorithm)
          • algorithm.package.progress (Query algorithm download progress)
          • algorithm.package.status (Algorithm package status)
          • algorithm.package.enable (Query algorithm package enable state)
          • algorithm.package.downloadResult (Algorithm package download result)
          • algorithm.package.upgradeResult (Algorithm package upgrade result)
      • 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

algorithm.package.upgradeResult (Algorithm package upgrade result)

algorithm.package.upgradeResult: Algorithm package upgrade result

algorithm.package.upgradeResult · device scope · message query permission Alarm

What it does

Alarm when an upgrade finishes (action invoke see Algorithm package; progress property algorithm.package.progress). compose merges idents. See Event catalog · Overview and common payload · Receive device messages.

Reported fields

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

NameDescriptionTypeWhen present
upgradeResultUpgrade result struct (url, ret)structSuccess shape
upgradeResult.urlPackage URLtextSame as upgradeResult
upgradeResult.ret0 failure, 1 successenumSame as upgradeResult
typeAlgorithm package typeenumCommon across idents
urlPackage URL (top level)textFailure shape; no upgradeResult

type enum matches Algorithm package download result.

Example

{
 "msgType": "algorithm.package.upgradeResult",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "outputData": {
 "type": "1",
 "upgradeResult": {
 "url": "https://example/pkg.bin",
 "ret": "1"
 }
 },
 "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. A sub-account needs Alarm. list / search filters out events you are not allowed to see. Algorithm package.

algorithm.package.downloadResult (Algorithm package download result)
device.reboot.execute (Reboot device)