shepherd-core 2024.4.1__py3-none-any.whl → 2024.5.1__py3-none-any.whl

shepherd_core/data_models/content/virtual_harvester_fixture.yaml

@@ -0,0 +1,160 @@
+# info:
+# - compendium of all parameters & description
+# - look into the implementation to see which parameters are used
+# - base for neutral fallback values if provided yml is sparse
+# - -> it is encouraged to omit redundant parameters in your own implementation
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1000
+    name: neutral
+    owner: Ingmar
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    created: 2022-12-12 12:12:12
+    updated_last: 2022-12-12 12:12:12
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1010
+    name: ivcurve
+    description: Postpone harvesting by sampling ivcurves (voltage stepped as sawtooth-wave)
+    comment: ~200 Hz
+    inherit_from: neutral
+    algorithm: ivcurve
+    samples_n: 250
+    voltage_min_mV: 0
+    voltage_max_mV: 5000
+    wait_cycles: 1  # results in 200 Hz (= 100kHz /(2*250))
+    rising: false # downward sawtooth seems to have advantages for solar cells
+    # todo: also add switch for sawtooth- vs triangle-wave?
+    # todo: could also include a version with dynamic upper-boundary, varied if voc is reached very early
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1011
+    name: ivcurves  # synonym
+    inherit_from: ivcurve
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1012
+    name: iv1000
+    comment: Name relates to curves per second
+    inherit_from: ivcurve
+    samples_n: 100
+    wait_cycles: 0
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1013
+    name: iv110
+    comment: Between 50 & 60 Hz line-frequency to avoid standing waves
+    inherit_from: ivcurve
+    samples_n: 909
+    wait_cycles: 0
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1020
+    name: isc_voc
+    description: Postpone harvesting by sampling short circuit current & open circuit voltage
+    inherit_from: neutral
+    algorithm: isc_voc
+    wait_cycles: 1  # results in 25 kHz (isc, wait, voc, wait)
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1030
+    name: cv20
+    description: Harvesting with constant Voltage
+    inherit_from: neutral
+    algorithm: cv
+    voltage_mV: 2000
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1031
+    name: cv24
+    inherit_from: cv20
+    voltage_mV: 2400
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1032
+    name: cv33
+    inherit_from: cv20
+    voltage_mV: 3300
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1032
+    name: cv10
+    inherit_from: cv20
+    voltage_mV: 1000
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1040
+    name: mppt_voc
+    description: MPPT based on open circuit voltage for solar
+    inherit_from: neutral
+    algorithm: mppt_voc
+    setpoint_n: 0.76
+    interval_ms: 100     # between measurements
+    duration_ms: 1.2     # solar can overshoot when load is removed
+    current_limit_uA: 5  # boundary for detecting open circuit in emulated version (working on IV-Curves)
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1041
+    name: mppt_bq
+    description: MPPT of TI BQ-Converters for solar
+    inherit_from: mppt_voc
+    setpoint_n: 0.76
+    interval_ms: 16000  # between measurements
+    duration_ms: 256    # of measurement
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1042
+    name: mppt_bqt
+    description: MPPT of TI BQ-Converters for thermoelectric
+    inherit_from: mppt_voc
+    setpoint_n: 0.50
+    interval_ms: 16000  # between measurements
+    duration_ms: 256    # of measurement
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1043
+    name: mppt_bq_solar # explicit naming
+    inherit_from: mppt_bq
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1044
+    name: mppt_bq_thermoelectric # explicit naming
+    inherit_from: mppt_bqt
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1045
+    name: mppt_po
+    description: MPPT based on perturb & observe algorithm
+    inherit_from: neutral
+    algorithm: mppt_po
+    voltage_min_mV: 0
+    voltage_max_mV: 5000
+    voltage_step_mV: 10
+    interval_ms: 18   # between steps
+
+- datatype: VirtualHarvesterConfig
+  parameters:
+    id: 1046
+    name: mppt_opt
+    description: Power-Optimum with very fast PO-Variant (harvesting) or special max-pwr-picker (emulator / ivcurve)
+    inherit_from: mppt_po
+    algorithm: mppt_opt
+    voltage_step_mV: 1
+    interval_ms: 0.01

