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
        • Battery
          • power.battery.info (Get battery info (by category) property)
          • power.battery.chargeData (Get battery charge data property)
          • power.battery.low (Low battery alert (standard))
          • power.battery.full (Full battery alert)
          • power.battery.level (Get battery level property)
          • power.battery.level (Set battery level property)
        • Power saving / supply mode
        • Sleep and wake
        • Outlet metering
      • Privacy
      • Call
      • Storage
      • System
      • 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

power.battery.low (Low battery alert (standard))

power.battery.low: Low battery alert (standard)

power.battery.low · device scope · message query permission Alarm

What it does

Reported when the battery is low (compose leaf: multiple legacy idents map to the same msgType). msgType is power.battery.low. Subscribe to capabilityEvent in callbackFlag. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload.

Reported fields

Fields inside outputData. Platform fields are described in Overview and common payload.

NameDescriptionTypeRequiredValues
typeLow-battery pack type. 0 camera battery, 1 door lock battery.enumno0 camera battery; 1 door lock battery
elePercentRemaining charge percentage. Range 0–100, step 1, unit %.intno0–100, step 1, unit %

Example

{
 "msgType": "power.battery.low",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "outputData": {
 "type": "0",
 "elePercent": 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. A sub-account needs Alarm. list / search filters out events you are not allowed to see. Battery.

power.battery.chargeData (Get battery charge data property)
power.battery.full (Full battery alert)