Automation Badge

This text is AI-generated — we need your feedback

This documentation was written with the help of AI and has not been fully reviewed. If something is wrong, unclear or missing, please tell us: open the feedback form, say which section it concerns and what you expected to read. The same link is at the bottom of every page.

The Automation Badge is a small icon that tells the control mode, the lock state or the alert state of a device. It is found in the Automation - OpenBridge section of the Perspective Component Palette as Automation Badge.

It is the same badge that the automation buttons draw in their corners (see Badges), as a component of its own. Use it where there is no automation button to carry the badge: beside a text, in a table row, in a faceplate or in a legend. For a badge on a pump, valve, switch or tank, use the badge properties of that component instead.

The badge shows the type it is given; it does not read tags or alarms itself.

An Automation Badge dropped from the palette with default properties:

Type and Mode

type selects the icon, and mode selects how much it stands out:

• flat (default) — only the icon.
• regular — the icon on a light chip with a border.
• enhanced — the icon on a filled, dark chip.

The level-*, alarm, warning and caution types have their own colours and are drawn the same way in all three modes.

type	Meaning	flat	regular	enhanced
auto (default)	Automatic control.
manual	Manual control.
manual-only	Manual control is the only mode available.
local	Local control.
local-only	Local control is the only mode available.
command-locked	Commands are locked.
interlock	An interlock is active.
interlock-inhibit	The interlock is inhibited.
alert-silenced	The alert of the device is silenced.
level-critical	Alert with priority level critical.
level-high	Alert with priority level high.
level-medium	Alert with priority level medium.
level-low	Alert with priority level low.
level-diagnostic	Alert with priority level diagnostic.
alarm	Alarm.
warning	Warning.
caution	Caution.

Use the level-* values in a project that uses priority levels, or alarm, warning and caution in a project that follows Bridge Alert Management.

The badge always shows an icon: there is no empty type. To show a badge only while a condition is true, bind meta.visible of the component to that condition.

Properties

Name	Description	Property Type
type	The icon of the badge, one of the values in the table above. Default auto.	value
mode	How much the badge stands out: flat, regular or enhanced. Default flat.	value

---

Size and Placement

The badge is 16 px at the regular size and is centred in the component’s box; resizing the component does not resize the badge. componentSize sets the size of the badge, in the same steps as the automation buttons:

regular	medium	large

The colours follow the OpenBridge palette of the session:

Properties

Name	Description	Property Type
componentSize	Size of the badge: regular, medium or large. Default regular.	value
style	Standard Perspective style object.	object

Component Events

The Automation Badge has no component events of its own. The standard Perspective events, such as onClick, are available in the component’s event configuration.

Examples

Example 1 — Show the Control Mode of a Device

1. Drop an Automation Badge next to the name of the device, and set mode to regular.

2. Bind type to the control mode with an expression, for example:

   if({[default]Pump01/Local}, 'local', if({[default]Pump01/Auto}, 'auto', 'manual'))

Example 2 — Show the Highest Alarm of a System

1. Drop an Automation Badge and bind type to an expression that gives the severity of the most severe active alarm of the system, as one of level-critical, level-high, level-medium, level-low or level-diagnostic.
2. Bind meta.visible to an expression that is true while the system has an active alarm, so that the badge is hidden otherwise.