The implemented cluster.
ReadonlyeventsAccess the behavior's events.
ReadonlyallThis event shall be generated when ExpressedState attribute returns to Normal state.
ReadonlyendThis event shall be generated when the EndOfServiceAlert is set to Expired.
ReadonlyhardwareThis event shall be generated when the device detects a hardware fault that leads to setting HardwareFaultAlert to True.
ReadonlylowThis event shall be generated when BatteryAlert attribute changes to either Warning or Critical state.
ReadonlyselfThis event shall be generated when the SelfTest completes, and the attribute TestInProgress changes to False.
Optional ReadonlyalarmThis event shall be generated when the DeviceMuted attribute changes to Muted.
Optional ReadonlymuteThis event shall be generated when DeviceMuted attribute changes to NotMuted.
Supported features as a flag object.
ReadonlystateAccess the behavior's state.
ReadonlybatteryIndicates whether the power resource fault detection mechanism is currently triggered at the device. If the detection mechanism is triggered, this attribute shall be set to Warning or Critical, otherwise it shall be set to Normal. The battery state shall also be reflected in the Power Source cluster representing the device’s battery using the appropriate supported attributes and events.
ReadonlyendIndicates whether the end-of-service has been triggered at the device. This attribute shall be set to Expired when the device reaches the end-of-service.
ReadonlyexpressedIndicates the visibly- and audibly-expressed state of the alarm. When multiple alarm conditions are being reflected in the server, this attribute shall indicate the condition with the highest priority. Priority order of conditions is determined by the manufacturer and shall be supplied as a part of certification procedure. If the value of ExpressedState is not Normal, the attribute corresponding to the value shall NOT be Normal. For example, if the ExpressedState is set to SmokeAlarm, the value of the SmokeState will indicate the severity of the alarm (Warning or Critical). Clients SHOULD also read the other attributes to be aware of further alarm conditions beyond the one indicated in ExpressedState.
Visible expression is typically a LED light pattern. Audible expression is a horn or speaker pattern. Audible expression shall BE suppressed if the DeviceMuted attribute is supported and set to Muted.
ReadonlyhardwareIndicates whether the hardware fault detection mechanism is currently triggered. If the detection mechanism is triggered, this attribute shall be set to True, otherwise it shall be set to False.
ReadonlytestIndicates whether the device self-test is currently activated. If the device self- test is activated, this attribute shall be set to True, otherwise it shall be set to False.
Optional ReadonlydeviceIndicates the whether the audible expression of the device is currently muted. Audible expression is typically a horn or speaker pattern.
Optional ReadonlyinterconnectIndicates whether the interconnected CO alarm is currently triggering by branching devices. When the interconnected CO alarm is being triggered, this attribute shall be set to Warning or Critical, otherwise it shall be set to Normal.
Optional ReadonlyinterconnectIndicates whether the interconnected smoke alarm is currently triggering by branching devices. When the interconnected smoke alarm is being triggered, this attribute shall be set to Warning or Critical, otherwise it shall be set to Normal.
Optional ReadonlyexpiryIndicates the date when the device reaches its stated expiry date. After the ExpiryDate has been reached, the EndOfServiceAlert shall start to be triggered. To account for better customer experience across time zones, the EndOfServiceAlert may be delayed by up to 24 hours after the ExpiryDate. Similarly, clients may delay any actions based on the ExpiryDate by up to 24 hours to best align with the local time zone.
Static ReadonlyclusterBase cluster state include all attribute values but may be extended by subclasses.
Readonlyattributes: { ReadonlybatteryIndicates whether the power resource fault detection mechanism is currently triggered at the device. If the detection mechanism is triggered, this attribute shall be set to Warning or Critical, otherwise it shall be set to Normal. The battery state shall also be reflected in the Power Source cluster representing the device’s battery using the appropriate supported attributes and events.
ReadonlydeviceIndicates the whether the audible expression of the device is currently muted. Audible expression is typically a horn or speaker pattern.
ReadonlyendIndicates whether the end-of-service has been triggered at the device. This attribute shall be set to Expired when the device reaches the end-of-service.
ReadonlyexpiryIndicates the date when the device reaches its stated expiry date. After the ExpiryDate has been reached, the EndOfServiceAlert shall start to be triggered. To account for better customer experience across time zones, the EndOfServiceAlert may be delayed by up to 24 hours after the ExpiryDate. Similarly, clients may delay any actions based on the ExpiryDate by up to 24 hours to best align with the local time zone.
ReadonlyexpressedIndicates the visibly- and audibly-expressed state of the alarm. When multiple alarm conditions are being reflected in the server, this attribute shall indicate the condition with the highest priority. Priority order of conditions is determined by the manufacturer and shall be supplied as a part of certification procedure. If the value of ExpressedState is not Normal, the attribute corresponding to the value shall NOT be Normal. For example, if the ExpressedState is set to SmokeAlarm, the value of the SmokeState will indicate the severity of the alarm (Warning or Critical). Clients SHOULD also read the other attributes to be aware of further alarm conditions beyond the one indicated in ExpressedState.
Visible expression is typically a LED light pattern. Audible expression is a horn or speaker pattern. Audible expression shall BE suppressed if the DeviceMuted attribute is supported and set to Muted.
ReadonlyhardwareIndicates whether the hardware fault detection mechanism is currently triggered. If the detection mechanism is triggered, this attribute shall be set to True, otherwise it shall be set to False.
ReadonlyinterconnectIndicates whether the interconnected CO alarm is currently triggering by branching devices. When the interconnected CO alarm is being triggered, this attribute shall be set to Warning or Critical, otherwise it shall be set to Normal.
ReadonlyinterconnectIndicates whether the interconnected smoke alarm is currently triggering by branching devices. When the interconnected smoke alarm is being triggered, this attribute shall be set to Warning or Critical, otherwise it shall be set to Normal.
ReadonlytestIndicates whether the device self-test is currently activated. If the device self- test is activated, this attribute shall be set to True, otherwise it shall be set to False.
Readonlycommands: { ReadonlyselfThis command shall initiate a device self-test. The return status shall indicate whether the test was successfully initiated. Only one SelfTestRequest may be processed at a time. When the value of the ExpressedState attribute is any of SmokeAlarm, COAlarm, Testing, InterconnectSmoke, Inter
connectCO, the device shall NOT execute the self-test, and shall return status code BUSY.
Upon successful acceptance of SelfTestRequest, the TestInProgress attribute shall be set to True and ExpressedState attribute shall be set to Testing. Any faults identified during the test shall be reflected in the appropriate attributes and events. Upon completion of the self test procedure, the SelfTestComplete event shall be generated, the TestInProgress attribute shall be set to False and ExpressedState attribute shall be updated to reflect the current state of the server.
Readonlyevents: { ReadonlyalarmThis event shall be generated when the DeviceMuted attribute changes to Muted.
ReadonlyallThis event shall be generated when ExpressedState attribute returns to Normal state.
ReadonlyendThis event shall be generated when the EndOfServiceAlert is set to Expired.
ReadonlyhardwareThis event shall be generated when the device detects a hardware fault that leads to setting HardwareFaultAlert to True.
ReadonlylowThis event shall be generated when BatteryAlert attribute changes to either Warning or Critical state.
ReadonlymuteThis event shall be generated when DeviceMuted attribute changes to NotMuted.
ReadonlyselfThis event shall be generated when the SelfTest completes, and the attribute TestInProgress changes to False.
Readonlyextensions: readonly [{ This metadata controls which SmokeCoAlarmCluster elements matter.js activates for specific feature combinations.
Readonlyfeatures: { Readonlyid: 92Readonlyname: "SmokeCoAlarm"Readonlyrevision: 1Static 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: {}ProtectedreactInstall a Reactor.
Important: The reactor MUST be a real JS function - arrow functions will not work!
This command shall initiate a device self-test. The return status shall indicate whether the test was successfully initiated. Only one SelfTestRequest may be processed at a time. When the value of the ExpressedState attribute is any of SmokeAlarm, COAlarm, Testing, InterconnectSmoke, Inter
connectCO, the device shall NOT execute the self-test, and shall return status code BUSY.
Upon successful acceptance of SelfTestRequest, the TestInProgress attribute shall be set to True and ExpressedState attribute shall be set to Testing. Any faults identified during the test shall be reflected in the appropriate attributes and events. Upon completion of the self test procedure, the SelfTestComplete event shall be generated, the TestInProgress attribute shall be set to False and ExpressedState attribute shall be updated to reflect the current state of the server.
StaticalterStaticenableStaticforStaticsetStaticwith
This is the default server implementation of SmokeCoAlarmBehavior.
The Matter specification requires the SmokeCoAlarm cluster to support features we do not enable by default. You should use SmokeCoAlarmServer.with to specialize the class for the features your implementation supports.