parameters.yaml

@@ -1,16 +1,15 @@
 # Parameters file for Surveillance Bot
 datapath: "/data/SDS/"                    # SC3 Datapath
-networks: ["1Y", "HA"]
-stations: "*"
-locations: "*"
+networks: ["1Y", "HA"]                    # select networks, list or str
+stations: "*"                             # select stations, list or str
+locations: "*"                            # select locations, list or str
 channels: ["EX1", "EX2", "EX3", "VEI"]    # Specify SOH channels, currently supported EX[1-3] and VEI
-channel_names: ["Temperature (°C)", "230V/12V Status (V)", "Router/Charger State (V)", "Logger Voltage (V)"] # names for plotting (optional)
-stations_blacklist: ["TEST", "EREA"]
-networks_blacklist: []
+stations_blacklist: ["TEST", "EREA"]      # exclude these stations
+networks_blacklist: []                    # exclude these networks
 interval: 60               # Perform checks every x seconds
 n_track: 120               # wait n_track * intervals before performing an action (i.e. send mail/end highlight status)
 timespan: 7                # Check data of the recent x days
-verbosity: 0
+verbosity: 0               # verbosity flag
 track_changes: True        # tracks all changes since GUI startup by text highlighting (GUI only)
 warn_count: False          # show number of warnings and errors in table
 dt_thresh: [300, 1800]     # threshold (s) for timing delay colourisation (yellow/red)
@@ -44,20 +43,31 @@ THRESHOLDS:
   high_volt: 14.8               # max voltage for over voltage warning
   unclassified: 5              # min voltage samples not classified for warning
 
+# ---------------------------------------- OPTIONAL PARAMETERS ---------------------------------------------------------
+
 # add links to html table with specified key as column and value as relative link, interpretable string parameters:
 # nw (e.g. 1Y), st (e.g. GR01A), nwst_id (e.g. 1Y.GR01A)
-# optional!
 add_links:
-  slmon: {"URL": "../slmon/{nw}_{st}.html", "text": "show"}  # for example: slmon: {"URL": "path/{nw}_{st}.html", "text": "link"}
+  # for example: slmon: {"URL": "path/{nw}_{st}.html", "text": "link"}
+  slmon: {"URL": "../slmon/{nw}_{st}.html", "text": "show"}
   24h-plot: {"URL": "../scheli/{nw}/{st}.png", "text": "plot"}
 
-# E-mail notifications (optional)
+# E-mail notifications
 EMAIL:
   mailserver: "localhost"
   addresses: ["marcel.paffrath@rub.de", "kasper.fischer@rub.de"]  # list of mail addresses for info mails
   sender: "webmaster@geophysik.ruhr-uni-bochum.de" # mail sender
 
-# Factor for channel to SI-units (for plotting, optional)
+# names for plotting of the above defined parameter "channels" in the same order
+channel_names: ["Temperature (°C)", "230V/12V Status (V)", "Router/Charger State (V)", "Logger Voltage (V)"]
+# specify y-ticks (and ylims) giving, (ymin, ymax, step) for each of the above channels (0: default)
+CHANNEL_TICKS:
+  - [-10, 50, 10]
+  - [1, 5, 1]
+  - [1, 5, 1]
+  - [9, 15, 1]
+
+# Factor for channel to SI-units (for plotting)
 CHANNEL_UNITS:
   EX1: 1e-6
   EX2: 1e-6
@@ -65,7 +75,6 @@ CHANNEL_UNITS:
   VEI: 1e-3
 
 # Transform channel for plotting, perform arithmetic operations in given order, e.g.: PBox EX1 V to deg C: 20 * x -20
-# optional!
 CHANNEL_TRANSFORM:
   EX1:
     - ["*", 20]