Before deepening into Waltz , please, note a list of very simple actions, but they really worth doing while using web-applications: * Redo last actions * Refresh the page * Refresh the page with cache drop (CTRL+F5)

User guide

To start Waltz you should know the link to the application's entry point (e.g. https://fs-webtango.desy.de:8080/hzgxenvtest/).

The application is secured with the login and pass. The credentials should be given by admin department.

login

The application consists of 5 parts:

1) Top tool bar;

2) The bottom tool bar;

3) Left panel with Devices tree (the root is the REST API server mane), Device tree tab (with device name as a root) and a filter by text;

4) Main view with the 3 tabs: Dashboard, Scripting and Settings;

5) Right panel (collapsed by default) - Device Control Panel.

1_main_page_marked

Top toolbar

On the left has logos that link to the corresponded websites. On the right — the user name (by clicking on it you can access Setting tab) and logout button.

Bottom toolbar

On the left — REST API request status (shows current request to the Tango REST Server). Can have the following states: * pending — the request is being sent but no response yet; * done — response from Tango REST Server have been successfully received; * failed — no response or it has an error.

On the right bottom corner you will find

Left panel

Consists of 3 parts: Filter by text, Devices Controls Widget and Device Controls Widget.

Left panel filter

Simple filter by text.

Exercise: 

Write “tg” in filter box.
Delete “tg” in filter box.

Devices tree widget

Shows all devices you have. In this widget you can configure device, monitor all its attributes and delete it, also filter by text.

The devices tree widget has the following structure:

icon_host — Tango host (in this application it is a container of devices);

icon_aliases — devices aliases (in this application it is a container of devices);

icon_domain — domains, catalog of families within one tango host;

icon_family — family - catalog of devices;

icon_device — device.

Exercise: 

Expand “development”, “sys” → “tg_test”.

You can use aliases instead of members to feel more comfortable with the names.

1_main_page_device_config_prop

If you click on the device, all the commands, attributes and pipes related to this device will be show in the Control Panel on the right. The Device Controls Widget will be also updated.

Context menu

Right click on the device to open a context menu:

1_main_page_device_menu

Device widget

As soon as the device in the Devises' tree is chosen the device widget is updated.

Hint: Double click on the device in the Devices tree and you can see the device structure and info.

3_device_tab

Here you can: * get info about the device; * can see device's attributes, commands and pipes; * Drag-n-Drop Attributes to the Dashboard; * click on attribute or command or pipe to select it in Control Panel; * dbl click on attribute or command or pipe to expand Control Panel.

NOTE if you get the following error, this means that Tango device is not exported:

Reason: TangoProxyException Description: Failed to get proxy for tango://hzgxenvtest.desy.de:10000/development/camel/0:ProxyException in Failed to apply creation policy for proxy development/camel/0 PANIC: TangoApi_DEVICE_NOT_EXPORTED development/camel/0 Not Exported ! Connection(development/camel/0) ERR: TangoApi_CANNOT_IMPORT_DEVICE Cannot import development/camel/0 Connection.build_connection(development/camel/0)[Failed to apply creation policy for proxy development/camel/0:TangoApi_DEVICE_NOT_EXPORTED[development/camel/0 Not Exported !]] Origin: org.tango.web.server.TangoProxyPool.getProxy(TangoProxyPool.java:74)

Drag-n-Drop an attribute to add it to the dashboard tab in the main view. The dashboard has the same view widget structure as the "monitor tab".

3_device_tab_to_monitor_1

NOTE The difference between “Dashboard” and “Monitor tab” is that you can add any attribute of ANY device to the Dashboard, whereas in the “Monitor tab” you see all the attributes of one device.

Exercise: 

Select any attribute or command or pipe, 
this also selects it in the Device control panel.

Control Panel

It has 3 views (Attributes, Commands and Pipes). Switch between views happens automatically when corresponding entity is selected in Device View panel:

4_device_controls_write

To work with the Device Controls Panel you should select the device first (e.g. in Devices tree widget or in Device widget or click on an attribute in the Dashboard etc.). Name of the selected device is shown above Attributes, Commands and Pipes tabs.

All the attributes, commands and pipes refer to the selected device.

Attributes view

You can “Read”, “Plot”, “Plot.Hist” and “Write”. * Read – shows info about the attribute; * Plot – reads the value and plot it. No automatic updates. If you want automatic updates, add attribute to monitor to the Dashboard in Device widget. * Plot.Hist – plots historical values (usually 10). The number can be set in "Configuration tab" of device. * Write – writes a new value in the attribute. If you change the value by writing a new one in the Device Controls Panel, this attribute will be automatically updated in all other tabs and panels.

4_device_controls_write

Exercise: 

Select “my_test_device”;
select “double_scalar” attribute in the list of attributes;
click “Plot”;
in the text field next to “Write” button enter 100 and click “Write” button;
click “Plot”;
click “Plot.Hist”;

Commands view

To execute the command, first choose the command you need, then type the input value.

“Input” and “Output” boxes show what type of input value should be written and what output to expect.

5_device_controls_commands

Exercise: 

Select “DevDouble” enter 3.14 as input and press the “Execute” button

Pipes tab

It contains “Read” and “Write” buttons and field where you can write value as JSON.

