MountTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface MountTrait.Attributes : ClusterStruct
Mount |
API for the Mount trait. |
Attributes for the Mount cluster.
Summary
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
List<UInt> |
A list of client-generated commands which are supported by this cluster server instance. |
List<UInt> |
A list of the attribute IDs of the attributes supported by the cluster instance. |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
MountTrait.Feature |
Whether the server supports zero or more optional cluster features. |
List<UInt> |
A list of server-generated commands (server to client) which are supported by this cluster server instance. |
MountTrait.MountDetectionTypeEnum? |
The method or mechanism used to detect and determine the current mount state. |
MountTrait.MountStateEnum? |
The physical attachment state of the device to the mount. |
String? |
Name of the detected mount type. |
MountTrait.MountTypeOverrideEnum? |
User-defined override to bypass automatic mount detection. |
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
acceptedCommandList
val acceptedCommandList: List<UInt>
A list of client-generated commands which are supported by this cluster server instance.
attributeList
val attributeList: List<UInt>
A list of the attribute IDs of the attributes supported by the cluster instance.
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
featureMap
val featureMap: MountTrait.Feature
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).
generatedCommandList
val generatedCommandList: List<UInt>
A list of server-generated commands (server to client) which are supported by this cluster server instance.
mountDetectionType
val mountDetectionType: MountTrait.MountDetectionTypeEnum?
The method or mechanism used to detect and determine the current mount state. Valid values are defined in MountDetectionTypeEnum.
Access type: Read
mountState
val mountState: MountTrait.MountStateEnum?
The physical attachment state of the device to the mount. Valid values are defined in MountStateEnum.
Access type: Read
mountTypeOverride
val mountTypeOverride: MountTrait.MountTypeOverrideEnum?
User-defined override to bypass automatic mount detection. This allows users to force the device to treat the mount as attached even if detection fails or if the mount is detached. Valid values are defined in MountTypeOverrideEnum.
Access type: Write