aiohomematic 2025.11.3__py3-none-any.whl

aiohomematic/rega_scripts/fetch_all_device_data.fn

@@ -0,0 +1,92 @@
+!# fetch_all_device_data.fn v2.2
+!# 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";
+
+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_program_descriptions.fn

@@ -0,0 +1,30 @@
+!# 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 @@
+!# get_serial
+!#
+!#  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_system_variable_descriptions.fn

@@ -0,0 +1,30 @@
+!# 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,12 @@
+!# set_program_state.fn
+!#
+!#  Dieses Script setzt den Zustand eines Programmes auf der CCU.
+!#
+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,15 @@
+!# set_system_variable
+!#
+!#  Erstellt durch @baxxy13 2022-04-11
+!#
+!#  Dieses Script schreibt eine Systemvariable vom Typ Zeichenkette.
+!#
+
+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));
+    }
+}

aiohomematic/store/__init__.py

@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: MIT
+# Copyright (c) 2021-2025
+"""
+Store packages for AioHomematic.
+
+This package groups store implementations used throughout the library:
+- persistent: Long-lived on-disk store for device and paramset descriptions.
+- dynamic: Short-lived in-memory store for runtime values and connection health.
+- visibility: Parameter visibility rules to decide which parameters are relevant.
+"""
+
+from __future__ import annotations
+
+from aiohomematic.store.dynamic import CentralDataCache, CommandCache, DeviceDetailsCache, PingPongCache
+from aiohomematic.store.persistent import (
+    DeviceDescriptionCache,
+    ParamsetDescriptionCache,
+    SessionRecorder,
+    cleanup_files,
+)
+from aiohomematic.store.visibility import ParameterVisibilityCache, check_ignore_parameters_is_clean
+
+__all__ = [
+    "CentralDataCache",
+    "CommandCache",
+    "DeviceDescriptionCache",
+    "DeviceDetailsCache",
+    "ParameterVisibilityCache",
+    "ParamsetDescriptionCache",
+    "PingPongCache",
+    "SessionRecorder",
+    "cleanup_files",
+    "check_ignore_parameters_is_clean",
+]