Sequencer Page: 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
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/web_pages/#sequencer-page Sequencer page] in Built-in web pages and [https://midas.triumf.ca/docs/develop/features/monitoring_and_control/sequencer/#web-interface Web interface] in Sequencer: overview for the new documentation about the Sequencer web page.
 
 
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[Mhttpd|mhttpd MIDAS web server]]
* [[Status Page]]
* [[Message Page]]
* [[ODB Page]]
* [[Programs Page]]
* [[Alarms Page]]
* [[MSCB Page]]
* [[Elog Page]]
* [[History Page]]
* [[Sequencer Page]]
* [[Custom Page]]
* [[Sequencer]]
* [[/Sequencer ODB tree]]
* [[Edit-on-Sequence Parameters]]
</div>
 
= Purpose =
The purpose of the [[mhttpd]] Sequencer Web Page to provide a visual display for the [[Sequencer]]. Using the Sequencer Page, [[Sequencer|Sequencer scripts]] can be loaded, edited and run.
 
 
= Access to the Sequencer Page =
The Sequencer Page is displayed by clicking on  {{Button|name=Sequencer}} button on the mhttpd [[Status Page]] or other [[mhttpd]] web page.
 
;Note
:If the Sequencer button is not present on the Status Page, it may have been [[Status Page#page-switch-buttons|suppressed]].
 
= Features of the Sequencer Page =
The Sequencer Page takes its parameters from the [[/Sequencer ODB tree]]. Sequencer scripts can be loaded and run from the Sequencer Page. A visual editor is provided to edit scripts. A display is provided showing the progress of a running script, and the last few Midas messages are also shown (Figure 5). If [[Edit-on-Sequence Parameters]] are defined, these will be displayed when a sequence is started.
 
== How to input and run a Sequencer Script ==
See [[Sequencer|Sequencer Commands]] for the list of commands recognized by the Sequencer.
 
<ul>
<li>Press {{Button|name=Sequencer}} on [[Status Page]]. The first time the button is pressed, the Sequencer Page will appear as in Figure 1, where no load file has been specified.</li>
;Note
:The directory path where the sequencer files will be saved is set by the ODB parameter [[/Sequencer ODB tree#Path|/Sequencer/State/Path]].
 
<li>Either</li>
<ul>
<li> press {{Button|name=Edit Script}}  and input a new test sequence (e.g. [[#Sequence File|test_seq.msl]]) as in Figure 2.</li>
<li> save the script by pressing {{Button|name=Save}}. You will be asked for a file name. </li>
</ul>
<li>Or </li>
<ul>
<li>load an existing script using {{Button|name=Load Script}} as in Figure 3.</li>
</ul>
<br>
<li> Press {{Button|name=Start Script}} button to start the script. </li>
<ul>
<li>You will be asked to input any required parameters as in Figure 4 (in this case the number of runs, see [[#Sequence File|test_seq.msl]]).</li>
<li>If [[Edit-on-Sequence Parameters]] are defined, these will be displayed in addition to any required parameters</li>
<li>In this example, the script contains an error that prevents the script from running (Figure 5)</li>
</ul>
<br>
<li> The script is edited by pressing  {{Button|name=Edit Script}}, and the error corrected.</li>
<br>
<li> Now the script will run when  {{Button|name=Start Script}}  is pressed. A visual status is displayed in the Progress window, and the current position in the sequence file is also highlighted (Figure 6).</li>
<br>
<li> The sequencer can be paused by pressing the  {{Button|name=Pause Script}} button (Figure 7).</li>
<br>
<li>The progress window will indicated when the sequencer is finished  (Figure 8).</li>
</ul>
 
;Click on a thumbnail to enlarge
<gallery>
File:sequencer_noscript.png|Figure 1: Initial Sequencer page
File:sequencer_scripteditor.png|Figure 2: Editing a Sequencer script
File:sequencer_filelist.png|Figure 3: Select a Sequencer file
File:sequencer_startscript.png|Figure 4: Select a Sequencer file
File:sequencer_error.png|Figure 5: There is an error in the script
File:sequencer_running.png|Figure 6: Sequencer is running
File:sequencer_paused.png|Figure 7: Sequencer is paused
File:sequencer_finished.png|Figure 8: Sequencer is finished
</gallery>
 
 
=== Sequence file  ===
The following is the contents of the sequence file used for testing ''test_seq.msl'' in the example [[#How to input and run a Sequencer Script|above]].
<pre>
COMMENT "This is a MSL test file"
RUNDESCRIPTION "Test run"
PARAM runs
 
LOOP $runs
    TRANSITION START
    WAIT ODBvalue "/Equipment/FIFO_acq/Statistics/Events sent" >= 25
    TRANSITION STOP
    WAIT seconds 5
ENDLOOP
</pre>
 
 
 
[[Category: Web server mhttpd]] [[Category: Sequencer]]

Latest revision as of 22:01, 30 October 2026

The midas documentation has moved. See Sequencer page in Built-in web pages and Web interface in Sequencer: overview for the new documentation about the Sequencer web page.