Repository navigation
IrrigationSystem
Martin Patfield edited this page Nov 10, 2026
·
2 revisions
A specialized grouping of Valves that displays as a single entity in the Home app.
See this example for migrating from MQTTThing.
| Field | Required | Description |
|---|---|---|
valveType |
No | One of GENERIC_VALVE (default), IRRIGATION, SHOWER_HEAD, WATER_FAUCET
|
minimumDuration |
No | Minimum number of minutes in the 'Default Run Time' setting |
maximumDuration |
No | Maximum number of minutes in the 'Default Run Time' setting |
simulateDuration |
No | If true, uses an internal timer to calculate RemainingDuration
|
valueActive |
Yes | Valve is active |
valueInactive |
Yes | Valve is not active |
valueInUse |
Yes | Valve is in use |
valves |
Yes | An array of valve configurations (see Valve Config below) |
| Field | Required | Description |
|---|---|---|
id |
Yes | A unique ID to identify this valve |
name |
Yes | The display name for the valve |
topicGetValveActive |
Yes | Get whether or not the valve is active |
topicSetValveActive |
Yes | Set whether or not the valve is active |
topicGetValveInUse |
Yes | Get whether or not the valve is in use |
topicGetValveRemainingDuration |
No | Get the time remaining in seconds |