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 saving / supply mode
        • Sleep and wake
          • power.sleep.status (Get sleep status property)
          • power.sleep.preview (Get preview sleep property)
          • power.sleep.preview (Set preview sleep property)
          • power.sleep.wake (Wake)
          • power.sleep.delay (Delay sleep)
          • power.sleep.imminent (Sleep imminent event)
        • 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.sleep.imminent (Sleep imminent event)

power.sleep.imminent: Sleep imminent event

power.sleep.imminent · device scope · message query permission Alarm

What it does

Reported when the device is about to sleep. msgType is power.sleep.imminent. After subscribing to capabilityEvent. See Receive device messages, setMessageCallback, Event catalog, and Overview and common payload. Common follow-ups: Delay sleep, Wake, or read Sleep status.

Reported fields

outputData has no business fields (may be {}). Platform fields: Overview and common payload.

Example

{
 "msgType": "power.sleep.imminent",
 "deviceId": "TESTIPC000012345",
 "productId": "56WGTET2",
 "outputData": {},
 "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. Sleep and wake.

power.sleep.delay (Delay sleep)
power.outlet.current (Get current current property)