device_monitor - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > estate management


DESCRIPTION

The device monitor periodically checks on the availability and health of every air quality monitoring device. The device_monitor utility is used to manage the email addresses for alerts associated with individual devices.

The --credentials flag is only required where the user wishes to store multiple identities. Setting the credentials is done interactively using the command line interface.

SYNOPSIS

device_monitor.py [-c CREDENTIALS] { -F [{ -e EMAIL_ADDR | -t DEVICE_TAG } [-x]] | -A EMAIL_ADDR DEVICE_TAG | -S DEVICE_TAG { 0 | 1 } | -D EMAIL_ADDR [{ -t DEVICE_TAG | -f }] } [-i INDENT] [-v]

Options
-h, --help show this help message and exit
-c CREDENTIALS_NAME, --credentials=CREDENTIALS_NAME the stored credentials to be presented
-F, --find find monitoring (for email address or device)
-A ADD, --add=ADD add email address to device
-S SUSPEND, --suspend=SUSPEND suspend monitoring of the device
-D DELETE, --delete=DELETE delete email address (from device or throughout)
-j, --json-message message body is JSON
-e EMAIL, --email=EMAIL email address
-t DEVICE_TAG, --device-tag=DEVICE_TAG device tag
-x, --exactly exact match for tag
-i INDENT, --indent=INDENT pretty-print the output with INDENT
-v, --verbose report narrative to stderr

EXAMPLES

device_monitor.py -c super -Ft scs-opc-109

DOCUMENT EXAMPLE

{
    "scs-bgx-570": {
        "device-tag": "scs-bgx-570",
        "recipients": [
            {
                "email": "[email protected]",
                "json-message": false
            }
        ],
        "suspended": false
    }
}

SEE ALSO

scs_analysis/cognito_user_credentials
scs_analysis/device_monitor_status

⚠️ **GitHub.com Fallback** ⚠️