ekfsm 1.4.0a37__tar.gz → 1.4.0a42__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ekfsm
-Version: 1.4.0a37
+Version: 1.4.0a42
 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.0a42}/docs/requirements.txt

@@ -165,6 +165,10 @@ idna==3.10 \
     --hash=sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9 \
     --hash=sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3
     # via requests
+ifaddr==0.2.0 \
+    --hash=sha256:085e0305cfe6f16ab12d72e2024030f5d52674afad6911bb1eee207177b8a748 \
+    --hash=sha256:cc0cbfcaabf765d44595825fb96a99bb12c79716b73b44330ea38ee2b0c4aed4
+    # via zeroconf
 imagesize==1.4.1 \
     --hash=sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b \
     --hash=sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a
@@ -173,6 +177,10 @@ iniconfig==2.0.0 \
     --hash=sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3 \
     --hash=sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374
     # via pytest
+io4edge-client==1.6.2 \
+    --hash=sha256:52c9b65defc19e74ca6b5d42c8c0c7f07ec879416d90323a7a5e682ff38f536f \
+    --hash=sha256:a83f3eb635861b697b0a6052bf89ba36998283ab6e7fc19bca8ec4c04272f0b5
+    # via ekfsm
 ipdb==0.13.13 \
     --hash=sha256:45529994741c4ab6d2388bfa5d7b725c2cf7fe9deffabdb8a6113aa5ed449ed4 \
     --hash=sha256:e3ac6018ef05126d442af680aad863006ec19d02290561ac88b8b1c0b0cfc726
@@ -409,7 +417,9 @@ protobuf==6.31.1 \
     --hash=sha256:7fa17d5a29c2e04b7d90e5e32388b8bfd0e7107cd8e616feef7ed3fa6bdab5c9 \
     --hash=sha256:a40fc12b84c154884d7d4c4ebd675d5b3b5283e155f324049ae396b95ddebc39 \
     --hash=sha256:d8cac4c982f0b957a4dc73a80e2ea24fab08e679c0de9deb835f4a12d69aca9a
-    # via ekfsm
+    # via
+    #   ekfsm
+    #   io4edge-client
 ptyprocess==0.7.0 ; sys_platform != 'emscripten' and sys_platform != 'win32' \
     --hash=sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35 \
     --hash=sha256:5c5d0a3b48ceee0b48485e0c26037c0acd7d29765ca3fbb5cb3831d347423220
@@ -607,3 +617,67 @@ yamale==6.0.0 \
     --hash=sha256:60be681f35e4939320b89de0d6f187ee0e5479ae7f7286b7f17f0859ddee4a66 \
     --hash=sha256:828c6cf2023101ec97d2759dfdc507e04ecfc0c6d39d500c00c37ec895ada53b
     # via ekfsm
+zeroconf==0.147.2 \
+    --hash=sha256:01d64386cf21b72659d070792faaa621e9c3dcc3f54361b38ac29afcb5f32ad4 \
+    --hash=sha256:0204a7b163d497c08b38e3e6d15304da7553819f9de4ad87d86ed01b445db140 \
+    --hash=sha256:0730fa038822085cb5eb0b4ebb57a106ae8b051aef0745cae79067e5e713d4f5 \
+    --hash=sha256:0958a0dbe5e84270ab36412cb290e72c87d63b931d260bc2f4a4a35c11729cab \
+    --hash=sha256:1398dd9e6f9678c3b47ec16c28531a7dad2ac9c31bbc267ab523f641537ce17c \
+    --hash=sha256:219a6c490251be96def371c4c670812fcb386ed5e36917e0523a4fa5d53fe21a \
+    --hash=sha256:23ea2fde9091ebc765e936c3f70f31f3053cadd2e7c96bbdabb8c7f58d922170 \
+    --hash=sha256:2a6941a1363116fe4416585f50e0b18ab1aa3bcb90854b77577c07a934f57e70 \
+    --hash=sha256:2d7619dc33b04e2ce1349b9e4194e3b98264bbbb57d138bcad977aced06eb3db \
+    --hash=sha256:2f91e2544433acfa928c8dbaea7af8bf0644e06904610799d6b762fd599d81bd \
+    --hash=sha256:3937ba05211bcbd3f45dca553a0c66a19f31f3626c9219a422b37a29b19c62b5 \
+    --hash=sha256:3a6f64fef18482b2d44fac3e7c95d5fd08a0af47584e71380c652abef68d19db \
+    --hash=sha256:3b6348049ed7ac4f67341cb23ae4d2bfcfc5f02d585aa251e1cd5b9151af0699 \
+    --hash=sha256:45f4279c908b2ccdac5804392e47c728e3c128b4ec49d0945263fbc5829bf891 \
+    --hash=sha256:47acc2d5117240afcb231dc669007ac1c25122094300aa1226143f16cff96406 \
+    --hash=sha256:4e47bf618bf8dd3b45f0ae5c2f4f67e9769210e8c786760f3eef3eff21a6394a \
+    --hash=sha256:55742f3fa55fb911c7e794888f34304832256106b9b6d969af3230ac60b74e30 \
+    --hash=sha256:572d4734dd9ea28369f0ea6af2b4ee02e97c52bc26a349c11f01aa191b577b1f \
+    --hash=sha256:58228730194c5b43f6d3a020071a980143adfb9f083bf6e1a526375b612281a4 \
+    --hash=sha256:58ef18096a566878238bb2190537fdd87949ce324d40540f60f2553fbcea8120 \
+    --hash=sha256:593316ef66ffe4920a8958409757d218d533f856c25028ae6bcea50129fe1da4 \
+    --hash=sha256:5b0ab523d7be5bebf58aeada1ca7f5ae41c1ebbe69da8435bbf2c2581b4fb3ac \
+    --hash=sha256:5bcf519c047a37c48684fdc8e2b5560be696ec1fbbc0099809fd9b36a6d4d2d4 \
+    --hash=sha256:5c3e5dd5db5d3ad02af43c76c0c11005d2dca811083ecfb29554ea744eb87d20 \
+    --hash=sha256:5e0bc1274d8157a21d43705b256b3320b25756dbc25ca017f7ae1fe66877c93f \
+    --hash=sha256:5fc666a8f76241b04beae6e3230dc45a76fa2edb33b525d456eabd92b1a08b08 \
+    --hash=sha256:62d8898c8fc47f1f951991f7745e50c553618d7e47aa019597c3333eddf24139 \
+    --hash=sha256:635ddcf238db00d92dd2aace77a1d852ce12152de06bdbde61767472cf45f93a \
+    --hash=sha256:64780ec808e0914c9de43ba9582ec1318ed18e91da650e1562560775bfe1714e \
+    --hash=sha256:65333ad735cbc7f6f8e0552e2dc85f254fa929da6e179c86ebe413986e4aa42f \
+    --hash=sha256:66ca484d14bb88885d227f1b2ad32e9ebf9b7e6238bb61e0a6ba241b3b0950c9 \
+    --hash=sha256:6a4d412e553b4adc650431dd0912f423b1e59780cf97429170c0cb431cfde347 \
+    --hash=sha256:6fe3f5acb1b5782dd8d4eec3f4f53e70c6f4cc09ca082d61bb9350e14f5cd38b \
+    --hash=sha256:777d71ae5154707175d9d392c7f37a2b810e862228409a0ea38459d4e4efd67a \
+    --hash=sha256:7960f749bcb534dab9456e2fa849405be7d96328b1135bb85c02ca87a385a455 \
+    --hash=sha256:7a94e0a3814b07bf7e848300166f890eb37d30d5e07030bbd144936674370e41 \
+    --hash=sha256:7b7a95526c7185c1f828042d4321c4abe1f7c1781c6e2ed7d69551630ffd950f \
+    --hash=sha256:7e7ec97f017fbb5ad5491fae250aa42216d9087b0ce7286afe2258f40afbf1b0 \
+    --hash=sha256:7f6ae2978034bebb48f629fc070e960bb1edee548d171ca5ff30c8a634fde908 \
+    --hash=sha256:889c5d4fcc163c1c8846a0a8fee164c62919db841f6b34dba1dbe55088402237 \
+    --hash=sha256:915bf241f3bb968dd37447551a114f42384b15e1a1778479fd7d0bf2c9898141 \
+    --hash=sha256:94a60cffde70d1cb50ff84290ddbfb56cb01093c008ab135c0ad94bcfd877610 \
+    --hash=sha256:9cf0c804c762f79c8056da421765cfb679ebef52fb35d9d7c01625136a9d0b44 \
+    --hash=sha256:a2aa19664d71ace60e4a9ca03649bb9e553a08360e7a3a93ed79f7b263e3e7ec \
+    --hash=sha256:a7ae899017781fbe0b30adef14ae97e27bdec6fe69603117dc45925a84ec5c23 \
+    --hash=sha256:b51c3d57223ae968f1fa432144eb10eb474fe01efce7a480309e947d72de6d41 \
+    --hash=sha256:b95d0dd3ec85c6f1db4b5417eb39b9d25a14bb67bb8b95a053d2fb63d842872b \
+    --hash=sha256:bb1a057d961f66423fe2f423cfc8a1d3ab854b520ac28e1226c200b916d07a4f \
+    --hash=sha256:c30a551d9a1df428ecce7816659314470f2bf36957a15905ff40560595bf61e9 \
+    --hash=sha256:c6259df8104aa1a29a9be9dafd6c4c3a5fd388c1a4cea7f921f70b1cc5ac17b6 \
+    --hash=sha256:d2bf175fa6226596cdd9a6ec93b2319b1c8e2e735f23a295ac59d192fbb70c68 \
+    --hash=sha256:d8cca1d4861d3b7c34d209e03e419a87ec96f5048870973b81f89483cf689c0b \
+    --hash=sha256:de22c0306b35ef0ee23f4deaa9204f0ffc3600125c63cc277fc5a52b7021aaf6 \
+    --hash=sha256:de45086232034d079e8b732ab65caf4df338fbc93f9547d9001558d832018296 \
+    --hash=sha256:e5a4ab8aab1a2dbb48132c02f009e0ec1648256b1c024b15ab924c5a62b6bd58 \
+    --hash=sha256:e5ecdeb37f1a298c1ae6b4a6c2bd882bf29286cabe7d03de3e9b5a4487accefc \
+    --hash=sha256:ebe04dbb35b9a7e461823f027eef0970576ace94e3e06222b85b10401d3276ed \
+    --hash=sha256:ed488fe2ae27438266f658630e2491a1b08462532ff69090f37095cf8002c002 \
+    --hash=sha256:fa36dd4a1f01acdf1ceee98ebb83df696ce03314908fb7a14292ebe61b25151f \
+    --hash=sha256:fb1056e9b08104dac93fa6f345c8722a106cc3582a49d7186deae627ae294116 \
+    --hash=sha256:fbdd3db8e53e8ff7f5f850613a46a22a828e490fbcd769e1acd2a8697aa66c77 \
+    --hash=sha256:ffc2c93167c43bf7e8387c1c860813b26ebf4dfe5c71a68c2ef4911b01a46ae6
+    # via io4edge-client

{ekfsm-1.4.0a37 → ekfsm-1.4.0a42}/docs/source/reference/ekfsm.rst

@@ -39,6 +39,9 @@ I2C Devices using SysFs
 EEPROM
 ~~~~~~
 .. automodule:: ekfsm.devices.eeprom
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 GPIO
 ~~~~

{ekfsm-1.4.0a37 → ekfsm-1.4.0a42}/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.0a42}/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.0a42}/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.0a42}/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.0a42}/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.0a42}/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.0a42}/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.42"
 
 [project.scripts]
 ekfsm-cli = "ekfsm.cli:main"