6_device_controls_pipes

Right panel

Displays user activity:

6_device_controls_pipes

Main view

Dashboard tab

It has the same purpose as Device monitor, except that attributes can be added here manually from different devices. You can add any attributes from any devices to the Dashboard using context menu on the corresponding attributes in Device widget.

3_device_tab_to_monitor_1

Plots are powered by plotly.js. Please refer to plotly documentation to get use of it: link

Exercise: 

Open “my_test_device” in Device tree. 
Choose “Double Scalar” in Attributes and add it to Dashboard using context menu. 
To plot the scalar attribute click on the plot icon.
Select attribute “short_image_ro” and add it to monitor using context menu. 
Select “double_spectrum_ro” and add it to Dashboard using context menu. 
Refresh the page

Device monitor

Right click on the "Monitor" in the device context menu and the monitor tab opens in the main view. The opened tab has the name of the monitored device.

1_main_page_device_monitor

Here you monitor all devices' attributes. The tab contains attributes' monitor view widget with: * Status bar, * Scalar plot view, * Scalar's data table, * Spectrum tabs, * Image tabs and * tool bar.

Status bar contains information about device.

Scalar attributes are listed in the Scalar's data table where you can plot them clicking on the plot icon (icon_plot). This plot will be shown in the Scalar plot view. To delete the plot just click on the cross of the related attribute in the Scalar's data table.

Attributes in Scalar's data table may be highlighted depending on attribute quality set in Tango (“warning” or “alarm”). You can set these values using Waltz (Devices tree widget → context menu on the device → Configure → Attributes config → Alarms).

Each Spectrum and Image attribute will have its own tab. Clicking on a spectrum you get the plot.

Tool bar has the following controls: * Arrow – shows status of refreshing of attributes' values; * Number – refresh rate of attributes' values (milliseconds); * Refresh button – to set a new value of refresh rate; * Pause button – to pause refreshing.

Plots are powered by plotly.js. Please refer to plotly documentation to get use of it: link

NOTE Values are updated only if visible.

Exercise: 

Go “sys” → “tg_test” → “my_test_device”.
Choose “Monitor” from the context menu.

Exercise: 

Click on the plot icon of “Double Scalar” attribute.
Click on the plot icon of “short_scalar” attribute.
To stop plotting “Double Scalar” attribute click on “x” in the data table.
Open “double_spectrum_ro”.
Open “short_image_ro”.

Exercise: 

Set 3000 and press refresh button.

Device configuration

Choose "Configure" in the device context. It opens device configuration tab (new tab in the main view) with the name of the configurated device.

Configuration tab contains properties, polling, events, attributes configuration and logging tabs which in their turn have their own tabs.

For example, in the properties tab you can add, refresh, apply, delete property. Double click on the value and you can change it.

Here you can also set the validity of the attribute to make it highlighted while monitoring.

1_main_page_device_config_alarm

The rest tabs work the same way.

Exercise: 

Go “sys” → “tg_test” → “my_test_device”.
Choose “Configure” from the context menu.

Scripting tab

You can write and execute javascripts here.

9_main_page_Scripting

“Scripts” block shows the names of javascript files you have.

If you want to create a new javascript file, type the name of your future file in “Script name” field and your code in “Script code”. When click on run button (icon_run) in the left bottom your script is automatically saved but you must fill Script name first!

The result of the scritp is shown in “Script output” box.

Of course, you can delete your script clicking on (icon_trash).

To change the script – select the needed one from the “Scripts” block.

Exercise: 

Script name: sum
Script code: return 2+2
Press “ctrl+enter” to execute the script or click execute button

Script name: readAttribute
Script code:
return PlatformContext.rest.fetchHost('localhost:10000')
  .then(host => host.fetchDevice('sys/tg_test/1'))
  .then(device => device.fetchAttr('double_scalar'))
  .then(attr => attr.read())
  .then(value => value.value)
Press “ctrl+enter” to execute the script

Settings tab

This tab can also be reachable by clicking on the user name.

7_main_page_settings

Tango REST API URL

Url of REST API entry point. Usually the correct value is set during the deployment so usually you don't need to change it. But it is possible to add new REST API hosts (will rewrite the existing one).

Tango hosts

List of user's Tango hosts. You can delete or add Tango hosts here. Template for Tango host: {host}:{port}.

Tango host info

Readonly information about host. Been automatically updated when click on the name of Tango host. The values are loaded from the REST server.

Tango Server Wizard

You can add new device(s) here.

Exercise: 

Set 
ServerName/Instance: TangoTest/test
Class name: TangoTest
Devices: test/tg_test/x;  test/tg_test/y

You have just added it to the database. The newly added devices are not running. You should start manually.

Device filters

In fact, there are 3 filters in the application. But two of them (in Devices tree widget and in Device Control Panel) are text filters and the one you have here allows you to combine.

You can apply more complicated filters, define which devices will be available. Moreover, several filters can be run simultaneously. Type each of them on new line and press “Apply filters” button.

To return to the full devices' tree apply: //*

7_main_page_settings_filter

Exercise: 

Set
sys/tg_test/*
tango/*/*
press “Apply”

Resources

[1] Waltz Overview (video)