Console

RotationTrait 

struct RotationTrait

This trait belongs to devices that support rotation, which can be specified in percentage of a full rotation or in number of degrees. The default direction of a rotation is clockwise.

  • No supported events for RotationTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by RotationTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the RotationTrait.

    Declaration

    Swift

    let attributes: Google.RotationTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the RotationTrait.

    Declaration

    Swift

    struct Attributes

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Google.RotationTrait, rhs: Google.RotationTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The number of degrees that a device can rotate.

    Declaration

    Swift

    struct RotationDegreesRange

  • Whether the device supports the rotateToDegrees command for this trait.

    Declaration

    Swift

    var supportsRotateToDegreesCommand: Bool { get }

  • Sets the absolute rotation in degrees.

    Declaration

    Swift

    func rotateToDegrees(rotationDegrees: Float32) async throws

    Parameters

    rotationDegrees

    An absolute value that sets the final clockwise rotation of the device in number of degrees. This value must fall within the range specified in rotationDegreesRange.

  • The batchable version of rotateToDegrees command above.

    See also

    rotateToDegrees

    Declaration

    Swift

    func rotateToDegreesBatchable(rotationDegrees: Float32) throws -> BatchableCommand<Void>

  • Whether the device supports the rotateToPercentage command for this trait.

    Declaration

    Swift

    var supportsRotateToPercentageCommand: Bool { get }

  • Sets the absolute rotation in percentage.

    Declaration

    Swift

    func rotateToPercentage(rotationPercent: Float32) async throws

    Parameters

    rotationPercent

    An absolute value that sets the final clockwise rotation of the device in percentage of a full rotation.

  • The batchable version of rotateToPercentage command above.

    See also

    rotateToPercentage

    Declaration

    Swift

    func rotateToPercentageBatchable(rotationPercent: Float32) throws -> BatchableCommand<Void>

  • Rotation trait FeatureMap.

    Declaration

    Swift

    struct RotationFeature