ClosureControl

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ClosureControl : ClosureControlTrait.Attributes, MatterTrait, ClosureControlCommands

API for the ClosureControl trait. This trait provides an interface for controlling a closure.

Summary

Nested types
`enum ClosureControl.Attribute : Enum, Field` Descriptor enum for this trait's attributes.
`enum ClosureControl.Command : Enum` Descriptor enum for this trait's commands.
`class ClosureControl.EngageStateChangedEvent : Event, ClosureControlTrait.EngageStateChanged`
`enum ClosureControl.EngageStateChangedEvent.EventFields : Enum, Field` Descriptor enum for this event's fields.
`class ClosureControl.MovementCompletedEvent : Event, ClosureControlTrait.MovementCompleted`
`enum ClosureControl.MovementCompletedEvent.EventFields : Enum, Field` Descriptor enum for this event's fields.
`class ClosureControl.OperationalErrorEvent : Event, ClosureControlTrait.OperationalError`
`enum ClosureControl.OperationalErrorEvent.EventFields : Enum, Field` Descriptor enum for this event's fields.
`class ClosureControl.SecureStateChangedEvent : Event, ClosureControlTrait.SecureStateChanged`
`enum ClosureControl.SecureStateChangedEvent.EventFields : Enum, Field` Descriptor enum for this event's fields.

Public functions
`Boolean`	`supports(attribute: ClosureControl.Attribute)`
`Boolean`	`supports(command: ClosureControl.Command)`

Public properties
`open TraitFactory<ClosureControl>`	`factory`

`suspend Unit`	`calibrate()` Initiates a calibration of the closure.
`BatchableCommand<Unit>`	`calibrateBatchable()` The batchable version of `calibrate` command.
`suspend Unit`	`moveTo(optionalArgs: ClosureControlTrait.MoveToCommand.OptionalArgs.() -> Unit)` The closure updates its position, latch state and motion speed.
`BatchableCommand<Unit>`	`moveToBatchable(optionalArgs: ClosureControlTrait.MoveToCommand.OptionalArgs.() -> Unit)` The batchable version of `moveTo` command.
`suspend Unit`	`stop()` Stops the closure.
`BatchableCommand<Unit>`	`stopBatchable()` The batchable version of `stop` command.

`open StructDescriptor`	`@HomeExperimentalGenericApi getDescriptor()` Returns the descriptor for the struct.
`open Any?`	`@HomeExperimentalGenericApi getFieldValueById(tagId: UInt)` Returns the value of the field for the given tag ID.

suspend Unit

forceRead()

`List<UInt>`	`acceptedCommandList` A list of client-generated commands which are supported by this cluster server instance.
`List<UInt>`	`attributeList` A list of the attribute IDs of the attributes supported by the cluster instance.
`UShort`	`clusterRevision` The revision of the server cluster specification supported by the cluster instance.
`UInt?`	`countdownTime` The estimated time remaining, in seconds, before the operation is complete.
`List<ClosureControlTrait.ClosureErrorEnum>?`	`currentErrorList` A list of active errors.
`ClosureControlTrait.Feature`	`featureMap` Whether the server supports zero or more optional cluster features.
`List<UInt>`	`generatedCommandList` A list of server-generated commands (server to client) which are supported by this cluster server instance.
`ClosureControlTrait.LatchControlModesBitmap?`	`latchControlModes` Whether the latch mechanism can be latched or unlatched remotely.
`ClosureControlTrait.MainStateEnum?`	`mainState` The current operational state of the closure.
`ClosureControlTrait.OverallCurrentStateStruct?`	`overallCurrentState` The current `Position`, `Latch`, and `Speed` states, whichever are applicable based on the feature flags set.
`ClosureControlTrait.OverallTargetStateStruct?`	`overallTargetState` The `TargetPosition`, `TargetLatch`, `TargetSpeed` values, whichever are applicable according to the feature flags set.

Trait.TraitMetadata

metadata

fun supports(attribute: ClosureControl.Attribute): Boolean

fun supports(command: ClosureControl.Command): Boolean

open val factory: TraitFactory<ClosureControl>