shepherd_core/data_models/content/virtual_source.py

@@ -1,3 +1,5 @@
+"""Generalized virtual source data models."""
+
 from typing import List
 
 from pydantic import Field
@@ -8,8 +10,8 @@ from typing_extensions import Self
 from ...commons import samplerate_sps_default
 from ...logger import logger
 from ...testbed_client import tb_client
-from .. import ShpModel
 from ..base.content import ContentModel
+from ..base.shepherd import ShpModel
 from .virtual_harvester import HarvesterPRUConfig
 from .virtual_harvester import VirtualHarvesterConfig
 
@@ -21,9 +23,11 @@ LUT2D = Annotated[List[LUT1D], Field(min_length=LUT_SIZE, max_length=LUT_SIZE)]
 
 
 class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
-    """The virtual Source uses the energy environment (file)
-    for supplying the Target Node during the experiment.
-    If not already done, the energy will be harvested and then converted.
+    """The vSrc uses the energy environment (file) for supplying the Target Node.
+
+    If not already done, the energy will be harvested and
+    then converted during the experiment.
+
     The converter-stage is software defined and offers:
     - buck-boost-combinations,
     - a simple diode + resistor and
@@ -117,9 +121,15 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
         return self
 
     def calc_internal_states(self) -> dict:
-        """Compensate for (hard to detect) current-surge of real capacitors
-        when converter gets turned on -> this can be const value, because
-        the converter always turns on with "V_storage_enable_threshold_uV"
+        """Update the model-states for the capacitor and other elements.
+
+        This also compensates for current-surge of real capacitors
+        when the converter gets turned on:
+
+        - surges are hard to detect & record
+        - this can be const value, because
+        - the converter always turns on with "V_storage_enable_threshold_uV".
+
         TODO: currently neglecting delay after disabling converter, boost
         only has simpler formula, second enabling when V_Cap >= V_out
 
@@ -189,7 +199,7 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
         return values
 
     def calc_converter_mode(self, *, log_intermediate_node: bool) -> int:
-        """Assembles bitmask from discrete values
+        """Assembles bitmask from discrete values.
 
         log_intermediate_node: record / log virtual intermediate (cap-)voltage and
         -current (out) instead of output-voltage and -current
@@ -204,7 +214,8 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
         )
 
     def calc_cap_constant_us_per_nF_n28(self) -> int:
