Console

ServiceAreaTrait 

struct ServiceAreaTrait

This trait provides an interface for controlling the areas where a device should operate, for reporting the status at each area, and for querying the current area.

  • No supported events for ServiceAreaTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ServiceAreaTrait.

    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 ServiceAreaTrait.

    Declaration

    Swift

    let attributes: Matter.ServiceAreaTrait.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 ServiceAreaTrait.

    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: Matter.ServiceAreaTrait, rhs: Matter.ServiceAreaTrait) -> 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)

  • Data describing the location of an area.

    Declaration

    Swift

    struct LocationDescriptorStruct

  • The data from this structure indicates a landmark and device position relative to the landmark.

    Declaration

    Swift

    struct LandmarkInfoStruct

  • The name and semantic data describing an area.

    Declaration

    Swift

    struct AreaInfoStruct

  • Data about an area known to the server.

    Declaration

    Swift

    struct AreaStruct

  • A struct representing a map.

    Declaration

    Swift

    struct MapStruct

  • Data about the operating status of an area.

    Declaration

    Swift

    struct ProgressStruct

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

    Declaration

    Swift

    var supportsSelectAreasCommand: Bool { get }

  • Selects the areas where the device should attempt to operate.

    Declaration

    Swift

    func selectAreas(newAreas: [UInt32]) async throws -> Matter.ServiceAreaTrait.SelectAreasCommandResponse

    Parameters

    newAreas

    The list of areas where the device should attempt to operate.

    Return Value

    The result of the completed SelectAreas command.

  • The batchable version of selectAreas command above.

    See also

    selectAreas

    Declaration

    Swift

    func selectAreasBatchable(newAreas: [UInt32]) throws -> BatchableCommand<Matter.ServiceAreaTrait.SelectAreasCommandResponse>

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

    Declaration

    Swift

    var supportsSkipAreaCommand: Bool { get }

  • Indicates to the device that the area specified by the areaID field should be skipped.

    Declaration

    Swift

    func skipArea(skippedArea: UInt32) async throws -> Matter.ServiceAreaTrait.SkipAreaCommandResponse

    Parameters

    skippedArea

    The area to skip, and to attempt operating in other areas on the supportedAreas attribute list.

    Return Value

    The result of the completed SkipArea command.

  • The batchable version of skipArea command above.

    See also

    skipArea

    Declaration

    Swift

    func skipAreaBatchable(skippedArea: UInt32) throws -> BatchableCommand<Matter.ServiceAreaTrait.SkipAreaCommandResponse>

  • The operational status of the device for an area.

    Declaration

    Swift

    enum OperationalStatusEnum

  • The status of the SelectAreas command.

    Declaration

    Swift

    enum SelectAreasStatus

  • The status of the SkipArea command.

    Declaration

    Swift

    enum SkipAreaStatus

  • ServiceArea cluster FeatureMap.

    Declaration

    Swift

    struct Feature