ekfsm 1.2.0a7__tar.gz → 1.3.0__tar.gz

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/.gitlab-ci.yml

@@ -180,7 +180,7 @@ build-doc-coverage:
     paths:
       - docs/build/coverage
 
-deploy:
+deploy-gitlab-pypi:
   stage: ⬆️ deploy
   image: python:3.12
   tags:
@@ -196,7 +196,26 @@ deploy:
     - echo "Install twine..."
     - python -m pip install twine
   script:
-    - echo "Deploying version ${GitVersion_SemVer} to pypi repository..."
+    - echo "Deploying version ${GitVersion_SemVer} to gitlab pypi repository..."
     - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python -m twine upload --repository-url ${PACKAGE_REGISTRY_URL} dist/*
   needs:
     - pkg
+
+deploy-pypi:
+  stage: ⬆️ deploy
+  tags:
+    - shared
+  variables:
+    GIT_STRATEGY: clone
+    GIT_SUBMODULE_STRATEGY: recursive
+  rules:
+    - *default_rule_hotfix
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH == "develop"
+      when: on_success
+  before_script:
+    - direnv allow .
+  script:
+    - echo "Deploying version ${GitVersion_SemVer} to pypi repository..."
+    - direnv exec . publish-package
+  needs:
+    - pkg

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/.readthedocs.yaml

@@ -29,4 +29,4 @@ sphinx:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
    install:
-   - requirements: docs/requirements.txt
+   - requirements: docs/requirements.txt

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/PKG-INFO

@@ -1,17 +1,20 @@
 Metadata-Version: 2.4
 Name: ekfsm
-Version: 1.2.0a7
+Version: 1.3.0
 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>
+Author-email: Jan Jansen <jan@ekf.de>, Klaus Popp <klaus.popp@ci4rail.com>, Felix Päßler <fp@ekf.de>
 Requires-Python: >=3.10
 Requires-Dist: anytree
 Requires-Dist: click>=8.0.1
 Requires-Dist: crcmod
 Requires-Dist: gpiod>=2.1.0
 Requires-Dist: hexdump
+Requires-Dist: ipdb>=0.13.13
 Requires-Dist: more-itertools
 Requires-Dist: munch
+Requires-Dist: schema>=0.7.7
 Requires-Dist: smbus2
+Requires-Dist: termcolor>=3.0.1
 Requires-Dist: types-pyyaml>=6.0.12.20241230
 Requires-Dist: yamale
 Description-Content-Type: text/markdown
@@ -146,9 +149,9 @@ import ekfsm
 
 system = ekfsm.System("system.yaml")
 
-# alternative ways to get the SUR HwModule
-sur = system["SER"]    # by using the hwmodule name as key
-sur = system.ser       # by using the hwmodule name as attribute
+# alternative ways to get the SUR HWModule
+sur = system["SER"]    # by using the HWModule name as key
+sur = system.ser       # by using the HWmodule name as attribute
 sur = system.slots["SLOT1"].hwmodule  # by using the slot name as key
 sur = system.slots.slot1.hwmodule  # by using the slot name as attribute
 

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/README.md

@@ -128,9 +128,9 @@ import ekfsm
 
 system = ekfsm.System("system.yaml")
 
-# alternative ways to get the SUR HwModule
-sur = system["SER"]    # by using the hwmodule name as key
-sur = system.ser       # by using the hwmodule name as attribute
+# alternative ways to get the SUR HWModule
+sur = system["SER"]    # by using the HWModule name as key
+sur = system.ser       # by using the HWmodule name as attribute
 sur = system.slots["SLOT1"].hwmodule  # by using the slot name as key
 sur = system.slots.slot1.hwmodule  # by using the slot name as attribute
 

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/devenv.lock

@@ -3,10 +3,10 @@
     "devenv": {
       "locked": {
         "dir": "src/modules",
-        "lastModified": 1740649578,
+        "lastModified": 1743582803,
         "owner": "cachix",
         "repo": "devenv",
-        "rev": "6344ff303b0098afae94b28df8dc1b9b7ac1e227",
+        "rev": "3dd684b5df083ca48a8db263d9406bf83fc12b3e",
         "type": "github"
       },
       "original": {
@@ -19,10 +19,10 @@
     "flake-compat": {
       "flake": false,
       "locked": {
-        "lastModified": 1733328505,
+        "lastModified": 1747046372,
         "owner": "edolstra",
         "repo": "flake-compat",
-        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
+        "rev": "9100a0f413b0c601e0533d1d94ffd501ce2e7885",
         "type": "github"
       },
       "original": {
@@ -31,31 +31,10 @@
         "type": "github"
       }
     },
-    "git-hooks": {
-      "inputs": {
-        "flake-compat": "flake-compat",
-        "gitignore": "gitignore",
-        "nixpkgs": [
-          "nixpkgs"
-        ]
-      },
-      "locked": {
-        "lastModified": 1737465171,
-        "owner": "cachix",
-        "repo": "git-hooks.nix",
-        "rev": "9364dc02281ce2d37a1f55b6e51f7c0f65a75f17",
-        "type": "github"
-      },
-      "original": {
-        "owner": "cachix",
-        "repo": "git-hooks.nix",
-        "type": "github"
-      }
-    },
     "gitignore": {
       "inputs": {
         "nixpkgs": [
-          "git-hooks",
+          "pre-commit-hooks",
           "nixpkgs"
         ]
       },
@@ -87,14 +66,32 @@
         "type": "github"
       }
     },
+    "pre-commit-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1747372754,
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "80479b6ec16fefd9c1db3ea13aeb038c60530f46",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
     "root": {
       "inputs": {
         "devenv": "devenv",
-        "git-hooks": "git-hooks",
         "nixpkgs": "nixpkgs",
-        "pre-commit-hooks": [
-          "git-hooks"
-        ]
+        "pre-commit-hooks": "pre-commit-hooks"
       }
     }
   },

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/devenv.nix

@@ -30,11 +30,26 @@
   };
 
   git-hooks.hooks = {
+    default-version = {
+      enable = true;
+      name = "Ensure default version";
+      entry = "git-reset-version";
+      pass_filenames = false;
+    };
+
+    update-docs-requirements = {
+      enable = true;
+      name = "Update requirements of documentation";
+      entry = "update-docs";
+      pass_filenames = false;
+    };
+
     # Remove trailing whitespace
     trailing-whitespace = {
       enable = true;
       package = pkgs.python3Packages.pre-commit-hooks;
       entry = "trailing-whitespace-fixer";
+      excludes = [ "tests/sim/sys/.*$" ];
     };
 
     # Ensure files end with a newline
@@ -47,6 +62,26 @@
     flake8.enable = true;
   };
 
+  scripts.update-docs.exec = ''
+    temp_file=$(mktemp)
+    trap "rm -f $temp_file" 0 2 3 15
+    uv export > $temp_file 2>/dev/null
+
+    if diff -q $temp_file docs/requirements.txt &>/dev/null; then
+      update-doc-reqs
+
+      if git diff --cached --name-only | grep -q -- 'uv.lock'; then
+        git add docs/requirements.txt
+      fi
+    fi
+  '';
+
+  scripts.git-reset-version.exec = ''
+      if git diff --cached --name-only | grep -q -- "^pyproject.toml"; then
+        uvx --from=toml-cli toml set --toml-path=pyproject.toml project.version 0.0.0 && git add pyproject.toml
+      fi
+  '';
+
   scripts.bump-version.exec = ''
     uvx --from=toml-cli toml set --toml-path=pyproject.toml project.version $(uvx dunamai from any --no-metadata --style semver)
   '';
@@ -56,13 +91,22 @@
     uv build
   '';
 
+  scripts.publish-package.exec = ''
+    uv publish
+  '';
+
   scripts.generate-doc-reqs.exec = ''
-    uv export >docs/requirements.txt
+    uv export > docs/requirements.txt
   '';
 
   scripts.generate-coverage.exec = ''
-    uv run --with pytest-cov pytest --cov=ekfsm --cov --cov-report term --cov-report xml:coverage.xml | perl -pe 's/\e\[?.*?[\@-~]//g' | tee pytest.log
-    uv run --with pytest-cov pytest --cov=ekfsm --junitxml=report.xml
+    if [ "$EUID" -ne 0 ]; then
+      uv run --with pytest-cov pytest -k 'not locking' --cov=ekfsm --cov --cov-report term --cov-report xml:coverage.xml | perl -pe 's/\e\[?.*?[\@-~]//g' | tee pytest.log
+      uv run --with pytest-cov pytest -k 'not locking' --cov=ekfsm --junitxml=report.xml
+    else
+      uv run --with pytest-cov pytest --cov=ekfsm --cov --cov-report term --cov-report xml:coverage.xml | perl -pe 's/\e\[?.*?[\@-~]//g' | tee pytest.log
+      uv run --with pytest-cov pytest --cov=ekfsm --junitxml=report.xml
+    fi
   '';
 
   scripts.doc-coverage.exec = ''

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/docs/source/boards/hitron/hdrc-300s.rst

@@ -10,13 +10,13 @@ The inventory provides access to the PSU inventory, such as the vendor, model, s
 +---------------------------------------------+-------------------+----------------------------+
 | Method                                      | Description       | Example Value              |
 +---------------------------------------------+-------------------+----------------------------+
-| :meth:`~ekfsm.devices.pmbus.PmBus.vendor`   | Get vendor        | ``Hitron``                 |
+| :meth:`~ekfsm.devices.pmbus.PMBus.vendor`   | get vendor        | ``hitron``                 |
 +---------------------------------------------+-------------------+----------------------------+
-| :meth:`~ekfsm.devices.pmbus.PmBus.model`    | Get model         | ``HDRC300S-110J-D120E(N)`` |
+| :meth:`~ekfsm.devices.pmbus.PMBus.model`    | Get model         | ``HDRC300S-110J-D120E(N)`` |
 +---------------------------------------------+-------------------+----------------------------+
-| :meth:`~ekfsm.devices.pmbus.PmBus.serial`   | Get serial number | ``23450506``               |
+| :meth:`~ekfsm.devices.pmbus.PaBus.serial`   | Get serial number | ``23450506``               |
 +---------------------------------------------+-------------------+----------------------------+
-| :meth:`~ekfsm.devices.pmbus.PmBus.revision` | Get Prevision     | ``0A``                     |
+| :meth:`~ekfsm.devices.pmbus.PMBus.revision` | Get Prevision     | ``0A``                     |
 +---------------------------------------------+-------------------+----------------------------+
 
 Device Temperature (Object: `th`)
@@ -25,7 +25,7 @@ Device Temperature (Object: `th`)
 +---------------------------------------------------------------+---------------------+---------------+
 | Method                                                        | Description         | Example Value |
 +---------------------------------------------------------------+---------------------+---------------+
-| :meth:`temperature() <ekfsm.devices.pmbus.PmBus.temp1_input>` | Get the temperature | ``-10``       |
+| :meth:`temperature() <ekfsm.devices.pmbus.PMBus.temp1_input>` | Get the temperature | ``-10``       |
 +---------------------------------------------------------------+---------------------+---------------+
 
 Main Output (Object: `main`)
@@ -36,11 +36,11 @@ The `main` object respresent the main output module (+12V) of the PSU.
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
 | Method                                                     | Description               | Example Value                                                 |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
-| :meth:`voltage() <ekfsm.devices.pmbus.PmBus.in1_input>`    | Get actual output voltage | ``12.1``                                                      |
+| :meth:`voltage() <ekfsm.devices.pmbus.PMBus.in1_input>`    | Get actual output voltage | ``12.1``                                                      |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
-| :meth:`current() <ekfsm.devices.pmbus.PmBus.curr1_input>`  | Get actual output current | ``2.5``                                                       |
+| :meth:`current() <ekfsm.devices.pmbus.PMBus.curr1_input>`  | Get actual output current | ``2.5``                                                       |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
-| :meth:`status() <ekfsm.devices.pmbus.PmBus.status0_input>` | Get diagnostics           | ``<PsuStatus.OUTPUT_OVERVOLTAGE``|``OUTPUT_OVERCURRENT: 48>`` |
+| :meth:`status() <ekfsm.devices.pmbus.PMBus.status0_input>` | Get diagnostics           | ``<PSUStatus.OUTPUT_OVERVOLTAGE``|``OUTPUT_OVERCURRENT: 48>`` |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
 
 
@@ -52,11 +52,11 @@ The `sby` object respresent the secondary output module (+5V) of the PSU.
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
 | Method                                                     | Description               | Example Value                                                 |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
-| :meth:`voltage() <ekfsm.devices.pmbus.PmBus.in2_input>`    | Get actual output voltage | ``5.1``                                                       |
+| :meth:`voltage() <ekfsm.devices.pmbus.PMBus.in2_input>`    | Get actual output voltage | ``5.1``                                                       |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
-| :meth:`current() <ekfsm.devices.pmbus.PmBus.curr2_input>`  | Get actual output current | ``0.2``                                                       |
+| :meth:`current() <ekfsm.devices.pmbus.PMBus.curr2_input>`  | Get actual output current | ``0.2``                                                       |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
-| :meth:`status() <ekfsm.devices.pmbus.PmBus.status1_input>` | Get diagnostics           | ``<PsuStatus.OUTPUT_OVERVOLTAGE``|``OUTPUT_OVERCURRENT: 48>`` |
+| :meth:`status() <ekfsm.devices.pmbus.PMBus.status1_input>` | Get diagnostics           | ``<PSUStatus.OUTPUT_OVERVOLTAGE``|``OUTPUT_OVERCURRENT: 48>`` |
 +------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
 
 .. warning::

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/docs/source/intro.rst

@@ -34,10 +34,10 @@ System Configuration
 --------------------
 
 The system configuration is defined in a :ref:`systemconfig`. The configuration file defines the
-modular components of the system, i.e. you define which board types (called :class:`~HwModule`s in ekfsm) are expected in which slots of the chassis.
+modular components of the system, i.e. you define which board types (called :class:`~HWModule`s in ekfsm) are expected in which slots of the chassis.
 
 The system configuration file is then passed to the :class:`~.System` constructor to create a system object.
-During instantiation, the system object will create the necessary :class:`~ekfsm.core.components.HwModule` objects and all the
+During instantiation, the system object will create the necessary :class:`~ekfsm.core.components.HWModule` objects and all the
 supported functions for the devices.
 
 It will also check if the actual hardware configuration matches the expected configuration. The result
@@ -50,7 +50,7 @@ The objects and subobjects model the hardware topology of the system.
 
 An :class:`~.System` object is the root object of the ekfsm package.
 The system object contains :class:`~.Slot` objects, which represent the slots of the chassis.
-Each slot object contains zero or one :class:`~ekfsm.core.components.HwModule` objects, which represents the hardware module in the slot.
+Each slot object contains zero or one :class:`~ekfsm.core.components.HWModule` objects, which represents the hardware module in the slot.
 
 .. image:: _static/ekfsm_system.drawio.png
    :align: center
@@ -93,9 +93,9 @@ If you want to access the LEDs on the :ref:`sur-uart`, you can do the following:
 
     system = ekfsm.System("system.yaml")
 
-    # alternative ways to get the SUR HwModule
-    sur = system["SER"]    # by using the hwmodule name as key
-    sur = system.ser       # by using the hwmodule name as attribute
+    # alternative ways to get the SUR HWModule
+    sur = system["SER"]    # by using the HWModule name as key
+    sur = system.ser       # by using the HWModule name as attribute
     sur = system.slots["SLOT1"].hwmodule  # by using the slot name as key
     sur = system.slots.slot1.hwmodule  # by using the slot name as attribute
 

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/ekfsm/boards/oem/hitron/hdrc-300s.yaml

@@ -2,7 +2,7 @@ id: HDRC300S.*
 name: "Hitron HDRC-300S"
 slot_type: CPCI_S0_PSU
 children:
-    - device_type: PmBus
+    - device_type: PMBus
       name: "PMBUS"
       addr: 0x18
       slot_coding_mask: 0x07

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/ekfsm/cli.py

@@ -1,15 +1,15 @@
 #! /usr/bin/env python3
 # import os
 # import sys
-import click
+# pyright: reportOptionalMemberAccess = false
 import logging
 from pathlib import Path
 
-from ekfsm.system import System
-from ekfsm.log import ekfsm_logger
-from ekfsm.simctrl import enable_simulation
-from ekfsm.simctrl import register_gpio_simulations
+import click
 
+from ekfsm.log import ekfsm_logger
+from ekfsm.simctrl import enable_simulation, register_gpio_simulations
+from ekfsm.system import System
 
 logging.basicConfig(level=logging.WARNING, format="%(levelname)s: %(message)s")
 logger = ekfsm_logger(__name__)
@@ -87,9 +87,7 @@ def cli(verbose, debug, sysfs, config):
     type=int,
     help="Write chassis serial number",
 )
-@click.option(
-    "--unit", "-u", is_flag=False, prompt=True, type=int, help="Write chassis unit"
-)
+@click.option("--unit", "-u", is_flag=False, prompt=True, type=int, help="Write chassis unit")
 @click.option(
     "--vendor",
     "-n",

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/ekfsm/config.py

@@ -1,8 +1,10 @@
+from typing import Any, List, Tuple
+
+import munch
 import yamale  # type: ignore
 import yaml
-import munch
 
-from typing import Any, List, Tuple
+from ekfsm.exceptions import ConfigError
 
 schema_str = """
 system_config:
@@ -22,13 +24,19 @@ slot:
 def _validate_config(config_file: str) -> None:
     schema = yamale.make_schema(content=schema_str)
     data = yamale.make_data(config_file)
-    yamale.validate(schema, data)
+    try:
+        yamale.validate(schema, data)
+    except yamale.YamaleError:
+        raise ConfigError("Error in configuration file")
 
 
 def _parse_config(config_file: str) -> Any | munch.Munch | List | Tuple:
-    with open(config_file) as file:
-        config = yaml.safe_load(file)
-        munchified_config = munch.munchify(config)
+    try:
+        with open(config_file) as file:
+            config = yaml.safe_load(file)
+            munchified_config = munch.munchify(config)
+    except OSError:
+        raise ConfigError("Failed to open configuration file: {config_file}")
     return munchified_config
 
 

ekfsm-1.3.0/ekfsm/core/__init__.py

@@ -0,0 +1,14 @@
+from .components import HWModule  # noqa: F401
+from .probe import ProbeableDevice  # noqa: F401
+from .slots import Slot, Slots, SlotType  # noqa: F401
+from .sysfs import SysFSAttribute, SysfsDevice  # noqa: F401
+
+__all__ = [
+    "Slot",
+    "SlotType",
+    "Slots",
+    "SysfsDevice",
+    "SysFSAttribute",
+    "HWModule",
+    "ProbeableDevice",
+]

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/ekfsm/core/components.py

@@ -36,9 +36,9 @@ class SysTree(NodeMixin):
         print(self)
 
 
-class HwModule(SysTree):
+class HWModule(SysTree):
     """
-    A HwModule represents an instantiation of a specifc hw board type,
+    A HWModule represents an instantiation of a specifc hw board type,
     for example an instance of an EKF SC9 board.
     """
 
@@ -119,13 +119,13 @@ class HwModule(SysTree):
     @property
     def instance_name(self) -> str:
         if self.name is None:
-            raise RuntimeError("instance name not set")
+            raise RuntimeError("Instance name not set")
         return self.name
 
     @property
     def slot(self) -> Slot:
         if self._slot is None:
-            raise RuntimeError("slot not set")
+            raise RuntimeError("Slot not set")
         return self._slot
 
     def __repr__(self) -> str:

{ekfsm-1.2.0a7 → ekfsm-1.3.0}/ekfsm/core/slots.py

@@ -1,11 +1,9 @@
 from enum import Enum
-from ekfsm.core.components import HwModule
-
+from typing import Any
 
 from munch import Munch
 
-
-from typing import Any
+from ekfsm.core.components import HWModule
 
 
 class SlotType(Enum):
@@ -66,8 +64,8 @@ class Slot:
         desired_hwmodule_type: str,
         desired_hwmodule_name: str,
         number: int,
-        hwmodule: HwModule | None = None,
-        master: HwModule | None = None,
+        hwmodule: HWModule | None = None,
+        master: HWModule | None = None,
         attributes: Munch | None = None,
     ) -> None:
         self._name = name
@@ -104,9 +102,7 @@ class Slot:
         }
 
     def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}(name={self._name}, slot_type={self.slot_type})"
-        )
+        return f"{self.__class__.__name__}(name={self._name}, slot_type={self.slot_type})"
 
     @property
     def name(self) -> str:
@@ -127,10 +123,7 @@ class Slot:
         """
         Return True if the slot is populated with the desired hardware module type, False otherwise.
         """
-        return (
-            self.hwmodule is not None
-            and self.hwmodule.board_type.lower() == self._desired_hwmodule_type.lower()
-        )
+        return self.hwmodule is not None and self.hwmodule.board_type.lower() == self._desired_hwmodule_type.lower()
 
 
 class Slots(Munch):