aiohomematic 2026.1.29__py3-none-any.whl

aiohomematic/rega_scripts/accept_device_in_inbox.fn

@@ -0,0 +1,51 @@
+!# name: accept_device_in_inbox.fn
+!# param: "##device_address##"
+!#
+!# Accept a device from the CCU inbox by setting ReadyConfig to true.
+!# The device address is passed as parameter.
+!#
+!# Params for session recorder
+!#
+
+string sDeviceAddress = "##device_address##";
+boolean bSuccess = false;
+boolean bFound = false;
+string sError = "";
+
+!# Find device by iterating through ID_DEVICES and matching address
+object oDevices = dom.GetObject(ID_DEVICES);
+if (oDevices) {
+    string sDevId;
+    foreach(sDevId, oDevices.EnumIDs()) {
+        object oDev = dom.GetObject(sDevId);
+        if (oDev) {
+            if (oDev.Address() == sDeviceAddress) {
+                bFound = true;
+                if (!oDev.ReadyConfig()) {
+                    oDev.ReadyConfig(true);
+                    bSuccess = oDev.ReadyConfig();
+                    if (!bSuccess) {
+                        sError = "Failed to set ReadyConfig";
+                    }
+                } else {
+                    sError = "Device already accepted";
+                    bSuccess = true;
+                }
+            }
+        }
+    }
+}
+
+if (!bFound) {
+    sError = "Device not found";
+}
+
+Write('{"success":');
+if (bSuccess) {
+    Write('true');
+} else {
+    Write('false');
+}
+Write(',"error":"');
+Write(sError);
+Write('"}');

aiohomematic/rega_scripts/create_backup_start.fn

