ShellyStatusAlertViaScene.js

/*
Created by Leivo Sepp, 2025
Licensed under the MIT License
https://github.com/LeivoSepp/Shelly-Status-Alerts-via-Scenes

Shelly Device Status Alerts via Scenes

This script tracks the online status of remote Shelly devices and 
triggers Shelly scenes to notify users when devices go offline or come back online.

Please set the following parameters in the KVS after the initial run of the script.
  "url": "https://xxx-xx-xx.shelly.cloud/",
  "apiKey": "your API key",
  "SceneIdOffline": "SceneId",
  "SceneIdOnline": "SceneId",

How to get the API key and URL:
1. Go to https://control.shelly.cloud/
2. Click Settings -> "Authorization cloud key" -> Get key.
3. Copy the API key, Shelly cloud URL and save them in the KVS

How to get the SceneId:
1. Go to https://control.shelly.cloud/
2. Click on the Scenes -> open the scene -> Informaton -> copy the Scene ID and save it in the KVS
3. Repeat the steps for the other scene.

Set the devices in the CONF.dvsc array to monitor. 
The id is the device id (mac address) and the name is anything you like to call it.
{ id: "1234567890", name: "My garage Pro 3EM" },

How to get the device id:
1. Go to https://control.shelly.cloud/
2. Click on the room -> device -> Settings -> Device Information
3. Copy the DeviceId (MAC address) and save it in the script
4. Repeat the steps for the other devices

The script will check the online status and then loop to next device.
If all devices are offline, the scene with the id CONF.scOf will be triggered.
If any device is back online, the scene with the id CONF.scOn will be triggered.

There are two non documented API calls that can be used to manage Shelly scenes.
- scene/manual_run?auth_key=apiKey&id=SceneId
- scene/enable?enabled=true&auth_key=apiKey&id=SceneId
- scene/enable?enabled=false&auth_key=apiKey&id=SceneId
*/
/**

 */
function dvsc() {
    return [
        { id: "123456789", name: "Nibe heating" },
        { id: "123456789", name: "Main Pro 3EM" },
        { id: "123456789", name: "Garage Shelly" },
    ]
}
let CONF = {
    ping: 60,       //time in seconds before next device check 
    url: '',        //url to the Shelly cloud
    apiK: '',       //API key
    scOf: '',       //scene id for offline
    scOn: '',       //scene id for online
    sRun: "/scene/manual_run",
    ver: "1.3",
};

let dIdx = 0;                   //device index
let fCnt = 0;                   //failure counter
let fail = false;               //is failure
let ok = true;                  //is ok
let outT = [];                  //offline times
let outX = 0;                   //offline index
const sId = Shelly.getCurrentScriptId();
pId = "Id" + Shelly.getCurrentScriptId() + ": ";


// set auto start
function strt() {
    if (!Shelly.getComponentConfig("script", sId).enable) {
        Shelly.call('Script.SetConfig', { id: sId, config: { enable: true } });
    }
}
// get KVS
function getK() {
    Shelly.call('KVS.Get', { key: "ShellyAlertsViaScene" + sId },
        function (res, err) {
            if (err !== 0) {
                let val = {
                    url: "url",
                    apiKey: "your_API_key",
                    SceneIdOffline: "sceneId",
                    SceneIdOnline: "sceneId",
                    Version: CONF.ver
                };
                print(pId, "API key and configuration parameters must be set in KVS.");
                Shelly.call('KVS.Set', { key: "ShellyAlertsViaScene" + sId, value: JSON.stringify(val) });
                Shelly.call('Script.Stop', { id: sId });
                return;
            }
            CONF.apiK = JSON.parse(res.value).apiKey;
            CONF.url = JSON.parse(res.value).url;
            CONF.scOf = JSON.parse(res.value).SceneIdOffline;
            CONF.scOn = JSON.parse(res.value).SceneIdOnline;
        });
}
// check device status
function pngD() {
    Shelly.call(
        "HTTP.POST", {
        "url": CONF.url + "/device/status",
        "content_type": "application/json",
        "body": JSON.stringify({ id: dvsc()[dIdx].id, auth_key: CONF.apiK }),
    }, function (res, err, msg) {
        let nDvc = dvsc().length;   //number of devices
        let next = frmT(new Date(Math.floor(Date.now() + CONF.ping * 1000)));
        if (err !== 0 || res === null || res.code != 200) {
            print(pId, "Error of reading this device:", dvsc()[dIdx].name, msg, err, ". Switching to next device at " + next);
            dIdx++;
            dIdx = dIdx % nDvc;
            return;
        }
        //instead of parsing the JSON, search for the strings to save memory
        let body = res.body;
        let isok = body.indexOf("isok") + 6;
        let onln = body.indexOf("online") + 8;

        if (!(body.substring(isok, body.indexOf(",", isok)) === "true") || !(body.substring(onln, body.indexOf(",", onln)) === "true")) {
            fCnt++;
            print(pId, dvsc()[dIdx].name, "is offline.", "Switching to next device at " + next);
        } else {
            fail = false;
            print(pId, dvsc()[dIdx].name, "is online.", "Next check at " + next);
        }
        next = null;
        print(dIdx === nDvc - 1 ? pId + (nDvc - fCnt) + " out of " + nDvc + " device(s) are online." : "");
        dIdx++;
        dIdx = dIdx % nDvc;
        if (fCnt >= nDvc && !fail) {
            print(pId, "Scene: All devices are offline at", frmT(new Date()));
            fCnt = 0;
            fail = true;
            ok = false;
            Scen(CONF.scOf);
            outT.push({ from: frmT(new Date()) });
            sKvs(outT);
            return;
        }
        if (!ok && !fail) {
            print(pId, "Scene: Device(s) are back online at", frmT(new Date()));
            Scen(CONF.scOn);
            ok = true;
            fCnt--;
            outT[outX].to = frmT(new Date());
            sKvs(outT);
            outX === 2 ? outT.splice(0, 1) : outT;  //remove the first element
            outX = outX === 2 ? 2 : outX + 1;       //max arr length = 3
            return;
        }
        fCnt = dIdx === 0 ? 0 : fCnt;
    });
}
// send scene
function Scen(id) {
    Shelly.call(
        "HTTP.GET", {
        "url": CONF.url + CONF.sRun + "?auth_key=" + CONF.apiK + "&id=" + id,
        "content_type": "application/json",
    });
}
// store offline times to KVS
function sKvs(val) {
    Shelly.call('KVS.Set', { key: "ShellyOutages" + sId, value: JSON.stringify(val) });
}
// format time
function frmT(date) {
    return (date.getHours() < 10 ? "0" + date.getHours() : date.getHours()) + ":"
        + (date.getMinutes() < 10 ? "0" + date.getMinutes() : date.getMinutes()) + " "
        + date.getDate() + "."
        + (date.getMonth() + 1) + "."
        + date.getFullYear();
}
// start
strt();
getK();
Timer.set(1000, false, pngD);
Timer.set(CONF.ping * 1000, true, pngD);