PowerSourceTrait.Attributes

@Generated(value = ["GoogleHomePlatformCodegen"])
interface PowerSourceTrait.Attributes : ClusterStruct

Known direct subclasses

PowerSource

PowerSource

API for the PowerSource trait.

Attributes for the PowerSource cluster.

Summary

Public functions
`open StructDescriptor`	`@HomeExperimentalGenericApi getDescriptor()` Returns the descriptor for the struct.
`open Any?`	`@HomeExperimentalGenericApi getFieldValueById(tagId: UInt)` Returns the value of the field for the given tag ID.

Public properties
`List<UInt>`	`acceptedCommandList` A list of client-generated commands which are supported by this cluster server instance.
`List<PowerSourceTrait.BatChargeFaultEnum>?`	`activeBatChargeFaults` Indicates the set of battery charge faults currently detected by the device on this power source.
`List<PowerSourceTrait.BatFaultEnum>?`	`activeBatFaults` Indicates the set of battery faults currently detected by the device on this power source.
`List<PowerSourceTrait.WiredFaultEnum>?`	`activeWiredFaults` The set of wired faults currently detected by the device on this power source.
`List<UInt>`	`attributeList` A list of the attribute IDs of the attributes supported by the cluster instance.
`String?`	`batAnsiDesignation` The string representing the ANSI designation for the battery, as specified in ANSI C18.
`PowerSourceTrait.BatApprovedChemistryEnum?`	`batApprovedChemistry` ID of the preferred chemistry of the battery source, as specified in `BatApprovedChemistryEnum`.
`UInt?`	`batCapacity` The preferred minimum charge capacity rating in milliampere-hours of battery cells or packs in the battery source.
`PowerSourceTrait.BatChargeLevelEnum?`	`batChargeLevel` The ranking of the charge level of the battery used to indicate when intervention is required, as specified in `BatChargeLevelEnum`.
`PowerSourceTrait.BatChargeStateEnum?`	`batChargeState` The state of the battery charge, as specified in `BatChargeStateEnum`.
`UInt?`	`batChargingCurrent` The assessed current in milliamps being supplied to charge the battery source.
`PowerSourceTrait.BatCommonDesignationEnum?`	`batCommonDesignation` The ID of the common or colloquial designation of the battery, as specified in `BatCommonDesignationEnum`.
`Boolean?`	`batFunctionalWhileCharging` Indicates whether the device can remain operational while the battery source is charging.
`String?`	`batIecDesignation` The string representing the IEC designation for the battery, as specified in IEC 60086.
`UByte?`	`batPercentRemaining` The estimated percentage of battery charge remaining until the battery can no longer provide power to the device.
`Boolean?`	`batPresent` Indicates if the device detects that the batteries are properly installed.
`UByte?`	`batQuantity` The number of battery cells or packs in the battery source.
`PowerSourceTrait.BatReplaceabilityEnum?`	`batReplaceability` Indicates the replaceability of the battery as specified in `BatReplaceabilityEnum`.
`String?`	`batReplacementDescription` A user-facing description of this battery, containing information required to identify a replacement, such as form factor, chemistry, or preferred manufacturer.
`Boolean?`	`batReplacementNeeded` Indicates if the battery needs to be replaced.
`UInt?`	`batTimeRemaining` The estimated time in seconds before the battery will no longer be able to provide power to the device.
`UInt?`	`batTimeToFullCharge` The estimated time in seconds before the battery source is fully charged.
`UInt?`	`batVoltage` The currently measured output voltage of the battery in millivolts.
`UShort`	`clusterRevision` The revision of the server cluster specification supported by the cluster instance.
`String?`	`description` A user-facing description of the source, used to distinguish it from other power sources.
`List<UShort>?`	`endpointList` A list of endpoints that are powered by the source defined by this cluster.
`PowerSourceTrait.Feature`	`featureMap` Whether the server supports zero or more optional cluster features.
`List<UInt>`	`generatedCommandList` A list of server-generated commands (server to client) which are supported by this cluster server instance.
`UByte?`	`order` The relative preference with which the device selects the source to provide power.
`PowerSourceTrait.PowerSourceStatusEnum?`	`status` The participation of the power source in providing power to the node, as specified in `PowerSourceStatusEnum`.
`UInt?`	`wiredAssessedCurrent` The assessed instantaneous current draw of the device on the hard-wired source, in milliamps.
`UShort?`	`wiredAssessedInputFrequency` The assessed frequency of the voltage, currently provided by the hard-wired source, in Hz.
`UInt?`	`wiredAssessedInputVoltage` The assessed RMS or DC voltage currently provided by the hard-wired source, in millivolts.
`PowerSourceTrait.WiredCurrentTypeEnum?`	`wiredCurrentType` The type of current that the device expects to be provided by the hard-wired source, as specified in `WiredCurrentTypeEnum`.
`UInt?`	`wiredMaximumCurrent` The maximum current in milliamps, given in the device's regulatory compliance label, expected to be provided by the hard-wired source.
`UInt?`	`wiredNominalVoltage` The nominal voltage in millivolts, given in the device's regulatory compliance label, expected to be provided by the hard-wired source.
`Boolean?`	`wiredPresent` Indicates if the device detects that the hard-wired power source is properly connected.

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.

