ServiceAreaTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ServiceAreaTrait.Attributes : ClusterStruct
ServiceArea |
API for the ServiceArea trait. |
Attributes for the ServiceArea 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. |
UInt? |
The area where the device is currently located, regardless of whether it is operating. |
UInt? |
The estimated Unix epoch time for completing service in the area, indicated by the |
ServiceAreaTrait.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. |
List<ServiceAreaTrait.ProgressStruct>? |
The operating status of one or more areas. |
List<UInt>? |
The set of areas where the device should attempt to operate. |
List<ServiceAreaTrait.AreaStruct>? |
The list of supported service areas for the device. |
List<ServiceAreaTrait.MapStruct>? |
The list of supported maps for the device. |
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.
currentArea
val currentArea: UInt?
The area where the device is currently located, regardless of whether it is operating. If the device is not mobile and can operate in multiple areas sequentially, this attribute indicates the area that is currently being serviced or the area that is currently traversed by the device.
Access type: Read
estimatedEndTime
val estimatedEndTime: UInt?
The estimated Unix epoch time for completing service in the area, indicated by the currentArea attribute. A value of 0 means that the operation has completed.
Access type: Read
featureMap
val featureMap: ServiceAreaTrait.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.
progress
val progress: List<ServiceAreaTrait.ProgressStruct>?
The operating status of one or more areas. Each entry in this list has a unique value for the AreaID field in ProgressStruct.
Access type: Read
selectedAreas
val selectedAreas: List<UInt>?
The set of areas where the device should attempt to operate. Mobile devices may travel without operating across any areas while attempting to reach the areas indicated by the SelectedAreas attribute. For example, a robotic vacuum cleaner may drive without cleaning when traveling without operating. If this attribute is empty, the device is not constrained to operate in any specific areas.
Access type: Read
supportedAreas
val supportedAreas: List<ServiceAreaTrait.AreaStruct>?
The list of supported service areas for the device. Each item in this list represents a unique area, as indicated by the AreaID field of AreaStruct.
Access type: Read
supportedMaps
val supportedMaps: List<ServiceAreaTrait.MapStruct>?
The list of supported maps for the device. Each item in this list represents a unique map, as indicated by the MapID field of MapStruct. A map is a full or partial representation of a home known to the device. Each map includes one or more areas.
Access type: Read