Control System Studio: BOY Details

Control SystemStudio:BOY DetailsKay KasemirORNL/SNSkasemirk@ornl.govA lot of material fromNadine Utzel, ITERand BOY online helpby Xihui Chen, SNSJune 2014ORNL is managed by UT-Battellefor the US Department of Energy

BOY Font, Color PreferencesMenu CSS, Preferences:– Locate the BOY settings– Check Color File, Font File, Top OPIs:Are they set to use files from the BOY Examples?– Open associated files in text editor2

Font, Color NamesWhen configuring a color(foreground, background, border, ) or font (Text Update font, ),you have two options:a)Pick any color or font– RGB resp. Name, Typeface, Sizeb)Pick a Predefined Color resp.FontWhat is better? Why?3

Exercise: Use Predefined Fonts Add a Label to your display– Set font to the predefined Title font– Set text to something like “This is the Title” Add another Label– Assert that it uses the “Default” font4

Portable Usage of FontsFonts differ between operating systems: “Times New” vs. “adobe-times-.” etc.How can an OPI file “Look the same” on Windows, OS X, Linux?1. If possible, install the same fonts on all your computers–Microsoft “Office” fonts available on most Windows and Mac OS computers because they alsorun MS Office–MS Office fonts are also available for Linux! Google “free office fonts Linux”2. BOY fonts.def file allows system-specific tweaks# Though using the same MS Office font# on all operating systems, the sizes seem# somewhat different.# Fix that by using different sizes for# each OS:Default Verdana-regular-10Default(macosx cocoa) Verdana-regular-14Default(linux gtk) Verdana-regular-10# Same with “Header1”: OS X needs bigger font# for same on-screen pixel sizeHeader1 Verdana-bold-24Header1(macosx cocoa) Verdana-bold-365

Exercise: Schema File Create a new display file “schema.opi”– Add a Text Update Background Color: Yellow Foreground Color: Red– Save, close the schema.opi Menu CSS, Preferences, CSS Applications, Display,BOY, OPI Editor– Set the “Schema OPI” to the schema.opi that you justcreated Create a new OPI file– Add a Text Update widget– Notice its initial Background & Foreground color?6

Preferences:Top OPIs, Site wide settings Top OPIs: Appear in Toolbar Path names for color & font files, “Top” OPIs,Schema can be web links– Instead of /BOY nt.defGood for site-wide files like your top-level controlsystem screen!7

Suggestions for your site After gaining some experience with BOY, somebody with design talentsdefines which colors, fonts, to use for displays at your site Pick fonts that look similar on all operating systems Create color.def, font.def, schema.opi– Place these on a web server– Configure CSS for your site to use the http:// paths to the *.def and schema.opi You can put your *.opi files into CVS– or subversion, Mercurial, GIT, CSS can include support for these Each night, you can publish the current *.opi files from CVS on your webserver– Point the “Topi OPIs” to http://web.server/opis/main.opi– End users can now easily run the “current” version from the Toolbar8

Main Idea: Simple Things are Easy1. Drag a widget, e.g. Knob, from palette to editor2. Enter the PV name in Properties view3. Click the “Run” button to execute!There is more, but don’t go overboard!Keep logic on the IOC.Display is only for the display.Don’t implement whole application in BOY.9

Widgets and Properties Galore Compared to EDM, MEDM, BOY tries to offerspecialized widgets– Grouping Container instead of Lines– LED instead of Circle-with-color-rule– Image Button instead of Images with conditional visibilityin front of invisible button– Tabbed Container instead of embedded window, manyinvisible buttons, conditionally visible graphics, local PVsto update the display inside the embedded window . with many Properties– Alarm sensitive Border/Background/ – Precision, Limits, from PV or direct entry– Actions10

Widgets and Properties Galorebecause.Display file describes Meaning:LED to display something, not Circle that happens to changecolor.Group of related widgets, not rectangle that happens tosurround something.Border color to reflect alarm state, not arbitrary change incolor.Font name “Title”, not “Arial-bold-12”.Displays with same Representation (Lines, circles withchanging color, “Arial-bold-12”) look the same as displayswith Meaning (group, LED, Title).But they are like compiled binaries without source code. Lessuseful in the long run.In the future, files with Meaning will be easier to translate forother, new tools than files with only Representation.11

