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

Overview

Input to the Identify triggerEffect command

Included Modules

Defined in:

matter/cluster/definitions/identify.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(data : Slice(UInt8)) #

[View source]

Instance Method Detail

def 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


[View source]
def 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


[View source]
def 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


[View source]
def 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


[View source]