ClosureDimension

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ClosureDimension : ClosureDimensionTrait.Attributes, MatterTrait, ClosureDimensionCommands


API for the ClosureDimension trait. This trait provides an interface for controlling a single degree of freedom (also referred to as a dimension or an axis) of a composed closure. Some device types may define that a Closure Dimension trait instance is associated with a corresponding Closure Control trait instance on the same device. In such cases, the Closure Dimension trait does not operate independently, rather, it relies on the Closure Control trait for supervisory logic.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public properties

open TraitFactory<ClosureDimension>

Inherited functions

From com.google.home.matter.standard.ClosureDimensionCommands
suspend Unit

Moves a dimension of the closure to a target position.

BatchableCommand<Unit>

The batchable version of setTarget command.

suspend Unit
step(
    direction: ClosureDimensionTrait.StepDirectionEnum,
    numberOfSteps: UShort,
    optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit
)

Moves a dimension of the closure by a specified number of steps to a target position.

BatchableCommand<Unit>
stepBatchable(
    direction: ClosureDimensionTrait.StepDirectionEnum,
    numberOfSteps: UShort,
    optionalArgs: ClosureDimensionTrait.StepCommand.OptionalArgs.() -> Unit
)

The batchable version of step command.

From com.google.home.matter.standard.ClosureDimensionTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.matter.standard.ClosureDimensionTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

UShort

The revision of the server cluster specification supported by the cluster instance.

ClosureDimensionTrait.DimensionStateStruct?

The current state of the closure dimension, including its Latch, Position, and Speed, as defined in the DimensionStateStruct.

ClosureDimensionTrait.Feature

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

ClosureDimensionTrait.LatchControlModesBitmap?

Whether the latch mechanism can be latched or unlatched remotely, as defined in the LatchControlModesBitmap.

ClosureDimensionTrait.RangePercent100thsStruct?

The range of possible values for the Position field in the CurrentState attribute.

ClosureDimensionTrait.ModulationTypeEnum?

The modulation type of the closure dimension, as defined in the ModulationTypeEnum.

ClosureDimensionTrait.OverflowEnum?

The overflow direction of the closure, as defined in the OverflowEnum.

UShort?

The minimal acceptable change to the Position field of the targetState and currentState attributes.

ClosureDimensionTrait.RotationAxisEnum?

The axis of rotation for the closure dimension, as defined in the RotationAxisEnum.

UShort?

The size of a single step, in hundredths of a percent.

ClosureDimensionTrait.DimensionStateStruct?

The target state of the closure dimension, including its Latch, Position, and Speed, as defined in the DimensionStateStruct.

ClosureDimensionTrait.TranslationDirectionEnum?

The direction of translation for the closure dimension, as defined in the TranslationDirectionEnum.

ClosureDimensionTrait.ClosureUnitEnum?

The unit related to the position of the closure, where the unit is defined in ClosureUnitEnum.

ClosureDimensionTrait.UnitRangeStruct?

The physical range of the closure's movement, expressed as minimum and maximum values of the unit of measurement.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: ClosureDimension.Attribute): Boolean

supports

fun supports(command: ClosureDimension.Command): Boolean

Public properties

factory

open val factoryTraitFactory<ClosureDimension>