Console

ZoneManagementTrait 

struct ZoneManagementTrait

This trait provides an interface to manage regions of interest, known as zones, which can be defined by either the manufacturer or the end user. This is a minimalistic custom version of the ZoneManagement standard Matter cluster, and provides functionality for some of the zone settings.

  • List of the event types that are supported by ZoneManagementTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ZoneManagementTrait.

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

    Declaration

    Swift

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

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

  • Encodes a point on the two-dimensional Cartesian plane for the TwoDCartesianZone feature.

    Declaration

    Swift

    struct TwoDCartesianVertexStruct

  • Encodes all information needed to define a TwoDCartesianZone.

    Declaration

    Swift

    struct TwoDCartesianZoneStruct

  • Encodes basic information about a zone without containing the specifics of how the zone is defined.

    Declaration

    Swift

    struct ZoneInformationStruct

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

    Declaration

    Swift

    var supportsCreateTwoDCartesianZoneCommand: Bool { get }

  • Creates and stores a two-dimensional Cartesian zone.

    Declaration

    Swift

    func createTwoDCartesianZone(zone: Matter.ZoneManagementTrait.TwoDCartesianZoneStruct) async throws -> Matter.ZoneManagementTrait.CreateTwoDCartesianZoneCommandResponse

    Parameters

    zone

    A TwoDCartesianZoneStruct value representing all information required to define the two-dimensional Cartesian zone.

    Return Value

    The result of the CreateTwoDCartesianZone command.

  • The batchable version of createTwoDCartesianZone command above.

    See also

    createTwoDCartesianZone

    Declaration

    Swift

    func createTwoDCartesianZoneBatchable(zone: Matter.ZoneManagementTrait.TwoDCartesianZoneStruct) throws -> BatchableCommand<Matter.ZoneManagementTrait.CreateTwoDCartesianZoneCommandResponse>

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

    Declaration

    Swift

    var supportsUpdateTwoDCartesianZoneCommand: Bool { get }

  • Updates a stored two-dimensional Cartesian zone. When updating the default zone (zoneID = 0), only the use field within the provided TwoDCartesianZoneStruct can be modified.

    Declaration

    Swift

    func updateTwoDCartesianZone(zoneID: UInt16, zone: Matter.ZoneManagementTrait.TwoDCartesianZoneStruct) async throws

    Parameters

    zone

    A TwoDCartesianZoneStruct value representing updated zone information.

  • The batchable version of updateTwoDCartesianZone command above.

    See also

    updateTwoDCartesianZone

    Declaration

    Swift

    func updateTwoDCartesianZoneBatchable(zoneID: UInt16, zone: Matter.ZoneManagementTrait.TwoDCartesianZoneStruct) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsRemoveZoneCommand: Bool { get }

  • Removes the user-defined zone indicated by the ZoneID. The default zone with zoneID = 0 cannot be removed.

    Declaration

    Swift

    func removeZone(zoneID: UInt16) async throws

  • The batchable version of removeZone command above.

    See also

    removeZone

    Declaration

    Swift

    func removeZoneBatchable(zoneID: UInt16) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsCreateOrUpdateTriggerCommand: Bool { get }

  • The batchable version of createOrUpdateTrigger command above.

    See also

    createOrUpdateTrigger

    Declaration

    Swift

    func createOrUpdateTriggerBatchable(trigger: Matter.ZoneManagementTrait.ZoneTriggerControlStruct) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsRemoveTriggerCommand: Bool { get }

  • The batchable version of removeTrigger command above.

    See also

    removeTrigger

    Declaration

    Swift

    func removeTriggerBatchable(zoneID: UInt16) throws -> BatchableCommand<Void>

  • The source of the zone.

    Declaration

    Swift

    enum ZoneSourceEnum

  • The type of the zone.

    Declaration

    Swift

    enum ZoneTypeEnum

  • The intended use of the zone.

    Declaration

    Swift

    enum ZoneUseEnum