PowerSource

@Generated(value = ["GoogleHomePlatformCodegen"])
interface PowerSource : PowerSourceTrait.Attributes, MatterTrait


API for the PowerSource trait. This trait provides an interface to devices that provide power to other devices.

Summary

Public functions

Boolean

Public properties

open TraitFactory<PowerSource>

Inherited functions

From com.google.home.matter.standard.PowerSourceTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.matter.standard.PowerSourceTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<PowerSourceTrait.BatChargeFaultEnum>?

Indicates the set of battery charge faults currently detected by the device on this power source.

List<PowerSourceTrait.BatFaultEnum>?

Indicates the set of battery faults currently detected by the device on this power source.

List<PowerSourceTrait.WiredFaultEnum>?

The set of wired faults currently detected by the device on this power source.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

String?

The string representing the ANSI designation for the battery, as specified in ANSI C18.

PowerSourceTrait.BatApprovedChemistryEnum?

ID of the preferred chemistry of the battery source, as specified in BatApprovedChemistryEnum.

UInt?

The preferred minimum charge capacity rating in milliampere-hours of battery cells or packs in the battery source.

PowerSourceTrait.BatChargeLevelEnum?

The ranking of the charge level of the battery used to indicate when intervention is required, as specified in BatChargeLevelEnum.

PowerSourceTrait.BatChargeStateEnum?

The state of the battery charge, as specified in BatChargeStateEnum.

UInt?

The assessed current in milliamps being supplied to charge the battery source.

PowerSourceTrait.BatCommonDesignationEnum?

The ID of the common or colloquial designation of the battery, as specified in BatCommonDesignationEnum.

Boolean?

Indicates whether the device can remain operational while the battery source is charging.

String?

The string representing the IEC designation for the battery, as specified in IEC 60086.

UByte?

The estimated percentage of battery charge remaining until the battery can no longer provide power to the device.

Boolean?

Indicates if the device detects that the batteries are properly installed.

UByte?

The number of battery cells or packs in the battery source.

PowerSourceTrait.BatReplaceabilityEnum?

Indicates the replaceability of the battery as specified in BatReplaceabilityEnum.

String?

A user-facing description of this battery, containing information required to identify a replacement, such as form factor, chemistry, or preferred manufacturer.

Boolean?

Indicates if the battery needs to be replaced.

UInt?

The estimated time in seconds before the battery will no longer be able to provide power to the device.

UInt?

The estimated time in seconds before the battery source is fully charged.

UInt?

The currently measured output voltage of the battery in millivolts.

UShort

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

String?

A user-facing description of the source, used to distinguish it from other power sources.

List<UShort>?

A list of endpoints that are powered by the source defined by this cluster.

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

UByte?

The relative preference with which the device selects the source to provide power.

PowerSourceTrait.PowerSourceStatusEnum?

The participation of the power source in providing power to the node, as specified in PowerSourceStatusEnum.

UInt?

The assessed instantaneous current draw of the device on the hard-wired source, in milliamps.

UShort?

The assessed frequency of the voltage, currently provided by the hard-wired source, in Hz.

UInt?

The assessed RMS or DC voltage currently provided by the hard-wired source, in millivolts.

PowerSourceTrait.WiredCurrentTypeEnum?

The type of current that the device expects to be provided by the hard-wired source, as specified in WiredCurrentTypeEnum.

UInt?

The maximum current in milliamps, given in the device's regulatory compliance label, expected to be provided by the hard-wired source.

UInt?

The nominal voltage in millivolts, given in the device's regulatory compliance label, expected to be provided by the hard-wired source.

Boolean?

Indicates if the device detects that the hard-wired power source is properly connected.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: PowerSource.Attribute): Boolean

Public properties

factory

open val factoryTraitFactory<PowerSource>