Equipment Page: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
(The midas documentation has moved to https://midas.triumf.ca/docs/)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/web_pages/#equipment-pages Equipment pages] in Built-in web pages and [https://midas.triumf.ca/docs/develop/features/acquiring_data/frontends/configuring/#equipment-display-page Equipment display page] on the Frontends: configuring page for the new documentation about the equipment pages.
 
= Links =
{{mhttpdpages}}
 
= Purpose =
The purpose of the [[mhttpd]] equipment pages is to allow the user to view any Variables related to an equipment.  
 
= Access the equipment page =
 
The main [[Status Page]] contains a list of all the equipment in an experiment (with each equipment being defined by a frontend). The name of each equipment on that page is a link to the relevant equipment page.
 
= Configuring the equipment page =
 
There are several ODB keys that can be defined in {{Odbpath|path=/Equipment/<equip_name>/}} that affect the behaviour of this webpage. See [[/Equipment_ODB_tree#Settings_subtree|the Equipment ODB tree]] documentation for full details, but in brief:
 
* "/Equipment/<equip_name>/Variables/" contains the Variables to show on this page (and to record in the history system).
* "/Equipment/<equip_name>/Settings/Names" or "/Equipment/<equip_name>/Settings/Names <variable>" contains the name of each element in the Variables arrays (e.g. channel names if recording the current of multiple channels).
* "/Equipment/<equip_name>/Settings/Unit <variable>" contains the units in which a variable is measured.
* "/Equipment/<equip_name>/Settings/Editable" contains a comma-separated list of variables that can be edited on the Equipment page.
* "/Equipment/<equip_name>/Settings/Grid display" is a boolean which allows you to switch between linear display and "grid" display.  These options are:
** Grid display: This is useful if there are “channels” with different attributes. Such as HV channels with current and voltage. In this case, we have several array under “Variables” which “belong” together, such as a voltage array and a current array. In this case one should have /Equpiment/<name>/Settings/Grid display = true, which cases the display like at the top of this page (Output on, Power good, Fault, Current). One also should then add “Names” under settings to have proper labels for each channel. 
** Non-grid display: Here we have arrays not related to each other. Here the grid display should be off, then you get the display directly above, where all banks are shown below each other.
 
 
All the settings are optional, and must be created by the user if desired.
 
= Example configuration and display =
 
Click to enlarge each image...
 
<gallery widths="300px" mode="packed">
Equipment_Variables.png|Variables
Equipment_Settings.png|Settings
Equipment_Page.png|Resulting display
</gallery>

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See Equipment pages in Built-in web pages and Equipment display page on the Frontends: configuring page for the new documentation about the equipment pages.