Attributes

struct Attributes

Attributes for the BasicInformationTrait.

  • 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.BasicInformationTrait.Attributes, rhs: Matter.BasicInformationTrait.Attributes) -> Bool

    Parameters

    lhs

    A value to compare.

    rhs

    Another value to compare.

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

    Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var acceptedCommandList: [UInt32]? { get }
  • A list of the attribute IDs of the attributes supported by the cluster instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var attributeList: [UInt32]? { get }
  • The minimum guaranteed value for some system-wide resource capabilities that are not otherwise cluster-specific and do not appear elsewhere. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var capabilityMinima: Matter.BasicInformationTrait.CapabilityMinimaStruct? { get }
  • The revision of the server cluster specification supported by the cluster instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var clusterRevision: UInt16? { get }
  • The revision number of the data model against which the node is certified. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var dataModelRevision: UInt16? { get }
  • 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
  • Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero). Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var featureMap: UInt32? { get }
  • A list of server-generated commands (server to client) which are supported by this cluster server instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var generatedCommandList: [UInt32]? { get }
  • The version number of the hardware of the node. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var hardwareVersion: UInt16? { get }
  • The human-readable version number of the hardware of the node. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var hardwareVersionString: String? { get }
  • 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 trait identifier.

    Declaration

    Swift

    static var identifier: String { get }
  • If set to true, allow a local node configuration to be disabled. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var localConfigDisabled: Bool? { get }
  • The ISO 3166-1 alpha-2 code representing the country, dependent territory, or special area of geographic interest in which the node is located at the time of the attribute being set. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var location: String? { get }
  • The date that the node was manufactured. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var manufacturingDate: String? { get }
  • The maximum paths per invoke. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var maxPathsPerInvoke: UInt16? { get }
  • The user defined name for the node. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var nodeLabel: String? { get }
  • The human-readable (displayable) vendor assigned part number for the node whose meaning and numbering scheme is vendor defined. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var partNumber: String? { get }
  • The information about the appearance of the product. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var productAppearance: Matter.BasicInformationTrait.ProductAppearanceStruct? { get }
  • The Product ID assigned by the vendor that is unique to the specific product of the Node. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var productID: UInt16? { get }
  • The vendor specific human-readable (displayable) product label. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var productLabel: String? { get }
  • A human-readable (displayable) name of the model for the node such as the model number (or other identifier) assigned by the vendor. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var productName: String? { get }
  • The link to a product specific web page. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var productUrl: String? { get }
  • Indicates whether the node can be reached. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var reachable: Bool? { get }
  • The human-readable (displayable) serial number. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var serialNumber: String? { get }
  • The current version number for the software running on the node. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var softwareVersion: UInt32? { get }
  • The current human-readable representation for the software running on the node. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var softwareVersionString: String? { get }
  • The specification version. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var specificationVersion: UInt32? { get }
  • The unique identifier for the device, which is constructed in a manufacturer specific manner. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var uniqueID: String? { get }
  • The Vendor ID. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var vendorID: UInt16? { get }
  • A human-readable (displayable) name of the vendor for the node. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var vendorName: String? { get }