Automation Button NEW

This text is AI-generated

This documentation was written with the help of AI and has not been fully reviewed. If something is wrong, unclear or missing, please let us know. Use the feedback form, and say which section it concerns.

The Automation Button NEW is a generic symbol for a device in a single-line diagram or mimic: one component that can be a switch or a converter, depending on the icon you select. It is found in the Automation - OpenBridge section of the Perspective Component Palette as Automation Button NEW (Beta).

Note: This component is in beta: its properties may change in a later version.

1. Icon — the symbol of the device, drawn for the on or the off state. See Icon and State.
2. Tag — the name of the device. See Tag and Values.
3. Values — any number of rows with a number and a unit.

The component shows the state it is given; it does not change it, and clicking it does nothing unless you configure an event.

An Automation Button NEW dropped from the palette with default properties. The blue frame is the component’s box, as the Designer shows it when the component is selected:

How It Relates to the Other Automation Buttons

The automation buttons — Switch, Converter, Pump and the others — are one component per kind of device. Each draws its icon on a button, shows a status row with On or Off, and has an alert frame, badges, a progress ring, three sizes and a choice of positioning.

The Automation Button NEW follows the newer OpenBridge design for automation symbols, and is one component for several kinds of device:

	Automation Button NEW	Switch, Converter, …
Device	Selected with icon: three switches, four converters.	One component per kind of device.
Drawing	The icon alone, directly on the line.	The icon on a button, or alone with the flat variant.
Text	A tag and any number of value rows.	A status row and a tag.
Number format	numberFormat.	—
Alert frame	No.	Yes.
Badges	No.	Yes.
Progress ring	No.	Yes.
Sizes	One size.	componentSize.
Positioning	The icon is always centred in the box.	positioning.

Use the Automation Button NEW where a device should show measured values, such as voltage and current, next to its symbol. Use the specific components where you need an alert frame, badges or a progress ring, or a device that the Automation Button NEW has no icon for.

---

Icon and State

icon selects the symbol, and on selects whether it is drawn for the on or the off state. Bind on to the state of the device. orientation rotates the icon 90° counter-clockwise for a vertical line; the text is not rotated.

icon	Off	On	Off, vertical	On, vertical
switch-01 (default)
switch-02
switch-03
converter-acdc
converter-dcdc
converter-dcac
converter-filter-1

• switch-01, switch-02, switch-03 — switching devices: a link, a blade with contact points, and a changeover switch.
• converter-acdc, converter-dcdc, converter-dcac — converters from AC to DC, DC to DC and DC to AC.
• converter-filter-1 — a filter, drawn with a diode symbol.

The off drawing is grey, the on drawing is in the colour of an active line. When on, the icon also gets a thin outline in the background colour, which separates it from a line drawn underneath it.

Properties

Name	Description	Property Type
icon	The symbol, one of the seven values in the table above. Default switch-01.	value
on	Whether the device is on. Selects the on or the off drawing of the icon. Default false.	value
orientation	horizontal, or vertical to rotate the icon for a vertical line. Default horizontal.	value

---

Tag and Values

Set hasTag to true and tag to the name of the device to show it next to the icon. readouts is a list of values: each item has a value and a unit and gives one row below the tag. The numbers are right-aligned and the units left-aligned, so the rows line up.

Tag only	Values only	Tag and values

Unlike the other automation buttons, this component has no status row: it does not write On or Off.

Label Position

labelPosition places the tag and the values on one of the four sides. The icon is always in the centre of the component’s box, and the text is drawn outside the box, starting at its edge. The blue frame is the component’s box:

labelPosition
top
bottom (default)
left
right

Keep the box at its default 48 × 48. In a larger box the icon stays in the centre and the text moves away from it with the edge of the box:

Number Format

numberFormat is a Java DecimalFormat pattern that is applied to every value. The digits after the decimal point set the number of decimals: a 0 is a decimal that is always shown, a # one that is shown only when needed. A , in the pattern turns on the thousands separator. The separators themselves follow the language of the browser.

The value 1234.5678 with four patterns:

#,##0.## (default)	0.00	#,##0.0	0

Properties

Name	Description	Property Type
hasTag	Show the tag. Default false.	value
tag	Name of the device, for example Q101. Only shown when hasTag is true.	value
labelPosition	Side the tag and values are on: top, bottom, left or right. Default bottom.	value
readouts	The value rows. Empty by default.	array
readouts[].value	The number. Default 0.	value
readouts[].unit	Text after the number, for example V. Empty by default.	value
numberFormat	DecimalFormat pattern for the values. Default #,##0.##.	value

---

Properties

Name	Description	Property Type
style	Standard Perspective style object.	object

The colours follow the OpenBridge palette of the session:

Component Events

The Automation Button NEW has no component events of its own. The standard Perspective events, such as onClick, are available in the component’s event configuration. See Operating a Device.

Examples

Example 1 — Rectifier with Voltage and Current

1. Drop an Automation Button NEW into a coordinate container, with the centre of its box on the line.

2. Set:

   Property	Value
   icon	converter-acdc
   hasTag	true
   tag	T101
   labelPosition	right
   numberFormat	#,##0.0

3. Add two items to readouts. Set their unit to V and A, and bind their value to the measurements, for example [default]Rectifier01/Voltage and [default]Rectifier01/Current.

4. Bind on to the state of the converter, for example [default]Rectifier01/Running.