PIDFaceplate¶
Operator faceplate of a control loop (IND-030 .. IND-034).
Not a safety-related system
A controller in a notebook runs with no timing guarantee. It is for visualization, teaching, simulation and supervision; it is not a safety-related system and must not perform a safety function. See the safety notice.

Supervisory objects · Widget catalog · API reference ·
schema pidfaceplate.schema.json
Example¶
The traits of the picture above:
ai.PIDFaceplate(
label="PIDFaceplate",
tag="TIC-101",
unit="°C",
pv=71.6,
sp=75,
op=62.5,
modes=["MAN", "AUTO", "CAS"],
pv_max=150,
confirm_delta=10,
lo=40,
hi=110,
hihi=130,
)
Traits¶
| Trait | Type | Default | Set by | Description |
|---|---|---|---|---|
size |
array | [240,236] |
host | [width, height] in CSS pixels. |
tag |
string | "" |
host | Loop tag, e.g. TIC-101. |
unit |
string | "" |
host | Unit of PV and SP. |
op_unit |
string | "%" |
host | Unit of OP. |
format |
string | "%.1f" |
host | printf-like spec of the values (NUM-004). |
pv |
number | "nan" |
host | Process value (measurement), set by the host. |
sp |
number | 0 |
host | Setpoint, clamped to sp_min .. sp_max (or the PV range). Changed by the operator in AUTO (IND-031). |
op |
number | 0 |
host | Output, clamped to op_min .. op_max. Changed by the operator in MAN. |
loop_mode |
"MAN", "AUTO", "CAS" |
"AUTO" |
host | Loop mode: MAN (operator sets OP), AUTO (operator sets SP), CAS (neither). Must be one of modes. |
modes |
array of enum | ["MAN","AUTO"] |
host | Modes offered on the faceplate. |
pv_min |
number | 0 |
host | Lower end of the PV scale. |
pv_max |
number | 100 |
host | Upper end of the PV scale. |
sp_min |
number or null | null |
host | Lower setpoint limit; null: pv_min. |
sp_max |
number or null | null |
host | Upper setpoint limit; null: pv_max. |
op_min |
number | 0 |
host | Lower output limit. |
op_max |
number | 100 |
host | Upper output limit. |
confirm_delta |
number or null | null |
host | A change of SP or OP larger than this needs a confirmation (IND-032); null: never. |
sp_tracking |
boolean | false |
host | Leaving MAN sets SP to PV (bumpless transfer, IND-034). |
lolo |
number or null | null |
host | Low-low alarm limit on PV. |
lo |
number or null | null |
host | Low alarm limit on PV. |
hi |
number or null | null |
host | High alarm limit on PV. |
hihi |
number or null | null |
host | High-high alarm limit on PV. |
deadband |
number | 0 |
host | Alarm hysteresis (ALARM-003). |
alarm_level |
"normal", "lo", "lolo", "hi", "hihi" |
"normal" |
derived | Alarm level of pv. Derived: by the host when it owns the state, otherwise by the front end (HOST-004). |
value |
object | {} |
derived | Summary {pv, sp, op, mode}. Derived: by the host when it owns the state, otherwise by the front end. |
Common traits (8), 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. |
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). |
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.