aiohomematic 2025.8.6__py3-none-any.whl

aiohomematic/model/update.py

@@ -0,0 +1,136 @@
+"""Module for data points implemented using the update category."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from datetime import datetime
+from functools import partial
+from typing import Final
+
+from aiohomematic.const import (
+    CALLBACK_TYPE,
+    DEFAULT_CUSTOM_ID,
+    HMIP_FIRMWARE_UPDATE_IN_PROGRESS_STATES,
+    HMIP_FIRMWARE_UPDATE_READY_STATES,
+    DataPointCategory,
+    Interface,
+)
+from aiohomematic.decorators import inspector
+from aiohomematic.exceptions import AioHomematicException
+from aiohomematic.model import device as hmd
+from aiohomematic.model.data_point import CallbackDataPoint
+from aiohomematic.model.decorators import config_property, state_property
+from aiohomematic.model.support import DataPointPathData, PayloadMixin, generate_unique_id
+
+__all__ = ["DpUpdate"]
+
+
+class DpUpdate(CallbackDataPoint, PayloadMixin):
+    """
+    Implementation of a update.
+
+    This is a default data point that gets automatically generated.
+    """
+
+    __slots__ = ("_device",)
+
+    _category = DataPointCategory.UPDATE
+
+    def __init__(self, device: hmd.Device) -> None:
+        """Init the callback data_point."""
+        PayloadMixin.__init__(self)
+        self._device: Final = device
+        super().__init__(
+            central=device.central,
+            unique_id=generate_unique_id(central=device.central, address=device.address, parameter="Update"),
+        )
+        self._set_modified_at(modified_at=datetime.now())
+
+    @state_property
+    def available(self) -> bool:
+        """Return the availability of the device."""
+        return self._device.available
+
+    @property
+    def device(self) -> hmd.Device:
+        """Return the device of the data_point."""
+        return self._device
+
+    @property
+    def full_name(self) -> str:
+        """Return the full name of the data_point."""
+        return f"{self._device.name} Update"
+
+    @config_property
+    def name(self) -> str:
+        """Return the name of the data_point."""
+        return "Update"
+
+    @state_property
+    def firmware(self) -> str | None:
+        """Version installed and in use."""
+        return self._device.firmware
+
+    @state_property
+    def firmware_update_state(self) -> str | None:
+        """Latest version available for install."""
+        return self._device.firmware_update_state
+
+    @state_property
+    def in_progress(self) -> bool:
+        """Update installation progress."""
+        if self._device.interface == Interface.HMIP_RF:
+            return self._device.firmware_update_state in HMIP_FIRMWARE_UPDATE_IN_PROGRESS_STATES
+        return False
+
+    @state_property
+    def latest_firmware(self) -> str | None:
+        """Latest firmware available for install."""
+        if self._device.available_firmware and (
+            (
+                self._device.interface == Interface.HMIP_RF
+                and self._device.firmware_update_state in HMIP_FIRMWARE_UPDATE_READY_STATES
+            )
+            or self._device.interface in (Interface.BIDCOS_RF, Interface.BIDCOS_WIRED)
+        ):
+            return self._device.available_firmware
+        return self._device.firmware
+
+    def _get_path_data(self) -> DataPointPathData:
+        """Return the path data of the data_point."""
+        return DataPointPathData(
+            interface=None,
+            address=self._device.address,
+            channel_no=None,
+            kind=DataPointCategory.UPDATE,
+        )
+
+    def register_data_point_updated_callback(self, cb: Callable, custom_id: str) -> CALLBACK_TYPE:
+        """Register update callback."""
+        if custom_id != DEFAULT_CUSTOM_ID:
+            if self._custom_id is not None:
+                raise AioHomematicException(
+                    f"REGISTER_UPDATE_CALLBACK failed: hm_data_point: {self.full_name} is already registered by {self._custom_id}"
+                )
+            self._custom_id = custom_id
+
+        if self._device.register_firmware_update_callback(cb) is not None:
+            return partial(self._unregister_data_point_updated_callback, cb=cb, custom_id=custom_id)
+        return None
+
+    def _unregister_data_point_updated_callback(self, cb: Callable, custom_id: str) -> None:
+        """Unregister update callback."""
+        if custom_id is not None:
+            self._custom_id = None
+        self._device.unregister_firmware_update_callback(cb)
+
+    @inspector()
+    async def update_firmware(self, refresh_after_update_intervals: tuple[int, ...]) -> bool:
+        """Turn the update on."""
+        return await self._device.update_firmware(refresh_after_update_intervals=refresh_after_update_intervals)
+
+    @inspector()
+    async def refresh_firmware_data(self) -> None:
+        """Refresh device firmware data."""
+        await self._device.central.refresh_firmware_data(device_address=self._device.address)
+        self._set_modified_at(modified_at=datetime.now())

aiohomematic/rega_scripts/fetch_all_device_data.fn

@@ -0,0 +1,75 @@
+!# 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;
+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);
+                foreach(sDPId, oChannel.DPs().EnumUsedIDs()) {
+                    object oDP = dom.GetObject(sDPId);
+                    if (oDP && oDP.Timestamp()) {
+                        if (oDP.TypeName() != "VARDP") {
+                            if (bDPFirst) {
+                              bDPFirst = false;
+                            } else {
+                              WriteLine(',');
+                            }
+                            integer sValueType = oDP.ValueType();
+                            Write('"');
+                            WriteURL(oDP.Name());
+                            Write('":');
+                            if (sValueType == 20) {
+                                Write('"');
+                                WriteURL(oDP.Value());
+                                Write('"');
+                            } else {
+                                vDPValue = oDP.Value();
+                                if (sValueType == 2) {
+                                    if (vDPValue) {
+                                        Write("true");
+                                    } else {
+                                        Write("false");
+                                    }
+                                } else {
+                                   if (vDPValue == "") {
+                                        Write("0");
+                                   } else {
+                                        Write(vDPValue);
+                                   }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+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));
+    }
+}