# ValveConfigurationAndControlTrait.Attributes

# ValveConfigurationAndControlTrait.Attributes


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

<br />

Known direct subclasses [ValveConfigurationAndControl](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControl)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControl` | API for the ValveConfigurationAndControl trait. |

*** ** * ** ***

Attributes for the ValveConfigurationAndControl cluster.

## Summary

| ### Public functions |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#getDescriptor()()` Returns the descriptor for the struct. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#attributeList()` A list of the attribute IDs of the attributes supported by the cluster instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#autoCloseTime()` The UTC time when the valve will close, depending on value of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#openDuration()` attribute. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#currentLevel()` The current level of the valve as a percentage value, between fully closed and fully open. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.ValveStateEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#currentState()` The current state of the valve. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#defaultOpenDuration()` The default duration, in seconds, for which the valve will remain open, if a value for the `openDuration` parameter is not present in the `Open` command. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#defaultOpenLevel()` The default value used for the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#targetLevel()` attribute, when a valve transitions from the closed to the open state, caused by an `Open` command, if a value for the `targetLevel` parameter isn't present in the `Open` command. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#featureMap()` Whether the server supports zero or more optional cluster features. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#generatedCommandList()` A list of server-generated commands (server to client) which are supported by this cluster server instance. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#levelStep()` The step size supported by the valve. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#openDuration()` The total duration, in seconds, for which the valve will remain open for the current opening. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#remainingDuration()` The remaining duration, in seconds, until the valve closes. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#targetLevel()` The target level of the valve as a percentage value, between fully closed and fully open. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.ValveStateEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#targetState()` The target state, while changing the state, of the valve. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.ValveFaultBitmap?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#valveFault()` Any faults registered by the valve. |

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

### attributeList

```
val attributeList: List<UInt>
```

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

### autoCloseTime

```
val autoCloseTime: ULong?
```

The UTC time when the valve will close, depending on value of the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#openDuration()` attribute.

**Access type:** Read

### clusterRevision

```
val clusterRevision: UShort
```

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

### currentLevel

```
val currentLevel: UByte?
```

The current level of the valve as a percentage value, between fully closed and fully open.

**Access type:** Read

### currentState

```
val currentState: ValveConfigurationAndControlTrait.ValveStateEnum?
```

The current state of the valve.

**Access type:** Read

### defaultOpenDuration

```
val defaultOpenDuration: UInt?
```

The default duration, in seconds, for which the valve will remain open, if a value for the `openDuration` parameter is not present in the `Open` command.

**Access type:** Write

### defaultOpenLevel

```
val defaultOpenLevel: UByte?
```

The default value used for the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ValveConfigurationAndControlTrait.Attributes#targetLevel()` attribute, when a valve transitions from the closed to the open state, caused by an `Open` command, if a value for the `targetLevel` parameter isn't present in the `Open` command.

**Access type:** Write

### featureMap

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

### levelStep

```
val levelStep: UByte?
```

The step size supported by the valve.

**Access type:** Read

### openDuration

```
val openDuration: UInt?
```

The total duration, in seconds, for which the valve will remain open for the current opening.

**Access type:** Read

### remainingDuration

```
val remainingDuration: UInt?
```

The remaining duration, in seconds, until the valve closes.

**Access type:** Read

### targetLevel

```
val targetLevel: UByte?
```

The target level of the valve as a percentage value, between fully closed and fully open.

**Access type:** Read

### targetState

```
val targetState: ValveConfigurationAndControlTrait.ValveStateEnum?
```

The target state, while changing the state, of the valve.

**Access type:** Read

### valveFault

```
val valveFault: ValveConfigurationAndControlTrait.ValveFaultBitmap?
```

Any faults registered by the valve.

**Access type:** Read