The implemented cluster.
Access the behavior's events.
Supported features as a flag object.
Protected
internalAccess the behavior's state.
Static
Readonly
clusterBase cluster state include all attribute values but may be extended by subclasses.
Static
Readonly
defaultsStatic
Optional
Readonly
dependenciesStatic
Readonly
earlyStatic
Readonly
ExtensionStatic
Readonly
idThe behavior ID for ClusterBehaviors is the name of the cluster.
Static
Readonly
InterfaceStatic
Readonly
nameStatic
Optional
Readonly
schemaStatic
Readonly
supervisorStatic
supportsDoes this behavior support functionality of a specific implementation?
Protected
callbackCreate 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!
This command starts or stops the receiving device identifying itself.
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.
Protected
reactInstall a Reactor.
Important: The reactor MUST be a real JS function - arrow functions will not work!
This command allows the support of feedback to the user, such as a certain light effect. It is used to allow an implementation to provide visual feedback to the user under certain circumstances such as a color light turning green when it has successfully connected to a network. The use of this command and the effects themselves are entirely up to the implementer to use whenever a visual feedback is useful but it is not the same as and does not replace the identify mechanism used during commissioning.
Static
alterStatic
enableStatic
forStatic
setStatic
with
This is the default server implementation of IdentifyBehavior.
This implementation includes all features of Identify.Cluster and implements all mandatory commands. You should use IdentifyServer.with to specialize the class for the features your implementation supports. Alternatively you can extend this class and override the methods you need to change or add mandatory commands.
Beside the standard state values the following additional state values are available:
isIdentifying
- Indicates if the device is currently identifying.Beside the standard events the following additional events are available:
startIdentifying
- Emitted when the device starts identifying. Use it e.g to start your own identifying logic.stopIdentifying
- Emitted when the device stops identifying.