BNMR: Custom pages: Difference between revisions
Jump to navigation
Jump to search
en>Suz mNo edit summary |
mNo edit summary |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Pagelinks}} | {{Pagelinks}} | ||
== Purpose == | == Purpose == | ||
BNMR | BNMR custom webpages are written specifically for the {{bnmqr|join=and}} experiments to enable to users to enter parameters and control the experiments more easily. They are built using the [https://midas.triumf.ca/MidasWiki/index.php/Custom_Page Midas custom page] system. | ||
== Introduction == | == Introduction == | ||
[https://midas.triumf.ca/MidasWiki/index.php/Midas_documentation MIDAS] experiments run the web server [[https://midas.triumf.ca/MidasWiki/index.php/Mhttpd mhttpd]] which allows users to control and communicate with their experiments using a standard web browser (e.g. Firefox). | [https://midas.triumf.ca/MidasWiki/index.php/Midas_documentation MIDAS] experiments run the web server [[https://midas.triumf.ca/MidasWiki/index.php/Mhttpd mhttpd]] which allows users to control and communicate with their experiments using a standard web browser (e.g. Firefox). | ||
Complicated experiments such as {{bnmqr|join=and}} involve a large number of ODB parameters in various directories that have to be setup in order to control the experiment. Navigating these parameters using the standard MIDAS ODB page can become complicated and time-consuming. For this reason, [https://midas.triumf.ca/MidasWiki/index.php/Custom_Page custom pages] specific to an experiment are often written to present relevant parameters for the experiment in a more user-friendly way, and to display information specific to that experiment. | Complicated experiments such as {{bnmqr|join=and}} involve a large number of ODB parameters in various directories that have to be setup in order to control the experiment. Navigating these parameters using the standard MIDAS ODB page can become complicated and time-consuming. For this reason, [https://midas.triumf.ca/MidasWiki/index.php/Custom_Page custom pages] specific to an experiment are often written to present relevant parameters for the experiment in a more user-friendly way, and to display information specific to that experiment. | ||
== Custom pages for bnmr/bnqr == | |||
| | The custom pages written for the {{bnmqr|join=and}} experiments include: | ||
|- | * [[BNMR: Custom Status page|Status page]] - replaces the MIDAS standard status page | ||
| | * [[BNMR: Custom Settings page|Settings page]] - displays parameters for the selected PPG timing scheme, PSM mode etc | ||
| | * [[BNMR: Custom Logging page|Logging page]] - displays parameters for logging data to a MUD file | ||
| | * [[BNMR: Custom Modes page|Modes page]] - displays the features of each experimental mode | ||
| | * [[BNMR: Custom Expert page|Expert page]] - displays features that are rarely used or easy to misuse | ||
== Defining in the /Custom ODB tree == | |||
In order for {{Utility|name=mhttpd}} to display custom pages, file names an aliases must be defined in the experiment's {{Odbpath|path=/Custom}} ODB tree. This includes external stylesheets, html and javascript code. See [https://daq00.triumf.ca/MidasWiki/index.php//Custom_ODB_tree Midas documentation about /Custom] for more. | |||
== Code location == | |||
All custom page code is located in the bnmr repository: | |||
* <code>cycling_framework/custom</code> directory contains tools from the base framework (including JQuery, Plotly and PPG visualization tools). | |||
* <code>bnxr_common/custom</code> directory contains code common to both experiments. | |||
* <code>config_bnmr.js</code> and <code>config_bnqr.js</code> define the specific differences for each experiment. | |||
[[Category:Webserver]] | [[Category:BNMR]] [[Category:Webserver]] | ||
Latest revision as of 13:47, 26 April 2022
Purpose
BNMR custom webpages are written specifically for the bnmr and bnqr experiments to enable to users to enter parameters and control the experiments more easily. They are built using the Midas custom page system.
Introduction
MIDAS experiments run the web server [mhttpd] which allows users to control and communicate with their experiments using a standard web browser (e.g. Firefox).
Complicated experiments such as bnmr and bnqr involve a large number of ODB parameters in various directories that have to be setup in order to control the experiment. Navigating these parameters using the standard MIDAS ODB page can become complicated and time-consuming. For this reason, custom pages specific to an experiment are often written to present relevant parameters for the experiment in a more user-friendly way, and to display information specific to that experiment.
Custom pages for bnmr/bnqr
The custom pages written for the bnmr and bnqr experiments include:
- Status page - replaces the MIDAS standard status page
- Settings page - displays parameters for the selected PPG timing scheme, PSM mode etc
- Logging page - displays parameters for logging data to a MUD file
- Modes page - displays the features of each experimental mode
- Expert page - displays features that are rarely used or easy to misuse
Defining in the /Custom ODB tree
In order for mhttpd to display custom pages, file names an aliases must be defined in the experiment's /Custom ODB tree. This includes external stylesheets, html and javascript code. See Midas documentation about /Custom for more.
Code location
All custom page code is located in the bnmr repository:
cycling_framework/customdirectory contains tools from the base framework (including JQuery, Plotly and PPG visualization tools).bnxr_common/customdirectory contains code common to both experiments.config_bnmr.jsandconfig_bnqr.jsdefine the specific differences for each experiment.