ekfsm 1.1.0a15.post1__py3-none-any.whl → 1.2.0a7__py3-none-any.whl

ekfsm/devices/eeprom.py

@@ -1067,6 +1067,23 @@ class EKF_CCU_EEPROM(EKF_EEPROM):
     def write_customer_area(self, data: bytes) -> None:
         """
         Write data to CCU EEPROM customer area.
+
+        Parameters
+        ----------
+        data
+            The data to write to the customer area of the CCU EEPROM.
+
+        Raises
+        ------
+        ValueError
+            If the data exceeds the customer area length.
+
+        Example
+        -------
+        >>> eeprom = EKF_CCU_EEPROM()
+        >>> eeprom.write_customer_area(b"Hello, World!")
+        >>> eeprom.customer_area()
+        b'Hello, World!'
         """
         if len(data) > self._customer_area_length:
             raise ValueError("Data exceeds customer area length")

ekfsm/devices/ekf_ccu_uc.py

@@ -54,7 +54,10 @@ class EKFCcuUc(Device):
     def temperature(self) -> float:
         """
         Get the temperature from the CCU thermal/humidity sensor.
-        The temperature is read once per second.
+
+        Note
+        ----
+        The CCU reads the temperature once per second.
 
         Returns
         -------
@@ -304,6 +307,13 @@ class EKFCcuUc(Device):
         progress_callback
             A callback function that is called with the current progress in bytes.
 
+        Example
+        -------
+        >>> from ekfsm.devices import EkfCcuUc
+        >>> ccu = EkfCcuUc("ccu")
+        >>> firmware = open("fw-ccu-1.0.0.bin", "rb").read()
+        >>> # Load firmware with progress callback
+        >>> ccu.load_firmware(firmware, progress_callback=lambda x: print(f"Progress: {x} bytes"))
         """
         with Locker(self.name + "-load_firmware").lock():
             offset = 0
@@ -423,6 +433,8 @@ class EKFCcuUc(Device):
         This would load a parameterset with just one parameter, the default fan speed. All other parameters will
         be set to their default values.
 
+        Important
+        ---------
         In order to apply the parameterset, the CCU must be restarted.
 
         Parameters
@@ -430,6 +442,14 @@ class EKFCcuUc(Device):
         _cfg
             The parameterset in JSON format.
 
+        Example
+        -------
+        >>> from ekfsm.devices import EkfCcuUc
+        >>> ccu = EkfCcuUc("ccu")
+        >>> # Load parameterset
+        >>> ccu.load_parameterset('{"version": "1.0.0", "parameters": {"fan-defrpm": "6000"}}')
+        >>> # Restart CCU to apply parameterset
+        >>> ccu.restart()
         """
         with Locker(self.name + "-parameterset").lock():
             cfg = _cfg.encode("utf-8")

ekfsm/devices/pmbus.py

@@ -93,9 +93,8 @@ class PsuStatus(IntFlag):
     >>> PsuStatus.OK in status
     True
     >>> # Instead, check if status is OK
-    >>> status = PsuStatus(0x00)
-    >>> status
-    <PsuStatus.OK: 0>
+    >>> status == PsuStatus(0x00)
+    False
     >>> PsuStatus.OUTPUT_OVERCURRENT in status
     False
     """

ekfsm/lock.py

@@ -1,23 +1,24 @@
+"""
+Some devices or device functions don't allow concurrent access.
+The locking mechanism is used to ensure that only one process/thread can
+access the device (function) at a time.
+
+Locking granularity is defined by the device.
+It may be at the device level or function level.
+
+Application can choose to use the locking mechanism or not.
+By default, the locking mechanism is enabled and uses the default
+lockfile root directory ``/var/lock/ekfsm``.
+
+Use :func:`locking_configure` to enable or disable the locking mechanism or to change
+the lockfile root directory.
+"""
+
 import fcntl
 import os
 from pathlib import Path
 from contextlib import contextmanager
 
