Mhttpd: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
== Purpose ==
== Purpose ==
The <span style="color:darkcyan;">''mhttpd''</span> utility runs the MIDAS [[Web Server]] which allows the user to communicate with the experiment. It is used for run control.  
The <span style="color:darkcyan;">''mhttpd''</span> utility runs the MIDAS Web Server which allows the user to communicate with an experiment using any web browser. It is used primarily for run control.  
 
 


== Arguments ==
== Arguments ==


     -p port  : port number e.g. 8081 (no default)
     -p port  : port number e.g. 8081 (no default)
   [-h] : connect to midas server (mserver) on given host
   [-h]     : connect to midas server (mserver) on given host
   [-e] : experiment to connect to
   [-e]     : experiment to connect to
   [-v] : display verbose HTTP communication
   [-v]     : display verbose HTTP communication
   [-D] : starts program as a daemon
   [-D]     : starts program as a daemon
   [-E] : only display ELog system
   [-E]     : only display ELog system
   [-H] : only display history plots
   [-H]     : only display history plots
   [-a] : only allow access for specific host(s). Several [-a Hostname] statements might be given
   [-a]     : only allow access for specific host(s). Several [-a Hostname] statements might be given
   [-help] : display usage information
   [-help]   : display usage information


== Usage ==
== Usage ==


  The TCP/IP port number is '''required''' as an argument in order to listen to the web-based request.
The TCP/IP port number is '''required''' as an argument in order to listen to the web-based request.
 
<br>e.g. if mhttpd is started on host machine "myhost" on port 8081 as follows
  mhttpd -p 8081 -D
access to the [[#Features|''Midas status page'']] can be obtained by pointing a web browser to
http://myhost.mydomain.xx:8081
 
;Note
If [[Exptab|multiple experiments]] run on the same host, a web server for each experiment must be started on a different port, e.g.
          mhttpd -e expt1 -p 8081 -D
          mhttpd -e expt2 -p 8082 -D
 


  mhttpd -p port [-h Hostname] [-e Experiment]  [-v] [-D] [-c] [-a Hostname]
  e.g.
  mhttpd -p 8081 -D


=== Features ===
=== Features ===
As mentioned, <span style="color:darkcyan;">''mhttpd''</span> provide a mean for run control which include the monitoring of the run parameters as well.
<span style="color:darkcyan;">''mhttpd''</span> provides a means for run control including monitoring of the run parameters.
Its main feature is a web paged invoked through any web browser accessing the Midas experimental URL at a defined port.
Its main feature is a web page invoked through any web browser accessing the Midas experimental URL at a defined port (see [[#Usage|Usage]]).
The content of this "Midas status page" is composed with the minimal information relative to the experiment and a collection of buttons and links to further describe and control the configuration of the experiment.  
 
 
The contents of this '''Midas status page''' is composed with minimal information relative to the experiment. It contains a collection of buttons and links to other pages to further describe and control the configuration of the experiment.  


* Minimal display (main web page)
* Minimal display (main web page)
** Experiment name, time & date, page refresh rate
** Experiment name, time & date, page refresh rate
** Buttons (see below)
** Standard Buttons (see below)
** User defined buttons
** User defined buttons
** run comments and condition display section (if enabled)
** run comments and condition display section (if enabled)
Line 41: Line 49:


* Buttons
* Buttons
** Transition the state of the run (stopped/running/paused), allows if setup to enter user running condition parameters at the start state.
** Transition the state of the run (stopped/running/paused), allows user running condition parameters to be entered at the start state (see [[Edit-on-start Parameters]]).
** Access to the full [[Online Database]] for data display and/or data content modification.  
** Access to the full [[Online Database]] for data display and/or data content modification.  
** Display the [[Midas Messages]]. These messages are generated by the Midas system as well as the user using cm_msg() functions.
** Display the [[Midas Messages]]. These messages are generated by the Midas system as well as the user using cm_msg() functions.
Line 55: Line 63:
** link to the logger configuration (if present) for the data recording.
** link to the logger configuration (if present) for the data recording.
** link to the possible secondary logging configuration parameters (if present).
** link to the possible secondary logging configuration parameters (if present).
=== Multiple copies ===
Several copies of  <span style="color:darkcyan;">''mhttpd''</span>  can run on a single host, as long as they are started on different ports.
If more than one experiment runs on the same host, a server for each experiment must be started on a different port, e.g.
          mhttpd -e midas -p 8081 -D
          mhttpd -e midgas -p 8082 -D

Revision as of 16:03, 15 July 2014

Purpose

The mhttpd utility runs the MIDAS Web Server which allows the user to communicate with an experiment using any web browser. It is used primarily for run control.

Arguments

   -p port  : port number e.g. 8081 (no default)
  [-h]      : connect to midas server (mserver) on given host
  [-e]      : experiment to connect to
  [-v]      : display verbose HTTP communication
  [-D]      : starts program as a daemon
  [-E]      : only display ELog system
  [-H]      : only display history plots
  [-a]      : only allow access for specific host(s). Several [-a Hostname] statements might be given
  [-help]   : display usage information

Usage

The TCP/IP port number is required as an argument in order to listen to the web-based request.


e.g. if mhttpd is started on host machine "myhost" on port 8081 as follows

 mhttpd -p 8081 -D

access to the Midas status page can be obtained by pointing a web browser to

http://myhost.mydomain.xx:8081
Note

If multiple experiments run on the same host, a web server for each experiment must be started on a different port, e.g.

          mhttpd -e expt1 -p 8081 -D
          mhttpd -e expt2 -p 8082 -D


Features

mhttpd provides a means for run control including monitoring of the run parameters. Its main feature is a web page invoked through any web browser accessing the Midas experimental URL at a defined port (see Usage).


The contents of this Midas status page is composed with minimal information relative to the experiment. It contains a collection of buttons and links to other pages to further describe and control the configuration of the experiment.

  • Minimal display (main web page)
    • Experiment name, time & date, page refresh rate
    • Standard Buttons (see below)
    • User defined buttons
    • run comments and condition display section (if enabled)
    • Equipment list with current running condition, number of event received, event rate, data rate for each equipment.
    • Data logging statistics (number of event recorded, data size recorder, compression factor, usage storage level) if enabled.
    • Secondary Data logging (data mover) with statistics if enabled.
    • Single line of the most recent Midas message.
    • Table of the current applications connected to this experiment.
  • Buttons
    • Transition the state of the run (stopped/running/paused), allows user running condition parameters to be entered at the start state (see Edit-on-start Parameters).
    • Access to the full Online Database for data display and/or data content modification.
    • Display the Midas Messages. These messages are generated by the Midas system as well as the user using cm_msg() functions.
    • Access to ELOG" site. "Short-cut" switch to the predefined "electronic logbook".
    • Access to the Alarms section for monitoring the different type of alarms (evaluated, programs, internals, periodic).
    • Access to the Program section for a status or interaction with the current running applications part of the Midas experiment.
    • Access to the History for graphical data representation of any ODB variables and acquired data.
    • Access to the Midas Slow Control Bus devices MSCB connected to this experiment.
    • Access to the run Sequencer control/monitoring page for interactive loading/saving/running of a run sequence based on any ODB parameters.
    • Short-cut to the Midas Help documentation resource.
  • Links
    • links to all the listed equipments invoking a dedicated page for the display and possible control of the equipment parameters.
    • link to the logger configuration (if present) for the data recording.
    • link to the possible secondary logging configuration parameters (if present).