ekfsm 0.13.0a183__py3-none-any.whl → 1.5.0__py3-none-any.whl

ekfsm/__init__.py

@@ -1,16 +1,5 @@
-from .core.slots import Slot
 from .system import System
-from .core import HwModule
-from .core.slots import SlotType
-from .exceptions import ConfigError
-from .lock import locking_cleanup, locking_configure
+from .config import load_config
+from .log import ekfsm_logger
 
-__all__ = (
-    "System",
-    "ConfigError",
-    "HwModule",
-    "Slot",
-    "SlotType",
-    "locking_cleanup",
-    "locking_configure",
-)
+__all__ = ("System", "load_config", "ekfsm_logger")

ekfsm/boards/oem/ekf/shu-shuttle.yaml

@@ -0,0 +1,43 @@
+id: 73
+name: "EKF SHU-SHUTTLE"
+slot_type: CPCI_S0_UTILITY
+children:
+  - device_type: I2CMux
+    name: "MUX"
+    addr: 0x70
+    slot_coding_mask: 0x0
+    children:
+      - device_type: MuxChannel
+        name: "CH00"
+        channel_id: 0
+        children:
+          - device_type: EKFIdentificationIOExpander
+            name: "GPIO"
+            addr: 0x3D
+            provides:
+              inventory:
+                - revision
+          - device_type: EKF_CCU_EEPROM
+            name: "EEPROM"
+            addr: 0x55
+            provides:
+              inventory:
+                - vendor
+                - serial
+                - model
+                - repaired_at
+                - manufactured_at
+              chassis_inventory:
+                - revision: crevision
+                - write_revision: write_crevision
+                - vendor: cvendor
+                - write_vendor: write_cvendor
+                - serial: cserial
+                - write_serial: write_cserial
+                - model: cmodel
+                - write_model: write_cmodel
+                - unit
+                - write_unit
+              custom_eeprom:
+                - write: write_customer_area
+                - read: customer_area

ekfsm/boards/oem/ekf/sq3-quartet.yaml

@@ -2,40 +2,54 @@ id: 69
 name: "EKF SQ3-QUARTET"
 slot_type: CPCI_S0_PER
 children:
-    - device_type: I2CMux
-      name: "MUX"
-      addr: 0x70
-      slot_coding_mask: 0x07
-      children:
-        - device_type: MuxChannel
-          name: "CH00"
-          channel_id: 0
-          children:
-            - device_type: EKFIdentificationIOExpander
-              name: "GPIO"
-              addr: 0x3D
-              provides:
-                inventory:
-                  - revision
-            - device_type: EKF_EEPROM
-              name: "EEPROM"
-              addr: 0x55
-              provides:
-                inventory:
-                  - vendor
-                  - serial
-                  - model
-                  - repaired_at
-                  - manufactured_at
-        - device_type: MuxChannel
-          name: "CH01"
-          channel_id: 1
-          children:
-        - device_type: MuxChannel
-          name: "CH02"
-          channel_id: 2
-          children:
-        - device_type: MuxChannel
-          name: "CH03"
-          channel_id: 3
-          children:
+  - device_type: IO4Edge
+    name: "BMC"
+    children:
+      - device_type: PixelDisplay
+        name: "display"
+      - device_type: ButtonArray
+        name: "buttons"
+        children:
+          - device_type: Button
+            name: "up"
+            channel_id: 0
+          - device_type: Button
+            name: "down"
+            channel_id: 1
+  - device_type: I2CMux
+    name: "MUX"
+    addr: 0x70
+    slot_coding_mask: 0x07
+    children:
+      - device_type: MuxChannel
+        name: "CH00"
+        channel_id: 0
+        children:
+          - device_type: EKFIdentificationIOExpander
+            name: "GPIO"
+            addr: 0x3D
+            provides:
+              inventory:
+                - revision
+          - device_type: EKF_EEPROM
+            name: "EEPROM"
+            addr: 0x55
+            provides:
+              inventory:
+                - vendor
+                - serial
+                - model
+                - repaired_at
+                - manufactured_at
+      - device_type: MuxChannel
+        name: "CH01"
+        channel_id: 1
+        children:
+      - device_type: MuxChannel
+        name: "CH02"
+        channel_id: 2
+        children:
+      - device_type: MuxChannel
+        name: "CH03"
+        channel_id: 3
+        children:

ekfsm/boards/oem/ekf/z1010.yaml

