SMS & voice alerts for Ignition SCADA

				
					import system

LOGGER = system.util.getLogger("SMSEagle")
CONFIG\_PATH = "\[default]SMSEagle/Config"


def getConfig():
    """Reads the gateway configuration from tags."""
    paths = \[
        "%s/gatewayUrl" % CONFIG\_PATH,
        "%s/accessToken" % CONFIG\_PATH,
        "%s/voiceId" % CONFIG\_PATH,
        "%s/callDuration" % CONFIG\_PATH,
        "%s/verifySsl" % CONFIG\_PATH,
    ]
    v = system.tag.readBlocking(paths)
    return {
        "url": str(v\[0].value).rstrip("/"),
        "token": str(v\[1].value),
        "voiceId": int(v\[2].value or 2),
        "duration": int(v\[3].value or 20),
        "verifySsl": bool(v\[4].value),
    }


def \_normalize(recipients):
    """Accepts a string or a list. Recipient formats:
    "+48111222333" phone number, "15:c" contact, "12:g" Phonebook group.
    """
    if recipients is None:
        return \[]
    if isinstance(recipients, basestring):
        return \[r.strip() for r in recipients.split(",") if r.strip()]
    return \[str(r).strip() for r in recipients if str(r).strip()]


def \_post(endpoint, payload, kind):
    """Posts a request to APIv2 and logs the outcome."""
    cfg = getConfig()
    if not cfg\["url"] or not cfg\["token"]:
        LOGGER.error("Missing configuration: gatewayUrl or accessToken")
        return False

    client = system.net.httpClient(
        timeout=10000,
        bypass\_cert\_validation=not cfg\["verifySsl"]
    )
    headers = {"access-token": cfg\["token"],
               "Content-Type": "application/json"}

    try:
        r = client.post(cfg\["url"] + endpoint, headers=headers, data=payload)
    except Exception, e:
        LOGGER.error("%s: connection error: %s" % (kind, str(e)))
        return False

    if r.good:
        LOGGER.info("%s sent, HTTP %s" % (kind, r.statusCode))
        return True

    LOGGER.error("%s rejected, HTTP %s: %s" % (kind, r.statusCode, r.text))
    return False


def sendSms(recipients, text, priority=None):
    to = \_normalize(recipients)
    if not to:
        LOGGER.warn("sendSms: empty recipient list")
        return False
    payload = {"to": to, "text": text}
    if priority is not None:
        payload\["priority"] = int(priority)
    return \_post("/api/v2/messages/sms", payload, "SMS")


def ringCall(recipients, duration=None):
    to = \_normalize(recipients)
    if not to:
        return False
    cfg = getConfig()
    payload = {"to": to, "duration": int(duration or cfg\["duration"])}
    return \_post("/api/v2/calls/ring", payload, "Ring call")


def ttsAdvancedCall(recipients, text, voiceId=None, duration=None):
    to = \_normalize(recipients)
    if not to:
        return False
    cfg = getConfig()
    payload = {
        "to": to,
        "text": text,
        "voice\_id": int(voiceId or cfg\["voiceId"]),
        "duration": int(duration or cfg\["duration"]),
    }
    return \_post("/api/v2/calls/tts\_advanced", payload, "TTS Advanced call")


def formatAlarm(event):
    return "%s | %s | prio %s" % (
        event.get("displayPath") or event.get("source"),
        event.get("label"),
        event.priority
    )


def notifyAlarm(event, recipients=None, mode="SMS",
                voiceId=None, duration=None):
    """Entry point for the Script block in a Notification Pipeline."""
    if recipients is None:
        recipients = system.tag.readBlocking(
            \["%s/defaultRecipients" % CONFIG\_PATH])\[0].value

    text = formatAlarm(event)
    mode = (mode or "SMS").upper()
    ok = True

    if mode in ("SMS", "SMS\_AND\_RING", "SMS\_AND\_TTS"):
        ok = sendSms(recipients, text) and ok
    if mode in ("RING", "SMS\_AND\_RING"):
        ok = ringCall(recipients, duration) and ok
    if mode in ("TTS", "SMS\_AND\_TTS"):
        ok = ttsAdvancedCall(recipients, text, voiceId, duration) and ok

    return ok


def testConnection():
    """Diagnostics. Call from the Designer script console."""
    cfg = getConfig()
    if not cfg\["url"]:
        return {"ok": False, "status": 0, "message": "gatewayUrl is not set"}

    client = system.net.httpClient(
        timeout=10000,
        bypass\_cert\_validation=not cfg\["verifySsl"]
    )
    headers = {"access-token": cfg\["token"]}

    try:
        r = client.get(cfg\["url"] + "/api/v2/modem/status", headers=headers)
    except Exception, e:
        return {"ok": False, "status": 0, "message": str(e)}

    if r.good:
        return {"ok": True, "status": r.statusCode,
                "message": "Connection OK"}

    hints = {
        401: "Invalid or expired API token",
        403: "API user lacks the required permissions",
        404: "Check the gateway address and firmware version (APIv2 required)",
    }
    return {"ok": False, "status": r.statusCode,
            "message": hints.get(r.statusCode, r.text)}