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
        • Arming
        • Attention zone
        • People counting
        • Cry detection
        • Absence from post
        • Face recognition
        • Fall detection
        • Gesture call
        • Intrusion
        • Loitering
        • Minor detection
        • Person and vehicle mix
        • Motion detection
        • Video occlusion
        • Illegal parking
        • Person detection
        • Pet detection
        • PIR
        • License plate recognition
        • Vehicle guard
        • Siren
        • Voice SOS
        • Abnormal sound
        • Tripwire
        • Unoccupied detection
        • Vehicle
        • Door contact
          • detection.door.contactState (Read door contact state)
          • detection.door.opened (Door opened alarm)
          • detection.door.closed (Door closed alarm)
          • detection.door.blocked (Deadbolt jammed)
          • detection.door.cardFailed (Failed card unlock)
          • detection.door.fingerprintFailed (Failed fingerprint unlock)
          • detection.door.highTemperature (High temperature alarm)
          • detection.door.hijack (Lock hijack alarm)
          • detection.door.keyInserted (Key inserted)
          • detection.door.passwordFailed (Failed password unlock)
          • detection.door.unlockEvent (Unlock event)
          • detection.door.dynamicResult (Read dynamic result)
          • detection.door.keyData (Read key data)
          • detection.door.keyUpdateId (Read key ID update)
          • detection.door.remoteEnabled (Read remote unlock enable)
          • detection.door.reset (Read reset user data)
          • detection.door.keyAdd (Add key)
          • detection.door.keyDelete (Delete key)
          • detection.door.keyOnce (One-time password)
          • detection.door.keyPeriod (Recurring password)
          • detection.door.dynamicResult (Set dynamic result)
          • detection.door.keyData (Set key data)
          • detection.door.keyUpdateId (Set key ID update)
          • detection.door.remoteEnabled (Set remote unlock enable)
          • detection.door.reset (Set reset user data)
        • Tamper
        • Gate accessory
        • Environment sensing
        • Target detection frame
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • 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
Scope
Reader notes
Index in this folder

Door contact

Door contact

Scope

contactState, lock state, keys, and related capabilities use property / invoke via get, set, or invoke—mostly permission Config. Open/close/failure/hijack events are listed below; subscribe to capabilityEvent via setMessageCallback for pushes and use message query permission Alarm. See Detection and alarms and door-contact entries in the Event catalog. Follow device.capability.list; most are device scope.

Reader notes

Start with Using capabilities. Call device.capability.list before you use IDs on this page. See Permission codes and Capability errors.

Index in this folder

OperationID
Read door contact statedetection.door.contactState
Door opened alarmdetection.door.opened
Door closed alarmdetection.door.closed
Read remote unlock enabledetection.door.remoteEnabled
Set remote unlock enabledetection.door.remoteEnabled
Read reset user datadetection.door.reset
Set reset user datadetection.door.reset
Read key datadetection.door.keyData
Set key datadetection.door.keyData
Read dynamic resultdetection.door.dynamicResult
Set dynamic resultdetection.door.dynamicResult
Read key ID updatedetection.door.keyUpdateId
Set key ID updatedetection.door.keyUpdateId
Add keydetection.door.keyAdd
Delete keydetection.door.keyDelete
One-time passworddetection.door.keyOnce
Recurring passworddetection.door.keyPeriod
Deadbolt jammeddetection.door.blocked
Key inserteddetection.door.keyInserted
Failed password unlockdetection.door.passwordFailed
Failed card unlockdetection.door.cardFailed
Failed fingerprint unlockdetection.door.fingerprintFailed
High temperature alarmdetection.door.highTemperature
Lock hijack alarmdetection.door.hijack
Unlock eventdetection.door.unlockEvent