Skip to content

Water Valve

David Dix edited this page Dec 16, 2019 · 38 revisions

A HomeKit water valve.

Type Device Type
20 Water Value

Example

{
  "c": {
    "b": [{ "g": 0, "t": 5 }]
  },
  "a": [{
    "t": 20,
    "f0": [{ "g": 0, "t": 1 }],
    "f1": [{ "g": 0, "t": 2 }],
  }]
}

This is an example of a water valve... ???

TODO: Add a specific water valve example

Sensor Type

Type Name Description
0 Water Valve (default)
1 Sprinkler
2 Shower
3 Tap / Faucet

A variety of one-wire sensors are available and supported by HAA.

Actions

Name Action Description
"0" OFF (default)
"1" ON

A water valve has two actions. The digital output array "r": [{}] for each should be configured to attain the desired state.

HomeKit Notifications

The list of notifications supported by a water valve are as follows:

Value Notification
0 Valve OFF (default)
1 Valve ON

HomeKit Notifications work two ways; A device state change initiate a notification message to HomeKit, or the HomeApp can initiate a HomeKit message to notify the device to make a state change.

When a change of state occurs with the device a notification will be sent to HomeKit.

Initial State

Name State Description
"s" 0 OFF (default)
1 ON
4 Defined by fixed state inputs
5 Last state before restart
6 Opposite to last state before restart

The initial state that a water valve enters on boot can be set using the "s" option.

Maximum Use Time

Name State Description
"d" 0 Timer disabled
3600 Timer set to 1 hour (default)
1 to ∞ Time in seconds to set the use time

This option limits the maximum amount of time that the water valve can be in the ON state. The default is to limit the valve on time to 3,600 seconds (1 hour), but this time period can be disabled, lengthened or shortened.

When the timer is enabled then the valve will be turned OFF after the maximum use time has elapsed.

TODO: Find out what happens to the timer is the device is rebooted

State Inputs

Name Event
"f0" Valve Off event
"f1" Valve On event

Additionally an accessory can have button(s) or digital input(s) associated with a specific state. When a specific state occurs then a fixed HomeKit event is triggered.

Refer to State Inputs for more detail and examples.

See Digital Inputs Array for details on how to define this option.

Inching

Name Value Description
"i" 0.02 to very large The time in seconds to wait

See Inching for details of this option.

Clone this wiki locally