Smart Water Valve

Smart water valve is a Powered By Shelly device which automatically regulates water flow by opening, closing, or adjusting the valve to a specific position. It responds to power events — such as closing or reopening the valve after a power outage — and can connect to temperature sensors for enhanced environmental monitoring.

For more information about the original Smart Water Valve consult: https://frankever.com/

The following components are available in Smart Water Valve:

• System
• XMOD service
• WiFi
• Bluetooth Low Energy
• Schedule
• Cloud
• MQTT
• Outbound Websocket
• Webhook
• KVS
• HTTP

Supported virtual components:

• Boolean
• Number
• Button

Supported BTHome components:

• BTHomeDevice
• BTHomeSensor

Virtual Component Configuration

The Smart Water Valve has the following virtual components:

Virtual Component	Type	Access	Description
open	button	write	Opens the water valve completely.
close	button	write	Closes the water valve completely.
position	number	write	Adjusts the valve’s position as a percentage (0–100%).
has_power	boolean	read	Indicates whether the device is currently receiving power.

Service Configuration

See the Service Configuration Example section for a full example.

Property	Type	Description
on_power_loss	string	Defines the behavior of the valve when the power gets lost: close - Close the valve. open - Open the valve. none - Do nothing. set_position - Set the valve at a certain position.
on_power_restore	string	Defines the behavior of the valve when the power is restored: close - Close the valve. open - Open the valve. none - Do nothing. set_position - Set the valve at a certain position. restore_last - Set the valve to the last saved position.
power_restored_pos	number	Applies when on_power_restore is set to set_position, defining the valve position after power is restored.
power_loss_pos	number	Applies when on_power_loss is set to set_position, defining the valve position when power is lost.
name	string	Valve's configuration name.

Method Examples

How to open the water valve

Button.Trigger HTTP GET Request

http://192.168.33.1/rpc/Button.Trigger?owner="service:0"&role="open"&event="single_push"

Button.Trigger Curl Request

curl -X POST -d '{"id":1,"method":"Button.Trigger","params":{"owner":"service:0","role":"open","event":"single_push"}}' http://${SHELLY}/rpc

Button.Trigger Mos Request

mos --port ${PORT} call Button.Trigger '{"owner":"service:0","role":"open","event":"single_push"}'

Response

Button.Trigger HTTP GET Response

null

Button.Trigger Curl Response

{
  "id": 1,
  "src": "watervalve-84fce6368be0",
  "params": null
}

Button.Trigger Mos Response

null

How to close the water valve

Button.Trigger HTTP GET Request

http://192.168.33.1/rpc/Button.Trigger?owner="service:0"&role="close"&event="single_push"

Button.Trigger Curl Request

curl -X POST -d '{"id":1,"method":"Button.Trigger","params":{"owner":"service:0","role":"close","event":"single_push"}}' http://${SHELLY}/rpc

Button.Trigger Mos Request

mos --port ${PORT} call Button.Trigger '{"owner":"service:0","role":"close","event":"single_push"}'

Response

Button.Trigger HTTP GET Response

null

Button.Trigger Curl Response

{
  "id": 1,
  "src": "watervalve-84fce6368be0",
  "params": null
}

Button.Trigger Mos Response

null

How to adjust the water valve's position (opened at 25%)

Number.Set HTTP GET Request

http://192.168.33.1/rpc/Number.Set?owner="service:0"&role="position"&value=25

Number.Set Curl Request

curl -X POST -d '{"id":1,"method":"Number.Set","params":{"owner":"service:0","role":"position","value":25}}' http://${SHELLY}/rpc

Number.Set Mos Request

mos --port ${PORT} call Number.Set '{"owner":"service:0","role":"position","value":25}'

Response

Number.Set HTTP GET Response

null

Number.Set Curl Response

{
  "id": 1,
  "src": "watervalve-84fce6368be0",
  "params": null
}

Number.Set Mos Response

null

How to check the device's power state

Boolean.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Boolean.GetStatus?owner="service:0"&role="has_power"

Boolean.GetStatus Curl Request

curl -X POST -d '{"id":1,"method":"Boolean.GetStatus","params":{"owner":"service:0","role":"has_power"}}' http://${SHELLY}/rpc

Boolean.GetStatus Mos Request

mos --port ${PORT} call Boolean.GetStatus '{"owner":"service:0","role":"has_power"}'

Response

Boolean.GetStatus HTTP GET Response

{
  "value": true,
  "source": "rpc",
  "last_update_ts": 1700864253
}

Boolean.GetStatus Curl Response

{
  "id": 1,
  "src": "watervalve-84fce6368be0",
  "params": {
    "value": true,
    "source": "rpc",
    "last_update_ts": 1700864253
  }
}

Boolean.GetStatus Mos Response

{
  "value": true,
  "source": "rpc",
  "last_update_ts": 1700864253
}

MQTT Communication

The Smart Water Valve can be controlled and monitored through MQTT.

Command topics

Allow sending open, close commands, as well as numeric position control.

Topic	Description
"valve/0/state"	Accepts open or close payloads to fully open or close the valve.
"valve/0/position"	Accepts numeric payloads (0–100) to set the target valve position as a percentage.

Status topics

Report information about the current status of the water valve.

Topic	Description
"valve/0/position"	Reports current valve position as a JSON object, e.g. { "position": 45 }.
"valve/0/has_power"	Reports current power-supply status as a JSON object, e.g. { "hasPower": true }.

Service Configuration Example

Service.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Service.GetConfig?id=0

Service.GetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Service.GetConfig","params":{"id":0}}' http://${SHELLY}/rpc

Service.GetConfig Mos Request

mos --port ${PORT} call Service.GetConfig '{"id":0}'

Response

Number.Set HTTP GET Response

{
  "on_power_loss": "none",
  "on_power_restore": "none",
  "power_restored_pos": 0,
  "power_loss_pos": 0,
  "name": "Water valve",
  "id": 0
}

Number.Set Curl Response

{
  "id": 1,
  "src": "st-802-54320440a210",
  "params": {
    "on_power_loss": "none",
    "on_power_restore": "none",
    "power_restored_pos": 0,
    "power_loss_pos": 0,
    "name": "Water valve",
    "id": 0
  }
}

Number.Set Mos Response

{
  "on_power_loss": "none",
  "on_power_restore": "none",
  "power_restored_pos": 0,
  "power_loss_pos": 0,
  "name": "Water valve",
  "id": 0
}