activeBatChargeFaults

val activeBatChargeFaults: List<PowerSourceTrait.BatChargeFaultEnum>?

Indicates the set of battery charge faults currently detected by the device on this power source. This set is represented as a list in BatChargeFaultEnum. When the device detects that a fault has been raised, the appropriate BatChargeFaultEnum value is added to this list. When the device detects that all conditions contributing to a fault have been cleared, the corresponding value is removed from this list. An empty list indicates that there are currently no active faults.

Access type: Read

activeBatFaults

val activeBatFaults: List<PowerSourceTrait.BatFaultEnum>?

Indicates the set of battery faults currently detected by the device on this power source. This set is represented as a list in BatFaultEnum. When the device detects that a fault has been raised, the appropriate BatFaultEnum value is added to this list. When the device detects that all conditions contributing to a fault have been cleared, the corresponding value is removed from this list. An empty list indicates that there are currently no active faults.

Access type: Read

activeWiredFaults

val activeWiredFaults: List<PowerSourceTrait.WiredFaultEnum>?

The set of wired faults currently detected by the device on this power source. This set is represented as a list of WiredFaultEnum. When the device detects that a fault has been raised, the appropriate WiredFaultEnum value is added to this list, provided this value is not already present in the list. This list should not contain more than one instance of a specific WiredFaultEnum value. When the device detects that all conditions contributing to a fault have been cleared, the corresponding WiredFaultEnum value is removed from this list. An empty list indicates that there are currently no active faults.

Access type: Read

attributeList

val attributeList: List<UInt>

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

batAnsiDesignation

val batAnsiDesignation: String?

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

Access type: Read

batApprovedChemistry

val batApprovedChemistry: PowerSourceTrait.BatApprovedChemistryEnum?

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

Access type: Read

batCapacity

val batCapacity: UInt?

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

Access type: Read

batChargeLevel

val batChargeLevel: PowerSourceTrait.BatChargeLevelEnum?

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

Access type: Read

batChargeState

val batChargeState: PowerSourceTrait.BatChargeStateEnum?

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

Access type: Read

batChargingCurrent

val batChargingCurrent: UInt?

The assessed current in milliamps being supplied to charge the battery source. A value of null indicates that the device is currently unable to assess the value.

Access type: Read

batCommonDesignation

val batCommonDesignation: PowerSourceTrait.BatCommonDesignationEnum?

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

Access type: Read

batFunctionalWhileCharging

val batFunctionalWhileCharging: Boolean?

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

Access type: Read

batIecDesignation

val batIecDesignation: String?

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

Access type: Read

batPercentRemaining

