struct Attributes
Attributes for the ModeSelectTrait
.
-
A list of the attribute IDs of the attributes supported by the cluster instance. Nullable: false.
Declaration
Swift
@TraitAttribute var attributeList: [UInt32]? { get }
-
Describes the purpose of the mode in this cluster instance. Nullable: false.
Declaration
Swift
@TraitAttribute var description: String? { get }
-
The single standard namespace for any standard semantic tag value supported in this or any other cluster instance with the same namespace. A null value means there is no namespace for this cluster instance, and that there are no semantic tags. Nullable: true.
Declaration
Swift
@TraitAttribute var standardNamespace: UInt16? { get }
-
The list of supported modes for the cluster instance. Nullable: false.
Declaration
Swift
@TraitAttribute var supportedModes: [Matter.ModeSelectTrait.ModeOptionStruct]? { get }
-
The current mode of a cluster instance on a device. This must be one of the values in
ModeOptionStruct
. Nullable: false.Declaration
Swift
@TraitAttribute var currentMode: UInt8? { get }
-
The desired startup mode for the device when it is supplied with power. Nullable: true.
Declaration
Swift
@TraitAttribute var startUpMode: UInt8? { get }
-
The value of the
currentMode
that depends on the state of anOnOff
cluster on the same endpoint. If theOnOff
cluster changes itsonOff
attribute fromoff
toon
, thecurrentMode
is changed to this value. Enabled by theonOff
feature. Nullable: true.Declaration
Swift
@TraitAttribute var onMode: UInt8? { 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 }
-
A list of client-generated commands which are supported by this cluster server instance.
Nullable: false.
Declaration
Swift
@TraitAttribute var acceptedCommandList: [UInt32]? { get }
-
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: Matter.ModeSelectTrait.Feature? { get }
-
The revision of the server cluster specification supported by the cluster instance. Nullable: false.
Declaration
Swift
@TraitAttribute var clusterRevision: UInt16? { get }
-
The trait identifier.
Declaration
Swift
static var identifier: String { get }
-
Writes this object to the given
TraitEncoder
. ThrowsHomeError.encodingFailed
if the data could not be encoded.Declaration
Swift
func encode(with encoder: TraitEncoder) throws
-
Returns a Boolean value indicating whether two values are equal.
Equality is the inverse of inequality. For any values
a
andb
,a == b
implies thata != b
isfalse
.Declaration
Swift
static func == (lhs: Matter.ModeSelectTrait.Attributes, rhs: Matter.ModeSelectTrait.Attributes) -> 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. Callhasher.combine(_:)
with each of these components.Important
In your implementation of
hash(into:)
, don’t callfinalize()
on thehasher
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)