@@ -0,0 +1,102 @@
+id: 112
+name: "EKF Z1010"
+slot_type: CPCI_S0_UTILITY
+children:
+  - device_type: I2CMux
+    name: "MUX"
+    addr: 0x70
+    slot_coding_mask: 0x0
+    children:
+      - device_type: MuxChannel
+        name: "CH00"
+        channel_id: 0
+        children:
+          - device_type: EKFIdentificationIOExpander
+            name: "GPIO"
+            addr: 0x3D
+            provides:
+              inventory:
+                - revision
+          - device_type: EKF_CCU_EEPROM
+            name: "EEPROM"
+            addr: 0x55
+            provides:
+              inventory:
+                - vendor
+                - serial
+                - model
+                - repaired_at
+                - manufactured_at
+              chassis_inventory:
+                - revision: crevision
+                - write_revision: write_crevision
+                - vendor: cvendor
+                - write_vendor: write_cvendor
+                - serial: cserial
+                - write_serial: write_cserial
+                - model: cmodel
+                - write_model: write_cmodel
+                - unit
+                - write_unit
+              custom_eeprom:
+                - write: write_customer_area
+                - read: customer_area
+  - device_type: IO4Edge
+    name: "I4E"
+    provides:
+      management:
+        - identify_firmware
+        - load_firmware
+        - load_parameter
+        - get_parameter
+        - restart
+    children:
+      - device_type: LEDArray
+        name: "leds"
+        children:
+          - device_type: ColorLED
+            name: "led0"
+            channel_id: 0
+          - device_type: ColorLED
+            name: "led1"
+            channel_id: 1
+          - device_type: ColorLED
+            name: "led2"
+            channel_id: 2
+          - device_type: ColorLED
+            name: "led3"
+            channel_id: 3
+          - device_type: ColorLED
+            name: "led4"
+            channel_id: 4
+          - device_type: ColorLED
+            name: "led5"
+            channel_id: 5
+          - device_type: ColorLED
+            name: "led6"
+            channel_id: 6
+          - device_type: ColorLED
+            name: "led7"
+            channel_id: 7
+      - device_type: Watchdog
+        name: "watchdog"
+        provides:
+          sysstate:
+            - kick
+      - device_type: ThermalHumidity
+        name: "th"
+      - device_type: GPIOArray
+        name: "gpios"
+        children:
+          - device_type: BinaryToggle
+            name: "power"
+            channel_id: 0
+          - device_type: BinaryToggle
+            name: "redriver"
+            channel_id: 1
+          - device_type: ButtonArray
+            name: "buttons"
+            children:
+              - device_type: Button
+                name: "eject"
+                channel_id: 2

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/cli.py

@@ -1,21 +1,23 @@
 #! /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__)
 
 sm: System | None = None
 
+__all__ = ("cli", "main", "write", "show")
+
 
 @click.group()
 @click.option("--verbose", "-v", is_flag=True, help="Enable verbose output")
@@ -37,7 +39,30 @@ sm: System | None = None
 )
 def cli(verbose, debug, sysfs, config):
     global sm
-    """POSIX-compliant CLI tool with subcommands"""
+    """POSIX-compliant CLI tool with subcommands
+    for the EKF System Management (EKFSM) library.
+
+    This tool provides a command-line interface for managing and
+    interacting with the EKF System Management library. It allows
+    users to perform various operations related to system management,
+    including reading and writing data to the system, and displaying
+    information about the system.
+
+    Parameters
+    ----------
+    verbose
+        Enable verbose output. If set, the logging level will be set to INFO.
+    debug
+        Enable debug output. If set, the logging level will be set to DEBUG.
+    sysfs
+        Use custom sysfs directory for simulation mode. If set, the
+        simulation mode will be enabled and the specified directory
+        will be used for sysfs operations.
+    config
+        Path to the configuration file. This file is required for
+        initializing the system. The path should point to a valid
+        configuration file in YAML format.
+    """
     if verbose:
         logging.getLogger().setLevel(logging.INFO)
         logger.info("Verbose output enabled")
@@ -62,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/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/core/__init__.py

@@ -1,4 +1,14 @@
-from .slots import Slot, SlotType, Slots  # noqa: F401
-from .sysfs import SysFSDevice, SysFSAttribute  # noqa: F401
-from .components import HwModule  # noqa: F401
+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/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.
     """
 
@@ -51,7 +51,7 @@ class HwModule(SysTree):
         *args,
         **kwargs,
     ) -> None:
-        from ekfsm.core.utils import deserialize_hardware_tree
+        from ekfsm.core.utils import deserialize_hardware_tree, deserialize_module
 
         from .slots import SlotType
 
@@ -59,9 +59,8 @@ class HwModule(SysTree):
         self._slot: Slot = slot
         self.config = config
 
-        self.id, self.board_type, slot_type, self.children = deserialize_hardware_tree(
-            self.logger, self.config, parent=self
-        )
+        self.id, self.board_type, slot_type = deserialize_module(self.logger, config)
+        self.children = deserialize_hardware_tree(self.logger, self.config, parent=self)
 
         self.slot_type = SlotType.from_string(slot_type)
 
@@ -119,13 +118,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/core/connections.py

@@ -0,0 +1,19 @@
+from contextlib import contextmanager
+
+
+class Connectable:
+
+    def __init__(self, client=None):
+        self._client = client
+        self._connected = False
+
+    @contextmanager
+    def connect(self):
+        if not self._connected:
+            client = self._client(self.service_addr, command_timeout=self.timeout)
+            self._connected = True
+        try:
+            yield client
+        finally:
+            client.close()
+            del client

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
@@ -142,7 +140,7 @@ class Slots(Munch):
 
     Example
     -------
-    >>> from ekfsm.slot import Slot, Slots, SlotType
+    >>> from ekfsm..core.slots import Slot, Slots, SlotType
     >>> slotA = Slot("SlotA", SlotType.CPCI_S0_PER, "Bla", "Blubb", 3)
     >>> slots = Slots((slotA.name, slotA))
     >>> print(slots[name])
@@ -192,7 +190,7 @@ class Slots(Munch):
 
         Example
         -------
-        >>> from ekfsm.slot import Slot, Slots, SlotType
+        >>> from ekfsm.core.slots import Slot, Slots, SlotType
         >>> slotA = Slot("SlotA", SlotType.CPCI_S0_PER, "Bla", "Blubb", 3)
         >>> slots = Slots()
         >>> slots.add(slotA) # add slotA to the collection