+The first line of the file always contains a thirteen-digit number
+which is the time (in UTC) corresponding to the contained data as Unix
+time (milli-seconds since 1/1/1970). The second line contains a
+floating point number (in human readable ascii format) representing the
+lower limit if the scale and the third line the upper limit. The next three
+lines contain the three numbers displayed on top of the graphics,
+usually the minumum, median and maximum data value. Everything
+after is considered to be the data. For some restrictions of the HTML
+GET mechanism available in JavaScript the data must not exceed ascii
+character 127. So the full scale displayed, either in colors or as
+graph, is from 0 to 127. Eeach ascii character represents one entry in
+the camera or the histogram. The number of entries in the histogram can
+be between 0 to hundreds, although more entries than a typical screen
+has pixels does not make much sense. Keep in mind that the data is
+reloaded every few seconds and the larger the file is the higher the
+network traffic is. For the camera the number of entries is fixed and
+must either be 40 (boards), 160 (patches), 320 (HV channels) or 1440
+(pixels). They must be ordered by crate, board, chip, group, channel.
+|
Index: trunk/FACT++/www/smartfact/struct/help-camera.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-camera.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-camera.page (revision 14623)
@@ -0,0 +1,14 @@
+Camera
+|image=fact-camera.png|
+|
+The camera display is available in different types. It can display 40
+(board) values, 160 (patch) values, 320 (bias channel) values or
+1440 pixels. Depending on the type of input data several pixels mights
+consequently be displayed in the same color.
+|
+|
min / med /max
+The minimum, median and maximum value of all values displayed in the camera.
+|
+|
Scale
+The color scale of the displayed data.
+|
Index: trunk/FACT++/www/smartfact/struct/help-datafile.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-datafile.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-datafile.page (revision 14623)
@@ -0,0 +1,43 @@
+Datafile format
+|
+A datafile is a file which is automatically loaded every few seconds
+and the values displayed on a page are updated. If the page name
+is mypage.page the name of the corresponding data file is
+mypage.data.
+
+The first line of the data file always contains a thirteen-digit number
+which is the time (in UTC) corresponding to the contained data
+as Unix time (milli-seconds since 1/1/1970). Seprated with tabs, it can
+contain to additional numbers. The first one defines if the warning
+sign is displayed (>=1 means that it is displayed) and the
+second defines whether the script stop sign is displayed in green or red.
+For data-files which are not guranteed to be updated in reasonable
+intervals, it is advisable to not write the two numbers at all.
+
+Each following line contains columns seperated by tabs. The first column
+contains the background color of the row. It can be given in any
+representation accepted by HTML, usually #rrggbb. The following columns
+contain values or text which will replace the $N in the format given
+in the page file, e.g.
+
+If the second line of the data file contains
+
+
+blue\t0\t42.0
+
+
+while \t here representas the ascii character 9 ('\t' in C and C++), and the format
+in the page files looks like
+
+
+
+In the case of camera and hist, a binary file is loaded which contains the
+data to be displayed. The file-format for this i discussed hereafter.
+In case of the image-tag an HTML image tag is included showing the
+image loaded full-width in the row.
+
+If a camera graphics is displayed, the given unit is displayed at the scale
+(note that opera browser do not support text in the graphics so far).
+
+The unit can contain HTML special characters, e.g. µA
+|
+|
Input tag
+For sending arguments to script (on script-pages) also a few special
+tags are available
+
+
+
+The title is displayed on the left side of the row. The name is the
+argument name used later in the script to indentify the arguments.
+
+input creates a text input field with the default as default.
+
+select creates a list-box with the items in the list. The default
+is the first item.
+|
+|Binary file format||help-binaryfile
Index: trunk/FACT++/www/smartfact/struct/help-fact-bias.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-fact-bias.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-fact-bias.page (revision 14623)
@@ -0,0 +1,26 @@
+FACT
+|
G-APD (med/max)
+Here the status of the bias system is summarized.
+
+The backround colors have the following meaning:
+
+
DNS online, MCP taking data, FAD taking data
+
Bias voltage switched on and median current above 60µA or
+maximum current (excluding faulty pixels) above 80µA
+
Bias voltage switched on and median current above 70µA or
+maximum current (excluding faulty pixels) above 90µA or any patch
+in OverCurrent or MCP not Idle and bias voltage is neither well defined
+switched on (VoltageOn) nor well defined off (VoltageOff).
+
Bias neither ramping, nor in OverCurrent, nor in the well defined
+voltage on or off state.
+
Bias crate is currently being calibrated
+
+
+If the bias crate is currently calibrated asterix' are displayed, otherwise
+median pixel current and the maximum pixel current. The maximum excludes
+the crazy pixels. If a channel is on OverCurrent (OC) is appended.
+If the bias crate has not yet been calibrated the maximum current is
+replaced by a dash. If the bias current have been calibarted
+already, also the total power consumed by the G-APDs
+is displayed otherwise the median applied voltage.
+|
Index: trunk/FACT++/www/smartfact/struct/help-fact-drive.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-fact-drive.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-fact-drive.page (revision 14623)
@@ -0,0 +1,35 @@
+FACT
+|
Drive
+The current drive status is displayed if the dim-network is online
+and the drivectrl has connection to cosy.
+
+The backround colors have the following meaning:
+
+
Drive is tracking
+
Drive is tracking and the control deviation is larger than one arc-minute
+
Drive is tracking and the control deviation is larger than two arc-minutes or the drive is in ERROR state
+
Drive is offline, or online and neither moving nor tracking
+
Drive is moving
+
+
+If the drive is online, the current pointing position is displayed. Between
+sun-rise and sun-set a sun-symbol (☼) is displayed. If between
+sun-set and sun-rise the moon is above horizon, a moon-symbol (☾)
+is displayed. During tracking the current control deviation is
+displayed behin a plus-minus symbol (±). If the source name of
+the current tracking position is available it is displayed in []-parenthesis.
+If the drive is currently moving a moving-symbol (⟳) is displayed.
+
+If the drive is online and in error state this is also indicated by the
+extension [ERR]. This should make it easier to detect this state.
+
+If the drive is switched off and either the sun- or the moon-symbol is
+visible, it is extended with either the time until sun-set (indicated
+with a down-arrow ↓) or the moon disk visibility in percent.
+When the drive is switched on, this information is omitted due to space
+reasons.
+
+More detailed informations about the sun and moon can be found at the
+weather page. More detailed tracking and pointing information at the
+drive page.
+|
Index: trunk/FACT++/www/smartfact/struct/help-fact-rate.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-fact-rate.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-fact-rate.page (revision 14623)
@@ -0,0 +1,13 @@
+FACT
+|
Trigger rate
+If the dim network is online and the trigger master (ftmctrl) in in state
+TriggerOn, the current camera trigger rate is displayed. If the
+bias voltage is swicthed on (biasctrl in state VoltageOn), also the
+median patch threshold is displayed in ()-parenthesis.
+
+
+Here the status of the whole system is summarized.
+
+The backround colors have the following meaning:
+
+
DNS online, MCP taking data, FAD taking data
+
n/a
+
n/a
+
DNS offline of MCP in idle state
+
DNS online, MCP configuring, configured or trigger on, MCP taking data and FAD not taking data, or
+ratecontrol in SettingThreshold or ratescan in progress.
+
+
+The MCP state Idle, any configuring state and configured are display
+as text Idle, Configuring or Configured. In
+brackets the name of the last configured, or corresponding configuration
+is displayed. In case the trigger is swicthed on or the MCP is in state
+data-taking, only the configuration name and the last available
+DRS trigger baseline calibration run is displayed in parenthesis, if
+available. For the special cases that the threshold is currently
+calibrated or a rate scan is in progress, Calibrating threshold or
+Rate scan in progress is displayed. Is the MCP is configured to take
+data or data-taking is in progress, either the length of the run to be taken
+and/or the number of events to be taken are displayed, or an estimate of
+the remaining time and/or number.
+|
Index: trunk/FACT++/www/smartfact/struct/help-fact-temp.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-fact-temp.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-fact-temp.page (revision 14623)
@@ -0,0 +1,19 @@
+FACT
+|
Relative camera temperature
+The difference between the average temperatur in the sensor compartment
+and the outside temperature as measured by the MAGIC weather station
+is displayed if both value are available.
+
+Currently, no color codes are applied. A green background just means
+that a valid number is displayed, i.e. that the camera is
+switched on because values were recived from the slow control
+board and values are received from the MAGIC weather station.
+
+The backround colors have the following meaning:
+
+If the dim network is online and magicweather is in state Receiving and
+at least one report has been received since smartfact was started,
+the current humidity and a measure for the wind gusts from the
+MAGIC weather station are displayed.
+
+
+
Wind gusts below 35km/h and humidity below 95%
+
Wind gusts larger than 35km/h or humidity larger than 95%
+
Wind gusts larger than 50km/h or humidity larger than 98%
+The camera display shows on the last events sent by the fadctrl. For
+network traffic reasons only one value, i.e. the maximum
+of all four or five pixels, is displayed per bias channel
+and the time marker channels are ignored. The extracted value corresponds
+to the maximum entry found in the region-of-interest.
+|
Index: trunk/FACT++/www/smartfact/struct/help-histogram.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-histogram.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-histogram.page (revision 14623)
@@ -0,0 +1,14 @@
+Histogram
+|image=fact-histogram.png|
+|
min / med /max
+The minimum, median and maximum value of all values displayed in the histogram.
+|
+|
Scale
+The scale of the displayed coordinate system. Note that the x-axis is
+defined by the writer and the points are always equidistant in x, even
+they might not be equidistant at all.
+|
+|
Data
+The data as reloaded from the server. Note that the data is quantized
+into seven bit. Hence, the resolution is limited to 128 steps.
+|
Index: trunk/FACT++/www/smartfact/struct/help-introduction.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-introduction.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-introduction.page (revision 14623)
@@ -0,0 +1,32 @@
+Introduction
+|
+The idea of SmartFACT++ is simple. A backend (smartfact) updates some
+data-files continously which can then be retrieved from a web-server
+and the data is displayed in your browser. To keep the network traffic
+low the data is not encapsulated in html, but transmitted as is.
+A JavaScript, running client side, i.e. on the machine running
+the browser is then creating the html around it dynamically which is then
+displayed by the browser. The backend writing the data-files can be basically
+everything. In case of FACT it is a program called smartfact which
+subscribes to all dim-services in the dim-network which are needed.
+Whenever a service is updated, the corresponding files are also updated.
+The disadvantage is that it is difficult to mix information which is
+not updated together in a single file and display it on a single page.
+This, e.g., means that a file which is only updated every two
+hours (because new information is only available every two hours) cannot
+reasonably store information which can change every minute, e.g.
+general warnings. Every page is restricted to reload a single file, to
+keep network traffic low. A simple solution would be a php which concatenates
+information before the information is transfered, but this is (not yet?)
+available. Consequently, all pages which are not updated frequently or
+are guranteed to be updated frequently will not show fats updateing
+information as warning. Some pages, e.g., the main page are
+updated once every seconcd or few seconds rather than updated
+event-driven by the reception of a new service. These pages will then
+show informations like the current warning status of the system.
+
+The page description is reloaded whenver a page has been clicked to
+avoid a lot of network traffic at startup. The disadvantage is a little
+network traffic (in the order of a few hundred bytes) whenever a page
+is changed.
+|
Index: trunk/FACT++/www/smartfact/struct/help-layout.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-layout.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-layout.page (revision 14623)
@@ -0,0 +1,37 @@
+Layout
+|
Home
+Links from all other pages (except the home page itself) to the home page
+|
+|
Watchdog
+The two dots on the left and the right of the title change their color
+with every retrieved data or graphics file, respectively. This is a way
+to find out if the continous retrieval is still in progress.
+|
+|
Time stamp of displayed data
+Each data file which is loaded from the server comes with a time-stamp.
+This time-stamp is displayed here. This allows for example to find out
+whether the values are still valid or just the last values produced by the
+system hours ago. If this time-stamp is older than sixty seconds,
+the time is displayed in red color.
+|
+|image=fact-inactive.png|
+|
Link to help page
+Links to a page giving information about the data currently displayed,
+e.g. meaning of background colors, etc.
+|
+|
Link to control page
+A direct link to the control page from which actions can be initiated.
+|
+#|
Title
+#|
+|
Stop script
+If this button is pressed a STOP is sent to the script control and the script
+should be terminated. On pages which are updated regularly, the color
+shows if a script is running (green) or not (red). When the
+button is displayed uncolored, the data is in general not updated often enough
+to deliver up-to-date information.
+|
+|
Current UTC
+The current UTC time is displayed. If this does not happen anymore there
+is a problem with the JavaScript. This is a bug and should never happen.
+|
Index: trunk/FACT++/www/smartfact/struct/help-main.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-main.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-main.page (revision 14623)
@@ -0,0 +1,16 @@
+SmartFACT++
+|
General help
||
+|The basic idea - how does it work?||help-introduction
+|Page layout (displayed elements)||help-layout
+|The camera display||help-camera
+|The histogram display||help-histogram
+|Network traffic and refresh||help-traffic
+|URL options||help-url
+|Sounds||help-sounds
+|File syntax||help-syntax
+||
+||
+#|
Help for main page
||help-main
+|
About
||help-about
+||
+|Please report bugs or problems to Thomas Bretz|
Index: trunk/FACT++/www/smartfact/struct/help-sounds.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-sounds.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-sounds.page (revision 14623)
@@ -0,0 +1,87 @@
+Sounds
+|
+Sounds have to be explicitly switched on in the URL, e.g.
+
+
+http://[url]/?sound
+
+
+Sounds will only be available on pages with regular updates, which are
+the main page and the status page. If sounds are not available,
+a stroke out speaker is displayed.
+
+Note that these pages are only reloaded once in a few seconds. If more
+than one sound is to be played during that time only the last sound
+will be played, i.e. that in special circumstances some sounds
+might be missed.
+
+In the following examples of all available sounds are listed.
+|
+|
Startup
+
+This sound is played whenever the control-program of the slow control board
+(fscctrl) gets contact to the hardware. This is usually the case when
+the camera is switched on.
+|
+|
Shutdown
+
+This sound is played whenever the control-program of the slow control board
+(fscctrl) looses contact with the hardware. This is usually the case when
+the camera is switched off.
+|
+|
Error
+
+If a severe error happens, this sounds is displayed. Until the error
+remains, a warning symbol is also displayed in the upper left corner
+and links to current error messages. A history of erros is accessible
+from the status page via the Smartfact entry.
+|
+|
Script ends
+
+A ding is played if a script has ended or been stopped.
+|
+|
Manual run ends
+
+If a run has been started manually, i.e. no script is running
+at the same time, a ding is played when the run end or to be more
+precise when the Master Control Program (MCP) changed its state
+from TakingData to Idle which happens when the data acquisition (fadctrl)
+leaves its state WritingData.
+|
+|
Automatic run ends
+
+For this tick-sound the same conditions apply than for the previous sound
+except that it is played when a script is executed while the run ends.
+The same sound is played whenever a run is started, i.e. the Master
+Control Program (MCP) changed its state from TriggerOn to TakingData
+which happens when the first even has been received and the data
+acquisition (fadctrl) changed its state to WritingData.
+
+|
+|
Message
+
+This sound will be played if a new message is distributed by the chat-server.
+The chatlog and the possibility to send messages is available from the
+Chat Server entry in the status page.
+|
Index: trunk/FACT++/www/smartfact/struct/help-syntax.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-syntax.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-syntax.page (revision 14623)
@@ -0,0 +1,60 @@
+Syntax
+|
+To write your own page you need to understand the syntax of the files.
+The first line in the file is the title. It is just the title
+displayed. If the first character is an asterix (*) then the page is
+considered a page which is intented for script submission (control
+page). If the page name starts with help-, the page is
+considered a help page and the help symbol is inactive. If the page is
+a control page, the submitted script with have the name of the page
+without extension, with the extension .dim, e.g.
+if the page name is mypage.page the submitted scripts
+name is mypage.dim.
+
+Each following line of the file describes a row in the table and is
+split by pipes (|). To use a pipe in a line you have to
+write |. Lines which containes less than two pipes are
+concatenated until the number of pipes in one line is at least two. So
+the description of one row can look like
+
+
+leftlink|Description|format|rightlink
+
+
+but also
+
+
+leftlink|
+Description
+|format|rightlink
+
+
+If leftlink is available, a left arrow is displayed on the left
+and the row will link to page called leftlink.page. The same for
+rightlink, just that a right arrow is displayed on the right instead.
+Both are mutually exclusive, and can also be omotted.
+
+The Description is just a text which appears on the left side of
+the row in bold-face. if the format is omitted, it will fill the full
+width of the table and be displayed in normal-face. Consequently, a
+simple text entry could look like:
+
+
+|
+This is my simple text entry.<br/>
+We can have more lines...
+
+...and even a paragraph-break.<br/>
+|
+
+
+Every line starting with a # is ignored.
+
+The description can also have special contents (see below).
+
+If the help is not a help-page, a data file is loaded and its data is
+displayed on the right of each row according the format given.
+|
+|Special tag descriptions||help-description
+|Data file and data file format||help-datafile
+|Binary file format||help-binaryfile
Index: trunk/FACT++/www/smartfact/struct/help-traffic.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-traffic.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-traffic.page (revision 14623)
@@ -0,0 +1,36 @@
+Network traffic
+|
+This interface is optimized for slow network connection and low network
+traffic. It is not advisable to reload the pages manually because you
+would just reload the JavaScript. The traffic should be less than
+1kB/s and hence suitable also for mobile connections. The layout is
+optimized for small windows and mobile phones.
+
+The data displayed is refreshed once every three seconds, i.e.
+the file is reloaded from the server. The graphics display is refreshed
+once every five seconds. A new refresh is only started if the old one
+has been finished, either successfully for with an error or timeout,
+i.e. that slow or faulty network connection can significanly
+increase the refresh time. Whenever a refresh was performed, the color
+of the dots around the title is changed (one for the data and one for
+the graphics) to indicate that the JavaScript is still running and
+requesting data from the server. Also the time stamp at the footer is
+updated. The time-stamp of the retrieved data is displayed at the top.
+If no updated could be performed within sixty seconds or the data is
+older than sixty seconds the time stamp is displayed in red. If the
+time-stamp of the graphics is older than sixty seconds the graphics is
+grayed.
+
+In case of errors or broken connections, the time interval for
+retrieval is increased to ten seconds, and decreased again if valid
+data was received.
+
+The timer is not newly started if a new page is loaded, hence, it might
+take a few seconds before the values will be displayed.
+
+The typical size of a camera display is about 350 bytes, the typical
+size of the ascii data is about 100 bytes. Adding the HTML header
+which is in the order of 200 bytes, this yields an average transmission
+rate of aprroximately 200 bytes per second. This is less than one
+mega-byte in one hour, plus the data loaded for each page switch.
+|
Index: trunk/FACT++/www/smartfact/struct/help-url.page
===================================================================
--- trunk/FACT++/www/smartfact/struct/help-url.page (revision 14623)
+++ trunk/FACT++/www/smartfact/struct/help-url.page (revision 14623)
@@ -0,0 +1,54 @@
+URL
+|
+The url you specify when calling SmartFACT++ can contain links to the
+page you intend to view first, but also special arguments for steering
+the display, e.g.
+
+
+http://[url]/?w=320&h=200#status
+
+
+Would open the status page (status.page) and display the content
+with a fixed size of 320x200. Both, width and height, can be omitted.
+
+Also possible
+
+
+http://[url]/?max
+
+
+Usually the graphic is adapted to fit into the viewport (the size of
+your browser window). This option instructs SmartFACT++ to display the
+graphics always quadratically and with the full width, i.e. it
+might range outside of your window on the bottom of your page and a scroll
+bas would be displayed.
+
+Since SmartFACT++ is also meant for mobile devices, some compromises had
+to be made. One is that modern HTML5 techniques could not be applied to
+the fullest. If your browser has problems with switching pages, you
+can turn off the sliding effect by:
+
+
+http://[url]/?noslide
+
+
+On pages which are regularly updated, i.e. the main page and
+the status page, sound output for certain circumstances can be enabled
+with the sound option:
+
+
+http://[url]/?sound
+
+
+All of the options can be combined as long as they make sense, e.g.
+
+
+http://[url]/?noslide&sound
+
+
+In all examples above the url would usually be
+
+