Skip to content

Pump

Pump with stopped, running and fault states and a rotation animation (SCADA-002).

Pump, light theme Pump, dark theme

Process symbols · Widget catalog · API reference · schema pump.schema.json

Example

The traits of the picture above:

ai.Pump(value="running", label="Pump running", tag="P-12")

Traits

Trait Type Default Set by Description
commands array of string ["start","stop"] host Commands offered on the faceplate (a constant of each widget).
value "stopped", "running", "fault" "stopped" host Pump state (feedback from the process).
animate boolean true host Rotate while running (off when reduced motion is requested).
direction "right", "left", "up", "down" "right" host Discharge direction of the symbol.
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.