User Interfaces. are the visible, attractive part of the control system. are just that. Logic belongs onto the IOC. come and go. Don’t get too tricky with the currentone.12

Disclaimer: Rules & Scripts can change any property of any widget:– Change text of label based on a PV i.e. build your own Text Update– Change color of an Ellipse based on PV i.e. build your own LEDBased on last slide, that is a bad idea!Still, there are places where rules and scripts can bevery powerful.13

Rules, ScriptsRules create dynamic displays– Easy: PV Widget PropertyScripts can to “anything”– Read PVs,change widget properties,open dialog, – JavaScript or Python (Jython)14

Exercise: Rule to change color of EllipseCreate Ellipse widget Locate its Behavior, Rules Property Click the “no rule attached” value toopen the dialog to Attach (or edit) Rules Add a rule that changes thebackground color as shown between Redand Green, triggered by changes in thesim://sine PV Press “See Generated Script”, comparewith screenshot Maybe add another TextUpdate widget todisplay the same sim://sine PV Run the display15

Rules vs. ScriptsRules– are simpler: One or more PVs change one property– are closer to describing Meaning– are internally converted to scripts, but what’s saved in the*.opi file is the Meaning: Property to adjust, expressions forrule, input PVs– should be preferred to scripts whenever possibleScripts– can be pretty much any Java Script of Jython code– can affect multiple properties, widgets, even add and removewidgets– should be used with care, because they can be hard tomaintain in the long run Use org.cstudio.opibuilder.scriptUtil (PVUtil, ColorFontUtil) Add many source code comments16

Rules, Scripts in OPI Examples Open BOY Examples/5 3 Rules Script.opi, firstin Runtime, then in Edit mode Check the rules behind the “Left Win!” text abovethe two knobs Check the Scriptattached to theleft Knob Check the Scriptattached to themoving circle– How does it changeits color?17

Script-generated Displays OpenBOY etsExample.opiin Runtime mode Enter “myConfigExample.xml”, press “Load”.Enter “myConfigExample2.xml”, press “Load”.–Notice a difference? Open SubPanel.opi in Edit mode,change it slightly by setting the colorof the “Group ” label to violet,save, then press “Load”on LoadWidgetsExample.opi–See how it’s using the current versionof SubPanel.opi?Investigate how this is done!18–What PV is attached to the text fieldwhere you enter the *.xml file names?–What PV is attached to the “Load” button?–Note the script attached to the big Grouping Container that appears empty in edit mode, but isdynamically populated with copies of SubPanel.opi in runtime mode.–Read that script together with myConfigExample.xml.Writing such a script requires knowledge of the BOY widget model.You don’t have to write such a script, but you should be able to understand what it does.

Example: SNS “Steering” ToolTry to get spot intothe green, at leastinto orangeTim Southern, Nick Luciano19

Scripts can replace custom Applications!Display howbeam loss isincreased orreduced relativeto a “snapshot”SNS operation group:Tim Southern, Nick Luciano20

21GoodBad Add Widget, enter PV,done Add 5 widgets, usedynamic visibility, localPVs, scripts TextUpdate widget withenum, string PV Various overlapping Textwidgets with rule tochange visibility LED widget with PV Circle widget, filled withrule-based color Rule used once tohighlight a specialstate.Otherwise, update orcreate new widget. Rule attached to everywidget to display alarmseverity, because youdon’t like the alarmsensitive border

What not to do in scripts Check allowed values– Record’s DRVH, DRVL Perform interlocks– CALC records “Timer” Displays– CALC . Start threads to “Ramp Power Supply Voltage”– CALC records, Sequencer Write experiment data to file– Archive tool, area detector, SCAN record, .22

SummaryThere is a lot you can doin BOY– Macros, Rules, Scripts, Rememberthe Main Idea:Simply Things are Easy1.Add widget2.Enter PV Name3.Run23

BOY Details Kay Kasemir ORNL/SNS kasemirk@ornl.gov A lot of material from Nadine Utzel, ITER and BOY online help by Xihui Chen, SNS June 2014 . 2 BOY Font, Color Preferences Menu CSS, Preferences: –Locate the BOY settings –Check Color File, Font File, Top OPIs: