ekfsm 1.4.0a37__tar.gz → 1.4.0a40__tar.gz

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ekfsm
-Version: 1.4.0a37
+Version: 1.4.0a40
 Summary: The EKF System Management Library (ekfsm) is a sensor monitoring suite for Compact PCI Serial devices.
 Author-email: Jan Jansen <jan@ekf.de>, Klaus Popp <klaus.popp@ci4rail.com>, Felix Päßler <fp@ekf.de>
 Requires-Python: >=3.10

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/ekfsm/core/utils.py

@@ -88,6 +88,7 @@ _device_structure = Schema(
         Optional("slot_coding_mask"): int,
         Optional("channel_id"): int,
         Optional("service_suffix"): str,
+        Optional("keepaliveInterval"): int,
         Optional("provides"): {
             Optional(str): [Use(provides_validator)],
         },

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/ekfsm/devices/button.py

@@ -4,7 +4,7 @@ from ekfsm.devices.generic import Device
 
 class Button(Device):
     """
-    Device class for handling a button array.
+    Device class for handling a single button as part on array.
     """
 
     def __init__(
@@ -35,6 +35,11 @@ class Button(Device):
     def handler(self, func: Callable | None, *args, **kwargs):
         """
         Handle button events with a callback function.
+
+        Parameters
+        ----------
+        func : Callable | None
+            The function to call on button events. If None, no function is called.
         """
         if callable(func):
             self._handler = func

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/ekfsm/devices/buttonArray.py

@@ -8,7 +8,13 @@ import io4edge_client.functionblock as fb
 
 class ButtonArray(Device):
     """
-    Device class for handling a button array.
+    Device class for handling an io4edge button array.
+
+    To read button events, call the `read` method in a separate thread.
+
+    Note
+    ----
+        Button handlers are called in the context of the `read` method's thread and need to be set in the Button instances.
     """
 
     def __init__(
@@ -18,6 +24,7 @@ class ButtonArray(Device):
         children: list[Device] | None = None,
         abort: bool = False,
         service_suffix: str | None = None,
+        keepaliveInterval: int = 10000,
         *args,
         **kwargs,
     ):
@@ -33,12 +40,14 @@ class ButtonArray(Device):
 
         self.service_addr = f"{parent.deviceId}-{self.service_suffix}"
 
-        self.client = binio.Client(self.service_addr)
+        self.client = binio.Client(
+            self.service_addr, command_timeout=keepaliveInterval / 1000 + 5
+        )
 
         self.subscriptionType = binio.Pb.SubscriptionType.BINARYIOTYPEB_ON_RISING_EDGE
         self.stream_cfg = fb.Pb.StreamControlStart(
             bucketSamples=1,  # 1 sample per bucket, also ein event pro bucket
-            keepaliveInterval=10000,  # rueckmeldung auch ohne events alle 10 Sekunden
+            keepaliveInterval=keepaliveInterval,
             bufferedSamples=2,  # 2 samples werden gepuffert
             low_latency_mode=True,  # schickt soweit moeglich sofort die Events
         )
@@ -46,6 +55,17 @@ class ButtonArray(Device):
     def read(self, stop_event: threading.Event | None = None, timeout: float = 0.1):
         """
         Read all button events and dispatch to handlers.
+
+        Parameters
+        ----------
+        stop_event : threading.Event, optional
+            Event to signal stopping the reading loop. If None, the loop will run indefinitely.
+        timeout : float, optional
+            Timeout for reading from the stream in seconds. Default is 0.1 seconds.
+
+        Note
+        ----
+            This method blocks and should be run in a separate thread.
         """
         self.client.start_stream(
             binio.Pb.StreamControlStart(

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/ekfsm/devices/colorLed.py

@@ -32,18 +32,37 @@ class ColorLED(Device):
     def get(self) -> tuple[Color, bool]:
         """
         Get color LED state.
-        @raises RuntimeError: if the command fails
-        @raises TimeoutError: if the command times out
+
+        Returns
+        -------
+            Current color and blink state.
+
+        Raises
+        ------
+        RuntimeError
+            if the command fails
+        TimeoutError
+            if the command times out
         """
         return self.client.get(self.channel_id)
 
     def set(self, color: Color, blink: bool) -> None:
         """
         Set the color of the color LED.
-        @param Color: The color to set the LED to.
-        @param blink: Whether to blink the LED.
-        @raises RuntimeError: if the command fails
-        @raises TimeoutError: if the command times out
+
+        Parameters
+        ----------
+        color : Color
+            The color to set the LED to.
+        blink : bool
+            Whether to blink the LED.
+
+        Raises
+        ------
+        RuntimeError
+            if the command fails
+        TimeoutError
+            if the command times out
         """
         self.client.set(self.channel_id, color, blink)
 

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/ekfsm/devices/thermal_humidity.py

@@ -32,13 +32,18 @@ class ThermalHumidity(Device):
 
         self.client = Client(self.service_addr)
 
-    def __repr__(self):
-        return f"{self.name}; Service Address: {self.service_addr}"
-
     def temperature(self) -> float:
         """
         Get the temperature in Celsius.
-        @raises RuntimeError: if the command fails
-        @raises TimeoutError: if the command times out
+
+        Raises
+        ------
+        RuntimeError
+            if the command fails
+        TimeoutError
+            if the command times out
         """
         return self.client.value()
+
+    def __repr__(self):
+        return f"{self.name}; Service Address: {self.service_addr}"

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/ekfsm/devices/watchdog.py

@@ -5,7 +5,7 @@ from io4edge_client.watchdog import Client
 
 class Watchdog(Device):
     """
-    Device class for handling a color LED.
+    Device class for handling an application watchdog.
     """
 
     def __init__(
@@ -38,7 +38,15 @@ class Watchdog(Device):
     def kick(self) -> None:
         """
         Kick the watchdog.
-        @raises RuntimeError: if the command fails
-        @raises TimeoutError: if the command times out
+
+        Raises
+        ------
+        RuntimeError
+            if the command fails
+        TimeoutError
+            if the command times out
         """
         self.client.kick()
+
+    def __repr__(self):
+        return f"{self.name}; Service Address: {self.service_addr}"

{ekfsm-1.4.0a37 → ekfsm-1.4.0a40}/pyproject.toml

@@ -27,7 +27,7 @@ authors = [
 ]
 description = "The EKF System Management Library (ekfsm) is a sensor monitoring suite for Compact PCI Serial devices."
 requires-python = ">=3.10"
-version = "1.4.0-alpha.37"
+version = "1.4.0-alpha.40"
 
 [project.scripts]
 ekfsm-cli = "ekfsm.cli:main"