val batPercentRemaining: UByte?

The estimated percentage of battery charge remaining until the battery can no longer provide power to the device. Values are expressed in half-percent units, ranging from 0 to 200. For example, a value of 48 is equivalent to 24%. A value of null indicates that the device is currently unable to assess the value. Changes to this attribute are reported either once every 10 seconds or when the value changes between null and a non-null value.

Access type: Read

batPresent

val batPresent: Boolean?

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

Access type: Read

batQuantity

val batQuantity: UByte?

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

Access type: Read

batReplaceability

val batReplaceability: PowerSourceTrait.BatReplaceabilityEnum?

Indicates the replaceability of the battery as specified in BatReplaceabilityEnum.

Access type: Read

batReplacementDescription

val batReplacementDescription: String?

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

Access type: Read

batReplacementNeeded

val batReplacementNeeded: Boolean?

Indicates if the battery needs to be replaced.

Access type: Read

batTimeRemaining

val batTimeRemaining: UInt?

The estimated time in seconds before the battery will no longer be able to provide power to the device. A value of null indicates that the device is currently unable to assess the value. Changes to this attribute are reported either once every 10 seconds or when the value changes between null and a non-null value.

Access type: Read

batTimeToFullCharge

val batTimeToFullCharge: UInt?

The estimated time in seconds before the battery source is fully charged. A value of null indicates that the device is currently unable to assess the value. Changes to this attribute are reported either once every 10 seconds or when the value changes between null and a non-null value.

Access type: Read

batVoltage

val batVoltage: UInt?

The currently measured output voltage of the battery in millivolts. A value of null indicates that the device is currently unable to assess the value.

Access type: Read

clusterRevision

val clusterRevision: UShort

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

description

val description: String?

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

Access type: Read

endpointList

val endpointList: List<UShort>?

A list of endpoints that are powered by the source defined by this cluster. Multiple instances of this cluster can list the same endpoint because it is possible for power for an endpoint to come from multiple sources. In that case, the Order attribute indicates their priority. For each power source on a device, there is only one instance of this cluster. A cluster instance with an empty list indicates that the power source is for the entire device, which includes all endpoints. A cluster instance with a non-empty list includes the endpoint for which the cluster instance resides.

Access type: Read

featureMap

val featureMap: PowerSourceTrait.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.

order

val order: UByte?

The relative preference with which the device selects the source to provide power. A source with a lower order is selected by the device to provide power before any other source with a higher order, if the lower-order source is available.

Access type: Read

status

val status: PowerSourceTrait.PowerSourceStatusEnum?

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

Access type: Read

wiredAssessedCurrent

val wiredAssessedCurrent: UInt?

The assessed instantaneous current draw of the device on the hard-wired source, in milliamps. A value of null indicates the device is currently unable to assess the value. If the wired source is not connected, but the device is still able to assess a value, then the assessed value can be reported.

Access type: Read

wiredAssessedInputFrequency

val wiredAssessedInputFrequency: UShort?

The assessed frequency of the voltage, currently provided by the hard-wired source, in Hz. A value of null indicates that the device is currently unable to assess the value. If the wired source is not connected, but the device is still able to assess a value, then the assessed value can be reported.

Access type: Read

wiredAssessedInputVoltage

val wiredAssessedInputVoltage: UInt?

The assessed RMS or DC voltage currently provided by the hard-wired source, in millivolts. A value of null indicates that the device is currently unable to assess the value. If the wired source is not connected, but the device is still able to assess a value, then the assessed value can be reported.

Access type: Read

wiredCurrentType

val wiredCurrentType: PowerSourceTrait.WiredCurrentTypeEnum?

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

Access type: Read

wiredMaximumCurrent

val wiredMaximumCurrent: UInt?

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

Access type: Read

wiredNominalVoltage

val wiredNominalVoltage: UInt?

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

Access type: Read

wiredPresent

val wiredPresent: Boolean?

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

Access type: Read