HomeDevice

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

A device supporting traits, commands, and subscriptions.

Summary

Public functions
`suspend DecommissionEligibility`	`checkDecommissionEligibility()` Checks if the device is eligible for decommissioning.
`suspend Set<Id>`	`decommissionDevice()` Initiates the decommissioning of this device.
`suspend Room?`	`room()` Gets the up-to-date `Room` this device is a part of.
`suspend HomeDevice`	`setName(name: String)` Sets the user-given name of this device.
`suspend Structure?`	`structure()` Gets the up-to-date `Structure` this device is a part of.

Public properties
`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<T?>`	`<T : DeviceType> typeOrNull(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 checkDecommissionEligibility(): DecommissionEligibility

Checks if the device is eligible for decommissioning.

Returns
`DecommissionEligibility`	a data class representing the device's eligibility for decommissioning.

suspend fun decommissionDevice(): Set<Id>

Initiates the decommissioning of this device. Throws an exception if the device is not eligible for decommissioning.

Returns
`Set<Id>`	the set of device IDs that were affected by the decommissioning of this device.

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 setName(name: String): HomeDevice

Sets the user-given name of this device.

Parameters
`name: String`	the new name for this device.

Returns
`HomeDevice`	an updated `HomeDevice`, with the new name, or previous name if the update failed.

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 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.