struct
Matter::Cluster::Definitions::OnOff::OffWithEffectRequest
- Matter::Cluster::Definitions::OnOff::OffWithEffectRequest
- Struct
- Value
- Object
Overview
Input to the OnOff offWithEffect command
Included Modules
- TLV::Serializable
Defined in:
matter/cluster/definitions/on_off.crConstructors
Instance Method Summary
-
#effect_identifier : EffectIdentifier
The EffectIdentifier field specifies the fading effect to use when turning the device off.
-
#effect_identifier=(effect_identifier : EffectIdentifier)
The EffectIdentifier field specifies the fading effect to use when turning the device off.
-
#effect_variant : UInt8
The EffectVariant field is used to indicate which variant of the effect, indicated in the EffectIdentifier field, SHOULD be triggered.
-
#effect_variant=(effect_variant : UInt8)
The EffectVariant field is used to indicate which variant of the effect, indicated in the EffectIdentifier field, SHOULD be triggered.
Constructor Detail
Instance Method Detail
The EffectIdentifier field specifies the fading effect to use when turning the device off. This field shall contain one of the non-reserved values listed in Values of the EffectIdentifier Field of the OffWithEffect Command.
The EffectIdentifier field specifies the fading effect to use when turning the device off. This field shall contain one of the non-reserved values listed in Values of the EffectIdentifier Field of the OffWithEffect Command.
The EffectVariant field is used to indicate which variant of the effect, indicated in the EffectIdentifier field, SHOULD be triggered. If the server does not support the given variant, it shall use the default variant. This field is dependent on the value of the EffectIdentifier field and shall contain one of the non-reserved values listed in Values of the EffectVariant Field of the OffWithEffect Command.
The EffectVariant field is used to indicate which variant of the effect, indicated in the EffectIdentifier field, SHOULD be triggered. If the server does not support the given variant, it shall use the default variant. This field is dependent on the value of the EffectIdentifier field and shall contain one of the non-reserved values listed in Values of the EffectVariant Field of the OffWithEffect Command.