@@ -0,0 +1,28 @@
+!# name: create_backup_start.fn
+!#
+!# This script starts a system backup in the background.
+!# It returns immediately without waiting for completion.
+!# Use create_backup_status.fn to check the backup status.
+!#
+!# The backup file is saved to /usr/local/tmp/last_backup.sbk
+!# Works for OpenCCU.
+!#
+
+string sPid = "";
+
+!# Remove any existing backup file and pid file
+system.Exec("/bin/sh -c 'rm -f /usr/local/tmp/last_backup.sbk /usr/local/tmp/backup.pid'");
+
+!# Start backup in background using nohup
+!# Save the PID to a file for status checking
+system.Exec("/bin/sh -c 'nohup /bin/sh -c \"/bin/createBackup.sh /usr/local/tmp/last_backup.sbk; rm -f /usr/local/tmp/backup.pid\" > /dev/null 2>&1 & echo $! > /usr/local/tmp/backup.pid'");
+
+!# Verify the process was started
+system.Exec("test -f /usr/local/tmp/backup.pid && cat /usr/local/tmp/backup.pid", &sPid);
+sPid = sPid.Trim();
+
+if (sPid != "") {
+    Write('{"success":true,"status":"started","pid":"' # sPid # '"}');
+} else {
+    Write('{"success":false,"status":"failed","message":"Failed to start backup process"}');
+}

aiohomematic/rega_scripts/create_backup_status.fn

@@ -0,0 +1,89 @@
+!# name: create_backup_status.fn
+!#
+!# This script checks the status of a backup started by create_backup_start.fn.
+!# Returns:
+!#   - "running": Backup process is still running
+!#   - "completed": Backup file exists and process has finished
+!#   - "failed": Process finished but no backup file exists
+!#   - "idle": No backup process started (no pid file)
+!#
+
+string sResult   = "";
+string sStatus   = "idle";
+string sPid      = "";
+string sSize     = "";
+string sHostname = "";
+string sVersion  = "";
+string sFilename = "";
+string sDate     = "";
+
+boolean bProcessRunning = false;
+boolean bFileExists = false;
+boolean bPidFileExists = false;
+boolean bBackupComplete = false;
+
+!# Check if pid file exists
+sResult = "";
+system.Exec("test -f /usr/local/tmp/backup.pid && echo 'YES' || echo 'NO'", &sResult);
+if (sResult.Trim() == "YES") {
+    bPidFileExists = true;
+
+    !# Read the PID
+    sResult = "";
+    system.Exec("cat /usr/local/tmp/backup.pid", &sResult);
+    sPid = sResult.Trim();
+
+    !# Check if process is still running
+    sResult = "";
+    system.Exec("/bin/sh -c 'ps -o pid | grep " # sPid # " > /dev/null 2>&1 && echo YES || echo NO'", &sResult);
+    if (sResult.Trim() == "YES") {
+        bProcessRunning = true;
+    }
+}
+
+!# Check if backup file exists
+sResult = "";
+system.Exec("test -f /usr/local/tmp/last_backup.sbk && echo 'YES' || echo 'NO'", &sResult);
+if (sResult.Trim() == "YES") {
+    bFileExists = true;
+}
+
+!# Determine status
+if (bProcessRunning) {
+    sStatus = "running";
+} else {
+    if (bFileExists) {
+        sStatus = "completed";
+        bBackupComplete = true;
+        !# Clean up pid file
+        system.Exec("rm -f /usr/local/tmp/backup.pid &");
+    } elseif (bPidFileExists) {
+              sStatus = "failed";
+              !# Clean up pid file
+              system.Exec("rm -f /usr/local/tmp/backup.pid &");
+    } else {
+        sStatus = "idle";
+    }
+}
+
+!# Build response
+if (bBackupComplete) {
+    !# Get file size
+    system.Exec("stat -c %s /usr/local/tmp/last_backup.sbk 2>/dev/null", &sSize);
+    sSize = sSize.Trim();
+
+    !# Get backup filename with timestamp
+    system.Exec("hostname", &sHostname);
+    sHostname = sHostname.Trim();
+
+    system.Exec("cat /VERSION | grep VERSION= | cut -d= -f2", &sVersion);
+    sVersion = sVersion.Trim();
+
+    sDate = localtime.Format("%F-%H%M");
+
+    sFilename = sHostname # "-" # sVersion # "-" # sDate # ".sbk";
+
+    Write('{"status":"' # sStatus # '","file":"/usr/local/tmp/last_backup.sbk","filename":"' # sFilename # '","size":' # sSize # '}');
+} else {
+    Write('{"status":"' # sStatus # '"}');
+}

aiohomematic/rega_scripts/fetch_all_device_data.fn

@@ -0,0 +1,97 @@
+!# name: fetch_all_device_data.fn
+!# param: "##interface##"
+!#
+!# This script fetches all device data required to initialize the entities without affecting the duty cycle.
+!#
+!# Original script: https://github.com/ioBroker/ioBroker.hm-rega/blob/master/regascripts/datapoints.fn
+!# datapoints.fn 1.9
+!# 3'2013-9'2014 hobbyquaker https://github.com/hobbyquaker
+!#
+!# Dieses Homematic-Script gibt eine Liste aller Datenpunkte, die zur Laufzeit einen validen Zeitstempel haben, als JSON String aus.
+!#
+!# modified by: SukramJ https://github.com/SukramJ && Baxxy13 https://github.com/Baxxy13
+!# v2.2 - 09/2023
+!#
+!# Das Interface wird durch die Integration an 'sUse_Interface' übergeben.
+!# Nutzbare Interfaces: BidCos-RF, BidCos-Wired, HmIP-RF, VirtualDevices
+!# Zum Testen direkt auf der Homematic-Zentrale muss das Interface wie folgt eingetragen werden: sUse_Interface = "HmIP-RF";
+!#
+!# Params for session recorder
+!#
+
+string sUse_Interface = "##interface##";
+string sDevId;
+string sChnId;
+string sDPId;
+var vDPValue;
+boolean bDPFirst = true;
+object oInterface = interfaces.Get(sUse_Interface);
+
+Write('{');
+if (oInterface) {
+    integer iInterface_ID = interfaces.Get(sUse_Interface).ID();
+    string sAllDevices = dom.GetObject(ID_DEVICES).EnumUsedIDs();
+    foreach (sDevId, sAllDevices) {
+        object oDevice = dom.GetObject(sDevId);
+        if ((oDevice) && (oDevice.ReadyConfig()) && (oDevice.Interface() == iInterface_ID)) {
+            foreach (sChnId, oDevice.Channels()) {
+                object oChannel = dom.GetObject(sChnId);
+                if (oChannel) {
+                    var oDPs = oChannel.DPs();
+                    if (oDPs) {
+                        foreach(sDPId, oDPs.EnumUsedIDs()) {
+                            object oDP = dom.GetObject(sDPId);
+                            if (oDP && oDP.Timestamp()) {
+                                if (oDP.TypeName() != "VARDP") {
+                                    integer sValueType = oDP.ValueType();
+                                    boolean bHasValue = false;
+                                    string sValue;
+                                    string sID = oDP.Name().UriEncode();
+                                    if (sValueType == 20) {
+                                        sValue = oDP.Value().UriEncode();
+                                        bHasValue = true;
+                                    } else {
+                                        vDPValue = oDP.Value();
+                                        if (sValueType == 2) {
+                                            if (vDPValue) {
+                                                sValue = "true";
+                                            } else {
+                                                sValue = "false";
+                                            }
+                                            bHasValue = true;
+                                        } else {
+                                            if (vDPValue == "") {
+                                                sValue = "0";
+                                            } else {
+                                                sValue = vDPValue;
+                                            }
+                                            bHasValue = true;
+                                        }
+                                    }
+                                    if (bHasValue) {
+                                        if (bDPFirst) {
+                                            bDPFirst = false;
+                                        } else {
+                                            WriteLine(',');
+                                        }
+                                        Write('"');
+                                        Write(sID);
+                                        Write('":');
+                                        if (sValueType == 20) {
+                                            Write('"');
+                                            Write(sValue);
+                                            Write('"');
+                                        } else {
+                                            Write(sValue);
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+Write('}');

aiohomematic/rega_scripts/get_backend_info.fn

@@ -0,0 +1,25 @@
+!# name: get_backend_info.fn
+!#
+!# This script retrieves backend information and identifies the CCU type.
+!# Product is normalized to CCU (CCU2/CCU3/debmatic) or OpenCCU
+!#
+
+string sVersion = "";
+string sProduct = "";
+string sHostname = "";
+
+system.Exec("grep VERSION= /VERSION | tr -d '[:space:]' | cut -d= -f2", &sVersion);
+sVersion = sVersion.Trim();
+
+system.Exec("grep PRODUCT= /VERSION | tr -d '[:space:]' | cut -d= -f2", &sProduct);
+sProduct = sProduct.Trim();
+if ((!sProduct.Contains("ccu")) && (!sProduct == "debmatic")) {
+    sProduct = "OpenCCU";
+} else {
+    sProduct = "CCU";
+}
+
+system.Exec("hostname", &sHostname);
+sHostname = sHostname.Trim();
+
+Write('{"version":"' # sVersion # '","product":"' # sProduct # '","hostname":"' # sHostname # '"}');

aiohomematic/rega_scripts/get_inbox_devices.fn

@@ -0,0 +1,61 @@
+!# name: get_inbox_devices.fn
+!#
+!# This script returns all devices in the CCU inbox (not yet configured).
+!# These are newly paired devices that haven't been set up yet.
+!#
+
+string sDevId;
+boolean bFirst = true;
+string sName;
+string sAddress;
+string sType;
+string sInterface;
+
+Write('[');
+
+object oDevices = dom.GetObject(ID_DEVICES);
+if (oDevices) {
+    foreach(sDevId, oDevices.EnumIDs()) {
+        object oDev = dom.GetObject(sDevId);
+        if (oDev) {
+            !# Check if device is not yet configured (in inbox)
+            if ((!oDev.ReadyConfig()) && (oDev.Name() != "Gateway")) {
+                if (bFirst) {
+                    bFirst = false;
+                } else {
+                    Write(',');
+                }
+
+                sAddress = oDev.Address();
+                if (!sAddress) {
+                    sAddress = "";
+                }
+
+                sName = oDev.Name();
+                if (sName) {
+                    sName = sName.UriEncode();
+                } else {
+                    sName = "";
+                }
+
+                sType = oDev.HssType();
+                if (!sType) {
+                    sType = "";
+                }
+
+                sInterface = oDev.Interface();
+                if (!sInterface) {
+                    sInterface = "";
+                }
+
+                Write('{"id":"' # oDev.ID() # '",');
+                Write('"address":"' # sAddress # '",');
+                Write('"name":"' # sName # '",');
+                Write('"type":"' # sType # '",');
+                Write('"interface":"' # sInterface # '"}');
+            }
+        }
+    }
+}
+
+Write(']');

aiohomematic/rega_scripts/get_program_descriptions.fn

@@ -0,0 +1,31 @@
+!# name: get_program_descriptions.fn
+!#
+!# Erstellt in Ergänzung zu https://github.com/eq-3/occu/blob/45b38865f6b60f16f825b75f0bdc8a9738831ee0/WebUI/www/api/methods/sysvar/getall.tcl
+!# Erweitert das Script um "description"
+!#
+
+string id;
+boolean dpFirst = true;
+Write("[");
+foreach(id, dom.GetObject(ID_PROGRAMS).EnumIDs()) {
+  object prg = dom.GetObject(id);
+    string description = "";
+    if (prg) {
+      ! use UriEncode() to ensure special characters " and \
+      ! and others are properly encoded using URI/URL percentage
+      ! encoding
+      description = prg.PrgInfo().UriEncode();
+
+      if (dpFirst) {
+        dpFirst = false;
+      } else {
+        WriteLine(',');
+      }
+
+      Write("{");
+      Write("\"id\": \"" # id # "\",");
+      Write("\"description\": \"" # description # "\"");
+      Write("}");
+    }
+}
+Write("]");

aiohomematic/rega_scripts/get_serial.fn

@@ -0,0 +1,44 @@
+!# name: get_serial.fn
+!#
+!#  Erstellt durch @baxxy13 2022-04-09
+!#
+!# Dieses Script liefert die Seriennummer des Funkmoduls in folgender Priorisierung zurück:
+!#  1. /var/board_sgtin
+!#  2. /var/board_serial
+!#  3. /sys/module/plat_eq3ccu2/parameters/board_serial
+!#
+!#  Dieses Script wird als Ersatz für JsonRPC CCU.getSerial verwendet.
+!#
+
+string serial;
+boolean find = false;
+string cmd_a = "/bin/sh -c 'cat /var/board_sgtin'";
+string cmd_b = "/bin/sh -c 'cat /var/board_serial'";
+string cmd_c = "/bin/sh -c 'cat /sys/module/plat_eq3ccu2/parameters/board_serial'";
+
+!# Try uses /var/board_sgtin
+system.Exec(cmd_a, &serial, &error);
+if (serial) {
+  serial = serial.Trim();
+  find = true;
+}
+!# Try uses /var/board_serial
+if (!find) {
+  system.Exec(cmd_b, &serial, &error);
+  if (serial) {
+    serial = serial.Trim();
+    find = true;
+  }
+}
+!# Try uses /sys/module/plat_eq3ccu2/parameters/board_serial
+if (!find) {
+  system.Exec(cmd_c, &serial, &error);
+  if (serial) {
+    serial = serial.Trim();
+  }
+}
+
+if (!serial) {
+  serial = "unknown";
+}
+WriteLine('{"serial": "'# serial #'"}');

aiohomematic/rega_scripts/get_service_messages.fn

@@ -0,0 +1,83 @@
+!# name: get_service_messages.fn
+!#
+!# Return all active service messages from the CCU.
+!# Service messages include connectivity issues (UNREACH), configuration
+!# pending, low battery warnings, and other device alerts.
+!#
+!# Note: Inbox devices are handled separately by get_inbox_devices.fn.
+!#
+
+string sAlarmId;
+boolean bFirst = true;
+
+Write('[');
+
+object oServices = dom.GetObject(ID_SERVICES);
+if (oServices) {
+    foreach(sAlarmId, oServices.EnumIDs()) {
+        object oAlarm = dom.GetObject(sAlarmId);
+        if (oAlarm && (oAlarm.AlState() == 1)) {
+            if (bFirst) {
+                bFirst = false;
+            } else {
+                Write(',');
+            }
+
+            string sRawName = oAlarm.Name();
+            string sName = "";
+            if (sRawName) {
+                sName = sRawName.UriEncode();
+            } else {
+                sRawName = "";
+            }
+
+            string sTimestamp = "";
+            time tTime = oAlarm.AlOccurrenceTime();
+            if (tTime) {
+                sTimestamp = tTime.ToString();
+            }
+
+            integer iType = oAlarm.AlType();
+            string sAddress = "";
+            string sDeviceName = "";
+
+            !# Extract address from alarm name (format: "AL-ADDRESS:X.PARAM")
+            if (sRawName.Find("AL-") == 0) {
+                string sTmp = sRawName.Substr(3);
+                integer iColon = sTmp.Find(":");
+                if (iColon > 0) {
+                    sAddress = sTmp.Substr(0, iColon);
+                }
+            }
+
+            !# Get device name from trigger data point channel
+            integer iTriggerDP = oAlarm.AlTriggerDP();
+            if (iTriggerDP) {
+                object oTrigger = dom.GetObject(iTriggerDP);
+                if (oTrigger) {
+                    object oChn = oTrigger.Channel();
+                    if (oChn) {
+                        if (sAddress == "") {
+                            sAddress = oChn.Address();
+                        }
+                        sDeviceName = oChn.Name();
+                        if (sDeviceName) {
+                            sDeviceName = sDeviceName.UriEncode();
+                        } else {
+                            sDeviceName = "";
+                        }
+                    }
+                }
+            }
+
+            Write('{"id":"' # oAlarm.ID() # '",');
+            Write('"name":"' # sName # '",');
+            Write('"timestamp":"' # sTimestamp # '",');
+            Write('"type":' # iType # ',');
+            Write('"address":"' # sAddress # '",');
+            Write('"device_name":"' # sDeviceName # '"}');
+        }
+    }
+}
+
+Write(']');

aiohomematic/rega_scripts/get_system_update_info.fn

@@ -0,0 +1,39 @@
+!# name: get_system_update_info.fn
+!#
+!# This script checks if a firmware update is available.
+!# Only supported on OpenCCU (uses checkFirmwareUpdate.sh).
+!#
+
+string sFwCurrent = "";
+string sFwAvailable = "";
+string sResult = "";
+boolean bUpdateAvailable = false;
+boolean bCheckScriptAvailable = false;
+integer iPos;
+integer iExitCode;
+
+!# Get current firmware version from /VERSION file
+system.Exec("grep VERSION= /VERSION | tr -d '[:space:]' | cut -d= -f2", &sFwCurrent);
+sFwCurrent = sFwCurrent.Trim();
+
+!# Check if checkFirmwareUpdate.sh is available and working
+system.Exec("/bin/checkFirmwareUpdate.sh 2>/dev/null; echo \"EXIT_CODE=$?\"", &sResult);
+sResult = sResult.Trim();
+iPos = sResult.Find("EXIT_CODE=");
+iExitCode = (sResult.Substr(iPos + 10, sResult.Length())).ToInteger();
+
+!# Check Exit codes: 0 = no update, 1 = update available, > 4 = error or script not available
+if (iExitCode < 5) {
+  bCheckScriptAvailable = true;
+  if (iExitCode == 1) {
+    bUpdateAvailable = true;
+    sResult = sResult.Replace("\n\n",";");
+    sResult = sResult.StrValueByIndex(";",1);
+    sResult = sResult.Replace(" ",";");
+    sFwAvailable = sResult.StrValueByIndex(";",3);
+  }
+}
+Write('{"current_firmware":"'# sFwCurrent #'",');
+Write('"available_firmware":"'# sFwAvailable #'",');
+Write('"update_available":'# bUpdateAvailable #',');
+Write('"check_script_available":'# bCheckScriptAvailable #'}');

aiohomematic/rega_scripts/get_system_variable_descriptions.fn

@@ -0,0 +1,31 @@
+!# name: get_system_variable_descriptions.fn
+!#
+!# Erstellt in Ergänzung zu https://github.com/eq-3/occu/blob/45b38865f6b60f16f825b75f0bdc8a9738831ee0/WebUI/www/api/methods/sysvar/getall.tcl
+!# Erweitert das Script um "description"
+!#
+
+string id;
+boolean dpFirst = true;
+Write("[");
+foreach(id, dom.GetObject(ID_SYSTEM_VARIABLES).EnumIDs()) {
+    object sv = dom.GetObject(id);
+    string description = "";
+    if (sv) {
+      ! use UriEncode() to ensure special characters " and \
+      ! and others are properly encoded using URI/URL percentage
+      ! encoding
+      description = sv.DPInfo().UriEncode();
+
+      if (dpFirst) {
+        dpFirst = false;
+      } else {
+        WriteLine(',');
+      }
+
+      Write("{");
+      Write("\"id\": \"" # id # "\",");
+      Write("\"description\": \"" # description # "\"");
+      Write("}");
+    }
+}
+Write("]");

aiohomematic/rega_scripts/set_program_state.fn

@@ -0,0 +1,17 @@
+!# name: set_program_state.fn
+!# param: "##id##"
+!# param: "##state##"
+!#
+!#  Dieses Script setzt den Zustand eines Programmes auf der CCU.
+!#
+!# Params for session recorder
+!#
+
+string p_id = "##id##";
+integer p_state = ##state##;
+
+object program = dom.GetObject(ID_PROGRAMS).Get(p_id);
+if (program) {
+    program.Active(p_state);
+    Write(program.Active())
+}

aiohomematic/rega_scripts/set_system_variable.fn

@@ -0,0 +1,19 @@
+!# name: set_system_variable.fn
+!# param: "##name##"
+!# param: "##value##"
+!#
+!#  Erstellt durch @baxxy13 2022-04-11
+!#
+!#  Dieses Script schreibt eine Systemvariable vom Typ Zeichenkette.
+!#
+!# Params for session recorder
+!#
+
+string sv_name = "##name##";
+string sv_value = "##value##";
+object target_sv = dom.GetObject(ID_SYSTEM_VARIABLES).Get(sv_name);
+if (target_sv) {
+    if (target_sv.ValueTypeStr() == "String") {
+       Write(target_sv.State(sv_value));
+    }
+}