Custom Page Features: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/api/javascript/deprecated/ Deprecated web features] and [https://midas.triumf.ca/docs/develop/features/monitoring_and_control/custom_pages/ Custom pages: overview] for the new documentation about the older custom page features.
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[Mhttpd|mhttpd MIDAS web server]]
* [[ODB Page]]
* [[Custom Page]]
* [[/Custom ODB tree]]
* [[Mhttpd.js|MIDAS Javascript library]]
* [[odbedit]]
</div>
 
 
= Introduction =
This page describes some of the special features provided for use on a user-created [[Custom Page#Custom Web Page]] running under [[mhttpd]].
= Access the ODB with the  MIDAS Javascript Library =
Access to the ODB is provided by the  [[Mhttpd.js|MIDAS Javascript Library]]. JS Library functions can be included in the HTML code using the <script> tag, e.g.
<!-- comment
  <script>
  document.write ('Experiment Name: '+ ODBGet("/Experiment/Name"))
  var alarm_path="/alarms/Alarm system active";
  var alarm_active=ODBGet(alarm_path);
  document.write('<a href="#" onclick="ODBEdit(alarm_path)" >'+alarm_active+'</a>')
</script>
-->
{{Html|text=<script>}}
{{JS|text=document.write ('Experiment Name: '+ ODBGet("/Experiment/Name")) <br> var alarm_path="/alarms/Alarm system active"; <br> var alarm_active=ODBGet(alarm_path); <br> document.write('<a href="#" onclick="ODBEdit(alarm_path)" >'+alarm_active+'</a>')}}
{{Html|text=</script>}}
 
== Access the ODB with HTML-style ''<odb>'' tags ==
;NOTE
: It is recommended that the [[Mhttpd.js|MIDAS Javascript Library]] be used for ODB access.
 
However, if Javascript (JS) is not available, the older HTML-style ''<odb>'' tags are still available and provide limited functionality.
 
The HTML-style ''<odb...>'' tag has been defined for read/write access to the ODB under HTML. The ''<odb...>'' tags are declared within enclosing HTML ''<form...>....</form>'' tags.
 
{|  style="text-align: left; width: 100%; background-color: rgb(255, 255, 255);" border="3" cellpadding="2" cellspacing="2"
|+ Caption  Access to ODB from HTML
|-
| colspan="1" rowspan="1" style="text-align: center; vertical-align: top; background-color: rgb(204, 204, 255); font-weight: bold;" | HTML ODB tag
| colspan="1" rowspan="1" style="text-align: center; vertical-align: top; background-color: rgb(204, 204, 255); font-weight: bold;" | Meaning
 
|- 
| colspan="1" rowspan="1"  style="text-align: left; vertical-align: top; background-color: rgb(255, 255, 255); color: black"  |<odb src="odb path">
| colspan="1" rowspan="1"  style="text-align: left; vertical-align: top; background-color: rgb(255, 255, 255); color: black"  |Display ODB field (read only)
|- 
| <odb src="odb path" edit=1 pwd="CustomPwd">
| Display an Editable ODB field (inline style). Optional password protection with '''pwd''' .
 
|- 
| <odb src="odb path" edit=2 pwd="CustomPwd">
| Display an Editable ODB field (popup style). Optional password protection with '''pwd''' .
|}
 
 
''<odb>'' tags are included in the HTML code e.g.
<!--
Experiment Name: <odb src="/Experiment/Name">
Run Number: <odb src="/runinfo/run number" edit=1>
-->
{{Html|text= Experiment Name: <odb src="/Experiment/Name"> <br>  Run Number: <odb src="/runinfo/run number" edit=1>}}
 
See also [[Custom Page#How to write a Custom Page|HTML Custom Page example]].
 
 
=    Password protection of ODB variables =
Being able to control an experiment through a web interface of course raises the question of safety. This is not so much about external access (for which there are other protection schemes firewalls, host lists etc.) but about accidental access by the normal shift crew. If a single click on a web page opens a critical valve, this might be a problem. In order to restrict access to some "experts", an additional password can be chosen for all or some controls on a custom page.
 
Password protection is optional, and must be set up by the user as decribed in [[/Custom ODB tree#Pwd subtree]].
 
Password protection is available for
 
*    Password protection of Edit Boxes
*    [[Mhttpd.js|ODBSet]] JavaScript function
*    Area map with password check
 
If password protection is set up, [[mhttpd]] will check the supplied password against the ODB entry, and show an error if they don't match.
 
 
= Json support =
Json support is provided with the [[Mhttpd.js|MIDAS Javascript Library]].
 
 
 
=  Access to the MIDAS Menu buttons =
Access to the standard MIDAS Menu buttons can be provided with HTML <input...> tags of the form:
 
<!-- <input name="cmd" value=''<button-name>'' type="submit" > -->
{{Html|text=<input name="cmd" value=''<button-name>'' type="submit" >}}
Valid values are the standard MIDAS Menu buttons, i.e. (Start, Pause, Resume, Stop, ODB, Elog, Alarms, History, Programs etc). The <input...> tags must be declared within enclosing HTML <form...>....</form> tags (see above).
 
The following HTML fragment shows the inclusion of three of the standard buttons, giving access to the Main Status, ODB and Messages pages :
<!--
<form name="form1" method="Get" action="/CS/MyExpt&">
<input name="cmd" value="Status" type="submit">
<input name="cmd" value="ODB" type="submit">
<input name="cmd" value="Messages" type="submit">
...
</form>
-->
{{Html|text= <form name="form1" method="Get" action="/CS/MyExpt&"> <br> <input name="cmd" value="Status" type="submit"> <br> <input name="cmd" value="ODB" type="submit"> <br> <input name="cmd" value="Messages" type="submit"> <br> ...  <br> </form> }}
 
= CustomScript Buttons =
[[/Customscript ODB tree#Customscript-button|CustomScript buttons]] can be provided on [[Custom Page|Custom Pages]]. These buttons are equivalent to optional [[/Script ODB tree#Script-button|script buttons]] on the [[Status Page]], and allow a particular action to be performed when the button is pressed. Customscript buttons can be set up through the [[/Customscript ODB tree]].
 
Any key <span style="color:purple; font-style:italic">/CustomScript/my button</span> will appear as a customscript-button
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">my button</span> on a custom page whose code includes an HTML <input...> tag of the form:
 
        <input type=submit name=customscript value="my button">
 
where the action of the button <span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">my button</span> will be found in the <span style="color:purple; font-style:italic">/customscript/my button</span> subdirectory.
 
After pressing a customscript-button, the [[Status Page]] will be shown, unless a redirect input tag is included to redirect back to the original custom page.
 
 
=    External stylesheet =
[[File:Mhxcustom03_keys.jpg|thumb|left|Figure 1: Keys in /Custom ODB tree for external stylesheet and Demo html code ]]
[[File:Mhxcustom03.jpg|thumb|left|Figure 2: Demo Custom Page using MIDAS stylesheet]]
 
A stylesheet can of course be included in an HTML page. However, it is often convenient to use an external stylesheet that can be used for several custom pages.  The MIDAS packate provides a condensed stylesheet  (mhttpd.css) for users who would like their custom pages to have a similar "look and feel" to that of the the standard pages.
 
An external stylesheet can be used in a [[Custom Page]] by creating a link in the [[/Custom]] tree to a stylesheet file on the local disk. It is convenient to end the link name with "!" to prevent a [[/Custom ODB tree#Custom-Button|custom-button]] appearing on the [[Status Page]] (see [[Custom ODB tree|Keys in the /Custom tree]]).  For example, the links for the Demo Custom Page myexpt.html and the style sheet mhttpd.css are shown using the [[ODB Page]] in Figure 1.
 
A <link> tag to link in the stylesheet is then placed in the header of the custom page html code (myexpt.html)  e.g.
<link type="text/css" rel="stylesheet" href="/CS/stylesheet!" title="Stylesheet">
 
The resulting custom page is shown in Figure 1, which can be compared with [[Custom Page#How to write a custom page|Figure 4 (no stylesheet)]].
 
<div style="clear: both"></div> <!-- clear wraparound after thumbnail -->
 
=  Alias-Buttons and Hyperlinks =
Any hyperlink can easily be included on a [[Custom Page]] by using the standard HTML anchor <a...> tag, e.g.
<a href="http://ladd00.triumf.ca/~daqweb/doc/midas/html/">Midas Help</a>
 
Links on a custom page equivalent to [[/Alias ODB tree#Alias-Buttons|alias-buttons]] can also be made e.g.
<button type="button" onclick="document.location.href='/Alias/alias&';">alias</button>
See the [[/Alias ODB tree]] for details.
 
 
=    Page refresh =
The following <meta...> tag included in the HTML header code will cause the whole custom page to refresh in 60 seconds :
<meta http-equiv="Refresh" content="60">
It is also possible to [[Periodic update of parts of a custom page#periodically update parts]] of a custom page.
 
= Periodic update of parts of a custom page =
The functionality of [[Mhttpd.js|ODBGet]] together with the
    window.setInterval() function
can be used to update parts of the web page periodically.
For example the Javascript fragment below contains a function which updates the current run number every 10 seconds in the background:
 
  window.setInterval("Refresh()", 10000);
  function Refresh() {
    document.getElementById("run_number").innerHTML = ODBGet('/Runinfo/Run number');
  }
 
The custom page has to
* [[Mhttpd.js#include js lib|include the MIDAS JS library]] to access ODBGet
* contain an element with id="run_number", such as
  <td id="run_number"></td>
 
 
= Display last MIDAS message(s) =
 
The message log (see [[Message System]]) can be accessed from a custom page using a call to the JavaScript library function [[Mhttpd.js|ODBGetMsg]] (provided the [[Mhttpd.js#include js lib|JS library is included]]). There is no HTML equivalent to this JS function.
 
This allows the inclusion of the "Last Midas message" on a custom page, e.g.
{{Html|text=<script>}}
{{JS|text=var message;<br> message= ODBGetMsg(1); <br>  document.write('Last message:'+message+'<br>');}}
{{Html|text=</script>}}
More messages may be displayed by increasing the parameter to ODBGetMsg.
 
 
=  Checkboxes =
The function [[Mhttpd.js|ODBSet]] (provided the [[Mhttpd.js#include js lib|JS library is included]]) can be used when one clicks on a checkbox for example:
{{Html|text=<input type="checkbox" onClick="ODBSet('/Logger/Write data',this.checked?'1':'0')">}}
If used as above, the state of the checkbox must be initialized when the page is loaded. This can be done with some JavaScript code called on initialization, which then uses [[Mhttpd.js|ODBSet]] as described above.
 
 
=    Image insertion  =
;Note
:      The image file must be in '''gif''' format.
Click to enlarge thumbnail
[[File:Mhcustom_images.jpg|thumbnail|left|Figure 5: /Custom/Images ODB Tree]]
 
Image insertion into a Custom page will be illustrated using the Demo custom page shown in [[Custom Page#How to write a custom page|Figure 4]]. It is assumed that a link to the Demo custom page file ''myexpt.html'' has already been made by defining the filepath in the [[/Custom ODB tree]].
 
To make the image ''myexpt.gif'' visible on the custom page, the path and filename of the image file must be defined in the  {{Odbpath|path=/Custom/images}} subtree.
 
Create the  subtrees {{Odbpath|path=/Custom/images/myexpt.gif}} where the subtree name "myexpt.gif" is named for the imagefile you are going to use. Multiple images can be used, by creating multiple imagefile subtrees.
 
In the imagefile subtree {{Odbpath|path=myexpt.gif}}, create the STRING key  {{Odbpath|path=Background}}, and set it to contain the path and name of the imagefile.  The tree structure should then look similar to Figure 5, minus the labels/bars/fill subtrees which will be added to the ODB later.
 
The image must also be referenced in the custom HTML file ''myexpt.html'' using an HTML <img...> tag, e.g.
{{Html|text=<img src="myexpt.gif">}}
 
Note that if additional features such as active clickable areas and labels, bars and fills superimposed on the image are also required, HTML mapping must also be activated with the HTML <map...> tag
 
{{Html|text=  <map name="myexpt.map"> <br> <img src="myexpt.gif" usemap="#myexpt.map"> <br> </map>"}}
 
<div style="clear: both"></div>  <!-- clear wraparound after thumbnail -->
 
==  Superimposing Labels, Bars and Fills onto an image ==
You can enhance your custom page by superimposing multiple features based on ODB variables onto
[[#Image insertion into a Custom page|an image]], such as
 
*    labels: "live" ODB values positioned in a particular location of the page
*    bars : "bar level" showing graphically ODB values such as levels or rate etc.
*    fills : "color level" where colour is used as the level indicator.
*    edit boxes : editable ODB values superimposed on the image
 
Each entry (label/bar/fill) will have an ODB tree associated to it defining the ODB variable path, X/Y position, colour, etc. Each time the page is updated, the latest ODB value/level/rate will be shown based on the ODB parameter to which the label, bar or fill is linked - hence the term "live". The overlay of the requested features is done onto the selected image file.
 
This powerful new extension brings the [[mhttpd]] capability closer to other experimental web controllers similar to EPICS.
 
;Note
:    Be sure to enable the feature to [[#Display mouse position]] in order to facilitate finding the X,Y positions of the various features.
 
A Demo custom page showing labels,bars and fills superimposed on an image is shown in [[Custom Page#How to write a custom page|Figure 4]]. The file [http://ladd00.triumf.ca/~daqweb/doc/midas/doc/html/xcustom_8odb_source.html xcustom.odb]
contains the ODB keys required, including those to insert the image and superimpose the various labels, fills etc.
 
In order to include a readout of ODB values (i.e. labels), on the image a further ODB subdirectory  {{Odbpath|path=labels}} must be created. Creating  {{Odbpath|path=Labels/<label name>}} sub-directory under the  {{Odbpath|path=}}image}} subtree will, automatically at the next web page refresh, cause the complete the structure for that label to be created and filled with default values, e.g.
 
 
 
    odbedit
    [local:Default:Stopped]/Custom>cd Images/myexpt.gif
    [local:Default:Stopped]/myexpt.gif>mkdir Labels
    [local:Default:Stopped]/myexpt.gif>cd labels
    [local:Default:Stopped]Labels>mkdir Rate
    [local:Default:Stopped]Rate>
 
The above example assumes that the image-filename is myexpt.gif . After the next refresh, the structure will have been created for the Rate label:
 
[local:Default:Stopped]Rate>ls -l
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Src                            STRING  1    256  2m  0  RWD
Format                          STRING  1    32    2m  0  RWD  %1.1f
Font                            STRING  1    32    2m  0  RWD  Medium
X                              INT    1    4    2m  0  RWD  0
Y                              INT    1    4    2m  0  RWD  0
Align                          INT    1    4    2m  0  RWD  0
FGColor                        STRING  1    8    2m  0  RWD  000000
BGColor                        STRING  1    8    2m  0  RWD  FFFFFF
 
This procedure is repeated for all the labels required, using a unique <label_name> subdirectory for each label.
 
 
 
 
**        Inserting a history image in a custom page
**        Mapping active areas onto the image
**        Display mouse position
 
**        Edit boxes floating on top of a graphic

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See Deprecated web features and Custom pages: overview for the new documentation about the older custom page features.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Custom_Page_Features&oldid=3686"