HomeDevice

interface HomeDevice : HasId, HasTraits, HasDeviceTypes, HasConnectivityState, HasCandidates

A device supporting traits, commands, and subscriptions.

Summary

Public functions
`suspend Room?`	`room()` Gets the up-to-date `Room` this device is a part of.
`suspend Structure?`	`structure()` Gets the up-to-date `Structure` this device is a part of.

Public properties
`Boolean`	`isInRoom` If this device is in a `Room`.
`Boolean`	`isInStructure` If this device is in a `Structure`.
`Boolean`	`isMatterDevice` If this device is backed by Matter.
`String`	`name` The user-given name of this device.
`Id?`	`roomId` The ID of the `Room` this device is a part of.
`Id?`	`structureId` The ID of the `Structure` this device is a part of.

`Flow<Set<NodeCandidate>>`	`allCandidates()` Returns all the automation `NodeCandidate` instances for the receiver and its child objects.
`Flow<Set<NodeCandidate>>`	`candidates()` Returns all the automation `NodeCandidate` instances for the receiver.

`Boolean`	`<T : DeviceType> has(type: DeviceTypeFactory<T>)` Checks if a device type is supported by this device.
`Flow<T>`	`<T : DeviceType> type(type: DeviceTypeFactory<T>)` Gets a flow on the `DeviceType` using the given `DeviceTypeFactory`.
`Flow<Set<DeviceType>>`	`types()` Gets a list of all available types on the `HomeDevice`.

`SourceConnectivity?`	`<T : Trait> getSourceConnectivity(trait: TraitFactory<T>)` Gets metadata, such as network locality and connectivity state, about the source of data for a particular trait.
`Boolean`	`<T : Trait> has(trait: TraitFactory<T>)` Checks if a trait is supported by a device.

SourceConnectivity

sourceConnectivity

Source Connectivity for the device.

`Id`	`id` Opaque ID for the object.

suspend fun room(): Room?

Gets the up-to-date Room this device is a part of.

Returns
`Room?`	the Room this device is a part of, or null if the device is not in a Room.

suspend fun structure(): Structure?

Gets the up-to-date Structure this device is a part of.

Returns
`Structure?`	the Structure this device is a part of, or null if the device is not in a Structure.

val isInRoom: Boolean

If this device is in a Room.

val isInStructure: Boolean

If this device is in a Structure.

val isMatterDevice: Boolean

If this device is backed by Matter.

val name: String

The user-given name of this device.

val roomId: Id?

The ID of the Room this device is a part of. Null if the device is not in a Room.

val structureId: Id?

The ID of the Structure this device is a part of. Null if the device is not in a Structure.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-06 UTC.

For devices
- Matter
  New IP-based smart home connectivity protocol that enables broad interoperability with many ecosystems
- Cloud-to-cloud
  Connect your cloud backend with the Smart Home API
- Find out which integration to build
  We’ll recommend an integration based on your device and needs
For apps, platforms & services
- Home APIs
  Access over 600M devices, hubs for Google Home and Matter infrastructure, and an automation engine powered by Google intelligence
Use cases
Business resources
Console
- Developer Console
- Support
- Stack Overflow
- Google Nest Community