shepherd-core 2025.4.2__tar.gz → 2025.5.3__tar.gz

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shepherd_core
-Version: 2025.4.2
+Version: 2025.5.3
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Author-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>
 Maintainer-email: Ingmar Splitt <ingmar.splitt@tu-dresden.de>

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/examples/experiment_generic_var1.py

@@ -15,13 +15,8 @@ What the code does:
 
 from pathlib import Path
 
+import shepherd_core.data_models as sm
 from shepherd_core import WebClient
-from shepherd_core.data_models import FirmwareDType
-from shepherd_core.data_models import GpioTracing
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.experiment import TargetConfig
 from shepherd_core.data_models.task import TestbedTasks
 from shepherd_core.data_models.testbed import MCU
 
@@ -34,28 +29,26 @@ do_connect = False
 if do_connect:
     WebClient()
 
-xp = Experiment(
+xp = sm.Experiment(
     id="4567",
     name="meaningful_TestName",
     # time_start could be "2033-03-13 14:15:16" or "datetime.now() + timedelta(minutes=30)"
     duration=30,
     target_configs=[
-        TargetConfig(
+        sm.TargetConfig(
             target_IDs=range(7, 12),
             custom_IDs=range(1, 100),  # note: longer list is OK
-            energy_env=EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
-            firmware1=Firmware(
+            energy_env=sm.EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
+            firmware1=sm.Firmware(
                 name="FW_TestXYZ",
                 data=Path("/var/shepherd/content/fw/nes_lab/nrf52_demo_rf/build.elf"),
-                data_type=FirmwareDType.path_elf,
+                data_type=sm.FirmwareDType.path_elf,
                 data_local=False,
                 mcu=MCU(name="nRF52"),
             ),
             power_tracing=None,
-            gpio_tracing=GpioTracing(
-                uart_decode=True,  # enables logging uart from userspace
-                uart_baudrate=115_200,
-            ),
+            gpio_tracing=sm.GpioTracing(),
+            uart_logging=sm.UartLogging(baudrate=115_200),
         ),
     ],
 )

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/examples/experiment_generic_var2.py

@@ -14,12 +14,8 @@
 
 from pathlib import Path
 
+import shepherd_core.data_models as sm
 from shepherd_core import WebClient
-from shepherd_core.data_models import GpioTracing
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.experiment import TargetConfig
 from shepherd_core.data_models.task import TestbedTasks
 
 # For online-queries the lib can be connected to the testbed-server.
@@ -31,24 +27,21 @@ do_connect = False
 if do_connect:
     WebClient()
 
-xp = Experiment(
+xp = sm.Experiment(
     id="4567",
     name="meaningful_TestName",
     # time_start could be "2033-03-13 14:15:16" or "datetime.now() + timedelta(minutes=30)"
     duration=30,
     target_configs=[
-        TargetConfig(
+        sm.TargetConfig(
             target_IDs=range(7, 12),
             custom_IDs=range(1, 100),  # note: longer list is OK
-            energy_env=EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
-            firmware1=Firmware.from_firmware(
+            energy_env=sm.EnergyEnvironment(name="eenv_static_3000mV_50mA_3600s"),
+            firmware1=sm.Firmware.from_firmware(
                 file=Path("./firmware_nrf.elf").absolute(),
             ),
             power_tracing=None,
-            gpio_tracing=GpioTracing(
-                uart_decode=True,  # enables logging uart from userspace
-                uart_baudrate=115_200,
-            ),
+            gpio_tracing=sm.GpioTracing(),
         ),
     ],
 )

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/examples/experiment_models.py

@@ -18,17 +18,12 @@ How to define an experiment:
 
 """
 
+import shepherd_core.data_models as sm
 from shepherd_core import WebClient
-from shepherd_core.data_models.content import EnergyEnvironment
-from shepherd_core.data_models.content import Firmware
-from shepherd_core.data_models.content import VirtualHarvesterConfig
-from shepherd_core.data_models.content import VirtualSourceConfig
-from shepherd_core.data_models.experiment import Experiment
-from shepherd_core.data_models.experiment import TargetConfig
 from shepherd_core.data_models.task import TestbedTasks
 
 # generate description for all parameters -> base for web-forms
-Experiment.schema_to_file("experiment_schema.yaml")
+sm.Experiment.schema_to_file("experiment_schema.yaml")
 
 # For online-queries the lib can be connected to the testbed-server.
 # NOTE: there are 3 states:
@@ -40,11 +35,11 @@ if do_connect:
     WebClient()
 
 # Defining an Experiment in Python
-hrv = VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
+hrv = sm.VirtualHarvesterConfig(name="mppt_bq_thermoelectric")
 
 target_cfgs = [
     # first Instance similar to yaml-syntax
-    TargetConfig(
+    sm.TargetConfig(
         target_IDs=[9, 10, 11],
         custom_IDs=[0, 1, 2],
         energy_env={"name": "SolarSunny"},
@@ -52,17 +47,17 @@ target_cfgs = [
         firmware1={"name": "nrf52_demo_rf"},
     ),
     # second Instance fully object-oriented (recommended)
-    TargetConfig(
+    sm.TargetConfig(
         target_IDs=list(range(1, 5)),
         custom_IDs=list(range(7, 18)),  # note: longer list is OK
-        energy_env=EnergyEnvironment(name="ThermoelectricWashingMachine"),
-        virtual_source=VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
-        firmware1=Firmware(name="nrf52_demo_rf"),
-        firmware2=Firmware(name="msp430_deep_sleep"),
+        energy_env=sm.EnergyEnvironment(name="ThermoelectricWashingMachine"),
+        virtual_source=sm.VirtualSourceConfig(name="BQ25570-Schmitt", harvester=hrv),
+        firmware1=sm.Firmware(name="nrf52_demo_rf"),
+        firmware2=sm.Firmware(name="msp430_deep_sleep"),
     ),
 ]
 
-xperi1 = Experiment(
+xperi1 = sm.Experiment(
     id="4567",
     name="meaningful Test-Name",
     time_start="2033-03-13 14:15:16",  # or: datetime.now() + timedelta(minutes=30)
@@ -71,12 +66,12 @@ xperi1 = Experiment(
 
 # Safe, reload and compare content
 xperi1.to_file("experiment_from_py.yaml", minimal=False)
-xperi2 = Experiment.from_file("experiment_from_py.yaml")
+xperi2 = sm.Experiment.from_file("experiment_from_py.yaml")
 print(f"xp1 hash: {xperi1.get_hash()}")
 print(f"xp2 hash: {xperi2.get_hash()}")
 
 # comparison to same config (in yaml) fails due to internal variables, BUT:
-xperi3 = Experiment.from_file("experiment_from_yaml.yaml")
+xperi3 = sm.Experiment.from_file("experiment_from_yaml.yaml")
 print(f"xp3 hash: {xperi3.get_hash()} (won't match)")
 
 # Create a tasks-list for the testbed

shepherd_core-2025.5.3/examples/inventory.py

@@ -0,0 +1,20 @@
+"""Shows how to use inventory functionality."""
+
+from pathlib import Path
+
+import shepherd_core.inventory as si
+
+pyt_inv = si.PythonInventory.collect()
+print(f"PyInv: {pyt_inv}")
+sys_inv = si.SystemInventory.collect()
+print(f"SysInv: {sys_inv}")
+tgt_inv = si.TargetInventory.collect()
+print(f"TgtInv: {tgt_inv}")
+
+
+inv = si.Inventory.collect()
+print(f"Complete Inventory: {inv}")
+inv.to_file("inventory.yaml", minimal=True, comment="just a test")
+
+inl = si.InventoryList(elements=[inv])
+inl.to_csv(Path(__file__).parent / "inventory.csv")

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/examples/simulate_vharvester.py

@@ -1,6 +1,6 @@
 """Demonstrate behavior of Virtual Harvester Algorithms.
 
-- simulation is based on ivsamples derived from a solar-isc-voc-recording during a jogging-trip
+- simulation is based on IVTrace derived from a solar-isc-voc-recording during a jogging-trip
 - harvesting is done by various algorithms and preconfigured virtual harvesters
 - results are printed on console (harvested energy)
 
@@ -44,13 +44,13 @@ save_files: bool = False
 # convert IVonne to IVCurve
 if not file_ivcurve.exists():
     with ivonne.Reader(file_ivonne) as db:
-        db.convert_2_ivcurves(file_ivcurve, duration_s=sim_duration)
+        db.convert_2_ivsurface(file_ivcurve, duration_s=sim_duration)
 
 # Input Statistics
 with Reader(file_ivcurve, verbose=False) as file:
     window_size = file.get_window_samples()
     I_in_max = 0.0
-    for _t, _v, _i in file.read_buffers():
+    for _t, _v, _i in file.read():
         I_in_max = max(I_in_max, _i.max())
     print(
         f"Input-file: \n"

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/shepherd_core/data_models/__init__.py

@@ -31,6 +31,7 @@ from .experiment.observer_features import GpioLevel
 from .experiment.observer_features import GpioTracing
 from .experiment.observer_features import PowerTracing
 from .experiment.observer_features import SystemLogging
+from .experiment.observer_features import UartLogging
 from .experiment.target_config import TargetConfig
 
 __all__ = [
@@ -54,6 +55,7 @@ __all__ = [
     "ShpModel",
     "SystemLogging",
     "TargetConfig",
+    "UartLogging",
     "VirtualHarvesterConfig",
     "VirtualSourceConfig",
     "Wrapper",

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/shepherd_core/data_models/base/content.py

@@ -1,21 +1,16 @@
 """Base-Model for all content."""
 
-import hashlib
 from datetime import datetime
 from typing import Annotated
 from typing import Optional
-from typing import Union
 from uuid import uuid4
 
-from pydantic import UUID4
 from pydantic import Field
 from pydantic import StringConstraints
 from pydantic import model_validator
 from typing_extensions import Self
-from typing_extensions import deprecated
 
 from .shepherd import ShpModel
-from .timezone import local_now
 
 # constr -> to_lower=True, max_length=16, regex=r"^[\w]+$"
 # ⤷ Regex = AlphaNum
@@ -26,24 +21,20 @@ SafeStr = Annotated[str, StringConstraints(pattern=r"^[ -~]+$")]
 # ⤷ Regex = All Printable ASCII-Characters with Space
 
 
-@deprecated("use UUID4 instead")
 def id_default() -> int:
     """Generate a unique ID - usable as default value.
 
-    Note: IdInt has space for 128 bit, so 128/4 = 32 hex-chars
+    Note: IdInt in mongoDB can currently handle 8 bytes (16 hex-values)
     """
-    time_stamp = str(local_now()).encode("utf-8")
-    time_hash = hashlib.sha3_224(time_stamp).hexdigest()[-32:]
-    return int(time_hash, 16)
+    return int(uuid4().hex[-15:], 16)
 
 
 class ContentModel(ShpModel):
     """Base-Model for content with generalized properties."""
 
-    # id: UUID4 = Field(  # TODO: db-migration - temp fix for documentation
-    id: Union[UUID4, int] = Field(
+    id: int = Field(
         description="Unique ID",
-        default_factory=uuid4,
+        default_factory=id_default,
     )
     name: NameStr
     description: Annotated[Optional[SafeStr], Field(description="Required when public")] = None

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/shepherd_core/data_models/content/_external_fixtures.yaml

@@ -1,7 +1,7 @@
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.488609+02:00
+  created: 2025-05-12 17:28:39.756999+02:00
   parameters:
-    id: 2639560972524229652
+    id: 263956097252422
     name: eenv_static_2000mV_10mA_3600s
     description: Artificial static Energy Environment, 2000mV, 10mA, 3600s
     comment: null
@@ -22,9 +22,9 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.497654+02:00
+  created: 2025-05-12 17:28:39.764595+02:00
   parameters:
-    id: 9823394105967169626
+    id: 98233941059
     name: eenv_static_2000mV_1mA_3600s
     description: Artificial static Energy Environment, 2000mV, 1mA, 3600s
     comment: null
@@ -45,9 +45,9 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.506739+02:00
+  created: 2025-05-12 17:28:39.772144+02:00
   parameters:
-    id: 3900615675169501222
+    id: 39006156751
     name: eenv_static_2000mV_50mA_3600s
     description: Artificial static Energy Environment, 2000mV, 50mA, 3600s
     comment: null
@@ -68,9 +68,9 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.515790+02:00
+  created: 2025-05-12 17:28:39.779737+02:00
   parameters:
-    id: 14796673729431137386
+    id: 1479667372943113
     name: eenv_static_2000mV_5mA_3600s
     description: Artificial static Energy Environment, 2000mV, 5mA, 3600s
     comment: null
@@ -91,9 +91,9 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.524761+02:00
+  created: 2025-05-12 17:28:39.787329+02:00
   parameters:
-    id: 6648482606607441403
+    id: 664848260660744
     name: eenv_static_3000mV_10mA_3600s
     description: Artificial static Energy Environment, 3000mV, 10mA, 3600s
     comment: null
@@ -114,9 +114,9 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.533513+02:00
+  created: 2025-05-12 17:28:39.794922+02:00
   parameters:
-    id: 13566000951043177991
+    id: 1356600095104317
     name: eenv_static_3000mV_1mA_3600s
     description: Artificial static Energy Environment, 3000mV, 1mA, 3600s
     comment: null
@@ -137,9 +137,9 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.542278+02:00
+  created: 2025-05-12 17:28:39.802410+02:00
   parameters:
-    id: 7977778327156610158
+    id: 797777832715661
     name: eenv_static_3000mV_50mA_3600s
     description: Artificial static Energy Environment, 3000mV, 50mA, 3600s
     comment: null
@@ -160,9 +160,9 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.550974+02:00
+  created: 2025-05-12 17:28:39.810147+02:00
   parameters:
-    id: 4900162978999238419
+    id: 490016297899923
     name: eenv_static_3000mV_5mA_3600s
     description: Artificial static Energy Environment, 3000mV, 5mA, 3600s
     comment: null
@@ -183,7 +183,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.568363+02:00
+  created: 2025-05-12 17:28:39.825659+02:00
   parameters:
     id: 3000
     name: msp430_deep_sleep
@@ -198,10 +198,10 @@
     mcu:
       id: 1002
       name: MSP430FR
-      description: 16MHz Ultra-Low-Pwr MCU with 128 KB FRAM
+      description: 16MHz Ultra-Low-Pwr MCU with 256 KB FRAM
       comment: null
       platform: MSP430
-      core: MSP430FR5962
+      core: MSP430FR5994
       prog_protocol: SBW
       prog_voltage: 3.0
       prog_datarate: 500000
@@ -211,7 +211,7 @@
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.578594+02:00
+  created: 2025-05-12 17:28:39.834276+02:00
   parameters:
     id: 3001
     name: msp430_spi_fram
@@ -226,10 +226,10 @@
     mcu:
       id: 1002
       name: MSP430FR
-      description: 16MHz Ultra-Low-Pwr MCU with 128 KB FRAM
+      description: 16MHz Ultra-Low-Pwr MCU with 256 KB FRAM
       comment: null
       platform: MSP430
-      core: MSP430FR5962
+      core: MSP430FR5994
       prog_protocol: SBW
       prog_voltage: 3.0
       prog_datarate: 500000
@@ -239,7 +239,7 @@
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.589223+02:00
+  created: 2025-05-12 17:28:39.842993+02:00
   parameters:
     id: 3002
     name: msp430_testable
@@ -254,10 +254,10 @@
     mcu:
       id: 1002
       name: MSP430FR
-      description: 16MHz Ultra-Low-Pwr MCU with 128 KB FRAM
+      description: 16MHz Ultra-Low-Pwr MCU with 256 KB FRAM
       comment: null
       platform: MSP430
-      core: MSP430FR5962
+      core: MSP430FR5994
       prog_protocol: SBW
       prog_voltage: 3.0
       prog_datarate: 500000
@@ -267,9 +267,9 @@
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.599274+02:00
+  created: 2025-05-12 17:28:39.851412+02:00
   parameters:
-    id: 7163917825449888392
+    id: 716391782544988
     name: nrf52_deep_sleep
     description: practically turned off MCU with the lowest possible consumption
     comment: null
@@ -282,20 +282,20 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_deep_sleep/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.609313+02:00
+  created: 2025-05-12 17:28:39.859962+02:00
   parameters:
     id: 2000
     name: nrf52_demo_rf
@@ -310,22 +310,22 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_demo_rf/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.619155+02:00
+  created: 2025-05-12 17:28:39.868340+02:00
   parameters:
-    id: 3174430733058172825
+    id: 317443073305817
     name: nrf52_rf_survey
     description: Link Matrix Generator - TX-Unit - sends packet with every possible
       P_TX, loops until stopped
@@ -339,22 +339,22 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_rf_survey/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.628815+02:00
+  created: 2025-05-12 17:28:39.876819+02:00
   parameters:
-    id: 16381936580724580968
+    id: 1638193658072458
     name: nrf52_rf_test
     description: sends out 1 BLE-Packet per second (verify with an app like 'RaMBLE')
     comment: null
@@ -367,20 +367,20 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_rf_test/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.638812+02:00
+  created: 2025-05-12 17:28:39.885271+02:00
   parameters:
     id: 2002
     name: nrf52_testable
@@ -396,14 +396,14 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_testable/build.elf
     data_type: path_elf
     data_hash: null

{shepherd_core-2025.4.2 → shepherd_core-2025.5.3}/shepherd_core/data_models/content/energy_environment.py

@@ -15,8 +15,8 @@ from shepherd_core.testbed_client import tb_client
 class EnergyDType(str, Enum):
     """Data-Type-Options for energy environments."""
 
-    ivsample = ivsamples = "ivsample"
-    ivcurve = ivcurves = ivsurface = "ivcurve"
+    ivtrace = ivsample = ivsamples = "ivsample"
+    ivsurface = ivcurve = ivcurves = "ivcurve"
     isc_voc = "isc_voc"