SQDFridgeMon - a Dilution Fridge Monitor with Automated Emails

Currently, this package contains a simplified dashboard that reads files from SQDFridgeLog and a separate email script. Note that the suite is not not intended to replace a dedicated dashboard:

• It is intended as a fast unified viewer for all fridge types to help peruse the log history via a fast plotting API (PyQTgraph).
• It reads the database files written by SQDFridgeLog
• The email alerting software is simplistic and lightweight (can run on the fridge computers; including Windows XP)

An advantage of this suite is that it accompanies SQDFridgeLog with a lightweight GUI that does not have database synchronisation issues seen with dashboards using SQLite3 databases hosted over a network share (e.g. locking issues when issuing multiple queries).

Simple unified dashboard and history viewer

Run MainDash.py (requires PySide - similar installation to SQDViz) after adding configDash.json to this folder:

{
    "BluFors LD":
    {
        "DB Filepath" : "C:/Bob/BluForsLD.db",
        "Display Config" :
        {
            "Compressors" :
            [
                ["tempWaterInlet", 0, 30], ["tempWaterOutlet", 0, 35], ["tempOil", 0, 30]
            ],
            "Pressures" :
            [
                ["Povc", 0, 1000], ["Pstill", 0, 1000], ["Pcond", 0, 1000], ["Ppretrap", 0, 1000], ["Ptank", 0, 1000]
            ],
            "Temperatures" :
            [
                ["tempCold50K", 40, 75], ["tempCold4K", 0, 8], ["tempColdStill", 0.25, 1], ["tempColdMC", 0, 0.1]
            ]
        }
    },
    "BluFors SD":
    {
        ...
    }
}

In the above example, the "Display Config" key contains columns of plots given as lists. The triplets are given as the parameter name (i.e. database table name), minimum and maximum values over which the colour map is scaled.

Automated email script

This script monitors the auto-generated fridge logs and emails the users if there are any abnormalities. To setup the script, first pull this repository to have the latest version-controlled script:

cd C:/Users/....../myFolder/
git clone https://github.com/sqdlab/SQDFridgeMon.git

Then create a config.json file in the folder SQDFridgeMon:

{
    "Recipients": [
        "john.doe@aol.com"
    ],
    "FromEmail": "fromEmail@yahoo.com",
    "UserName" : "user name",
    "Password" : "XXXXXXXXXXXXXXXX",
    "SMTP"     : "smtp.mail.yahoo.com",
    "Port"     : 587,
    "UseTLS"   : true,
    "FridgeName" : "BluFors LD",
    "FridgeType"    : "BluFors",
    "FridgeLogLocation"    : "/.../FilePath to Fridge Logs directory/",
    "AcceptableParameterRanges":
    {
        "Water Inlet Temperature" : [0, 30],
        "Water Outlet Temperature" : [0, 40],
        "Oil Temperature" : [0, 30],
        "P2" : [-1, 1e-3],
        "P3" : [-1, 1],
        "P4" : [-1, 1]
    }
}

Note the following features:

• The recipients are given as a list
• FromEmail is the actual email address
• UserName is the user-name used to log into the account (typically the same as FromEmail)
• Password is the app-password generated by the email provider:
  • Yahoo
  • GMail
• For Port and TLS either experiment or refer to the email provider for further details
• FridgeType must correspond to one of the JSON file names in the FridgeConfigs folder.
• FridgeLogLocation is the directory where all the log files are stored.
• AcceptableParameterRanges must give a list of key-value pairs in which the values are a tuple representing the acceptable interval for the given parameter. Each key must be a valid one listed in the corresponding JSON file in the FridgeConfigs folder.

To run the program (after setting up config.json), simply run:

python Main.py