-        """Calc constant to convert capacitor-current to Voltage-delta
+        """Calc constant to convert capacitor-current to Voltage-delta.
+
         dV[uV] = constant[us/nF] * current[nA] = constant[us*V/nAs] * current[nA]
         """
         C_cap_uF = max(self.C_intermediate_uF, 0.001)
@@ -224,7 +235,8 @@ lut_o = Annotated[List[u32], Field(min_length=LUT_SIZE, max_length=LUT_SIZE)]
 
 
 class ConverterPRUConfig(ShpModel):
-    """Map settings-list to internal state-vars struct ConverterConfig
+    """Map settings-list to internal state-vars struct ConverterConfig.
+
     NOTE:
       - yaml is based on si-units like nA, mV, ms, uF
       - c-code and py-copy is using nA, uV, ns, nF, fW, raw

shepherd_core/data_models/content/virtual_source_fixture.yaml

@@ -0,0 +1,230 @@
+# info:
+# - compendium of all parameters & description
+# - base for neutral fallback values if provided yml is sparse
+# - -> it is encouraged to omit redundant parameters
+---
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1000
+    name: neutral
+    description: Direct feed-through of energy environment with no converter (allows on-off-patters)
+    # General Config
+    enable_boost: false # if false -> v_intermediate = v_input, output-switch-hysteresis is still usable
+    enable_buck: false # if false -> v_output = v_intermediate
+
+    interval_startup_delay_drain_ms: 0
+
+    harvester:
+      name: mppt_opt # harvester only active if input is "ivcurves"
+
+    V_input_max_mV: 10000
+    I_input_max_mA: 4200
+    V_input_drop_mV: 0.0  # simulate input-diode
+    R_input_mOhm: 0.0  # resistance only active with disabled boost, range [1 mOhm; 1MOhm]
+
+    C_intermediate_uF: 0.0  # primary storage-Cap
+    V_intermediate_init_mV: 3000 # allow a proper / fast startup
+    I_intermediate_leak_nA: 0.0
+
+    V_intermediate_enable_threshold_mV: 1 # -> target gets connected (hysteresis-combo with next value)
+    V_intermediate_disable_threshold_mV: 0 # -> target gets disconnected
+    interval_check_thresholds_ms: 0.0  # some BQs check every 64 ms if output should be disconnected
+
+    V_pwr_good_enable_threshold_mV: 2800 # target is informed by pwr-good on output-pin (hysteresis) -> for intermediate voltage
+    V_pwr_good_disable_threshold_mV: 2200
+    immediate_pwr_good_signal: true  # 1: activate instant schmitt-trigger, 0: stay in interval for checking thresholds
+
+    C_output_uF: 1.0   # final (always last) stage to compensate undetectable current spikes when enabling power for target
+
+    # Extra
+    V_output_log_gpio_threshold_mV: 1400  # min voltage needed to enable recording changes in gpio-bank
+
+    # Boost Converter
+    V_input_boost_threshold_mV: 0.0 # min input-voltage for the boost converter to work
+    V_intermediate_max_mV: 10000 # -> boost converter shuts off
+
+    LUT_input_efficiency: [
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ], # rows are current -> here a[V=0][:]
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+      [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ],
+    ] # input-array[12][12] depending on array[inp_voltage][log(inp_current)], influence of cap-voltage is not implemented
+    LUT_input_V_min_log2_uV: 0 # 2^7 = 128 uV -> array[0] is for inputs < 128 uV
+    LUT_input_I_min_log2_nA: 0 # 2^8 = 256 nA -> array[0] is for inputs < 256 nA
+
+    # Buck-converter
+    V_output_mV: 2400
+    V_buck_drop_mV: 0.0  # simulate LDO min voltage differential or output-diode
+
+    LUT_output_efficiency: [ 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00, 1.00 ] # array[12] depending on output_current
+    LUT_output_I_min_log2_nA: 0  # 2^8 = 256 nA -> array[0] is for inputs < 256 nA, see notes on LUT_input for explanation
+
+    owner: Ingmar
+    group: NES Lab
+    visible2group: true
+    visible2all: true
+    created: 2022-12-12 12:12:12
+    updated_last: 2022-12-12 12:12:12
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1010
+    name: direct
+    inherit_from: neutral
+    # Note: current input has no influence
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1011
+    name: diode+capacitor
+    description: Simple Converter based on diode and buffer capacitor
+    inherit_from: neutral
+    V_input_drop_mV: 300  # simulate input-diode
+    C_intermediate_uF: 10  # primary storage-Cap
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1012
+    name: dio_cap # simpler naming
+    inherit_from: diode+capacitor
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1013
+    name: diode+resistor+capacitor
+    description: Simple Converter based on diode, current limiting resistor and buffer capacitor
+    inherit_from: diode+capacitor
+    R_input_mOhm: 10000
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1014
+    name: dio_res_cap # simpler naming
+    inherit_from: diode+resistor+capacitor
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1020
+    name: BQ25504
+    description: TI BQ25504 with integrated boost-converter
+    inherit_from: neutral # to complete undefined vars
+    enable_boost: true # if false -> v_intermediate = v_input, output-switch-hysteresis is still usable
+
+    harvester:
+      name: mppt_bq_solar # harvester only active if input is "ivcurves"
+
+    V_input_max_mV: 3000
+    I_input_max_mA: 100
+
+    C_intermediate_uF: 22.0  # primary storage-Cap
+    V_intermediate_init_mV: 3000 # allow a proper / fast startup
+    I_intermediate_leak_nA: 330
+
+    V_intermediate_enable_threshold_mV: 2600 # -> target gets connected (hysteresis-combo with next value)
+    V_intermediate_disable_threshold_mV: 2300 # -> target gets disconnected
+    interval_check_thresholds_ms: 64.0  # some BQs check every 64 ms if output should be disconnected
+
+    V_pwr_good_enable_threshold_mV: 2800 # target is informed by pwr-good on output-pin (hysteresis) -> for intermediate voltage
+    V_pwr_good_disable_threshold_mV: 2400
+    immediate_pwr_good_signal: false  # 1: activate instant schmitt-trigger, 0: stay in interval for checking thresholds
+
+    # Boost Converter
+    V_input_boost_threshold_mV: 130 # min input-voltage for the boost converter to work
+    V_intermediate_max_mV: 3600 # -> boost converter shuts off
+
+    LUT_input_efficiency: [
+      # <8uA  8uA   16uA  32uA  64uA  128uA 256uA 512uA 1mA   2mA   4mA   >8mA
+      [ 0.01, 0.01, 0.02, 0.05, 0.10, 0.15, 0.15, 0.20, 0.25, 0.30, 0.30, 0.35 ], # < 128 mV
+      [ 0.10, 0.20, 0.30, 0.40, 0.50, 0.55, 0.56, 0.57, 0.58, 0.59, 0.60, 0.61 ], # > 128 mV, ~200
+      [ 0.20, 0.40, 0.50, 0.60, 0.65, 0.66, 0.67, 0.68, 0.69, 0.70, 0.71, 0.72 ], # > 256 mV, ~320
+      [ 0.35, 0.55, 0.65, 0.71, 0.73, 0.74, 0.75, 0.75, 0.76, 0.77, 0.77, 0.78 ], # > 384 mV, ~450
+      [ 0.45, 0.65, 0.70, 0.73, 0.75, 0.77, 0.78, 0.79, 0.80, 0.81, 0.81, 0.82 ], # > 512 mV, ~570
+      [ 0.50, 0.70, 0.74, 0.76, 0.78, 0.79, 0.80, 0.81, 0.82, 0.83, 0.83, 0.84 ], # > 640 mV
+      [ 0.52, 0.73, 0.76, 0.78, 0.80, 0.81, 0.82, 0.83, 0.84, 0.85, 0.85, 0.86 ], # > 768 mV
+      [ 0.53, 0.75, 0.77, 0.79, 0.81, 0.82, 0.83, 0.84, 0.85, 0.86, 0.86, 0.87 ], # > 896 mV
+      [ 0.55, 0.77, 0.78, 0.80, 0.82, 0.83, 0.85, 0.86, 0.87, 0.87, 0.87, 0.88 ], # > 1024 mV
+      [ 0.56, 0.78, 0.79, 0.81, 0.83, 0.85, 0.87, 0.88, 0.88, 0.88, 0.88, 0.89 ], # > 1152 mV
+      [ 0.58, 0.79, 0.80, 0.82, 0.84, 0.86, 0.88, 0.89, 0.89, 0.89, 0.89, 0.90 ], # > 1280 mV
+      [ 0.60, 0.80, 0.81, 0.83, 0.85, 0.87, 0.89, 0.90, 0.90, 0.90, 0.90, 0.90 ], # > 1408 mV
+    ] # input-array[12][12] depending on array[inp_voltage][log(inp_current)], influence of cap-voltage is not implemented
+    LUT_input_V_min_log2_uV: 17 # example: 2^7 = 128 uV -> array[0] is for inputs < 128 uV
+    LUT_input_I_min_log2_nA: 13 # example: 2^8 = 256 nA -> array[0] is for inputs < 256 nA
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1021
+    name: BQ25504s # Version with Schmitt-Trigger
+    description: TI BQ25504 with Schmitt-Trigger for a faster power-good-signal
+    inherit_from: BQ25504
+    immediate_pwr_good_signal: true
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1022
+    name: BQ25504-Schmitt
+    inherit_from: BQ25504s
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1030
+    name: BQ25570
+    description: TI BQ25570 with integrated boost- & buck-converter
+    inherit_from: BQ25504 # inherit Input-LUT that is similar enough
+    enable_boost: true # if false -> v_intermediate = v_input, output-switch-hysteresis is still usable
+    enable_buck: true # if false -> v_output = v_intermediate
+
+    V_input_max_mV: 5100
+    I_input_max_mA: 100
+
+    C_intermediate_uF: 33.0  # primary storage-Cap
+    V_intermediate_init_mV: 3400 # allow a proper / fast startup
+    I_intermediate_leak_nA: 0.0
+
+    V_intermediate_enable_threshold_mV: 3000 # -> target gets connected (hysteresis-combo with next value)
+    V_intermediate_disable_threshold_mV: 2400 # -> target gets disconnected
+    interval_check_thresholds_ms: 64.0  # some BQs check every 64 ms if output should be disconnected
+
+    V_pwr_good_enable_threshold_mV: 3000 # target is informed by pwr-good on output-pin (hysteresis) -> for intermediate voltage
+    V_pwr_good_disable_threshold_mV: 2500
+    immediate_pwr_good_signal: false  # 1: activate instant schmitt-trigger, 0: stay in interval for checking thresholds
+
+    C_output_uF: 1.0   # final (always last) stage to compensate undetectable current spikes when enabling power for target
+
+    # Boost Converter
+    V_input_boost_threshold_mV: 100.0 # min input-voltage for the boost converter to work
+    V_intermediate_max_mV: 5500 # -> boost converter shuts off
+
+    # Buck Converter
+    V_output_mV: 2200
+    V_buck_drop_mV: 200.0  # simulate LDO min voltage differential or output-diode
+
+    #                        <1u   1u    2u    4u    8u    16u   32u   64u   128u  256u  512u  >1m
+    LUT_output_efficiency: [ 0.40, 0.50, 0.60, 0.73, 0.82, 0.86, 0.88, 0.90, 0.91, 0.92, 0.93, 0.92] # array[12] depending on output_current
+    LUT_output_I_min_log2_nA: 10  # example: 2^8 = 256 nA -> array[0] is for inputs < 256 nA, see notes on LUT_input for explanation
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1031
+    name: BQ25570s
+    description: TI BQ25570 with Schmitt-Trigger for a faster power-good-signal
+    inherit_from: BQ25570
+    immediate_pwr_good_signal: true
+
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1032
+    name: BQ25570-Schmitt
+    inherit_from: BQ25570s
+- datatype: VirtualSourceConfig
+  parameters:
+    id: 1033
+    name: default
+    inherit_from: BQ25570s

shepherd_core/data_models/experiment/__init__.py

@@ -1,4 +1,8 @@
-from ..testbed.cape import TargetPort
+"""Module for experiment related data-models.
+
+These models import externally from: /base, /content, /testbed.
+"""
+
 from .experiment import Experiment
 from .observer_features import GpioActuation
 from .observer_features import GpioEvent
@@ -8,8 +12,6 @@ from .observer_features import PowerTracing
 from .observer_features import SystemLogging
 from .target_config import TargetConfig
 
-# these models import externally from: /base, /content, /testbed
-
 __all__ = [
     "Experiment",
     "TargetConfig",
@@ -21,5 +23,4 @@ __all__ = [
     "SystemLogging",
     # Enums
     "GpioLevel",
-    "TargetPort",
 ]

shepherd_core/data_models/experiment/experiment.py

@@ -1,3 +1,5 @@
+"""Config for testbed experiments."""
+
 from datetime import datetime
 from datetime import timedelta
 from typing import List
@@ -22,12 +24,10 @@ from .target_config import TargetConfig
 
 
 class Experiment(ShpModel, title="Config of an Experiment"):
-    """Configuration for Experiments on the Shepherd-Testbed
-    emulating Energy Environments for Target Nodes
-    """
+    """Config for experiments on the testbed emulating energy environments for target nodes."""
 
     # General Properties
-    # id: UUID4 ... # TODO db-migration - temp fix for documentation
+    # id: UUID4 ... # TODO: db-migration - temp fix for documentation
     id: Union[UUID4, int] = Field(default_factory=uuid4)
     # ⤷ TODO: automatic ID is problematic for identification by hash
 
@@ -90,7 +90,7 @@ class Experiment(ShpModel, title="Config of an Experiment"):
         obs_ids = [testbed.get_observer(_id).id for _id in target_ids]
         if len(target_ids) > len(set(obs_ids)):
             raise ValueError(
-                "Observer used more than once in Experiment -> only 1 target per observer!"
+                "Observer is used more than once in Experiment -> only 1 target per observer!"
             )
 
     def get_target_ids(self) -> list:
@@ -101,4 +101,5 @@ class Experiment(ShpModel, title="Config of an Experiment"):
             if target_id in _config.target_IDs:
                 return _config
         # gets already caught in target_config - but keep:
-        raise ValueError(f"Target-ID {target_id} was not found in Experiment '{self.name}'")
+        msg = f"Target-ID {target_id} was not found in Experiment '{self.name}'"
+        raise ValueError(msg)

shepherd_core/data_models/experiment/observer_features.py

@@ -1,3 +1,5 @@
+"""Configs for observer features like gpio- & power-tracing."""
+
 from datetime import timedelta
 from enum import Enum
 from typing import List
@@ -15,7 +17,8 @@ from ..testbed.gpio import GPIO
 
 
 class PowerTracing(ShpModel, title="Config for Power-Tracing"):
-    """Configuration for recording the Power-Consumption of the Target Nodes
+    """Configuration for recording the Power-Consumption of the Target Nodes.
+
     TODO: postprocessing not implemented ATM
     """
 