-#
-# Some devices or device functions don't allow concurrent access.
-# The locking mechanism is used to ensure that only one process/thread can
-# access the device (function) at a time.
-#
-# Locking granularity is defined by the device.
-# It may be at the device level or function level.
-#
-# Application can choose to use the locking mechanism or not.
-# By default, the locking mechanism is enabled and uses the default
-# lockfile root directory /var/lock/ekfsm.
-#
-# Use locking_configure() to enable or disable the locking mechanism or to change
-# the lockfile root directory.
-
 USE_LOCK = True
 LOCKFILE_ROOT = "/var/lock/ekfsm"
 ALL_LOCKERS: list["Locker"] = []  # List of all locker instances
@@ -27,8 +28,12 @@ def locking_configure(enable: bool, lockfile_root: str = LOCKFILE_ROOT):
     """
     Configures the locking mechanism.
 
-    :param enable: Whether to enable or disable locking.
-    :param lockfile_root: The root directory for lockfiles. (default: /var/lock/ekfsm)
+    Parameters
+    ----------
+    enable
+        Whether to enable or disable locking.
+    lockfile_root
+        The root directory for lockfiles.
     """
     global USE_LOCK, LOCKFILE_ROOT
     USE_LOCK = enable
@@ -55,9 +60,12 @@ class Locker:
 
     Example
     -------
-    with Locker("mysharedresourcename").lock():
-        # Access the shared resource here
-        pass
+    .. code-block:: python
+
+        with Locker("mysharedresourcename").lock():
+            # Access the shared resource here
+            pass
+
     """
 
     def __init__(self, module: str):
@@ -72,6 +80,17 @@ class Locker:
         ALL_LOCKERS.append(self)
 
     def cleanup(self):
+        """
+        Cleans up the lock file and closes the lock file descriptor.
+
+        Important
+        ---------
+        This method should be called when the lock is no longer needed.
+
+        Note
+        ----
+        It is automatically called when the context manager exits.
+        """
         if not USE_LOCK:
             return
         if self.lock_fd is not None:
@@ -84,6 +103,14 @@ class Locker:
 
     @contextmanager
     def lock(self):
+        """
+        Locks the resource for exclusive access.
+
+        Note
+        ----
+        This method is a context manager that locks the resource when entered
+        and releases the lock when exited.
+        """
         if not USE_LOCK:
             yield
         self.lock_fd = os.open(self.lockfile_path, os.O_RDWR)

ekfsm/system.py

@@ -1,10 +1,12 @@
-from typing import Tuple, Any, Generator
+from typing import Tuple, Any
 from pathlib import Path
 from munch import Munch, munchify
 
 from ekfsm.core.components import SysTree
 import yaml
 
+from ekfsm.utils import all_board_cfg_files, find_board_config
+
 from .core.slots import Slot, SlotType
 
 from .config import load_config
@@ -14,39 +16,6 @@ from .exceptions import ConfigError
 from .log import ekfsm_logger
 
 
-_CFG_DIR = Path(__file__).parent / "boards"
-
-
-def find_board_config(module_type: str) -> Path | None:
-    """
-    Find a matching board config in `boards/oem/` given the module type specified in
-    the system configuration file.
-
-    Parameters
-    ----------
-    module_type
-        Board type specified in the system configuration for a slot.
-        It must consist of an OEM and the board type, separated by whitespace. Neither
-        part may contain any other whitespace.
-    """
-    oem, board = module_type.split(maxsplit=1)
-    if (
-        path := _CFG_DIR / "oem" / oem.strip().lower() / f"{board.strip().lower()}.yaml"
-    ).exists():
-        return path
-    return None
-
-
-def all_board_cfg_files() -> Generator[Path, None, None]:
-    """
-    Generator that recursively yields all *.yaml files in a directory
-    """
-    path = Path(_CFG_DIR)
-    for item in path.rglob("*.yaml"):
-        if item.is_file():
-            yield item
-
-
 class System(SysTree):
     """
     A System represents a CPCI system.

ekfsm/utils.py

@@ -0,0 +1,41 @@
+from typing import Generator
+
+
+from pathlib import Path
+
+_CFG_DIR = Path(__file__).parent / "boards"
+
+
+def find_board_config(module_type: str) -> Path | None:
+    """
+    Find a matching board config in `boards/oem/` given the module type specified in
+    the system configuration file.
+
+    Parameters
+    ----------
+    module_type
+        Board type specified in the system configuration for a slot.
+        It must consist of an OEM and the board type, separated by whitespace. Neither
+        part may contain any other whitespace.
+    """
+    oem, board = module_type.split(maxsplit=1)
+    if (
+        path := _CFG_DIR / "oem" / oem.strip().lower() / f"{board.strip().lower()}.yaml"
+    ).exists():
+        return path
+    return None
+
+
+def all_board_cfg_files() -> Generator[Path, None, None]:
+    """
+    Generator that recursively yields all *.yaml files in the config directory.
+
+    Yields
+    ------
+    item: Path
+        Path to a config file.
+    """
+    path = Path(_CFG_DIR)
+    for item in path.rglob("*.yaml"):
+        if item.is_file():
+            yield item

{ekfsm-1.1.0a15.post1.dist-info → ekfsm-1.2.0a7.dist-info}/METADATA

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

{ekfsm-1.1.0a15.post1.dist-info → ekfsm-1.2.0a7.dist-info}/RECORD

@@ -2,11 +2,12 @@ ekfsm/__init__.py,sha256=R12o_igFRTqlHUD9jyrOIPq2nBpTUWuvIPgCytBlVzk,142
 ekfsm/cli.py,sha256=JmTO1TyxrTlGTkQo8ndSR7nj0grSGuQdh9ugXx1IeQE,3919
 ekfsm/config.py,sha256=FTk47f3qA05Zv6Cy_L_5XlGmmbC9z_kPdQJKpVoHkWs,924
 ekfsm/exceptions.py,sha256=25P677GxfBTdBWHRngPce0bmhcLg7MFeTtuAvguxd90,1310
-ekfsm/lock.py,sha256=qmWkW6OA-NLiDrtSsQn-K10tZJ19t-h4iFB5zyL97Vw,2682
+ekfsm/lock.py,sha256=XWLu2yhgIs16oSyc_4jdVUobbxyYlYOjZi1EFgHsXVU,3236
 ekfsm/log.py,sha256=_GC8Y7a4fFV4_DNicbwQ-5rRzNQU6WSotXd2etXSrZk,866
 ekfsm/py.typed,sha256=1gNRtmxvYcVqDDEyAzBLnD8dAOweUfYxW2ZPdJzN1fg,102
 ekfsm/simctrl.py,sha256=NkmjvqOym9Wruh0f14Od6gHfEgPMAkxUzMQ-nvzcM3Q,6681
-ekfsm/system.py,sha256=azVFdVK7r-9RWotsD7c18YvyZfCqg-3z5t7SqUSDLh8,12922
+ekfsm/system.py,sha256=kBukgVyPJYTh_ilauEEANG2KKqHWOrQBYLhVdG679HM,12028
+ekfsm/utils.py,sha256=IKQrGr8UzUJpqj365uQqIWDRTAgpVC0OUmqIKzt_9T0,1081
 ekfsm/boards/oem/ekf/ccu.yaml,sha256=qgr7YZO0kEddD9K6tv6222NyozkRNuF7NFw6hyX0XgE,2094
 ekfsm/boards/oem/ekf/sc5-festival.yaml,sha256=_0kS5GegfyOt5CTJc9kY6HJbr9yZo4i18sVo6F4KE9c,772
 ekfsm/boards/oem/ekf/sc9-toccata.yaml,sha256=btLgQMSsW0tRipnUYUkVQSIsjzxfKq0NXaQ1fMMyBRI,771
@@ -26,8 +27,8 @@ ekfsm/core/sysfs.py,sha256=CVGxUEdhmJjRw8ZfnjL3hUwm6oWsp3ZKPG2qGUFYIiY,2283
 ekfsm/core/utils.py,sha256=EoPOuRmLlvHvGneDcKjP7Qbjfsc4XlMbLeaSFRObt_E,3145
 ekfsm/devices/__init__.py,sha256=UtFLCtAdpDJ3OaY7fedk13bx90NMsfxhyVAHV13t2U4,936
 ekfsm/devices/coretemp.py,sha256=oco909zpXw9BqkLWV3dJma1_Q23M2EUGsgdcs4QtFjU,1966
