ClusterStruct

interface ClusterStruct

Known direct subclasses

`ActionsTrait.ActionStruct`	The details of a single action.
`ActionsTrait.EndpointListStruct`	The details of a single endpoint list, a set of endpoints that have some logical relation.
`ActivatedCarbonFilterMonitoringTrait.ReplacementProductStruct`	The details of a replacement activated carbon filter.
`ApplicationBasicTrait.ApplicationStruct`	A global identifier for an app.
`ApplicationLauncherTrait.ApplicationEpStruct`
`ApplicationLauncherTrait.ApplicationStruct`
`ArmDisarmTrait.AvailableArmLevels`	The supported security levels of the device.
`ArmDisarmTrait.LevelValues`	Contains a user-friendly name for the levels as well as the language code.
`ArmDisarmTrait.Levels`	Information about security-level names.
`AudioOutputTrait.OutputInfoStruct`	Contains information about an output.
`BasicInformationTrait.CapabilityMinimaStruct`	A set of constant values related to the overall capabilities of the node.
`BasicInformationTrait.ProductAppearanceStruct`	The product's appearance.
`BindingTrait.TargetStruct`	A remote node and endpoint.
`ChannelTrait.AdditionalInfoStruct`
`ChannelTrait.ChannelInfoStruct`	A channel in a channel lineup.
`ChannelTrait.ChannelPagingStruct`
`ChannelTrait.LineupInfoStruct`	A channel lineup.
`ChannelTrait.PageTokenStruct`
`ChannelTrait.ProgramCastStruct`
`ChannelTrait.ProgramCategoryStruct`
`ChannelTrait.ProgramStruct`
`ChannelTrait.SeriesInfoStruct`
`ContentLauncherTrait.AdditionalInfoStruct`	Additional name-value pairs that can be used to identify content.
`ContentLauncherTrait.BrandingInformationStruct`	Branding information that customizes the video player skin.
`ContentLauncherTrait.ContentSearchStruct`	Inputs to a search for content for display or playback.
`ContentLauncherTrait.DimensionStruct`	A set of dimensions for a background image.
`ContentLauncherTrait.ParameterStruct`	Inputs to a search for content for display or playback.
`ContentLauncherTrait.PlaybackPreferencesStruct`
`ContentLauncherTrait.StyleInformationStruct`	Style information which can be used to change the media player's visual style.
`ContentLauncherTrait.TrackPreferenceStruct`
`CookTrait.FoodPreset`	Internal name of the food preset.
`CookTrait.FoodSynonym`	Available food synonyms for a language.
`DescriptorTrait.DeviceTypeStruct`	An object describing endpoint conformance to a release of a device type definition.
`DescriptorTrait.SemanticTagStruct`	An object describing an endpoint label specific to a manufacturer.
`DishwasherModeTrait.ModeOptionStruct`	Describes a mode that may be selected on the device.
`DishwasherModeTrait.ModeTagStruct`	Describes a mode tag.
`DispenseTrait.Amount`	The available dispensible item amounts.
`DispenseTrait.DispensableItem`	The available dispensible items.
`DispenseTrait.DispenseItem`	The state of a given disensible item.
`DispenseTrait.ItemNameSynonym`	Synonym names for the dispensed item in a given language.
`DispenseTrait.PresetNameSynonym`	Synonym names for the preset in a given language.
`DispenseTrait.Preset`	The supported dispensible item presets.
`DoorLockTrait.CredentialStruct`	A set of credentials used when operating the door lock.
`ElectricalEnergyMeasurementTrait.CumulativeEnergyResetStruct`	Indicates when cumulative measurements were most recently zero.
`ElectricalEnergyMeasurementTrait.EnergyMeasurementStruct`	Indicates the amount of energy measured during a given measurement period.
`ElectricalEnergyMeasurementTrait.MeasurementAccuracyRangeStruct`	The accuracy of a measurement for a range of measurement values, shown as a maximum +/- percentage of the true value, a maximum +/- fixed value of the true value, or both.
`ElectricalEnergyMeasurementTrait.MeasurementAccuracyStruct`	The set of accuracy ranges for a given measurement, the maximum and minimum values for the measurement, and whether the measurement is directly measured or only estimated from other existing information.
`ElectricalPowerMeasurementTrait.HarmonicMeasurementStruct`	Measurements of various harmonics.
`ElectricalPowerMeasurementTrait.MeasurementAccuracyRangeStruct`	The accuracy of a measurement for a range of measurement values, shown as a maximum +/- percentage of the true value, a maximum +/- fixed value of the true value, or both.
`ElectricalPowerMeasurementTrait.MeasurementAccuracyStruct`	The set of accuracy ranges for a given measurement, the maximum and minimum values for the measurement, and whether the measurement is directly measured or only estimated from other existing information.
`ElectricalPowerMeasurementTrait.MeasurementRangeStruct`	The maximum and minimum values of a given measurement type during a measurement period, along with the observation times of these values.
`ElevatorControlTrait.ElevatorFloor`	An elevator floor.
`ElevatorControlTrait.FloorNameSynonym`	Synonyms for this floor in a given language.
`EnergyEvseModeTrait.ModeOptionStruct`	Represents the possible mode of the `EnergyEvse` instance.
`EnergyEvseModeTrait.ModeTagStruct`	Describes a mode tag.
`EnergyEvseTrait.ChargingTargetScheduleStruct`	A set of user-specified charging targets for an electric vehicle for a set of specified days.
`EnergyEvseTrait.ChargingTargetStruct`	A single user-specified charging target for an electric vehicle.
`ExtendedApplicationLauncherTrait.ApplicationNames`	Application names and language-specific synonyms.
`ExtendedApplicationLauncherTrait.AvailableApplication`	Represents an application that users of this device can interact with.
`ExtendedChannelTrait.ExtendedMediaChannel`	Media channel description.
`ExtendedDoorLockTrait.PrivacyModeActor`	Describes who and what last caused the privacy mode state to change.
`ExtendedFanControlTrait.AvailableFanSpeeds`	The speed settings supported by the device.
`ExtendedFanControlTrait.SpeedValues`	Synonyms for the speed setting in each supported language.
`ExtendedFanControlTrait.Speed`	A named speed setting.
`ExtendedMediaInputTrait.AvailableInput`	Available-input definitions.
`ExtendedMediaInputTrait.InputNames`	Input names for a given available language.
`ExtendedModeSelectTrait.ModeSetting`
`ExtendedModeSelectTrait.ModeSynonyms`
`ExtendedModeSelectTrait.Mode`
`ExtendedModeSelectTrait.SettingSynonyms`
`ExtendedModeSelectTrait.Setting`
`ExtendedPowerSourceTrait.Capacity`
`ExtendedThermostatTrait.PresetSynonyms`	Synonyms for the preset in a given language.
`ExtendedThermostatTrait.Preset`	Information about a preset.
`FillTrait.AvailableFillLevels`	The available fill levels.
`FillTrait.LevelSynonym`	Synonyms of the level in a given language.
`FillTrait.Level`	Level name and its language-specific synonyms.
`FixedLabelTrait.LabelStruct`	An object describing an endpoint's label.
`HepaFilterMonitoringTrait.ReplacementProductStruct`	The details of a replacement HEPA filter.
`LaundryWasherModeTrait.ModeOptionStruct`	Describes a mode that may be selected on the device.
`LaundryWasherModeTrait.ModeTagStruct`	Describes a mode tag.
`LightEffectsTrait.Color`	Color of the light for the duration of the effect.
`LightEffectsTrait.SpectrumHsv`	Represents a color using the HSV model.
`MediaInputTrait.InputInfoStruct`	Information about an input.
`MediaPlaybackTrait.PlaybackPositionStruct`	A playback position within a media stream.
`MediaPlaybackTrait.TrackAttributesStruct`
`MediaPlaybackTrait.TrackStruct`
`MicrowaveOvenModeTrait.ModeOptionStruct`	Represents the possible mode of the `MicrowaveOvenMode` instance.
`MicrowaveOvenModeTrait.ModeTagStruct`	Describes a mode tag.
`ModeSelectTrait.ModeOptionStruct`	Represents the possible mode of the cluster instance.
`ModeSelectTrait.SemanticTagStruct`	Represents a semantic tag.
`NetworkControlTrait.GuestNetworkSettings`	Settings of the guest network.
`NetworkControlTrait.LastNetworkDownloadSpeedTest`	Results of the most recent network-download speed test.
`NetworkControlTrait.LastNetworkUploadSpeedTest`	The results of the most recent network-upload speed test.
`NetworkControlTrait.NetworkProfileState`	The state of one of the network profiles.
`NetworkControlTrait.NetworkSettings`	Settings of the main network.
`ObjectDetectionTrait.Object`	Information about a specific object that has been detected.
`ObjectDetectionTrait.Objects`	Categorization of the objects detected.
`OccupancySensingTrait.HoldTimeLimitsStruct`
`OpenCloseTrait.DirectionOpenState`	Current state for the given open direction.
`OperationalStateTrait.ErrorStateStruct`	Used to indicate the error state of the device when the `operationalState` attribute is Error.
`OperationalStateTrait.OperationalStateStruct`	Used to indicate a possible state of the device.
`OvenCavityOperationalStateTrait.ErrorStateStruct`	Used to indicate the error state of the oven when the OvenCavityOperationalState.Attributes.operationalState attribute is Error.
`OvenCavityOperationalStateTrait.OperationalStateStruct`	Used to indicate a possible state of the oven.
`OvenModeTrait.ModeOptionStruct`	Represents the possible mode of the `OvenMode` instance.
`OvenModeTrait.ModeTagStruct`	Describes a mode tag.
`ParkingLocationTrait.CurrentParkingLocation`	Locations of the user's parked vehicles.
`PowerSourceTrait.BatChargeFaultChangeType`
`PowerSourceTrait.BatFaultChangeType`
`PowerSourceTrait.WiredFaultChangeType`
`RefrigeratorAndTemperatureControlledCabinetModeTrait.ModeOptionStruct`	Describes a mode that may be selected on the device.
`RefrigeratorAndTemperatureControlledCabinetModeTrait.ModeTagStruct`	Describes a mode tag.
`RotationTrait.RotationDegreesRange`	The number of degrees that a device can rotate.
`RvcCleanModeTrait.ModeOptionStruct`	Describes a mode that may be selected on the device.
`RvcCleanModeTrait.ModeTagStruct`	Describes a mode tag.
`RvcOperationalStateTrait.ErrorStateStruct`	Used to indicate the error state of the device when the RvcOperationStateTrait.Attributes.operationalState attribute is Error.
`RvcOperationalStateTrait.OperationalStateStruct`	Used to indicate a possible state of the device.
`RvcRunModeTrait.ModeOptionStruct`	Describes a mode that may be selected on the device.
`RvcRunModeTrait.ModeTagStruct`	Describes a mode tag.
`TargetNavigatorTrait.TargetInfoStruct`	An object describing the navigable target.
`ThermostatTrait.AtomicAttributeStatusStruct`
`ThermostatTrait.PresetStruct`	A preset.
`ThermostatTrait.PresetTypeStruct`	A preset type.
`ThermostatTrait.ScheduleStruct`	A schedule.
`ThermostatTrait.ScheduleTransitionStruct`	A schedule transition.
`ThermostatTrait.ScheduleTypeStruct`	A schedule type.
`ThermostatTrait.WeeklyScheduleTransitionStruct`	A single transition in a thermostat schedule.
`TogglesTrait.ToggleSetting`	Indicates if a specific toggle is enabled or not.
`TogglesTrait.ToggleSynonyms`	Synonyms of the toggle in a given language.
`TogglesTrait.Toggle`	A toggle that is available on the device.
`UnitTestingTrait.DoubleNestedStructList`	DoubleNestedStructList
`UnitTestingTrait.NestedStructList`	NestedStructList
`UnitTestingTrait.NestedStruct`	NestedStruct
`UnitTestingTrait.NullablesAndOptionalsStruct`	NullablesAndOptionalsStruct`.
`UnitTestingTrait.SimpleStruct`	SimpleStruct
`UnitTestingTrait.TestFabricScoped`	TestFabricScoped
`UnitTestingTrait.TestGlobalStruct`
`UnitTestingTrait.TestListStructOctet`	TestListStructOctet
`UserLabelTrait.LabelStruct`	An object describing an endpoint's label.

Interface for a Cluster Struct field.

Summary

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

Public functions

getDescriptor

fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

fun getFieldValueById(tagId: UInt): Any?

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