jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-13 12:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change valve state is enum (#2328)

Browse Source
This commit is contained in:
G Johansson 2024-09-23 14:20:34 +02:00 committed by GitHub
parent a00529d7b4
commit 0b47074ce4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/core/entity/valve.md
View File

@ -26,15 +26,16 @@ Properties should always only return information from memory and not do I/O (lik
| `ValveDeviceClass.WATER` | Control of a water valve.
| `ValveDeviceClass.GAS` | Control of a gas valve.
### States
| Constant | Description
|----------|------------------------|
| `STATE_OPENING` | The valve is in the process of opening to reach a set position.
| `STATE_OPEN` | The valve has reached the open position.
| `STATE_CLOSING` | The valve is in the process of closing to reach a set position.
| `STATE_CLOSED` | The valve has reach the closed position.
The state is defined by setting it's properties. The resulting state is using the `ValveState` enum to return one of the below members.
| Value | Description |
|----------|--------------------------------------------------------------------|
| `OPENING`| The valve is in the process of opening to reach a set position. |
| `OPEN` | The valve has reached the open position. |
| `CLOSING`| The valve is in the process of closing to reach a set position. |
| `CLOSED` | The valve has reached the closed position. |
## Supported features