-ekfsm/devices/eeprom.py,sha256=wj2sy52s8YtsLyfb-_J3cbmI3m-EYdRgSqNZ9_GHVb8,31971
-ekfsm/devices/ekf_ccu_uc.py,sha256=mKOWt3T7uLUZdIzCnZwJPLEKYjN22TgOGZEo6yclnoA,15384
+ekfsm/devices/eeprom.py,sha256=4UjydeDxZT7w2zXkhZu7GUuHYu8sAidT8xuVtkt4OJw,32389
+ekfsm/devices/ekf_ccu_uc.py,sha256=bVdxaiXtrJC2-tSRv1rGUzm4wOxL20QfTL4NIKdRJE8,16092
 ekfsm/devices/ekf_sur_led.py,sha256=dY2EIqUx4-LV7ipCEIg8DfXWlGxpspRmEtEhVfHY6LI,1871
 ekfsm/devices/generic.py,sha256=9FDj8hhiCQAFmA5tt3lv1JPIZyAb3XCCriDIoR61kcE,10821
 ekfsm/devices/gpio.py,sha256=hlJ3yJ8jSGUIkPpjymani0EcxYJX2iEybGbnV8N0O5E,9552
@@ -35,11 +36,11 @@ ekfsm/devices/iio.py,sha256=gMOJGdg2PvFbAvlBpLfDTIc_-9i1Z3OLpuabTke6N3I,1480
 ekfsm/devices/iio_thermal_humidity.py,sha256=gALZ1B4f1ePGAEL7Q5VxbubgC3CgtC9RBM9F4YWuH4E,1478
 ekfsm/devices/imu.py,sha256=GwJrnC-WztpE5oGnkIp-laFkSp3_gbSp9YpJ8jBsUOs,423
 ekfsm/devices/mux.py,sha256=C2h5w8eXrL4RXXebCSnNY-VShTgeqmYDMvGSunapBqk,1830
-ekfsm/devices/pmbus.py,sha256=QIs93qv9sXSdWEPyY55k0KVSr-XMPYNJhTux3vYLzAE,7104
+ekfsm/devices/pmbus.py,sha256=5nIvuUkY20YwXTIpd3lebdu2dU-he_IJ7wLz1EUTrzc,7078
 ekfsm/devices/smbios.py,sha256=gDDYtfCd7njzqxJBKJxIR2BMCK6-uZxUVxC9y0hnz4g,1009
 ekfsm/devices/smbus.py,sha256=zD9b6PehipMw-xoaOMC-oorDVxBoo30hc98gyFxFLs0,500
 ekfsm/devices/utils.py,sha256=4-0Kmvy4ou8R71afNj6RqdBTjLW4SMWPHqVrzB2RUZw,397
-ekfsm-1.1.0a15.post1.dist-info/METADATA,sha256=ylfAPwvJBbi31RurwwJQDMo6V3C-EYkeoTn_RjXs14E,6550
-ekfsm-1.1.0a15.post1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ekfsm-1.1.0a15.post1.dist-info/entry_points.txt,sha256=WhUR4FzuxPoGrbTOKLsNJO7NAnk2qd4T30fqzN1yLw8,45
-ekfsm-1.1.0a15.post1.dist-info/RECORD,,
+ekfsm-1.2.0a7.dist-info/METADATA,sha256=VUyieRTVS_l9ZWkP1ctAYgFAK5s9tv3V_mUOTBXkePM,6543
+ekfsm-1.2.0a7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ekfsm-1.2.0a7.dist-info/entry_points.txt,sha256=WhUR4FzuxPoGrbTOKLsNJO7NAnk2qd4T30fqzN1yLw8,45
+ekfsm-1.2.0a7.dist-info/RECORD,,