SounderSupervision¶

Overview¶

Circuit health for an audible alarm signaling device. It is independent from the Sounder active state, so a sounder can be active and faulty at the same time.

When to Use¶

Siren or bell circuit open detection
Sounder output overload detection
Supervised audible alarm outputs

States¶

State	Status id	Description
`Normal`	`supervision.normal` (hidden)	No sounder supervision fault is active
`Fault`	`supervision.fault`	Sounder circuit fault is active

Normal is the hidden default state: SetNormal(ct) publishes no status string, so the function status is removed from the published status snapshot.

Actions¶

Action	Target State	Event
`SounderFault(timestamp, faultType)`	`Fault`	`pq.event.alarm.sounder.fault`
`SounderFaultCleared(timestamp, faultType)`	`Normal`	`pq.event.alarm.sounder.fault.cleared`

faultType is an optional string that identifies the device-reported fault cause and is included in the event payload.

Each action sets the target state and publishes its listed event. Route a confirmed device transition to the matching action; do not publish the same PqEvent separately.

SounderSupervision holds one circuit-health state. Each SounderFaultCleared call sets it to Normal, irrespective of faultType; it does not track independent fault causes.

YAML Example¶

device_types:
  - type_id: AlarmSiren
    functions:
      SounderSupervision: