/MSCB ODB tree: 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
 
Line 1: Line 1:
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/odb_keys/#mscb /MSCB] on the ODB keys page and [https://midas.triumf.ca/docs/develop/features/acquiring_data/slow_control/mscb/ Slow control: MSCB] for the new documentation about the /MSCB ODB keys.
* [[Midas_documentation|Midas Documentation]]
* [[Feature_listing|Feature Listing]]
* [[Application_listing|Application Listing]]
* [[Online_Database|Online Database]]
</div>
 
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[mhttpd |MIDAS web server (mhttpd)]]
* mhttpd [[MSCB Page]]
* [https://midas.psi.ch/mscb/ MSCB Slow Control Bus]
</div>
 
= Purpose =
The <span style="color:purple; font-style:italic;">/MSCB</span> ODB tree contains data for the
[https://midas.psi.ch/mscb/ MSCB System].
This tree is optional, and only required if the MSCB system is in use. Provided MSCB support has been [[MSCB Page|built in]] to [[mhttpd]], the data from this tree is displayed on the [[MSCB Page]].
 
 
= Creating the /MSCB tree =
The <span style="color:purple; font-style:italic">/MSCB</span> ODB tree is an optional tree that may be [[ODB#Creating ODB keys|created by the user]], but they are also created automatically by [[mhttpd]] if the  <span style="color:purple; font-style:italic;">/MSCB/Submaster</span> key is not present in the ODB. In this case, the equipment list is scanned, and all MSCB devices and addresses are collected from locations such as
; <span style="color:purple; font-style:italic;">/Equipment/<name>/Settings/DD/<name>/MSCB Device</span>
which is the location for MSCB submasters used by the mscbdev.c and mscbhvr.c device drivers (found in the midas package at path
../midas/drivers/device). Once the tree is created, it will not be touched again by [[mhttpd]] (unless  <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;">Rescan</span> on the [[MSCB Page]] is pressed) so devices can be removed or [[ODB#Reorder ODB keys|reordered]] by hand.
 
 
= Example =
The following example using the [[odbedit]] command <span style="color:saddlebrown; font-style:bold; ">"ls"</span> command shows the /MSCB ODB tree from the Deap experiment. This data is displayed on the [[MSCB Page#Introduction|MSCB Page]]. 
 
[local:deap:Stopped]/>ls -l /MSCB/Submaster/mscb520
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Pwd                            STRING  1    32    31h  0  RWD
Comment                        STRING  1    32    31h  0  RWD  SCBs
Address                        INT    28    4    31h  0  RWD
                                        [0]            0
                                        [1]             1
                                        [2]            2
                                        [3]            3
                                        [4]            4
                                        [5]            5
                                        .................
                                        [27]            27
Node comment                    STRING  28    32    31h  0  RWD
                                        [0]            aaa
                                        [1]            bbb
                                        [2]            DEAPCOND410
                                        [3]            DEAPCOND410
                                        [4]            DEAPCOND410
                                        [5]            DEAPCOND410
                                        ...........................
                                        [27]            DEAPCOND410
       
= Keys in the /MSCB tree =
 
== <span style="color:purple; font-style:italic">Submaster</span> subtree ==
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' DIR
</div>
The <span style="color:purple; font-style:italic">Submaster</span> subtree contains  one or more <span style="color:purple; font-style:italic"><submaster-name></span> subtree(s) for the MSCB submasters present in the system.
 
<br>
---------
<br>
 
=== <span style="color:purple; font-style:italic"><submaster-name></span> subtree ===
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' DIR
* '''Default:'''
</div>
The <span style="color:purple; font-style:italic"><submaster-name></span> subtree contains information for one of the MSCB submaster(s) present in the system. There will be a <span style="color:purple; font-style:italic"><submaster-name></span> subtree for each MSCB submaster present.
 
<br>
---------
<br>
 
==== <span style="color:purple; font-style:italic">Pwd</span> ====
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING [32]
* '''Default:'''
</div>
This key in the [[#<submaster-name> subtree|<submaster-name> subtree]] may contain an optional password needed by that submaster. Leave blank if no password.
 
<br>
---------
<br>
 
==== <span style="color:purple; font-style:italic">Comment</span> ====
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING [32]
* '''Default:'''
</div>
This key in the [[#<submaster-name> subtree|<submaster-name> subtree]] may contain an optional comment describing that submaster.
 
<br>
---------
<br>
 
==== <span style="color:purple; font-style:italic">Address</span> ====
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' INT Array
* '''Default:'''
</div>
This key in the [[#<submaster-name> subtree|<submaster-name> subtree]] is a variable-length array containing the node addresses for that submaster. The length of the array is determined by the number of nodes present.
 
<br>
---------
<br>
 
==== <span style="color:purple; font-style:italic">Node comment</span> ====
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* '''Type:''' STRING[32] Array
* '''Default:'''
</div>
This key in the [[#<submaster-name> subtree|<submaster-name> subtree]]is an optional variable-length array that may contain a comment for each node. The length of the array is determined by the number of nodes present.
 
<br>
---------
<br>
 
[[Category:ODB Tree]]

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See /MSCB on the ODB keys page and Slow control: MSCB for the new documentation about the /MSCB ODB keys.