BasicInformation

interface BasicInformation : BasicInformationTrait.Attributes, MatterTrait, Updatable, BasicInformationCommands


API for the BasicInformation trait. This trait provides attributes and events for determining basic information about nodes.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public properties

open TraitFactory<BasicInformation>

Inherited functions

From com.google.home.matter.standard.BasicInformationCommands
suspend Unit

Send a manufacturer specific ping.

From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend BasicInformation

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties

From com.google.home.matter.standard.BasicInformationTrait.Attributes
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.

BasicInformationTrait.CapabilityMinimaStruct?

The minimum guaranteed value for some system-wide resource capabilities that are not otherwise cluster-specific and do not appear elsewhere.

UShort

The revision of the server cluster specification supported by the cluster instance.

UShort?

The revision number of the data model against which the node is certified.

UInt

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.

UShort?

The version number of the hardware of the node.

String?

The human-readable version number of the hardware of the node.

Boolean?

If set to true, allow a local node configuration to be disabled.

String?

The ISO 3166-1 alpha-2 code representing the country, dependent territory, or special area of geographic interest in which the node is located at the time of the attribute being set.

String?

The date that the node was manufactured.

UShort?

The maximum paths per invoke.

String?

The user defined name for the node.

String?

The human-readable (displayable) vendor assigned part number for the node whose meaning and numbering scheme is vendor defined.

BasicInformationTrait.ProductAppearanceStruct?

The information about the appearance of the product.

UShort?

The Product ID assigned by the vendor that is unique to the specific product of the Node.

String?

The vendor specific human-readable (displayable) product label.

String?

A human-readable (displayable) name of the model for the node such as the model number (or other identifier) assigned by the vendor.

String?

The link to a product specific web page.

Boolean?

Indicates whether the node can be reached.

String?

The human-readable (displayable) serial number.

UInt?

The current version number for the software running on the node.

String?

The current human-readable representation for the software running on the node.

UInt?

The specification version.

String?

The unique identifier for the device, which is constructed in a manufacturer specific manner.

UShort?

The Vendor ID.

String?

A human-readable (displayable) name of the vendor for the node.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: BasicInformation.Attribute): Boolean

supports

fun supports(command: BasicInformation.Command): Boolean

Public properties

factory

open val factoryTraitFactory<BasicInformation>