Valve¶
On/off or control valve (SCADA-001).

Process symbols · Widget catalog · API reference ·
schema valve.schema.json
Example¶
The traits of the picture above:
ai.Valve(
value="open",
label="Valve (open, 60 %)",
position=60,
tag="XV-101",
auto=False,
)
Traits¶
| Trait | Type | Default | Set by | Description |
|---|---|---|---|---|
commands |
array of string | ["open","close"] |
host | Commands offered on the faceplate (a constant of each widget). |
value |
"open", "closed", "transit", "fault" |
"closed" |
host | Valve state (feedback from the process). |
position |
number or null | null |
host | Opening in % for a control valve (feedback); null: on/off valve. A control valve faceplate also takes a position demand in manual mode (with simulate, applied to position and value). |
orientation |
"horizontal", "vertical" |
"horizontal" |
host |
Common traits (12), shared with other widgets
| Trait | Type | Default | Set by | Description |
|---|---|---|---|---|
mode |
"control", "indicator" |
"control" |
host | "control": the user sets the value; "indicator": display only. |
label |
string | "" |
host | Plain text, never interpreted as HTML (SEC-002). |
disabled |
boolean | false |
host | Greyed out, input rejected. |
visible |
boolean | true |
host | |
tooltip |
string | "" |
host | Plain text shown on hover. |
size |
array | [90,90] |
host | [width, height] in CSS pixels. |
style |
"modern", "classic", "system" |
"modern" |
host | |
theme |
"auto", "light", "dark", "system" |
"auto" |
host | "auto": the style decides; "system": the host page or the operating system (STYLE-007). |
skin |
object | {} |
host | Replaceable drawing parts: part name -> SVG source, sanitized (STYLE-005, STYLE-006). |
tag |
string | "" |
host | Instrument tag shown on the faceplate (e.g. P-101). |
auto |
boolean | true |
host, widget | Automatic mode: the commands are disabled on the faceplate. The faceplate AUTO / MANUAL buttons send auto and manual commands; without a host owning the state, the front end applies them itself (HOST-012). |
simulate |
boolean | false |
host | A command sets the state itself (teaching, simulations): see the x-awi-simulated table of commands. Applied by the host when it owns the state, otherwise by the front end. |
Set by: host, the program (Python, Julia, ...); widget, the user through the widget;
derived, computed from other traits by the host that owns the state, or by the widget.
See the trait contract.