Inspector User Manual A Rapid Development Application for CERN instrumentation Bertrand LEFORT / Martino Ferrari BE/OP September 18, 2013 Bertrand LEFORT email: blefort@cern.ch BE/OP 1
Martino Ferrari email: maferrar@cern.ch BE/OP 2 Concept! 5 When labview knows about working-sets 5 The Graphical User Interface! 6 It seems pretty hollow... but IT is not! 6 Main Panel Elements 7 Property Tree frame 7 Creating your own Property Tree 8 Defining a Single Custom Property 9 The Device frame and the Property frame 11 The Monitor Panel! 12 What is this black PANEL? 12 Monitors 13 Monitor Picker 13 Unbounded Monitors 15 Chart2D Monitor 15 Graph History Mode 16 Exporting the Data 17 History Data Mouse Tricks 18 Text Monitor 19 Vector indexes 19 Bounded Monitors 20 Bar Monitor 21 Gauge Monitor 22 List Monitor 22 Fixed Shape Monitors 23 Bertrand LEFORT email: blefort@cern.ch BE/OP 2
Martino Ferrari email: maferrar@cern.ch BE/OP 3 Fixed Shape and Boolean Arrays 24 Reshape Monitors 25 Reshape Action 26 Special Monitors 27 Write Button 27 Write button hiding/showing field 28 Labels 28 Frames 28 Monitors Common Commands 29 Change Monitor Range Menu 29 Change PLS Menu 29 Change Unit Menu 29 Under-Sampling Menu 29 Changing Colors Menus 30 Changing Text Appearance 30 Monitor Panel Basic Features 30 Resizing / Scaling 30 Rotating 30 Copy & Paste 31 Copy & Mutate 31 Undo 31 Multi Selection & Multi Move & Multi delete 31 Creating Synoptics! 32 Start forgetting about LABVIEW 32 Picture Container 32 Bertrand LEFORT email: blefort@cern.ch BE/OP 3
Martino Ferrari email: maferrar@cern.ch BE/OP 4 Synthetic Values! 36 Creating new values combining Properties 36 The Equation editor interface 36 Creating a Synthetic PropertyValue 38 Logging Values! 42 Saving values to disk in circular buffers 42 Local Server VS Distant Server 44 Vistar Mode! 44 Disabling Editing Mode 44 Starting The Inspector! 46 Java Web Start 46 Inspector Binary File 46 Command line Parameter 46 Bertrand LEFORT email: blefort@cern.ch BE/OP 4
Martino Ferrari email: maferrar@cern.ch BE/OP 5 Concept What is the Inspector? WHEN LABVIEW KNOWS ABOUT WORKING-SETS Inspector highlights: A super working-set for all the CERN devices used in the accelerators complex. A debugging tool to allow Operators quickly monitor a device. A data logger to save to disk any value with periodic and aperiodic triggers. A data history browser to retrieve logged data. An Equation Editor to process data from several sources in real time. An Alarm system that can alert you on your cell phone or email when something is going wrong. A rapid development framework to generate simple applications without writing any lines of code (neither Java, nor XML). Many of the actuals OP applications can be re-created using the Inspector in few minutes... without writing a lines of code (neither Java, nor XML). Bertrand LEFORT email: blefort@cern.ch BE/OP 5
Martino Ferrari email: maferrar@cern.ch BE/OP 6 The Graphical User Interface simplicity is the ultimate form of sophistication IT SEEMS PRETTY HOLLOW... BUT IT IS NOT! When you start the Inspector without loading any Panel The interface looks like that: An inspector started without default panel. A Panel is like a Tab in Firefox, one Inspector can run several tabs at the same time. Tabs can be added or removed pressing the corresponding symbols. The window is divided in 3 and has 3 useful menus (a Property Tree, a Synthetic Property drawer (hidden) and a right click contextual menu). Bertrand LEFORT email: blefort@cern.ch BE/OP 6
Martino Ferrari email: maferrar@cern.ch BE/OP 7 Main Panel Elements The following illustrations shows the location / functionalities of the main panel. Open/Save Panel Show / Hide Drawer New Tab Under-Sampling Machine selector Working Set Move / Resize Select Add Handler History Window Size Remove Handler Copy & paste Monitor Contextual Menu Rotate Shape Equation Editor Synthetic Property Drawer Property RBAC Tokken Selector Vistar Mode Property Tree frame On the top left part of the window you will find the working sets as you know them (more or less, in the Inspector, they are alphabetically sorted). You can browse through the tree of working sets in order to select a Device as you were doing when using the JAPC working-sets launcher. Bertrand LEFORT email: blefort@cern.ch BE/OP 7
Martino Ferrari email: maferrar@cern.ch BE/OP 8 In the previous illustration, only the CTF3 working-sets are visible but you can access the working-sets of any accelerator: go to the Machine list and select the desired machine. If you don t find your machine in the list, click on Other machine and enter the operational context name (ex: ADEOP, LN4OP...). The working sets will be automatically retrieved from the data base (it may takes few minutes). As soon as the retrieval ends, the new machine name will added to the machine list. The Machine list opened. If you want to access a property that is not included in any CERN workingsets try right-clicking in the black frame and select ADD PROPERTY. If you often need to access this property, you can create your own Property Tree. Creating your own Property Tree When you need to access a set of undeclared properties on a regular basis, you can create your own Property Tree in the Machine Selector. Go to the Machine Selector, click on Other Machine and select Define a new local working set Bertrand LEFORT email: blefort@cern.ch BE/OP 8
Martino Ferrari email: maferrar@cern.ch BE/OP 9 Once clicked on Define a new local working set, the following window will appear. User-defined Property Tree. The + and - Sign allow to add/remove branches (and leaves). Each time the Add button is pressed, the Inspector if the user wants to define a Device or a device s Property. The Save button allows to save the tree on the user local folder. This tree will, now on, appears automatically in the Machine list. Defining a Single Custom Property When you want to create only one custom Property (Property exported by a FESA class but not included in a machine working set) you can use the ASCParameterChooser to create it. Bertrand LEFORT email: blefort@cern.ch BE/OP 9
Martino Ferrari email: maferrar@cern.ch BE/OP 10 ASCParameter Chooser allows to browse the CERN data base and to retrieve an already exported Property. This Chooser offers auto-complete capabilities. To access the ASC Parameter Chooser, do a right click in the Monitor Panel (the black panel with the grid) and select the Add Property menu entry. Bertrand LEFORT email: blefort@cern.ch BE/OP 10
Martino Ferrari email: maferrar@cern.ch BE/OP 11 The Device frame and the Property frame When a Device is selected, the list of the corresponding properties is displayed in the bottom left corner. Usually, users familiar with the officials CERN working-sets, only expect to see one element when they click on a device. Here, all the properties of a device are accessible separately (CCV, AQN, STAQ...). If you just modified the CERN Properties database, you can force the refresh of the list doing a right click and selecting the Refresh Working Set (may takes several minutes). If the Property Tree is local (user defined). The user can edit it doing a right click and selecting the Edit Working Set. If the Property Tree is local (user defined). The user can delete it doing a right click and selecting the Delete Working Set. Once a device is selected, all its properties appear! Bertrand LEFORT email: blefort@cern.ch BE/OP 11
Martino Ferrari email: maferrar@cern.ch BE/OP 12 The Monitor Panel Where the magic takes place WHAT IS THIS BLACK PANEL? A great part of the interface is a black grid called Monitor Panel. This area is where you are going to create your application and/or visualizing your data. Just using Drag & Drop! To start using the inspector drag an item from the Device Tree or from the Property Tree and drop it onto the Monitor Panel. After a property Drag & Drop, the inspector panel ask the user the PLS equation he wants to use to read this property. You can drag and drop any PROPERTY (or DEVICE) of any DEVICE into the Monitor Panel. When you perform this action, the inspector will ask you with which PLS equation you want to work with (if CCM is running, the default CCM equation is used). Bertrand LEFORT email: blefort@cern.ch BE/OP 12
Martino Ferrari email: maferrar@cern.ch BE/OP 13 The PLS equation defines how a value is sampled. If you don t know nothing about PLS try to use the default one, if it is not allowed by the component, try to use <MY_OP_CONTEXT>.USER.ALL. If it is still not working, ask someone with more experience. MONITORS Depending of the data type of the Property, the Inspector propose a set possible graphical representation for them. There is two main kinds of Monitors: The unbounded Monitors that handle unbounded values and the bounded Monitors that needs to know the value range to be able to represent it graphically. The Monitor selection process is realized using the Monitor-Picker. Monitor Picker Once the PLS equation is defined, the Inspector offers the possibility to pick up a representation for this data. The Inspector panel asking the user how to shows this property Bertrand LEFORT email: blefort@cern.ch BE/OP 13
Martino Ferrari email: maferrar@cern.ch BE/OP 14 You can select among the following representations: A 2D plot with an X-axis that depends on the data type. This monitor accepts multiple scalar plots or a single vector plot. The Graph monitor offers the possibility to display vectors using the Waterfall mode. A text display that shows the value of the property along with a title/name. It also allows to display one dimension vector. A bar graph that shows the intensity of a property within a defined range. A clock type representation that shows the intensity of a property within a defined range. A list that looks like the official working-sets. Number of column can be edited using the contextual menu. A squared shape that changes colors depending on the value it represents. A configurable shape that changes colors depending on the value it represents. Not all the Properties can be displayed using all the possible representation... but don t be worry, the Inspector shows only relevant monitors. When a Property can be written, the Monitor Picker also offers to create a WRITE button. The following illustration shows the possible representation offered by the inspector. Bertrand LEFORT email: blefort@cern.ch BE/OP 14
Martino Ferrari email: maferrar@cern.ch BE/OP 15 Inspector Main Monitors. UNBOUNDED MONITORS The following monitors does not require any range to be defined. Chart2D Monitor The Graph is the best way to monitor a value when want to be sure of its stability through time. Bertrand LEFORT email: blefort@cern.ch BE/OP 15
Martino Ferrari email: maferrar@cern.ch BE/OP 16 The inspector panel displaying a value through time You can add several scalar plots on the same GRAPH Monitor doing successive drag and drops of properties, even if they do not belong to the same accelerator The red corner on the bottom right corner of the GRAPH Monitor is fitted with a red handle. This handle is used to resize any component (all the inspector component are resizable in real-time). You can also move the window dragging from the grey part. Graph History Mode All the values handled by the Inspector comes automatically with an History. Standard history size is 1000 points. Logged values can have an history up to several month (see chapter on Logging)! The Inspector 2D graph has an embedded history browser that can be opened using the HISTORY entry of the contextual menu (right click). Bertrand LEFORT email: blefort@cern.ch BE/OP 16
Martino Ferrari email: maferrar@cern.ch BE/OP 17 The 2D graph showing the embedded history browser. The history browser, once open, shows all the data gathered by all the Inspector servers. The range is indicated by the time scale and 2 cursors allow to select the part of the history that must be displayed in the main Graph monitor window. Once part of the history is selected the upper graph is updated with the history data. The history data can be exported to Coma separated (CSV) files using the right click. See the chapter on logging for further information. Once part of the history is selected the upper graph is updated with the history data. To To go back to the real time data, the user has to move the cursors to the top end of the history plot (both cursors at the end of the plot). Exporting the Data The time range selected in the History chart is displayed in the main Chart 2D panel. This data sub-set can be exported to a CSV file. Bertrand LEFORT email: blefort@cern.ch BE/OP 17
Martino Ferrari email: maferrar@cern.ch BE/OP 18 A Graph 2D Monitor showing the embed history chart and the Export Logs window. When selecting the Export Logs menu entry, a pop-up window appear. This window allows the user to select one or several plots to export. History Data Mouse Tricks In oder to help the user retrieving data the history plot offers the following trick: The history window can be moved just clicking (both cursors move together). The history window can be make bigger/smaller using the mouse wheel. The history data can be Zoomed / Cropped double-clicking on a cursor (the grey part next to the cursor will be removed from the data set) Bertrand LEFORT email: blefort@cern.ch BE/OP 18
Martino Ferrari email: maferrar@cern.ch BE/OP 19 Text Monitor The Text monitor can represent any kind of values. The unit is also displayed when defined in the data base. The inspector panel displaying value using a Text monitor. Vector indexes Numerical vectors indexes are numbered from left to right. The number also corresponds of the index in the arrays. This number can be used in the Equation editor to extract a single value from an array (a[n] function where n is the index number). Bits vectors use reversed numbering: the less significant bit is at the rightmost position and has the index set to zero. The monitor title can be changed /removed in the contextual menu (right click). The monitor unit can be changed/removed in the contextual menu (right click). When displaying a large vector, the total array window is not showing all the values but it is always possible to move the cells to the left or to the right using the mouse s wheel. When monitoring large vectors it is possible to under-sample the Property in order to save machine resources (bandwidth and CPU). See Chapter on Under-sampling Bertrand LEFORT email: blefort@cern.ch BE/OP 19
Martino Ferrari email: maferrar@cern.ch BE/OP 20 BOUNDED MONITORS All the other Monitors ask the user to define the Monitor range. Inspector panel asking for the range of the Property When defined in the CERN database, the range is retrieved automatically and the user only need to confirm the database range value. The database range can always be overridden. Bounded monitors don t accept NaN as Minimum or Maximum Value. The RANGE is also used by the Inspector to define Property visual alarms. By default, a property has 5 levels of alarm: NOMINAL: When the value is at more than 20% of its bounds WARNING: When the value is inside a range defined by [10%, 20%]MIN AND [20%, 10%]MAX DANGER: When the value is inside a range defined by [MIN, 10%MIN] U [10% MAX, 10%MAX] See the chapter on the Gauge Monitor. Bertrand LEFORT email: blefort@cern.ch BE/OP 20
Martino Ferrari email: maferrar@cern.ch BE/OP 21 Bar Monitor The Bar Monitor displays only numerical values. The display color will change when the value is reaching any of the NOMINAL, WARNING or DANGER zones. The default name is the full Property name and can be overridden by the user. The inspector panel displaying the same value using a Text monitor, a Graph monitor, a Bar monitor and a Gauge monitor. The Bar Monitor is green because the value is NOMINAL. The NOMINAL, WARNING and DANGER colors can be configured using the right click menu. Bertrand LEFORT email: blefort@cern.ch BE/OP 21
Martino Ferrari email: maferrar@cern.ch BE/OP 22 Gauge Monitor The Gauge Monitor displays only numerical values. The NOMINAL, WARNING and DANGER areas are represented on the Gauge. The unit is also displayed when indicated in the database. The unit can be overridden by the user. The default name is the full Property name and can be overridden by the user. The Gauge monitor: In this case, the range is from 0.0 to 100.0, the DANGER area is red, the WARNING area is orange and the nominal area is white. The Actual value is 35.6 and the unit is E-9 mb. The Value name is indicated at the bottom. The colors can be configured using the right click menu. List Monitor The List Monitor can represent any type of Properties. When clicking on the table field, more information is retrieved from the CERN databases and displayed in the Description text filed. The content of the table can be filtered out and the number and the size of the column configured. Bertrand LEFORT email: blefort@cern.ch BE/OP 22
Martino Ferrari email: maferrar@cern.ch BE/OP 23 A list monitor showing a value. You can Drag and drop from and to this monitor. for example, you can select a property and drop it on an already created GRAPH monitor or on the monitor panel itself. You can event select SET of properties and drag and drop them! Large lists can be filtered using the filter text field. Only the Properties matching the text filter are displayed. The default columns setting includes low level information like the Property class, the PLS used and the Reference Property (The Property that controls this property). Visible columns can be configured in the contextual menu. Fixed Shape Monitors A range limited value state can be represented by a colors depending on the Property value (NOMINAL, WARNING and DANGER states). Fixed Shape monitors represents a value state using a color code. Fixed Shape can be interconnected by lines in order to represent a relation (lines are only graphical elements). Bertrand LEFORT email: blefort@cern.ch BE/OP 23
Martino Ferrari email: maferrar@cern.ch BE/OP 24 Fixed shapes can be resized and rotate (right button click on the handler) and can display a text label. Fixed Shape monitors showing inter-connected and rotated. The monitor rotation is performed using right click on the monitor red handler (it appears when the monitor is selected). The rotation range is [-90, 0] degrees. Fixed Shape and Boolean Arrays When manipulating Property values of type Boolean Array the Monitor Picker offers to the user the possibility to create one Fixed Shape for each boolean value contained in the array. In the following example the I2B array has been converted in 8 independent Fixed Shape using a mouse center button drag-and-drop from the array to the Monitor Panel (black background). Bertrand LEFORT email: blefort@cern.ch BE/OP 24
Martino Ferrari email: maferrar@cern.ch BE/OP 25 Result of the conversion of a Text Monitor to a Fixed Shape Monitor for a Boolean Array value. A Monitor can be converted from one Monitor type to another using a mouse center button drag and drop. Reshape Monitors A range limited value state can be represented by a colors depending on the Property value (NOMINAL, WARNING and DANGER states). Reshape Monitors are polymorphic components that can take any shape. Reshapes monitors can be shaped moving either a single Reshape Handler or a segment between two Reshape Handler. The number of handlers is dynamic: double click creates an handler, middle click on a handler delete it. Bertrand LEFORT email: blefort@cern.ch BE/OP 25
Martino Ferrari email: maferrar@cern.ch BE/OP 26 A Reshape Monitor in DANGER state showing 4 handlers. The previous Reshape monitors in NOMINAL state with the lower right handler moved down. The previous Reshape monitors in Warning state with an extra handler. The user can move either a single handler or a line. Reshape Action It is possible to associate an action to the Reshape Monitor double-click. An action is either opening a new panel (or going to a panel if already opened) or running an external shell command. Bertrand LEFORT email: blefort@cern.ch BE/OP 26
Martino Ferrari email: maferrar@cern.ch BE/OP 27 To define the action that will be executed after a double-click, double-click the Reshape Monitor. The Reshape monitors asking the user the kind of action to define. SPECIAL MONITORS Write Button Some Properties can be written. This action can be done using the WRITE button. This button is proposed to the user by the Monitor Picker after a Drag-and-drop action. The Write button can write more that one value at a time. The user can drag-and-drop Properties to the button s parameter drawer to add extra Property. A Write button that would write sequentially 3 Properties. Bertrand LEFORT email: blefort@cern.ch BE/OP 27
Martino Ferrari email: maferrar@cern.ch BE/OP 28 The Write button Property value text field can be initialized drag-and-dropping another Property on it. When a Property is discrete a combo box is displayed instead of a text field. Write button hiding/showing field The WRITE button parameter list can be hidden/shown using the upper right arrow. The button can be resized as all the others Inspector monitors. Write buttons with hidden parameters and different size. The user can move either a single handler or a line. Labels It is possible to add labels in the Monitor Panel and in the Image Container. To create a Label right click in the Monitor Panel background and select ADD LABEL. Frames It is possible to add Frames to the Monitor Panel and to the Image Container. To create a Frame right click in the Monitor Panel background and select ADD FRAME. Frames behave like the Image Containers and can be fully personalized (Title, background color and Border Color). Bertrand LEFORT email: blefort@cern.ch BE/OP 28
Martino Ferrari email: maferrar@cern.ch BE/OP 29 MONITORS COMMON COMMANDS All the Monitors come with a contextual menu. Some of the options are common to all the Monitors. Change Monitor Range Menu Bounded Monitors limits (Min and Max) can be the modified using the Change Monitor Range contextual menu entry. Change PLS Menu Properties are always read using a PLS equation (or Selector). The Inspector offers the possibility to change the PLS on-the-fly using the Change PLS menu entry. Change Unit Menu Properties, when properly defined in the CERN database, come with a unit associated to the value. When there is no unit defined or when the user want to change or remove the displayed unit the Change Unit menu entry can be used. The defined Unit will override the default unit. Under-Sampling Menu Property sampling rate can be high and Property value size really large (array of thousands of doubles). This kind of data are not interesting for the eye if they are un-processed beforehand. The Inspector offers two way to deal with this kind of data. The first way is to perform averaging or buffering using the Equation Editor (see the chapter on Equation Editor). The second way is to set an Under-Sampling Ratio to the sampled data. Under Sampling Ratio can be applied to real data as well as to Synthetic Data. An Under-Sampling Ratio two means that the Monitor will only display a value out of two. In other words the display will be refreshed at a frequency two times lower than before. Bertrand LEFORT email: blefort@cern.ch BE/OP 29
Martino Ferrari email: maferrar@cern.ch BE/OP 30 Changing Colors Menus Many parts of the Monitors can be personalized. When such type of menu entry is selected a Monitor color is displayed. This typical Color Picker allows to configure accurately the desired colors. The Color transparency is also parametrizable, it is useful when creating Synoptic based on a background image. Changing Text Appearance Many parts of the Monitors can be personalized. Some Monitors allow to change the font size. MONITOR PANEL BASIC FEATURES The Monitor Panel offers all the common user friendly commands. Resizing / Scaling Most of the Monitors allow to be resized dragging the monitor red corner with the mouse left button. Rotating Lot of the Monitors allow to be rotated dragging the monitor red corner with the mouse right button. Standard rotation are limited to the [-90..90] degrees range. Bertrand LEFORT email: blefort@cern.ch BE/OP 30
Martino Ferrari email: maferrar@cern.ch BE/OP 31 Copy & Paste All the monitors can be copied and paste using the traditional CONTROL+C and CONTROL+V keyboard short-cuts. Copy & Mutate Monitors also support Copy and Mutate to go from a graphical representation to another one. For example a multi-plots Graph Monitor can be converted in a Table Monitor drag-anddropping from the Graph Monitor to the Monitor Panel using the mouse middle button. Undo Undo is supported for all the move, delete and resize operation. Multi Selection & Multi Move & Multi delete Selection of various object is allowed. Selected object can be moved as a group and can be deleted using keyboard Delete key. Bertrand LEFORT email: blefort@cern.ch BE/OP 31
Martino Ferrari email: maferrar@cern.ch BE/OP 32 Creating Synoptics Background is the key... START FORGETTING ABOUT LABVIEW All the previously described monitors can be drag-and-dropped onto images to create synoptics. The first step to take to create a Synoptic is to include an image in the background. The inspector panel right click menu allows to add images to the background. PICTURE CONTAINER You can add pictures to the monitor background. This images will be used as a container to create synoptics: just drag and drop a Property onto the image or move already created Monitors onto it. The elements inside the picture will be considered as part of the picture. Bertrand LEFORT email: blefort@cern.ch BE/OP 32
Martino Ferrari email: maferrar@cern.ch BE/OP 33 The inspector panel with an image added to the background. The magnet symbol appearing in green has a Reshape Monitor set over the picture. The Picture Container like all the other Monitors can be resized using the red handlers. Resizing a picture with embedded monitors leads to misalignments between the picture and the Monitors position and should be avoided. The resizing should be done before inserting Monitors. Bertrand LEFORT email: blefort@cern.ch BE/OP 33
Martino Ferrari email: maferrar@cern.ch BE/OP 34 The Reshape is now over the drawing of the BHN 45 magnet and represents its state. A Text Monitor has been added next to it. The Text Monitor Title and Unit has been removed. This monitors is transparent so the background is visible, the color change in function of the range defined by the user. A single Picture Container can represents an entire Machine. Hereafter the Synoptic designed for the AD. All the AD devices are included in the Picture Container. All the elements are also clickable and open a Specialist panel showing detail about the (failing) element. Bertrand LEFORT email: blefort@cern.ch BE/OP 34
Martino Ferrari email: maferrar@cern.ch BE/OP 35 All the AD devices displayed in a single Picture Container. An action can be associated to a Reshape Monitor double click. It is possible to trigger the opening of a panel or to execute an external shell command. Bertrand LEFORT email: blefort@cern.ch BE/OP 35
Martino Ferrari email: maferrar@cern.ch BE/OP 36 Synthetic Values When creativity is the only limit... CREATING NEW VALUES COMBINING PROPERTIES The Properties can be processed / combined to create new virtual properties called Synthetic Values. Equation Editor Synthetic Property Drawer The 2 buttons that give access to the already existing Property Drawer and to the Equation editor are located in the upper right corner of the GUI. The Equation editor interface The Equation Editors GUI works like a labview panel. Blocks representing either operators or functions are inter-connected by lines. Blocks may hay have inputs and/or outputs. Operators and functions may not accept all the types of data (i.e.: boolean function can t process strings). Bertrand LEFORT email: blefort@cern.ch BE/OP 36
Martino Ferrari email: maferrar@cern.ch BE/OP 37 Constant Block Operators Block Function Block Alarm Block Property Trigger (PLS or time constant) Already Created Synthetic Properties are in the hidden drawer. Moving a block out of the frame delete it Property Name Property Description Button Equation Editor GUI. The shown equation convert a double result to an integer result and transform the result into an array of bits. When an output is selected, incompatible inputs are disabled (grey color). The different blocks types are detailed in the following table. Name Constants Block functionality To create a constant, the type is defined based on the value format. The constant value can be initialized doing a Drag & Drop of a readable property on the constant block. Operators Block Function Block All The mathematical, boolean and bits operators are accessible through this block. All The mathematical, arrays and filters functions are accessible through this block. Data type converters are also included in the Functions. Bertrand LEFORT email: blefort@cern.ch BE/OP 37
Martino Ferrari email: maferrar@cern.ch BE/OP 38 Name Alarm Block Property Trigger functionality An alarm block take a boolean as input. When the boolean goes FALSE, it sends an alarm to the recipient (TO field). The recipient can be a CERN telephone number or a CERN mail address. The Alarm will be active for DAYS days (zero days mean meanwhile the property exist in my computer ). The property trigger is another PROPERTY or SYNTHETIC PROPERTY VALUE. When the trigger is received, the others properties used in the equation will be READ (no subscriptions) and the final value computed. Double clicking the Trigger allows to create a constant frequency trigger. Synthetic Property Drawer Property Description The already existing synthetic property values are listed in the property drawer. They can be used as a normal property. The description of the newly created property. Creating a Synthetic PropertyValue To illustrate the easiness of creating a Synthetic Property, we will show the step by step creation of a graph gathering a plot of value and a plot of its moving mean based on the 50 last acquisitions. Bertrand LEFORT email: blefort@cern.ch BE/OP 38
Martino Ferrari email: maferrar@cern.ch BE/OP 39 The Example we are about to recreate: we show a Vector, its mean, the first value, the moving average of the array, the first Value moving average and, finally, the plot of the first value of the array and its mean. Step 1: Creating the Array mean Drag-and-drop the Array Property and the function block. Double click the function block and select Mean of an Array Press Done at the bottom of the window, the Monitor Picker will ask you to pick a representation: select the Text Monitor. Step 2: Extracting Array first Value Bertrand LEFORT email: blefort@cern.ch BE/OP 39
Martino Ferrari email: maferrar@cern.ch BE/OP 40 Drag-and-drop the Array Property and the function block. Double click the function block and select Array value Extraction. DnD a constant and set its value to zero to force the type to integer. Connect the constant and the Property to the Function Block. Press Done at the bottom of the window, the Monitor Picker will ask you to pick a representation: select the Text Monitor. Step 3: Creating the Moving average of the First Value Bertrand LEFORT email: blefort@cern.ch BE/OP 40
Martino Ferrari email: maferrar@cern.ch BE/OP 41 Open the Synthetic Property Drawer, and Select the Array First Value Synthetic Property. Drag-and-drop the Array the function block. Double click the function block and select Moving Average. Drag and drop a constant and set its value to 50 (the number of Acquisition, the size of the window). Connect the constant and the Property to the Function Block. Press Done at the bottom of the window, the Monitor Picker will ask you to pick a representation: select the Text Monitor. To create the Graph Monitor, drag and drop the Text Monitor you just created using the mouse middle button. When you release the button the Monitor Picker will ask you to pick a representation: select the Graph Monitor. To create a new Plot inside the graph, just drag and drop the Array First Value Synthetic Property from the Synthetic Property drawer to the Graph Monitor. Bertrand LEFORT email: blefort@cern.ch BE/OP 41
Martino Ferrari email: maferrar@cern.ch BE/OP 42 Logging Values When you need it written... SAVING VALUES TO DISK IN CIRCULAR BUFFERS Any monitor can be logged to disk in just a (right) click. When the logging is required, a dialog appears that allows to start the logging on a local or on a remote server. The logging will maintain the last DAYS of data in the buffer. To do the logging on a local server, it is enough to click on new server. The logging dialog. When a value is logged by the Inspector, it appears in blue in the Property Tree. Bertrand LEFORT email: blefort@cern.ch BE/OP 42
Martino Ferrari email: maferrar@cern.ch BE/OP 43 In this illustrations 2 Devices appears in blue. It means that the have sub Properties logged. Clicking on a device the user can have access to the logged Properties. Right clicking on the logged Properties, it is possible to know the list of PLS equation logged. Bertrand LEFORT email: blefort@cern.ch BE/OP 43
Martino Ferrari email: maferrar@cern.ch BE/OP 44 Local Server VS Distant Server Inspector servers are distributed on several servers. If you have high disk / CPU needs you should start a local server that will handle your data using your disk quotas. If your local server is killed, The inspector will restart your logging on its own servers!! To retrieve and export the Data use the Graph Monitor with the desired Property value(s). See Chapter on the Graph Monitor History. Vistar Mode When you want to show your work... DISABLING EDITING MODE Once your panel done, you can switch from the editing mode to the Vistar Mode. The Vistar Mode block any further modification. When Going to Vistar Mode the Undo history is flushed. The two following illustrations show the difference between the Edit Mode and the Vistar Mode. Bertrand LEFORT email: blefort@cern.ch BE/OP 44
Martino Ferrari email: maferrar@cern.ch BE/OP 45 Inspector in EDIT mode, all the controls are available. Inspector in Vistart mode, The drawers are hidden and it is no longer possible to move the components. Nevertheless, the Graph Monitor zooming capabilities are maintained. Bertrand LEFORT email: blefort@cern.ch BE/OP 45
Martino Ferrari email: maferrar@cern.ch BE/OP 46 Starting The Inspector If you want to have it jusst for you... JAVA WEB START The inspector uses Java Web Start (also known as JavaWS, javaws or JAWS). This is a framework developed by Oracle that allows users to start applications directly from the Internet. Some key benefits of this technology include seamless version updating for globally distributed applications and greater control of memory allocation. Inspector Binary File Inspector files can be retrieved / run using the following link http://abwww.cern.ch/ap/dist/ ade/ade-inspector/pro/inspector.jnlp Command line Parameter Inspector supports the following command line parameters: Bertrand LEFORT email: blefort@cern.ch BE/OP 46
Martino Ferrari email: maferrar@cern.ch BE/OP 47 Parameter --tgm=selector functionality The Tgm library need to know the machine the user is about to control. Linux workstation : The Tgm library uses a environment variable call TGM_NETWORK. This variable can be set using the 'setenv' Linux command (setenv TGM_NETWORK OPER.LIC). If this environment variable is not set, the default value in the library will be set to OPER.LIC Windows PC : Like Linux workstations, the Tgm library uses the TGM_NETWORK environment variable. it can be set by opening the control panel and selecting the system icon. In the 'System Properties', select the Avanced' tab and press 'Environment Variables' button. Il will open a window that allows you to define the TGM_NETWORK environment variable. If the environment variable is not defined, the default value OPER.LIC will be used. The inspector allows to override this variable. The possible values are: OPER.LIC for PSB, LEI, CPS, ADE, SPS. OPER.CTF for CTF, SCT, FCT. OPER.LHC for LHC. CLN4.LN4 for the Linac 4 file1 file2 file3... --viewmode The XML files to load. Files will be loaded in separated tabs. To open the inspector in Vistar mode. This option is valid only if the command line also specify at least one panel to open. Bertrand LEFORT email: blefort@cern.ch BE/OP 47