The implemented cluster.
ReadonlyeventsAccess the behavior's events.
ReadonlydoorThe door lock server provides several alarms which can be sent when there is a critical state on the door lock. The alarms available for the door lock server are listed in AlarmCodeEnum.
ReadonlylockThe door lock server sends out a LockOperation event when the event is triggered by the various lock operation sources.
• If the door lock server supports the Unbolt Door command, it shall generate a LockOperation event with LockOperationType set to Unlock after an Unbolt Door command succeeds.
• If the door lock server supports the Unbolting feature and an Unlock Door command is performed, it shall generate a LockOperation event with LockOperationType set to Unlatch when the unlatched state is reached and a LockOperation event with LockOperationType set to Unlock when the lock successfully completes the unlock → hold latch → release latch and return to unlock state operation.
• If the command fails during holding or releasing the latch but after passing the unlocked state, the door lock server shall generate a LockOperationError event with LockOperationType set to Unlatch and a LockOperation event with LockOperationType set to Unlock.
◦ If it fails before reaching the unlocked state, the door lock server shall generate only a
LockOperationError event with LockOperationType set to Unlock.
• Upon manual actuation, a door lock server that supports the Unbolting feature:
◦ shall generate a LockOperation event of LockOperationType Unlatch when it is actuated from the
outside.
◦ may generate a LockOperation event of LockOperationType Unlatch when it is actuated from the
inside.
ReadonlylockThe door lock server sends out a LockOperationError event when a lock operation fails for various reasons.
Supported features as a flag object.
ReadonlystateAccess the behavior's state.
ReadonlyactuatorIndicates if the lock is currently able to (Enabled) or not able to (Disabled) process remote Lock, Unlock, or Unlock with Timeout commands.
ReadonlylockThis attribute may be NULL if the lock hardware does not currently know the status of the locking mechanism. For example, a lock may not know the LockState status after a power cycle until the first lock actuation is completed.
The Not Fully Locked value is used by a lock to indicate that the state of the lock is somewhere between Locked and Unlocked so it is only partially secured. For example, a deadbolt could be partially extended and not in a dead latched state.
ReadonlylockIndicates the type of door lock as defined in LockTypeEnum.
ReadonlyoperatingIndicates the current operating mode of the lock as defined in OperatingModeEnum.
Optional ReadonlyalarmThis attribute is only supported if the Alarms cluster is on the same endpoint. The alarm mask is used to turn on/off alarms for particular functions. Alarms for an alarm group are enabled if the associated alarm mask bit is set. Each bit represents a group of alarms. Entire alarm groups can be turned on or off by setting or clearing the associated bit in the alarm mask.
This mask DOES NOT apply to the Events mechanism of this cluster.
Optional ReadonlyautoIndicates the number of seconds to wait after unlocking a lock before it automatically locks again. 0=disabled. If set, unlock operations from any source will be timed. For one time unlock with timeout use the specific command.
Optional ReadonlydefaultIndicates the default configurations as they are physically set on the device (example: hardware dip switch setting, etc…) and represents the default setting for some of the attributes within this cluster (for example: LED, Auto Lock, Sound Volume, and Operating Mode attributes).
This is a read-only attribute and is intended to allow clients to determine what changes may need to be made without having to query all the included attributes. It may be beneficial for the clients to know what the device’s original settings were in the event that the device needs to be restored to factory default settings.
If the Client device would like to query and modify the door lock server’s operating settings, it SHOULD send read and write attribute requests to the specific attributes.
For example, the Sound Volume attribute default value is Silent Mode. However, it is possible that the current Sound Volume is High Volume. Therefore, if the client wants to query/modify the current Sound Volume setting on the server, the client SHOULD read/write to the Sound Volume attribute.
Optional ReadonlyenableThis attribute shall enable/disable an inside LED that allows the user to see at a glance if the door is locked.
Optional ReadonlyenableThis attribute shall enable/disable local programming on the door lock of certain features (see LocalProgrammingFeatures attribute). If this value is set to TRUE then local programming is enabled on the door lock for all features. If it is set to FALSE then local programming is disabled on the door lock for those features whose bit is set to 0 in the LocalProgrammingFeatures attribute. Local programming shall be enabled by default.
Optional ReadonlyenableThis attribute shall enable/disable the ability to lock the door lock with a single touch on the door lock.
Optional ReadonlyenableThis attribute shall enable/disable a button inside the door that is used to put the lock into privacy mode. When the lock is in privacy mode it cannot be manipulated from the outside.
Optional Readonlylanguage?: stringIndicates the language for the on-screen or audible user interface using a 2- byte language code from ISO-639-1.
Optional ReadonlyledIndicates the settings for the LED support, as defined by LEDSettingEnum.
Optional ReadonlylocalIndicates the local programming features that will be disabled when EnableLocalProgramming attribute is set to False. If a door lock doesn’t support disabling one aspect of local programming it shall return CONSTRAINT_ERROR during a write operation of this attribute. If the EnableLocalProgramming attribute is set to True then all local programming features shall be enabled regardless of the bits set to 0 in this attribute.
The features that can be disabled from local programming are defined in LocalProgrammingFeaturesBitmap.
Optional ReadonlysoundIndicates the sound volume on a door lock as defined by SoundVolumeEnum.
ReadonlysupportedThis attribute shall contain a bitmap with all operating bits of the OperatingMode attribute supported by the lock. All operating modes NOT supported by a lock shall be set to one. The value of the OperatingMode enumeration defines the related bit to be set.
Static ReadonlyclusterBase cluster state include all attribute values but may be extended by subclasses.
Static ReadonlydefaultsStatic Optional ReadonlydependenciesStatic ReadonlyearlyStatic ReadonlyEventsStatic ReadonlyExtensionStatic ReadonlyidThe behavior ID for ClusterBehaviors is the name of the cluster.
Static ReadonlyInterfaceStatic ReadonlyInternalStatic ReadonlynameStatic Optional ReadonlyschemaStatic ReadonlyStateStatic ReadonlysupervisorStaticsupportsDoes this behavior support functionality of a specific implementation?
Release resources. This is the public API for releasing application resources held by behaviors in internal state.
ProtectedcallbackCreate a generic callback function that has the same properties as a Reactor.
Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!
Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.
This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.
Optional_options: {}This command causes the lock device to lock the door. This command includes an optional code for the lock. The door lock may require a PIN depending on the value of the RequirePINForRemoteOperation attribute.
† The PIN/RFID Code is an obsolete field name, use PINCode instead.
ProtectedreactInstall a Reactor.
Important: The reactor MUST be a real JS function - arrow functions will not work!
This command causes the lock device to unlock the door. This command includes an optional code for the lock. The door lock may require a code depending on the value of the RequirePINForRemoteOperation attribute.
NOTE
If the attribute AutoRelockTime is supported the lock will transition to the locked state when the auto relock time has expired.
† The PIN/RFID Code is an obsolete field name, use PINCode instead.
This command causes the lock device to unlock the door with a timeout parameter. After the time in seconds specified in the timeout field, the lock device will relock itself automatically. This timeout parameter is only temporary for this message transition and overrides the default relock time
as specified in the AutoRelockTime attribute. If the door lock device is not capable of or does not want to support temporary Relock Timeout, it SHOULD NOT support this optional command.
† The PIN/RFID Code is an obsolete field name, use PINCode instead.
StaticalterStaticenableStaticforStaticsetStaticwith
This is the default server implementation of DoorLockBehavior.