Changeset 2542

Timestamp:

Jul 3, 2014, 3:04:55 PM (9 years ago)

Author:

olle

Message:

Refs #615. Lab environment extension updated in installation documentation:

1. Outermost README file updated:
   a. New header section with component name and version.
   b. Installation instructions extended concerning settings in configuration file labenv-config.xml.
   c. Extra info on alarm functionality added at the end.

File:

• extensions/net.sf.basedb.labenv/trunk/README (modified) (4 diffs)

extensions/net.sf.basedb.labenv/trunk/README

@@ +1 @@
+== Component name ==
+
+Name: LabEnv v1.2
+Type: BASE extension
+Full name: Lab Environment Extension
+
 == Requirements ==
 
@@ -21 +27 @@
  4. Copy the `labenv-config.xml` file to `WEB-INF/classes` directory.
  5. The default `labenv-config.xml` file does not contain any useful
-    configuration values, but have to be edited with information
-    on the lab sensors. Measurement data will be stored in the database
-    for the sensor number defined in the configuration file. This lab
-    sensor number is therefore not just a trivial index number for
-    internal use in the XML configuration file. When sensors are added
-    for new locations, they should normally be configured with a new
-    unique number.
+    configuration values, but has to be edited with information
+    on the lab sensors.
+    a. Configuration of database for lab environment data and settings
+    common for all lab sensors. If no values are given for "dbfilename",
+    "timeoutinseconds", "storageintervalinseconds", and
+    "numberofmeasurementsperstoredvalue", default values "labenv.db",
+    5, 300, and 5, will be used, respectively. This corresponds to
+    measurements each minute and storage of the average values every
+    5th minute. If alarm notification via e-mail is desired, information
+    about what e-mail server to use must be entered for "smtphost".
+    Attribute "fromaddress" is the e-mail address shown in the
+    "From"-field for the mail; normally this is of the type
+    "noreply@*" here, e.g. "noreply@thep.lu.se". Attribute "fromname"
+    is the name part of the "From"-field for the mail, e.g. something
+    generic like "Lab Environment BASE extension", or something more
+    specific for your BASE server or lab.
+    b. Measurement data will be stored in the database for the sensor
+    number defined in the configuration file. This lab sensor number
+    is therefore not just a trivial index number for internal use in
+    the XML configuration file. When sensors are added for new
+    locations, they should normally be configured with a new unique
+    number. If no "startdate" is given for a sensor, it will be ignored.
+    c. Alarm configuration for a lab sensor is optional. One or more
+    alarm configurations can be entered for each sensor. Each alarm
+    configuration contains start and end time in "HHmm" format,
+    a weekday filter with one of the values "all", "mondaytofriday",
+    "saturdaytosunday", "workdays", or "nonworkdays" (last two entries
+    are currently adapted to the automatic climate control at labs
+    in Medicon Village, Lund University, Sweden), minimum and maximum
+    allowed values for temperature and humidity, and a user list
+    of alarm administrators. For each alarm administrator is entered
+    the BASE log-in name ("id"), and an optional e-mail address for
+    alarm notification.
  6. Copy the 'labenv.jar' file to your BASE plug-ins directory. 
-   Look in your 'base.config' file if you don't know where this is.
+    Look in your 'base.config' file if you don't know where this is.
  7. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
  8. Run the installation wizard and select to install 'labenv.jar'.
@@ -49 +81 @@
 
  * No known issues. 
- 
+
 == Tips and tricks ==
 
@@ -95 +127 @@
 the 'build.xml' file, create a file named 'build.properties' and set
 the values there.
+
+== Alarm functionality ==
+
+* After an alarm has been reported, new alarm reports for that
+configuration are normally blocked, until an alarm administrator
+resets the alarm. An exception is alarm for lost contact with the
+sensor, that blocks alarms of the same type, but not alarms for
+temperature or humidity values outside allowed values, if contact with
+the sensor should be reestablished.
+* All alarms are reset if the Lab Environment service is restarted.
+* All users can inspect alarm status via menu Extensions ->
+Lab Environment -> Lab environment alarms, but only an alarm
+administrator for an alarn can reset it. It is reset by setting option
+"Alarm blocked" to "No" and clicking button "Set alarm blocker".