@@ -45,12 +48,13 @@ class PowerTracing(ShpModel, title="Config for Power-Tracing"):
         if not self.calculate_power and discard_all:
             raise ValueError("Error in config -> tracing enabled, but output gets discarded")
         if self.calculate_power:
-            raise ValueError("postprocessing not implemented ATM")
+            raise NotImplementedError("postprocessing not implemented ATM")
         return self
 
 
 class GpioTracing(ShpModel, title="Config for GPIO-Tracing"):
-    """Configuration for recording the GPIO-Output of the Target Nodes
+    """Configuration for recording the GPIO-Output of the Target Nodes.
+
     TODO: postprocessing not implemented ATM
     """
 
@@ -84,13 +88,15 @@ class GpioTracing(ShpModel, title="Config for GPIO-Tracing"):
 
 
 class GpioLevel(str, Enum):
+    """Options for setting the gpio-level or state."""
+
     low = "L"
     high = "H"
     toggle = "X"  # TODO: not the smartest decision for writing a converter
 
 
 class GpioEvent(ShpModel, title="Config for a GPIO-Event"):
-    """Configuration for a single GPIO-Event (Actuation)"""
+    """Configuration for a single GPIO-Event (Actuation)."""
 
     delay: PositiveFloat
     # ⤷ from start_time
@@ -104,7 +110,8 @@ class GpioEvent(ShpModel, title="Config for a GPIO-Event"):
     @model_validator(mode="after")
     def post_validation(self) -> Self:
         if not self.gpio.user_controllable():
-            raise ValueError(f"GPIO '{self.gpio.name}' in actuation-event not controllable by user")
+            msg = f"GPIO '{self.gpio.name}' in actuation-event not controllable by user"
+            raise ValueError(msg)
         return self
 
     def get_events(self) -> np.ndarray:
@@ -113,7 +120,7 @@ class GpioEvent(ShpModel, title="Config for a GPIO-Event"):
 
 
 class GpioActuation(ShpModel, title="Config for GPIO-Actuation"):
-    """Configuration for a GPIO-Actuation-Sequence"""
+    """Configuration for a GPIO-Actuation-Sequence."""
 
     # TODO: not implemented ATM - decide if pru control sys-gpio or
     # TODO: not implemented ATM - reverses pru-gpio (preferred if possible)
@@ -125,7 +132,7 @@ class GpioActuation(ShpModel, title="Config for GPIO-Actuation"):
 
 
 class SystemLogging(ShpModel, title="Config for System-Logging"):
-    """Configuration for recording Debug-Output of the Observers System-Services"""
+    """Configuration for recording Debug-Output of the Observers System-Services."""
 
     dmesg: bool = True
     ptp: bool = True

shepherd_core/data_models/experiment/target_config.py

@@ -1,3 +1,5 @@
+"""Configuration related to Target Nodes (DuT)."""
+
 from typing import List
 from typing import Optional
 
@@ -19,7 +21,7 @@ from .observer_features import PowerTracing
 
 
 class TargetConfig(ShpModel, title="Target Config"):
-    """Configuration for Target Nodes (DuT)"""
+    """Configuration related to Target Nodes (DuT)."""
 
     target_IDs: Annotated[List[IdInt], Field(min_length=1, max_length=128)]
     custom_IDs: Optional[Annotated[List[IdInt16], Field(min_length=1, max_length=128)]] = None
@@ -44,7 +46,8 @@ class TargetConfig(ShpModel, title="Target Config"):
     @model_validator(mode="after")
     def post_validation(self) -> Self:
         if not self.energy_env.valid:
-            raise ValueError(f"EnergyEnv '{self.energy_env.name}' for target must be valid")
+            msg = f"EnergyEnv '{self.energy_env.name}' for target must be valid"
+            raise ValueError(msg)
         for _id in self.target_IDs:
             target = Target(id=_id)
             for mcu_num in [1, 2]:
@@ -56,24 +59,25 @@ class TargetConfig(ShpModel, title="Target Config"):
                     fw_def = Firmware(name=tgt_mcu.fw_name_default)
                     # ⤷ this will raise if default is faulty
                     if tgt_mcu.id != fw_def.mcu.id:
-                        raise ValueError(
+                        msg = (
                             f"Default-Firmware for MCU{mcu_num} of Target-ID '{target.id}' "
                             f"(={fw_def.mcu.name}) "
                             f"is incompatible (={tgt_mcu.name})"
                         )
+                        raise ValueError(msg)
                 if has_fw and has_mcu and val_fw.mcu.id != tgt_mcu.id:
-                    raise ValueError(
+                    msg = (
                         f"Firmware{mcu_num} for MCU of Target-ID '{target.id}' "
                         f"(={val_fw.mcu.name}) "
                         f"is incompatible (={tgt_mcu.name})"
                     )
+                    raise ValueError(msg)
 
         c_ids = self.custom_IDs
         t_ids = self.target_IDs
         if c_ids is not None and (len(set(c_ids)) < len(set(t_ids))):
-            raise ValueError(
-                f"Provided custom IDs {c_ids} not enough to cover target range {t_ids}"
-            )
+            msg = f"Provided custom IDs {c_ids} not enough to cover target range {t_ids}"
+            raise ValueError(msg)
         # TODO: if custom ids present, firmware must be ELF
         return self