struct

Matter::Cluster::Definitions::Identify::TriggerEffectRequest

Inherits TLV::Serializable < Struct < Value < Object

Input to the Identify triggerEffect command

Constructors

new(effect_identifier : EffectIdentifier, effect_variany : EffectVariant)
Source
new(any : TLV::Any)
Source

Class methods

from_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian)
Source
from_slice(bytes : Bytes)
Source
from_tlv(any : TLV::Any)
Source
from_tlv(data : Bytes)
Source

Instance methods

effect_identifier

This field specifies the identify effect to use. All values of the EffectIdentifier shall be supported. Implementors may deviate from the example light effects in the table below, but they SHOULD indicate during testing how they handle each effect.

This field shall contain one of the non-reserved values listed below.

Table 3. Values of the EffectIdentifier Field of the TriggerEffect Command

Source
effect_identifier=(effect_identifier : EffectIdentifier)

This field specifies the identify effect to use. All values of the EffectIdentifier shall be supported. Implementors may deviate from the example light effects in the table below, but they SHOULD indicate during testing how they handle each effect.

This field shall contain one of the non-reserved values listed below.

Table 3. Values of the EffectIdentifier Field of the TriggerEffect Command

Source
effect_variany

This field is used to indicate which variant of the effect, indicated in the EffectIdentifier field, SHOULD be triggered. If a device does not support the given variant, it shall use the default variant. This field shall contain one of the values listed below:

Table 4. Values of the EffectVariant Field of the TriggerEffect Command

Source
effect_variany=(effect_variany : EffectVariant)

This field is used to indicate which variant of the effect, indicated in the EffectIdentifier field, SHOULD be triggered. If a device does not support the given variant, it shall use the default variant. This field shall contain one of the values listed below:

Table 4. Values of the EffectVariant Field of the TriggerEffect Command

Source
to_io(io : IO, format : IO::ByteFormat = IO::ByteFormat::LittleEndian) : Nil
Source
to_slice
Source
to_tlv(outer_tag : Nil | UInt8 | Tuple(UInt16, UInt16) | Tuple(UInt16, UInt16, UInt16) = nil) : TLV::Any
Source