ekfsm 0.12.0.post1__tar.gz → 0.13.0a160.post4__tar.gz

{ekfsm-0.12.0.post1 → ekfsm-0.13.0a160.post4}/.vscode/settings.json

@@ -2,7 +2,7 @@
     "mypy-type-checker.reportingScope": "workspace",
     "editor.defaultFormatter": "ms-python.black-formatter",
     "editor.formatOnSave": true,
-    "mypy-type-checker.preferDaemon": false,
+    "mypy-type-checker.preferDaemon": true,
     "mypy-type-checker.importStrategy": "fromEnvironment",
     "autoDocstring.docstringFormat": "numpy-notypes",
     "autoDocstring.startOnNewLine": true,

ekfsm-0.13.0a160.post4/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: ekfsm
+Version: 0.13.0a160.post4
+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
+Requires-Dist: anytree
+Requires-Dist: click>=8.0.1
+Requires-Dist: crcmod
+Requires-Dist: gpiod>=2.1.0
+Requires-Dist: hexdump
+Requires-Dist: more-itertools
+Requires-Dist: munch
+Requires-Dist: smbus2
+Requires-Dist: types-pyyaml>=6.0.12.20241230
+Requires-Dist: yamale
+Description-Content-Type: text/markdown
+
+# ekfsm - EKF system management library
+
+Provides a python library framework for access to system management functions on Linux based modular hardware systems,
+such as CompactPCI-Serial systems.
+
+## Features
+
+- System configuration via YAML configuration file
+- Obtain inventory information of the system and its components
+- Obtain sensor information, such as temperature, humidity, voltage, current, accelerometer, gyroscope, etc.
+- Write and read EEPROM contents
+- Access to system level functions, such as system LEDs, system fan, system power supply, etc.
+- Supports simulation mode for development and testing
+- Probing of desired boards in configured slots
+
+## Requirements
+
+Prior to the use of I2C, PMBus or GPIO devices using the API, those devices have to be initialised by ACPI or manual device setup.
+
+### Example
+
+In order to initialize an EEPROM of type AT24 behind a Mux channel 0, manualy add the device:
+
+```bash
+cd /sys/bus/i2c/devices/0-0074/channel-0/
+echo 24c02 0x55 >new_device
+```
+
+Now we can access the EEPROM contents:
+
+```bash
+hd 8-0055/eeprom
+00000000  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  |................|
+*
+00000100
+```
+
+
+## Installation
+
+To install the package via pip, you have to use a virtual environment to ensure full operabilty.
+*Note: CLI entrypoint script won't work if installed in the system store!*
+
+### Prepare virtual environment
+
+First, name, create and activate your virtual environment (here `myvenv`):
+
+```bash
+$ python -m venv myvenv
+$ source myvenv/bin/activate
+```
+
+### Package install
+
+Now install the ekfsm package and all dependencies from the [project pypi registry](https://gitlab.ekf.com/libs/apis/ekfsm/-/packages):
+
+```bash
+(myvenv) $ pip install ekfsm --index-url https://gitlab.ekf.com/api/v4/projects/407/packages/pypi/simple
+Looking in indexes: https://gitlab.ekf.com/api/v4/projects/407/packages/pypi/simple
+Collecting ekfsm
+  Downloading https://gitlab.ekf.com/api/v4/projects/407/packages/pypi/files/e400ee46de9346c086ce708675977cc6ab080c8c016d360970c82d1c436f7c89/ekfsm-0.12.0-py3-none-any.whl (43 kB)
+Collecting anytree (from ekfsm)
+  Using cached anytree-2.12.1-py3-none-any.whl.metadata (8.1 kB)
+Collecting click>=8.0.1 (from ekfsm)
+  Using cached click-8.1.8-py3-none-any.whl.metadata (2.3 kB)
+Collecting crcmod (from ekfsm)
+  Using cached crcmod-1.7-cp312-cp312-linux_x86_64.whl
+Collecting gpiod>=2.1.0 (from ekfsm)
+  Using cached gpiod-2.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.1 kB)
+Collecting hexdump (from ekfsm)
+  Using cached hexdump-3.3-py3-none-any.whl
+Collecting more-itertools (from ekfsm)
+  Using cached more_itertools-10.6.0-py3-none-any.whl.metadata (37 kB)
+Collecting munch (from ekfsm)
+  Using cached munch-4.0.0-py2.py3-none-any.whl.metadata (5.9 kB)
+Collecting smbus2 (from ekfsm)
+  Using cached smbus2-0.5.0-py2.py3-none-any.whl.metadata (6.9 kB)
+Collecting types-pyyaml>=6.0.12.20241230 (from ekfsm)
+  Using cached types_PyYAML-6.0.12.20241230-py3-none-any.whl.metadata (1.8 kB)
+Collecting yamale (from ekfsm)
+  Using cached yamale-6.0.0-py3-none-any.whl.metadata (22 kB)
+Collecting six (from anytree->ekfsm)
+  Using cached six-1.17.0-py2.py3-none-any.whl.metadata (1.7 kB)
+Collecting pyyaml (from yamale->ekfsm)
+  Using cached PyYAML-6.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (2.1 kB)
+Using cached click-8.1.8-py3-none-any.whl (98 kB)
+Using cached gpiod-2.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (103 kB)
+Using cached types_PyYAML-6.0.12.20241230-py3-none-any.whl (20 kB)
+Using cached anytree-2.12.1-py3-none-any.whl (44 kB)
+Using cached more_itertools-10.6.0-py3-none-any.whl (63 kB)
+Using cached munch-4.0.0-py2.py3-none-any.whl (9.9 kB)
+Using cached smbus2-0.5.0-py2.py3-none-any.whl (11 kB)
+Using cached yamale-6.0.0-py3-none-any.whl (57 kB)
+Using cached PyYAML-6.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (767 kB)
+Using cached six-1.17.0-py2.py3-none-any.whl (11 kB)
+Installing collected packages: smbus2, hexdump, crcmod, types-pyyaml, six, pyyaml, munch, more-itertools, gpiod, click, yamale, anytree, ekfsm
+Successfully installed anytree-2.12.1 click-8.1.8 crcmod-1.7 ekfsm-0.12.0 gpiod-2.3.0 hexdump-3.3 more-itertools-10.6.0 munch-4.0.0 pyyaml-6.0.2 six-1.17.0 smbus2-0.5.0 types-pyyaml-6.0.12.20241230 yamale-6.0.0
+```
+
+## Example Usage Scenario
+
+To use the library for a desired system, it must be configured in a system config yaml file:
+
+```yaml
+# Example config
+system_config:
+  name: "Simple System"
+  slots:
+    - name: SYSTEM_SLOT
+      slot_type: CPCI_S0_SYS
+      desired_hwmodule_type: EKF SC9-Toccata
+      desired_hwmodule_name: CPU
+      attributes:
+        is_master: true
+    - name: SLOT1
+      slot_type: CPCI_S0_PER
+      desired_hwmodule_type: EKF SRF-SUR
+      desired_hwmodule_name: SER
+      attributes:
+        slot_coding: 0x1
+```
+
+### API
+
+If you want to access the LEDs on the EKF SUR-UART, you can do the following:
+```python
+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
+sur = system.slots["SLOT1"].hwmodule  # by using the slot name as key
+sur = system.slots.slot1.hwmodule  # by using the slot name as attribute
+
+# accessing the LED device
+sur.led_a.set(0,"purple")  # set the color of the LED to purple
+```
+
+For further infos on all API aspects, please see the [API Reference](https://ekfsm.readthedocs.io/en/main/reference/index.html).
+
+### CLI
+
+Upon activation of a venv provided with the ekfsm library, an entry point script `ekfsm-cli` is exported in the current shell.
+
+See `ekfsm-cli -h` for a help on the usage.
+
+
+## Resources
+
+[Documentation](https://ekfsm.readthedocs.io/en/main/)
+
+[Source Code](https://gitlab.ekf.com/libs/apis/ekfsm)
+
+[Developer Wiki](https://gitlab.ekf.com/libs/apis/ekfsm/-/wikis/home)

ekfsm-0.13.0a160.post4/README.md

@@ -0,0 +1,156 @@
+# ekfsm - EKF system management library
+
+Provides a python library framework for access to system management functions on Linux based modular hardware systems,
+such as CompactPCI-Serial systems.
+
+## Features
+
+- System configuration via YAML configuration file
+- Obtain inventory information of the system and its components
+- Obtain sensor information, such as temperature, humidity, voltage, current, accelerometer, gyroscope, etc.
+- Write and read EEPROM contents
+- Access to system level functions, such as system LEDs, system fan, system power supply, etc.
+- Supports simulation mode for development and testing
+- Probing of desired boards in configured slots
+
+## Requirements
+
+Prior to the use of I2C, PMBus or GPIO devices using the API, those devices have to be initialised by ACPI or manual device setup.
+
+### Example
+
+In order to initialize an EEPROM of type AT24 behind a Mux channel 0, manualy add the device:
+
+```bash
+cd /sys/bus/i2c/devices/0-0074/channel-0/
+echo 24c02 0x55 >new_device
+```
+
+Now we can access the EEPROM contents:
+
+```bash
+hd 8-0055/eeprom
+00000000  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  |................|
+*
+00000100
+```
+
+
+## Installation
+
+To install the package via pip, you have to use a virtual environment to ensure full operabilty.
+*Note: CLI entrypoint script won't work if installed in the system store!*
+
+### Prepare virtual environment
+
+First, name, create and activate your virtual environment (here `myvenv`):
+
+```bash
+$ python -m venv myvenv
+$ source myvenv/bin/activate
+```
+
+### Package install
+
+Now install the ekfsm package and all dependencies from the [project pypi registry](https://gitlab.ekf.com/libs/apis/ekfsm/-/packages):
+
+```bash
+(myvenv) $ pip install ekfsm --index-url https://gitlab.ekf.com/api/v4/projects/407/packages/pypi/simple
+Looking in indexes: https://gitlab.ekf.com/api/v4/projects/407/packages/pypi/simple
+Collecting ekfsm
+  Downloading https://gitlab.ekf.com/api/v4/projects/407/packages/pypi/files/e400ee46de9346c086ce708675977cc6ab080c8c016d360970c82d1c436f7c89/ekfsm-0.12.0-py3-none-any.whl (43 kB)
+Collecting anytree (from ekfsm)
+  Using cached anytree-2.12.1-py3-none-any.whl.metadata (8.1 kB)
+Collecting click>=8.0.1 (from ekfsm)
+  Using cached click-8.1.8-py3-none-any.whl.metadata (2.3 kB)
+Collecting crcmod (from ekfsm)
+  Using cached crcmod-1.7-cp312-cp312-linux_x86_64.whl
+Collecting gpiod>=2.1.0 (from ekfsm)
+  Using cached gpiod-2.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.1 kB)
+Collecting hexdump (from ekfsm)
+  Using cached hexdump-3.3-py3-none-any.whl
+Collecting more-itertools (from ekfsm)
+  Using cached more_itertools-10.6.0-py3-none-any.whl.metadata (37 kB)
+Collecting munch (from ekfsm)
+  Using cached munch-4.0.0-py2.py3-none-any.whl.metadata (5.9 kB)
+Collecting smbus2 (from ekfsm)
+  Using cached smbus2-0.5.0-py2.py3-none-any.whl.metadata (6.9 kB)
+Collecting types-pyyaml>=6.0.12.20241230 (from ekfsm)
+  Using cached types_PyYAML-6.0.12.20241230-py3-none-any.whl.metadata (1.8 kB)
+Collecting yamale (from ekfsm)
+  Using cached yamale-6.0.0-py3-none-any.whl.metadata (22 kB)
+Collecting six (from anytree->ekfsm)
+  Using cached six-1.17.0-py2.py3-none-any.whl.metadata (1.7 kB)
+Collecting pyyaml (from yamale->ekfsm)
+  Using cached PyYAML-6.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (2.1 kB)
+Using cached click-8.1.8-py3-none-any.whl (98 kB)
+Using cached gpiod-2.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (103 kB)
+Using cached types_PyYAML-6.0.12.20241230-py3-none-any.whl (20 kB)
+Using cached anytree-2.12.1-py3-none-any.whl (44 kB)
+Using cached more_itertools-10.6.0-py3-none-any.whl (63 kB)
+Using cached munch-4.0.0-py2.py3-none-any.whl (9.9 kB)
+Using cached smbus2-0.5.0-py2.py3-none-any.whl (11 kB)
+Using cached yamale-6.0.0-py3-none-any.whl (57 kB)
+Using cached PyYAML-6.0.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (767 kB)
+Using cached six-1.17.0-py2.py3-none-any.whl (11 kB)
+Installing collected packages: smbus2, hexdump, crcmod, types-pyyaml, six, pyyaml, munch, more-itertools, gpiod, click, yamale, anytree, ekfsm
+Successfully installed anytree-2.12.1 click-8.1.8 crcmod-1.7 ekfsm-0.12.0 gpiod-2.3.0 hexdump-3.3 more-itertools-10.6.0 munch-4.0.0 pyyaml-6.0.2 six-1.17.0 smbus2-0.5.0 types-pyyaml-6.0.12.20241230 yamale-6.0.0
+```
+
+## Example Usage Scenario
+
+To use the library for a desired system, it must be configured in a system config yaml file:
+
+```yaml
+# Example config
+system_config:
+  name: "Simple System"
+  slots:
+    - name: SYSTEM_SLOT
+      slot_type: CPCI_S0_SYS
+      desired_hwmodule_type: EKF SC9-Toccata
+      desired_hwmodule_name: CPU
+      attributes:
+        is_master: true
+    - name: SLOT1
+      slot_type: CPCI_S0_PER
+      desired_hwmodule_type: EKF SRF-SUR
+      desired_hwmodule_name: SER
+      attributes:
+        slot_coding: 0x1
+```
+
+### API
+
+If you want to access the LEDs on the EKF SUR-UART, you can do the following:
+```python
+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
+sur = system.slots["SLOT1"].hwmodule  # by using the slot name as key
+sur = system.slots.slot1.hwmodule  # by using the slot name as attribute
+
+# accessing the LED device
+sur.led_a.set(0,"purple")  # set the color of the LED to purple
+```
+
+For further infos on all API aspects, please see the [API Reference](https://ekfsm.readthedocs.io/en/main/reference/index.html).
+
+### CLI
+
+Upon activation of a venv provided with the ekfsm library, an entry point script `ekfsm-cli` is exported in the current shell.
+
+See `ekfsm-cli -h` for a help on the usage.
+
+
+## Resources
+
+[Documentation](https://ekfsm.readthedocs.io/en/main/)
+
+[Source Code](https://gitlab.ekf.com/libs/apis/ekfsm)
+
+[Developer Wiki](https://gitlab.ekf.com/libs/apis/ekfsm/-/wikis/home)

{ekfsm-0.12.0.post1 → ekfsm-0.13.0a160.post4}/docs/requirements.txt

@@ -1,6 +1,5 @@
 # This file was autogenerated by uv via the following command:
 #    uv export
--e .
 alabaster==1.0.0 \
     --hash=sha256:c00dca57bca26fa62a6d7d0a9fcce65f3e026e9bfe33e9c538fd3fbb2144fd9e \
     --hash=sha256:fc6786402dc3fcb2de3cabd5fe455a2db534b371124f1f21de8731783dec828b

{ekfsm-0.12.0.post1 → ekfsm-0.13.0a160.post4}/docs/source/boards/ekf/ccu.rst

@@ -5,7 +5,7 @@ EKF CCU
 ===========
 
 
-Chassis Inventory (Object: `system_inventory``)
+Chassis Inventory (Object: `system_inventory`)
 ===============================================
 
 The system inventory provides access to the chassis inventory, such as the vendor, model, serial number, and revision.
@@ -60,7 +60,7 @@ CCU Management (Object: `management`)
 +--------------------------------------------------------------+-----------------------------------------------+----------------------------------------------------+
 | :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.load_parameterset` | Load a parameterset into the CCU              | ``{"version": "1.0.0", "parameters": { ... } }``   |
 +--------------------------------------------------------------+-----------------------------------------------+----------------------------------------------------+
-| :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.restart`           | Restart the CCU                               | -                                                  |
+| :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.restart`           | Restart the CCU                               | N/A                                                |
 +--------------------------------------------------------------+-----------------------------------------------+----------------------------------------------------+
 
 
@@ -72,7 +72,7 @@ The system state controller provides method to influence the CCU's system state
 +--------------------------------------------------------+----------------------------------------+---------------+
 | Method                                                 | Description                            | Example Value |
 +--------------------------------------------------------+----------------------------------------+---------------+
-| :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.wd_trigger`  | Trigger Watchdog                       | -             |
+| :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.wd_trigger`  | Trigger Watchdog                       | N/A           |
 +--------------------------------------------------------+----------------------------------------+---------------+
 | :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.sw_shutdown` | Tell CCU that we are going to shutdown | ``50``        |
 +--------------------------------------------------------+----------------------------------------+---------------+
@@ -93,11 +93,11 @@ Fan Controller (Object: `fan`)
 Inertial Measurement Unit (Object: `imu`)
 =========================================
 
-+-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
-| Method                                                | Description              | Example Value                                                                                                                        |
-+-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
-| :meth:`~ekfsm.devices.ekf_ccu_uc.EKFCcuUc.imu_sample` | Read the next IMU sample | ``[-0.0047884033203125, -0.0143652099609375, 9.859322436523437], gyro: [-0.3662109375, -0.54931640625, 0.18310546875], lost: False`` |
-+-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
++-----------------------------------------------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+| Method                                                          | Description              | Example Value                                                                                                                               |
++-----------------------------------------------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+| :meth:`sample() <ekfsm.devices.ekf_ccu_uc.EKFCcuUc.imu_sample>` | Read the next IMU sample | ``accel: [-0.0047884033203125, -0.0143652099609375, 9.859322436523437], gyro: [-0.3662109375, -0.54931640625, 0.18310546875], lost: False`` |
++-----------------------------------------------------------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
 
 Thermal and Humidity Sensor (Object: `th`)
 ==========================================

ekfsm-0.13.0a160.post4/docs/source/boards/ekf/se5-club.rst

@@ -0,0 +1,8 @@
+================
+EKF SE5-CLUB
+================
+
+Inventory
+=========
+
+.. include:: snippets/cpci_inventory.rst

ekfsm-0.13.0a160.post4/docs/source/boards/ekf/sn4-djembe.rst

@@ -0,0 +1,8 @@
+================
+EKF SN4-DJEMBE
+================
+
+Inventory
+=========
+
+.. include:: snippets/cpci_inventory.rst

ekfsm-0.13.0a160.post4/docs/source/boards/hitron/hdrc-300s.rst

@@ -0,0 +1,63 @@
+================
+HITRON HDRC-300S
+================
+
+Inventory (Object: `inventory`)
+=================================
+
+The inventory provides access to the PSU inventory, such as the vendor, model, serial number, and revision.
+
++---------------------------------------------+-------------------+----------------------------+
+| Method                                      | Description       | Example Value              |
++---------------------------------------------+-------------------+----------------------------+
+| :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.serial`   | Get serial number | ``23450506``               |
++---------------------------------------------+-------------------+----------------------------+
+| :meth:`~ekfsm.devices.pmbus.PmBus.revision` | Get Prevision     | ``0A``                     |
++---------------------------------------------+-------------------+----------------------------+
+
+Device Temperature (Object: `th`)
+==================================
+
++---------------------------------------------------------------+---------------------+---------------+
+| Method                                                        | Description         | Example Value |
++---------------------------------------------------------------+---------------------+---------------+
+| :meth:`temperature() <ekfsm.devices.pmbus.PmBus.temp1_input>` | Get the temperature | ``-10``       |
++---------------------------------------------------------------+---------------------+---------------+
+
+Main Output (Object: `main`)
+==============================
+
+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:`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>`` |
++------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
+
+
+Standby Output (Object: `sby`)
+==============================
+
+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:`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>`` |
++------------------------------------------------------------+---------------------------+---------------------------------------------------------------+
+
+.. warning::
+    The `status()` methods only work if the debug filesystem is mounted.

{ekfsm-0.12.0.post1 → ekfsm-0.13.0a160.post4}/docs/source/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcom to EKF System Management Library documentation!
+Welcome to EKF System Management Library documentation!
 ======================================================
 
 

ekfsm-0.13.0a160.post4/ekfsm/boards/oem/ekf/se5-club.yaml

@@ -0,0 +1,41 @@
+id: 64
+name: "EKF SE5-CLUB"
+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:

ekfsm-0.13.0a160.post4/ekfsm/boards/oem/ekf/sn4-djembe.yaml

@@ -0,0 +1,41 @@
+id: 61
+name: "EKF SN4-DJEMBE"
+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:

ekfsm-0.12.0.post1/ekfsm/boards/oem/hitron/hdrc-300.yaml → ekfsm-0.13.0a160.post4/ekfsm/boards/oem/hitron/hdrc-300s.yaml

@@ -1,5 +1,5 @@
-id: HDRC300
-name: "HITRON HDRC-300"
+id: HDRC300S-110J-D120E(N)
+name: "Hitron HDRC-300S"
 slot_type: CPCI_S0_PSU
 children:
     - device_type: PmBus
@@ -15,6 +15,10 @@ children:
         main:
           - voltage: in1_input
           - current: curr1_input
+          - status: status0_input
         sby:
           - voltage: in2_input
           - current: curr2_input
+          - status: status1_input
+        th:
+          - temperature: temp1_input

{ekfsm-0.12.0.post1 → ekfsm-0.13.0a160.post4}/ekfsm/cli.py

@@ -75,9 +75,12 @@ def cli(verbose, debug, sysfs, config):
 @click.option("--revision", "-r", is_flag=False, help="Write chassis revision")
 @click.option("--model", "-m", is_flag=False, help="Write chassis model")
 @click.option("--custom", "-c", is_flag=False, help="Write chassis custom information")
-def write(serial, unit, vendor, revision, model, custom):
+@click.option("--version", "-v", is_flag=True, help="Write schema version")
+def write(serial, unit, vendor, revision, model, custom, version):
     """Write data to the system"""
     chassis = sm.ccu.chassis_inventory
+    eeprom = sm.ccu.mux.ch00.eeprom
+
     if serial:
         chassis.write_serial(serial)
     if unit:
@@ -90,6 +93,8 @@ def write(serial, unit, vendor, revision, model, custom):
         chassis.write_model(model)
     if custom:
         chassis.write_customer_area(custom)
+    if version:
+        eeprom.write_version(version)
 
 
 @cli.command()

{ekfsm-0.12.0.post1 → ekfsm-0.13.0a160.post4}/ekfsm/config.py

@@ -7,6 +7,7 @@ from typing import Any, List, Tuple
 schema_str = """
 system_config:
   name: str()
+  aggregates: map(required=False)
   slots: list(include('slot'))
 ---
 slot:

{ekfsm-0.12.0.post1 → ekfsm-0.13.0a160.post4}/ekfsm/core/components.py

@@ -11,16 +11,17 @@ if TYPE_CHECKING:
     from .slots import Slot
 
 
-class SystemComponent(NodeMixin):
+class SysTree(NodeMixin):
     """
     Base class for all system components including Hardware Modules and Devices.
     """
 
-    def __init__(self, name: str):
+    def __init__(self, name: str, abort: bool = False) -> None:
         from ekfsm.log import ekfsm_logger
 
         self.logger = ekfsm_logger(name)
         self.name = name
+        self.abort = abort
 
     def _render_tree(self) -> str:
         output = ""
@@ -35,18 +36,26 @@ class SystemComponent(NodeMixin):
         print(self)
 
 
-class HwModule(SystemComponent):
+class HwModule(SysTree):
     """
     A HwModule represents an instantiation of a specifc hw board type,
     for example an instance of an EKF SC9 board.
     """
 
-    def __init__(self, instance_name: str, config: dict, slot: Slot) -> None:
+    def __init__(
+        self,
+        instance_name: str,
+        config: dict,
+        slot: Slot,
+        abort: bool = False,
+        *args,
+        **kwargs,
+    ) -> None:
         from ekfsm.core.utils import deserialize_hardware_tree
 
         from .slots import SlotType
 
-        super().__init__(instance_name)
+        super().__init__(instance_name, abort=abort)
         self._slot: Slot = slot
         self.config = config